import { z, EmbedderReference as EmbedderReference$1 } from 'genkit'; import { C as CommonPluginOptions } from './types-B3i-Lt7D.js'; import * as aiplatform from '@google-cloud/aiplatform'; import { EmbedderReference } from 'genkit/embedder'; import { Document } from 'genkit/retriever'; import { GoogleAuth } from 'google-auth-library'; /** * Copyright 2024 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ interface VertexVectorSearchOptions { pluginOptions: PluginOptions; authClient: GoogleAuth; defaultEmbedder?: EmbedderReference; } type IIndexDatapoint = aiplatform.protos.google.cloud.aiplatform.v1.IIndexDatapoint; declare class Datapoint extends aiplatform.protos.google.cloud.aiplatform.v1 .IndexDatapoint { constructor(properties: IIndexDatapoint); } type IFindNeighborsRequest = aiplatform.protos.google.cloud.aiplatform.v1.IFindNeighborsRequest; type IFindNeighborsResponse = aiplatform.protos.google.cloud.aiplatform.v1.IFindNeighborsResponse; type ISparseEmbedding = aiplatform.protos.google.cloud.aiplatform.v1.IndexDatapoint.ISparseEmbedding; type IRestriction = aiplatform.protos.google.cloud.aiplatform.v1.IndexDatapoint.IRestriction; type INumericRestriction = aiplatform.protos.google.cloud.aiplatform.v1.IndexDatapoint.INumericRestriction; declare const SparseEmbeddingSchema: z.ZodObject<{ values: z.ZodOptional>; dimensions: z.ZodOptional, "many">>; }, "strip", z.ZodTypeAny, { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; }, { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; }>; type SparseEmbedding = z.infer; declare const RestrictionSchema: z.ZodObject<{ namespace: z.ZodString; allowList: z.ZodArray; denyList: z.ZodArray; }, "strip", z.ZodTypeAny, { namespace: string; allowList: string[]; denyList: string[]; }, { namespace: string; allowList: string[]; denyList: string[]; }>; type Restriction = z.infer; declare const NumericRestrictionOperatorSchema: z.ZodEnum<["OPERATOR_UNSPECIFIED", "LESS", "LESS_EQUAL", "EQUAL", "GREATER_EQUAL", "GREATER", "NOT_EQUAL"]>; type NumericRestrictionOperator = z.infer; declare const NumericRestrictionSchema: z.ZodObject<{ valueInt: z.ZodOptional>; valueFloat: z.ZodOptional; valueDouble: z.ZodOptional; namespace: z.ZodString; op: z.ZodOptional, z.ZodNull]>>; }, "strip", z.ZodTypeAny, { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }, { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }>; type NumericRestriction = z.infer; declare const CrowdingTagSchema: z.ZodObject<{ crowdingAttribute: z.ZodOptional; }, "strip", z.ZodTypeAny, { crowdingAttribute?: string | undefined; }, { crowdingAttribute?: string | undefined; }>; type CrowdingTag = z.infer; declare const NeighborSchema: z.ZodObject<{ datapoint: z.ZodOptional; featureVector: z.ZodOptional>; sparseEmbedding: z.ZodOptional>; dimensions: z.ZodOptional, "many">>; }, "strip", z.ZodTypeAny, { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; }, { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; }>>; restricts: z.ZodOptional; denyList: z.ZodArray; }, "strip", z.ZodTypeAny, { namespace: string; allowList: string[]; denyList: string[]; }, { namespace: string; allowList: string[]; denyList: string[]; }>, "many">>; numericRestricts: z.ZodOptional>; valueFloat: z.ZodOptional; valueDouble: z.ZodOptional; namespace: z.ZodString; op: z.ZodOptional, z.ZodNull]>>; }, "strip", z.ZodTypeAny, { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }, { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }>, "many">>; crowdingTag: z.ZodOptional; }, "strip", z.ZodTypeAny, { crowdingAttribute?: string | undefined; }, { crowdingAttribute?: string | undefined; }>>; }, "strip", z.ZodTypeAny, { datapointId?: string | undefined; featureVector?: number[] | undefined; sparseEmbedding?: { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; } | undefined; restricts?: { namespace: string; allowList: string[]; denyList: string[]; }[] | undefined; numericRestricts?: { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }[] | undefined; crowdingTag?: { crowdingAttribute?: string | undefined; } | undefined; }, { datapointId?: string | undefined; featureVector?: number[] | undefined; sparseEmbedding?: { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; } | undefined; restricts?: { namespace: string; allowList: string[]; denyList: string[]; }[] | undefined; numericRestricts?: { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }[] | undefined; crowdingTag?: { crowdingAttribute?: string | undefined; } | undefined; }>>; distance: z.ZodOptional; sparseDistance: z.ZodOptional; }, "strip", z.ZodTypeAny, { datapoint?: { datapointId?: string | undefined; featureVector?: number[] | undefined; sparseEmbedding?: { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; } | undefined; restricts?: { namespace: string; allowList: string[]; denyList: string[]; }[] | undefined; numericRestricts?: { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }[] | undefined; crowdingTag?: { crowdingAttribute?: string | undefined; } | undefined; } | undefined; distance?: number | undefined; sparseDistance?: number | undefined; }, { datapoint?: { datapointId?: string | undefined; featureVector?: number[] | undefined; sparseEmbedding?: { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; } | undefined; restricts?: { namespace: string; allowList: string[]; denyList: string[]; }[] | undefined; numericRestricts?: { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }[] | undefined; crowdingTag?: { crowdingAttribute?: string | undefined; } | undefined; } | undefined; distance?: number | undefined; sparseDistance?: number | undefined; }>; type Neighbor = z.infer; declare const FindNeighborsResponseSchema: z.ZodObject<{ nearestNeighbors: z.ZodOptional; neighbors: z.ZodOptional; featureVector: z.ZodOptional>; sparseEmbedding: z.ZodOptional>; dimensions: z.ZodOptional, "many">>; }, "strip", z.ZodTypeAny, { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; }, { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; }>>; restricts: z.ZodOptional; denyList: z.ZodArray; }, "strip", z.ZodTypeAny, { namespace: string; allowList: string[]; denyList: string[]; }, { namespace: string; allowList: string[]; denyList: string[]; }>, "many">>; numericRestricts: z.ZodOptional>; valueFloat: z.ZodOptional; valueDouble: z.ZodOptional; namespace: z.ZodString; op: z.ZodOptional, z.ZodNull]>>; }, "strip", z.ZodTypeAny, { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }, { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }>, "many">>; crowdingTag: z.ZodOptional; }, "strip", z.ZodTypeAny, { crowdingAttribute?: string | undefined; }, { crowdingAttribute?: string | undefined; }>>; }, "strip", z.ZodTypeAny, { datapointId?: string | undefined; featureVector?: number[] | undefined; sparseEmbedding?: { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; } | undefined; restricts?: { namespace: string; allowList: string[]; denyList: string[]; }[] | undefined; numericRestricts?: { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }[] | undefined; crowdingTag?: { crowdingAttribute?: string | undefined; } | undefined; }, { datapointId?: string | undefined; featureVector?: number[] | undefined; sparseEmbedding?: { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; } | undefined; restricts?: { namespace: string; allowList: string[]; denyList: string[]; }[] | undefined; numericRestricts?: { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }[] | undefined; crowdingTag?: { crowdingAttribute?: string | undefined; } | undefined; }>>; distance: z.ZodOptional; sparseDistance: z.ZodOptional; }, "strip", z.ZodTypeAny, { datapoint?: { datapointId?: string | undefined; featureVector?: number[] | undefined; sparseEmbedding?: { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; } | undefined; restricts?: { namespace: string; allowList: string[]; denyList: string[]; }[] | undefined; numericRestricts?: { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }[] | undefined; crowdingTag?: { crowdingAttribute?: string | undefined; } | undefined; } | undefined; distance?: number | undefined; sparseDistance?: number | undefined; }, { datapoint?: { datapointId?: string | undefined; featureVector?: number[] | undefined; sparseEmbedding?: { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; } | undefined; restricts?: { namespace: string; allowList: string[]; denyList: string[]; }[] | undefined; numericRestricts?: { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }[] | undefined; crowdingTag?: { crowdingAttribute?: string | undefined; } | undefined; } | undefined; distance?: number | undefined; sparseDistance?: number | undefined; }>, "many">>; }, "strip", z.ZodTypeAny, { id?: string | undefined; neighbors?: { datapoint?: { datapointId?: string | undefined; featureVector?: number[] | undefined; sparseEmbedding?: { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; } | undefined; restricts?: { namespace: string; allowList: string[]; denyList: string[]; }[] | undefined; numericRestricts?: { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }[] | undefined; crowdingTag?: { crowdingAttribute?: string | undefined; } | undefined; } | undefined; distance?: number | undefined; sparseDistance?: number | undefined; }[] | undefined; }, { id?: string | undefined; neighbors?: { datapoint?: { datapointId?: string | undefined; featureVector?: number[] | undefined; sparseEmbedding?: { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; } | undefined; restricts?: { namespace: string; allowList: string[]; denyList: string[]; }[] | undefined; numericRestricts?: { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }[] | undefined; crowdingTag?: { crowdingAttribute?: string | undefined; } | undefined; } | undefined; distance?: number | undefined; sparseDistance?: number | undefined; }[] | undefined; }>, "many">>; }, "strip", z.ZodTypeAny, { nearestNeighbors?: { id?: string | undefined; neighbors?: { datapoint?: { datapointId?: string | undefined; featureVector?: number[] | undefined; sparseEmbedding?: { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; } | undefined; restricts?: { namespace: string; allowList: string[]; denyList: string[]; }[] | undefined; numericRestricts?: { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }[] | undefined; crowdingTag?: { crowdingAttribute?: string | undefined; } | undefined; } | undefined; distance?: number | undefined; sparseDistance?: number | undefined; }[] | undefined; }[] | undefined; }, { nearestNeighbors?: { id?: string | undefined; neighbors?: { datapoint?: { datapointId?: string | undefined; featureVector?: number[] | undefined; sparseEmbedding?: { values?: number[] | undefined; dimensions?: (string | number)[] | undefined; } | undefined; restricts?: { namespace: string; allowList: string[]; denyList: string[]; }[] | undefined; numericRestricts?: { namespace: string; valueInt?: string | number | undefined; valueFloat?: number | undefined; valueDouble?: number | undefined; op?: "OPERATOR_UNSPECIFIED" | "LESS" | "LESS_EQUAL" | "EQUAL" | "GREATER_EQUAL" | "GREATER" | "NOT_EQUAL" | null | undefined; }[] | undefined; crowdingTag?: { crowdingAttribute?: string | undefined; } | undefined; } | undefined; distance?: number | undefined; sparseDistance?: number | undefined; }[] | undefined; }[] | undefined; }>; type FindNeighborsResponse = z.infer; declare const VertexAIVectorRetrieverOptionsSchema: z.ZodOptional; }, "strip", z.ZodTypeAny, { k?: number | undefined; }, { k?: number | undefined; }>>; type VertexAIVectorRetrieverOptions = z.infer; declare const VertexAIVectorIndexerOptionsSchema: z.ZodAny; type VertexAIVectorIndexerOptions = z.infer; /** * A document retriever function that takes an array of Neighbors from Vertex AI Vector Search query result, and resolves to a list of documents. * Also takes an options object that can be used to configure the retriever. */ type DocumentRetriever = (docIds: Neighbor[], options?: Options) => Promise; /** * Indexer function that takes an array of documents, stores them in a database of the user's choice, and resolves to a list of document ids. * Also takes an options object that can be used to configure the indexer. Only Streaming Update Indexers are supported. */ type DocumentIndexer = (docs: Document[], options?: Options) => Promise; interface VectorSearchOptions { deployedIndexId: string; indexEndpointId: string; publicDomainName: string; indexId: string; documentRetriever: DocumentRetriever; documentIndexer: DocumentIndexer; embedder?: EmbedderReference; embedderOptions?: z.infer; } /** * Copyright 2024 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** Options specific to vector search configuration */ interface VectorSearchOptionsConfig { /** Configure Vertex AI vector search index options */ vectorSearchOptions?: VectorSearchOptions[]; embedder?: EmbedderReference$1; } interface PluginOptions extends CommonPluginOptions, VectorSearchOptionsConfig { } export { type CrowdingTag as C, type DocumentIndexer as D, type FindNeighborsResponse as F, type IRestriction as I, type Neighbor as N, type PluginOptions as P, type Restriction as R, type SparseEmbedding as S, type VectorSearchOptions as V, type DocumentRetriever as a, type VertexAIVectorIndexerOptions as b, VertexAIVectorIndexerOptionsSchema as c, type VertexAIVectorRetrieverOptions as d, VertexAIVectorRetrieverOptionsSchema as e, type VertexVectorSearchOptions as f, type INumericRestriction as g, type IIndexDatapoint as h, CrowdingTagSchema as i, Datapoint as j, FindNeighborsResponseSchema as k, type IFindNeighborsRequest as l, type IFindNeighborsResponse as m, type ISparseEmbedding as n, NeighborSchema as o, type NumericRestriction as p, type NumericRestrictionOperator as q, NumericRestrictionOperatorSchema as r, NumericRestrictionSchema as s, RestrictionSchema as t, SparseEmbeddingSchema as u, type VectorSearchOptionsConfig as v };