Jump to

• Request
• Response

Create vector and/or metadata indexes.

post

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

Creates vector and/or metadata indexes. indexParams accepts nested vector and metadata index configuration.

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

• debugFlags: object VectorDebugFlags
  Debug flags to be used to trace vector modules
• indexParams: object VectorIndexParams
  Additional Properties Allowed: true

  Nested index configuration for vector and metadata indexes.
• tableName(required): string
  The name of the vector table.

{
    "type":"object",
    "required":[
        "tableName"
    ],
    "properties":{
        "tableName":{
            "type":"string",
            "description":"The name of the vector table."
        },
        "indexParams":{
            "$ref":"#/components/schemas/VectorIndexParams"
        },
        "debugFlags":{
            "$ref":"#/components/schemas/VectorDebugFlags"
        }
    },
    "example":{
        "tableName":"DOCS",
        "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
        }
    }
}

Example:

{
    "tableName":"DOCS",
    "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 : 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 : VectorIndexParams

Type: object

Additional Properties Allowed: true

Nested index configuration for vector and metadata indexes.

Show Source

• index_type: string
  Allowed Values: [ "vector", "metadata", "all" ]

  Action scope for rebuild and drop operations.
• metadata_index_params: object metadata_index_params
  Additional Properties Allowed: true

  Metadata multi-value index settings and path selectors.
• parallel_creation: integer
  Minimum Value: 1

  Parallel DDL degree for vector and metadata index operations.
• vector_index_params: object vector_index_params
  Additional Properties Allowed: true

  Vector index settings such as organization, distance metric, distributed HNSW, scalar quantization, and advanced parameters.

{
    "description":"Nested index configuration for vector and metadata indexes.",
    "type":"object",
    "properties":{
        "vector_index_params":{
            "type":"object",
            "description":"Vector index settings such as organization, distance metric, distributed HNSW, scalar quantization, and advanced parameters.",
            "properties":{
                "auto_index":{
                    "type":"boolean",
                    "description":"Enables vector index creation or management."
                },
                "organization":{
                    "type":"string",
                    "enum":[
                        "PARTITIONS",
                        "INMEMORY GRAPH"
                    ]
                },
                "distance_metric":{
                    "type":"string",
                    "enum":[
                        "COSINE",
                        "MANHATTAN",
                        "HAMMING",
                        "JACCARD",
                        "DOT",
                        "EUCLIDEAN",
                        "L2_SQUARED",
                        "EUCLIDEAN_SQUARED"
                    ]
                },
                "accuracy":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":100
                },
                "online_build":{
                    "type":"boolean"
                },
                "quantization_type":{
                    "type":"string",
                    "nullable":true,
                    "enum":[
                        "NONE",
                        "SCALAR"
                    ]
                },
                "compression_ratio":{
                    "type":"number",
                    "nullable":true,
                    "enum":[
                        2,
                        4,
                        8
                    ]
                },
                "distribute_params":{
                    "type":"object",
                    "nullable":true,
                    "properties":{
                        "distribute_method":{
                            "type":"string",
                            "enum":[
                                "ROWID RANGE",
                                "SIMILARITY",
                                "PARTITION",
                                "SUBPARTITION",
                                "DISTRIBUTE",
                                "AUTO"
                            ]
                        }
                    }
                },
                "advanced_params":{
                    "type":"object",
                    "description":"Index-family-specific options such as partitions, neighbors, efConstruction, rescore_factor, or algorithm."
                }
            },
            "additionalProperties":true
        },
        "metadata_index_params":{
            "type":"object",
            "description":"Metadata multi-value index settings and path selectors.",
            "properties":{
                "auto_index":{
                    "type":"boolean"
                },
                "include_paths":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "exclude_paths":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            },
            "additionalProperties":true
        },
        "parallel_creation":{
            "type":"integer",
            "nullable":true,
            "minimum":1,
            "description":"Parallel DDL degree for vector and metadata index operations."
        },
        "index_type":{
            "type":"string",
            "enum":[
                "vector",
                "metadata",
                "all"
            ],
            "description":"Action scope for rebuild and drop operations."
        }
    },
    "additionalProperties":true,
    "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
    }
}

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

