你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Azure.AI.OpenAI 命名空间
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
类
AudioTranscription |
将语音音频转录为书面文本的操作的结果信息。 |
AudioTranscriptionOptions |
音频听录请求的配置信息。 |
AudioTranscriptionSegment |
有关听录音频数据的单个段的扩展信息。 段通常表示大约 5-10 秒的语音。 段边界通常发生在单词之间,但不一定发生在句子之间。 |
AudioTranslation |
将语音音频转换为书面文本的操作的结果信息。 |
AudioTranslationOptions |
音频翻译请求的配置信息。 |
AudioTranslationSegment |
有关已翻译音频数据的单个段的扩展信息。 段通常表示大约 5-10 秒的语音。 段边界通常发生在单词之间,但不一定发生在句子之间。 |
AzureChatExtensionConfiguration |
单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 聊天完成请求将使用 Azure OpenAI 聊天扩展来增强响应行为。 此配置的使用仅与 Azure OpenAI 兼容。 |
AzureChatExtensionsMessageContext |
当 Azure OpenAI 聊天扩展涉及生成相应的聊天完成响应时可用的其他上下文信息的表示形式。 仅当使用配置为使用匹配扩展的 Azure OpenAI 请求时,才会填充此上下文信息。 |
AzureChatExtensionsOptions |
聊天完成使用的其他设置的抽象化,以通过配置的 Azure OpenAI 扩展的功能来补充标准行为。 这些功能特定于 Azure OpenAI,配置为使用这些功能的聊天完成请求需要与该服务终结点一起使用。 |
AzureCognitiveSearchChatExtensionConfiguration |
将 Azure 认知搜索 用作 Azure OpenAI 聊天扩展时的可配置选项的特定表示形式。 |
AzureCognitiveSearchIndexFieldMappingOptions |
可选设置,用于控制使用配置的Azure 认知搜索资源时字段的处理方式。 |
AzureOpenAIModelFactory |
模型的模型工厂。 |
ChatChoice |
作为整体聊天完成请求的一部分的单个提示完成的表示形式。
通常, |
ChatCompletions |
来自聊天完成请求的响应数据的表示形式。 完成支持各种任务,并生成继续或“完成”提供的提示数据的文本。 |
ChatCompletionsOptions |
聊天完成请求的配置信息。 完成支持各种任务,并生成继续或“完成”提供的提示数据的文本。 |
ChatMessage |
聊天补全交互中的单个角色属性化消息。 |
Choice |
作为整体完成请求的一部分的单个提示完成的表示形式。
通常, |
Completions |
来自完成请求的响应数据的表示形式。 完成支持各种任务,并生成继续或“完成”提供的提示数据的文本。 |
CompletionsLogProbabilityModel |
完成生成的对数概率模型的表示形式。 |
CompletionsOptions |
完成请求的配置信息。 完成支持各种任务,并生成继续或“完成”提供的提示数据的文本。 |
CompletionsUsage |
为完成请求处理的令牌计数的表示形式。 计数考虑提示、选择、选择替代项、best_of代和其他使用者的所有令牌。 |
ContentFilterResult |
有关筛选的内容严重性级别以及是否已筛选的信息。 |
ContentFilterResults |
有关内容筛选类别的信息(如果已检测到)。 |
EmbeddingItem |
单个嵌入相关性比较的表示形式。 |
Embeddings |
嵌入请求的响应数据的表示形式。 嵌入度量文本字符串的相关性,通常用于搜索、聚类分析、建议和其他类似方案。 |
EmbeddingsOptions |
嵌入请求的配置信息。 嵌入度量文本字符串的相关性,通常用于搜索、聚类分析、建议和其他类似方案。 |
EmbeddingsUsage |
此请求和响应中使用的令牌量的度量。 |
FunctionCall |
应调用的函数的名称和参数,由模型生成。 |
FunctionDefinition |
调用方指定的函数的定义,聊天补全可能会调用该函数以响应匹配的用户输入。 |
ImageGenerationOptions |
表示用于生成图像的请求数据。 |
ImageGenerations |
映像生成操作的结果。 |
ImageLocation |
提供可从中访问图像的 URL 的图像响应项。 |
OpenAIClient |
用于完成和搜索的 Azure OpenAI API。 |
OpenAIClientOptions |
OpenAIClient 的客户端选项。 |
PromptFilterResult |
请求中单个提示的内容筛选结果。 |
StreamingChatCompletionsUpdate |
表示对流式聊天完成响应的增量更新。 |
StreamingResponse<T> |
表示包含流式处理内容的操作响应,该流式处理内容可在仍接收响应时进行反序列化和枚举。 |
结构
AudioTranscriptionFormat |
定义输出听录信息的基础响应格式的可用选项。 |
AudioTranslationFormat |
定义输出转换信息的基础响应格式的可用选项。 |
AzureChatExtensionType |
单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 聊天完成请求将使用 Azure OpenAI 聊天扩展来增强响应行为。 此配置的使用仅与 Azure OpenAI 兼容。 |
AzureCognitiveSearchQueryType |
将查询用作 Azure OpenAI 聊天扩展时应执行的Azure 认知搜索检索查询的类型。 |
ChatRole |
聊天补全交互中消息的预期用途的说明。 |
CompletionsFinishReason |
完成响应结束方式的表示形式。 |
ContentFilterSeverity |
有害内容的强度和风险级别的分级。 |
ImageSize |
生成的图像的所需大小。 必须是 256x256、512x512 或 1024x1024 之一。 |
枚举
OpenAIClientOptions.ServiceVersion |
要使用的服务版本。 |
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