QueryService

POST /v1/stream-query

Changed on Oct 12, 2024

Stream responses as you search for relevant results, highlight relevant snippets, and do Retrieval Augmented Generation (RAG).

Instead of receiving a complete response like with the Standard Query API, you receive partial responses in this order:

Search results.
If summarization is enabled, you get chunks of the summary, like "This", "is", "a", "summary".
If FCS is enabled, then the FCS is the final response.

Some tips for this API:

This operation authenticates with either an API Key or OAuth 2.0 (in a JWT "Bearer Token"). You can find details of how to set up an API key or use OAuth 2.0 here.
The Query API takes an array of queries, since you can have Vectara perform more than 1 query in a single API call. The results that are returned are thus in an array as well, with each element in the response array corresponding to the input query array.
Custom dimensions (the dim array) is a feature that is only available to Scale accounts.
Reranking enhances search accuracy and variety and more details can be found here.

Request

Base URL
https://api.vectara.io
Auth
- API key in header x-api-key
- or OAuth 2
  Client credentials
  Token URLhttps://vectara-prod-YOUR_VECTARA_CUSTOMER_ID.auth.us-west-2.amazoncognito.com/oauth2/token
TypeScript
https://skmtc.dev/vectara/apis/vectara-rest-api/docs/v1/stream-query/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

customer-idinteger required

Enter the Customer ID to use for the request.

timeoutstring

(Optional) Enter the timeout value of the request in seconds, such as 10S or 30S.

Request body

Example request

{
  "query": [
    {
      "query": "What is the answer to the life, the universe, and everything?",
      "start": 0,
      "numResults": 10,
      "contextConfig": {
        "sentencesBefore": 3,
        "sentencesAfter": 3,
        "startTag": "<b>",
        "endTag": "</b>"
      },
      "corpusKey": [
        {
          "customerId": 12345,
          "corpusId": 12
        }
      ],
      "summary": [
        {
          "maxSummarizedResults": 10,
          "responseLang": "en"
        }
      ]
    }
  ]
}

Response

A successful response.(streaming responses)

Changes

Oct 12, 20248c3acaedc699 Revision changes
- breaking
  the request property became required
- breaking
  the response property /////// became optional for the status
- breaking
  the response property ///// became optional for the status
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the optional property /////// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- info
  added the new optional request property /////
- info
  added the new optional request property ////
- info
  the request property //// became optional
- info
  the /// request property format was generalized from int32 to no format
- info
  the /// request property format was generalized from int32 to no format
- info
  the /// request property format was generalized from int32 to no format
- info
  the /// request property format was generalized from int32 to no format
- info
  the //// request property format was generalized from int64 to no format
- info
  the //// request property format was generalized from int64 to no format
- info
  the ///// request property format was generalized from float to no format
- info
  the //// request property format was generalized from int64 to no format
- info
  the ///// request property format was generalized from float to no format
- info
  the ///// request property format was generalized from int64 to no format
- info
  the ///// request property format was generalized from float to no format
- info
  the ///// request property format was generalized from float to no format
- info
  the //// request property format was generalized from int64 to no format

Operation history