Class AzureChatOpenAI

Wrapper around OpenAI large language models that use the Chat endpoint.

To use you should have the OPENAI_API_KEY environment variable set.

To use with Azure you should have the: AZURE_OPENAI_API_KEY, AZURE_OPENAI_API_INSTANCE_NAME, AZURE_OPENAI_API_DEPLOYMENT_NAME and AZURE_OPENAI_API_VERSION environment variables set. AZURE_OPENAI_BASE_PATH is optional and will override AZURE_OPENAI_API_INSTANCE_NAME if you need to use a custom endpoint.

Remarks

Any parameters that are valid to be passed to openai.createChatCompletion can be passed through modelKwargs, even if not explicitly available on this class.

Example

// Create a new instance of ChatOpenAI with specific temperature and model name settings
const model = new ChatOpenAI({
  temperature: 0.9,
  model: "ft:gpt-3.5-turbo-0613:{ORG_NAME}::{MODEL_ID}",
});

// Invoke the model with a message and await the response
const message = await model.invoke("Hi there!");

// Log the response to the console
console.log(message);

Hierarchy (view full)

ChatOpenAI
- AzureChatOpenAI

Constructors

constructor

new AzureChatOpenAI(fields?): AzureChatOpenAI
Parameters
- Optionalfields: any
Returns AzureChatOpenAI
Overrides ChatOpenAI.constructor
- Defined in libs/langchain-openai/src/azure/chat_models.ts:28

Properties

frequencyPenalty

frequencyPenalty: number = 0

Penalizes repeated tokens according to frequency

model

model: string = "gpt-3.5-turbo"

Model name to use

modelName

modelName: string = "gpt-3.5-turbo"

Model name to use Alias for model

n

n: number = 1

Number of completions to generate for each prompt

presencePenalty

presencePenalty: number = 0

Penalizes repeated tokens

streamUsage

streamUsage: boolean = true

Whether or not to include token usage data in streamed chunks.

Default

true

streaming

streaming: boolean = false

Whether to stream the results or not. Enabling disables tokenUsage reporting

temperature

temperature: number = 1

Sampling temperature to use

topP

topP: number = 1

Total probability mass of tokens to consider at each step

`Optional`apiKey

apiKey?: string

API key to use when making requests to OpenAI. Defaults to the value of OPENAI_API_KEY environment variable.

`Optional`azureADTokenProvider

azureADTokenProvider?: (() => Promise<string>)

A function that returns an access token for Microsoft Entra (formerly known as Azure Active Directory), which will be invoked on every request.

`Optional`azureOpenAIApiDeploymentName

azureOpenAIApiDeploymentName?: string

Azure OpenAI API deployment name to use for completions when making requests to Azure OpenAI. This is the name of the deployment you created in the Azure portal. e.g. "my-openai-deployment" this will be used in the endpoint URL: https://{InstanceName}.openai.azure.com/openai/deployments/my-openai-deployment/

`Optional`azureOpenAIApiInstanceName

azureOpenAIApiInstanceName?: string

Azure OpenAI API instance name to use when making requests to Azure OpenAI. this is the name of the instance you created in the Azure portal. e.g. "my-openai-instance" this will be used in the endpoint URL: https://my-openai-instance.openai.azure.com/openai/deployments/{DeploymentName}/

`Optional`azureOpenAIApiKey

azureOpenAIApiKey?: string

API key to use when making requests to Azure OpenAI.

`Optional`azureOpenAIApiVersion

azureOpenAIApiVersion?: string

API version to use when making requests to Azure OpenAI.

`Optional`azureOpenAIBasePath

azureOpenAIBasePath?: string

Custom endpoint for Azure OpenAI API. This is useful in case you have a deployment in another region. e.g. setting this value to "https://westeurope.api.cognitive.microsoft.com/openai/deployments" will be result in the endpoint URL: https://westeurope.api.cognitive.microsoft.com/openai/deployments/{DeploymentName}/

`Optional`logitBias

logitBias?: Record<string, number>

Dictionary used to adjust the probability of specific tokens being generated

`Optional`logprobs

