langchain_community.chat_models.azure_openai.AzureChatOpenAIΒΆ

class langchain_community.chat_models.azure_openai.AzureChatOpenAI[source]ΒΆ

Bases: ChatOpenAI

Azure OpenAI Chat Completion API.

To use this class you must have a deployed model on Azure OpenAI. Use deployment_name in the constructor to refer to the β€œModel deployment name” in the Azure portal.

In addition, you should have the openai python package installed, and the following environment variables set or passed in constructor in lower case: - AZURE_OPENAI_API_KEY - AZURE_OPENAI_API_ENDPOINT - AZURE_OPENAI_AD_TOKEN - OPENAI_API_VERSION - OPENAI_PROXY

For example, if you have gpt-35-turbo deployed, with the deployment name 35-turbo-dev, the constructor should look like:

AzureChatOpenAI(
    azure_deployment="35-turbo-dev",
    openai_api_version="2023-05-15",
)

Be aware the API version may change.

You can also specify the version of the model using model_version constructor parameter, as Azure OpenAI doesn’t return model version with the response.

Default is empty. When you specify the version, it will be appended to the model name in the response. Setting correct version will help you to calculate the cost properly. Model version is not validated, so make sure you set it correctly to get the correct cost.

Any parameters that are valid to be passed to the openai.create call can be passed in, even if not explicitly saved on this class.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param azure_ad_token: Union[str, None] = NoneΒΆ

Your Azure Active Directory token.

Automatically inferred from env var AZURE_OPENAI_AD_TOKEN if not provided.

For more: https://www.microsoft.com/en-us/security/business/identity-access/microsoft-entra-id.

param azure_ad_token_provider: Union[Callable[[], str], None] = NoneΒΆ

A function that returns an Azure Active Directory token.

Will be invoked on every request.

param azure_endpoint: Union[str, None] = NoneΒΆ

Your Azure endpoint, including the resource.

Automatically inferred from env var AZURE_OPENAI_ENDPOINT if not provided.

Example: https://example-resource.azure.openai.com/

param cache: Optional[bool] = NoneΒΆ

Whether to cache the response.

param callback_manager: Optional[BaseCallbackManager] = NoneΒΆ

Callback manager to add to the run trace.

param callbacks: Callbacks = NoneΒΆ

Callbacks to add to the run trace.

param default_headers: Union[Mapping[str, str], None] = NoneΒΆ
param default_query: Union[Mapping[str, object], None] = NoneΒΆ
param deployment_name: Union[str, None] = None (alias 'azure_deployment')ΒΆ

A model deployment.

If given sets the base client URL to include /deployments/{azure_deployment}. Note: this means you won’t be able to use non-deployment endpoints.

param http_client: Union[Any, None] = NoneΒΆ

Optional httpx.Client.

param max_retries: int = 2ΒΆ

Maximum number of retries to make when generating.

param max_tokens: Optional[int] = NoneΒΆ

Maximum number of tokens to generate.

param metadata: Optional[Dict[str, Any]] = NoneΒΆ

Metadata to add to the run trace.

param model_kwargs: Dict[str, Any] [Optional]ΒΆ

Holds any model parameters valid for create call not explicitly specified.

param model_name: str = 'gpt-3.5-turbo' (alias 'model')ΒΆ

Model name to use.

param model_version: str = ''ΒΆ

Legacy, for openai<1.0.0 support.

param n: int = 1ΒΆ

Number of chat completions to generate for each prompt.

param openai_api_base: Optional[str] = None (alias 'base_url')ΒΆ

Base URL path for API requests, leave blank if not using a proxy or service emulator.

param openai_api_key: Union[str, None] = None (alias 'api_key')ΒΆ

Automatically inferred from env var AZURE_OPENAI_API_KEY if not provided.

param openai_api_type: str = ''ΒΆ

Legacy, for openai<1.0.0 support.

param openai_api_version: str = '' (alias 'api_version')ΒΆ

Automatically inferred from env var OPENAI_API_VERSION if not provided.

param openai_organization: Optional[str] = None (alias 'organization')ΒΆ

Automatically inferred from env var OPENAI_ORG_ID if not provided.

