Class ChatConnection<AuthOptions>

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

Type Parameters

AuthOptions

Hierarchy (view full)

AbstractGoogleLLMConnection<BaseMessage[], AuthOptions>
- ChatConnection

Constructors

constructor

new ChatConnection<AuthOptions>(fields, caller, client, streaming): ChatConnection<AuthOptions>
Type Parameters
- AuthOptions
Parameters
- fields: undefined | GoogleAIBaseLLMInput<AuthOptions>
- caller: AsyncCaller
- client: GoogleAbstractedClient
- streaming: boolean
Returns ChatConnection<AuthOptions>
Overrides AbstractGoogleLLMConnection.constructor
- Defined in libs/langchain-google-common/src/chat_models.ts:64

Properties

`Optional`apiConfig

apiConfig?: GoogleAIAPIConfig

apiVersion

apiVersion: string = "v1"

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

caller

caller: AsyncCaller

client

client: GoogleAbstractedClient

convertSystemMessageToHumanContent

convertSystemMessageToHumanContent: undefined | boolean

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

api

get api(): GoogleAIAPI
Returns GoogleAIAPI
Overrides AbstractGoogleLLMConnection.api
- Defined in libs/langchain-google-common/src/chat_models.ts:108

apiName

get apiName(): string
Returns string
Inherited from AbstractGoogleLLMConnection.apiName
- Defined in libs/langchain-google-common/src/connection.ts:269

computeUseSystemInstruction

get computeUseSystemInstruction(): boolean
Returns boolean
- Defined in libs/langchain-google-common/src/chat_models.ts:81

computedAPIName

get computedAPIName(): string
Returns string
Inherited from AbstractGoogleLLMConnection.computedAPIName
- Defined in libs/langchain-google-common/src/connection.ts:264

computedEndpoint

get computedEndpoint(): string
Returns string
Inherited from AbstractGoogleLLMConnection.computedEndpoint
- Defined in libs/langchain-google-common/src/connection.ts:195

computedLocation

get computedLocation(): string
Returns string
Inherited from AbstractGoogleLLMConnection.computedLocation
- Defined in libs/langchain-google-common/src/connection.ts:292

computedPlatformType

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

endpoint

get endpoint(): string
Hostname for the API call (if this is running on GCP)

Returns string
Inherited from AbstractGoogleLLMConnection.endpoint
- Defined in libs/langchain-google-common/src/connection.ts:191

location

get location(): string
Region where the LLM is stored (if this is running on GCP)

Returns string
Inherited from AbstractGoogleLLMConnection.location
- Defined in libs/langchain-google-common/src/connection.ts:183

modelFamily

get modelFamily(): VertexModelFamily
Returns VertexModelFamily
Inherited from AbstractGoogleLLMConnection.modelFamily
- Defined in libs/langchain-google-common/src/connection.ts:256

modelPublisher

get modelPublisher(): string
Returns string
Inherited from AbstractGoogleLLMConnection.modelPublisher
- Defined in libs/langchain-google-common/src/connection.ts:260

platform

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

useSystemInstruction

get useSystemInstruction(): boolean
Returns boolean
- Defined in libs/langchain-google-common/src/chat_models.ts:75

Methods

additionalHeaders

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

formatData

formatData(input, parameters): Promise<unknown>
Parameters
- input: BaseMessage[]
- parameters: GoogleAIModelRequestParams
Returns Promise<unknown>
Inherited from AbstractGoogleLLMConnection.formatData
- Defined in libs/langchain-google-common/src/connection.ts:401

request

request(input, parameters, options, runManager?): Promise<GoogleLLMResponse>
Parameters
- input: BaseMessage[]
- parameters: GoogleAIModelRequestParams
- options: BaseLanguageModelCallOptions
- OptionalrunManager: BaseRunManager
Returns Promise<GoogleLLMResponse>
Inherited from AbstractGoogleLLMConnection.request
- Defined in libs/langchain-google-common/src/connection.ts:335

Class ChatConnection<AuthOptions>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ChatConnection<AuthOptions>

Properties

OptionalapiConfig

apiVersion

caller

client

convertSystemMessageToHumanContent

model

modelName

platformType

streaming

Default

Accessors

api

Returns GoogleAIAPI

apiName

Returns string

computeUseSystemInstruction

Returns boolean

computedAPIName

Returns string

computedEndpoint

Returns string

computedLocation

Returns string

computedPlatformType

Returns GooglePlatformType

endpoint

Returns string

location

Returns string

modelFamily

Returns VertexModelFamily

modelPublisher

Returns string

platform

Returns GooglePlatformType

useSystemInstruction

Returns boolean

Methods

additionalHeaders

Returns Promise<Record<string, string>>

buildGeminiAPI

Returns GoogleAIAPI

buildMethod

Returns GoogleAbstractedClientOpsMethod

buildUrl

Returns Promise<string>

buildUrlGenerativeLanguage

Returns Promise<string>

buildUrlMethod

Returns Promise<string>

buildUrlMethodClaude

Returns Promise<string>

buildUrlMethodGemini

Returns Promise<string>

buildUrlVertex

Returns Promise<string>

formatData

Parameters

Returns Promise<unknown>

request

Parameters

Returns Promise<GoogleLLMResponse>

Settings

On This Page

`Optional`apiConfig