Sign in

v2

OpenAPI 3.0.02026-08-051996591.2 MB
Generation Presets

List generation presets

Lists the generation presets used for query requests. The platform creates and maintains predefined generation presets. A generation preset groups several properties that configure generation for a request. This includes the prompt_template, the Large Language Model (LLM), and other generation settings like max_tokens and temperature. Each preset includes a complete Velocity template for the prompt. Presets are typically associated with a single LLM.

Specify a generation preset in query or chat requests with the generation_preset_name field.

Generation presets object

The generation_presets object contains the name, description, llm_name, prompt_template, and other fields that make up the preset.

If your account has access to a preset, enabled is set to true. A preset can also be set as a default.

Example generation presets response

{
  "generation_presets": [
    {
      "name": "vectara-summary-ext-24-05-med-omni",
      "description": "Generate summary with controllable citations, Uses GPT-4o with 2,048 max tokens",
      "llm_name": "gpt-4o",
      "prompt_template": "[\n    {\"role\": \"system\", \"content\": \"Follow these detailed step-by-step",
      "max_used_search_results": 25,
      "max_tokens": 2048,
      "temperature": 0,
      "frequency_penalty": 0,
      "presence_penalty": 0,
      "enabled": true,
      "default": false
    }
  ]
}
get/v2/generation_presets

Query parameters

llm_namestring
Example:mockingbird-2.0

Filter presets by the LLM name.

filterstring
Example:mockingbird.*

A regular expression to match names and descriptions of the generation presets.

limitinteger

The maximum number of results to return in the list.

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

List of Generation Presets.

Example response

{
  "generation_presets": [
    {
      "id": "gnp_123",
      "name": "Mockingbird 2.0",
      "description": "Mockingbird LLM 2.0 prompt for summarizing query results as an answer. Designed for RAG.",
      "llm_name": "mockingbird-2.0",
      "max_used_search_results": 50,
      "max_tokens": 500,
      "temperature": 0.4,
      "frequency_penalty": 0.2,
      "presence_penalty": 0.2,
      "ownership": "platform"
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}