param openai_proxy: Optional[str] = NoneΒΆ
param request_timeout: Union[float, Tuple[float, float], Any, None] = None (alias 'timeout')ΒΆ

Timeout for requests to OpenAI completion API. Can be float, httpx.Timeout or None.

param streaming: bool = FalseΒΆ

Whether to stream the results or not.

param tags: Optional[List[str]] = NoneΒΆ

Tags to add to the run trace.

param temperature: float = 0.7ΒΆ

What sampling temperature to use.

param tiktoken_model_name: Optional[str] = NoneΒΆ

The model name to pass to tiktoken when using this class. Tiktoken is used to count the number of tokens in documents to constrain them to be under a certain limit. By default, when set to None, this will be the same as the embedding model name. However, there are some cases where you may want to use this Embedding class with a model name not supported by tiktoken. This can include when using Azure embeddings or when using one of the many model providers that expose an OpenAI-like API but with different models. In those cases, in order to avoid erroring when tiktoken is called, you can specify a model name to use here.

param validate_base_url: bool = TrueΒΆ

For backwards compatibility. If legacy val openai_api_base is passed in, try to infer if it is a base_url or azure_endpoint and update accordingly.

param verbose: bool [Optional]ΒΆ

Whether to print out response text.

__call__(messages: List[BaseMessage], stop: Optional[List[str]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) BaseMessageΒΆ

Call self as a function.

async abatch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) List[Output]ΒΆ

Default implementation runs ainvoke in parallel using asyncio.gather.

The default implementation of batch works well for IO bound runnables.

Subclasses should override this method if they can batch more efficiently; e.g., if the underlying runnable uses an API which supports a batch mode.

