你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@azure/openai package

类

AzureKeyCredential	支持更新基础键值的基于静态键的凭据。
OpenAIClient	用于与 Azure OpenAI 交互的客户端。 客户端需要 OpenAI 资源的终结点和身份验证方法，例如 API 密钥或令牌。 可以在 OpenAI 资源页中找到 API 密钥和终结点。 它们将位于资源的“密钥和终结点”页中。 身份验证示例： API 密钥 import { OpenAIClient } from "@azure/openai"; import { AzureKeyCredential } from "@azure/core-auth"; const endpoint = "<azure endpoint>"; const credential = new AzureKeyCredential("<api key>"); const client = new OpenAIClient(endpoint, credential); Azure Active Directory import { OpenAIClient } from "@azure/openai"; import { DefaultAzureCredential } from "@azure/identity"; const endpoint = "<azure endpoint>"; const credential = new DefaultAzureCredential(); const client = new OpenAIClient(endpoint, credential);
OpenAIKeyCredential	OpenAIKeyCredential 类表示 OpenAI API 密钥，用于向 OpenAI 终结点的 OpenAI 客户端进行身份验证。

接口

AudioResultSimpleJson	简单听录响应
AudioResultVerboseJson	听录响应。
AudioSegment	听录段。
AzureChatEnhancementConfiguration	可用 Azure OpenAI 增强配置的表示形式。
AzureChatEnhancements	表示通过请求中提供的匹配输入配置的 Azure 增强功能对聊天完成的输出结果。
AzureChatExtensionConfiguration	单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 聊天完成请求将使用 Azure OpenAI 聊天扩展来增强响应行为。 此配置的使用仅与 Azure OpenAI 兼容。
AzureChatExtensionDataSourceResponseCitation	当 Azure OpenAI 聊天扩展涉及生成相应的聊天完成响应时，可用的其他上下文信息的单个实例。 仅当使用配置为使用匹配扩展的 Azure OpenAI 请求时，才会填充此上下文信息。
AzureChatExtensionsMessageContext	当 Azure OpenAI 聊天扩展涉及生成相应的聊天完成响应时可用的其他上下文信息的表示形式。 仅当使用配置为使用匹配扩展的 Azure OpenAI 请求时，才会填充此上下文信息。
AzureChatGroundingEnhancementConfiguration	Azure OpenAI 接地增强的可用选项的表示形式。
AzureChatOCREnhancementConfiguration	Azure OpenAI 光学字符识别 (OCR) 增强的可用选项的表示形式。
AzureCosmosDBChatExtensionConfiguration	将 Azure Cosmos DB 用作 Azure OpenAI 聊天扩展时的可配置选项的特定表示形式。
AzureCosmosDBFieldMappingOptions	可选设置，用于控制使用配置的 Azure Cosmos DB 资源时字段的处理方式。
AzureExtensionsOptions	Azure OpenAI 聊天扩展的选项。
AzureGroundingEnhancement	返回图像中检测到的对象的边界框的接地增强。
AzureGroundingEnhancementCoordinatePoint	Azure 地面增强功能使用的单个多边形点的表示形式。
AzureGroundingEnhancementLine	一个内容行对象，该对象由相邻的内容元素序列（如字词和选择标记）组成。
AzureGroundingEnhancementLineSpan	一个 span 对象，表示检测到的对象及其边界框信息。
AzureMachineLearningIndexChatExtensionConfiguration	将 Azure 机器学习矢量索引用作 Azure OpenAI 聊天扩展时的可配置选项的特定表示形式。
AzureSearchChatExtensionConfiguration	将 Azure 搜索 用作 Azure OpenAI 聊天扩展时的可配置选项的特定表示形式。
AzureSearchIndexFieldMappingOptions	可选设置，用于控制使用配置的 Azure 搜索 资源时字段的处理方式。
ChatChoice	作为整体聊天完成请求的一部分的单个提示完成的表示形式。 通常， n 根据提供的提示生成选项，默认值为 1。 令牌限制和其他设置可能会限制生成的选项数。
ChatChoiceLogProbabilityInfo	记录选项的概率信息，通过“logprobs”和“top_logprobs”请求。
ChatCompletions	来自聊天完成请求的响应数据的表示形式。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。
ChatCompletionsFunctionToolCall	对函数工具的工具调用，由模型在计算已配置的函数工具时发出，表示要解析的后续聊天完成请求所需的函数调用。
ChatCompletionsFunctionToolDefinition	聊天完成函数工具的定义信息，该工具可以调用函数以响应工具调用。
ChatCompletionsFunctionToolSelection	特定命名函数工具的工具选择，将聊天完成限制为使用命名函数。
ChatCompletionsJsonResponseFormat	聊天完成的响应格式，将响应限制为发出有效的 JSON 对象。
ChatCompletionsNamedFunctionToolSelection	特定命名函数工具的工具选择，将聊天完成限制为使用命名函数。
ChatCompletionsNamedToolSelection	用于聊天完成请求的显式命名工具选择的抽象表示形式。
ChatCompletionsResponseFormat	聊天完成可用响应格式配置的抽象表示形式。 可用于启用 JSON 模式。
ChatCompletionsTextResponseFormat	标准聊天完成响应格式可以自由生成文本，不保证生成符合特定架构的响应内容。
ChatCompletionsToolCall	工具调用的抽象表示形式，必须在后续请求中解析以执行所请求的聊天完成。
ChatCompletionsToolDefinition	工具的抽象表示形式，模型可以使用该工具改进聊天完成响应。
ChatFinishDetails	有关聊天完成响应终止原因的结构化信息的抽象表示形式。
ChatMessageContentItem	聊天消息中结构化内容项的抽象表示形式。
ChatMessageImageContentItem	包含图像引用的结构化聊天内容项。
ChatMessageImageUrl	模型可从中检索图像的 Internet 位置。
ChatMessageTextContentItem	包含纯文本的结构化聊天内容项。
ChatRequestAssistantMessage	表示来自助手的响应或操作的请求聊天消息。
ChatRequestFunctionMessage	表示已配置函数的请求输出的请求聊天消息。
ChatRequestMessage	请求中提供的聊天消息的抽象表示形式。
ChatRequestSystemMessage	请求聊天消息，其中包含影响模型生成聊天完成响应的系统说明。
ChatRequestToolMessage	表示已配置工具的请求输出的请求聊天消息。
ChatRequestUserMessage	表示用户对助手输入的请求聊天消息。
ChatResponseMessage	响应中收到的聊天消息的表示形式。
ChatTokenLogProbabilityInfo	单个消息内容令牌的日志概率信息的表示形式。
ChatTokenLogProbabilityResult	单个内容令牌的日志概率信息的表示形式，包括请求“top_logprobs”时最可能标记的列表。
Choice	作为整体完成请求的一部分的单个提示完成的表示形式。 通常， n 根据提供的提示生成选项，默认值为 1。 令牌限制和其他设置可能会限制生成的选项数。
Completions	来自完成请求的响应数据的表示形式。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。
CompletionsLogProbabilityModel	完成生成的对数概率模型的表示形式。
CompletionsUsage	为完成请求处理的令牌计数的表示形式。 计数考虑提示、选择、选择替代项、best_of代和其他使用者的所有令牌。
ContentFilterBlocklistIdResult	表示通过内容筛选对自定义阻止列表进行评估的结果。
ContentFilterCitedDetectionResult	表示通过内容筛选对受保护资源执行的检测操作的结果。
ContentFilterDetectionResult	表示由内容筛选执行的检测操作的结果。
ContentFilterErrorResults	有关内容筛选错误结果的信息。
ContentFilterResult	有关筛选的内容严重性级别以及是否已筛选的信息。
ContentFilterResultsForPrompt	请求中单个提示的内容筛选结果。
ContentFilterSuccessResultDetailsForPrompt	有关内容筛选成功结果的信息。
ContentFilterSuccessResultsForChoice	有关根据生成的模型输出评估的内容筛选的信息。
ElasticsearchChatExtensionConfiguration	将 Elasticsearch 用作 Azure OpenAI 聊天扩展时的可配置选项的特定表示形式。
ElasticsearchIndexFieldMappingOptions	可选设置，用于控制使用配置的 Elasticsearch® 资源时字段的处理方式。
EmbeddingItem	单个嵌入相关性比较的表示形式。
Embeddings	嵌入请求的响应数据的表示形式。 嵌入度量文本字符串的相关性，通常用于搜索、聚类分析、建议和其他类似方案。
EmbeddingsUsage	此请求和响应中使用的令牌量的度量。
EventStream	可迭代且可释放的可读流。
FunctionCall	应调用的函数的名称和参数，由模型生成。
FunctionDefinition	调用方指定的函数的定义，聊天补全可能会调用该函数以响应匹配的用户输入。
FunctionName	一个 结构，指定在处理聊天完成操作时要使用的特定请求提供的函数的确切名称。
GetAudioTranscriptionOptions	音频听录请求的选项
GetAudioTranslationOptions	音频翻译请求的选项
GetChatCompletionsOptions	此模块包含我们希望与相应生成的模型并行运行的模型。 这对于提供名称/类型与生成的模型不同的面向客户的模型非常有用。
GetCompletionsOptions	完成请求的配置信息。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。
GetEmbeddingsOptions	自定义嵌入请求的选项
GetImagesOptions	表示用于生成图像的请求数据。
ImageGenerationContentFilterResults	描述图像生成请求的内容筛选结果。
ImageGenerationData	单个生成的图像的表示形式，作为 base64 编码的数据或可从中检索图像的 URL 提供。
ImageGenerationPromptFilterResults	描述图像生成请求提示的内容筛选结果。
ImageGenerations	成功映像生成操作的结果。
MaxTokensFinishDetails	停止原因的结构化表示形式，表示在模型自然完成之前已达到令牌限制。
OnYourDataAccessTokenAuthenticationOptions	使用访问令牌时的 Azure OpenAI 数据身份验证选项。
OnYourDataApiKeyAuthenticationOptions	使用 API 密钥时的 Azure OpenAI 数据身份验证选项。
OnYourDataAuthenticationOptions	Azure OpenAI On Your Data 的身份验证选项。
OnYourDataConnectionStringAuthenticationOptions	使用 连接字符串 时的 Azure OpenAI 数据身份验证选项。
OnYourDataDeploymentNameVectorizationSource	Azure OpenAI 在应用矢量搜索时使用的矢量化源的详细信息，该源基于同一 Azure OpenAI 资源中的内部嵌入模型部署名称。
OnYourDataEncodedApiKeyAuthenticationOptions	使用 Elasticsearch 编码的 API 密钥时的 Azure OpenAI 数据身份验证选项。
OnYourDataEndpointVectorizationSource	应用矢量搜索时由 Azure OpenAI 在数据上使用的矢量化源的详细信息，该源基于用于嵌入的公共 Azure OpenAI 终结点调用。
OnYourDataKeyAndKeyIdAuthenticationOptions	使用 Elasticsearch 密钥和密钥 ID 对时的 Azure OpenAI 数据身份验证选项。
OnYourDataModelIdVectorizationSource	Azure OpenAI 在应用矢量搜索时使用的矢量化源的详细信息，该源基于搜索服务模型 ID。 目前仅受 Elasticsearch® 支持。
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions	使用系统分配的托管标识时，Azure OpenAI On Data 的身份验证选项。
OnYourDataUserAssignedManagedIdentityAuthenticationOptions	使用用户分配的托管标识时的 Azure OpenAI 数据身份验证选项。
OnYourDataVectorizationSource	使用向量搜索的 Azure OpenAI 数据向量化源的抽象表示形式。
OpenAIClientOptions
PineconeChatExtensionConfiguration	将 Pinecone 用作 Azure OpenAI 聊天扩展时的可配置选项的特定表示形式。
PineconeFieldMappingOptions	可选设置，用于控制使用配置的 Pinecone 资源时字段的处理方式。
StopFinishDetails	停止原因的结构化表示形式，表示模型自然终止。