logprobs?: boolean

Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

`Optional`maxTokens

maxTokens?: number

Maximum number of tokens to generate in the completion. -1 returns as many tokens as possible given the prompt and the model's maximum context size.

`Optional`modelKwargs

modelKwargs?: Record<string, any>

Holds any additional parameters that are valid to pass to openai.createCompletion that are not explicitly specified on this class.

`Optional`openAIApiKey

openAIApiKey?: string

API key to use when making requests to OpenAI. Defaults to the value of OPENAI_API_KEY environment variable. Alias for apiKey

`Optional`organization

organization?: string

`Optional`stop

stop?: string[]

List of stop words to use when generating Alias for stopSequences

`Optional`stopSequences

stopSequences?: string[]

List of stop words to use when generating

`Optional`supportsStrictToolCalling

supportsStrictToolCalling?: boolean

Whether the model supports the strict argument when passing in tools. Defaults to true if modelName/model starts with 'gpt-' otherwise defaults to undefined. If undefined the strict argument will not be passed to OpenAI.

`Optional`timeout

timeout?: number

Timeout to use when making requests to OpenAI.

`Optional`topLogprobs

topLogprobs?: number

An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

`Optional`user

user?: string

Unique string identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

`Protected`client

client: OpenAI

`Protected`clientConfig

clientConfig: ClientOptions

Accessors

callKeys

get callKeys(): any[]
Returns any[]
Inherited from ChatOpenAI.callKeys
- Defined in libs/langchain-openai/src/chat_models.ts:410

Methods

bindTools

bindTools(tools, kwargs?): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>
Parameters
- tools: any[]
- Optionalkwargs: Partial<ChatOpenAICallOptions>
Returns Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>
Inherited from ChatOpenAI.bindTools
- Defined in libs/langchain-openai/src/chat_models.ts:634

completionWithRetry

completionWithRetry(request, options?): Promise<AsyncIterable<ChatCompletionChunk>>
Calls the OpenAI API with retry logic in case of failures.
Parameters
- request: ChatCompletionCreateParamsStreaming
  The request to send to the OpenAI API.
- Optionaloptions: OpenAICoreRequestOptions
  Optional configuration for the API call.
Returns Promise<AsyncIterable<ChatCompletionChunk>>
The response from the OpenAI API.
Inherited from ChatOpenAI.completionWithRetry
- Defined in libs/langchain-openai/src/chat_models.ts:1069
completionWithRetry(request, options?): Promise<ChatCompletion>
Parameters
- request: ChatCompletionCreateParamsNonStreaming
- Optionaloptions: OpenAICoreRequestOptions
Returns Promise<ChatCompletion>
Inherited from ChatOpenAI.completionWithRetry
- Defined in libs/langchain-openai/src/chat_models.ts:1074

getLsParams

getLsParams(options): LangSmithParams
Parameters
- options: unknown
Returns LangSmithParams
Overrides ChatOpenAI.getLsParams
- Defined in libs/langchain-openai/src/azure/chat_models.ts:53

getNumTokensFromMessages

getNumTokensFromMessages(messages): Promise<{
countPerMessage: any[];
totalCount: number;
}>
Parameters
- messages: BaseMessage[]
Returns Promise<{
countPerMessage: any[];
totalCount: number;
}>
Inherited from ChatOpenAI.getNumTokensFromMessages
- Defined in libs/langchain-openai/src/chat_models.ts:994

identifyingParams

identifyingParams(): Omit<ChatCompletionCreateParams, "messages"> & {
model_name: string;
} & ClientOptions
Get the identifying parameters for the model

Returns Omit<ChatCompletionCreateParams, "messages"> & {
model_name: string;
} & ClientOptions
Inherited from ChatOpenAI.identifyingParams
- Defined in libs/langchain-openai/src/chat_models.ts:819

invocationParams

invocationParams(options?, extra?): Omit<ChatCompletionCreateParams, "messages">
Get the parameters used to invoke the model
Parameters
- Optionaloptions: unknown
- Optionalextra: {
  streaming?: boolean;
  }
  - Optionalstreaming?: boolean
