Azure OpenAI (预览版)
轻松将 Azure OpenAI 的前沿人工智能功能集成到工作流中
此连接器在以下产品和区域中可用:
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 政府区域 - Azure 中国区域 - 美国国防部(DoD) |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 联系人 | |
|---|---|
| Name | Microsoft |
| URL | https://support.microsoft.com |
| 连接器元数据 | |
|---|---|
| 发布者 | Microsoft |
| 网站 | https://azure.microsoft.com/en-us/products/cognitive-services/openai-service |
| 隐私策略 | https://learn.microsoft.com/en-us/legal/cognitive-services/openai/data-privacy |
| 类别 | 人工智能;商业智能 |
正在创建连接
连接器支持以下身份验证类型:
| API 密钥 | 提供 Azure OpenAI 资源名称和 API 密钥,以访问托管 AI 模型的 Azure OpenAI。 | 所有区域 | 可共享 |
| 逻辑应用托管标识 | 使用 LogicApps 托管标识创建连接 | 仅限 LOGICAPPS | 可共享 |
| 默认值 [已弃用] | 此选项仅适用于没有显式身份验证类型的较旧连接,并且仅用于向后兼容性。 | 所有区域 | 不可共享 |
API 密钥
身份验证 ID:keyBasedAuth
适用:所有区域
提供 Azure OpenAI 资源名称和 API 密钥,以访问托管 AI 模型的 Azure OpenAI。
这是可共享的连接。 如果 Power App 与其他用户共享,则连接也会共享。 有关详细信息,请参阅 画布应用的连接器概述 - Power Apps |Microsoft Docs
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| Azure OpenAI 资源名称 | 字符串 | 托管 AI 模型的 Azure OpenAI 资源的名称 | True |
| Azure OpenAI API 密钥 | securestring | 用于访问托管 AI 模型的 Azure OpenAI 资源的 API 密钥 | True |
| Azure 认知搜索终结点 URL | 字符串 | 用于为数据编制索引的 Azure 认知搜索终结点的 URL | |
| Azure 认知搜索 API 密钥 | securestring | 用于访问为数据编制索引的 Azure 认知搜索终结点的 API 密钥 |
逻辑应用托管标识
身份验证 ID:managedIdentityAuth
适用:仅限 LOGICAPPS
使用 LogicApps 托管标识创建连接
这是可共享的连接。 如果 Power App 与其他用户共享,则连接也会共享。 有关详细信息,请参阅 画布应用的连接器概述 - Power Apps |Microsoft Docs
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| LogicApps 托管标识 | managedIdentity | 使用逻辑应用托管标识登录 | True |
| Azure OpenAI 资源名称 | 字符串 | 托管 AI 模型的 Azure OpenAI 资源的名称 | True |
默认值 [已弃用]
适用:所有区域
此选项仅适用于没有显式身份验证类型的较旧连接,并且仅用于向后兼容性。
这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| Azure OpenAI 资源名称 | 字符串 | 托管 AI 模型的 Azure OpenAI 资源的名称 | True |
| Azure OpenAI API 密钥 | securestring | 用于访问托管 AI 模型的 Azure OpenAI 资源的 API 密钥 | True |
| Azure 认知搜索终结点 URL | 字符串 | 用于为数据编制索引的 Azure 认知搜索终结点的 URL | |
| Azure 认知搜索 API 密钥 | securestring | 用于访问为数据编制索引的 Azure 认知搜索终结点的 API 密钥 |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 1000 | 60 秒 |
操作
| 为聊天消息创建完成操作 |
为聊天消息创建完成操作 |
| 使用扩展为聊天消息创建完成 |
使用扩展为聊天消息创建完成 |
| 获取多个嵌入 |
获取给定输入数组的向量表示形式,这些输入可由机器学习模型和算法轻松使用 |
| 获取嵌入 |
获取可供机器学习模型和算法轻松使用的给定输入的向量表示形式 |
为聊天消息创建完成操作
为聊天消息创建完成操作
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
已部署模型的部署 ID
|
deployment-id | True | string |
已部署模型的部署 ID |
|
API 版本
|
api-version | True | string |
API 版本 |
|
温度
|
temperature | number |
要使用的采样温度,介于 0 和 2 之间。 较高的值(如 0.8)将使输出更随机,而较小的值(如 0.2)将使输出更集中且更具确定性
我们通常建议更改此设置或 |
|
|
top_p
|
top_p | number |
温度采样的替代方法,称为核采样,其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。
我们通常建议更改此设置或 |
|
|
数据流
|
stream | boolean |
如果设置此选项,将发送部分消息增量,如在 ChatGPT 中一样。 词元将在可用时作为服务器发送的事件发送(内容仅包括数据),并且流式传输将由 |
|
|
stop
|
stop | array of string |
最多四个序列,其中 API 将停止生成更多令牌。 返回的文本将不包含停止序列。 |
|
|
max_tokens
|
max_tokens | integer |
生成的答案允许的最大令牌数。 默认情况下,模型可返回的标记数将为(4096 - 提示标记)。 |
|
|
presence_penalty
|
presence_penalty | number |
介于 -2.0 和 2.0 之间的数字。 正值会根据它们到目前为止是否在文本中出现来惩罚新令牌,从而增加模型谈论新话题的可能性。 |
|
|
frequency_penalty
|
frequency_penalty | number |
介于 -2.0 和 2.0 之间的数字。 正值会根据它们到目前为止是否出现在文本中来惩罚新令牌,从而增加模型谈论新主题的可能性。 |
|
|
logit_bias
|
logit_bias | object |
修改指定令牌在完成中出现的可能性。 接受 json 对象,该对象将标记(由 tokenizer 中的标记 ID 指定)映射到从 -100 到 100 的相关偏差值。 在数学上,采样之前会将偏差添加到由模型生成的 logit 中。 具体效果因模型而异,但 -1 和 1 之间的值会减少或增加选择的可能性;-100 或 100 等值会导致相关令牌的禁止或独占选择。 |
|
|
用户
|
user | string |
表示最终用户的唯一标识符,可帮助 Azure OpenAI 监视和检测滥用行为。 |
|
|
角色
|
role | True | string |
消息作者的角色。 |
|
内容
|
content | True | string |
具有已定义类型的内容部件数组,每个部件可以是类型 |
|
类型
|
type | True | string |
单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 这将由聊天补全请求使用,该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。 此配置的使用仅与 Azure OpenAI 兼容。 |
|
top_n_documents
|
top_n_documents | integer |
为配置的查询提供的已配置最多文档数。 |
|
|
in_scope
|
in_scope | boolean |
是否应将查询限制为使用索引数据。 |
|
|
严谨性
|
strictness | integer |
搜索相关性筛选的已配置严格性。 严格度越高,精准率越高,但回复的召回率越低。 |
|
|
角色信息
|
role_information | string |
为模型提供有关它应该如何运行以及在生成回复时应引用的任何上下文的说明。 你可以描述助手的个性,告诉它如何设置回复的格式。 存在 100 个令牌的限制,并将计入整体令牌限制。 |
|
|
索引名称
|
index_name | True | string |
在引用的 Azure 认知搜索资源中可供使用的索引的名称。 |
|
标题字段
|
title_field | string |
要用作标题的索引字段的名称。 |
|
|
URL字段
|
url_field | string |
要用作 URL 的索引字段的名称。 |
|
|
文件路径字段 (filepath_field)
|
filepath_field | string |
要用作文件路径的索引字段的名称。 |
|
|
内容字段
|
content_fields | array of string |
应被视为内容的索引字段的名称。 |
|
|
content_fields_separator
|
content_fields_separator | string |
内容字段应使用的分隔符模式。 |
|
|
向量场
|
vector_fields | array of string |
表示矢量数据的字段的名称。 |
|
|
查询类型
|
query_type | string |
在将其用作 Azure OpenAI 聊天扩展时应执行的 Azure 认知搜索检索查询的类型。 |
|
|
语义配置
|
semantic_configuration | string |
查询的附加语义配置。 |
|
|
筛选器
|
filter | string |
搜索筛选器。 |
|
|
类型
|
type | string |
表示 Azure OpenAI On Your Data 可用于配置用于矢量搜索的矢量化数据的可用源。 |
|
|
部署名称
|
deployment_name | True | string |
指定要用于矢量化的模型部署的名称。 此模型部署必须位于同一 Azure OpenAI 资源中,但基于自有数据将通过内部调用(而不是公共调用)使用此模型部署,从而即使在专用网络中也能实现矢量搜索。 |
|
n
|
n | integer |
要为每个输入消息生成的聊天完成选项数。 |
|
|
seed
|
seed | integer |
如果指定,我们的系统将尽最大努力以确定性方式采样,这样具有相同参数的重复请求 |
|
|
logprobs
|
logprobs | boolean |
是否返回输出标记的对数概率。 如果为 true,则返回在 |
|
|
top_logprobs
|
top_logprobs | integer |
一个介于 0 和 5 之间的整数,指定在每个标记位置返回的最有可能的标记数,每个标记都有关联的对数概率。
如果使用此参数,则必须将 |
|
|
类型
|
type | string |
|
返回
使用扩展为聊天消息创建完成
使用扩展为聊天消息创建完成
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
已部署模型的部署 ID
|
deployment-id | True | string |
已部署模型的部署 ID |
|
确认已部署模型的部署 ID
|
deploymentId | True | string |
确认已部署模型的部署 ID |
|
API 版本
|
api-version | True | string |
API 版本 |
|
索引
|
index | integer |
会话中消息的索引。 |
|
|
角色
|
role | True | string |
此消息作者的角色。 |
|
收件人
|
recipient | string |
消息的收件人,格式为 <命名空间>。<作>。 仅当收件人是工具时才显示。 |
|
|
内容
|
content | True | string |
消息的内容 |
|
end_turn
|
end_turn | boolean |
消息是否结束轮次。 |
|
|
类型
|
type | True | string |
数据源类型。 |
|
parameters
|
parameters | object |
在运行时中用于数据源的参数。 |
|
|
温度
|
temperature | number |
要使用的采样温度,介于 0 和 2 之间。 较高的值(如 0.8)将使输出更随机,而较小的值(如 0.2)将使输出更集中且更具确定性
我们通常建议更改此设置或 |
|
|
top_p
|
top_p | number |
温度采样的替代方法,称为核采样,其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。
我们通常建议更改此设置或 |
|
|
数据流
|
stream | boolean |
如果设置此选项,将发送部分消息增量,如在 ChatGPT 中一样。 词元将在可用时作为服务器发送的事件发送(内容仅包括数据),并且流式传输将由 |
|
|
stop
|
stop | array of string |
数组最小大小为 1,最大大小为 4 |
|
|
max_tokens
|
max_tokens | integer |
生成的答案允许的最大令牌数。 默认情况下,模型可返回的标记数将为(4096 - 提示标记)。 |
|
|
presence_penalty
|
presence_penalty | number |
介于 -2.0 和 2.0 之间的数字。 正值会根据它们到目前为止是否在文本中出现来惩罚新令牌,从而增加模型谈论新话题的可能性。 |
|
|
frequency_penalty
|
frequency_penalty | number |
介于 -2.0 和 2.0 之间的数字。 正值会根据它们到目前为止是否出现在文本中来惩罚新令牌,从而增加模型谈论新主题的可能性。 |
|
|
logit_bias
|
logit_bias | object |
修改指定令牌在完成中出现的可能性。 接受 json 对象,该对象将标记(由 tokenizer 中的标记 ID 指定)映射到从 -100 到 100 的相关偏差值。 在数学上,采样之前会将偏差添加到由模型生成的 logit 中。 具体效果因模型而异,但 -1 和 1 之间的值会减少或增加选择的可能性;-100 或 100 等值会导致相关令牌的禁止或独占选择。 |
|
|
用户
|
user | string |
表示最终用户的唯一标识符,可帮助 Azure OpenAI 监视和检测滥用行为。 |
返回
扩展聊天完成的响应。
获取多个嵌入
获取给定输入数组的向量表示形式,这些输入可由机器学习模型和算法轻松使用
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
已部署模型的部署 ID
|
deployment-id | True | string |
已部署模型的部署 ID |
|
API 版本
|
api-version | True | string |
API 版本 |
|
输入
|
input | True | array of string |
要为其嵌入的输入文本数组,编码为字符串。 每个输入字符串的长度不得超过 2048 个标记 |
|
用户
|
user | string |
表示最终用户的唯一标识符,可帮助 Azure OpenAI 监视和检测滥用行为。 |
|
|
输入类型
|
input_type | string |
要使用的嵌入搜索的输入类型。 |
返回
获取嵌入
获取可供机器学习模型和算法轻松使用的给定输入的向量表示形式
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
已部署模型的部署 ID
|
deployment-id | True | string |
已部署模型的部署 ID |
|
API 版本
|
api-version | True | string |
API 版本 |
|
输入
|
input | True | string |
要获取嵌入的输入文本,编码为字符串。 输入字符串长度不得超过 2048 个令牌 |
|
用户
|
user | string |
表示最终用户的唯一标识符,可帮助 Azure OpenAI 监视和检测滥用行为。 |
|
|
输入类型
|
input_type | string |
要使用的嵌入搜索的输入类型。 |
返回
定义
Message
聊天消息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
索引
|
index | integer |
会话中消息的索引。 |
|
角色
|
role | string |
此消息作者的角色。 |
|
收件人
|
recipient | string |
消息的收件人,格式为 <命名空间>。<作>。 仅当收件人是工具时才显示。 |
|
内容
|
content | string |
消息的内容 |
|
end_turn
|
end_turn | boolean |
消息是否结束轮次。 |
ExtensionsChatCompletionsResponse
扩展聊天完成的响应。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | string | |
|
对象
|
object | string | |
|
已创建
|
created | integer | |
|
模型
|
model | string | |
|
prompt_filter_results
|
prompt_filter_results | promptFilterResults |
请求中零个或多个提示的内容筛选结果。 在流式处理请求中,不同提示的结果可能以不同的时间或不同的顺序到达。 |
|
prompt_tokens
|
usage.prompt_tokens | integer | |
|
completion_tokens
|
usage.completion_tokens | integer | |
|
total_tokens
|
usage.total_tokens | integer | |
|
choices
|
choices | array of ExtensionsChatCompletionChoice |
ExtensionsChatCompletionChoice
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
索引
|
index | integer | |
|
finish_reason
|
finish_reason | string | |
|
content_filter_results
|
content_filter_results | contentFilterResults |
有关内容筛选类别(hate、sexual、violence、self_harm)的信息(如果检测到),及严重性级别(very_low、low、medium、high-scale,用于确定有害内容的强度和风险级别),以及内容是否已筛选。 |
|
messages
|
messages | array of Message |
服务返回的消息列表。 |
contentFilterResult
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
severity
|
severity | string | |
|
filtered
|
filtered | boolean |
contentFilterResults
有关内容筛选类别(hate、sexual、violence、self_harm)的信息(如果检测到),及严重性级别(very_low、low、medium、high-scale,用于确定有害内容的强度和风险级别),以及内容是否已筛选。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
sexual
|
sexual | contentFilterResult | |
|
violence
|
violence | contentFilterResult | |
|
hate
|
hate | contentFilterResult | |
|
self_harm
|
self_harm | contentFilterResult | |
|
错误
|
error | errorBase |
promptFilterResult
请求中单个提示的内容筛选结果。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
prompt_index
|
prompt_index | integer | |
|
content_filter_results
|
content_filter_results | contentFilterResults |
有关内容筛选类别(hate、sexual、violence、self_harm)的信息(如果检测到),及严重性级别(very_low、low、medium、high-scale,用于确定有害内容的强度和风险级别),以及内容是否已筛选。 |
提示过滤结果
请求中零个或多个提示的内容筛选结果。 在流式处理请求中,不同提示的结果可能以不同的时间或不同的顺序到达。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
物品
|
promptFilterResult |
请求中单个提示的内容筛选结果。 |
errorBase
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
代码
|
code | string | |
|
消息
|
message | string |
errorBase_2024Feb15Preview
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
代码
|
code | string | |
|
消息
|
message | string |
contentFilterSeverityResult_2024Feb15Preview
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
filtered
|
filtered | boolean | |
|
severity
|
severity | string |
contentFilterDetectedResult_2024Feb15Preview
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
filtered
|
filtered | boolean | |
|
detected
|
detected | boolean |
contentFilterDetectedWithCitationResult_2024Feb15Preview
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
filtered
|
filtered | boolean | |
|
detected
|
detected | boolean | |
|
URL
|
citation.URL | string | |
|
许可
|
citation.license | string |
contentFilterIdResult_2024Feb15Preview
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | string | |
|
filtered
|
filtered | boolean |
contentFilterPromptResults_2024Feb15Preview
有关内容筛选类别(hate、sexual、violence、self_harm)的信息(如果检测到),及严重性级别(very_low、low、medium、high-scale,用于确定有害内容的强度和风险级别),以及内容是否已筛选。 有关越狱内容和亵渎内容的信息(如果检测到),以及是否已筛选。 以及有关客户阻止列表的信息(如果已筛选)及其 ID。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
sexual
|
sexual | contentFilterSeverityResult_2024Feb15Preview | |
|
violence
|
violence | contentFilterSeverityResult_2024Feb15Preview | |
|
hate
|
hate | contentFilterSeverityResult_2024Feb15Preview | |
|
self_harm
|
self_harm | contentFilterSeverityResult_2024Feb15Preview | |
|
profanity
|
profanity | contentFilterDetectedResult_2024Feb15Preview | |
|
custom_blocklists
|
custom_blocklists | array of contentFilterIdResult_2024Feb15Preview | |
|
错误
|
error | errorBase_2024Feb15Preview | |
|
jailbreak
|
jailbreak | contentFilterDetectedResult_2024Feb15Preview |
contentFilterChoiceResults_2024Feb15Preview
有关内容筛选类别(hate、sexual、violence、self_harm)的信息(如果检测到),及严重性级别(very_low、low、medium、high-scale,用于确定有害内容的强度和风险级别),以及内容是否已筛选。 有关第三方文本和亵渎内容的信息(如果检测到),以及是否已筛选。 以及有关客户阻止列表的信息(如果已筛选)及其 ID。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
sexual
|
sexual | contentFilterSeverityResult_2024Feb15Preview | |
|
violence
|
violence | contentFilterSeverityResult_2024Feb15Preview | |
|
hate
|
hate | contentFilterSeverityResult_2024Feb15Preview | |
|
self_harm
|
self_harm | contentFilterSeverityResult_2024Feb15Preview | |
|
profanity
|
profanity | contentFilterDetectedResult_2024Feb15Preview | |
|
custom_blocklists
|
custom_blocklists | array of contentFilterIdResult_2024Feb15Preview | |
|
错误
|
error | errorBase_2024Feb15Preview | |
|
protected_material_text
|
protected_material_text | contentFilterDetectedResult_2024Feb15Preview | |
|
protected_material_code
|
protected_material_code | contentFilterDetectedWithCitationResult_2024Feb15Preview |
promptFilterResult_2024Feb15Preview
请求中单个提示的内容筛选结果。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
prompt_index
|
prompt_index | integer | |
|
content_filter_results
|
content_filter_results | contentFilterPromptResults_2024Feb15Preview |
有关内容筛选类别(hate、sexual、violence、self_harm)的信息(如果检测到),及严重性级别(very_low、low、medium、high-scale,用于确定有害内容的强度和风险级别),以及内容是否已筛选。 有关越狱内容和亵渎内容的信息(如果检测到),以及是否已筛选。 以及有关客户阻止列表的信息(如果已筛选)及其 ID。 |
promptFilterResults_2024Feb15Preview
请求中零个或多个提示的内容筛选结果。 在流式处理请求中,不同提示的结果可能以不同的时间或不同的顺序到达。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
物品
|
promptFilterResult_2024Feb15Preview |
请求中单个提示的内容筛选结果。 |
azureChatExtensionsMessageContext_2024Feb15Preview
当 Azure OpenAI 聊天扩展涉及到生成相应的聊天补全响应时可用的其他上下文信息的表示形式。 仅当使用配置为使用匹配扩展的 Azure OpenAI 请求时,才会填充此上下文信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
citations
|
citations | array of citation_2024Feb15Preview |
数据源检索结果,用于在响应中生成助手消息。 |
|
意向
|
intent | string |
聊天历史记录中检测到的意向,用于传递到下一轮,以传递上下文。 |
citation_2024Feb15Preview
聊天补全响应消息的引文信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
内容
|
content | string |
引文的内容。 |
|
title
|
title | string |
引文的标题。 |
|
网址
|
url | string |
引文的 URL。 |
|
文件路径
|
filepath | string |
引文的文件路径。 |
|
chunk_id
|
chunk_id | string |
引文的区块 ID。 |
createChatCompletionResponse_2024Feb15Preview
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | string |
聊天补全的唯一标识符。 |
|
对象
|
object | chatCompletionResponseObject_2024Feb15Preview |
对象类型。 |
|
已创建
|
created | integer |
聊天补全创建时间的 Unix 时间戳(以秒为单位)。 |
|
模型
|
model | string |
用于聊天补全的模型。 |
|
使用情况
|
usage | completionUsage_2024Feb15Preview |
完成请求的使用情况统计信息。 |
|
system_fingerprint
|
system_fingerprint | string |
可以与 |
|
prompt_filter_results
|
prompt_filter_results | promptFilterResults_2024Feb15Preview |
请求中零个或多个提示的内容筛选结果。 在流式处理请求中,不同提示的结果可能以不同的时间或不同的顺序到达。 |
|
choices
|
choices | array of object | |
|
索引
|
choices.index | integer | |
|
finish_reason
|
choices.finish_reason | string | |
|
消息
|
choices.message | chatCompletionResponseMessage_2024Feb15Preview |
模型生成的聊天补全消息。 |
|
content_filter_results
|
choices.content_filter_results | contentFilterChoiceResults_2024Feb15Preview |
有关内容筛选类别(hate、sexual、violence、self_harm)的信息(如果检测到),及严重性级别(very_low、low、medium、high-scale,用于确定有害内容的强度和风险级别),以及内容是否已筛选。 有关第三方文本和亵渎内容的信息(如果检测到),以及是否已筛选。 以及有关客户阻止列表的信息(如果已筛选)及其 ID。 |
|
logprobs
|
choices.logprobs | chatCompletionChoiceLogProbs_2024Feb15Preview |
所选的对数概率信息。 |
chatCompletionChoiceLogProbs_2024Feb15Preview
所选的对数概率信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
内容
|
content | array of chatCompletionTokenLogprob_2024Feb15Preview |
包含对数概率信息的消息内容令牌列表。 |
chatCompletionTokenLogprob_2024Feb15Preview
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
代币
|
token | string |
令牌。 |
|
logprob
|
logprob | number |
此令牌的对数概率。 |
|
字节
|
bytes | array of integer |
表示令牌的 UTF-8 字节表示形式的整数列表。 在字符由多个令牌表示,并且其字节表示形式必须组合在一起才能生成正确的文本表示形式的情况下非常有用。 如果令牌没有字节表示形式,则为 |
|
top_logprobs
|
top_logprobs | array of object |
在此标记位置上,最有可能的标记及其对数概率的列表。 在极少数情况下,返回的数量可能少于请求的 |
|
代币
|
top_logprobs.token | string |
令牌。 |
|
logprob
|
top_logprobs.logprob | number |
此令牌的对数概率。 |
|
字节
|
top_logprobs.bytes | array of integer |
表示令牌的 UTF-8 字节表示形式的整数列表。 在字符由多个令牌表示,并且其字节表示形式必须组合在一起才能生成正确的文本表示形式的情况下非常有用。 如果令牌没有字节表示形式,则为 |
chatCompletionResponseMessage_2024Feb15Preview
模型生成的聊天补全消息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
角色
|
role | chatCompletionResponseMessageRole_2024Feb15Preview |
响应消息作者的角色。 |
|
内容
|
content | string |
消息的内容。 |
|
上下文
|
context | azureChatExtensionsMessageContext_2024Feb15Preview |
当 Azure OpenAI 聊天扩展涉及到生成相应的聊天补全响应时可用的其他上下文信息的表示形式。 仅当使用配置为使用匹配扩展的 Azure OpenAI 请求时,才会填充此上下文信息。 |
chatCompletionResponseMessageRole_2024Feb15Preview
chatCompletionResponseObject_2024Feb15Preview
completionUsage_2024Feb15Preview
完成请求的使用情况统计信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
prompt_tokens
|
prompt_tokens | integer |
提示中的标记数。 |
|
completion_tokens
|
completion_tokens | integer |
生成的补全中的词元数。 |
|
total_tokens
|
total_tokens | integer |
请求中使用的令牌总数(提示 + 补全)。 |
getSingleEmbeddingsResponse_2024Feb15Preview
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
对象
|
object | string |
响应对象类型的详细信息 |
|
模型
|
model | string |
模型名称 |
|
embedding
|
embedding | array of number |
表示给定输入的计算嵌入的浮点数组 |
|
prompt_tokens
|
usage.prompt_tokens | integer |
输入中使用的令牌数 |
|
total_tokens
|
usage.total_tokens | integer |
使用的令牌总数 |
getMultipleEmbeddingsResponse_2024Feb15Preview
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
对象
|
object | string |
响应对象类型的详细信息 |
|
模型
|
model | string |
模型名称 |
|
embeddings
|
embeddings | array of array |
一个数组,其中包含表示输入字符串集合的计算嵌入的浮点数组 |
|
items
|
embeddings | array of number | |
|
prompt_tokens
|
usage.prompt_tokens | integer |
输入中使用的令牌数 |
|
total_tokens
|
usage.total_tokens | integer |
使用的令牌总数 |