/** * CyborgDB Service * REST API for CyborgDB: The Confidential Vector Database * * The version of the OpenAPI document: 0.17.1.dev16 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { type BinaryQueryRequest } from '../models/BinaryQueryRequest'; import { type BinaryUpsertRequest } from '../models/BinaryUpsertRequest'; import { type CreateIndexRequest } from '../models/CreateIndexRequest'; import { type CreateUserRequest } from '../models/CreateUserRequest'; import { type CreateUserResponse } from '../models/CreateUserResponse'; import { type CyborgdbServiceApiSchemasIndexSuccessResponseModel } from '../models/CyborgdbServiceApiSchemasIndexSuccessResponseModel'; import { type CyborgdbServiceApiSchemasVectorsSuccessResponseModel } from '../models/CyborgdbServiceApiSchemasVectorsSuccessResponseModel'; import { type DeleteRequest } from '../models/DeleteRequest'; import { type GetRequest } from '../models/GetRequest'; import { type GetResponseModel } from '../models/GetResponseModel'; import { type IndexInfoResponseModel } from '../models/IndexInfoResponseModel'; import { type IndexListResponseModel } from '../models/IndexListResponseModel'; import { type IndexOperationRequest } from '../models/IndexOperationRequest'; import { type IndexTrainingStatusResponseModel } from '../models/IndexTrainingStatusResponseModel'; import { type ListIDsRequest } from '../models/ListIDsRequest'; import { type ListIDsResponse } from '../models/ListIDsResponse'; import { type ListUsersResponse } from '../models/ListUsersResponse'; import { type QueryMetadataRequest } from '../models/QueryMetadataRequest'; import { type QueryMetadataResponse } from '../models/QueryMetadataResponse'; import { type QueryResponse } from '../models/QueryResponse'; import { type Request } from '../models/Request'; import { type TrainRequest } from '../models/TrainRequest'; import { type UpsertRequest } from '../models/UpsertRequest'; import * as runtime from '../runtime'; export interface CreateIndexV1IndexesCreatePostRequest { createIndexRequest: CreateIndexRequest; } export interface CreateUserV1IndexesIndexNameUsersPostRequest { indexName: string; createUserRequest: CreateUserRequest; } export interface DeleteIndexV1IndexesDeletePostRequest { indexOperationRequest: IndexOperationRequest; } export interface DeleteUserV1IndexesIndexNameUsersUserIdDeleteRequest { indexName: string; userId: string; xIndexKey?: string | null; } export interface DeleteVectorsV1VectorsDeletePostRequest { deleteRequest: DeleteRequest; } export interface GetIndexInfoV1IndexesDescribePostRequest { indexOperationRequest: IndexOperationRequest; } export interface GetIndexSizeV1VectorsNumVectorsPostRequest { indexOperationRequest: IndexOperationRequest; } export interface GetVectorsV1VectorsGetPostRequest { getRequest: GetRequest; } export interface ListIdsV1VectorsListIdsPostRequest { listIDsRequest: ListIDsRequest; } export interface ListUsersV1IndexesIndexNameUsersGetRequest { indexName: string; xIndexKey?: string | null; } export interface QueryMetadataV1VectorsQueryMetadataPostRequest { queryMetadataRequest: QueryMetadataRequest; } export interface QueryVectorsBinaryV1VectorsQueryBinaryPostRequest { binaryQueryRequest: BinaryQueryRequest; } export interface QueryVectorsV1VectorsQueryPostRequest { request: Request; } export interface TrainIndexV1IndexesTrainPostRequest { trainRequest: TrainRequest; } export interface UpsertVectorsBinaryV1VectorsUpsertBinaryPostRequest { binaryUpsertRequest: BinaryUpsertRequest; } export interface UpsertVectorsV1VectorsUpsertPostRequest { upsertRequest: UpsertRequest; } /** * */ export declare class DefaultApi extends runtime.BaseAPI { /** * Creates request options for createIndexV1IndexesCreatePost without sending the request */ createIndexV1IndexesCreatePostRequestOpts(requestParameters: CreateIndexV1IndexesCreatePostRequest): Promise; /** * Create a new encrypted index with the provided configuration. Exactly one of `kms_name` / `index_key` must be set; supplying both is rejected with 400. * `kms_name` set — service generates a random KEK, wraps it via the named registry slot\'s KMS, persists the envelope, and uses the plaintext KEK as `index_key` on the core call. CEI generates the DEK and wraps it under that KEK internally. * `index_key` set — SDK-supplied KEK; envelope persisted with `provider=\"none\"`. The SDK must re-supply `index_key` on every subsequent request for this index. * Create Encrypted Index */ createIndexV1IndexesCreatePostRaw(requestParameters: CreateIndexV1IndexesCreatePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new encrypted index with the provided configuration. Exactly one of `kms_name` / `index_key` must be set; supplying both is rejected with 400. * `kms_name` set — service generates a random KEK, wraps it via the named registry slot\'s KMS, persists the envelope, and uses the plaintext KEK as `index_key` on the core call. CEI generates the DEK and wraps it under that KEK internally. * `index_key` set — SDK-supplied KEK; envelope persisted with `provider=\"none\"`. The SDK must re-supply `index_key` on every subsequent request for this index. * Create Encrypted Index */ createIndexV1IndexesCreatePost(requestParameters: CreateIndexV1IndexesCreatePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for createUserV1IndexesIndexNameUsersPost without sending the request */ createUserV1IndexesIndexNameUsersPostRequestOpts(requestParameters: CreateUserV1IndexesIndexNameUsersPostRequest): Promise; /** * Mint a user API key with the given permissions, scoped to this index. The api_key is returned once and never stored — only the user holds it. * Create a user for an index */ createUserV1IndexesIndexNameUsersPostRaw(requestParameters: CreateUserV1IndexesIndexNameUsersPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Mint a user API key with the given permissions, scoped to this index. The api_key is returned once and never stored — only the user holds it. * Create a user for an index */ createUserV1IndexesIndexNameUsersPost(requestParameters: CreateUserV1IndexesIndexNameUsersPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteIndexV1IndexesDeletePost without sending the request */ deleteIndexV1IndexesDeletePostRequestOpts(requestParameters: DeleteIndexV1IndexesDeletePostRequest): Promise; /** * Delete a specific index. Admin-only: deleting an index drops the KMS envelope and every user\'s wrapped DEK, so it sits alongside create/train as a root operation rather than a per-user write op. * Delete Encrypted Index */ deleteIndexV1IndexesDeletePostRaw(requestParameters: DeleteIndexV1IndexesDeletePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Delete a specific index. Admin-only: deleting an index drops the KMS envelope and every user\'s wrapped DEK, so it sits alongside create/train as a root operation rather than a per-user write op. * Delete Encrypted Index */ deleteIndexV1IndexesDeletePost(requestParameters: DeleteIndexV1IndexesDeletePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteUserV1IndexesIndexNameUsersUserIdDelete without sending the request */ deleteUserV1IndexesIndexNameUsersUserIdDeleteRequestOpts(requestParameters: DeleteUserV1IndexesIndexNameUsersUserIdDeleteRequest): Promise; /** * Delete (revoke) a user */ deleteUserV1IndexesIndexNameUsersUserIdDeleteRaw(requestParameters: DeleteUserV1IndexesIndexNameUsersUserIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Delete (revoke) a user */ deleteUserV1IndexesIndexNameUsersUserIdDelete(requestParameters: DeleteUserV1IndexesIndexNameUsersUserIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteVectorsV1VectorsDeletePost without sending the request */ deleteVectorsV1VectorsDeletePostRequestOpts(requestParameters: DeleteVectorsV1VectorsDeletePostRequest): Promise; /** * Delete vectors by their IDs. * Delete Items from Encrypted Index */ deleteVectorsV1VectorsDeletePostRaw(requestParameters: DeleteVectorsV1VectorsDeletePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Delete vectors by their IDs. * Delete Items from Encrypted Index */ deleteVectorsV1VectorsDeletePost(requestParameters: DeleteVectorsV1VectorsDeletePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for getIndexInfoV1IndexesDescribePost without sending the request */ getIndexInfoV1IndexesDescribePostRequestOpts(requestParameters: GetIndexInfoV1IndexesDescribePostRequest): Promise; /** * Get information about a specific index. * Describe Encrypted Index */ getIndexInfoV1IndexesDescribePostRaw(requestParameters: GetIndexInfoV1IndexesDescribePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get information about a specific index. * Describe Encrypted Index */ getIndexInfoV1IndexesDescribePost(requestParameters: GetIndexInfoV1IndexesDescribePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for getIndexSizeV1VectorsNumVectorsPost without sending the request */ getIndexSizeV1VectorsNumVectorsPostRequestOpts(requestParameters: GetIndexSizeV1VectorsNumVectorsPostRequest): Promise; /** * Get the number of vectors stored in an index * Get the number of vectors in an index */ getIndexSizeV1VectorsNumVectorsPostRaw(requestParameters: GetIndexSizeV1VectorsNumVectorsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get the number of vectors stored in an index * Get the number of vectors in an index */ getIndexSizeV1VectorsNumVectorsPost(requestParameters: GetIndexSizeV1VectorsNumVectorsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for getTrainingStatusV1IndexesTrainingStatusGet without sending the request */ getTrainingStatusV1IndexesTrainingStatusGetRequestOpts(): Promise; /** * Get the current training status including indexes being trained and the auto-train configuration. Returns: dict: Training status information including: - training_indexes: List of index names currently being trained - retrain_threshold: Vector-count floor before the first training * Get Training Status */ getTrainingStatusV1IndexesTrainingStatusGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get the current training status including indexes being trained and the auto-train configuration. Returns: dict: Training status information including: - training_indexes: List of index names currently being trained - retrain_threshold: Vector-count floor before the first training * Get Training Status */ getTrainingStatusV1IndexesTrainingStatusGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for getVectorsV1VectorsGetPost without sending the request */ getVectorsV1VectorsGetPostRequestOpts(requestParameters: GetVectorsV1VectorsGetPostRequest): Promise; /** * Retrieve vectors by their IDs. * Get Items from Encrypted Index */ getVectorsV1VectorsGetPostRaw(requestParameters: GetVectorsV1VectorsGetPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve vectors by their IDs. * Get Items from Encrypted Index */ getVectorsV1VectorsGetPost(requestParameters: GetVectorsV1VectorsGetPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for healthCheckV1HealthGet without sending the request */ healthCheckV1HealthGetRequestOpts(): Promise; /** * Check if the API is running. * Health check endpoint */ healthCheckV1HealthGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Check if the API is running. * Health check endpoint */ healthCheckV1HealthGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: string; }>; /** * Creates request options for listIdsV1VectorsListIdsPost without sending the request */ listIdsV1VectorsListIdsPostRequestOpts(requestParameters: ListIdsV1VectorsListIdsPostRequest): Promise; /** * List all item IDs currently stored in the index. Returns a list of all IDs and the total count. * List all IDs in an index */ listIdsV1VectorsListIdsPostRaw(requestParameters: ListIdsV1VectorsListIdsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * List all item IDs currently stored in the index. Returns a list of all IDs and the total count. * List all IDs in an index */ listIdsV1VectorsListIdsPost(requestParameters: ListIdsV1VectorsListIdsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listIndexesV1IndexesListGet without sending the request */ listIndexesV1IndexesListGetRequestOpts(): Promise; /** * List all available indexes. * List Encrypted Indexes */ listIndexesV1IndexesListGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * List all available indexes. * List Encrypted Indexes */ listIndexesV1IndexesListGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listUsersV1IndexesIndexNameUsersGet without sending the request */ listUsersV1IndexesIndexNameUsersGetRequestOpts(requestParameters: ListUsersV1IndexesIndexNameUsersGetRequest): Promise; /** * List an index\'s users */ listUsersV1IndexesIndexNameUsersGetRaw(requestParameters: ListUsersV1IndexesIndexNameUsersGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * List an index\'s users */ listUsersV1IndexesIndexNameUsersGet(requestParameters: ListUsersV1IndexesIndexNameUsersGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for queryMetadataV1VectorsQueryMetadataPost without sending the request */ queryMetadataV1VectorsQueryMetadataPostRequestOpts(requestParameters: QueryMetadataV1VectorsQueryMetadataPostRequest): Promise; /** * Find items by metadata alone — no query vector. With no `text`, resolves the filter entirely from the encrypted metadata index and returns the matching items, unscored. With `text`, runs BM25 over the index\'s full_text fields and returns the top matches ranked by score; a filter given alongside acts as a pre-filter. Works on untrained indexes. Because there is no post-filter stage to fall back on, the index\'s `metadata_schema` is enforced here: `$regex` / `$contains` need a `pattern` field, and a `filterable: false` field cannot be filtered on. Both come back as 400 with the reason. `/query` with a vector has no such restriction. * Query an Encrypted Index by Metadata Only */ queryMetadataV1VectorsQueryMetadataPostRaw(requestParameters: QueryMetadataV1VectorsQueryMetadataPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Find items by metadata alone — no query vector. With no `text`, resolves the filter entirely from the encrypted metadata index and returns the matching items, unscored. With `text`, runs BM25 over the index\'s full_text fields and returns the top matches ranked by score; a filter given alongside acts as a pre-filter. Works on untrained indexes. Because there is no post-filter stage to fall back on, the index\'s `metadata_schema` is enforced here: `$regex` / `$contains` need a `pattern` field, and a `filterable: false` field cannot be filtered on. Both come back as 400 with the reason. `/query` with a vector has no such restriction. * Query an Encrypted Index by Metadata Only */ queryMetadataV1VectorsQueryMetadataPost(requestParameters: QueryMetadataV1VectorsQueryMetadataPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for queryVectorsBinaryV1VectorsQueryBinaryPost without sending the request */ queryVectorsBinaryV1VectorsQueryBinaryPostRequestOpts(requestParameters: QueryVectorsBinaryV1VectorsQueryBinaryPostRequest): Promise; /** * Search for nearest neighbors using binary format for query vectors. This endpoint is optimized for large batch queries. Query vectors are sent as base64-encoded float32 numpy arrays, which is more efficient than JSON arrays for large batches. * Query Encrypted Index (Binary Format) */ queryVectorsBinaryV1VectorsQueryBinaryPostRaw(requestParameters: QueryVectorsBinaryV1VectorsQueryBinaryPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Search for nearest neighbors using binary format for query vectors. This endpoint is optimized for large batch queries. Query vectors are sent as base64-encoded float32 numpy arrays, which is more efficient than JSON arrays for large batches. * Query Encrypted Index (Binary Format) */ queryVectorsBinaryV1VectorsQueryBinaryPost(requestParameters: QueryVectorsBinaryV1VectorsQueryBinaryPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for queryVectorsV1VectorsQueryPost without sending the request */ queryVectorsV1VectorsQueryPostRequestOpts(requestParameters: QueryVectorsV1VectorsQueryPostRequest): Promise; /** * Search for nearest neighbors in the index. * Query Encrypted Index */ queryVectorsV1VectorsQueryPostRaw(requestParameters: QueryVectorsV1VectorsQueryPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Search for nearest neighbors in the index. * Query Encrypted Index */ queryVectorsV1VectorsQueryPost(requestParameters: QueryVectorsV1VectorsQueryPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for trainIndexV1IndexesTrainPost without sending the request */ trainIndexV1IndexesTrainPostRequestOpts(requestParameters: TrainIndexV1IndexesTrainPostRequest): Promise; /** * Train the index for efficient querying. Training is queued and processed asynchronously. If the index is already being trained or queued, returns the current status. * Train Encrypted index */ trainIndexV1IndexesTrainPostRaw(requestParameters: TrainIndexV1IndexesTrainPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Train the index for efficient querying. Training is queued and processed asynchronously. If the index is already being trained or queued, returns the current status. * Train Encrypted index */ trainIndexV1IndexesTrainPost(requestParameters: TrainIndexV1IndexesTrainPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for upsertVectorsBinaryV1VectorsUpsertBinaryPost without sending the request */ upsertVectorsBinaryV1VectorsUpsertBinaryPostRequestOpts(requestParameters: UpsertVectorsBinaryV1VectorsUpsertBinaryPostRequest): Promise; /** * Add or update vectors in the index using binary format. This endpoint is optimized for large batches of vectors. Vectors are sent as base64-encoded float32 numpy arrays, which is much more efficient than JSON arrays for large datasets. After upserting, checks if the index needs training/retraining based on the number of vectors and triggers automatic training if needed. * Add Items to Encrypted Index (Binary Format) */ upsertVectorsBinaryV1VectorsUpsertBinaryPostRaw(requestParameters: UpsertVectorsBinaryV1VectorsUpsertBinaryPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Add or update vectors in the index using binary format. This endpoint is optimized for large batches of vectors. Vectors are sent as base64-encoded float32 numpy arrays, which is much more efficient than JSON arrays for large datasets. After upserting, checks if the index needs training/retraining based on the number of vectors and triggers automatic training if needed. * Add Items to Encrypted Index (Binary Format) */ upsertVectorsBinaryV1VectorsUpsertBinaryPost(requestParameters: UpsertVectorsBinaryV1VectorsUpsertBinaryPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for upsertVectorsV1VectorsUpsertPost without sending the request */ upsertVectorsV1VectorsUpsertPostRequestOpts(requestParameters: UpsertVectorsV1VectorsUpsertPostRequest): Promise; /** * Add or update vectors in the index. After upserting, checks if the index needs training/retraining based on the number of vectors and triggers automatic training if needed. * Add Items to Encrypted Index */ upsertVectorsV1VectorsUpsertPostRaw(requestParameters: UpsertVectorsV1VectorsUpsertPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Add or update vectors in the index. After upserting, checks if the index needs training/retraining based on the number of vectors and triggers automatic training if needed. * Add Items to Encrypted Index */ upsertVectorsV1VectorsUpsertPost(requestParameters: UpsertVectorsV1VectorsUpsertPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }