1. Oracle REST Data Services API
  2. Tasks
  3. Vector Database
  4. Vector Tables

Create a vector table.

post

http://localhost:8080/ords/pdbdba/_/db-api/stable/vecdb/vector-tables/

Creates a new vector table. Provide embedParams for model-backed tables; omit it for BYOV tables.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Example:
{
    "name":"DOCS",
    "comment":"Searchable document chunks",
    "tableParams":{
        "auto_generate_id":true
    },
    "annotations":{
        "application":"knowledge-base"
    },
    "indexParams":{
        "vector_index_params":{
            "auto_index":true,
            "organization":"INMEMORY GRAPH",
            "distance_metric":"COSINE",
            "quantization_type":"SCALAR",
            "compression_ratio":4,
            "distribute_params":{
                "distribute_method":"AUTO"
            },
            "advanced_params":{
                "neighbors":32,
                "efConstruction":128,
                "rescore_factor":10,
                "algorithm":"uniform_quantization"
            }
        },
        "metadata_index_params":{
            "auto_index":true,
            "include_paths":[
                "tenant",
                "category"
            ],
            "exclude_paths":[
                "body"
            ]
        },
        "parallel_creation":4
    }
}
Nested Schema : annotations
Type: object
Additional Properties Allowed: true
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
Nested Schema : embedParams
Type: object
Additional Properties Allowed: true
Embedding model parameters. Presence creates a model-backed table.
Show Source
Nested Schema : VectorIndexParams
Type: object
Additional Properties Allowed: true
Nested index configuration for vector and metadata indexes.
Show Source
Example:
{
    "vector_index_params":{
        "auto_index":true,
        "organization":"INMEMORY GRAPH",
        "distance_metric":"COSINE",
        "quantization_type":"SCALAR",
        "compression_ratio":4,
        "distribute_params":{
            "distribute_method":"AUTO"
        },
        "advanced_params":{
            "neighbors":32,
            "efConstruction":128,
            "rescore_factor":10,
            "algorithm":"uniform_quantization"
        }
    },
    "metadata_index_params":{
        "auto_index":true,
        "include_paths":[
            "tenant",
            "category"
        ],
        "exclude_paths":[
            "body"
        ]
    },
    "parallel_creation":4
}
Nested Schema : tableParams
Type: object
Additional Properties Allowed: true
Table creation controls for vector table creation.
Show Source
Nested Schema : metadata_index_params
Type: object
Additional Properties Allowed: true
Metadata multi-value index settings and path selectors.
Show Source
Nested Schema : vector_index_params
Type: object
Additional Properties Allowed: true
Vector index settings such as organization, distance metric, distributed HNSW, scalar quantization, and advanced parameters.
Show Source
Nested Schema : exclude_paths
Type: array
Show Source
Nested Schema : include_paths
Type: array
Show Source
Nested Schema : advanced_params
Type: object
Index-family-specific options such as partitions, neighbors, efConstruction, rescore_factor, or algorithm.
Nested Schema : distribute_params
Type: object
Show Source
Security
Back to Top

Response

Supported Media Types

201 Response

Vector table created successfully.
Body ()
Nested Schema : VectorIndexParams
Type: object
Additional Properties Allowed: true
Nested index configuration for vector and metadata indexes.
Show Source
Example:
{
    "vector_index_params":{
        "auto_index":true,
        "organization":"INMEMORY GRAPH",
        "distance_metric":"COSINE",
        "quantization_type":"SCALAR",
        "compression_ratio":4,
        "distribute_params":{
            "distribute_method":"AUTO"
        },
        "advanced_params":{
            "neighbors":32,
            "efConstruction":128,
            "rescore_factor":10,
            "algorithm":"uniform_quantization"
        }
    },
    "metadata_index_params":{
        "auto_index":true,
        "include_paths":[
            "tenant",
            "category"
        ],
        "exclude_paths":[
            "body"
        ]
    },
    "parallel_creation":4
}
Nested Schema : metadata_index_params
Type: object
Additional Properties Allowed: true
Metadata multi-value index settings and path selectors.
Show Source
Nested Schema : vector_index_params
Type: object
Additional Properties Allowed: true
Vector index settings such as organization, distance metric, distributed HNSW, scalar quantization, and advanced parameters.
Show Source
Nested Schema : exclude_paths
Type: array
Show Source
Nested Schema : include_paths
Type: array
Show Source
Nested Schema : advanced_params
Type: object
Index-family-specific options such as partitions, neighbors, efConstruction, rescore_factor, or algorithm.
Nested Schema : distribute_params
Type: object
Show Source

400 Response

The request body included invalid or missing parameters such as missing name or invalid JSON field types.
Body ()
Root Schema : ORDSErrorResponse
Type: object
Show Source

409 Response

Conflict: A table with that name already exists.
Body ()
Root Schema : ORDSErrorResponse
Type: object
Show Source
Back to Top