async agenerate(messages: List[List[BaseMessage]], stop: Optional[List[str]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, **kwargs: Any) LLMResultΒΆ

Top Level call

async agenerate_prompt(prompts: List[PromptValue], stop: Optional[List[str]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) LLMResultΒΆ

Asynchronously pass a sequence of prompts and return model generations.

This method should make use of batched calls for models that expose a batched API.

Use this method when you want to:
  1. take advantage of batched calls,

  2. need more output from the model than just the top generated value,

  3. are building chains that are agnostic to the underlying language model

    type (e.g., pure text completion models vs chat models).

Parameters
  • prompts – List of PromptValues. A PromptValue is an object that can be converted to match the format of any language model (string for pure text generation models and BaseMessages for chat models).

  • stop – Stop words to use when generating. Model output is cut off at the first occurrence of any of these substrings.

  • callbacks – Callbacks to pass through. Used for executing additional functionality, such as logging or streaming, throughout generation.

  • **kwargs – Arbitrary additional keyword arguments. These are usually passed to the model provider API call.

Returns

An LLMResult, which contains a list of candidate Generations for each input

prompt and additional model provider-specific output.

async ainvoke(input: LanguageModelInput, config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) BaseMessageΒΆ

Default implementation of ainvoke, calls invoke from a thread.

The default implementation allows usage of async code even if the runnable did not implement a native async version of invoke.

Subclasses should override this method if they can run asynchronously.

async apredict(text: str, *, stop: Optional[Sequence[str]] = None, **kwargs: Any) strΒΆ

Asynchronously pass a string to the model and return a string prediction.

Use this method when calling pure text generation models and only the top

candidate generation is needed.

Parameters
  • text – String input to pass to the model.

  • stop – Stop words to use when generating. Model output is cut off at the first occurrence of any of these substrings.

  • **kwargs – Arbitrary additional keyword arguments. These are usually passed to the model provider API call.

Returns

Top model prediction as a string.

async apredict_messages(messages: List[BaseMessage], *, stop: Optional[Sequence[str]] = None, **kwargs: Any) BaseMessageΒΆ

Asynchronously pass messages to the model and return a message prediction.

Use this method when calling chat models and only the top

candidate generation is needed.

Parameters
  • messages – A sequence of chat messages corresponding to a single model input.

  • stop – Stop words to use when generating. Model output is cut off at the first occurrence of any of these substrings.

  • **kwargs – Arbitrary additional keyword arguments. These are usually passed to the model provider API call.

Returns

Top model prediction as a message.

async astream(input: LanguageModelInput, config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) AsyncIterator[BaseMessageChunk]ΒΆ

Default implementation of astream, which calls ainvoke. Subclasses should override this method if they support streaming output.

async astream_log(input: Any, config: Optional[RunnableConfig] = None, *, diff: bool = True, with_streamed_output_list: bool = True, include_names: Optional[Sequence[str]] = None, include_types: Optional[Sequence[str]] = None, include_tags: Optional[Sequence[str]] = None, exclude_names: Optional[Sequence[str]] = None, exclude_types: Optional[Sequence[str]] = None, exclude_tags: Optional[Sequence[str]] = None, **kwargs: Optional[Any]) Union[AsyncIterator[RunLogPatch], AsyncIterator[RunLog]]ΒΆ

Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc.

Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run.

The jsonpatch ops can be applied in order to construct state.

Parameters
  • input – The input to the runnable.

  • config – The config to use for the runnable.

  • diff – Whether to yield diffs between each step, or the current state.

  • with_streamed_output_list – Whether to yield the streamed_output list.

  • include_names – Only include logs with these names.

  • include_types – Only include logs with these types.

  • include_tags – Only include logs with these tags.

  • exclude_names – Exclude logs with these names.

  • exclude_types – Exclude logs with these types.

  • exclude_tags – Exclude logs with these tags.

async atransform(input: AsyncIterator[Input], config: Optional[RunnableConfig] = None, **kwargs: Optional[Any]) AsyncIterator[Output]ΒΆ

Default implementation of atransform, which buffers input and calls astream. Subclasses should override this method if they can start producing output while input is still being generated.

batch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) List[Output]ΒΆ

Default implementation runs invoke in parallel using a thread pool executor.

The default implementation of batch works well for IO bound runnables.

Subclasses should override this method if they can batch more efficiently; e.g., if the underlying runnable uses an API which supports a batch mode.

bind(**kwargs: Any) Runnable[Input, Output]ΒΆ

Bind arguments to a Runnable, returning a new Runnable.

bind_functions(functions: Sequence[Union[Dict[str, Any], Type[BaseModel], Callable]], function_call: Optional[str] = None, **kwargs: Any) Runnable[Union[PromptValue, str, List[BaseMessage]], BaseMessage]ΒΆ

Bind functions (and other objects) to this chat model.

Parameters
  • functions – A list of function definitions to bind to this chat model. Can be a dictionary, pydantic model, or callable. Pydantic models and callables will be automatically converted to their schema dictionary representation.

  • function_call – Which function to require the model to call. Must be the name of the single provided function or β€œauto” to automatically determine which function to call (if any).

  • kwargs – Any additional parameters to pass to the Runnable constructor.

call_as_llm(message: str, stop: Optional[List[str]] = None, **kwargs: Any) strΒΆ
completion_with_retry(run_manager: Optional[CallbackManagerForLLMRun] = None, **kwargs: Any) AnyΒΆ

Use tenacity to retry the completion call.

config_schema(*, include: Optional[Sequence[str]] = None) Type[BaseModel]ΒΆ

The type of config this runnable accepts specified as a pydantic model.

To mark a field as configurable, see the configurable_fields and configurable_alternatives methods.

Parameters

include – A list of fields to include in the config schema.

Returns

A pydantic model that can be used to validate config.

configurable_alternatives(which: ConfigurableField, *, default_key: str = 'default', prefix_keys: bool = False, **kwargs: Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) RunnableSerializable[Input, Output]ΒΆ
configurable_fields(**kwargs: Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) RunnableSerializable[Input, Output]ΒΆ
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) ModelΒΆ

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = β€˜allow’ was set since it adds all passed values

copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) ModelΒΆ

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters
  • include – fields to include in new model

  • exclude – fields to exclude from new model, as with values this takes precedence over include

  • update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data

  • deep – set to True to make a deep copy of the model

Returns

new model instance

dict(**kwargs: Any) DictΒΆ

Return a dictionary of the LLM.

