Azure AI Foundry 代理程式服務 (預覽)
輕鬆地將 Azure AI Foundry 代理程式服務功能整合到您的工作流程中。
此連接器適用於以下產品和區域:
| 服務 | 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://learn.microsoft.com/en-us/azure/ai-services/agents/ |
| 隱私策略 | https://learn.microsoft.com/en-us/legal/cognitive-services/agents/data-privacy-security |
| 類別 | 人工智慧;商業智慧 |
正在建立連線
連接器支援下列驗證類型:
| Logic Apps 受控識別 | 使用 LogicApps 受控識別建立連線 | 僅限 LOGICAPPS | 可共用 |
| Microsoft Entra ID 使用者登入 | 使用 Microsoft Entra ID 認證登入 | 所有區域 | 不可共享 |
| 預設值 [已棄用] | 此選項僅適用於沒有明確驗證類型的舊連線,並且僅用於回溯相容性。 | 所有區域 | 不可共享 |
Logic Apps 受控識別
驗證 ID:managedIdentityAuth
適用:僅限 LOGICAPPS
使用 LogicApps 受控識別建立連線
這是可共享的連接。 如果 Power App 與其他使用者共用,也會共用連線。 如需詳細資訊,請參閱 畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| LogicApps 受控識別 | managedIdentity | 使用 Logic Apps 受控識別登入 | 對 |
| Azure AI 專案端點 | 字串 | Azure AI 專案端點的名稱,例如 https://{account-name}.services.ai.azure.com/api/projects/{project-name} | 對 |
Microsoft Entra ID 使用者登入
驗證識別碼:entraIDUserLogin
適用:所有地區
使用 Microsoft Entra ID 認證登入
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| Azure AI 專案端點 | 字串 | Azure AI 專案端點的名稱,例如 https://{account-name}.services.ai.azure.com/api/projects/{project-name} | 對 |
預設值 [已棄用]
適用:所有地區
此選項僅適用於沒有明確驗證類型的舊連線,並且僅用於回溯相容性。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 1000 | 60 秒 |
動作
| 以代理程式識別碼為基礎的外部代理程式活動通訊協定 |
以代理程式識別碼為基礎的外部代理程式活動通訊協定 |
| 列出代理 |
列出代理 |
| 列出消息 |
列出消息 |
| 創建運行 |
創建運行 |
| 叫用代理程式 |
叫用代理程式。 |
| 基於應用程式的外部代理活動通訊協定 |
基於應用程式的外部代理活動通訊協定 |
| 建立線程 |
建立線程 |
| 開始運行 |
開始運行 |
以代理程式識別碼為基礎的外部代理程式活動通訊協定
以代理程式識別碼為基礎的外部代理程式活動通訊協定
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要傳送訊息的代理程式 ID。
|
AgentId | True | string |
要傳送訊息的代理程式 ID。 |
|
|
object |
傳回
- response
- object
列出代理
列出消息
列出消息
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
API 版本
|
api-version | True | string |
API 版本 |
|
要為其建立訊息的執行緒識別碼。
|
ThreadId | True | string |
要為其建立訊息的執行緒識別碼。 |
傳回
創建運行
創建運行
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
API 版本
|
api-version | True | string |
API 版本 |
|
要為其建立訊息的執行緒識別碼。
|
ThreadId | True | string |
要為其建立訊息的執行緒識別碼。 |
|
assistant_id
|
assistant_id | True | string |
用來執行此執行的助理識別碼。 |
|
型號
|
model | string |
要用來執行此執行的模型部署名稱。 如果提供,它會置換助理的模型部署名稱。 |
|
|
instructions
|
instructions | string |
置換助理的指示。 對於每次執行修改行為很有用。 |
|
|
additional_instructions
|
additional_instructions | string |
在執行的指令結尾附加其他指令。 |
|
|
角色
|
role | string |
正在建立訊息的實體角色。 可以是使用者或助理。 'user' 表示訊息是由實際使用者傳送,在大多數情況下應該用來代表使用者產生的訊息。 'assistant' 表示訊息是由助理產生的。 使用此值,將來自助理的訊息插入對話中。 |
|
|
內容
|
content | string |
訊息的內容。 |
|
|
名稱
|
name | string |
可在執行中使用的檔案標識碼或訊息清單。 |
|
|
中繼資料
|
metadata | object |
可附加至物件的索引鍵/值組 (16 個為一組)。 這有助於以結構化格式儲存物件的其他相關資訊。 索引鍵的長度上限為 64 個字元,而值的長度上限為 512 個字元。 |
|
|
名稱
|
name | string |
可在執行中使用的工具清單。 |
|
|
中繼資料
|
metadata | object |
附加至物件的 16 個索引鍵值組的集合。 索引鍵長度上限:64 個字元,值長度上限:512 個字元。 |
|
|
溫度
|
temperature | number |
取樣溫度 (0-2)。 較高的值(例如,0.8)會增加隨機性,較低的值(例如,0.2)使輸出更具確定性。 |
|
|
top_p
|
top_p | number |
細胞核採樣替代溫度。 0.1 表示考慮前 10% 機率質量。 |
|
|
串流
|
stream | boolean |
如果為 true,則會在執行期間傳回事件串流,作為伺服器傳送的事件,以「data: [DONE]」訊息終止。 |
|
|
max_prompt_tokens
|
max_prompt_tokens | integer |
在執行期間可能使用的完成記號數目上限。 如果超過,則執行會以未完成結束。 |
|
|
max_completion_tokens
|
max_completion_tokens | integer |
在執行期間可能使用的完成記號數目上限。 如果超過,則執行會以未完成結束。 |
|
|
truncation_strategy
|
truncation_strategy | object |
控制在執行之前截斷執行緒的方式,以管理初始內容視窗。 |
|
|
tool_choice
|
tool_choice | object |
控制模型呼叫的工具。 預設為「自動」,允許模型決定。 可以設定為「無」以停用工具使用。 |
|
|
回應格式
|
response_format | object |
指定輸出格式。 設定 { 'type': 'json_object' } 會啟用有效 JSON 回應的 JSON 模式。 |
傳回
叫用代理程式
叫用代理程式。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
API 版本
|
api-version | True | string |
API 版本 |
|
中繼資料
|
metadata | object |
可附加至物件的索引鍵/值組 (16 個為一組)。 這很適合用來以結構化格式儲存物件的其他資訊,以及透過 API 或儀錶板查詢物件。 索引鍵是長度上限為64個字元的字串。 值是長度上限為 512 個字元的字串。 |
|
|
使用者
|
user | string |
代表使用者的唯一標識碼,可協助 OpenAI 監視和偵測濫用行為。 深入瞭解。 |
|
|
top_logprobs
|
top_logprobs | integer |
介於 0 到 20 之間的整數,其會指定最有可能在每個語彙基元位置傳回的語彙基元數目,每個都有相關聯的對數機率。 |
|
|
previous_response_id
|
previous_response_id | string |
先前回應模型的唯一識別碼。 使用這個功能來建立多輪對話。 深入瞭解 交談狀態。 |
|
|
背景
|
background | boolean |
是否要在背景執行模型回應。 深入瞭解。 |
|
|
max_output_tokens
|
max_output_tokens | integer |
可針對回應產生的記號數目上限,包括可見的輸出記號和 推理記號。 |
|
|
最大工具呼叫次數
|
max_tool_calls | integer |
回應中可處理的內建工具呼叫總數上限。 此最大數目適用於所有內建工具呼叫,而不是每個個別工具。 系統會忽略模型呼叫工具的任何進一步嘗試。 |
|
|
型別
|
type | True | string |
物件,指定模型必須輸出的格式。
預設格式為 不建議使用 gpt-4o 和較新的模型: 設定為 |
|
型別
|
type | True | string |
可用來產生回應的工具。 |
|
tool_choice
|
tool_choice |
模型應該如何選取產生回應時要使用的工具(或工具)。
|
||
|
識別碼
|
id | True | string |
要使用的提示範本的唯一識別碼。 |
|
版本
|
version | string |
提示範本的選用版本。 |
|
|
variables
|
variables | object |
選用的值對應,用於替換您提示中的變數。 替代值可以是字串或其他回應輸入類型,例如影像或檔案。 |
|
|
truncation
|
truncation | string |
用於模型回應的截斷策略。
|
|
|
輸入
|
input |
用來讓模型產生回應的文字、影像或檔案輸入。 瞭解詳情: |
||
|
include
|
include | string |
指定要包含在模型回應中的其他輸出數據。 目前支援的值如下:
|
|
|
平行工具呼叫
|
parallel_tool_calls | boolean |
是否允許模型平行執行工具呼叫。 |
|
|
儲存
|
store | boolean |
是否要儲存產生的模型回應,以便稍後透過 API 擷取。 |
|
|
instructions
|
instructions | string |
插入模型內容中的系統(或開發人員)訊息。 與 一起使用 |
|
|
型別
|
type | True | string | |
|
名稱
|
name | True | string |
代理程式的名稱。 |
|
版本
|
version | True | string |
代理程式的版本識別碼。 |
傳回
基於應用程式的外部代理活動通訊協定
基於應用程式的外部代理活動通訊協定
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代理程式應用程式。
|
MyApplication | True | string |
代理程式應用程式。 |
|
|
object |
傳回
- response
- object
建立線程
建立線程
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
API 版本
|
api-version | True | string |
API 版本 |
|
角色
|
role | string |
正在建立訊息的實體角色。 可以是使用者或助理。 'user' 表示訊息是由實際使用者傳送,在大多數情況下應該用來代表使用者產生的訊息。 'assistant' 表示訊息是由助理產生的。 使用此值,將來自助理的訊息插入對話中。 |
|
|
內容
|
content | string |
訊息的內容。 |
|
|
名稱
|
name | string |
可在執行中使用的檔案標識碼或訊息清單。 |
|
|
中繼資料
|
metadata | object |
可附加至物件的索引鍵/值組 (16 個為一組)。 這有助於以結構化格式儲存物件的其他相關資訊。 索引鍵的長度上限為 64 個字元,而值的長度上限為 512 個字元。 |
|
|
中繼資料
|
metadata | object |
可附加至物件的索引鍵/值組 (16 個為一組)。 這有助於以結構化格式儲存物件的其他相關資訊。 索引鍵的長度上限為 64 個字元,而值的長度上限為 512 個字元。 |
|
|
tool_resources
|
tool_resources | object |
可供此執行緒中的助理工具使用的一組資源。 工具的類型專用的資源。 例如,code_interpreter 工具需要檔案 ID 清單,而file_search工具需要向量存放區 ID 清單。 |
傳回
開始運行
開始運行
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
API 版本
|
api-version | True | string |
API 版本 |
|
要為其建立訊息的執行緒識別碼。
|
ThreadId | True | string |
要為其建立訊息的執行緒識別碼。 |
|
執行的識別碼。
|
RunId | True | string |
執行的識別碼。 |
傳回
定義
listAgents回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物件
|
object | string |
回應物件類型的詳細資料。 |
|
資料
|
data | array of Data |
服務傳回的訊息清單。 |
|
first_id
|
first_id | string |
第一個 id 的詳細信息。 |
|
last_id
|
last_id | string |
最後一個 ID 的詳細資料。 |
|
還有更多
|
has_more | boolean |
告訴是否有更多代理程式。 |
createThread回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
識別碼,可在 API 端點中參考。 |
|
物件
|
object | string |
物件類型,一律是執行緒。 |
|
建立於
|
created_at | integer |
執行緒建立時的 Unix 時間戳記 (以秒為單位)。 |
|
中繼資料
|
metadata | object |
可附加至物件的索引鍵/值組 (16 個為一組)。 這有助於以結構化格式儲存物件的其他相關資訊。 索引鍵的長度上限為 64 個字元,而值的長度上限為 512 個字元。 |
createRun回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
識別碼,可在 API 端點中參考。 |
|
物件
|
object | string |
物件類型,一律是 thread.run。 |
|
建立於
|
created_at | integer |
執行建立時的 Unix 時間戳記 (以秒為單位)。 |
|
thread_id
|
thread_id | string |
在此執行過程中執行的執行緒識別碼。 |
|
assistant_id
|
assistant_id | string |
用來執行此執行的助理識別碼。 |
|
狀態
|
status | string |
執行的狀態,可以是佇列、in_progress、requires_action、取消、取消、失敗、已完成或已過期。 |
|
required_action
|
required_action | object |
繼續執行所需之動作的詳細資料。 如果不需要採取任何動作,則為空值。 |
|
last_error
|
last_error | object |
與此執行相關聯的最後一個錯誤。 如果沒有錯誤,則為 null。 |
|
到期時間
|
expires_at | integer |
執行到期時的 Unix 時間戳記 (以秒為單位)。 |
|
started_at
|
started_at | integer |
執行啟動時的 Unix 時間戳記 (以秒為單位)。 |
|
cancelled_at
|
cancelled_at | integer |
取消執行時的 Unix 時間戳記 (以秒為單位)。 |
|
failed_at
|
failed_at | integer |
執行失敗時的 Unix 時間戳記 (以秒為單位)。 |
|
completed_at
|
completed_at | integer |
執行完成時的 Unix 時間戳記 (以秒為單位)。 |
|
型號
|
model | string |
助理用於此執行的模型部署名稱。 |
|
instructions
|
instructions | string |
助理用於此執行的指示。 |
|
工具
|
tools | array of tools |
助理用於此執行的工具清單。 |
|
文件識別碼
|
file_ids | array of fileIds |
助理用於此執行的檔案 ID 清單。 |
|
中繼資料
|
metadata | object |
可附加至物件的索引鍵/值組 (16 個為一組)。 索引鍵長度上限為 64 個字元,值長度上限為 512 個字元。 |
|
tool_choice
|
tool_choice | object |
控制模型所呼叫的工具 (若有)。 'none' 表示模型不會呼叫任何工具,而是產生訊息。 'auto' 表示模型可以在產生訊息或呼叫工具之間進行選擇。 指定 {'type': 'file_search'} 或 {'type': 'function', 'function': {'name': 'my_function'}} 等工具會強制模型呼叫該工具。 |
|
max_prompt_tokens
|
max_prompt_tokens | number |
在執行過程中指定為已使用的提示權杖數目上限。 |
|
max_completion_tokens
|
max_completion_tokens | number |
在執行過程中指定為已使用的完成權杖數目上限。 |
|
使用方式
|
usage | object |
與執行相關的使用量統計資料。 如果執行未處於終端狀態 (例如,in_progress、排入佇列) ,則此值將為 Null。 |
|
truncation_strategy
|
truncation_strategy | object |
控制執行緒在執行之前截斷執行程的方式。 |
|
回應格式
|
response_format | string |
模型必須輸出的格式。 與 GPT-4 Turbo 和自 gpt-3.5-turbo-1106 以來的所有 GPT-3.5 Turbo 模型相容。 |
getRun回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
識別碼,可在 API 端點中參考。 |
|
物件
|
object | string |
物件類型,一律是 thread.run。 |
|
建立於
|
created_at | integer |
執行建立時的 Unix 時間戳記 (以秒為單位)。 |
|
thread_id
|
thread_id | string |
在此執行過程中執行的執行緒識別碼。 |
|
assistant_id
|
assistant_id | string |
用來執行此執行的助理識別碼。 |
|
狀態
|
status | string |
執行的狀態,可以是佇列、in_progress、requires_action、取消、取消、失敗、已完成或已過期。 |
|
required_action
|
required_action | object |
繼續執行所需之動作的詳細資料。 如果不需要採取任何動作,則為空值。 |
|
last_error
|
last_error | object |
與此執行相關聯的最後一個錯誤。 如果沒有錯誤,則為 null。 |
|
到期時間
|
expires_at | integer |
執行到期時的 Unix 時間戳記 (以秒為單位)。 |
|
started_at
|
started_at | integer |
執行啟動時的 Unix 時間戳記 (以秒為單位)。 |
|
cancelled_at
|
cancelled_at | integer |
取消執行時的 Unix 時間戳記 (以秒為單位)。 |
|
failed_at
|
failed_at | integer |
執行失敗時的 Unix 時間戳記 (以秒為單位)。 |
|
completed_at
|
completed_at | integer |
執行完成時的 Unix 時間戳記 (以秒為單位)。 |
|
型號
|
model | string |
助理用於此執行的模型部署名稱。 |
|
instructions
|
instructions | string |
助理用於此執行的指示。 |
|
工具
|
tools | array of tools |
助理用於此執行的工具清單。 |
|
文件識別碼
|
file_ids | array of fileIds |
助理用於此執行的檔案 ID 清單。 |
|
中繼資料
|
metadata | object |
可附加至物件的索引鍵/值組 (16 個為一組)。 索引鍵長度上限為 64 個字元,值長度上限為 512 個字元。 |
|
tool_choice
|
tool_choice | object |
控制模型所呼叫的工具 (若有)。 'none' 表示模型不會呼叫任何工具,而是產生訊息。 'auto' 表示模型可以在產生訊息或呼叫工具之間進行選擇。 指定 {'type': 'file_search'} 或 {'type': 'function', 'function': {'name': 'my_function'}} 等工具會強制模型呼叫該工具。 |
|
max_prompt_tokens
|
max_prompt_tokens | number |
在執行過程中指定為已使用的提示權杖數目上限。 |
|
max_completion_tokens
|
max_completion_tokens | number |
在執行過程中指定為已使用的完成權杖數目上限。 |
|
使用方式
|
usage | object |
與執行相關的使用量統計資料。 如果執行未處於終端狀態 (例如,in_progress、排入佇列) ,則此值將為 Null。 |
|
truncation_strategy
|
truncation_strategy | object |
控制執行緒在執行之前截斷執行程的方式。 |
|
回應格式
|
response_format | string |
模型必須輸出的格式。 與 GPT-4 Turbo 和自 gpt-3.5-turbo-1106 以來的所有 GPT-3.5 Turbo 模型相容。 |
listMessage回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物件
|
object | string |
回應物件類型的詳細資料 |
|
資料
|
data | array of Data |
服務傳回的訊息清單。 |
|
first_id
|
first_id | string |
第一個 id 的詳細信息 |
|
last_id
|
last_id | string |
最後一個 id 的詳細信息 |
|
還有更多
|
has_more | boolean |
告訴是否有更多代理程式 |
資料
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
識別碼,可在 API 端點中參考。 |
|
物件
|
object | string |
物件類型,一律為小幫手。 |
|
建立於
|
created_at | integer |
助理建立時的 Unix 時間戳記 (以秒為單位)。 |
|
名稱
|
name | string |
助理的名稱。 最大長度為 256 個字元。 |
|
描述
|
description | string |
助理的描述。 長度上限為 512 個字元。 |
|
型號
|
model | string |
要使用的模型部署名稱名稱。 |
|
instructions
|
instructions | string |
助理所使用的系統指示。 長度上限為 32768 個字元。 |
|
工具
|
tools | array of tools |
在助理上啟用的工具清單。 每個助理最多可以有 128 個工具。 工具可以是code_interpreter或功能的類型。 函數描述最多可以是 1,024 個字元。 |
|
中繼資料
|
metadata | object |
可附加至物件的索引鍵/值組 (16 個為一組)。 對於以結構化格式儲存其他資訊很有用。 索引鍵長度上限為 64 個字元,值長度上限為 512 個字元。 |
|
溫度
|
temperature | number |
預設值為 1。 決定要使用的取樣溫度,介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機,而 0.2 之類的較低值會使它更集中且具決定性。 |
|
top_p
|
top_p | number |
預設值為 1。 核取樣是溫度取樣的替代方法,在此方法中,模型會考慮包含 top_p 機率質量的權杖結果。 因此,0.1 表示只考慮組成前 10% 機率質量的權杖。 |
|
回應格式
|
response_format | object |
指定模型必須輸出的格式。 將此參數設定為 { 'type': 'json_object' } 會啟用 JSON 模式,確保訊息是有效的 JSON。 |
|
tool_resources
|
tool_resources | object |
助理的工具所使用的一組資源。 工具的類型專用的資源。 例如,code_interpreter 工具需要檔案 ID 清單,而file_search工具需要向量存放區 ID 清單。 |
OpenAI.ServiceTier
指定用來處理要求的處理類型。
- 如果設定為 'auto',則會使用專案設定中設定的服務層級來處理要求。 除非另有設定,否則專案將使用「預設」。
- 如果設定為「預設」,則會使用所選型號的標準定價和效能來處理要求。
- 如果設定為 'flex' 或 'priority',則會使用對應的服務層級來處理要求。 請聯絡銷售人員 ,以進一步瞭解優先處理。
- 未設定時,預設行為為「自動」。
設定參數後 service_tier ,回應體將包含 service_tier 基於實際用於服務請求的處理模式的值。 此回應值可能與參數中設定的值不同。
指定用來處理要求的處理類型。
- 如果設定為 'auto',則會使用專案設定中設定的服務層級來處理要求。 除非另有設定,否則專案將使用「預設」。
- 如果設定為「預設」,則會使用所選型號的標準定價和效能來處理要求。
- 如果設定為 'flex' 或 'priority',則會使用對應的服務層級來處理要求。 請聯絡銷售人員 ,以進一步瞭解優先處理。
- 未設定時,預設行為為「自動」。
設定參數後 service_tier ,回應體將包含 service_tier 基於實際用於服務請求的處理模式的值。 此回應值可能與參數中設定的值不同。
OpenAI.Reasoning
僅限於 o 系列模型
推理模型的配置選項。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
投入量
|
effort | string | |
|
摘要
|
summary | string |
模型所執行推理的摘要。 這對於偵錯和瞭解模型的推理程式很有用。
|
|
generate_summary
|
generate_summary | string |
已取代: 請改用 模型所執行推理的摘要。 這對於偵錯和瞭解模型的推理程式很有用。
|
OpenAI.回應文本格式配置
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
型別
|
type | OpenAI.ResponseTextFormatConfigurationType |
物件,指定模型必須輸出的格式。
預設格式為 不建議使用 gpt-4o 和較新的模型: 設定為 |
開放人工智慧.回應文字格式配置類型
物件,指定模型必須輸出的格式。
{ "type": "json_schema" }設定會啟用結構化輸出,以確保模型符合您提供的 JSON 架構。 在結構 化輸出指南中進一步了解。
預設格式為 { "type": "text" },且沒有其他選項。
不建議使用 gpt-4o 和較新的模型:
設定為 { "type": "json_object" } 可啟用較舊的 JSON 模式,以確保模型產生的訊息為有效的 JSON。 對於支援它的模型,最好使用 。json_schema
物件,指定模型必須輸出的格式。
{ "type": "json_schema" }設定會啟用結構化輸出,以確保模型符合您提供的 JSON 架構。 在結構 化輸出指南中進一步了解。
預設格式為 { "type": "text" },且沒有其他選項。
不建議使用 gpt-4o 和較新的模型:
設定為 { "type": "json_object" } 可啟用較舊的 JSON 模式,以確保模型產生的訊息為有效的 JSON。 對於支援它的模型,最好使用 。json_schema
OpenAI.Tool
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
型別
|
type | OpenAI.ToolType |
可用來產生回應的工具。 |
OpenAI.工具類型
OpenAI.Prompt
關於提示範本及其變數的參考。 深入瞭解。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
要使用的提示範本的唯一識別碼。 |
|
版本
|
version | string |
提示範本的選用版本。 |
|
variables
|
variables | OpenAI.ResponsePromptVariables |
選用的值對應,用於替換您提示中的變數。 替代值可以是字串或其他回應輸入類型,例如影像或檔案。 |
OpenAI.Response
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
中繼資料
|
metadata | object |
可附加至物件的索引鍵/值組 (16 個為一組)。 這很適合用來以結構化格式儲存物件的其他資訊,以及透過 API 或儀錶板查詢物件。 索引鍵是長度上限為64個字元的字串。 值是長度上限為 512 個字元的字串。 |
|
溫度
|
temperature | float |
要使用的取樣溫度,介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機,而 0.2 之類的較低值會使它更集中且具決定性。
一般會建議改變這個值或 |
|
top_p
|
top_p | float |
核取樣是溫度取樣的替代方法,在此方法中,模型會考慮包含 top_p 機率質量的權杖結果。 因此,0.1 表示只考慮組成前 10% 機率質量的權杖。 一般會建議改變這個值或 |
|
使用者
|
user | string |
代表使用者的唯一標識碼,可協助 OpenAI 監視和偵測濫用行為。 深入瞭解。 |
|
服務層級
|
service_tier | OpenAI.ServiceTier |
指定用來處理要求的處理類型。
設定參數後 |
|
top_logprobs
|
top_logprobs | integer |
介於 0 到 20 之間的整數,其會指定最有可能在每個語彙基元位置傳回的語彙基元數目,每個都有相關聯的對數機率。 |
|
previous_response_id
|
previous_response_id | string |
先前回應模型的唯一識別碼。 使用這個功能來建立多輪對話。 深入瞭解 交談狀態。 |
|
型號
|
model | string |
用於生成此回應的模型部署。 |
|
reasoning
|
reasoning | OpenAI.Reasoning |
僅限於 o 系列模型 推理模型的配置選項。 |
|
背景
|
background | boolean |
是否要在背景執行模型回應。 深入瞭解。 |
|
max_output_tokens
|
max_output_tokens | integer |
可針對回應產生的記號數目上限,包括可見的輸出記號和 推理記號。 |
|
最大工具呼叫次數
|
max_tool_calls | integer |
回應中可處理的內建工具呼叫總數上限。 此最大數目適用於所有內建工具呼叫,而不是每個個別工具。 系統會忽略模型呼叫工具的任何進一步嘗試。 |
|
format
|
text.format | OpenAI.ResponseTextFormatConfiguration | |
|
工具
|
tools | array of OpenAI.Tool |
模型可能會在產生回應時呼叫的工具陣列。 您可以藉由設定 您可以提供模型的兩種工具類別如下: |
|
tool_choice
|
tool_choice |
模型應該如何選取產生回應時要使用的工具(或工具)。
|
|
|
提示
|
prompt | OpenAI.Prompt |
關於提示範本及其變數的參考。 深入瞭解。 |
|
truncation
|
truncation | string |
用於模型回應的截斷策略。
|
|
識別碼
|
id | string |
此回應的唯一標識碼。 |
|
物件
|
object | string |
此資源的物件類型 - 一律設定為 |
|
狀態
|
status | string |
回應產生的狀態。
|
|
建立於
|
created_at | unixtime |
建立此回應時的 Unix 時間戳(以秒為單位)。 |
|
錯誤
|
error | OpenAI.ResponseError |
當模型無法生成回應時,會返回一個錯誤對象。 |
|
reason
|
incomplete_details.reason | string |
回應不完整的原因。 |
|
輸出
|
output | array of OpenAI.ItemResource |
模型所產生的內容項目陣列。
|
|
instructions
|
instructions |
插入模型內容中的系統(或開發人員)訊息。 與 一起使用 |
|
|
output_text
|
output_text | string |
SDK 專屬的便利屬性,其中包含 |
|
使用方式
|
usage | OpenAI.ResponseUsage |
代表令牌使用詳細數據,包括輸入令牌、輸出令牌、輸出令牌明細,以及所使用的令牌總數。 |
|
平行工具呼叫
|
parallel_tool_calls | boolean |
是否允許模型平行執行工具呼叫。 |
|
識別碼
|
conversation.id | string | |
|
Agent
|
agent | AgentId |
OpenAI.ResponseError
當模型無法生成回應時,會返回一個錯誤對象。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字碼
|
code | OpenAI.ResponseErrorCode |
回應的錯誤碼。 |
|
訊息
|
message | string |
人類看得懂的錯誤描述。 |
OpenAI.ResponseErrorCode
OpenAI.ItemResource
用來產生回應的內容項目。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
型別
|
type | OpenAI.ItemType | |
|
識別碼
|
id | string |
OpenAI.ItemType
OpenAI.ResponseUsage
代表令牌使用詳細數據,包括輸入令牌、輸出令牌、輸出令牌明細,以及所使用的令牌總數。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
input_tokens
|
input_tokens | integer |
輸入令牌的數目。 |
|
cached_tokens
|
input_tokens_details.cached_tokens | integer |
從快取擷取的權杖數目。 更多關於提示快取的資訊。 |
|
output_tokens
|
output_tokens | integer |
輸出令牌的數目。 |
|
reasoning_tokens
|
output_tokens_details.reasoning_tokens | integer |
推理令牌的數目。 |
|
total_tokens
|
total_tokens | integer |
使用的令牌總數。 |
AgentId
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
型別
|
type | string | |
|
名稱
|
name | string |
代理程式的名稱。 |
|
版本
|
version | string |
代理程式的版本識別碼。 |
OpenAI.ResponsePromptVariables
選用的值對應,用於替換您提示中的變數。 替代值可以是字串或其他回應輸入類型,例如影像或檔案。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
object |
選用的值對應,用於替換您提示中的變數。 替代值可以是字串或其他回應輸入類型,例如影像或檔案。 |
工具
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
可在執行中使用的工具清單。 |
檔案標元
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
可在執行中使用的檔案識別碼清單。 |
物件
這是類型 'object'。