类型别名

AudioResult	基于请求的响应格式的听录结果的类型
AudioResultFormat	音频任务的结果格式
AudioTranscriptionTask	“transcribe”、“translate”
AzureChatExtensionConfigurationUnion	AzureChatExtensionConfigurationUnion 的别名
AzureChatExtensionType	“azure_search”、“azure_ml_index”、“azure_cosmos_db”、“elasticsearch”、“pinecone”
AzureSearchQueryType	“simple”、“semantic”、“vector”、“vector_simple_hybrid”、“vector_semantic_hybrid”
ChatCompletionsNamedToolSelectionUnion	ChatCompletionsNamedToolSelectionUnion 的别名
ChatCompletionsResponseFormatUnion	ChatCompletionsResponseFormatUnion 的别名
ChatCompletionsToolCallUnion	ChatCompletionsToolCallUnion 的别名
ChatCompletionsToolDefinitionUnion	ChatCompletionsToolDefinitionUnion 的别名
ChatCompletionsToolSelectionPreset	“auto”、“none”
ChatFinishDetailsUnion	ChatFinishDetailsUnion 的别名
ChatMessageContentItemUnion	ChatMessageContentItemUnion 的别名
ChatMessageImageDetailLevel	“auto”、“low”、“high”
ChatRequestMessageUnion	ChatRequestMessageUnion 的别名
ChatRole	“system”、“助手”、“user”、“function”、“tool”
CompletionsFinishReason	“stop”、“length”、“content_filter”、“function_call”、“tool_calls”
ContentFilterResultDetailsForPrompt	有关内容筛选类别的信息（如果已检测到）。
ContentFilterResultsForChoice	有关内容筛选结果（如果已检测到）的信息。
ContentFilterSeverity	“safe”、“low”、“medium”、“high”
ElasticsearchQueryType	“simple”、“vector”
FunctionCallPreset	“auto”、“none”
ImageGenerationQuality	“standard”、“hd”
ImageGenerationResponseFormat	“url”、“b64_json”
ImageGenerationStyle	“natural”、“vivid”
ImageSize	“256x256”、“512x512”、“1024x1024”、“1792x1024”、“1024x1792”
OnYourDataAuthenticationOptionsUnion	OnYourDataAuthenticationOptionsUnion 的别名
OnYourDataAuthenticationType	“api_key”、“connection_string”、“key_and_key_id”、“encoded_api_key”、“access_token”、“system_assigned_managed_identity”、“user_assigned_managed_identity”
OnYourDataVectorizationSourceType	“endpoint”、“deployment_name”、“model_id”
OnYourDataVectorizationSourceUnion	OnYourDataVectorizationSourceUnion 的别名