Returns Omit<ChatCompletionCreateParams, "messages">
Inherited from ChatOpenAI.invocationParams
- Defined in libs/langchain-openai/src/chat_models.ts:655

toJSON

toJSON(): any
Returns any
- Defined in libs/langchain-openai/src/azure/chat_models.ts:119

withStructuredOutput

withStructuredOutput<RunOutput>(outputSchema, config?): Runnable<BaseLanguageModelInput, RunOutput>
Type Parameters
- RunOutput extends Record<string, any> = Record<string, any>
Parameters
- outputSchema: any
- Optionalconfig: ChatOpenAIStructuredOutputMethodOptions<false>
Returns Runnable<BaseLanguageModelInput, RunOutput>
Inherited from ChatOpenAI.withStructuredOutput
- Defined in libs/langchain-openai/src/chat_models.ts:1171
withStructuredOutput<RunOutput>(outputSchema, config?): Runnable<BaseLanguageModelInput, {
parsed: RunOutput;
raw: BaseMessage;
}>
Type Parameters
- RunOutput extends Record<string, any> = Record<string, any>
Parameters
- outputSchema: any
- Optionalconfig: ChatOpenAIStructuredOutputMethodOptions<true>
Returns Runnable<BaseLanguageModelInput, {
parsed: RunOutput;
raw: BaseMessage;
}>
Inherited from ChatOpenAI.withStructuredOutput
- Defined in libs/langchain-openai/src/chat_models.ts:1183

Class AzureChatOpenAI

Remarks

Example

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AzureChatOpenAI

Properties

frequencyPenalty

model

modelName

n

presencePenalty

streamUsage

Default

streaming

temperature

topP

OptionalapiKey

OptionalazureADTokenProvider

OptionalazureOpenAIApiDeploymentName

OptionalazureOpenAIApiInstanceName

OptionalazureOpenAIApiKey

OptionalazureOpenAIApiVersion

OptionalazureOpenAIBasePath

OptionallogitBias

Optionallogprobs

OptionalmaxTokens

OptionalmodelKwargs

OptionalopenAIApiKey

Optionalorganization

Optionalstop

OptionalstopSequences

OptionalsupportsStrictToolCalling

Optionaltimeout

OptionaltopLogprobs

Optionaluser

Protectedclient

ProtectedclientConfig

Accessors

callKeys

Returns any[]

Methods

bindTools

Parameters

Returns Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>

completionWithRetry

Parameters

Returns Promise<AsyncIterable<ChatCompletionChunk>>

Parameters

Returns Promise<ChatCompletion>

getLsParams

Parameters

Returns LangSmithParams

getNumTokensFromMessages

Parameters

Returns Promise<{ countPerMessage: any[]; totalCount: number; }>

identifyingParams

Returns Omit<ChatCompletionCreateParams, "messages"> & { model_name: string; } & ClientOptions

invocationParams

Parameters

Optionalstreaming?: boolean

Returns Omit<ChatCompletionCreateParams, "messages">

toJSON

Returns any

withStructuredOutput

Type Parameters

Parameters

Returns Runnable<BaseLanguageModelInput, RunOutput>

Type Parameters

Parameters

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

Settings

On This Page

`Optional`apiKey

`Optional`azureADTokenProvider

`Optional`azureOpenAIApiDeploymentName

`Optional`azureOpenAIApiInstanceName

`Optional`azureOpenAIApiKey

`Optional`azureOpenAIApiVersion

`Optional`azureOpenAIBasePath

`Optional`logitBias

`Optional`logprobs

`Optional`maxTokens

`Optional`modelKwargs

`Optional`openAIApiKey

`Optional`organization

`Optional`stop

`Optional`stopSequences

`Optional`supportsStrictToolCalling

`Optional`timeout

`Optional`topLogprobs

`Optional`user

`Protected`client

`Protected`clientConfig

Returns Promise<{
countPerMessage: any[];
totalCount: number;
}>

Returns Omit<ChatCompletionCreateParams, "messages"> & {
model_name: string;
} & ClientOptions

`Optional`streaming?: boolean

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