List LLMs

GET 
/v2/llms

List LLMs that can be used with query and chat endpoints. The LLM is not directly specified in a query, but instead a generation_preset_name is used. The generation_preset_name property in generation parameters can be found as the name property on the Generations Presets retrieved from /v2/generation_presets.

Request

Query Parameters

filter string

A regular expression to match names and descriptions of the LLMs.

limit int32

Possible values: >= 1 and <= 100

Default value: 10

The maximum number of results to return in the list.

page_key string

Used to retrieve the next page of LLMs after the limit has been reached. This parameter is not needed for the first page of results.

Header Parameters

Request-Timeout integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified seconds or time out.

Request-Timeout-Millis integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified milliseconds or time out.

Responses

200

List of LLMs.

application/json

Schema

Schema

llms object[]
List of LLMs.
Array [
id string
Possible values: Value must match regular expression llm_.*
The ID of the LLM.
name string
Name of the LLM.
description string
The description of the LLM.
enabled boolean
Indicates whether the LLM is enabled.
default boolean
If this is the default LLM, it is used in queries when the generator is not specified.
prompts object[]deprecated
List of prompts that the model can use. This is deprecated; see /v2/generation_presets instead.
Array [
id string
Possible values: Value must match regular expression pmt_.*
The ID of the prompt.
name string
Name of the prompt. This is used as the prompt_name in a query.
description string
The description of the prompt.
enabled boolean
Indicates whether the prompt is enabled.
default boolean
Indicates if this prompt is the default prompt used with the LLM.
]
]
metadata object

The standard metadata in the response of a list operation.

page_key string

When requesting the next page of this list, this is needed as a query parameter.

Example (from schema)

{
  "llms": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "enabled": true,
      "default": true
    }
  ],
  "metadata": {
    "page_key": "string"
  }
}

403

Permissions do not allow listing summarizers.

application/json

Schema

Schema

messages message[]

The messages describing why the error occurred.

request_id string

The ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "messages": [
    "Internal server error."
  ],
  "request_id": "string"
}

Loading...