List encoders
GET/v2/encoders
Encoders are used to store and retrieve from a corpus.
Request
Query Parameters
A regular expression against encoder names and descriptions.
Possible values: >= 1
and <= 100
Default value: 10
The maximum number of results to return in the list.
Used to the retrieve the next page of encoders after the limit has been reached.
Responses
- 200
- 403
List of encoders.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
encoders object[]
Possible values: Value must match regular expression enc_[0-9]+$
The Encoder ID.
The encoder name.
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 the quality of the embedding.
The encoder description.
Indicates whether the encoder is default used when creating a corpus.
Indicates whether the encoder is enabled.
metadata object
The standard metadata in the response of a list operation.
When requesting the next page of this list, this is needed as a query parameter.
{
"encoders": [
{
"id": "enc_1",
"name": "boomerang",
"output_dimensions": 768,
"description": "string",
"default": true,
"enabled": true
}
],
"metadata": {
"page_key": "string"
}
}
Permissions do not allow listing encoders.
- application/json
- Schema
- Example (from schema)
Schema
The messages describing why the error occurred.
The ID of the request that can be used to help Vectara support debug what went wrong .
{
"messages": [
"Internal server error."
],
"request_id": "string"
}