`langchain_openai.embeddings.azure`.AzureOpenAIEmbeddings¶

class langchain_openai.embeddings.azure.AzureOpenAIEmbeddings[源代码]¶

基类: OpenAIEmbeddings

Azure OpenAI Embeddings API。

使用时，您应设置环境变量 AZURE_OPENAI_API_KEY 为您的API密钥，或将它作为构造函数的命名参数传递。

示例

from langchain_openai import AzureOpenAIEmbeddings

openai = AzureOpenAIEmbeddings(model="text-embedding-3-large")

通过解析和验证关键字参数中的输入数据来创建一个新模型。

如果输入数据无法解析为有效模型，则引发 ValidationError。

param allowed_special: Union[Literal['all'], Set[str], None] = None¶

param azure_ad_token: Optional[SecretStr] = None¶

您的Azure Active Directory令牌。

如未提供，将自动从环境变量 AZURE_OPENAI_AD_TOKEN 中推断。

约束

type = string
writeOnly = True
format = password

param azure_ad_token_provider: Union[Callable[[], str], None] = None¶

返回Azure Active Directory令牌的函数。

在每次请求时调用。

param azure_endpoint: Union[str, None] = None¶

Azure端点，包括资源。

如果没有提供，将自动从环境变量 AZURE_OPENAI_ENDPOINT 中获取。

示例：https://example-resource.azure.openai.com/

param check_embedding_ctx_length: bool = True¶: 是否检查输入的标记长度，并自动拆分超过embedding_ctx_length的输入。

param chunk_size: int = 2048¶: 每个批次中嵌入文本的最大数量

param default_headers: Union[Mapping[str, str], None] = None¶

param default_query: Union[Mapping[str, object], None] = None¶

param deployment: Optional[str] = None (alias 'azure_deployment')¶

模型部署。

如果给定，将设置基本客户端URL以包含 /deployments/{azure_deployment}。注意：这意味着您将无法使用非部署端点。

param dimensions: Optional[int] = None¶

结果嵌入应具有的维度数。

仅支持在 text-embedding-3 及以后的模型中使用。

param disallowed_special: Union[Literal['all'], Set[str], Sequence[str], None] = None¶

param embedding_ctx_length: int = 8191¶: 一次性嵌入的最大令牌数。

param headers: Any = None¶

param http_async_client: Union[Any, None] = None¶: 可选的httpx.AsyncClient。仅在异步调用中使用。如果您希望同步调用使用自定义客户端，则必须指定http_client。

param http_client: Union[Any, None] = None¶: 可选的httpx.Client。仅用于同步调用。如果您希望异步调用使用自定义客户端，则必须指定http_async_client。

参数 max_retries: int = 2¶: 生成时尝试的最大重试次数。

参数 model: str = 'text-embedding-ada-002'¶

参数 model_kwargs: Dict[str, Any] [可选]¶: 保存用于 create 调用且未显式指定的任何模型参数。

参数 openai_api_base: Optional[str] = None (别名为 'base_url')¶: API请求的基本URL路径，如果不使用代理或服务模拟器，请留空。

参数 openai_api_key: Optional[SecretStr] = None (别名为 'api_key')¶

如果没有提供，将自动从环境变量 AZURE_OPENAI_API_KEY 中推断出来。

约束

type = string
writeOnly = True
format = password

参数 openai_api_type: Optional[str] = None¶

参数 openai_api_version: Optional[str] = None (别名为 'api_version')¶: 如果没有提供，将自动从环境变量 OPENAI_API_VERSION 中推断出来。

参数 openai_organization: Optional[str] = None (同义词 'organization')¶: 如果没有提供，将自动从环境变量 OPENAI_ORG_ID 中推断。

参数 openai_proxy: Optional[str] = None¶

参数 request_timeout: Optional[Union[float, Tuple[float, float], Any]] = None (同义词 'timeout')¶: 调用 OpenAI 完成API请求的超时时间。可以是浮点数、httpx.Timeout 或 None。

参数 retry_max_seconds: int = 20¶: 重试之间的最大等待时间（秒）

参数 retry_min_seconds: int = 4¶: 重试之间的最小等待时间（秒）

参数 show_progress_bar: bool = False¶: 在嵌入时是否显示进度条。

参数 skip_empty: bool = False¶: 在嵌入或引发错误时是否跳过空字符串。默认情况下，不跳过。

param tiktoken_enabled: bool = True¶: 将该值设置为False用于非OpenAI实现的嵌入API，例如text-generation-webui的–extensions openai扩展

param tiktoken_model_name: Optional[str] = None¶: 使用此类时传递给tiktoken的模型名称。Tiktoken用于统计文档中的标记数量以限制其不超过特定限额。默认情况下，当设置为None时，将与嵌入模型名称相同。但是，在某些情况下，您可能希望使用此嵌入类与不被tiktoken支持的模型名称一起使用。这可以包括使用Azure嵌入或在使用许多公开类似于OpenAI API但具有不同模型的模型提供者时。在这些情况下，为了避免在调用tiktoken时出错，您可以在此处指定要使用的模型名称。

param validate_base_url : bool = True¶

async aembed_documents(texts: List[str], chunk_size: Optional[int] = 0) → List[List[float]]¶

异步调用OpenAI的嵌入端点以嵌入搜索文档。

参数

texts (列表[str]) – 待嵌入的文本列表。
chunk_size (可选[int]) – 嵌入的块大小。如果为None，将使用类指定的块大小。

返回

嵌入列表，每条文本对应一个。

返回类型

列表[列表[float]]

async aembed_query(text: str) → List[float]¶

异步调用 OpenAI 的嵌入端点以嵌入查询文本。

参数: text (str) – 要嵌入的文本。
返回: 文本的嵌入。
返回类型: 浮点数 列表

embed_documents(texts: List[str], chunk_size: Optional[int] = 0) → List[List[float]]¶

调用 OpenAI 的嵌入端点以嵌入搜索文档。

参数

texts (列表[str]) – 待嵌入的文本列表。
chunk_size (可选[int]) – 嵌入的块大小。如果为None，将使用类指定的块大小。

返回

嵌入列表，每条文本对应一个。

返回类型

列表[列表[float]]

embed_query(text: str) → List[float]¶

调用 OpenAI 的嵌入端点以嵌入查询文本。

参数: text (str) – 要嵌入的文本。
返回: 文本的嵌入。
返回类型: 浮点数 列表

使用 AzureOpenAIEmbeddings 的示例¶

langchain_openai.embeddings.azure.AzureOpenAIEmbeddings¶

使用 AzureOpenAIEmbeddings 的示例¶

`langchain_openai.embeddings.azure`.AzureOpenAIEmbeddings¶