Get an LLM

GET 
/v2/llms/:llm_id

Get details about a specific LLM.

Request

Path Parameters

llm_id stringrequired

The name of the LLM to retrieve.

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

The LLM details.

application/json

Schema

Schema

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.
]

Example (from schema)

{
  "id": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "default": true
}

403

Permissions do not allow retrieving this LLM.

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"
}

404

LLM not found.

application/json

Schema

Schema

id string

The ID cannot be found.

messages message[]
request_id string

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

Example (from schema)

{
  "id": "string",
  "messages": [
    "string"
  ],
  "request_id": "string"
}

Loading...