Jump to

• Request
• Response

Upsert vectors or records into a given vector table.

post

/vecdb/vector-tables/{vector_table_name}/upsert

Insert or update records into a vector table.

Request

Path Parameters

• vector_table_name(required): string
  The name of the vector table.

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
• vectors(required): array vectors
  The vectors to upsert

{
    "type":"object",
    "required":[
        "vectors"
    ],
    "properties":{
        "vectors":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"string",
                        "description":"The ID of the vector record."
                    },
                    "dense_vector":{
                        "type":"array",
                        "description":"The dense vector to insert.",
                        "items":{
                            "type":"number",
                            "format":"double"
                        }
                    },
                    "metadata":{
                        "type":"object",
                        "description":"The metadata associated to the vector record."
                    }
                }
            },
            "description":"The vectors to upsert"
        },
        "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 : vectors

Type: array

The vectors to upsert

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":"The ID of the vector record."
            },
            "dense_vector":{
                "type":"array",
                "description":"The dense vector to insert.",
                "items":{
                    "type":"number",
                    "format":"double"
                }
            },
            "metadata":{
                "type":"object",
                "description":"The metadata associated to the vector record."
            }
        }
    },
    "description":"The vectors to upsert"
}

Nested Schema : items

Type: object

Show Source

• dense_vector: array dense_vector
  The dense vector to insert.
• id: string
  The ID of the vector record.
• metadata: object metadata
  The metadata associated to the vector record.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the vector record."
        },
        "dense_vector":{
            "type":"array",
            "description":"The dense vector to insert.",
            "items":{
                "type":"number",
                "format":"double"
            }
        },
        "metadata":{
            "type":"object",
            "description":"The metadata associated to the vector record."
        }
    }
}

Nested Schema : dense_vector

Type: array

The dense vector to insert.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The dense vector to insert.",
    "items":{
        "type":"number",
        "format":"double"
    }
}

Nested Schema : metadata

Type: object

The metadata associated to the vector record.

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

201 Response

List of vectors.

Body ()

Root Schema : schema

Type: object

Show Source

• upserted_count: number
  The number of upserted records.

{
    "type":"object",
    "properties":{
        "upserted_count":{
            "type":"number",
            "description":"The number of upserted records."
        }
    }
}

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

404 Response

The specified vector table does not exists.

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