Jump to

• Request
• Response

Describe a vector table.

get

/vecdb/vector-tables/{vector_table_name}

Returns metadata for the specified vector table.

Request

Path Parameters

• vector_table_name(required): string
  Name of the vector table. Must contain only letters, digits, and underscore (_).

There's no request body for this operation.

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

Vector table details.

Headers

• ETag:
  Entity tag for the resource.

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

404 Response

Not found or precondition failed.

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