cloudflare/resources/vectorize/indexes.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as IndexesAPI from 'cloudflare/resources/vectorize/indexes';
import { SinglePage } from 'cloudflare/pagination';
export declare class Indexes extends APIResource {
    /**
     * Creates and returns a new Vectorize Index.
     */
    create(params: IndexCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreateIndex | null>;
    /**
     * Updates and returns the specified Vectorize Index.
     */
    update(indexName: string, params: IndexUpdateParams, options?: Core.RequestOptions): Core.APIPromise<CreateIndex | null>;
    /**
     * Returns a list of Vectorize Indexes
     */
    list(params: IndexListParams, options?: Core.RequestOptions): Core.PagePromise<CreateIndicesSinglePage, CreateIndex>;
    /**
     * Deletes the specified Vectorize Index.
     */
    delete(indexName: string, params: IndexDeleteParams, options?: Core.RequestOptions): Core.APIPromise<IndexDeleteResponse>;
    /**
     * Delete a set of vectors from an index by their vector identifiers.
     */
    deleteByIds(indexName: string, params: IndexDeleteByIDsParams, options?: Core.RequestOptions): Core.APIPromise<IndexDeleteVectorsByID | null>;
    /**
     * Returns the specified Vectorize Index.
     */
    get(indexName: string, params: IndexGetParams, options?: Core.RequestOptions): Core.APIPromise<CreateIndex | null>;
    /**
     * Get a set of vectors from an index by their vector identifiers.
     */
    getByIds(indexName: string, params: IndexGetByIDsParams, options?: Core.RequestOptions): Core.APIPromise<IndexGetByIDsResponse | null>;
    /**
     * Inserts vectors into the specified index and returns the count of the vectors
     * successfully inserted.
     */
    insert(indexName: string, params: IndexInsertParams, options?: Core.RequestOptions): Core.APIPromise<IndexInsert | null>;
    /**
     * Finds vectors closest to a given vector in an index.
     */
    query(indexName: string, params: IndexQueryParams, options?: Core.RequestOptions): Core.APIPromise<IndexQuery | null>;
    /**
     * Upserts vectors into the specified index, creating them if they do not exist and
     * returns the count of values and ids successfully inserted.
     */
    upsert(indexName: string, params: IndexUpsertParams, options?: Core.RequestOptions): Core.APIPromise<IndexUpsert | null>;
}
export declare class CreateIndicesSinglePage extends SinglePage<CreateIndex> {
}
export interface CreateIndex {
    config?: IndexDimensionConfiguration;
    /**
     * Specifies the timestamp the resource was created as an ISO8601 string.
     */
    created_on?: string;
    /**
     * Specifies the description of the index.
     */
    description?: string;
    /**
     * Specifies the timestamp the resource was modified as an ISO8601 string.
     */
    modified_on?: string;
    name?: string;
}
export interface IndexDeleteVectorsByID {
    /**
     * The count of the vectors successfully deleted.
     */
    count?: number;
    /**
     * Array of vector identifiers of the vectors that were successfully processed for
     * deletion.
     */
    ids?: Array<string>;
}
export interface IndexDimensionConfiguration {
    /**
     * Specifies the number of dimensions for the index
     */
    dimensions: number;
    /**
     * Specifies the type of metric to use calculating distance.
     */
    metric: 'cosine' | 'euclidean' | 'dot-product';
}
export interface IndexInsert {
    /**
     * Specifies the count of the vectors successfully inserted.
     */
    count?: number;
    /**
     * Array of vector identifiers of the vectors successfully inserted.
     */
    ids?: Array<string>;
}
export interface IndexQuery {
    /**
     * Specifies the count of vectors returned by the search
     */
    count?: number;
    /**
     * Array of vectors matched by the search
     */
    matches?: Array<IndexQuery.Match>;
}
export declare namespace IndexQuery {
    interface Match {
        /**
         * Identifier
         */
        id?: string;
        metadata?: unknown | null;
        /**
         * The score of the vector according to the index's distance metric
         */
        score?: number;
        values?: Array<number> | null;
    }
}
export interface IndexUpsert {
    /**
     * Specifies the count of the vectors successfully inserted.
     */
    count?: number;
    /**
     * Array of vector identifiers of the vectors successfully inserted.
     */
    ids?: Array<string>;
}
export type IndexDeleteResponse = unknown | string | null;
/**
 * Array of vectors with matching ids.
 */
export type IndexGetByIDsResponse = unknown;
export interface IndexCreateParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param: Specifies the type of configuration to use for the index.
     */
    config: IndexDimensionConfiguration | IndexCreateParams.VectorizeIndexPresetConfiguration;
    /**
     * Body param:
     */
    name: string;
    /**
     * Body param: Specifies the description of the index.
     */
    description?: string;
}
export declare namespace IndexCreateParams {
    interface VectorizeIndexPresetConfiguration {
        /**
         * Specifies the preset to use for the index.
         */
        preset: '@cf/baai/bge-small-en-v1.5' | '@cf/baai/bge-base-en-v1.5' | '@cf/baai/bge-large-en-v1.5' | 'openai/text-embedding-ada-002' | 'cohere/embed-multilingual-v2.0';
    }
}
export interface IndexUpdateParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param: Specifies the description of the index.
     */
    description: string;
}
export interface IndexListParams {
    /**
     * Identifier
     */
    account_id: string;
}
export interface IndexDeleteParams {
    /**
     * Identifier
     */
    account_id: string;
}
export interface IndexDeleteByIDsParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param: A list of vector identifiers to delete from the index indicated by
     * the path.
     */
    ids?: Array<string>;
}
export interface IndexGetParams {
    /**
     * Identifier
     */
    account_id: string;
}
export interface IndexGetByIDsParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param: A list of vector identifiers to retrieve from the index indicated by
     * the path.
     */
    ids?: Array<string>;
}
export interface IndexInsertParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param:
     */
    body: unknown;
}
export interface IndexQueryParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param: The search vector that will be used to find the nearest neighbors.
     */
    vector: Array<number>;
    /**
     * Body param: A metadata filter expression used to limit nearest neighbor results.
     */
    filter?: unknown;
    /**
     * Body param: Whether to return the metadata associated with the closest vectors.
     */
    returnMetadata?: boolean;
    /**
     * Body param: Whether to return the values associated with the closest vectors.
     */
    returnValues?: boolean;
    /**
     * Body param: The number of nearest neighbors to find.
     */
    topK?: number;
}
export interface IndexUpsertParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param:
     */
    body: unknown;
}
export declare namespace Indexes {
    export import CreateIndex = IndexesAPI.CreateIndex;
    export import IndexDeleteVectorsByID = IndexesAPI.IndexDeleteVectorsByID;
    export import IndexDimensionConfiguration = IndexesAPI.IndexDimensionConfiguration;
    export import IndexInsert = IndexesAPI.IndexInsert;
    export import IndexQuery = IndexesAPI.IndexQuery;
    export import IndexUpsert = IndexesAPI.IndexUpsert;
    export import IndexDeleteResponse = IndexesAPI.IndexDeleteResponse;
    export import IndexGetByIDsResponse = IndexesAPI.IndexGetByIDsResponse;
    export import CreateIndicesSinglePage = IndexesAPI.CreateIndicesSinglePage;
    export import IndexCreateParams = IndexesAPI.IndexCreateParams;
    export import IndexUpdateParams = IndexesAPI.IndexUpdateParams;
    export import IndexListParams = IndexesAPI.IndexListParams;
    export import IndexDeleteParams = IndexesAPI.IndexDeleteParams;
    export import IndexDeleteByIDsParams = IndexesAPI.IndexDeleteByIDsParams;
    export import IndexGetParams = IndexesAPI.IndexGetParams;
    export import IndexGetByIDsParams = IndexesAPI.IndexGetByIDsParams;
    export import IndexInsertParams = IndexesAPI.IndexInsertParams;
    export import IndexQueryParams = IndexesAPI.IndexQueryParams;
    export import IndexUpsertParams = IndexesAPI.IndexUpsertParams;
}
//# sourceMappingURL=indexes.d.ts.map