POST Agents/AI/Answer

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/AI/Answer

Returns an answer.

NsApiSlow threshold: 1000 ms.

Experimental: ## The AI agent is experimental, subject to change, and not intended for partners.

Query String Parameters

Parameter Name Type Description
$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. 
POST /api/v1/Agents/AI/Answer?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

NamespaceName, Query, Type, Top

Property Name Type Description
NamespaceName String
Query String
Type String
Top Integer

Response:

OK

Response Description
200 OK

Response body: RagAnswer

Property Name Type Description
Answer string Response to the question
Source array Array of sources used to ground the answer. Each source has a chunk of text, relevancy score, title.
TrackingId string Unique identifier for this answer. Used for correlating feedback to answers

Sample request

POST /api/v1/Agents/AI/Answer
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8

{
  "NamespaceName": "Mraz Group",
  "Query": "impedit",
  "Type": "Document",
  "Top": 970
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "Answer": "To reset your password, click on 'Forgot Password' on the login page. You will receive an email with instructions to create a new password. The link expires after 24 hours.",
  "Source": [
    {
      "Chunk": "Password Reset: Users can reset their password by clicking the 'Forgot Password' link on the login page. An email will be sent with a secure reset link valid for 24 hours.",
      "Title": "User Authentication Guide",
      "Id": "doc-auth-2024-001",
      "Type": "Document",
      "Score": 0.92,
      "Metadata": {
        "category": "security",
        "lastUpdated": "2024-11-15"
      }
    },
    {
      "Chunk": "Security best practices require password reset links to expire within 24 hours to prevent unauthorized access.",
      "Title": "Security Policy",
      "Id": "doc-sec-policy-001",
      "Type": "Document",
      "Score": 0.85,
      "Metadata": {
        "category": "security",
        "version": "3.2"
      }
    }
  ],
  "TrackingId": "ai-query-20241124-7f3a9c2b"
}