@azure/ai-agents package

Kelas

AgentsClient
MCPTool	Alat yang terhubung ke server Model Context Protocol (MCP). Mendukung pengelolaan koneksi server MCP dan alat yang diizinkan secara dinamis.
OpenApiTool	Alat yang mengambil informasi menggunakan spesifikasi OpenAPI. Diinisialisasi dengan definisi API awal (nama, deskripsi, spesifikasi, autentikasi), class ini juga mendukung penambahan dan penghapusan definisi API tambahan secara dinamis.
ToolSet	Mewakili sekumpulan alat dengan definisi dan sumber dayanya.
ToolUtility	Kelas utilitas untuk membuat berbagai alat.

Antarmuka

AISearchIndexResource	Sumber daya Indeks Pencarian AI.
ActivityFunctionDefinition	Informasi definisi aktivitas untuk suatu fungsi.
ActivityFunctionParameters	Parameter yang digunakan untuk definisi fungsi aktivitas.
Agent	Mewakili agen yang dapat memanggil model dan menggunakan alat.
AgentDeletionStatus	Status operasi penghapusan agen.
AgentErrorDetail	Menjelaskan informasi kesalahan yang dikembalikan oleh API agen.
AgentEventMessage	Setiap peristiwa dalam aliran peristiwa yang dikirim server memiliki event properti dan data : Example event: thread.created data: {"id": "thread_123", "object": "thread", ...} Kami mengeluarkan peristiwa setiap kali objek baru dibuat, beralih ke status baru, atau sedang dialirkan di bagian (delta). Misalnya, kami memancarkan thread.run.created saat eksekusi baru dibuat, thread.run.completed saat eksekusi selesai, dan sebagainya. Saat Agen memilih untuk membuat pesan selama berjalan, kami memancarkan thread.message.created event, peristiwa thread.message.in_progress , banyak thread.message.delta peristiwa, dan akhirnya peristiwa thread.message.completed . Kami dapat menambahkan peristiwa tambahan dari waktu ke waktu, jadi sebaiknya tangani peristiwa yang tidak diketahui dengan baik dalam kode Anda.
AgentEventMessageStream	Mewakili aliran pesan peristiwa agen.
AgentThread	Informasi tentang satu utas yang terkait dengan agen.
AgentThreadCreationOptions	Detail yang digunakan untuk membuat utas agen baru.
AgentV1Error	Payload kesalahan yang dikembalikan oleh API agen.
AgentsClientOptionalParams	Parameter opsional untuk klien.
AgentsNamedToolChoice	Menentukan alat yang harus digunakan model. Gunakan untuk memaksa model memanggil alat tertentu.
AgentsResponseFormat	Objek yang menjelaskan output model yang diharapkan. Jika json_object hanya function jenis tools yang diizinkan untuk diteruskan ke Jalankan. Jika text model dapat mengembalikan teks atau nilai apa pun yang diperlukan.
AzureAISearchToolDefinition	Informasi definisi input untuk alat pencarian Azure AI seperti yang digunakan untuk mengonfigurasi agen.
AzureAISearchToolResource	Sekumpulan sumber daya indeks yang digunakan oleh alat azure_ai_search.
AzureFunctionBinding	Struktur untuk menyimpan nama antrean penyimpanan dan URI.
AzureFunctionDefinition	Definisi fungsi Azure.
AzureFunctionStorageQueue	Struktur untuk menyimpan nama antrean penyimpanan dan URI.
AzureFunctionToolCallDetails	Deskripsi panggilan fungsi Azure. Semua bidang hadir dalam langkah eksekusi yang telah selesai, namun hanya beberapa bidang yang ada di RunStepDeltaAzureFunctionToolCall.
AzureFunctionToolDefinition	Informasi definisi input untuk alat fungsi azure seperti yang digunakan untuk mengonfigurasi agen.
BingCustomSearchConfiguration	Konfigurasi pencarian kustom bing.
BingCustomSearchToolDefinition	Informasi definisi input untuk alat pencarian kustom Bing seperti yang digunakan untuk mengonfigurasi agen.
BingCustomSearchToolParameters	Parameter alat pencarian kustom bing.
BingGroundingSearchConfiguration	Konfigurasi pencarian untuk Bing Grounding
BingGroundingSearchToolParameters	Parameter alat pencarian pembumian bing.
BingGroundingToolDefinition	Informasi definisi input untuk alat pencarian grounding bing seperti yang digunakan untuk mengonfigurasi agen.
BrowserAutomationToolCallDetails	Detail panggilan alat Otomatisasi Browser.
BrowserAutomationToolCallStep	Menjelaskan satu langkah eksekusi alat Otomatisasi Browser.
BrowserAutomationToolConnectionParameters	Definisi parameter input untuk koneksi yang digunakan oleh Alat Otomatisasi Browser.
BrowserAutomationToolDefinition	Informasi definisi input untuk Alat Otomatisasi Browser, seperti yang digunakan untuk mengonfigurasi Agen.
BrowserAutomationToolParameters	Definisi parameter input untuk Alat Otomatisasi Browser.
CodeInterpreterToolDefinition	Informasi definisi input untuk alat penerjemah kode seperti yang digunakan untuk mengonfigurasi agen.
CodeInterpreterToolResource	Sekumpulan sumber daya yang digunakan oleh alat code_interpreter.
ConnectedAgentDetails	Informasi untuk menghubungkan satu agen ke agen lain sebagai alat
ConnectedAgentToolDefinition	Informasi definisi input untuk alat agen yang terhubung yang mendefinisikan sub-agen khusus domain
CreateAgentOptionalParams	Parameter opsional.
CreateThreadAndRunOptionalParams	Parameter opsional.
DeepResearchBingGroundingConnection	ID sumber daya koneksi untuk sumber daya pembumian Bing .
DeepResearchDetails	Detail alat Penelitian Mendalam.
DeepResearchToolDefinition	Informasi definisi input untuk alat Penelitian Mendalam seperti yang digunakan untuk mengonfigurasi agen.
DeleteAgentOptionalParams	Parameter opsional.
FabricDataAgentToolParameters	Parameter alat agen data fabric.
FileDeletionStatus	Respons status dari operasi penghapusan file.
FileInfo	Mewakili agen yang dapat memanggil model dan menggunakan alat.
FileListResponse	Data respons dari operasi daftar file.
FileSearchRankingOptions	Opsi peringkat untuk pencarian file.
FileSearchToolCallContent	Objek konten hasil pencarian file.
FileSearchToolDefinition	Informasi definisi input untuk alat pencarian file seperti yang digunakan untuk mengonfigurasi agen.
FileSearchToolDefinitionDetails	Opsi mengambil alih untuk alat pencarian file.
FileSearchToolResource	Sekumpulan sumber daya yang digunakan oleh alat file_search.
FilesDeleteFileOptionalParams	Parameter opsional.
FilesGetFileContentOptionalParams	Parameter opsional.
FilesGetFileOptionalParams	Parameter opsional.
FilesListFilesOptionalParams	Parameter opsional.
FilesOperations	Antarmuka yang mewakili operasi File.
FilesUploadFileOptionalParams	Parameter opsional.
FunctionArgument	Argumen dan deskripsi fungsi.
FunctionDefinition	Informasi definisi input untuk fungsi.
FunctionName	Nama fungsi yang akan digunakan, jika menggunakan alat function
FunctionToolDefinition	Informasi definisi input untuk alat fungsi seperti yang digunakan untuk mengonfigurasi agen.
GetAgentOptionalParams	Parameter opsional.
IncompleteRunDetails	Detail tentang mengapa eksekusi tidak lengkap. Akan null jika eksekusi tidak lengkap.
ListAgentsOptionalParams	Parameter opsional.
MCPApprovalPerTool	Objek persetujuan MCP yang disesuaikan, alat daftar yang memerlukan dan tidak memerlukan persetujuan
MCPToolDefinition	Informasi definisi input untuk alat MCP yang mendefinisikan titik akhir server MCP
MCPToolList	Objek, berisi daftar alat untuk persetujuan.
MCPToolResource	Sekumpulan sumber daya yang digunakan oleh alat mcp.
MessageAttachment	Ini menjelaskan alat mana file telah dilampirkan.
MessageContent	Representasi abstrak dari satu item konten pesan utas.
MessageDeletionStatus	Status operasi penghapusan pesan utas.
MessageDelta	Mewakili payload 'delta' yang diketik dalam gugus delta pesan streaming.
MessageDeltaChunk	Mewakili delta pesan yaitu bidang yang diubah pada pesan selama streaming.
MessageDeltaContent	Representasi dasar abstrak dari payload konten pesan yang dialirkan sebagian.
MessageDeltaImageFileContent	Mewakili bagian konten file gambar yang dialirkan dalam gugus delta pesan streaming.
MessageDeltaImageFileContentObject	Mewakili payload 'image_file' dalam konten file gambar streaming.
MessageDeltaTextAnnotation	Representasi dasar abstrak dari anotasi teks bagian konten teks yang dialirkan.
MessageDeltaTextContent	Mewakili bagian konten teks yang dialirkan dalam gugus delta pesan streaming.
MessageDeltaTextContentObject	Mewakili data bagian konten teks yang dialirkan dalam gugus delta pesan streaming.
MessageDeltaTextFileCitationAnnotation	Mewakili kutipan file yang dialirkan yang diterapkan ke bagian konten teks streaming.
MessageDeltaTextFileCitationAnnotationObject	Mewakili data kutipan file yang dialirkan seperti yang diterapkan ke bagian konten teks streaming.
MessageDeltaTextFilePathAnnotation	Mewakili anotasi jalur file yang dialirkan yang diterapkan ke bagian konten teks streaming.
MessageDeltaTextFilePathAnnotationObject	Mewakili data anotasi jalur file yang dialirkan seperti yang diterapkan ke bagian konten teks streaming.
MessageDeltaTextUrlCitationAnnotation	Kutipan dalam pesan yang mengarah ke URL tertentu yang terkait dengan pesan. Dihasilkan saat agen menggunakan alat seperti 'bing_grounding' untuk mencari di Internet.
MessageDeltaTextUrlCitationDetails	Representasi kutipan URL, seperti yang digunakan dalam konten pesan utas teks.
MessageImageFileContent	Representasi konten file gambar dalam pesan utas.
MessageImageFileDetails	Referensi gambar, seperti yang diwakili dalam konten pesan utas.
MessageImageFileParam	Menentukan bagaimana file gambar yang diunggah secara internal direferensikan saat membuat blok file gambar.
MessageImageUrlParam	Menentukan bagaimana URL gambar eksternal direferensikan saat membuat blok URL gambar.
MessageIncompleteDetails	Informasi yang memberikan detail tambahan tentang pesan yang memasukkan status tidak lengkap.
MessageInputContentBlock	Menentukan satu blok konten saat membuat pesan. Bidang 'jenis' menentukan apakah itu teks, file gambar, atau URL gambar eksternal, dll.
MessageInputImageFileBlock	Blok file gambar dalam pesan baru, mereferensikan gambar yang diunggah secara internal berdasarkan ID file.
MessageInputImageUrlBlock	Blok URL gambar dalam pesan baru, mereferensikan gambar eksternal berdasarkan URL.
MessageInputTextBlock	Blok teks dalam pesan baru, yang berisi konten teks biasa.
MessageTextAnnotation	Representasi abstrak dari anotasi untuk konten pesan utas teks.
MessageTextContent	Representasi item tekstual konten pesan utas.
MessageTextDetails	Teks dan anotasi terkait untuk satu item konten pesan utas agen.
MessageTextFileCitationAnnotation	Kutipan dalam pesan yang menunjuk ke kutipan tertentu dari File tertentu yang terkait dengan agen atau pesan. Dihasilkan ketika agen menggunakan alat 'file_search' 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.
MessageTextUrlCitationAnnotation	Kutipan dalam pesan yang mengarah ke URL tertentu yang terkait dengan pesan. Dihasilkan saat agen menggunakan alat seperti 'bing_grounding' untuk mencari di Internet.
MessageTextUrlCitationDetails	Representasi kutipan URL, seperti yang digunakan dalam konten pesan utas teks.
MessagesCreateMessageOptionalParams	Parameter opsional.
MessagesDeleteOptionalParams	Parameter opsional.
MessagesGetMessageOptionalParams	Parameter opsional.
MessagesListMessagesOptionalParams	Parameter opsional.
MessagesOperations	Antarmuka yang mewakili operasi Pesan.
MessagesUpdateMessageOptionalParams	Parameter opsional.
MicrosoftFabricToolDefinition	Informasi definisi input untuk alat Microsoft Fabric seperti yang digunakan untuk mengonfigurasi agen.
OpenApiAnonymousAuthDetails	Detail keamanan untuk autentikasi anonim OpenApi
OpenApiAuthDetails	detail autentikasi untuk OpenApiFunctionDefinition
OpenApiConnectionAuthDetails	Detail keamanan untuk autentikasi koneksi OpenApi
OpenApiConnectionSecurityScheme	Skema keamanan untuk autentikasi OpenApi managed_identity
OpenApiFunctionDefinition	Informasi definisi input untuk fungsi openapi.
OpenApiManagedAuthDetails	Detail keamanan untuk autentikasi OpenApi managed_identity
OpenApiManagedSecurityScheme	Skema keamanan untuk autentikasi OpenApi managed_identity
OpenApiToolDefinition	Informasi definisi input untuk alat OpenAPI seperti yang digunakan untuk mengonfigurasi agen.
PageSettings	Opsi untuk metode byPage
PagedAsyncIterableIterator	Antarmuka yang memungkinkan iterasi yang dapat diulang asinkron baik ke penyelesaian maupun berdasarkan halaman.
PollingOptions	Opsi untuk mengonfigurasi perilaku polling.
PollingOptionsParams	Parameter opsional yang mengonfigurasi perilaku polling.
RequiredAction	Representasi abstrak dari tindakan yang diperlukan untuk menjalankan utas agen untuk melanjutkan.
RequiredFunctionToolCall	Representasi panggilan yang diminta ke alat fungsi, yang diperlukan oleh model untuk melanjutkan evaluasi eksekusi.
RequiredFunctionToolCallDetails	Informasi terperinci untuk pemanggilan fungsi, seperti yang disediakan oleh tindakan yang diperlukan memanggil alat fungsi, yang mencakup nama dan argumen ke fungsi.
RequiredMcpToolCall	Representasi panggilan yang diminta ke alat MCP, yang diperlukan oleh model untuk melanjutkan evaluasi eksekusi.
RequiredToolCall	Representasi abstrak dari pemanggilan alat yang diperlukan oleh model untuk melanjutkan eksekusi.
ResponseFormatJsonSchema	Sebuah deskripsi tentang tujuan format respons, yang digunakan oleh model untuk menentukan cara merespons dalam format tersebut.
ResponseFormatJsonSchemaType	Jenis format respons yang ditentukan: json_schema
RunCompletionUsage	Statistik penggunaan yang terkait dengan eksekusi. Nilai ini akan null jika eksekusi tidak dalam status terminal (yaitu in_progress, queued, dll.).
RunError	Detail kesalahan seperti yang ditemui oleh eksekusi utas agen.
RunStep	Informasi terperinci tentang satu langkah eksekusi utas agen.
RunStepActivityDetails	Informasi terperinci yang terkait dengan aktivitas langkah jalankan.
RunStepAzureAISearchToolCall	Catatan panggilan ke alat Azure AI Search, yang dikeluarkan oleh model dalam evaluasi alat yang ditentukan, yang mewakili pencarian Azure AI yang dijalankan.
RunStepAzureFunctionToolCall	Rekaman panggilan ke alat Azure Function.
RunStepBingCustomSearchToolCall	Rekaman panggilan ke alat Pencarian Kustom Bing, yang dikeluarkan oleh model dalam evaluasi alat yang ditentukan, yang mewakili pencarian yang dijalankan dengan Pencarian Kustom Bing.
RunStepBingGroundingToolCall	Catatan panggilan ke alat grounding bing, yang dikeluarkan oleh model dalam evaluasi alat yang ditentukan, yang mewakili pencarian yang dijalankan dengan bing grounding.
RunStepBrowserAutomationToolCall	Catatan panggilan ke alat Otomatisasi Browser yang dikeluarkan oleh Agen.
RunStepCodeInterpreterImageOutput	Representasi output gambar yang dipancarkan oleh alat penerjemah kode sebagai respons terhadap panggilan alat oleh model.
RunStepCodeInterpreterImageReference	Referensi gambar yang dipancarkan oleh alat penerjemah kode sebagai respons terhadap panggilan alat oleh model.
RunStepCodeInterpreterLogOutput	Representasi output log yang dipancarkan oleh alat penerjemah kode sebagai respons terhadap panggilan alat oleh model.
RunStepCodeInterpreterToolCall	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.
RunStepCodeInterpreterToolCallDetails	Informasi terperinci tentang pemanggilan penerjemah kode oleh model.
RunStepCodeInterpreterToolCallOutput	Representasi abstrak dari output yang dipancarkan dari alat penerjemah kode.
RunStepCompletionUsage	Statistik penggunaan yang terkait dengan langkah eksekusi.
RunStepConnectedAgent	Informasi terperinci tentang panggilan alat agen yang terhubung.
RunStepConnectedAgentToolCall	Catatan panggilan ke agen yang terhubung.
RunStepDeepResearchToolCall	Catatan panggilan ke alat Penelitian Mendalam, yang dikeluarkan oleh model dalam evaluasi alat yang ditentukan, yang mewakili operasi penelitian mendalam yang dieksekusi.
RunStepDeepResearchToolCallDetails	Informasi terperinci tentang tugas penelitian mendalam yang dilakukan oleh model.
RunStepDelta	Mewakili payload delta dalam gugus delta langkah eksekusi streaming.
RunStepDeltaAzureAISearchToolCall	Mewakili Azure AI Search dalam langkah eksekusi streaming.
RunStepDeltaAzureFunctionToolCall	Mewakili panggilan alat Azure Function dalam langkah eksekusi streaming.
RunStepDeltaBingGroundingToolCall	Mewakili panggilan alat pembumian bing dalam langkah eksekusi streaming.
RunStepDeltaChunk	Mewakili delta langkah eksekusi yaitu bidang yang diubah pada langkah eksekusi selama streaming.
RunStepDeltaCodeInterpreterDetailItemObject	Mewakili data panggilan alat Penerjemah Kode dalam panggilan alat langkah eksekusi streaming.
RunStepDeltaCodeInterpreterImageOutput	Mewakili output gambar seperti yang dihasilkan alat penerjemah Kode dan seperti yang diwakili dalam kumpulan panggilan alat delta langkah eksekusi streaming.
RunStepDeltaCodeInterpreterImageOutputObject	Mewakili data untuk alat Penerjemah Kode langkah eksekusi streaming memanggil output gambar.
RunStepDeltaCodeInterpreterLogOutput	Mewakili output log seperti yang dihasilkan oleh alat Penerjemah Kode dan seperti yang diwakili dalam kumpulan panggilan alat delta langkah eksekusi streaming.
RunStepDeltaCodeInterpreterOutput	Representasi dasar abstrak dari alat langkah eksekusi streaming memanggil output alat Penerjemah Kode.
RunStepDeltaCodeInterpreterToolCall	Mewakili panggilan alat Penerjemah Kode dalam detail panggilan alat langkah eksekusi streaming.
RunStepDeltaConnectedAgentToolCall	Mewakili pemanggilan agen yang terhubung sebagai bagian dari langkah eksekusi streaming.
RunStepDeltaCustomBingGroundingToolCall	Mewakili panggilan alat Pencarian Kustom Bing dalam langkah eksekusi streaming.
RunStepDeltaDeepResearchToolCall	Mewakili penelitian mendalam dalam langkah eksekusi streaming.
RunStepDeltaDetail	Mewakili item detail langkah eksekusi tunggal dalam payload delta langkah eksekusi streaming.
RunStepDeltaFileSearchToolCall	Mewakili panggilan alat pencarian file dalam detail panggilan alat langkah eksekusi streaming.
RunStepDeltaFunction	Mewakili data fungsi dalam panggilan alat fungsi delta langkah eksekusi streaming.
RunStepDeltaFunctionToolCall	Mewakili panggilan alat fungsi dalam detail panggilan alat langkah eksekusi streaming.
RunStepDeltaMCPObject	Mewakili pemanggilan mcp sebagai bagian dari langkah eksekusi streaming.
RunStepDeltaMcpToolCall	Mewakili data fungsi dalam panggilan MCP langkah eksekusi streaming.
RunStepDeltaMessageCreation	Mewakili pembuatan pesan dalam delta langkah eksekusi streaming.
RunStepDeltaMessageCreationObject	Mewakili data dalam objek respons pembuatan pesan langkah eksekusi streaming.
RunStepDeltaMicrosoftFabricToolCall	Mewakili panggilan alat Microsoft Fabric dalam langkah eksekusi streaming.
RunStepDeltaOpenAPIObject	Mewakili pemanggilan openapi sebagai bagian dari langkah eksekusi streaming.
RunStepDeltaOpenAPIToolCall	Mewakili panggilan alat openapi dalam langkah eksekusi streaming.
RunStepDeltaSharepointToolCall	Mewakili panggilan alat SharePoint dalam langkah eksekusi streaming.
RunStepDeltaToolCall	Representasi dasar abstrak dari panggilan alat tunggal dalam detail panggilan alat delta langkah eksekusi streaming.
RunStepDeltaToolCallObject	Mewakili pemanggilan panggilan alat sebagai bagian dari langkah eksekusi streaming.
RunStepDetails	Representasi abstrak dari detail untuk langkah eksekusi.
RunStepDetailsActivity	Mewakili daftar aktivitas, yang terkait dengan langkah yang diberikan.
RunStepError	Informasi kesalahan yang terkait dengan langkah eksekusi yang gagal.
RunStepFileSearchToolCall	Catatan panggilan ke alat pencarian file, yang dikeluarkan oleh model dalam evaluasi alat yang ditentukan, yang mewakili pencarian file yang dijalankan.
RunStepFileSearchToolCallResult	Hasil panggilan alat pencarian file.
RunStepFileSearchToolCallResults	Hasil pencarian file.
RunStepFunctionToolCall	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.
RunStepFunctionToolCallDetails	Informasi terperinci tentang fungsi yang dipanggil oleh model.
RunStepMcpToolCall	Rekaman panggilan ke alat MCP, yang dikeluarkan oleh model dalam evaluasi alat yang ditentukan, yang mewakili tindakan MCP yang dieksekusi.
RunStepMessageCreationDetails	Informasi terperinci yang terkait dengan langkah eksekusi pembuatan pesan.
RunStepMessageCreationReference	Detail pesan yang dibuat sebagai bagian dari langkah eksekusi.
RunStepMicrosoftFabricToolCall	Catatan panggilan ke alat Microsoft Fabric, yang dikeluarkan oleh model dalam evaluasi alat yang ditentukan, yang mewakili operasi Microsoft Fabric yang dijalankan.
RunStepOpenAPIToolCall	Catatan panggilan ke alat OpenAPI, yang dikeluarkan oleh model dalam evaluasi alat yang ditentukan, yang mewakili operasi OpenAPI yang dijalankan.
RunStepSharepointToolCall	Catatan panggilan ke alat SharePoint, yang dikeluarkan oleh model dalam evaluasi alat yang ditentukan, yang mewakili tindakan SharePoint yang dijalankan.
RunStepToolCall	Representasi abstrak dari panggilan alat terperinci seperti yang direkam dalam langkah eksekusi untuk eksekusi yang ada.
RunStepToolCallDetails	Informasi terperinci yang terkait dengan alat panggilan langkah eksekusi.
RunStepsGetRunStepOptionalParams	Parameter opsional.
RunStepsListRunStepsOptionalParams	Parameter opsional.
RunStepsOperations	Antarmuka yang mewakili operasi RunSteps.
RunsCancelRunOptionalParams	Parameter opsional.
RunsCreateRunOptionalParams	Parameter opsional.
RunsGetRunOptionalParams	Parameter opsional.
RunsListRunsOptionalParams	Parameter opsional.
RunsOperations	Antarmuka yang mewakili operasi Run.
RunsSubmitToolOutputsToRunOptionalParams	Parameter opsional.
RunsUpdateRunOptionalParams	Parameter opsional.
SharepointGroundingToolParameters	Parameter alat pembumian sharepoint.
SharepointToolDefinition	Informasi definisi input untuk alat sharepoint seperti yang digunakan untuk mengonfigurasi agen.
SubmitToolApprovalAction	Detail untuk persetujuan panggilan alat yang diperlukan yang harus dikirimkan agar eksekusi utas agen dapat dilanjutkan.
SubmitToolApprovalDetails	Detail yang menjelaskan alat yang harus disetujui.
SubmitToolOutputsAction	Detail untuk panggilan alat yang diperlukan yang harus dikirimkan agar utas agen dapat dilanjutkan.
SubmitToolOutputsDetails	Detail yang menjelaskan alat yang harus dipanggil untuk mengirimkan output alat.
ThreadDeletionStatus	Status operasi penghapusan utas.
ThreadMessage	Satu pesan yang sudah ada dalam utas agen.
ThreadMessageOptions	Satu pesan dalam utas agen, sebagaimana disediakan selama pembuatan utas tersebut untuk status awalnya.
ThreadRun	Data yang mewakili eksekusi evaluasi tunggal utas agen.
ThreadsCreateThreadOptionalParams	Parameter opsional.
ThreadsDeleteThreadOptionalParams	Parameter opsional.
ThreadsGetThreadOptionalParams	Parameter opsional.
ThreadsListThreadsOptionalParams	Parameter opsional.
ThreadsOperations	Antarmuka yang mewakili operasi Threads.
ThreadsUpdateThreadOptionalParams	Parameter opsional.
ToolApproval	Data yang disediakan selama pengiriman output alat untuk menyelesaikan panggilan alat yang tertunda dan memungkinkan model untuk melanjutkan.
ToolConnection	Sumber daya koneksi.
ToolDefinition	Representasi abstrak dari definisi alat input yang dapat digunakan agen.
ToolOutput	Data yang disediakan selama pengiriman output alat untuk menyelesaikan panggilan alat yang tertunda dan memungkinkan model untuk melanjutkan.
ToolResources	Sekumpulan sumber daya yang digunakan oleh alat agen. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.
TruncationObject	Kontrol tentang bagaimana utas akan dipotong sebelum eksekusi. Gunakan ini untuk mengontrol jendela konteks awal eksekusi.
UpdateAgentOptionalParams	Parameter opsional.
VectorStore	Penyimpanan vektor adalah kumpulan file yang diproses dapat digunakan oleh alat.file_search
VectorStoreAutoChunkingStrategyRequest	Strategi default. Strategi ini saat ini menggunakan max_chunk_size_tokens 800 dan chunk_overlap_tokens 400.
VectorStoreAutoChunkingStrategyResponse	Ini dikembalikan ketika strategi penggugusan tidak diketahui. Biasanya, ini karena file diindeks sebelum konsep chunking_strategy diperkenalkan di API.
VectorStoreChunkingStrategyRequest	Representasi abstrak dari konfigurasi strategi potongan penyimpanan vektor.
VectorStoreChunkingStrategyResponse	Representasi abstrak dari konfigurasi strategi potongan penyimpanan vektor.
VectorStoreConfiguration	Konfigurasi penyimpanan vektor adalah daftar sumber data, digunakan ketika beberapa file dapat digunakan untuk pencarian file perusahaan.
VectorStoreConfigurations	Struktur, yang berisi daftar konfigurasi penyimpanan vektor yaitu daftar ID aset azure.
VectorStoreDataSource	Struktur, yang berisi jalur URI aset Azure dan jenis aset file yang digunakan sebagai sumber data untuk pencarian file perusahaan.
VectorStoreDeletionStatus	Objek respons untuk menghapus penyimpanan vektor.
VectorStoreExpirationPolicy	Kebijakan kedaluwarsa untuk penyimpanan vektor.
VectorStoreFile	Deskripsi file yang dilampirkan ke penyimpanan vektor.
VectorStoreFileBatch	Batch file yang dilampirkan ke penyimpanan vektor.
VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams	Parameter opsional.
VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams	Parameter opsional.
VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams	Parameter opsional.
VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams	Parameter opsional.
VectorStoreFileBatchesOperations	Antarmuka yang mewakili operasi VectorStoreFileBatches.
VectorStoreFileCount	Jumlah file yang diproses atau sedang diproses oleh penyimpanan vektor ini dikelompokkan menurut status.
VectorStoreFileDeletionStatus	Objek respons untuk menghapus hubungan file penyimpanan vektor.
VectorStoreFileError	Detail tentang kesalahan yang mungkin terjadi saat memproses file untuk penyimpanan vektor ini
VectorStoreFilesCreateVectorStoreFileOptionalParams	Parameter opsional.
VectorStoreFilesDeleteVectorStoreFileOptionalParams	Parameter opsional.
VectorStoreFilesGetVectorStoreFileOptionalParams	Parameter opsional.
VectorStoreFilesListVectorStoreFilesOptionalParams	Parameter opsional.
VectorStoreFilesOperations	Antarmuka yang mewakili operasi VectorStoreFiles.
VectorStoreStaticChunkingStrategyOptions	Opsi untuk mengonfigurasi strategi potongan statis penyimpanan vektor.
VectorStoreStaticChunkingStrategyRequest	Strategi penggugusan yang dikonfigurasi secara statis.
VectorStoreStaticChunkingStrategyResponse	Strategi penggugusan yang dikonfigurasi secara statis.
VectorStoresCreateVectorStoreOptionalParams	Parameter opsional.
VectorStoresDeleteVectorStoreOptionalParams	Parameter opsional.
VectorStoresGetVectorStoreOptionalParams	Parameter opsional.
VectorStoresListVectorStoresOptionalParams	Parameter opsional.
VectorStoresModifyVectorStoreOptionalParams	Parameter opsional.
VectorStoresOperations	Antarmuka yang mewakili operasi VectorStores.

