Jump to

• Request
• Response

Create a vector table.

post

/vecdb/vector-tables/

Creates a new vector table. Exactly one of vectorType or embedParams must be provided. If both or neither are provided, the request is rejected.

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

• annotations: object annotations
  Key-value pairs added to the vector table metadata.
• autoGenerateID: boolean
  Whether the ID column of the table should be auto generated. Defaults to false.
• debugFlags: object VectorDebugFlags
  Debug flags to be used to trace vector modules
• description: string
  A brief description of the vector table.
• embedParams: object embedParams
  Embedding model parameters. Provide this instead of vectorType to create a table for a model (e.g., {"model":"hosted-model-name","embed_metadata_jsonpath":""}).
• indexParams: object VectorIndexParams
  Index configuration for the table.
• tableName(required): string
  The name of the vector table.
• vectorType: string
  Allowed Values: [ "dense" ]

  Vector type to use for the table. For V1 only 'dense' is supported.

{
    "type":"object",
    "required":[
        "tableName"
    ],
    "properties":{
        "tableName":{
            "type":"string",
            "description":"The name of the vector table."
        },
        "description":{
            "type":"string",
            "description":"A brief description of the vector table."
        },
        "autoGenerateID":{
            "type":"boolean",
            "description":"Whether the ID column of the table should be auto generated. Defaults to false."
        },
        "annotations":{
            "type":"object",
            "description":"Key-value pairs added to the vector table metadata."
        },
        "vectorType":{
            "type":"string",
            "description":"Vector type to use for the table. For V1 only 'dense' is supported.",
            "enum":[
                "dense"
            ]
        },
        "embedParams":{
            "type":"object",
            "description":"Embedding model parameters. Provide this instead of vectorType to create a table for a model (e.g., {\"model\":\"hosted-model-name\",\"embed_metadata_jsonpath\":\"\"}).",
            "properties":{
            }
        },
        "indexParams":{
            "$ref":"#/components/schemas/VectorIndexParams"
        },
        "debugFlags":{
            "$ref":"#/components/schemas/VectorDebugFlags"
        }
    },
    "oneOf":[
        {
            "required":[
                "vectorType"
            ],
            "not":{
                "required":[
                    "embedParams"
                ]
            }
        },
        {
            "required":[
                "embedParams"
            ],
            "not":{
                "required":[
                    "vectorType"
                ]
            }
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "required":[
        "tableName"
    ],
    "properties":{
        "tableName":{
            "type":"string",
            "description":"The name of the vector table."
        },
        "description":{
            "type":"string",
            "description":"A brief description of the vector table."
        },
        "autoGenerateID":{
            "type":"boolean",
            "description":"Whether the ID column of the table should be auto generated. Defaults to false."
        },
        "annotations":{
            "type":"object",
            "description":"Key-value pairs added to the vector table metadata."
        },
        "vectorType":{
            "type":"string",
            "description":"Vector type to use for the table. For V1 only 'dense' is supported.",
            "enum":[
                "dense"
            ]
        },
        "embedParams":{
            "type":"object",
            "description":"Embedding model parameters. Provide this instead of vectorType to create a table for a model (e.g., {\"model\":\"hosted-model-name\",\"embed_metadata_jsonpath\":\"\"}).",
            "properties":{
            }
        },
        "indexParams":{
            "$ref":"#/components/schemas/VectorIndexParams"
        },
        "debugFlags":{
            "$ref":"#/components/schemas/VectorDebugFlags"
        }
    },
    "oneOf":[
        {
            "required":[
                "vectorType"
            ],
            "not":{
                "required":[
                    "embedParams"
                ]
            }
        },
        {
            "required":[
                "embedParams"
            ],
            "not":{
                "required":[
                    "vectorType"
                ]
            }
        }
    ]
}

Nested Schema : annotations

Type: object

Key-value pairs added to the vector table metadata.

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 : embedParams

Type: object

Embedding model parameters. Provide this instead of vectorType to create a table for a model (e.g., {"model":"hosted-model-name","embed_metadata_jsonpath":""}).

Show Source

{
    "type":"object",
    "description":"Embedding model parameters. Provide this instead of vectorType to create a table for a model (e.g., {\"model\":\"hosted-model-name\",\"embed_metadata_jsonpath\":\"\"}).",
    "properties":{
    }
}

Nested Schema : VectorIndexParams

Type: object

Index configuration for the table.

Show Source

• accuracy: integer
  Minimum Value: 0

  Maximum Value: 100
• advanced_params: object advanced_params
• distance_metric: string
  Allowed Values: [ "COSINE", "MANHATTAN", "HAMMING", "JACCARD", "DOT", "EUCLIDEAN", "L2_SQUARED", "EUCLIDEAN_SQUARED" ]
• indexing: string
  Default Value: auto

  Allowed Values: [ "manual", "auto" ]
• organization: string
  Default Value: PARTITIONS

  Allowed Values: [ "PARTITIONS", "INMEMORY GRAPH" ]

{
    "description":"Index configuration for the table.",
    "type":"object",
    "properties":{
        "indexing":{
            "type":"string",
            "enum":[
                "manual",
                "auto"
            ],
            "default":"auto"
        },
        "organization":{
            "type":"string",
            "enum":[
                "PARTITIONS",
                "INMEMORY GRAPH"
            ],
            "default":"PARTITIONS"
        },
        "distance_metric":{
            "type":"string",
            "enum":[
                "COSINE",
                "MANHATTAN",
                "HAMMING",
                "JACCARD",
                "DOT",
                "EUCLIDEAN",
                "L2_SQUARED",
                "EUCLIDEAN_SQUARED"
            ]
        },
        "accuracy":{
            "type":"integer",
            "minimum":0,
            "maximum":100
        },
        "advanced_params":{
            "type":"object"
        }
    }
}

Nested Schema : advanced_params

Type: object

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

Vector table created successfully.

Body ()

Root Schema : VecDBTableNoLinks

Type: object

Show Source

• annotations: object annotations
  User metadata attached to the table.
• auto_generate_id: integer
  Whether the ID column of the table should be auto generated. Defaults to false.
• created: string (date-time)
  Creation timestamp of the vector table.
• dense_idx_name: string
  The name of the vector index associated to the vector table.
• description: string
  Description of the vector table
• embed_params: embed_params
  Embedding model configuration (MODEL tables).
• index_params: object index_params
  Index configuration for the table.
• owner: string
• stats: object stats
  Statistics of the vector table
• status: string
  Population status of the vector table.
• table_name: string
  The name of the table
• updated: string (date-time)
  Creation timestamp of the vector table.
• vector_table_type: string
  Allowed Values: [ "BYOV", "MODEL" ]

  Creation mode of the table.
• vector_type: string
  Allowed Values: [ "dense" ]

{
    "type":"object",
    "properties":{
        "table_name":{
            "type":"string",
            "description":"The name of the table"
        },
        "description":{
            "type":"string",
            "description":"Description of the vector table",
            "nullable":true
        },
        "auto_generate_id":{
            "type":"integer",
            "description":"Whether the ID column of the table should be auto generated. Defaults to false."
        },
        "owner":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"Population status of the vector table."
        },
        "vector_type":{
            "type":"string",
            "enum":[
                "dense"
            ]
        },
        "vector_table_type":{
            "type":"string",
            "enum":[
                "BYOV",
                "MODEL"
            ],
            "description":"Creation mode of the table."
        },
        "index_params":{
            "description":"Index configuration for the table.",
            "type":"object",
            "properties":{
                "indexing":{
                    "type":"string"
                },
                "organization":{
                    "type":"string"
                },
                "distance_metric":{
                    "type":"string"
                },
                "accuracy":{
                    "type":"integer"
                },
                "advanced_params":{
                    "type":"object",
                    "properties":{
                        "partitions":{
                            "type":"number",
                            "nullable":true
                        },
                        "efConstruction":{
                            "type":"number",
                            "nullable":true
                        },
                        "neighbors":{
                            "type":"number",
                            "nullable":true
                        }
                    }
                }
            },
            "nullable":true
        },
        "annotations":{
            "description":"User metadata attached to the table.",
            "type":"object",
            "nullable":true
        },
        "embed_params":{
            "description":"Embedding model configuration (MODEL tables).",
            "nullable":true,
            "properties":{
                "model":{
                    "type":"string"
                },
                "embed_metadata_jsonpath":{
                    "type":"string"
                }
            }
        },
        "dense_idx_name":{
            "type":"string",
            "description":"The name of the vector index associated to the vector table.",
            "nullable":true
        },
        "stats":{
            "type":"object",
            "description":"Statistics of the vector table",
            "nullable":true,
            "properties":{
                "total_vectors":{
                    "type":"number",
                    "nullable":true
                }
            }
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Creation timestamp of the vector table."
        },
        "updated":{
            "type":"string",
            "format":"date-time",
            "description":"Creation timestamp of the vector table.",
            "nullable":true
        }
    }
}

Nested Schema : annotations

Type: object

User metadata attached to the table.

Nested Schema : embed_params

Type: object

Embedding model configuration (MODEL tables).

Show Source

• embed_metadata_jsonpath: string
• model: string

{
    "description":"Embedding model configuration (MODEL tables).",
    "nullable":true,
    "properties":{
        "model":{
            "type":"string"
        },
        "embed_metadata_jsonpath":{
            "type":"string"
        }
    }
}

Nested Schema : index_params

Type: object

Index configuration for the table.

Show Source

• accuracy: integer
• advanced_params: object advanced_params
• distance_metric: string
• indexing: string
• organization: string

{
    "description":"Index configuration for the table.",
    "type":"object",
    "properties":{
        "indexing":{
            "type":"string"
        },
        "organization":{
            "type":"string"
        },
        "distance_metric":{
            "type":"string"
        },
        "accuracy":{
            "type":"integer"
        },
        "advanced_params":{
            "type":"object",
            "properties":{
                "partitions":{
                    "type":"number",
                    "nullable":true
                },
                "efConstruction":{
                    "type":"number",
                    "nullable":true
                },
                "neighbors":{
                    "type":"number",
                    "nullable":true
                }
            }
        }
    },
    "nullable":true
}

Nested Schema : stats

Type: object

Statistics of the vector table

Show Source

• total_vectors: number

{
    "type":"object",
    "description":"Statistics of the vector table",
    "nullable":true,
    "properties":{
        "total_vectors":{
            "type":"number",
            "nullable":true
        }
    }
}

Nested Schema : advanced_params

Type: object

Show Source

• efConstruction: number
• neighbors: number
• partitions: number

{
    "type":"object",
    "properties":{
        "partitions":{
            "type":"number",
            "nullable":true
        },
        "efConstruction":{
            "type":"number",
            "nullable":true
        },
        "neighbors":{
            "type":"number",
            "nullable":true
        }
    }
}

400 Response

The request body included invalid or missing parameters (e.g., missing tableName, invalid JSON, or providing both/neither vectorType and embedParams).

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

409 Response

Conflict: A table with that name already 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