Multiple Corpora Query

POST 
/v2/query

Perform a multipurpose query to retrieve relevant information from one or more corpora and generate a response using Retrieval Augmented Generation (RAG).

• Specify the unique corpus_key identifying the corpus to query. The corpus_key is created in the Vectara Console UI or the Create Corpus API definition, and the corpus key is part of that process. When creating a new corpus, you have the option to assign a custom corpus_key following your preferred naming convention. This key serves as a unique identifier for the corpus, allowing it to be referenced in search requests. For more information, see Corpus Key Definition.
• Customize your search by specifying the query text (query), pagination details (offset and limit), and metadata filters (metadata_filter) to tailor your search results. Learn more
• Leverage advanced search capabilities like reranking (reranker) and opt-in Retrieval Augmented Generation (RAG) (generation) for enhanced query performance. Generation is opt-in by setting the generation property. By excluding the property or by setting it to null, the response will not include generation. Learn more
• Specify Vectara's RAG-focused LLM (Mockingbird) for the generation_preset_name. Learn more
• Use advanced summarization options that utilize detailed summarization parameters such as max_response_characters, temperature, and frequency_penalty for generating precise and relevant summaries. Learn more
• Customize citation formats in summaries using the citations object to include numeric, HTML, or Markdown links. Learn more

For more detailed information, see this Query API guide.

Request

Responses

200

A response to a query.

400

Query request was malformed.

403

Permissions do not allow querying one or more corpora in the request.

404

One or more of the corpora were not found.