Class NaturalLanguageSearch
Natural language search results.
Carrier object for NaturalLanguageSearch. Services for the NaturalLanguageSearch Carrier is available from the AI Agent.Inherited Members
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.9.0.0")]
public class NaturalLanguageSearchConstructors
NaturalLanguageSearch()
Default constructor
Declaration
public NaturalLanguageSearch()See Also
Properties
Entity
Type of entity we are searching. e.g. 'contact', 'project' etc.
Declaration
[DataMember]
public virtual string Entity { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
InternalContext
AI internal context - opaque to callers.
Declaration
[DataMember]
public virtual string InternalContext { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
ODataQuery
Search criteria in ODATA format
Declaration
[DataMember]
public virtual string ODataQuery { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
Query
User's query.
Declaration
[DataMember]
public virtual string Query { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
ResponseMarkdown
Markdown response from the AI.
Declaration
[DataMember]
public virtual string ResponseMarkdown { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
Restrictions
Archive restrictions for the search query.
Declaration
[DataMember]
public virtual ArchiveRestrictionInfo[] Restrictions { get; set; }Property Value
| Type | Description |
|---|---|
| ArchiveRestrictionInfo[] |
See Also
Methods
ToString()
Returns the carrier contents as a formatted string.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string | The carrier contents. |
Overrides
See Also
ToString(string)
Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.
Declaration
public string ToString(string prefix)Parameters
| Type | Name | Description |
|---|---|---|
| string | prefix | The line prefix (typically used for indenting) |
Returns
| Type | Description |
|---|---|
| string | The carrier contents. |