Alias Jenis

AgentEventStreamData	Mewakili data peristiwa aliran di agen.
AgentRunResponse	Agen menjalankan respons dengan dukungan untuk melakukan streaming.
AgentStreamEvent	Alias untuk AgentStreamEvent
AgentsNamedToolChoiceType	Jenis alat yang tersedia untuk agen bernama alat.
AgentsResponseFormatMode	Mewakili mode di mana model akan menangani format pengembalian panggilan alat.
AgentsResponseFormatOption	Alias untuk AgentsResponseFormatOption
AgentsToolChoiceOption	Alias untuk AgentsToolChoiceOption
AgentsToolChoiceOptionMode	Menentukan bagaimana pilihan alat akan digunakan
AzureAISearchQueryType	Jenis kueri yang tersedia untuk alat Azure AI Search.
ContinuablePage	Antarmuka yang menjelaskan halaman hasil.
FileContents	Nilai yang valid untuk konten file biner.
FilePurpose	Nilai yang mungkin menunjukkan tujuan penggunaan file.
FileState	Status file.
ImageDetailLevel	Menentukan tingkat detail gambar. Bisa berupa 'otomatis', 'rendah', 'tinggi', atau nilai masa depan yang tidak diketahui.
IncompleteDetailsReason	Alasan mengapa eksekusi tidak lengkap. Ini akan menunjuk ke batas token tertentu yang tercapai selama eksekusi.
ListSortOrder	Opsi pengurutan yang tersedia saat meminta daftar objek respons.
MCPRequiredApproval	Alias untuk MCPRequiredApproval
MessageAttachmentToolDefinition	Alias untuk MessageAttachmentToolDefinition
MessageBlockType	Menentukan jenis blok konten dalam pesan. Bisa berupa teks, file gambar, URL gambar eksternal, atau jenis masa depan yang tidak diketahui.
MessageContentUnion	Alias untuk MessageContentUnion
MessageDeltaContentUnion	Alias untuk MessageDeltaContentUnion
MessageDeltaTextAnnotationUnion	Alias untuk MessageDeltaTextAnnotationUnion
MessageIncompleteDetailsReason	Serangkaian alasan yang menjelaskan mengapa pesan ditandai sebagai tidak lengkap.
MessageInputContent	Alias untuk MessageInputContent
MessageInputContentBlockUnion	Alias untuk MessageInputContentBlockUnion
MessageRole	Nilai yang mungkin untuk peran yang dikaitkan dengan pesan dalam utas.
MessageStatus	Kemungkinan nilai status eksekusi untuk pesan utas.
MessageTextAnnotationUnion	Alias untuk MessageTextAnnotationUnion
OpenApiAuthDetailsUnion	Alias untuk OpenApiAuthDetailsUnion
OpenApiAuthType	Jenis autentikasi untuk titik akhir OpenAPI. Jenis yang diizinkan adalah: Anonim (tidak perlu otentikasi) Koneksi (memerlukan connection_id ke titik akhir, seperti yang disiapkan di AI Foundry) Managed_Identity (memerlukan audiens untuk autentikasi berbasis identitas)
RequiredActionUnion	Alias untuk RequiredActionUnion
RequiredToolCallUnion	Alias untuk RequiredToolCallUnion
ResponseFormat	Kemungkinan format respons API.
RunAdditionalFieldList	Daftar bidang tambahan untuk disertakan dalam respons.
RunStatus	Nilai yang mungkin untuk status eksekusi utas agen.
RunStepCodeInterpreterToolCallOutputUnion	Alias untuk RunStepCodeInterpreterToolCallOutputUnion
RunStepDeltaCodeInterpreterOutputUnion	Alias untuk RunStepDeltaCodeInterpreterOutputUnion
RunStepDeltaDetailUnion	Alias untuk RunStepDeltaDetailUnion
RunStepDeltaToolCallUnion	Alias untuk RunStepDeltaToolCallUnion
RunStepDetailsUnion	Alias untuk RunStepDetailsUnion
RunStepErrorCode	Kemungkinan nilai kode kesalahan yang dapat dikaitkan dengan langkah eksekusi yang gagal.
RunStepStatus	Nilai yang mungkin untuk status langkah eksekusi.
RunStepToolCallUnion	Alias untuk RunStepToolCallUnion
RunStepType	Kemungkinan jenis langkah jalan.
ToolDefinitionUnion	Alias untuk ToolDefinitionUnion
TruncationStrategy	Kemungkinan strategi pemotongan untuk utas.
VectorStoreChunkingStrategyRequestType	Jenis strategi chunking
VectorStoreChunkingStrategyRequestUnion	Alias untuk VectorStoreChunkingStrategyRequestUnion
VectorStoreChunkingStrategyResponseType	Jenis strategi chunking
VectorStoreChunkingStrategyResponseUnion	Alias untuk VectorStoreChunkingStrategyResponseUnion
VectorStoreExpirationPolicyAnchor	Menjelaskan hubungan antara hari dan kedaluwarsa penyimpanan vektor ini
VectorStoreFileBatchStatus	Status batch file penyimpanan vektor.
VectorStoreFileErrorCode	Varian kode kesalahan untuk pemrosesan file penyimpanan vektor
VectorStoreFileStatus	Status file penyimpanan vektor
VectorStoreFileStatusFilter	Filter parameter kueri untuk titik akhir pengambilan file penyimpanan vektor
VectorStoreStatus	Vektor menyimpan status yang mungkin

