Class ChatGoogleBase<AuthOptions>`Abstract`

Integration with a chat model.

Type Parameters

AuthOptions

Hierarchy

BaseChatModel<GoogleAIBaseLanguageModelCallOptions, AIMessageChunk>
- ChatGoogleBase

Implements

ChatGoogleBaseInput<AuthOptions>

Constructors

constructor

new ChatGoogleBase<AuthOptions>(fields?): ChatGoogleBase<AuthOptions>
Type Parameters
- AuthOptions
Parameters
- Optional fields: ChatGoogleBaseInput<AuthOptions>
Returns ChatGoogleBase<AuthOptions>
Overrides BaseChatModel<GoogleAIBaseLanguageModelCallOptions, AIMessageChunk>.constructor
- Defined in libs/langchain-google-common/src/chat_models.ts:223

Properties

convertSystemMessageToHumanContent

convertSystemMessageToHumanContent: undefined | boolean

maxOutputTokens

maxOutputTokens: number = 1024

Maximum number of tokens to generate in the completion.

model

model: string

Model to use

modelName

modelName: string = "gemini-pro"

Model to use Alias for model

safetyHandler

safetyHandler: GoogleAISafetyHandler

safetySettings

safetySettings: GoogleAISafetySetting[] = []

stopSequences

stopSequences: string[] = []

temperature

temperature: number = 0.7

Sampling temperature to use

topK

topK: number = 40

Top-k changes how the model selects tokens for output.

A top-k of 1 means the selected token is the most probable among all tokens in the model’s vocabulary (also called greedy decoding), while a top-k of 3 means that the next token is selected from among the 3 most probable tokens (using temperature).

topP

topP: number = 0.8

Top-p changes how the model selects tokens for output.

Tokens are selected from most probable to least until the sum of their probabilities equals the top-p value.

For example, if tokens A, B, and C have a probability of .3, .2, and .1 and the top-p value is .5, then the model will select either A or B as the next token (using temperature).

`Protected` connection

connection: ChatConnection<AuthOptions>

`Protected` streamedConnection

streamedConnection: ChatConnection<AuthOptions>

Accessors

platform

get platform(): GooglePlatformType
Returns GooglePlatformType
- Defined in libs/langchain-google-common/src/chat_models.ts:276

Methods

bindTools

bindTools(tools, kwargs?): RunnableInterface<BaseLanguageModelInput, AIMessageChunk, GoogleAIBaseLanguageModelCallOptions>
Parameters
- tools: (StructuredToolInterface<ZodObject<any, any, any, any, {}>> | Record<string, unknown>)[]
- Optional kwargs: Partial<GoogleAIBaseLanguageModelCallOptions>
Returns RunnableInterface<BaseLanguageModelInput, AIMessageChunk, GoogleAIBaseLanguageModelCallOptions>
Overrides BaseChatModel.bindTools
- Defined in libs/langchain-google-common/src/chat_models.ts:280

`Abstract` buildAbstractedClient

buildAbstractedClient(fields?): GoogleAbstractedClient
Parameters
- Optional fields: GoogleAIBaseLLMInput<AuthOptions>
Returns GoogleAbstractedClient
- Defined in libs/langchain-google-common/src/chat_models.ts:234

buildApiKey

buildApiKey(fields?): undefined | string
Parameters
- Optional fields: GoogleAIBaseLLMInput<AuthOptions>
Returns undefined | string
- Defined in libs/langchain-google-common/src/chat_models.ts:242

invocationParams

invocationParams(options?): GoogleAIModelRequestParams
Get the parameters used to invoke the model
Parameters
- Optional options: Omit<GoogleAIBaseLanguageModelCallOptions, never>
Returns GoogleAIModelRequestParams
Overrides BaseChatModel.invocationParams
- Defined in libs/langchain-google-common/src/chat_models.ts:299

withStructuredOutput