classmethod from_orm(obj: Any) ModelΒΆ
generate(messages: List[List[BaseMessage]], stop: Optional[List[str]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, **kwargs: Any) LLMResultΒΆ

Top Level call

generate_prompt(prompts: List[PromptValue], stop: Optional[List[str]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) LLMResultΒΆ

Pass a sequence of prompts to the model and return model generations.

This method should make use of batched calls for models that expose a batched API.

Use this method when you want to:
  1. take advantage of batched calls,

  2. need more output from the model than just the top generated value,

  3. are building chains that are agnostic to the underlying language model

    type (e.g., pure text completion models vs chat models).

Parameters
  • prompts – List of PromptValues. A PromptValue is an object that can be converted to match the format of any language model (string for pure text generation models and BaseMessages for chat models).

  • stop – Stop words to use when generating. Model output is cut off at the first occurrence of any of these substrings.

  • callbacks – Callbacks to pass through. Used for executing additional functionality, such as logging or streaming, throughout generation.

  • **kwargs – Arbitrary additional keyword arguments. These are usually passed to the model provider API call.

Returns

An LLMResult, which contains a list of candidate Generations for each input

prompt and additional model provider-specific output.

get_input_schema(config: Optional[RunnableConfig] = None) Type[BaseModel]ΒΆ

Get a pydantic model that can be used to validate input to the runnable.

Runnables that leverage the configurable_fields and configurable_alternatives methods will have a dynamic input schema that depends on which configuration the runnable is invoked with.

This method allows to get an input schema for a specific configuration.

Parameters

config – A config to use when generating the schema.

Returns

A pydantic model that can be used to validate input.

classmethod get_lc_namespace() List[str][source]ΒΆ

Get the namespace of the langchain object.

get_num_tokens(text: str) intΒΆ

Get the number of tokens present in the text.

Useful for checking if an input will fit in a model’s context window.

Parameters

text – The string input to tokenize.

Returns

The integer number of tokens in the text.

get_num_tokens_from_messages(messages: List[BaseMessage]) intΒΆ

Calculate num tokens for gpt-3.5-turbo and gpt-4 with tiktoken package.

Official documentation: https://github.com/openai/openai-cookbook/blob/ main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb

get_output_schema(config: Optional[RunnableConfig] = None) Type[BaseModel]ΒΆ

Get a pydantic model that can be used to validate output to the runnable.

Runnables that leverage the configurable_fields and configurable_alternatives methods will have a dynamic output schema that depends on which configuration the runnable is invoked with.

This method allows to get an output schema for a specific configuration.

Parameters

config – A config to use when generating the schema.

Returns

A pydantic model that can be used to validate output.

get_token_ids(text: str) List[int]ΒΆ

Get the tokens present in the text with tiktoken package.

invoke(input: LanguageModelInput, config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) BaseMessageΒΆ

Transform a single input into an output. Override to implement.

Parameters
  • input – The input to the runnable.

  • config – A config to use when invoking the runnable. The config supports standard keys like β€˜tags’, β€˜metadata’ for tracing purposes, β€˜max_concurrency’ for controlling how much work to do in parallel, and other keys. Please refer to the RunnableConfig for more details.

Returns

The output of the runnable.

classmethod is_lc_serializable() boolΒΆ

Return whether this model can be serialized by Langchain.

json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) unicodeΒΆ

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod lc_id() List[str]ΒΆ

A unique identifier for this class for serialization purposes.

The unique identifier is a list of strings that describes the path to the object.

map() Runnable[List[Input], List[Output]]ΒΆ

Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) ModelΒΆ
classmethod parse_obj(obj: Any) ModelΒΆ
classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) ModelΒΆ
predict(text: str, *, stop: Optional[Sequence[str]] = None, **kwargs: Any) strΒΆ

Pass a single string input to the model and return a string prediction.

Use this method when passing in raw text. If you want to pass in specific

types of chat messages, use predict_messages.

Parameters
  • text – String input to pass to the model.

  • stop – Stop words to use when generating. Model output is cut off at the first occurrence of any of these substrings.

  • **kwargs – Arbitrary additional keyword arguments. These are usually passed to the model provider API call.

Returns

Top model prediction as a string.

predict_messages(messages: List[BaseMessage], *, stop: Optional[Sequence[str]] = None, **kwargs: Any) BaseMessageΒΆ