Enum

DoneEvent	Peristiwa terminal yang menunjukkan keberhasilan akhir aliran.
ErrorEvent	Peristiwa terminal menunjukkan kesalahan sisi server saat streaming.
KnownVersions	Versi API Azure AI Agents
MessageStreamEvent	Peristiwa streaming terkait operasi pesan
RunStepStreamEvent	Jalankan operasi langkah terkait peristiwa streaming
RunStreamEvent	Jalankan peristiwa streaming terkait operasi
ThreadStreamEvent	Peristiwa streaming terkait operasi utas
VectorStoreDataSourceAssetType	Jenis aset penyimpanan vektor. Jenis aset dapat berupa uri_asset, dalam hal ini harus berisi ID URI aset, dalam kasus id_asset harus berisi ID data.
connectionToolType	Jenis alat koneksi yang digunakan untuk mengonfigurasi agen

Fungsi

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

Menentukan apakah output yang diberikan adalah dari jenis yang ditentukan.

Detail Fungsi

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

Menentukan apakah output yang diberikan adalah dari jenis yang ditentukan.

function isOutputOfType<T>(output: ToolDefinitionUnion | RequiredAction | RequiredToolCall, type: string): output

Parameter

output

ToolDefinitionUnion | RequiredAction | RequiredToolCall

Tindakan untuk memeriksa, yang dapat berjenis RequiredAction, RequiredToolCall, atau ToolDefinitionUnion.

type

string

Jenis untuk memeriksa tindakan.

Mengembalikan

output

Boolean yang menunjukkan apakah tindakan adalah jenis yang ditentukan.