List encoders

GET 
/v2/encoders

Encoders are used to store and retrieve from a corpus.

Request

Query Parameters

filter string

A regular expression against encoder names and descriptions.

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 encoders after the limit has been reached.

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

application/json

Schema

Schema

encoders object[]
Array [
id string
Possible values: Value must match regular expression enc_[0-9]+$
The Encoder ID.
name string
The encoder name.
output_dimensions int32
When this encoder is used to create an embedding, it shows the count of dimensions for the output embedding. A high dimensionality will consume more storage space, but it allows for an increase in the quality of the embedding.
description string
The encoder description.
default boolean
Indicates whether the default encoder is used when creating a corpus.
enabled boolean
Indicates whether the encoder is enabled.
]
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)

{
  "encoders": [
    {
      "id": "enc_1",
      "name": "boomerang",
      "output_dimensions": 768,
      "description": "string",
      "default": true,
      "enabled": true
    }
  ],
  "metadata": {
    "page_key": "string"
  }
}

403

Permissions do not allow listing encoders.

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