@azure/openai-assistants package
類別
| AssistantsClient |
用戶端處理 助理 相關作業。 |
| AzureKeyCredential |
支援更新基礎金鑰值的靜態索引鍵型認證。 |
| OpenAIKeyCredential |
OpenAIKeyCredential 類別代表 OpenAI API 密鑰，並用來向 OpenAI 端點的 Assistants 用戶端進行驗證。 |
介面
| Assistant |
表示可呼叫模型並使用工具的 助理。 |
| AssistantCreationOptions |
建立新 助理 時要使用的要求詳細數據。 |
| AssistantDeletionStatus |
助理 刪除作業的狀態。 |
| AssistantFile |
附加至 助理 檔案的相關信息，如可讀取檔案的工具所使用。 |
| AssistantFileDeletionStatus |
助理 檔案刪除作業的狀態。 |
| AssistantThread |
與 助理 相關聯的單一線程相關信息。 |
| AssistantThreadCreationOptions |
用來建立新 助理 線程的詳細數據。 |
| AssistantsClientOptions |
用來建立 助理 客戶端的詳細資料 * |
| CancelRunOptions |
用來取消執行的詳細數據。 |
| CodeInterpreterImageOutput |
程式代碼解釋器工具所發出的影像輸出表示法，以回應模型的工具呼叫。 |
| CodeInterpreterImageReference |
程式代碼解釋器工具發出的影像參考，以回應模型的工具呼叫。 |
| CodeInterpreterLogOutput |
程式代碼解釋器工具發出之記錄輸出的表示法，以回應模型的工具呼叫。 |
| CodeInterpreterToolCall |
呼叫程式代碼解釋器工具的記錄，由模型在評估已定義的工具時發出，代表程式代碼解釋器所耗用和發出的輸入和輸出。 |
| CodeInterpreterToolCallDetails |
模型調用程式代碼解釋器的詳細資訊。 |
| CodeInterpreterToolDefinition |
用來設定 助理 的程式代碼解釋器工具輸入定義資訊。 |
| CreateAndRunThreadOptions |
建立並立即執行新 助理 線程時所使用的詳細數據。 |
| CreateAssistantFileOptions |
用來建立 助理 檔案的詳細數據。 |
| CreateAssistantOptions |
用來建立 助理的詳細數據。 |
| CreateMessageOptions |
用來建立訊息的詳細數據。 |
| CreateRunOptions |
建立新執行 助理 線程時所使用的詳細數據。 |
| CreateRunRequestOptions |
用來建立執行要求的詳細數據。 |
| CreateThreadAndRunOptions |
用來建立和執行線程的詳細數據。 |
| CreateThreadOptions |
用來建立線程的詳細數據。 |
| DeleteAssistantFileOptions |
用來刪除 助理 檔案的詳細數據。 |
| DeleteAssistantOptions |
用來刪除 助理的詳細數據。 |
| DeleteFileOptions |
用來刪除檔案的詳細數據。 |
| DeleteThreadOptions |
用來刪除線程的詳細數據。 |
| DeletionStatus |
OpenAI 刪除作業結果狀態的抽象表示法。 |
| FileDeletionStatus |
檔案刪除作業的狀態回應。 |
| FileListResponse |
來自檔案清單作業的回應數據。 |
| FunctionDefinition |
函式的輸入定義資訊。 |
| FunctionToolCall |
呼叫函式工具的記錄，由模型在評估已定義的工具時發出，代表所指定函式所耗用和發出的輸入和輸出。 |
| FunctionToolCallDetails |
模型所呼叫之函式的詳細資訊。 |
| FunctionToolDefinition |
用來設定 助理 之函式工具的輸入定義資訊。 |
| GetAssistantFileOptions |
用來取得 助理 檔案的詳細數據。 |
| GetAssistantOptions |
用來取得 助理的詳細數據。 |
| GetFileOptions |
用來取得檔案的詳細數據。 |
| GetMessageFileOptions |
用來取得訊息檔的詳細數據。 |
| GetMessageOptions |
用來取得訊息的詳細數據。 |
| GetRunOptions |
用來取得執行的詳細數據。 |
| GetRunStepOptions |
用來取得執行步驟的詳細數據。 |
| GetThreadOptions |
用來取得線程的詳細數據。 |
| InputFile |
表示可呼叫模型並使用工具的 助理。 |
| ListAssistantFilesOptions |
用來列出 助理 檔案的詳細數據。 |
| ListAssistantsOptions |
用來列出助理的詳細數據。 |
| ListFilesOptions |
用來列出檔案的詳細數據。 |
| ListMessageFilesOptions |
用來列出訊息檔的詳細數據。 |
| ListMessagesOptions |
用來列出訊息的詳細數據。 |
| ListResponseOf |
所要求專案的回應數據。 |
| ListRunStepsOptions |
用來列出執行步驟的詳細數據。 |
| ListRunsOptions |
用來列出執行的詳細數據。 |
| MessageFile |
附加至 助理 線程訊息的檔案相關信息。 |
| MessageImageFileContent |
線程訊息中圖像檔內容的表示法。 |
| MessageImageFileDetails |
影像參考，如線程訊息內容所示。 |
| MessageTextContent |
線程訊息內容的文字專案表示。 |
| MessageTextDetails |
助理 線程訊息內容之單一專案的文字和相關聯批注。 |
| MessageTextFileCitationAnnotation |
訊息內的引文，指向與 助理 或訊息相關聯之特定檔案的特定引號。 當 助理 使用「擷取」工具來搜尋檔案時產生。 |
| MessageTextFileCitationDetails |
檔案型文字引文的表示法，如文字線程訊息內容的檔案型註釋所使用。 |
| MessageTextFilePathAnnotation |
訊息內的引文，指向位於特定路徑的檔案。 |
| MessageTextFilePathDetails |
圖像文件識別碼的封裝，如訊息影像內容所使用。 |
| RequiredAction |
要繼續執行 助理 線程所需動作的抽象表示法。 |
| RequiredFunctionToolCall |
要求呼叫函式工具的表示法，模型需要以繼續評估執行。 |
| RetrievalToolCall |
呼叫擷取工具的記錄，該擷取工具是由模型在評估所定義工具時發出，代表已執行的擷取動作。 |
| RetrievalToolDefinition |
用來設定 助理 之擷取工具的輸入定義資訊。 |
| RunError |
助理 線程執行所遇到的錯誤詳細數據。 |
| RunStep |
助理 線程執行之單一步驟的詳細資訊。 |
| RunStepError |
與失敗的執行步驟相關聯的錯誤資訊。 |
| RunStepMessageCreationDetails |
與訊息建立執行步驟相關聯的詳細資訊。 |
| RunStepMessageCreationReference |
在執行步驟中建立之訊息的詳細數據。 |
| RunStepToolCallDetails |
與執行步驟呼叫工具相關聯的詳細資訊。 |
| SubmitToolOutputsDetails |
描述應呼叫以提交工具輸出之工具的詳細數據。 |
| SubmitToolOutputsToRunOptions |
用來將工具輸出提交至執行的詳細數據。 |
| ThreadDeletionStatus |
線程刪除作業的狀態。 |
| ThreadMessage |
助理 線程內的單一現有訊息。 |
| ThreadRun |
代表 助理 線程單一評估回合的數據。 |
| ToolOutput |
工具期間提供的數據會輸出提交，以解決擱置的工具呼叫，並允許模型繼續。 |
| UpdateAssistantOptions |
修改現有 助理 時要使用的要求詳細數據。 |
| UpdateAssistantRequestOptions |
用來更新 助理的詳細數據。 |
| UpdateMessageOptions |
用來更新訊息的詳細數據。 |
| UpdateRunOptions |
用來更新執行的詳細數據。 |
| UpdateThreadOptions |
用來更新線程的詳細數據。 |
| UploadFileOptions |
用來上傳檔案的詳細數據。 |
類型別名
| CodeInterpreterToolCallOutput |
CodeInterpreterToolCallOutput 的別名 |
| FilePurpose |
“fine-tune”、“fine-tune-results”、“assistants”、“assistants_output” |
| ListSortOrder |
“asc”、“desc” |
| MessageContent |
MessageContent 的別名 |
| MessageRole |
“user”、“助理” |
| MessageTextAnnotation |
MessageTextAnnotation 的別名 |
| RequiredToolCall |
RequiredToolCall 的別名 |
| RunStatus |
“queued”、“in_progress”、“requires_action”、“cancelling”、“cancelled”、“failed”、“completed”、“expired” |
| RunStepDetails |
RunStepDetails 的別名 |
| RunStepErrorCode |
“server_error”、“rate_limit_exceeded” |
| RunStepStatus |
“in_progress”、“cancelled”、“failed”、“completed”、“expired” |
| RunStepType |
“message_creation”、“tool_calls” |
| ToolCall |
ToolCall 的別名 |
| ToolDefinition |
輸入工具定義的抽象表示法，助理 可以使用。 |
