@databricks/sdk-vectorsearch 0.0.0-dev → 0.1.0-dev.1

package/dist/v1/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/v1/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,MAAM,EAAE,oBAAoB,EAAC,MAAM,UAAU,CAAC;AAEtD,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,sBAAsB,EACtB,eAAe,EACf,oBAAoB,GACrB,MAAM,SAAS,CAAC;AAEjB,YAAY,EACV,UAAU,EACV,qBAAqB,EACrB,wBAAwB,EACxB,SAAS,EACT,4BAA4B,EAC5B,6BAA6B,EAC7B,qBAAqB,EACrB,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EACzB,wBAAwB,EACxB,+BAA+B,EAC/B,2BAA2B,EAC3B,qBAAqB,EACrB,qBAAqB,EACrB,QAAQ,EACR,mBAAmB,EACnB,cAAc,EACd,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,SAAS,EACT,sBAAsB,EACtB,uBAAuB,EACvB,mBAAmB,EACnB,MAAM,EACN,WAAW,EACX,WAAW,EACX,YAAY,EACZ,eAAe,EACf,gCAAgC,EAChC,iCAAiC,EACjC,oBAAoB,EACpB,+BAA+B,EAC/B,uBAAuB,EACvB,wBAAwB,EACxB,cAAc,EACd,iCAAiC,EACjC,UAAU,EACV,cAAc,EACd,iCAAiC,EACjC,kCAAkC,EAClC,sBAAsB,EACtB,uBAAuB,EACvB,MAAM,EACN,sBAAsB,EACtB,uBAAuB,EACvB,+BAA+B,EAC/B,gCAAgC,EAChC,4BAA4B,EAC5B,6BAA6B,EAC7B,sBAAsB,EACtB,KAAK,EACL,WAAW,EACX,iBAAiB,GAClB,MAAM,SAAS,CAAC"}

package/dist/v1/index.js

@@ -0,0 +1,4 @@
+// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
+export { Client, CreateEndpointWaiter } from './client';
+export { EndpointType, IndexSubtype, PipelineType, ScalingChangeState, UpsertDeleteDataStatus, VectorIndexType, EndpointStatus_State, } from './model';
+//# sourceMappingURL=index.js.map

package/dist/v1/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/v1/index.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAE/E,OAAO,EAAC,MAAM,EAAE,oBAAoB,EAAC,MAAM,UAAU,CAAC;AAEtD,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,sBAAsB,EACtB,eAAe,EACf,oBAAoB,GACrB,MAAM,SAAS,CAAC"}

package/dist/v1/model.d.ts

