Class AbstractGoogleLLMConnection<MessageType, AuthOptions>`Abstract`

Parameters needed to setup the client connection. AuthOptions are something like GoogleAuthOptions (from google-auth-library) or WebGoogleAuthOptions.

Type Parameters

MessageType
AuthOptions

Hierarchy (view full)

GoogleAIConnection<BaseLanguageModelCallOptions, MessageType, AuthOptions, GoogleLLMResponse>
- AbstractGoogleLLMConnection

Constructors

constructor

new AbstractGoogleLLMConnection<MessageType, AuthOptions>(fields, caller, client, streaming?): AbstractGoogleLLMConnection<MessageType, AuthOptions>
Type Parameters
- MessageType
- AuthOptions
Parameters
- fields: undefined | GoogleAIBaseLLMInput<AuthOptions>
- caller: AsyncCaller
- client: GoogleAbstractedClient
- Optionalstreaming: boolean
Returns AbstractGoogleLLMConnection<MessageType, AuthOptions>
Inherited from GoogleAIConnection.constructor
- Defined in libs/langchain-google-common/src/connection.ts:219

Properties

api

api: any

apiVersion

apiVersion: string = "v1"

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

caller

caller: AsyncCaller

client

client: GoogleAbstractedClient

endpoint

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

Hostname for the API call (if this is running on GCP)

location

location: string = "us-central1"

Region where the LLM is stored (if this is running on GCP)

model

model: string

Model to use

modelName

modelName: string

Model to use Alias for model

platformType

platformType: undefined | GooglePlatformType

What platform to run the service on. If not specified, the class should determine this from other means. Either way, the platform actually used will be in the "platform" getter.

streaming

streaming: boolean

Whether or not to stream.

Default

false

Accessors

computedPlatformType

get computedPlatformType(): GooglePlatformType
Returns GooglePlatformType
Inherited from GoogleAIConnection.computedPlatformType
- Defined in libs/langchain-google-common/src/connection.ts:240

modelFamily

get modelFamily(): GoogleLLMModelFamily
Returns GoogleLLMModelFamily
Inherited from GoogleAIConnection.modelFamily
- Defined in libs/langchain-google-common/src/connection.ts:232

platform

get platform(): GooglePlatformType
Returns GooglePlatformType
Inherited from GoogleAIConnection.platform
- Defined in libs/langchain-google-common/src/connection.ts:173

Methods

additionalHeaders

additionalHeaders(): Promise<Record<string, string>>
Returns Promise<Record<string, string>>
Inherited from GoogleAIConnection.additionalHeaders
- Defined in libs/langchain-google-common/src/connection.ts:89

buildMethod

buildMethod(): GoogleAbstractedClientOpsMethod
Returns GoogleAbstractedClientOpsMethod
Inherited from GoogleAIConnection.buildMethod
- Defined in libs/langchain-google-common/src/connection.ts:181

buildUrl

buildUrl(): Promise<string>
Returns Promise<string>
Inherited from GoogleAIConnection.buildUrl
- Defined in libs/langchain-google-common/src/connection.ts:263

buildUrlGenerativeLanguage

buildUrlGenerativeLanguage(): Promise<string>
Returns Promise<string>
Inherited from GoogleAIConnection.buildUrlGenerativeLanguage
- Defined in libs/langchain-google-common/src/connection.ts:250

buildUrlMethod

buildUrlMethod(): Promise<string>
Returns Promise<string>
Overrides GoogleAIConnection.buildUrlMethod
- Defined in libs/langchain-google-common/src/connection.ts:301

buildUrlMethodGemini

buildUrlMethodGemini(): Promise<string>
Returns Promise<string>
- Defined in libs/langchain-google-common/src/connection.ts:297

buildUrlVertex

buildUrlVertex(): Promise<string>
Returns Promise<string>
Inherited from GoogleAIConnection.buildUrlVertex
- Defined in libs/langchain-google-common/src/connection.ts:256

formatSystemInstruction

formatSystemInstruction(_input, _parameters): Promise<GeminiContent>
Parameters
- _input: MessageType
- _parameters: GoogleAIModelRequestParams
Returns Promise<GeminiContent>
- Defined in libs/langchain-google-common/src/connection.ts:336

formatToolConfig

formatToolConfig(parameters): undefined | {
    functionCallingConfig: {
        allowedFunctionNames?: string[];
        mode: "auto" | "any" | "none";
    };
}
Parameters
- parameters: GoogleAIModelRequestParams
Returns undefined | {
    functionCallingConfig: {
        allowedFunctionNames?: string[];
        mode: "auto" | "any" | "none";
    };
}
- Defined in libs/langchain-google-common/src/connection.ts:387

formatTools

formatTools(_input, parameters): GeminiTool[]
Parameters
- _input: MessageType
- parameters: GoogleAIModelRequestParams
Returns GeminiTool[]
- Defined in libs/langchain-google-common/src/connection.ts:364

request

request(input, parameters, options): Promise<GoogleResponse>
Parameters
- input: MessageType
- parameters: GoogleAIModelRequestParams
- options: BaseLanguageModelCallOptions
Returns Promise<GoogleResponse>
Inherited from GoogleAIConnection.request
- Defined in libs/langchain-google-common/src/connection.ts:277

structuredToolToFunctionDeclaration

structuredToolToFunctionDeclaration(tool): GeminiFunctionDeclaration
Parameters
- tool: StructuredToolParams
Returns GeminiFunctionDeclaration
- Defined in libs/langchain-google-common/src/connection.ts:343

structuredToolsToGeminiTools

structuredToolsToGeminiTools(tools): GeminiTool[]
Parameters
- tools: StructuredToolParams[]
Returns GeminiTool[]
- Defined in libs/langchain-google-common/src/connection.ts:354

Class AbstractGoogleLLMConnection<MessageType, AuthOptions>Abstract

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AbstractGoogleLLMConnection<MessageType, AuthOptions>

Properties

api

apiVersion

caller

client

endpoint

location

model

modelName

platformType

streaming

Default

Accessors

computedPlatformType

Returns GooglePlatformType

modelFamily

Returns GoogleLLMModelFamily

platform

Returns GooglePlatformType

Methods

additionalHeaders

Returns Promise<Record<string, string>>

buildMethod

Returns GoogleAbstractedClientOpsMethod

buildUrl

Returns Promise<string>

buildUrlGenerativeLanguage

Returns Promise<string>

buildUrlMethod

Returns Promise<string>

buildUrlMethodGemini

Returns Promise<string>

buildUrlVertex

Returns Promise<string>

AbstractformatContents

Parameters

Returns Promise<GeminiContent[]>

formatData

Parameters

Returns Promise<GeminiRequest>

formatGenerationConfig

Parameters

Returns GeminiGenerationConfig

formatSafetySettings

Parameters

Returns GeminiSafetySetting[]

formatSystemInstruction

Parameters

Returns Promise<GeminiContent>

formatToolConfig

Parameters

Returns undefined | { functionCallingConfig: { allowedFunctionNames?: string[]; mode: "auto" | "any" | "none"; }; }

formatTools

Parameters

Returns GeminiTool[]

request

Parameters

Returns Promise<GoogleResponse>

structuredToolToFunctionDeclaration

Parameters

Returns GeminiFunctionDeclaration

structuredToolsToGeminiTools

Parameters

Returns GeminiTool[]

Settings

On This Page

Class AbstractGoogleLLMConnection<MessageType, AuthOptions>`Abstract`

`Abstract`formatContents

Returns undefined | {
functionCallingConfig: {
allowedFunctionNames?: string[];
mode: "auto" | "any" | "none";
};
}