A class that represents a connection to a Google Vertex AI Matching Engine instance.

Hierarchy

Implements

Constructors

Properties

FilterType: Restriction[]
apiEndpoint: string

The host to connect to for queries and upserts.

apiVersion: string = "v1"

The version of the API functions. Part of the path.

authOptions: GoogleAuthOptions<JSONClient>

Explicitly set Google Auth credentials if you cannot get them from google auth application-default login This is useful for serverless or autoscaling environments like Fargate

caller: AsyncCaller
callerOptions: AsyncCallerCallOptions
callerParams: AsyncCallerParams
deployedIndexId: string

The id for the "deployed index", which is an identifier in the index endpoint that references the index (but is not the index id)

docstore: Docstore

Docstore that retains the document, stored by ID

endpoint: string = "us-central1-aiplatform.googleapis.com"

Hostname for the API call

index: string

The id for the index

indexEndpoint: string

The id for the index endpoint

indexEndpointClient: IndexEndpointConnection
location: string = "us-central1"

Region where the LLM is stored

removeDatapointClient: RemoveDatapointConnection
upsertDatapointClient: UpsertDatapointConnection

Methods

  • Parameters

    • documentMetadata: Record<string, any>

    Returns {
        [key: string]: string | number | boolean | string[] | null;
    }

    • [key: string]: string | number | boolean | string[] | null
  • Given the metadata from a document, convert it to an array of Restriction objects that may be passed to the Matching Engine and stored. The default implementation flattens any metadata and includes it as an "allowList". Subclasses can choose to convert some of these to "denyList" items or to add additional restrictions (for example, to format dates into a different structure or to add additional restrictions based on the date).

    Parameters

    • documentMetadata: Record<string, any>

      The metadata from a document

    Returns Restriction[]

    a Restriction[] (or an array of a subclass, from the FilterType)

  • Parameters

    • query: string
    • Optional k: number
    • Optional filter: Restriction[]
    • Optional _callbacks: Callbacks

    Returns Promise<DocumentInterface<Record<string, any>>[]>

  • Parameters

    • query: string
    • Optional k: number
    • Optional filter: Restriction[]
    • Optional _callbacks: Callbacks

    Returns Promise<[DocumentInterface<Record<string, any>>, number][]>

  • Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.

    Parameters

    Returns Promise<DocumentInterface<Record<string, any>>[]>

    • List of documents selected by maximal marginal relevance.

Generated using TypeDoc