Jump to

• Request
• Response

List the records of a given vector table.

post

http://localhost:8080/ords/pdbdba/_/db-api/stable/vecdb/vector-tables/{vector_table_name}/list

Look up and return vectors by ID from a vector table. The returned vectors include the vector data and/or metadata.

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
• ids: array ids
  The IDs of the vector table records to list.
• limit: number
  Default Value: 15

  The maximum number or records to retrieve.
• offset: number
  Row offset for pagination.

{
    "type":"object",
    "properties":{
        "ids":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"The IDs of the vector table records to list."
        },
        "limit":{
            "type":"number",
            "description":"The maximum number or records to retrieve.",
            "default":15
        },
        "offset":{
            "type":"number",
            "description":"Row offset for pagination."
        },
        "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 : ids

Type: array

The IDs of the vector table records to list.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"The IDs of the vector table records to list."
}

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

List of vector records.

Body ()

Root Schema : VecDBVectorVectorCollection

Type: object

Show Source

• count: number
• items: array items
• limit: number
• offset: number

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VecDBVectorVectorItem"
            }
        },
        "limit":{
            "type":"number"
        },
        "offset":{
            "type":"number"
        },
        "count":{
            "type":"number"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object VecDBVectorVectorItem

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VecDBVectorVectorItem"
    }
}

Nested Schema : VecDBVectorVectorItem

Type: object

Show Source

• dense_vector: array dense_vector
• id: string
• metadata: object metadata

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "dense_vector":{
            "type":"array",
            "items":{
                "type":"number",
                "format":"double"
            }
        },
        "metadata":{
            "type":"object",
            "nullable":true
        }
    }
}

Nested Schema : dense_vector

Type: array

Show Source

• Array of: number(double)

{
    "type":"array",
    "items":{
        "type":"number",
        "format":"double"
    }
}

Nested Schema : metadata

Type: object

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