@azure/openai-assistants package
Kelas
| AssistantsClient |
Klien menangani operasi terkait asisten. |
| AzureKeyCredential |
Kredensial berbasis kunci statis yang mendukung pembaruan nilai kunci yang mendasar. |
| OpenAIKeyCredential |
Kelas OpenAIKeyCredential mewakili kunci API OpenAI dan digunakan untuk mengautentikasi ke klien Asisten untuk titik akhir OpenAI. |
Antarmuka
| Assistant |
Mewakili asisten yang dapat memanggil model dan menggunakan alat. |
| AssistantCreationOptions |
Detail permintaan yang akan digunakan saat membuat asisten baru. |
| AssistantDeletionStatus |
Status operasi penghapusan asisten. |
| AssistantFile |
Informasi tentang file yang dilampirkan ke asisten, seperti yang digunakan oleh alat yang dapat membaca file. |
| AssistantFileDeletionStatus |
Status operasi penghapusan file asisten. |
| AssistantThread |
Informasi tentang satu utas yang terkait dengan asisten. |
| AssistantThreadCreationOptions |
Detail yang digunakan untuk membuat utas asisten baru. |
| AssistantsClientOptions |
Detail yang digunakan untuk membuat klien asisten * |
| CancelRunOptions |
Detail yang digunakan untuk membatalkan lari. |
| CodeInterpreterImageOutput |
Representasi output gambar yang dipancarkan oleh alat penerjemah kode sebagai respons terhadap panggilan alat oleh model. |
| CodeInterpreterImageReference |
Referensi gambar yang dipancarkan oleh alat penerjemah kode sebagai respons terhadap panggilan alat oleh model. |
| CodeInterpreterLogOutput |
Representasi output log yang dipancarkan oleh alat penerjemah kode sebagai respons terhadap panggilan alat oleh model. |
| CodeInterpreterToolCall |
Catatan panggilan ke alat penerjemah kode, yang dikeluarkan oleh model dalam evaluasi alat yang ditentukan, yang mewakili input dan output yang dikonsumsi dan dipancarkan oleh penerjemah kode. |
| CodeInterpreterToolCallDetails |
Informasi terperinci tentang pemanggilan penerjemah kode oleh model. |
| CodeInterpreterToolDefinition |
Informasi definisi input untuk alat penerjemah kode seperti yang digunakan untuk mengonfigurasi asisten. |
| CreateAndRunThreadOptions |
Detail yang digunakan saat membuat dan segera menjalankan utas asisten baru. |
| CreateAssistantFileOptions |
Detail yang digunakan untuk membuat file asisten. |
| CreateAssistantOptions |
Detail yang digunakan untuk membuat asisten. |
| CreateMessageOptions |
Detail yang digunakan untuk membuat pesan. |
| CreateRunOptions |
Detail yang digunakan saat membuat eksekusi baru utas asisten. |
| CreateRunRequestOptions |
Detail yang digunakan untuk membuat permintaan eksekusi. |
| CreateThreadAndRunOptions |
Detail yang digunakan untuk membuat dan menjalankan utas. |
| CreateThreadOptions |
Detail yang digunakan untuk membuat utas. |
| DeleteAssistantFileOptions |
Detail yang digunakan untuk menghapus file asisten. |
| DeleteAssistantOptions |
Detail yang digunakan untuk menghapus asisten. |
| DeleteFileOptions |
Detail yang digunakan untuk menghapus file. |
| DeleteThreadOptions |
Detail yang digunakan untuk menghapus utas. |
| DeletionStatus |
Representasi abstrak dari status hasil operasi penghapusan OpenAI. |
| FileDeletionStatus |
Respons status dari operasi penghapusan file. |
| FileListResponse |
Data respons dari operasi daftar file. |
| FunctionDefinition |
Informasi definisi input untuk fungsi. |
| FunctionToolCall |
Catatan panggilan ke alat fungsi, yang dikeluarkan oleh model dalam evaluasi alat yang ditentukan, yang mewakili input dan output yang dikonsumsi dan dipancarkan oleh fungsi yang ditentukan. |
| FunctionToolCallDetails |
Informasi terperinci tentang fungsi yang dipanggil oleh model. |
| FunctionToolDefinition |
Informasi definisi input untuk alat fungsi seperti yang digunakan untuk mengonfigurasi asisten. |
| GetAssistantFileOptions |
Detail yang digunakan untuk mendapatkan file asisten. |
| GetAssistantOptions |
Detail yang digunakan untuk mendapatkan asisten. |
| GetFileOptions |
Detail yang digunakan untuk mendapatkan file. |
| GetMessageFileOptions |
Detail yang digunakan untuk mendapatkan file pesan. |
| GetMessageOptions |
Detail yang digunakan untuk mendapatkan pesan. |
| GetRunOptions |
Detailnya digunakan untuk berlari. |
| GetRunStepOptions |
Detail yang digunakan untuk mendapatkan langkah lari. |
| GetThreadOptions |
Detail yang digunakan untuk mendapatkan utas. |
| InputFile |
Mewakili asisten yang dapat memanggil model dan menggunakan alat. |
| ListAssistantFilesOptions |
Detail yang digunakan untuk mencantumkan file asisten. |
| ListAssistantsOptions |
Detail yang digunakan untuk mencantumkan asisten. |
| ListFilesOptions |
Detail yang digunakan untuk mencantumkan file. |
| ListMessageFilesOptions |
Detail yang digunakan untuk mencantumkan file pesan. |
| ListMessagesOptions |
Detail yang digunakan untuk mencantumkan pesan. |
| ListResponseOf |
Data respons untuk daftar item yang diminta. |
| ListRunStepsOptions |
Detail yang digunakan untuk mencantumkan langkah-langkah eksekusi. |
| ListRunsOptions |
Detail yang digunakan untuk mencantumkan eksekusi. |
| MessageFile |
Informasi tentang file yang dilampirkan ke pesan utas asisten. |
| MessageImageFileContent |
Representasi konten file gambar dalam pesan utas. |
| MessageImageFileDetails |
Referensi gambar, seperti yang diwakili dalam konten pesan utas. |
| MessageTextContent |
Representasi item tekstual konten pesan utas. |
| MessageTextDetails |
Teks dan anotasi terkait untuk satu item konten pesan utas asisten. |
| MessageTextFileCitationAnnotation |
Kutipan dalam pesan yang menunjuk ke kutipan tertentu dari File tertentu yang terkait dengan asisten atau pesan. Dihasilkan saat asisten menggunakan alat 'pengambilan' untuk mencari file. |
| MessageTextFileCitationDetails |
Representasi kutipan teks berbasis file, seperti yang digunakan dalam anotasi berbasis file konten pesan utas teks. |
| MessageTextFilePathAnnotation |
Kutipan dalam pesan yang menunjuk ke file yang terletak di jalur tertentu. |
| MessageTextFilePathDetails |
Enkapulasi ID file gambar, seperti yang digunakan oleh konten gambar pesan. |
| RequiredAction |
Representasi abstrak dari tindakan yang diperlukan agar eksekusi utas asisten dapat dilanjutkan. |
| RequiredFunctionToolCall |
Representasi panggilan yang diminta ke alat fungsi, yang diperlukan oleh model untuk melanjutkan evaluasi eksekusi. |
| RetrievalToolCall |
Rekaman panggilan ke alat pengambilan, yang dikeluarkan oleh model dalam evaluasi alat yang ditentukan, yang mewakili tindakan pengambilan yang dieksekusi. |
| RetrievalToolDefinition |
Informasi definisi input untuk alat pengambilan seperti yang digunakan untuk mengonfigurasi asisten. |
| RunError |
Detail kesalahan seperti yang ditemui oleh thread asisten berjalan. |
| RunStep |
Informasi terperinci tentang satu langkah eksekusi utas asisten. |
| RunStepError |
Informasi kesalahan yang terkait dengan langkah eksekusi yang gagal. |
| RunStepMessageCreationDetails |
Informasi terperinci yang terkait dengan langkah eksekusi pembuatan pesan. |
| RunStepMessageCreationReference |
Detail pesan yang dibuat sebagai bagian dari langkah eksekusi. |
| RunStepToolCallDetails |
Informasi terperinci yang terkait dengan alat panggilan langkah eksekusi. |
| SubmitToolOutputsDetails |
Detail yang menjelaskan alat yang harus dipanggil untuk mengirimkan output alat. |
| SubmitToolOutputsToRunOptions |
Detail yang digunakan untuk mengirimkan output alat ke eksekusi. |
| ThreadDeletionStatus |
Status operasi penghapusan utas. |
| ThreadMessage |
Satu pesan yang ada dalam utas asisten. |
| ThreadRun |
Data yang mewakili satu evaluasi eksekusi utas asisten. |
| ToolOutput |
Data yang disediakan selama pengiriman output alat untuk menyelesaikan panggilan alat yang tertunda dan memungkinkan model untuk melanjutkan. |
| UpdateAssistantOptions |
Detail permintaan yang akan digunakan saat memodifikasi asisten yang ada. |
| UpdateAssistantRequestOptions |
Detail yang digunakan untuk memperbarui asisten. |
| UpdateMessageOptions |
Detail yang digunakan untuk memperbarui pesan. |
| UpdateRunOptions |
Detail yang digunakan untuk memperbarui eksekusi. |
| UpdateThreadOptions |
Detail yang digunakan untuk memperbarui utas. |
| UploadFileOptions |
Detail yang digunakan untuk mengunggah file. |
Alias Jenis
| CodeInterpreterToolCallOutput |
Alias untuk CodeInterpreterToolCallOutput |
| FilePurpose |
"fine-tune", "fine-tune-results", "assistants", "assistants_output" |
| ListSortOrder |
"asc", "desc" |
| MessageContent |
Alias untuk MessageContent |
| MessageRole |
"pengguna", "asisten" |
| MessageTextAnnotation |
Alias untuk MessageTextAnnotation |
| RequiredToolCall |
Alias untuk RequiredToolCall |
| RunStatus |
"antrian", "in_progress", "requires_action", "membatalkan", "dibatalkan", "gagal", "selesai", "kedaluwarsa" |
| RunStepDetails |
Alias untuk RunStepDetails |
| RunStepErrorCode |
"server_error", "rate_limit_exceeded" |
| RunStepStatus |
"in_progress", "dibatalkan", "gagal", "selesai", "kedaluwarsa" |
| RunStepType |
"message_creation", "tool_calls" |
| ToolCall |
Alias untuk ToolCall |
| ToolDefinition |
Representasi abstrak dari definisi alat input yang dapat digunakan asisten. |