@@ -0,0 +1,661 @@
+import type { Temporal } from '@js-temporal/polyfill';
+import type { JsonValue } from '@databricks/sdk-core/wkt';
+import { z } from 'zod';
+/** Type of endpoint. */
+export declare enum EndpointType {
+    STORAGE_OPTIMIZED = "STORAGE_OPTIMIZED",
+    STANDARD = "STANDARD"
+}
+/**
+ * The subtype of the AI Search index, determining the indexing and retrieval strategy.
+ * - `VECTOR`: Not supported. Use `HYBRID` instead.
+ * - `FULL_TEXT`: An index that uses full-text search without vector embeddings.
+ * - `HYBRID`: An index that uses vector embeddings for similarity search and hybrid search.
+ */
+export declare enum IndexSubtype {
+    VECTOR = "VECTOR",
+    FULL_TEXT = "FULL_TEXT",
+    HYBRID = "HYBRID"
+}
+/**
+ * Pipeline execution mode.
+ * - `TRIGGERED`: If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.
+ * - `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh.
+ */
+export declare enum PipelineType {
+    TRIGGERED = "TRIGGERED",
+    CONTINUOUS = "CONTINUOUS"
+}
+export declare enum ScalingChangeState {
+    SCALING_CHANGE_UNSPECIFIED = "SCALING_CHANGE_UNSPECIFIED",
+    SCALING_CHANGE_APPLIED = "SCALING_CHANGE_APPLIED",
+    SCALING_CHANGE_IN_PROGRESS = "SCALING_CHANGE_IN_PROGRESS"
+}
+export declare enum UpsertDeleteDataStatus {
+    SUCCESS = "SUCCESS",
+    PARTIAL_SUCCESS = "PARTIAL_SUCCESS",
+    FAILURE = "FAILURE"
+}
+/**
+ * There are 2 types of AI Search indexes:
+ * - `DELTA_SYNC`: An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes.
+ * - `DIRECT_ACCESS`: An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates.
+ */
+export declare enum VectorIndexType {
+    DELTA_SYNC = "DELTA_SYNC",
+    DIRECT_ACCESS = "DIRECT_ACCESS"
+}
+/** Current state of the endpoint */
+export declare enum EndpointStatus_State {
+    PROVISIONING = "PROVISIONING",
+    ONLINE = "ONLINE",
+    OFFLINE = "OFFLINE",
+    /**
+     * After the endpoint is ready, it can be in one of the following states:
+     * - RED_STATE: The endpoint is unhealthy and needs to be investigated.
+     * - YELLOW_STATE: The endpoint is healthy but needs to be monitored.
+     * - ONLINE: The endpoint is healthy and ready to serve traffic.
+     */
+    RED_STATE = "RED_STATE",
+    YELLOW_STATE = "YELLOW_STATE",
+    /**
+     * The endpoint is being deleted or has been deleted. Associated resources
+     * are being cleaned up; once cleanup completes the endpoint will no longer
+     * be retrievable.
+     */
+    DELETED = "DELETED"
+}
+export interface ColumnInfo {
+    /** Name of the column. */
+    name?: string | undefined;
+    /** Data type of the column (e.g., "string", "int", "array<float>") */
+    typeText?: string | undefined;
+}
+export interface CreateEndpointRequest {
+    /** Name of the AI Search endpoint */
+    name?: string | undefined;
+    /** Type of endpoint */
+    endpointType?: EndpointType | undefined;
+    /** The budget policy id to be applied */
+    budgetPolicyId?: string | undefined;
+    /** The usage policy id to be applied once we've migrated to usage policies */
+    usagePolicyId?: string | undefined;
+    /**
+     * Target QPS for the endpoint. Mutually exclusive with num_replicas.
+     * The actual replica count is calculated at index creation/sync time based on this value.
+     * Best-effort target; the system does not guarantee this QPS will be achieved.
+     */
+    targetQps?: bigint | undefined;
+}
+export interface CreateVectorIndexRequest {
+    /** Name of the index */
+    name?: string | undefined;
+    /** Name of the endpoint to be used for serving the index */
+    endpointName?: string | undefined;
+    /** Primary key of the index */
+    primaryKey?: string | undefined;
+    indexType?: VectorIndexType | undefined;
+    indexSpec?: {
+        $case: 'directAccessIndexSpec';
+        /** Specification for Direct Vector Access Index. Required if `index_type` is `DIRECT_ACCESS`. */
+        directAccessIndexSpec: DirectAccessVectorIndexSpec;
+    } | {
+        $case: 'deltaSyncIndexSpec';
+        /** Specification for Delta Sync Index. Required if `index_type` is `DELTA_SYNC`. */
+        deltaSyncIndexSpec: DeltaSyncVectorIndexSpecRequest;
+    } | undefined;
+    /** The subtype of the index. Use `HYBRID` or `FULL_TEXT`. `VECTOR` is not supported. */
+    indexSubtype?: IndexSubtype | undefined;
+}
+export interface CustomTag {
+    /** Key field for an AI Search endpoint tag. */
+    key?: string | undefined;
+    /** [Optional] Value field for an AI Search endpoint tag. */
+    value?: string | undefined;
+}
+/** Request payload for deleting data from a vector index. */
+export interface DeleteDataVectorIndexRequest {
+    /** Name of the vector index where data is to be deleted. Must be a Direct Vector Access Index. */
+    name?: string | undefined;
+    /** List of primary keys for the data to be deleted. */
+    primaryKeys?: string[] | undefined;
+}
+export interface DeleteDataVectorIndexResponse {
+    /** Status of the delete operation. */
+    status?: UpsertDeleteDataStatus | undefined;
+    /** Result of the upsert or delete operation. */
+    result?: UpsertDeleteDataResult | undefined;
+}
+export interface DeleteEndpointRequest {
+    /** Name of the AI Search endpoint */
+    name?: string | undefined;
+}
+export interface DeleteEndpointResponse {
+}
+export interface DeleteVectorIndexRequest {
+    /** Name of the index */
+    name?: string | undefined;
+}
+export interface DeleteVectorIndexResponse {
+}
+export interface DeltaSyncVectorIndexSpec {
+    /** The name of the source table. */
+    sourceTable?: string | undefined;
+    /** The columns that contain the embedding source. */
+    embeddingSourceColumns?: EmbeddingSourceColumn[] | undefined;
+    /** The columns that contain the embedding vectors. */
+    embeddingVectorColumns?: EmbeddingVectorColumn[] | undefined;
+    /**
+     * Pipeline execution mode.
+     * - `TRIGGERED`: If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.
+     * - `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh.
+     */
+    pipelineType?: PipelineType | undefined;
+    /** The ID of the pipeline that is used to sync the index. */
+    pipelineId?: string | undefined;
+    /** [Optional] Name of the Delta table to sync the vector index contents and computed embeddings to. */
+    embeddingWritebackTable?: string | undefined;
+    /**
+     * [Optional] Select the columns to sync with the vector index. If you leave this field blank, all columns
+     * from the source table are synced with the index. The primary key column and embedding source column or
+     * embedding vector column are always synced.
+     */
+    columnsToSync?: string[] | undefined;
+    /**
+     * [Optional] Alias for columns_to_sync. Select the columns to include in the vector index.
+     * If you leave this field blank, all columns from the source table are included.
+     * The primary key column and embedding source column or embedding vector column are always included.
+     * Only one of columns_to_sync or columns_to_index may be specified.
+     */
+    columnsToIndex?: string[] | undefined;
+}
+export interface DeltaSyncVectorIndexSpecRequest {
+    /** The name of the source table. */
+    sourceTable?: string | undefined;
+    /** The columns that contain the embedding source. */
+    embeddingSourceColumns?: EmbeddingSourceColumn[] | undefined;
+    /** The columns that contain the embedding vectors. */
+    embeddingVectorColumns?: EmbeddingVectorColumn[] | undefined;
+    /**
+     * Pipeline execution mode.
+     * - `TRIGGERED`: If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.
+     * - `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh.
+     */
+    pipelineType?: PipelineType | undefined;
+    /** The ID of the pipeline that is used to sync the index. */
+    pipelineId?: string | undefined;
+    /** [Optional] Name of the Delta table to sync the vector index contents and computed embeddings to. */
+    embeddingWritebackTable?: string | undefined;
+    /**
+     * [Optional] Select the columns to sync with the vector index. If you leave this field blank, all columns
+     * from the source table are synced with the index. The primary key column and embedding source column or
+     * embedding vector column are always synced.
+     */
+    columnsToSync?: string[] | undefined;
+    /**
+     * [Optional] Alias for columns_to_sync. Select the columns to include in the vector index.
+     * If you leave this field blank, all columns from the source table are included.
+     * The primary key column and embedding source column or embedding vector column are always included.
+     * Only one of columns_to_sync or columns_to_index may be specified.
+     */
+    columnsToIndex?: string[] | undefined;
+}
+export interface DirectAccessVectorIndexSpec {
+    /** The columns that contain the embedding vectors. The format should be array[double]. */
+    embeddingVectorColumns?: EmbeddingVectorColumn[] | undefined;
+    /**
+     * The schema of the index in JSON format.
+     * Supported types are `integer`, `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`.
+     * Supported types for vector column: `array<float>`, `array<double>`,`.
+     */
+    schemaJson?: string | undefined;
+    /** The columns that contain the embedding source. The format should be array[double]. */
+    embeddingSourceColumns?: EmbeddingSourceColumn[] | undefined;
+}
+export interface EmbeddingSourceColumn {
+    /** Name of the column */
+    name?: string | undefined;
+    /** TODO: clean up ai gateway related code. It's deprecated on ModelServing side. */
+    embeddingConfig?: {
+        $case: 'embeddingModelEndpointName';
+        /** Name of the embedding model endpoint, used by default for both ingestion and querying. */
+        embeddingModelEndpointName: string;
+    } | undefined;
+    /** Name of the embedding model endpoint which, if specified, is used for querying (not ingestion). */
+    modelEndpointNameForQuery?: string | undefined;
+}
+export interface EmbeddingVectorColumn {
+    /** Name of the column */
+    name?: string | undefined;
+    /** Dimension of the embedding vector */
+    embeddingDimension?: number | undefined;
+}
+export interface Endpoint {
+    /** Name of the AI Search endpoint */
+    name?: string | undefined;
+    /** Creator of the endpoint */
+    creator?: string | undefined;
+    /** Timestamp of endpoint creation */
+    creationTimestamp?: bigint | undefined;
+    /** Timestamp of last update to the endpoint */
+    lastUpdatedTimestamp?: bigint | undefined;
+    /** Type of endpoint */
+    endpointType?: EndpointType | undefined;
+    /** User who last updated the endpoint */
+    lastUpdatedUser?: string | undefined;
+    /** Unique identifier of the endpoint */
+    id?: string | undefined;
+    /** Current status of the endpoint */
+    endpointStatus?: EndpointStatus | undefined;
+    /** Number of indexes on the endpoint */
+    numIndexes?: number | undefined;
+    /** The user-selected budget policy id for the endpoint. */
+    budgetPolicyId?: string | undefined;
+    /** The budget policy id applied to the endpoint */
+    effectiveBudgetPolicyId?: string | undefined;
+    /** The custom tags assigned to the endpoint */
+    customTags?: CustomTag[] | undefined;
+    /** Scaling information for the endpoint */
+    scalingInfo?: EndpointScalingInfo | undefined;
+}
+export interface EndpointScalingInfo {
+    /** The current state of the scaling change request. */
+    state?: ScalingChangeState | undefined;
+    /**
+     * The requested QPS target for the endpoint. Best-effort; the system does not
+     * guarantee this QPS will be achieved.
+     */
+    requestedTargetQps?: bigint | undefined;
+}
+/** Status information of an endpoint */
+export interface EndpointStatus {
+    /** Current state of the endpoint */
+    state?: EndpointStatus_State | undefined;
+    /** Additional status message */
+    message?: string | undefined;
+}
+export interface GetEndpointRequest {
+    /** Name of the endpoint */
+    name?: string | undefined;
+}
+export interface GetVectorIndexRequest {
+    /** Name of the index */
+    name?: string | undefined;
+    /**
+     * If true, the URL returned for the index is guaranteed to be compatible with the reranker.
+     * Currently this means we return the CP URL regardless of how the index is being accessed.
+     * If not set or set to false, the URL may still be compatible with the reranker depending on
+     * what URL we return.
+     */
+    ensureRerankerCompatible?: boolean | undefined;
+}
+export interface ListEndpointRequest {
+    /** Token for pagination */
+    pageToken?: string | undefined;
+}
+export interface ListEndpointResponse {
+    /** An array of Endpoint objects */
+    endpoints?: Endpoint[] | undefined;
+    /** A token that can be used to get the next page of results. If not present, there are no more results to show. */
+    nextPageToken?: string | undefined;
+}
+export interface ListValue {
+    /** Repeated field of dynamically typed values. */
+    values?: Value[] | undefined;
+}
+export interface ListVectorIndexRequest {
+    /** Name of the endpoint */
+    endpointName?: string | undefined;
+    /** Token for pagination */
+    pageToken?: string | undefined;
+}
+export interface ListVectorIndexResponse {
+    vectorIndexes?: MiniVectorIndex[] | undefined;
+    /** A token that can be used to get the next page of results. If not present, there are no more results to show. */
+    nextPageToken?: string | undefined;
+}
+/** Key-value pair. */
+export interface MapStringValueEntry {
+    /** Column name. */
+    key?: string | undefined;
+    /** Column value, nullable. */
+    value?: Value | undefined;
+}
+/** Metric specification */
+export interface Metric {
+    /** Metric name */
+    name?: string | undefined;
+    /** Metric labels */
+    labels?: MetricLabel[] | undefined;
+    /** Percentile for the metric */
+    percentile?: number | undefined;
+}
+/** Label for a metric */
+export interface MetricLabel {
+    /** Label name */
+    name?: string | undefined;
+    /** Label value */
+    value?: string | undefined;
+}
+/** Single metric value at a specific timestamp */
+export interface MetricValue {
+    /** Timestamp of the metric value (milliseconds since epoch) */
+    timestamp?: bigint | undefined;
+    /** Metric value */
+    value?: number | undefined;
+}
+/** Collection of metric values for a specific metric */
+export interface MetricValues {
+    /** Metric specification */
+    metric?: Metric | undefined;
+    /** Time series of metric values */
+    values?: MetricValue[] | undefined;
+}
+export interface MiniVectorIndex {
+    /** Name of the index */
+    name?: string | undefined;
+    /** Name of the endpoint associated with the index */
+    endpointName?: string | undefined;
+    /** Primary key of the index */
+    primaryKey?: string | undefined;
+    indexType?: VectorIndexType | undefined;
+    indexSpec?: {
+        $case: 'directAccessIndexSpec';
+        directAccessIndexSpec: DirectAccessVectorIndexSpec;
+    } | {
+        $case: 'deltaSyncIndexSpec';
+        deltaSyncIndexSpec: DeltaSyncVectorIndexSpec;
+    } | undefined;
+    status?: VectorIndexStatus | undefined;
+    /** The user who created the index. */
+    creator?: string | undefined;
+    /** The subtype of the index. */
+    indexSubtype?: IndexSubtype | undefined;
+}
+export interface PatchEndpointBudgetPolicyRequest {
+    /** Name of the AI Search endpoint */
+    name?: string | undefined;
+    /** The budget policy id to be applied */
+    budgetPolicyId?: string | undefined;
+}
+export interface PatchEndpointBudgetPolicyResponse {
+    budgetPolicyId?: string | undefined;
+    /** The budget policy applied to the AI Search endpoint. */
+    effectiveBudgetPolicyId?: string | undefined;
+}
+export interface PatchEndpointRequest {
+    /** Name of the AI Search endpoint */
+    name?: string | undefined;
+    /**
+     * Target QPS for the endpoint. Best-effort; the system does not guarantee this QPS
+     * will be achieved.
+     */
+    targetQps?: bigint | undefined;
+}
+/** Request payload for getting next page of results. */
+export interface QueryVectorIndexNextPageRequest {
+    /** Name of the vector index to query. */
+    name?: string | undefined;
+    /** Name of the endpoint. */
+    endpointName?: string | undefined;
+    /** Page token returned from previous `QueryVectorIndex` or `QueryVectorIndexNextPage` API. */
+    pageToken?: string | undefined;
+}
+export interface QueryVectorIndexRequest {
+    /** Name of the vector index to query. */
+    name?: string | undefined;
+    /** Number of results to return. Defaults to 10. */
+    numResults?: number | undefined;
+    /** List of column names to include in the response. */
+    columns?: string[] | undefined;
+    /**
+     * JSON string representing query filters.
+     *
+     * Example filters:
+     *
+     * - `{"id <": 5}`: Filter for id less than 5.
+     * - `{"id >": 5}`: Filter for id greater than 5.
+     * - `{"id <=": 5}`: Filter for id less than equal to 5.
+     * - `{"id >=": 5}`: Filter for id greater than equal to 5.
+     * - `{"id": 5}`: Filter for id equal to 5.
+     */
+    filtersJson?: string | undefined;
+    /** Query vector. Required for Direct Vector Access Index and Delta Sync Index using self-managed vectors. */
+    queryVector?: number[] | undefined;
+    /** Query text. Required for Delta Sync Index using model endpoint. */
+    queryText?: string | undefined;
+    /** Threshold for the approximate nearest neighbor search. Defaults to 0.0. */
+    scoreThreshold?: number | undefined;
+    /** The query type to use. Choices are `ANN` and `HYBRID` and `FULL_TEXT`. Defaults to `ANN`. */
+    queryType?: string | undefined;
+    /** Column names used to retrieve data to send to the reranker. */
+    columnsToRerank?: string[] | undefined;
+    /**
+     * If set, the top 50 results are reranked with the Databricks Reranker model before returning the `num_results` results to the user.
+     * The setting `columns_to_rerank` selects which columns are used for reranking. For each datapoint, the columns selected are concatenated before
+     * being sent to the reranking model. See https://docs.databricks.com/aws/en/vector-search/query-vector-search#rerank for more information.
+     */
+    reranker?: RerankerConfig | undefined;
+}
+export interface QueryVectorIndexResponse {
+    /** Metadata about the result set. */
+    manifest?: ResultManifest | undefined;
+    /** Data returned in the query result. */
+    result?: ResultData | undefined;
+    /**
+     * [Optional] Token that can be used in `QueryVectorIndexNextPage` API to get next page of results.
+     * If more than 1000 results satisfy the query, they are returned in groups of 1000.
+     * Empty value means no more results. The maximum number of results that can be returned is 10,000.
+     */
+    nextPageToken?: string | undefined;
+}
+export interface RerankerConfig {
+    /**
+     * Reranker identifier:
+     * - When model_type=BASE/UNSPECIFIED: must be "databricks_reranker".
+     * - When model_type=FINETUNED: the Model Serving endpoint name hosting a finetuned reranker.
+     */
+    model?: string | undefined;
+    /** Parameters that control how the reranker processes the query results. */
+    parameters?: RerankerConfig_RerankerParameters | undefined;
+}
+export interface RerankerConfig_RerankerParameters {
+    columnsToRerank?: string[] | undefined;
+}
+/** Data returned in the query result. */
+export interface ResultData {
+    /** Number of rows in the result set. */
+    rowCount?: number | undefined;
+    /** Data rows returned in the query. */
+    dataArray?: JsonValue[][] | undefined;
+}
+/** Metadata about the result set. */
+export interface ResultManifest {
+    /** Number of columns in the result set. */
+    columnCount?: number | undefined;
+    /** Information about each column in the result set. */
+    columns?: ColumnInfo[] | undefined;
+}
+/** Request to retrieve user-visible metrics */
+export interface RetrieveUserVisibleMetricsRequest {
+    /** AI Search endpoint name */
+    name?: string | undefined;
+    /** Start time for metrics query */
+    startTime?: Temporal.Instant | undefined;
+    /** End time for metrics query */
+    endTime?: Temporal.Instant | undefined;
+    /** Granularity in seconds */
+    granularityInSeconds?: number | undefined;
+    /** List of metrics to retrieve */
+    metrics?: Metric[] | undefined;
+    /** Token for pagination */
+    pageToken?: string | undefined;
+}
+/** Response containing user-visible metrics */
+export interface RetrieveUserVisibleMetricsResponse {
+    /** Collection of metric values */
+    metricValues?: MetricValues[] | undefined;
+    /** A token that can be used to get the next page of results. If not present, there are no more results to show. */
+    nextPageToken?: string | undefined;
+}
+export interface ScanVectorIndexRequest {
+    /** Name of the vector index to scan. */
+    name?: string | undefined;
+    /** Number of results to return. Defaults to 10. */
+    numResults?: number | undefined;
+    /** Primary key of the last entry returned in the previous scan. */
+    lastPrimaryKey?: string | undefined;
+}
+/** Response to a scan vector index request. */
+export interface ScanVectorIndexResponse {
+    /** List of data entries */
+    data?: Struct[] | undefined;
+    /** Primary key of the last entry. */
+    lastPrimaryKey?: string | undefined;
+}
+export interface Struct {
+    /** Data entry, corresponding to a row in a vector index. */
+    fields?: MapStringValueEntry[] | undefined;
+}
+export interface SyncVectorIndexRequest {
+    /** Name of the vector index to synchronize. Must be a Delta Sync Index. */
+    name?: string | undefined;
+}
+export interface SyncVectorIndexResponse {
+}
+export interface UpdateEndpointCustomTagsRequest {
+    /** Name of the AI Search endpoint */
+    name?: string | undefined;
+    /** The new custom tags for the AI Search endpoint */
+    customTags?: CustomTag[] | undefined;
+}
+export interface UpdateEndpointCustomTagsResponse {
+    /** The name of the AI Search endpoint whose custom tags were updated. */
+    name?: string | undefined;
+    /** All the custom tags that are applied to the AI Search endpoint. */
+    customTags?: CustomTag[] | undefined;
+}
+export interface UpsertDataVectorIndexRequest {
+    /** Name of the vector index where data is to be upserted. Must be a Direct Vector Access Index. */
+    name?: string | undefined;
+    /** JSON string representing the data to be upserted. */
+    inputsJson?: string | undefined;
+}
+export interface UpsertDataVectorIndexResponse {
+    /** Status of the upsert operation. */
+    status?: UpsertDeleteDataStatus | undefined;
+    /** Result of the upsert or delete operation. */
+    result?: UpsertDeleteDataResult | undefined;
+}
+export interface UpsertDeleteDataResult {
+    /** Count of successfully processed rows. */
+    successRowCount?: bigint | undefined;
+    /** List of primary keys for rows that failed to process. */
+    failedPrimaryKeys?: string[] | undefined;
+}
+export interface Value {
+    /** (--The kind of value.--) */
+    kind?: {
+        $case: 'numberValue';
+        numberValue: number;
+    } | {
+        $case: 'stringValue';
+        stringValue: string;
+    } | {
+        $case: 'boolValue';
+        boolValue: boolean;
+    } | {
+        $case: 'structValue';
+        structValue: Struct;
+    } | {
+        $case: 'listValue';
+        listValue: ListValue;
+    } | undefined;
+}
+export interface VectorIndex {
+    /** Name of the index */
+    name?: string | undefined;
+    /** Name of the endpoint associated with the index */
+    endpointName?: string | undefined;
+    /** Primary key of the index */
+    primaryKey?: string | undefined;
+    indexType?: VectorIndexType | undefined;
+    indexSpec?: {
+        $case: 'directAccessIndexSpec';
+        directAccessIndexSpec: DirectAccessVectorIndexSpec;
+    } | {
+        $case: 'deltaSyncIndexSpec';
+        deltaSyncIndexSpec: DeltaSyncVectorIndexSpec;
+    } | undefined;
+    status?: VectorIndexStatus | undefined;
+    /** The user who created the index. */
+    creator?: string | undefined;
+    /** The subtype of the index. */
+    indexSubtype?: IndexSubtype | undefined;
+}
+export interface VectorIndexStatus {
+    /** Message associated with the index status */
+    message?: string | undefined;
+    /** Number of rows indexed */
+    indexedRowCount?: bigint | undefined;
+    /** Whether the index is ready for search */
+    ready?: boolean | undefined;
+    /** Index API Url to be used to perform operations on the index */
+    indexUrl?: string | undefined;
+}
+export declare const unmarshalColumnInfoSchema: z.ZodType<ColumnInfo>;
+export declare const unmarshalCustomTagSchema: z.ZodType<CustomTag>;
+export declare const unmarshalDeleteDataVectorIndexResponseSchema: z.ZodType<DeleteDataVectorIndexResponse>;
+export declare const unmarshalDeleteEndpointResponseSchema: z.ZodType<DeleteEndpointResponse>;
+export declare const unmarshalDeleteVectorIndexResponseSchema: z.ZodType<DeleteVectorIndexResponse>;
+export declare const unmarshalDeltaSyncVectorIndexSpecSchema: z.ZodType<DeltaSyncVectorIndexSpec>;
+export declare const unmarshalDirectAccessVectorIndexSpecSchema: z.ZodType<DirectAccessVectorIndexSpec>;
+export declare const unmarshalEmbeddingSourceColumnSchema: z.ZodType<EmbeddingSourceColumn>;
+export declare const unmarshalEmbeddingVectorColumnSchema: z.ZodType<EmbeddingVectorColumn>;
+export declare const unmarshalEndpointSchema: z.ZodType<Endpoint>;
+export declare const unmarshalEndpointScalingInfoSchema: z.ZodType<EndpointScalingInfo>;
+export declare const unmarshalEndpointStatusSchema: z.ZodType<EndpointStatus>;
+export declare const unmarshalListEndpointResponseSchema: z.ZodType<ListEndpointResponse>;
+export declare const unmarshalListValueSchema: z.ZodType<ListValue>;
+export declare const unmarshalListVectorIndexResponseSchema: z.ZodType<ListVectorIndexResponse>;
+export declare const unmarshalMapStringValueEntrySchema: z.ZodType<MapStringValueEntry>;
+export declare const unmarshalMetricSchema: z.ZodType<Metric>;
+export declare const unmarshalMetricLabelSchema: z.ZodType<MetricLabel>;
+export declare const unmarshalMetricValueSchema: z.ZodType<MetricValue>;
+export declare const unmarshalMetricValuesSchema: z.ZodType<MetricValues>;
+export declare const unmarshalMiniVectorIndexSchema: z.ZodType<MiniVectorIndex>;
+export declare const unmarshalPatchEndpointBudgetPolicyResponseSchema: z.ZodType<PatchEndpointBudgetPolicyResponse>;
+export declare const unmarshalQueryVectorIndexResponseSchema: z.ZodType<QueryVectorIndexResponse>;
+export declare const unmarshalResultDataSchema: z.ZodType<ResultData>;
+export declare const unmarshalResultManifestSchema: z.ZodType<ResultManifest>;
+export declare const unmarshalRetrieveUserVisibleMetricsResponseSchema: z.ZodType<RetrieveUserVisibleMetricsResponse>;
+export declare const unmarshalScanVectorIndexResponseSchema: z.ZodType<ScanVectorIndexResponse>;
+export declare const unmarshalStructSchema: z.ZodType<Struct>;
+export declare const unmarshalSyncVectorIndexResponseSchema: z.ZodType<SyncVectorIndexResponse>;
+export declare const unmarshalUpdateEndpointCustomTagsResponseSchema: z.ZodType<UpdateEndpointCustomTagsResponse>;
+export declare const unmarshalUpsertDataVectorIndexResponseSchema: z.ZodType<UpsertDataVectorIndexResponse>;
+export declare const unmarshalUpsertDeleteDataResultSchema: z.ZodType<UpsertDeleteDataResult>;
+export declare const unmarshalValueSchema: z.ZodType<Value>;
+export declare const unmarshalVectorIndexSchema: z.ZodType<VectorIndex>;
+export declare const unmarshalVectorIndexStatusSchema: z.ZodType<VectorIndexStatus>;
+export declare const marshalCreateEndpointRequestSchema: z.ZodType;
+export declare const marshalCreateVectorIndexRequestSchema: z.ZodType;
+export declare const marshalCustomTagSchema: z.ZodType;
+export declare const marshalDeltaSyncVectorIndexSpecRequestSchema: z.ZodType;
+export declare const marshalDirectAccessVectorIndexSpecSchema: z.ZodType;
+export declare const marshalEmbeddingSourceColumnSchema: z.ZodType;
+export declare const marshalEmbeddingVectorColumnSchema: z.ZodType;
+export declare const marshalMetricSchema: z.ZodType;
+export declare const marshalMetricLabelSchema: z.ZodType;
+export declare const marshalPatchEndpointBudgetPolicyRequestSchema: z.ZodType;
+export declare const marshalPatchEndpointRequestSchema: z.ZodType;
+export declare const marshalQueryVectorIndexNextPageRequestSchema: z.ZodType;
+export declare const marshalQueryVectorIndexRequestSchema: z.ZodType;
+export declare const marshalRerankerConfigSchema: z.ZodType;
+export declare const marshalRerankerConfig_RerankerParametersSchema: z.ZodType;
+export declare const marshalRetrieveUserVisibleMetricsRequestSchema: z.ZodType;
+export declare const marshalScanVectorIndexRequestSchema: z.ZodType;
+export declare const marshalSyncVectorIndexRequestSchema: z.ZodType;
+export declare const marshalUpdateEndpointCustomTagsRequestSchema: z.ZodType;
+export declare const marshalUpsertDataVectorIndexRequestSchema: z.ZodType;
+//# sourceMappingURL=model.d.ts.map