Jump to

• Request
• Response

Generate text embeddings

post

/vecdb/embed

Generate vector embeddings for one or more input texts using an ONNX model hosted in the database.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• debugFlags: object VectorDebugFlags
  Debug flags to be used to trace vector modules
• inputs(required): array inputs
  Minimum Number of Items: 1

  Array of input items to embed.
• modelName(required): string
  The name of the text embedding model hosted in the database.

{
    "type":"object",
    "required":[
        "modelName",
        "inputs"
    ],
    "properties":{
        "modelName":{
            "type":"string",
            "description":"The name of the text embedding model hosted in the database."
        },
        "inputs":{
            "type":"array",
            "description":"Array of input items to embed.",
            "minItems":1,
            "items":{
                "$ref":"#/components/schemas/VectorEmbedInputItem"
            }
        },
        "debugFlags":{
            "$ref":"#/components/schemas/VectorDebugFlags"
        }
    }
}

Nested Schema : VectorDebugFlags

Type: object

Debug flags to be used to trace vector modules

Show Source

• VEC_INDEX_CALIBRATION: string
  Allowed Values: [ "low", "medium", "high" ]
• VECIDX_TRANS: string
  Allowed Values: [ "low", "medium", "high" ]
• VECIDX_TRANS_COM: string
  Allowed Values: [ "low", "medium", "high" ]
• VECIDX_TRANS_PJ: string
  Allowed Values: [ "low", "medium", "high" ]
• VECIDX_TRANS_PJ_DWNGRD: string
  Allowed Values: [ "low", "medium", "high" ]
• VECIDX_TRANS_PJ_GROW: string
  Allowed Values: [ "low", "medium", "high" ]
• VECIDX_TRANS_SJ: string
  Allowed Values: [ "low", "medium", "high" ]
• VECIDX_TRANS_SJ_BG: string
  Allowed Values: [ "low", "medium", "high" ]
• VECTOR_INDEX: string
  Allowed Values: [ "low", "medium", "high" ]
• VECTOR_INDEX_FIXED_VIEW: string
  Allowed Values: [ "low", "medium", "high" ]
• VECTOR_INDEX_NEIGHBOR_GRAPH: string
  Allowed Values: [ "low", "medium", "high" ]
• VECTOR_INDEX_NEIGHBOR_GRAPH_APPCHNG: string
  Allowed Values: [ "low", "medium", "high" ]
• VECTOR_INDEX_NEIGHBOR_GRAPH_BUILD: string
  Allowed Values: [ "low", "medium", "high" ]
• VECTOR_INDEX_NEIGHBOR_GRAPH_MEM: string
  Allowed Values: [ "low", "medium", "high" ]
• VECTOR_INDEX_NEIGHBOR_GRAPH_SEARCH: string
  Allowed Values: [ "low", "medium", "high" ]
• VECTOR_INDEX_NEIGHBOR_GRAPH_STATS: string
  Allowed Values: [ "low", "medium", "high" ]
• VECTOR_INDEX_NEIGHBOR_PARTITIONS: string
  Allowed Values: [ "low", "medium", "high" ]
• VECTOR_TRACE: string
  Allowed Values: [ "low", "medium", "high" ]

{
    "type":"object",
    "description":"Debug flags to be used to trace vector modules",
    "properties":{
        "VECTOR_INDEX":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECTOR_INDEX_NEIGHBOR_GRAPH":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECTOR_INDEX_NEIGHBOR_GRAPH_BUILD":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECTOR_INDEX_NEIGHBOR_GRAPH_MEM":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECTOR_INDEX_NEIGHBOR_GRAPH_SEARCH":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECTOR_INDEX_NEIGHBOR_GRAPH_APPCHNG":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECTOR_INDEX_NEIGHBOR_GRAPH_STATS":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECTOR_INDEX_NEIGHBOR_PARTITIONS":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECTOR_INDEX_FIXED_VIEW":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECIDX_TRANS":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECIDX_TRANS_COM":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECIDX_TRANS_PJ":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECIDX_TRANS_PJ_DWNGRD":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECIDX_TRANS_PJ_GROW":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECIDX_TRANS_SJ":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECIDX_TRANS_SJ_BG":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VEC_INDEX_CALIBRATION":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        },
        "VECTOR_TRACE":{
            "type":"string",
            "enum":[
                "low",
                "medium",
                "high"
            ]
        }
    }
}

Nested Schema : inputs

Type: array

Minimum Number of Items: 1

Array of input items to embed.

Show Source

• Array of: object VectorEmbedInputItem

{
    "type":"array",
    "description":"Array of input items to embed.",
    "minItems":1,
    "items":{
        "$ref":"#/components/schemas/VectorEmbedInputItem"
    }
}

Nested Schema : VectorEmbedInputItem

Type: object

Show Source

• text(required): string
  Input text to embed.

{
    "type":"object",
    "required":[
        "text"
    ],
    "properties":{
        "text":{
            "type":"string",
            "description":"Input text to embed."
        }
    }
}

Security

• BasicAuth: http
  Type: http
• BearerAuth: http
  Type: http
• OAuth2: oauth2
  Type: oauth2

Back to Top

Response

Supported Media Types

• application/json
• application/problem+json

200 Response

Embeddings generated successfully.

Body ()

Root Schema : VectorEmbedResponse

Type: object

Show Source

• data(required): array data
  List of generated embeddings.

{
    "type":"object",
    "required":[
        "data"
    ],
    "properties":{
        "data":{
            "type":"array",
            "description":"List of generated embeddings.",
            "items":{
                "$ref":"#/components/schemas/VectorEmbedItem"
            }
        }
    }
}

Nested Schema : data

Type: array

List of generated embeddings.

Show Source

• Array of: object VectorEmbedItem

{
    "type":"array",
    "description":"List of generated embeddings.",
    "items":{
        "$ref":"#/components/schemas/VectorEmbedItem"
    }
}

Nested Schema : VectorEmbedItem

Type: object

Show Source

• embedding(required): array embedding
  Embedding vector for the input text.
• text(required): string
  Echo of the input text.

{
    "type":"object",
    "required":[
        "text",
        "embedding"
    ],
    "properties":{
        "text":{
            "type":"string",
            "description":"Echo of the input text."
        },
        "embedding":{
            "type":"array",
            "description":"Embedding vector for the input text.",
            "items":{
                "type":"number",
                "format":"double"
            }
        }
    }
}

Nested Schema : embedding

Type: array

Embedding vector for the input text.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"Embedding vector for the input text.",
    "items":{
        "type":"number",
        "format":"double"
    }
}

400 Response

The request body included invalid parameters.

Body ()

Root Schema : ORDSErrorResponse

Type: object

Show Source

• code(required): string
• diagnosticTrace: string
• instance(required): string
• message(required): string
• stackTrace: string
• type(required): string

{
    "type":"object",
    "required":[
        "code",
        "message",
        "type",
        "instance"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "instance":{
            "type":"string"
        },
        "diagnosticTrace":{
            "type":"string"
        },
        "stackTrace":{
            "type":"string"
        }
    }
}

Back to Top