Interface MatchingEngineArgs

Parameters necessary to configure the Matching Engine.

interface MatchingEngineArgs {
    docstore: Docstore;
    index: string;
    indexEndpoint: string;
    apiEndpoint?: string;
    apiVersion?: string;
    authOptions?: GoogleAuthOptions<JSONClient>;
    callerOptions?: AsyncCallerCallOptions;
    callerParams?: AsyncCallerParams;
    customModelURL?: string;
    deployedIndexId?: string;
    endpoint?: string;
    location?: string;
}

Hierarchy

  • GoogleVertexAIConnectionParams<GoogleAuthOptions>
  • IndexEndpointConnectionParams
  • UpsertDatapointParams
    • MatchingEngineArgs

Implemented by

Properties

docstore index indexEndpoint apiEndpoint? apiVersion? authOptions? callerOptions? callerParams? customModelURL? deployedIndexId? endpoint? location?

Properties

docstore

docstore: Docstore

index

index: string

indexEndpoint

indexEndpoint: string

Optional apiEndpoint

apiEndpoint?: string

Optional apiVersion

apiVersion?: string

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

Optional authOptions

authOptions?: GoogleAuthOptions<JSONClient>

Optional callerOptions

callerOptions?: AsyncCallerCallOptions

Optional callerParams

callerParams?: AsyncCallerParams

Optional customModelURL

customModelURL?: string

If you are planning to connect to a model that lives under a custom endpoint provide the "customModelURL" which will override the automatic URL building

This is necessary in cases when you want to point to a fine-tuned model or a model that has been hidden under VertexAI Endpoints.

In those cases, specifying the GoogleVertexAIModelParams.model param will not be necessary and will be ignored.

See

GoogleVertexAILLMConnection.buildUrl

Optional deployedIndexId

deployedIndexId?: string

Optional endpoint

endpoint?: string

Hostname for the API call

Optional location

location?: string

Region where the LLM is stored

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc