Skip to main content
Search

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

NamespaceName, Query, Type, Top

Search: Returns semantic search results from vector database.

NamespaceName
string
Query
string
Type
enum<string>
Available options:
None,
Ticket,
Webpage,
Document,
FAQ,
Product,
Website
Top
integer<int32>

Response

OK

Chunk
string

Markdown text that matched query.

Title
string

Title or filename of matched document, extracted from the Metadata

Id
string

Matched document's unique id. Typically a URI.

Type
enum<string>

Content type (web/faq/ticket/...)

Available options:
None,
Ticket,
Webpage,
Document,
FAQ,
Product,
Website
Score
number<double>

Relevancy score (0-1). How close this chunk of the document matched the query.

Metadata
object

Dictionary of metadata for this result. Keys depend on the source of the document. e.g. 'Title', 'Filename', 'Url', etc.