Skip to main content

​
Class NaturalLanguageSearch

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for NaturalLanguageSearch. Natural language search results.

​
Inheritance

object ← NaturalLanguageSearch

​
Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

​
Constructors

​
NaturalLanguageSearch()

Default constructor - defaults any enum props to 0.

​
Properties

​
Entity

Type of entity we are searching. e.g. ‘contact’, ‘project’ etc.

​
Property Value

string

​
InternalContext

AI internal context - opaque to callers.

​
Property Value

string

​
ODataQuery

Search criteria in ODATA format

​
Property Value

string

​
Query

User’s query.

​
Property Value

string

​
ResponseMarkdown

Markdown response from the AI.

​
Property Value

string

​
Restrictions

Archive restrictions for the search query.

​
Property Value

ArchiveRestrictionInfo[]

​
See Also

AIAgent

Related topics

WebAPI changes in SuperOffice 12.0WebAPI changes in SuperOffice 12.1WebAPI changes in SuperOffice 12.2SuperOffice WebApiHow to use SuperOffice.WebApiHow to create a user-defined field using the web services APIHow to get a system user ticket credential