Search
Returns semantic search results from vector database.
NsApiSlow threshold: 1000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
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
Response
OK
Markdown text that matched query.
Title or filename of matched document, extracted from the Metadata
Matched document's unique id. Typically a URI.
Content type (web/faq/ticket/...)
None, Ticket, Webpage, Document, FAQ, Product, Website Relevancy score (0-1). How close this chunk of the document matched the query.
Dictionary of metadata for this result. Keys depend on the source of the document. e.g. 'Title', 'Filename', 'Url', etc.