• auto_index: boolean
• exclude_paths: array exclude_paths
• include_paths: array include_paths

{
    "type":"object",
    "description":"Metadata multi-value index settings and path selectors.",
    "properties":{
        "auto_index":{
            "type":"boolean"
        },
        "include_paths":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "exclude_paths":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":true
}

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

• accuracy: integer
  Minimum Value: 0

  Maximum Value: 100
• advanced_params: object advanced_params
  Index-family-specific options such as partitions, neighbors, efConstruction, rescore_factor, or algorithm.
• auto_index: boolean
  Enables vector index creation or management.
• compression_ratio: number
  Allowed Values: [ 2, 4, 8 ]
• distance_metric: string
  Allowed Values: [ "COSINE", "MANHATTAN", "HAMMING", "JACCARD", "DOT", "EUCLIDEAN", "L2_SQUARED", "EUCLIDEAN_SQUARED" ]
• distribute_params: object distribute_params
• online_build: boolean
• organization: string
  Allowed Values: [ "PARTITIONS", "INMEMORY GRAPH" ]
• quantization_type: string
  Allowed Values: [ "NONE", "SCALAR" ]

{
    "type":"object",
    "description":"Vector index settings such as organization, distance metric, distributed HNSW, scalar quantization, and advanced parameters.",
    "properties":{
        "auto_index":{
            "type":"boolean",
            "description":"Enables vector index creation or management."
        },
        "organization":{
            "type":"string",
            "enum":[
                "PARTITIONS",
                "INMEMORY GRAPH"
            ]
        },
        "distance_metric":{
            "type":"string",
            "enum":[
                "COSINE",
                "MANHATTAN",
                "HAMMING",
                "JACCARD",
                "DOT",
                "EUCLIDEAN",
                "L2_SQUARED",
                "EUCLIDEAN_SQUARED"
            ]
        },
        "accuracy":{
            "type":"integer",
            "minimum":0,
            "maximum":100
        },
        "online_build":{
            "type":"boolean"
        },
        "quantization_type":{
            "type":"string",
            "nullable":true,
            "enum":[
                "NONE",
                "SCALAR"
            ]
        },
        "compression_ratio":{
            "type":"number",
            "nullable":true,
            "enum":[
                2,
                4,
                8
            ]
        },
        "distribute_params":{
            "type":"object",
            "nullable":true,
            "properties":{
                "distribute_method":{
                    "type":"string",
                    "enum":[
                        "ROWID RANGE",
                        "SIMILARITY",
                        "PARTITION",
                        "SUBPARTITION",
                        "DISTRIBUTE",
                        "AUTO"
                    ]
                }
            }
        },
        "advanced_params":{
            "type":"object",
            "description":"Index-family-specific options such as partitions, neighbors, efConstruction, rescore_factor, or algorithm."
        }
    },
    "additionalProperties":true
}

Nested Schema : exclude_paths

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : include_paths

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

• distribute_method: string
  Allowed Values: [ "ROWID RANGE", "SIMILARITY", "PARTITION", "SUBPARTITION", "DISTRIBUTE", "AUTO" ]

{
    "type":"object",
    "nullable":true,
    "properties":{
        "distribute_method":{
            "type":"string",
            "enum":[
                "ROWID RANGE",
                "SIMILARITY",
                "PARTITION",
                "SUBPARTITION",
                "DISTRIBUTE",
                "AUTO"
            ]
        }
    }
}

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

Description of the vector index creation job that has been created.

Body ()

Root Schema : VecDBJobItem

Type: object

Show Source

• job_creator: string
• job_name: string
• job_type: string
• links: array links
• operation: string
• start_date: string
• state: string

{
    "type":"object",
    "properties":{
        "job_name":{
            "type":"string"
        },
        "job_creator":{
            "type":"string"
        },
        "job_type":{
            "type":"string"
        },
        "operation":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "start_date":{
            "type":"string",
            "nullable":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : LinkRelation

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

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 vector table was not found.

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