Azure OpenAI (預覽版)
輕鬆將 Azure OpenAI 的尖端人工智慧功能整合到您的工作流程中
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | Microsoft |
| URL | https://support.microsoft.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 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。 | 所有區域 | 可共用 |
| Logic Apps 受控識別 | 使用 LogicApps 受控識別建立連線 | 僅限 LOGICAPPS | 可共用 |
| 預設值 [已棄用] | 此選項僅適用於沒有明確驗證類型的舊連線,並且僅用於回溯相容性。 | 所有區域 | 不可共享 |
API 金鑰
驗證 ID:keyBasedAuth
適用:所有地區
提供 Azure OpenAI 資源名稱和 API 金鑰,以存取裝載 AI 模型的 Azure OpenAI。
這是可共享的連接。 如果 Power App 與其他使用者共用,也會共用連線。 如需詳細資訊,請參閱 畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| Azure OpenAI 資源名稱 | 字串 | 裝載 AI 模型之 Azure OpenAI 資源的名稱 | 對 |
| Azure OpenAI API 金鑰 | securestring | 存取裝載 AI 模型之 Azure OpenAI 資源的 API 金鑰 | 對 |
| Azure 認知搜尋端點 URL | 字串 | 為資料編製索引的 Azure 認知搜尋服務端點的 URL | |
| Azure 認知搜尋 API 金鑰 | securestring | 存取 Azure 認知搜尋服務端點的 API 金鑰,以編製資料索引 |
Logic Apps 受控識別
驗證 ID:managedIdentityAuth
適用:僅限 LOGICAPPS
使用 LogicApps 受控識別建立連線
這是可共享的連接。 如果 Power App 與其他使用者共用,也會共用連線。 如需詳細資訊,請參閱 畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| LogicApps 受控識別 | managedIdentity | 使用 Logic Apps 受控識別登入 | 對 |
| Azure OpenAI 資源名稱 | 字串 | 裝載 AI 模型之 Azure OpenAI 資源的名稱 | 對 |
預設值 [已棄用]
適用:所有地區
此選項僅適用於沒有明確驗證類型的舊連線,並且僅用於回溯相容性。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| Azure OpenAI 資源名稱 | 字串 | 裝載 AI 模型之 Azure OpenAI 資源的名稱 | 對 |
| Azure OpenAI API 金鑰 | securestring | 存取裝載 AI 模型之 Azure OpenAI 資源的 API 金鑰 | 對 |
| Azure 認知搜尋端點 URL | 字串 | 為資料編製索引的 Azure 認知搜尋服務端點的 URL | |
| Azure 認知搜尋 API 金鑰 | securestring | 存取 Azure 認知搜尋服務端點的 API 金鑰,以編製資料索引 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 1000 | 60 秒 |
動作
| 使用擴充功能建立聊天訊息的完成 |
使用擴充功能建立聊天訊息的完成 |
| 取得內嵌 |
取得指定輸入的向量表示法,可由機器學習模型和演算法輕鬆使用 |
| 取得多個內嵌 |
取得機器學習模型和演算法可以輕鬆使用的給定輸入陣列的向量表示 |
| 建立聊天訊息的完成 |
建立聊天訊息的完成 |
使用擴充功能建立聊天訊息的完成
使用擴充功能建立聊天訊息的完成
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
已部署模型的部署識別碼
|
deployment-id | True | string |
已部署模型的部署識別碼 |
|
確認已部署模型的部署識別碼
|
deploymentId | True | string |
確認已部署模型的部署識別碼 |
|
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 | array of string |
陣列大小下小為 1,最大為 4 |
|
|
最大代幣數
|
max_tokens | integer |
所產生答案允許的權杖數目上限。 根據預設,模型可傳回的權杖數目會是 (4096 - 提示權杖)。 |
|
|
出現懲罰
|
presence_penalty | number |
介於 -2.0 和 2.0 之間的數字。 正值會根據權杖迄今為止是否出現在文字中來打壓新權杖,提高模型討論新主題的可能性。 |
|
|
頻率懲罰
|
frequency_penalty | number |
介於 -2.0 和 2.0 之間的數字。 正值會根據權杖迄今為止在文字中的出現頻率來打壓新權杖,降低模型重複完全相同行的可能性。 |
|
|
logit偏差
|
logit_bias | object |
修改在完成時出現指定權杖的可能性。 接受 json 物件,此物件會將權杖 (由權杖化工具中的權杖識別碼所指定) 對應至 -100 到 100 的相關偏差值。 在數學上,偏差會先加到模型產生的對數,再取樣。 確切的效果會因模型而異,但介於 -1 到 1 之間的值應該會降低或提高選取的可能性;而 -100 或 100 之類的值應會導致禁止選取或獨佔選取相關權杖。 |
|
|
使用者
|
user | string |
代表使用者的唯一識別碼,可協助 Azure OpenAI 監視和偵測濫用。 |
傳回
擴充功能聊天完成的回應。
取得內嵌
取得指定輸入的向量表示法,可由機器學習模型和演算法輕鬆使用
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
已部署模型的部署識別碼
|
deployment-id | True | string |
已部署模型的部署識別碼 |
|
API 版本
|
api-version | True | string |
API 版本 |
|
輸入
|
input | True | string |
輸入要取得內嵌的文字,編碼為字串。 輸入字串的長度不得超過 2048 個權杖 |
|
使用者
|
user | string |
代表使用者的唯一識別碼,可協助 Azure OpenAI 監視和偵測濫用。 |
|
|
輸入類型
|
input_type | string |
要使用的內嵌搜尋的輸入類型。 |
傳回
取得多個內嵌
取得機器學習模型和演算法可以輕鬆使用的給定輸入陣列的向量表示
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
已部署模型的部署識別碼
|
deployment-id | True | string |
已部署模型的部署識別碼 |
|
API 版本
|
api-version | True | string |
API 版本 |
|
輸入
|
input | True | array of string |
要取得內嵌的輸入文字陣列,編碼為字串。 每個輸入字串的長度不得超過 2048 個記號 |
|
使用者
|
user | string |
代表使用者的唯一識別碼,可協助 Azure OpenAI 監視和偵測濫用。 |
|
|
輸入類型
|
input_type | string |
要使用的內嵌搜尋的輸入類型。 |
傳回
建立聊天訊息的完成
建立聊天訊息的完成
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
已部署模型的部署識別碼
|
deployment-id | True | string |
已部署模型的部署識別碼 |
|
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 | array of string |
API 會停止產生更多權杖的這種序列,最多 4 個。 傳回的文字不會包含停止序列。 |
|
|
最大代幣數
|
max_tokens | integer |
所產生答案允許的權杖數目上限。 根據預設,模型可傳回的權杖數目會是 (4096 - 提示權杖)。 |
|
|
出現懲罰
|
presence_penalty | number |
介於 -2.0 和 2.0 之間的數字。 正值會根據權杖迄今為止是否出現在文字中來打壓新權杖,提高模型討論新主題的可能性。 |
|
|
頻率懲罰
|
frequency_penalty | number |
介於 -2.0 和 2.0 之間的數字。 正值會根據權杖迄今為止在文字中的出現頻率來打壓新權杖,降低模型重複完全相同行的可能性。 |
|
|
logit偏差
|
logit_bias | object |
修改在完成時出現指定權杖的可能性。 接受 json 物件,此物件會將權杖 (由權杖化工具中的權杖識別碼所指定) 對應至 -100 到 100 的相關偏差值。 在數學上,偏差會先加到模型產生的對數,再取樣。 確切的效果會因模型而異,但介於 -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
|
strictness | integer |
已設定的搜尋相關性篩選嚴格度。 嚴格度越高,精確度就越高,但答案的召回率越低。 |
|
|
角色資訊
|
role_information | string |
提供模型關於其行為方式的指示,以及產生回應時應該參考的任何內容。 您可以描述助理的特質,並對其告知如何格式化回應。 其權杖數限制為 100 個,且會計入整體權杖限制。 |
|
|
索引名稱
|
index_name | True | string |
要在參考的 Azure 搜尋服務資源中作為可用索引的索引名稱。 |
|
標題欄位
|
title_field | string |
要用作標題的索引欄位名稱。 |
|
|
網址欄位
|
url_field | string |
要用作 URL 的索引欄位名稱。 |
|
|
檔案路徑欄位
|
filepath_field | string |
要用作檔案路徑的索引欄位名稱。 |
|
|
content_fields
|
content_fields | array of string |
應視為內容的索引欄位名稱。 |
|
|
content_fields_separator
|
content_fields_separator | string |
內容欄位應使用的分隔符號模式。 |
|
|
向量場
|
vector_fields | array of string |
代表向量資料的欄位名稱。 |
|
|
查詢類型
|
query_type | string |
Azure 搜尋服務擷取查詢在用作 Azure OpenAI 聊天延伸模組時所應執行的類型。 |
|
|
語義配置
|
semantic_configuration | string |
查詢的其他語意設定。 |
|
|
篩選
|
filter | string |
搜尋篩選器。 |
|
|
型別
|
type | string |
代表 Azure OpenAI On Your Data 可用來設定資料向量化以用於向量搜尋的可用來源。 |
|
|
部署名稱
|
deployment_name | True | string |
指定要用於向量化的模型部署名稱。 此模型部署必須位於相同的 Azure OpenAI 資源中,但 On Your Data 將會透過內部呼叫 (而非公用呼叫) 來使用此模型部署,因此即使在私人網路中也會啟用向量搜尋。 |
|
n
|
n | integer |
針對每個輸入訊息產生多少聊天完成選項。 |
|
|
seed
|
seed | integer |
如果指定,我們的系統將盡最大努力以確定性方式進行採樣,以便具有相同 |
|
|
logprobs
|
logprobs | boolean |
是否要傳回輸出權杖的對數機率。 如果為 true,則會傳回在 |
|
|
top_logprobs
|
top_logprobs | integer |
介於 0 到 5 之間的整數,指定在每個權杖位置最有可能傳回的權杖數目,每個權杖都有相關聯的對數機率。
如果使用此參數,則 |
|
|
型別
|
type | string |
設定為 |
傳回
定義
Message
聊天訊息。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
索引
|
index | integer |
交談中訊息的索引。 |
|
角色
|
role | string |
此訊息作者的角色。 |
|
收件者
|
recipient | string |
以命名空間>格式<的訊息收件者。<操作>。 當且僅當收件人是工具時才會出現。 |
|
內容
|
content | string |
訊息的內容 |
|
end_turn
|
end_turn | boolean |
訊息是否結束回合。 |
擴充功能ChatCompletionsResponse
擴充功能聊天完成的回應。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
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 | array of ExtensionsChatCompletionChoice |
擴充功能ChatCompletionChoice
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
索引
|
index | integer | |
|
finish_reason
|
finish_reason | string | |
|
content_filter_results
|
content_filter_results | contentFilterResults |
有關內容篩選類別 (仇恨、性、暴力、自殘)、是否偵測到此類內容,以及嚴重性層級 (非常低、低、中、高,用來判定有害內容的強度和風險層級),和內容是否已篩選的資訊。 |
|
messages
|
messages | array of Message |
服務傳回的訊息清單。 |
內容篩選結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
嚴重
|
severity | string | |
|
filtered
|
filtered | boolean |
內容篩選結果
有關內容篩選類別 (仇恨、性、暴力、自殘)、是否偵測到此類內容,以及嚴重性層級 (非常低、低、中、高,用來判定有害內容的強度和風險層級),和內容是否已篩選的資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
sexual
|
sexual | contentFilterResult | |
|
violence
|
violence | contentFilterResult | |
|
hate
|
hate | contentFilterResult | |
|
self_harm
|
self_harm | contentFilterResult | |
|
錯誤
|
error | errorBase |
promptFilterResult
要求中單一提示的內容篩選結果。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
prompt_index
|
prompt_index | integer | |
|
content_filter_results
|
content_filter_results | contentFilterResults |
有關內容篩選類別 (仇恨、性、暴力、自殘)、是否偵測到此類內容,以及嚴重性層級 (非常低、低、中、高,用來判定有害內容的強度和風險層級),和內容是否已篩選的資訊。 |
promptFilterResults
要求中零個或多個提示的內容篩選結果。 在串流要求中,不同提示的結果可能會在不同時間或依不同的順序抵達。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
promptFilterResult |
要求中單一提示的內容篩選結果。 |
errorBase
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字碼
|
code | string | |
|
訊息
|
message | string |
errorBase_2024Feb15Preview
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字碼
|
code | string | |
|
訊息
|
message | string |
contentFilterSeverityResult_2024Feb15Preview
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
filtered
|
filtered | boolean | |
|
嚴重
|
severity | string |
contentFilterDetectedResult_2024Feb15Preview
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
filtered
|
filtered | boolean | |
|
detected
|
detected | boolean |
contentFilterDetectedWithCitationResult_2024Feb15Preview
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
filtered
|
filtered | boolean | |
|
detected
|
detected | boolean | |
|
URL
|
citation.URL | string | |
|
使用權
|
citation.license | string |
contentFilterIdResult_2024Feb15Preview
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string | |
|
filtered
|
filtered | boolean |
contentFilterPromptResults_2024Feb15Preview
有關內容篩選類別 (仇恨、性、暴力、自殘)、是否偵測到此類內容,以及嚴重性層級 (非常低、低、中、高,用來判定有害內容的強度和風險層級),和內容是否已篩選的資訊。 有關越獄內容和粗話、是否偵測到此類內容,以及內容是否已篩選的資訊。 有關客戶封鎖清單、清單是否已篩選及其識別碼的資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
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
有關內容篩選類別 (仇恨、性、暴力、自殘)、是否偵測到此類內容,以及嚴重性層級 (非常低、低、中、高,用來判定有害內容的強度和風險層級),和內容是否已篩選的資訊。 有關第三方文字和粗話、是否偵測到此類內容,以及內容是否已篩選的資訊。 有關客戶封鎖清單、清單是否已篩選及其識別碼的資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
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
要求中單一提示的內容篩選結果。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
prompt_index
|
prompt_index | integer | |
|
content_filter_results
|
content_filter_results | contentFilterPromptResults_2024Feb15Preview |
有關內容篩選類別 (仇恨、性、暴力、自殘)、是否偵測到此類內容,以及嚴重性層級 (非常低、低、中、高,用來判定有害內容的強度和風險層級),和內容是否已篩選的資訊。 有關越獄內容和粗話、是否偵測到此類內容,以及內容是否已篩選的資訊。 有關客戶封鎖清單、清單是否已篩選及其識別碼的資訊。 |
promptFilterResults_2024Feb15Preview
要求中零個或多個提示的內容篩選結果。 在串流要求中,不同提示的結果可能會在不同時間或依不同的順序抵達。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
promptFilterResult_2024Feb15Preview |
要求中單一提示的內容篩選結果。 |
azureChatExtensionsMessageContext_2024Feb15Preview
一種表示法,在產生對應的聊天完成回應時若涉及 Azure OpenAI 聊天延伸模組,用來代表其他可用的內容資訊。 只有在使用的 Azure OpenAI 要求設定為使用相符的延伸模組時,才會填入此內容資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
citations
|
citations | array of citation_2024Feb15Preview |
資料來源擷取結果,用於在回應中產生小幫手訊息。 |
|
意圖
|
intent | string |
從聊天記錄中偵測到的意圖,用來傳至下一個回合,以傳遞內容。 |
citation_2024Feb15Preview
聊天完成回應訊息的引文資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
內容
|
content | string |
引文的內容。 |
|
title
|
title | string |
引文的標題。 |
|
url
|
url | string |
引文的 URL。 |
|
檔案路徑
|
filepath | string |
引文的檔案路徑。 |
|
Chunk ID (區塊識別碼)
|
chunk_id | string |
引文的區塊識別碼。 |
createChatCompletionResponse_2024Feb15Preview
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
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 | 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 |
有關內容篩選類別 (仇恨、性、暴力、自殘)、是否偵測到此類內容,以及嚴重性層級 (非常低、低、中、高,用來判定有害內容的強度和風險層級),和內容是否已篩選的資訊。 有關第三方文字和粗話、是否偵測到此類內容,以及內容是否已篩選的資訊。 有關客戶封鎖清單、清單是否已篩選及其識別碼的資訊。 |
|
logprobs
|
choices.logprobs | chatCompletionChoiceLogProbs_2024Feb15Preview |
選擇的對數機率資訊。 |
chatCompletionChoiceLogProbs_2024Feb15Preview
選擇的對數機率資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
內容
|
content | array of chatCompletionTokenLogprob_2024Feb15Preview |
具有對數機率資訊的訊息內容權杖清單。 |
chatCompletionTokenLogprob_2024Feb15Preview
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Token
|
token | string |
權杖。 |
|
logprob
|
logprob | number |
此權杖的對數機率。 |
|
bytes
|
bytes | array of integer |
一個整數清單,代表權杖的 UTF-8 位元組表示法。 如果由多個權杖代表字元,而且其位元組表示法必須合併以產生正確的文字表示法,則十分有用。 如果權杖沒有位元組表示法,則可以是 |
|
top_logprobs
|
top_logprobs | array of object |
此權杖位置上最有可能的權杖和其對數機率清單。 在罕見的情況下,可能會少於所傳回的已要求 |
|
Token
|
top_logprobs.token | string |
權杖。 |
|
logprob
|
top_logprobs.logprob | number |
此權杖的對數機率。 |
|
bytes
|
top_logprobs.bytes | array of integer |
一個整數清單,代表權杖的 UTF-8 位元組表示法。 如果由多個權杖代表字元,而且其位元組表示法必須合併以產生正確的文字表示法,則十分有用。 如果權杖沒有位元組表示法,則可以是 |
chatCompletionResponseMessage_2024Feb15Preview
模型產生的聊天完成訊息。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
角色
|
role | chatCompletionResponseMessageRole_2024Feb15Preview |
回應訊息作者的角色。 |
|
內容
|
content | string |
訊息的內容。 |
|
內容
|
context | azureChatExtensionsMessageContext_2024Feb15Preview |
一種表示法,在產生對應的聊天完成回應時若涉及 Azure OpenAI 聊天延伸模組,用來代表其他可用的內容資訊。 只有在使用的 Azure OpenAI 要求設定為使用相符的延伸模組時,才會填入此內容資訊。 |
chatCompletionResponseMessageRole_2024Feb15Preview
chatCompletionResponseObject_2024Feb15Preview
completionUsage_2024Feb15Preview
完成要求的使用量統計資料。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
prompt_tokens
|
prompt_tokens | integer |
提示中的權杖數目。 |
|
completion_tokens
|
completion_tokens | integer |
已產生完成中的權杖數目。 |
|
total_tokens
|
total_tokens | integer |
要求中使用的權杖總數 (提示 + 完成)。 |
getSingleEmbeddingsResponse_2024Feb15Preview
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物件
|
object | string |
回應物件類型的詳細資料 |
|
型號
|
model | string |
模型名稱 |
|
embedding
|
embedding | array of number |
浮點數陣列,代表指定輸入的計算內嵌 |
|
prompt_tokens
|
usage.prompt_tokens | integer |
輸入中使用的權杖數目 |
|
total_tokens
|
usage.total_tokens | integer |
使用的權杖總數 |
getMultipleEmbeddingsResponse_2024Feb15Preview
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物件
|
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 |
使用的權杖總數 |