withStructuredOutput<RunOutput>(outputSchema, config?): Runnable<BaseLanguageModelInput, RunOutput, RunnableConfig>
Type Parameters
- RunOutput extends Record<string, any> = Record<string, any>
Parameters
- outputSchema: Record<string, any> | ZodType<RunOutput, ZodTypeDef, RunOutput>
- Optional config: StructuredOutputMethodOptions<false>
Returns Runnable<BaseLanguageModelInput, RunOutput, RunnableConfig>
Overrides BaseChatModel.withStructuredOutput
- Defined in libs/langchain-google-common/src/chat_models.ts:358
withStructuredOutput<RunOutput>(outputSchema, config?): Runnable<BaseLanguageModelInput, {
parsed: RunOutput;
raw: BaseMessage;
}, RunnableConfig>
Type Parameters
- RunOutput extends Record<string, any> = Record<string, any>
Parameters
- outputSchema: Record<string, any> | ZodType<RunOutput, ZodTypeDef, RunOutput>
- Optional config: StructuredOutputMethodOptions<true>
Returns Runnable<BaseLanguageModelInput, {
parsed: RunOutput;
raw: BaseMessage;
}, RunnableConfig>
Overrides BaseChatModel.withStructuredOutput
- Defined in libs/langchain-google-common/src/chat_models.ts:369

Class ChatGoogleBase<AuthOptions>Abstract

Type Parameters

AuthOptions

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

AuthOptions

Parameters

Optional fields: ChatGoogleBaseInput<AuthOptions>

Returns ChatGoogleBase<AuthOptions>

Properties

convertSystemMessageToHumanContent

maxOutputTokens

model

modelName

safetyHandler

safetySettings

stopSequences

temperature

topK

topP

Protected connection

Protected streamedConnection

Accessors

platform

Returns GooglePlatformType

Methods

bindTools

Parameters

tools: (StructuredToolInterface<ZodObject<any, any, any, any, {}>> | Record<string, unknown>)[]

Optional kwargs: Partial<GoogleAIBaseLanguageModelCallOptions>

Returns RunnableInterface<BaseLanguageModelInput, AIMessageChunk, GoogleAIBaseLanguageModelCallOptions>

Abstract buildAbstractedClient

Parameters

Optional fields: GoogleAIBaseLLMInput<AuthOptions>

Returns GoogleAbstractedClient

buildApiKey

Parameters

Optional fields: GoogleAIBaseLLMInput<AuthOptions>

Returns undefined | string

buildApiKeyClient

Parameters

apiKey: string

Returns GoogleAbstractedClient

buildClient

Parameters

Optional fields: GoogleAIBaseLLMInput<AuthOptions>

Returns GoogleAbstractedClient

buildConnection

Parameters

fields: GoogleBaseLLMInput<AuthOptions>

client: GoogleAbstractedClient

Returns void

invocationParams

Parameters

Optional options: Omit<GoogleAIBaseLanguageModelCallOptions, never>

Returns GoogleAIModelRequestParams

withStructuredOutput

Type Parameters

RunOutput extends Record<string, any> = Record<string, any>

Parameters

outputSchema: Record<string, any> | ZodType<RunOutput, ZodTypeDef, RunOutput>

Optional config: StructuredOutputMethodOptions<false>

Returns Runnable<BaseLanguageModelInput, RunOutput, RunnableConfig>

Type Parameters

RunOutput extends Record<string, any> = Record<string, any>

Parameters

outputSchema: Record<string, any> | ZodType<RunOutput, ZodTypeDef, RunOutput>

Optional config: StructuredOutputMethodOptions<true>

Returns Runnable<BaseLanguageModelInput, { parsed: RunOutput; raw: BaseMessage; }, RunnableConfig>

Settings

Member Visibility

Theme

Class ChatGoogleBase<AuthOptions>`Abstract`

`Optional` fields: ChatGoogleBaseInput<AuthOptions>

`Protected` connection

`Protected` streamedConnection

`Optional` kwargs: Partial<GoogleAIBaseLanguageModelCallOptions>

`Abstract` buildAbstractedClient

`Optional` fields: GoogleAIBaseLLMInput<AuthOptions>

`Optional` fields: GoogleAIBaseLLMInput<AuthOptions>

`Optional` fields: GoogleAIBaseLLMInput<AuthOptions>

`Optional` options: Omit<GoogleAIBaseLanguageModelCallOptions, never>

`Optional` config: StructuredOutputMethodOptions<false>

`Optional` config: StructuredOutputMethodOptions<true>

Returns Runnable<BaseLanguageModelInput, {
parsed: RunOutput;
raw: BaseMessage;
}, RunnableConfig>