Pass a message sequence to the model and return a message prediction.

Use this method when passing in chat messages. If you want to pass in raw text,

use predict.

Parameters
  • messages – A sequence of chat messages corresponding to a single model input.

  • stop – Stop words to use when generating. Model output is cut off at the first occurrence of any of these substrings.

  • **kwargs – Arbitrary additional keyword arguments. These are usually passed to the model provider API call.

Returns

Top model prediction as a message.

classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') DictStrAnyΒΆ
classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) unicodeΒΆ
stream(input: LanguageModelInput, config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) Iterator[BaseMessageChunk]ΒΆ

Default implementation of stream, which calls invoke. Subclasses should override this method if they support streaming output.

to_json() Union[SerializedConstructor, SerializedNotImplemented]ΒΆ
to_json_not_implemented() SerializedNotImplementedΒΆ
transform(input: Iterator[Input], config: Optional[RunnableConfig] = None, **kwargs: Optional[Any]) Iterator[Output]ΒΆ

Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

classmethod update_forward_refs(**localns: Any) NoneΒΆ

Try to update ForwardRefs on fields based on this Model, globalns and localns.

classmethod validate(value: Any) ModelΒΆ
with_config(config: Optional[RunnableConfig] = None, **kwargs: Any) Runnable[Input, Output]ΒΆ

Bind config to a Runnable, returning a new Runnable.

with_fallbacks(fallbacks: Sequence[Runnable[Input, Output]], *, exceptions_to_handle: Tuple[Type[BaseException], ...] = (<class 'Exception'>,)) RunnableWithFallbacksT[Input, Output]ΒΆ

Add fallbacks to a runnable, returning a new Runnable.

Parameters
  • fallbacks – A sequence of runnables to try if the original runnable fails.

  • exceptions_to_handle – A tuple of exception types to handle.

Returns

A new Runnable that will try the original runnable, and then each fallback in order, upon failures.

with_listeners(*, on_start: Optional[Listener] = None, on_end: Optional[Listener] = None, on_error: Optional[Listener] = None) Runnable[Input, Output]ΒΆ

Bind lifecycle listeners to a Runnable, returning a new Runnable.

on_start: Called before the runnable starts running, with the Run object. on_end: Called after the runnable finishes running, with the Run object. on_error: Called if the runnable throws an error, with the Run object.

The Run object contains information about the run, including its id, type, input, output, error, start_time, end_time, and any tags or metadata added to the run.

with_retry(*, retry_if_exception_type: ~typing.Tuple[~typing.Type[BaseException], ...] = (<class 'Exception'>,), wait_exponential_jitter: bool = True, stop_after_attempt: int = 3) Runnable[Input, Output]ΒΆ

Create a new Runnable that retries the original runnable on exceptions.

Parameters
  • retry_if_exception_type – A tuple of exception types to retry on

  • wait_exponential_jitter – Whether to add jitter to the wait time between retries

  • stop_after_attempt – The maximum number of attempts to make before giving up

Returns

A new Runnable that retries the original runnable on exceptions.

with_types(*, input_type: Optional[Type[Input]] = None, output_type: Optional[Type[Output]] = None) Runnable[Input, Output]ΒΆ

Bind input and output types to a Runnable, returning a new Runnable.

property InputType: TypeAliasΒΆ

Get the input type for this runnable.

property OutputType: AnyΒΆ

Get the output type for this runnable.

property config_specs: List[langchain_core.runnables.utils.ConfigurableFieldSpec]ΒΆ

List configurable fields for this runnable.

property input_schema: Type[pydantic.main.BaseModel]ΒΆ

The type of input this runnable accepts specified as a pydantic model.

property lc_attributes: Dict[str, Any]ΒΆ

List of attribute names that should be included in the serialized kwargs.

These attributes must be accepted by the constructor.

property lc_secrets: Dict[str, str]ΒΆ

A map of constructor argument names to secret ids.

For example,

{β€œopenai_api_key”: β€œOPENAI_API_KEY”}

property output_schema: Type[pydantic.main.BaseModel]ΒΆ

The type of output this runnable produces specified as a pydantic model.

Examples using AzureChatOpenAIΒΆ