Bagikan melalui

Create Thread And Run - Create Thread And Run

  • Referensi
Layanan:
AI Foundry
Versi API:
v1

Membuat utas agen baru dan segera memulai eksekusi menggunakan utas baru tersebut.

POST {endpoint}/threads/runs?api-version=v1

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
endpoint
 path True

string (uri)

Titik akhir proyek dalam bentuk: https://.services.ai.azure.com/api/projects/
api-version
 query True

string

minLength: 1

Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
assistant_id True

string

ID agen tempat utas harus dibuat.
instructions

string

Instruksi sistem yang diambil alih yang harus digunakan agen untuk menjalankan utas.
max_completion_tokens

integer (int32)

Jumlah maksimum token penyelesaian yang dapat digunakan selama eksekusi. Eksekusi akan berupaya sebaik mungkin untuk hanya menggunakan jumlah token penyelesaian yang ditentukan, di beberapa belokan eksekusi. Jika eksekusi melebihi jumlah token penyelesaian yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.
max_prompt_tokens

integer (int32)

Jumlah maksimum token prompt yang dapat digunakan selama eksekusi. Eksekusi akan berupaya sebaik mungkin untuk hanya menggunakan jumlah token prompt yang ditentukan, di beberapa belokan eksekusi. Jika eksekusi melebihi jumlah token prompt yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.
metadata

object

Satu set hingga 16 pasangan kunci/nilai yang dapat dilampirkan ke objek, digunakan untuk menyimpan informasi tambahan tentang objek tersebut dalam format terstruktur. Panjang kunci mungkin hingga 64 karakter dan panjang nilainya mungkin hingga 512 karakter.
model

string

Model yang ditimpa yang harus digunakan agen untuk menjalankan utas.
parallel_tool_calls

boolean

Jika fungsi true akan berjalan secara paralel selama penggunaan alat.
response_format

AgentsResponseFormatOption

Menentukan format yang harus dihasilkan model.
stream

boolean

Jika true, mengembalikan aliran peristiwa yang terjadi selama peristiwa Jalankan sebagai yang dikirim server, mengakhiri saat Eksekusi memasuki status terminal dengan data: [DONE] pesan.
temperature

number (float)

Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.
thread

AgentThreadCreationOptions

Detail yang digunakan untuk membuat utas baru. Jika tidak ada utas yang disediakan, utas kosong akan dibuat.
tool_choice

AgentsToolChoiceOption

Mengontrol apakah atau tidak dan alat mana yang dipanggil oleh model.
tool_resources

ToolResources

Ambil alih alat yang dapat digunakan agen untuk eksekusi ini. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi
tools ToolDefinition[]:

Daftar penggantian alat yang diaktifkan yang harus digunakan agen untuk menjalankan utas.
top_p

number (float)

Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan.

Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.
truncation_strategy

TruncationObject

Strategi yang digunakan untuk menjatuhkan pesan saat jendela konteks bergerak maju.

Respons

Nama Jenis Deskripsi
200 OK

ThreadRun

Informasi tentang thread yang baru dibuat berjalan.
Other Status Codes

AgentV1Error

Respons kesalahan tak terduga.

Keamanan

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama Deskripsi
https://ai.azure.com/.default

Definisi

Nama Deskripsi
AgentErrorDetail

Menjelaskan informasi kesalahan yang dikembalikan oleh API agen.
AgentThreadCreationOptions

Detail yang digunakan untuk membuat utas agen baru.
AgentV1Error

Payload kesalahan yang dikembalikan oleh API agen.
AISearchIndexResource

Sumber daya Indeks Pencarian AI.
AzureAISearchQueryType

Jenis kueri yang tersedia untuk alat Azure AI Search.
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.
AzureFunctionToolDefinition

Informasi definisi input untuk alat fungsi azure seperti yang digunakan untuk mengonfigurasi agen.
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.
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
CreateAndRunThreadOptions

Detail yang digunakan saat membuat dan segera menjalankan utas agen baru.
FileSearchRankingOptions

Opsi peringkat untuk 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.
FunctionDefinition

Informasi definisi input untuk fungsi.
FunctionToolDefinition

Informasi definisi input untuk alat fungsi seperti yang digunakan untuk mengonfigurasi agen.
IncompleteDetailsReason

Alasan mengapa eksekusi tidak lengkap. Ini akan menunjuk ke batas token tertentu yang tercapai selama eksekusi.
IncompleteRunDetails

Detail tentang mengapa eksekusi tidak lengkap. Akan null jika eksekusi tidak lengkap.
MessageAttachment

Ini menjelaskan alat mana file telah dilampirkan.
MessageRole

Nilai yang mungkin untuk peran yang dikaitkan dengan pesan dalam utas.
OpenApiAnonymousAuthDetails

Detail keamanan untuk autentikasi anonim OpenApi
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)
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.
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.
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.
RunStatus

Nilai yang mungkin untuk status eksekusi utas agen.
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.
ThreadMessageOptions

Satu pesan dalam utas agen, sebagaimana disediakan selama pembuatan utas tersebut untuk status awalnya.
ThreadRun

Data yang mewakili eksekusi evaluasi tunggal utas agen.
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.
TruncationStrategy

Kemungkinan strategi pemotongan untuk utas.
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.
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.

AgentErrorDetail

Objek

Menjelaskan informasi kesalahan yang dikembalikan oleh API agen.

Nama Jenis Deskripsi
code

string

Kode kesalahan yang dapat dibaca mesin.
message

string

Deskripsi kesalahan yang dapat dibaca manusia.
param

string

Nama parameter yang menyebabkan kesalahan, jika ada.
type

string

Pengidentifikasi jenis kesalahan (misalnya invalid_request_error).

AgentThreadCreationOptions

Objek

Detail yang digunakan untuk membuat utas agen baru.

Nama Jenis Deskripsi
messages

ThreadMessageOptions[]

Pesan awal yang akan dikaitkan dengan utas baru.
metadata

object

Satu set hingga 16 pasangan kunci/nilai yang dapat dilampirkan ke objek, digunakan untuk menyimpan informasi tambahan tentang objek tersebut dalam format terstruktur. Panjang kunci mungkin hingga 64 karakter dan panjang nilainya mungkin hingga 512 karakter.
tool_resources

ToolResources

Sekumpulan sumber daya yang tersedia untuk alat agen di utas ini. 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.

AgentV1Error

Objek

Payload kesalahan yang dikembalikan oleh API agen.

Nama Jenis Deskripsi
error

AgentErrorDetail

Mewakili kesalahan.

AISearchIndexResource

Objek

Sumber daya Indeks Pencarian AI.

Nama Jenis Deskripsi
filter

string

filter string untuk resource pencarian.
index_asset_id

string

Indeks id aset untuk resource pencarian.
index_connection_id

string

Id koneksi indeks dalam IndexResource yang dilampirkan ke agen ini.
index_name

string

Nama indeks dalam IndexResource yang dilampirkan ke agen ini.
query_type

AzureAISearchQueryType

Jenis kueri dalam AIIndexResource yang dilampirkan ke agen ini.
top_k

integer (int32)

Jumlah dokumen yang akan diambil dari pencarian dan presentasi ke model.

AzureAISearchQueryType

Enumeration

Jenis kueri yang tersedia untuk alat Azure AI Search.

Nilai Deskripsi
semantic

Jenis kueri semantic
simple

Jenis kueri simple
vector

Jenis kueri vector
vector_semantic_hybrid

Jenis kueri vector_semantic_hybrid
vector_simple_hybrid

Jenis kueri vector_simple_hybrid

AzureAISearchToolDefinition

Objek

Informasi definisi input untuk alat pencarian Azure AI seperti yang digunakan untuk mengonfigurasi agen.

Nama Jenis Deskripsi
type string:

azure_ai_search

Jenis objek.

AzureAISearchToolResource

Objek

Sekumpulan sumber daya indeks yang digunakan oleh alat azure_ai_search.

Nama Jenis Deskripsi
indexes

AISearchIndexResource[]

Indeks yang melekat pada agen ini. Mungkin ada maksimum 1 sumber daya indeks yang terpasang pada agen.

AzureFunctionBinding

Objek

Struktur untuk menyimpan nama antrean penyimpanan dan URI.

Nama Jenis Deskripsi
storage_queue

AzureFunctionStorageQueue

Antrean penyimpanan.
type enum:

storage_queue

Jenis pengikatan, yang selalu 'storage_queue'.

AzureFunctionDefinition

Objek

Definisi fungsi Azure.

Nama Jenis Deskripsi
function

FunctionDefinition

Definisi fungsi azure dan parameternya.
input_binding

AzureFunctionBinding

Antrean penyimpanan input. Pemicu penyimpanan antrean menjalankan fungsi saat pesan ditambahkan ke dalamnya.
output_binding

AzureFunctionBinding

Antrean penyimpanan output. Fungsi menulis output ke antrean ini ketika item input diproses.

AzureFunctionStorageQueue

Objek

Struktur untuk menyimpan nama antrean penyimpanan dan URI.

Nama Jenis Deskripsi
queue_name

string

Nama antrean penyimpanan fungsi Azure.
queue_service_endpoint

string

URI ke layanan Antrean Azure Storage memungkinkan Anda memanipulasi antrean.

AzureFunctionToolDefinition

Objek

Informasi definisi input untuk alat fungsi azure seperti yang digunakan untuk mengonfigurasi agen.

Nama Jenis Deskripsi
azure_function

AzureFunctionDefinition

Definisi fungsi konkret yang harus dipanggil alat fungsi.
type string:

azure_function

Jenis objek.

BingGroundingSearchConfiguration

Objek

Konfigurasi pencarian untuk Bing Grounding

Nama Jenis Deskripsi
connection_id

string

ID koneksi untuk pembumian dengan pencarian bing
count

integer (int64)

Jumlah hasil pencarian yang akan ditampilkan dalam respons api bing
freshness

string

Filter hasil pencarian berdasarkan rentang waktu tertentu. Nilai yang diterima: https://learn.microsoft.com/bing/search-apis/bing-web-search/reference/query-parameters
market

string

Pasar dari mana hasilnya berasal.
set_lang

string

Bahasa yang akan digunakan untuk string antarmuka pengguna saat memanggil Bing API.

BingGroundingSearchToolParameters

Objek

Parameter alat pencarian pembumian bing.

Nama Jenis Deskripsi
search_configurations

BingGroundingSearchConfiguration[]

Konfigurasi pencarian yang dilampirkan ke alat ini. Mungkin ada maksimal 1 sumber daya konfigurasi pencarian yang dilampirkan ke alat.

BingGroundingToolDefinition

Objek

Informasi definisi input untuk alat pencarian grounding bing seperti yang digunakan untuk mengonfigurasi agen.

Nama Jenis Deskripsi
bing_grounding

BingGroundingSearchToolParameters

Parameter alat pencarian pembumian bing.
type string:

bing_grounding

Jenis objek.

CodeInterpreterToolDefinition

Objek

Informasi definisi input untuk alat penerjemah kode seperti yang digunakan untuk mengonfigurasi agen.

Nama Jenis Deskripsi
type string:

code_interpreter

Jenis objek.

CodeInterpreterToolResource

Objek

Sekumpulan sumber daya yang digunakan oleh alat code_interpreter.

Nama Jenis Deskripsi
data_sources

VectorStoreDataSource[]

Sumber data yang akan digunakan. Opsi ini saling eksklusif dengan properti fileIds.
file_ids

string[]

Daftar ID file yang disediakan untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.

ConnectedAgentDetails

Objek

Informasi untuk menghubungkan satu agen ke agen lain sebagai alat

Nama Jenis Deskripsi
description

string

Deskripsi tentang apa yang dilakukan agen, digunakan oleh model untuk memilih kapan dan bagaimana memanggil agen.
id

string

Pengidentifikasi agen turunan.
name

string

Nama agen yang akan dipanggil.

ConnectedAgentToolDefinition

Objek

Informasi definisi input untuk alat agen yang terhubung yang mendefinisikan sub-agen khusus domain

Nama Jenis Deskripsi
connected_agent

ConnectedAgentDetails

Sub-agen untuk terhubung
type string:

connected_agent

Jenis objek.

CreateAndRunThreadOptions

Objek

Detail yang digunakan saat membuat dan segera menjalankan utas agen baru.

Nama Jenis Nilai default Deskripsi
assistant_id

string

ID agen tempat utas harus dibuat.
instructions

string

Instruksi sistem yang diambil alih yang harus digunakan agen untuk menjalankan utas.
max_completion_tokens

integer (int32)

Jumlah maksimum token penyelesaian yang dapat digunakan selama eksekusi. Eksekusi akan berupaya sebaik mungkin untuk hanya menggunakan jumlah token penyelesaian yang ditentukan, di beberapa belokan eksekusi. Jika eksekusi melebihi jumlah token penyelesaian yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.
max_prompt_tokens

integer (int32)

Jumlah maksimum token prompt yang dapat digunakan selama eksekusi. Eksekusi akan berupaya sebaik mungkin untuk hanya menggunakan jumlah token prompt yang ditentukan, di beberapa belokan eksekusi. Jika eksekusi melebihi jumlah token prompt yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.
metadata

object

Satu set hingga 16 pasangan kunci/nilai yang dapat dilampirkan ke objek, digunakan untuk menyimpan informasi tambahan tentang objek tersebut dalam format terstruktur. Panjang kunci mungkin hingga 64 karakter dan panjang nilainya mungkin hingga 512 karakter.
model

string

Model yang ditimpa yang harus digunakan agen untuk menjalankan utas.
parallel_tool_calls

boolean

Jika fungsi true akan berjalan secara paralel selama penggunaan alat.
response_format

AgentsResponseFormatOption

Menentukan format yang harus dihasilkan model.
stream

boolean

Jika true, mengembalikan aliran peristiwa yang terjadi selama peristiwa Jalankan sebagai yang dikirim server, mengakhiri saat Eksekusi memasuki status terminal dengan data: [DONE] pesan.
temperature

number (float)

1

Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.
thread

AgentThreadCreationOptions

Detail yang digunakan untuk membuat utas baru. Jika tidak ada utas yang disediakan, utas kosong akan dibuat.
tool_choice

AgentsToolChoiceOption

Mengontrol apakah atau tidak dan alat mana yang dipanggil oleh model.
tool_resources

ToolResources

Ambil alih alat yang dapat digunakan agen untuk eksekusi ini. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi
tools ToolDefinition[]:

Daftar penggantian alat yang diaktifkan yang harus digunakan agen untuk menjalankan utas.
top_p

number (float)

1

Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan.

Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.
truncation_strategy

TruncationObject

Strategi yang digunakan untuk menjatuhkan pesan saat jendela konteks bergerak maju.

FileSearchRankingOptions

Objek

Opsi peringkat untuk pencarian file.

Nama Jenis Deskripsi
ranker

string

Peringkat pencarian file.
score_threshold

number (float)

Ambang pencarian ranker.

FileSearchToolDefinition

Objek

Informasi definisi input untuk alat pencarian file seperti yang digunakan untuk mengonfigurasi agen.

Nama Jenis Deskripsi
file_search

FileSearchToolDefinitionDetails

Opsi mengambil alih untuk alat pencarian file.
type string:

file_search

Jenis objek.

FileSearchToolDefinitionDetails

Objek

Opsi mengambil alih untuk alat pencarian file.

Nama Jenis Deskripsi
max_num_results

integer (int32)

minimum: 1
maximum: 50

Jumlah maksimum hasil yang harus dihasilkan alat pencarian file. Defaultnya adalah 20 untuk model gpt-4* dan 5 untuk gpt-3.5-turbo. Angka ini harus antara 1 dan 50 inklusif.

Perhatikan bahwa alat pencarian file mungkin menghasilkan lebih sedikit dari max_num_results hasil. Lihat dokumentasi alat pencarian file untuk informasi selengkapnya.
ranking_options

FileSearchRankingOptions

Opsi peringkat untuk pencarian file.

FileSearchToolResource

Objek

Sekumpulan sumber daya yang digunakan oleh alat file_search.

Nama Jenis Deskripsi
vector_store_ids

string[]

ID penyimpanan vektor yang terpasang pada agen ini. Mungkin ada maksimal 1 penyimpanan vektor yang terpasang pada agen.
vector_stores

VectorStoreConfigurations[]

Daftar objek konfigurasi penyimpanan vektor dari Azure. Daftar ini terbatas pada satu elemen. Satu-satunya elemen dari daftar ini berisi daftar ID aset azure yang digunakan oleh alat pencarian.

FunctionDefinition

Objek

Informasi definisi input untuk fungsi.

Nama Jenis Deskripsi
description

string

Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.
name

string

Nama fungsi yang akan dipanggil.
parameters

Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON.

FunctionToolDefinition

Objek

Informasi definisi input untuk alat fungsi seperti yang digunakan untuk mengonfigurasi agen.

Nama Jenis Deskripsi
function

FunctionDefinition

Definisi fungsi konkret yang harus dipanggil alat fungsi.
type string:

function

Jenis objek.

IncompleteDetailsReason

Enumeration

Alasan mengapa eksekusi tidak lengkap. Ini akan menunjuk ke batas token tertentu yang tercapai selama eksekusi.

Nilai Deskripsi
max_completion_tokens

Token penyelesaian maksimum terlampaui
max_prompt_tokens

Token prompt maksimum terlampaui

IncompleteRunDetails

Objek

Detail tentang mengapa eksekusi tidak lengkap. Akan null jika eksekusi tidak lengkap.

Nama Jenis Deskripsi
reason

IncompleteDetailsReason

Alasan mengapa eksekusi tidak lengkap. Ini menunjukkan batas token tertentu mana yang tercapai selama eksekusi.

MessageAttachment

Objek

Ini menjelaskan alat mana file telah dilampirkan.

Nama Jenis Deskripsi
data_source

VectorStoreDataSource

ID aset Azure.
file_id

string

ID file yang akan dilampirkan ke pesan.
tools

MessageAttachmentToolDefinition[]

Alat yang akan ditambahkan ke file ini.

MessageRole

Enumeration

Nilai yang mungkin untuk peran yang dikaitkan dengan pesan dalam utas.

Nilai Deskripsi
assistant

Peran yang mewakili agen.
user

Peran yang mewakili pengguna akhir.

OpenApiAnonymousAuthDetails

Objek

Detail keamanan untuk autentikasi anonim OpenApi

Nama Jenis Deskripsi
type string:

anonymous

Jenis otentikasi, harus anonim/koneksi/managed_identity

OpenApiAuthType

Enumeration

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)
Nilai Deskripsi
anonymous
connection
managed_identity

OpenApiConnectionAuthDetails

Objek

Detail keamanan untuk autentikasi koneksi OpenApi

Nama Jenis Deskripsi
security_scheme

OpenApiConnectionSecurityScheme

Detail keamanan autentikasi koneksi
type string:

connection

Jenis otentikasi, harus anonim/koneksi/managed_identity

OpenApiConnectionSecurityScheme

Objek

Skema keamanan untuk autentikasi OpenApi managed_identity

Nama Jenis Deskripsi
connection_id

string

Id koneksi untuk Jenis autentikasi koneksi

OpenApiFunctionDefinition

Objek

Informasi definisi input untuk fungsi openapi.

Nama Jenis Deskripsi
auth OpenApiAuthDetails:

Buka detail autentikasi API
default_params

string[]

Daftar parameter spesifikasi OpenAPI yang akan menggunakan default yang disediakan pengguna
description

string

Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.
functions

FunctionDefinition[]

Daftar definisi fungsi yang digunakan oleh alat OpenApi
name

string

Nama fungsi yang akan dipanggil.
spec

Bentuk fungsi openapi, digambarkan sebagai objek Skema JSON.

OpenApiManagedAuthDetails

Objek

Detail keamanan untuk autentikasi OpenApi managed_identity

Nama Jenis Deskripsi
security_scheme

OpenApiManagedSecurityScheme

Detail keamanan autentikasi koneksi
type string:

managed_identity

Jenis otentikasi, harus anonim/koneksi/managed_identity

OpenApiManagedSecurityScheme

Objek

Skema keamanan untuk autentikasi OpenApi managed_identity

Nama Jenis Deskripsi
audience

string

Cakupan autentikasi untuk jenis autentikasi managed_identity

OpenApiToolDefinition

Objek

Informasi definisi input untuk alat OpenAPI seperti yang digunakan untuk mengonfigurasi agen.

Nama Jenis Deskripsi
openapi

OpenApiFunctionDefinition

Definisi fungsi openapi.
type string:

openapi

Jenis objek.

RequiredFunctionToolCall

Objek

Representasi panggilan yang diminta ke alat fungsi, yang diperlukan oleh model untuk melanjutkan evaluasi eksekusi.

Nama Jenis Deskripsi
function

RequiredFunctionToolCallDetails

Informasi terperinci tentang fungsi yang akan dijalankan oleh alat yang menyertakan nama dan argumen.
id

string

ID panggilan alat. ID ini harus dirujuk saat mengirimkan output alat.
type string:

function

Jenis objek untuk panggilan alat yang diperlukan.

RequiredFunctionToolCallDetails

Objek

Informasi terperinci untuk pemanggilan fungsi, seperti yang disediakan oleh tindakan yang diperlukan memanggil alat fungsi, yang mencakup nama dan argumen ke fungsi.

Nama Jenis Deskripsi
arguments

string

Argumen yang digunakan saat memanggil fungsi bernama, seperti yang disediakan oleh model. Argumen disajikan sebagai dokumen JSON yang harus divalidasi dan diurai untuk evaluasi.
name

string

Nama fungsi.

RunCompletionUsage

Objek

Statistik penggunaan yang terkait dengan eksekusi. Nilai ini akan null jika eksekusi tidak dalam status terminal (yaitu in_progress, queued, dll.).

Nama Jenis Deskripsi
completion_tokens

integer (int64)

Jumlah token penyelesaian yang digunakan selama eksekusi.
prompt_tokens

integer (int64)

Jumlah token prompt yang digunakan selama eksekusi.
total_tokens

integer (int64)

Jumlah total token yang digunakan (prompt + completion).

RunError

Objek

Detail kesalahan seperti yang ditemui oleh eksekusi utas agen.

Nama Jenis Deskripsi
code

string

Status untuk kesalahan.
message

string

Teks yang dapat dibaca manusia yang terkait dengan kesalahan.

RunStatus

Enumeration

Nilai yang mungkin untuk status eksekusi utas agen.

Nilai Deskripsi
cancelled

Mewakili eksekusi yang telah dibatalkan.
cancelling

Mewakili eksekusi yang sedang dalam proses pembatalan.
completed

Mewakili eksekusi yang berhasil diselesaikan.
expired

Mewakili eksekusi yang kedaluwarsa sebelum dapat selesai.
failed

Mewakili eksekusi yang gagal.
in_progress

Mewakili eksekusi yang sedang berlangsung.
queued

Mewakili eksekusi yang diantri untuk memulai.
requires_action

Mewakili eksekusi yang memerlukan operasi lain, seperti pengiriman output alat, untuk melanjutkan.

SubmitToolOutputsAction

Objek

Detail untuk panggilan alat yang diperlukan yang harus dikirimkan agar utas agen dapat dilanjutkan.

Nama Jenis Deskripsi
submit_tool_outputs

SubmitToolOutputsDetails

Detail yang menjelaskan alat yang harus dipanggil untuk mengirimkan output alat.
type string:

submit_tool_outputs

Jenis objek.

SubmitToolOutputsDetails

Objek

Detail yang menjelaskan alat yang harus dipanggil untuk mengirimkan output alat.

Nama Jenis Deskripsi
tool_calls RequiredToolCall[]:

RequiredFunctionToolCall[]

Daftar panggilan alat yang harus diselesaikan agar utas agen dapat dilanjutkan.

ThreadMessageOptions

Objek

Satu pesan dalam utas agen, sebagaimana disediakan selama pembuatan utas tersebut untuk status awalnya.

Nama Jenis Deskripsi
attachments

MessageAttachment[]

Daftar file yang dilampirkan ke pesan, dan alat yang harus ditambahkan.
content

MessageInputContent

Isi pesan awal. Ini mungkin berupa string dasar (jika Anda hanya memerlukan teks) atau array blok konten yang diketik (misalnya, teks, image_file, image_url, dan sebagainya).
metadata

object

Satu set hingga 16 pasangan kunci/nilai yang dapat dilampirkan ke objek, digunakan untuk menyimpan informasi tambahan tentang objek tersebut dalam format terstruktur. Panjang kunci mungkin hingga 64 karakter dan panjang nilainya mungkin hingga 512 karakter.
role

MessageRole

Peran entitas yang membuat pesan. Nilai yang diizinkan meliputi: user, yang menunjukkan pesan dikirim oleh pengguna aktual (dan harus digunakan dalam banyak kasus untuk mewakili pesan buatan pengguna), dan assistant, yang menunjukkan pesan dibuat oleh agen (gunakan nilai ini untuk menyisipkan pesan dari agen ke dalam percakapan).

ThreadRun

Objek

Data yang mewakili eksekusi evaluasi tunggal utas agen.

Nama Jenis Deskripsi
assistant_id

string

ID agen yang terkait dengan utas yang dijalankan ini dilakukan.
cancelled_at

integer (unixtime)

Tanda waktu Unix, dalam detik, mewakili kapan ini dibatalkan.
completed_at

integer (unixtime)

Tanda waktu Unix, dalam detik, mewakili kapan ini selesai.
created_at

integer (unixtime)

Tanda waktu Unix, dalam detik, mewakili kapan objek ini dibuat.
expires_at

integer (unixtime)

Tanda waktu Unix, dalam detik, mewakili kapan item ini kedaluwarsa.
failed_at

integer (unixtime)

Tanda waktu Unix, dalam detik, mewakili kapan ini gagal.
id

string

Pengidentifikasi, yang dapat dirujuk di titik akhir API.
incomplete_details

IncompleteRunDetails

Detail tentang mengapa eksekusi tidak lengkap. Akan null jika eksekusi tidak lengkap.
instructions

string

Instruksi sistem yang ditimpa yang digunakan untuk eksekusi utas agen ini.
last_error

RunError

Kesalahan terakhir, jika ada, yang ditemui oleh utas agen ini berjalan.
max_completion_tokens

integer (int32)

Jumlah maksimum token penyelesaian yang ditentukan telah digunakan selama eksekusi.
max_prompt_tokens

integer (int32)

Jumlah maksimum token prompt yang ditentukan telah digunakan selama eksekusi.
metadata

object

Satu set hingga 16 pasangan kunci/nilai yang dapat dilampirkan ke objek, digunakan untuk menyimpan informasi tambahan tentang objek tersebut dalam format terstruktur. Panjang kunci mungkin hingga 64 karakter dan panjang nilainya mungkin hingga 512 karakter.
model

string

ID model yang akan digunakan.
object enum:

thread.run

Jenis objek, yang selalu 'thread.run'.
parallel_tool_calls

boolean

Menentukan apakah alat dapat dijalankan secara paralel dalam eksekusi.
required_action RequiredAction:

SubmitToolOutputsAction

Detail tindakan yang diperlukan untuk menjalankan utas agen untuk melanjutkan.
response_format

AgentsResponseFormatOption

Format respons panggilan alat yang digunakan dalam eksekusi ini.
started_at

integer (unixtime)

Tanda waktu Unix, dalam detik, mewakili kapan item ini dimulai.
status

RunStatus

Status eksekusi utas agen.
temperature

number (float)

Suhu pengambilan sampel yang digunakan untuk eksekusi ini. Jika tidak diatur, default ke 1.
thread_id

string

ID utas yang terkait dengan eksekusi ini.
tool_choice

AgentsToolChoiceOption

Mengontrol apakah atau tidak dan alat mana yang dipanggil oleh model.
tool_resources

ToolResources

Ambil alih alat yang dapat digunakan agen untuk eksekusi ini. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi
tools ToolDefinition[]:

Alat yang diaktifkan ditimpa yang digunakan untuk eksekusi utas agen ini.
top_p

number (float)

Nilai pengambilan sampel nukleus yang digunakan untuk proses ini. Jika tidak diatur, default ke 1.
truncation_strategy

TruncationObject

Strategi yang digunakan untuk menjatuhkan pesan saat jendela konteks bergerak maju.
usage

RunCompletionUsage

Statistik penggunaan yang terkait dengan eksekusi. Nilai ini akan null jika eksekusi tidak dalam status terminal (yaitu in_progress, queued, dll.).

ToolResources

Objek

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.

Nama Jenis Deskripsi
azure_ai_search

AzureAISearchToolResource

Sumber daya yang akan digunakan oleh alat azure_ai_search yang terdiri dari ID indeks dan nama.
code_interpreter

CodeInterpreterToolResource

Sumber daya yang akan digunakan oleh alat code_interpreter yang terdiri dari ID file.
file_search

FileSearchToolResource

Sumber daya yang akan digunakan oleh alat file_search yang terdiri dari ID penyimpanan vektor.

TruncationObject

Objek

Kontrol tentang bagaimana utas akan dipotong sebelum eksekusi. Gunakan ini untuk mengontrol jendela konteks awal eksekusi.

Nama Jenis Nilai default Deskripsi
last_messages

integer (int32)

Jumlah pesan terbaru dari utas saat membuat konteks untuk eksekusi.
type

TruncationStrategy

auto

Strategi pemotongan yang digunakan untuk utas. Defaultnya adalah auto. Jika diatur ke last_messages, utas akan dipotong ke lastMessages menghitung pesan terbaru di utas. Ketika diatur ke auto, pesan di tengah utas akan dihilangkan agar sesuai dengan panjang konteks model, max_prompt_tokens.

TruncationStrategy

Enumeration

Kemungkinan strategi pemotongan untuk utas.

Nilai Deskripsi
auto

Nilai bawaan. Pesan di tengah utas akan dijatuhkan agar sesuai dengan panjang konteks model.
last_messages

Utas akan terpotong ke lastMessages jumlah pesan terbaru.

VectorStoreConfiguration

Objek

Konfigurasi penyimpanan vektor adalah daftar sumber data, digunakan ketika beberapa file dapat digunakan untuk pencarian file perusahaan.

Nama Jenis Deskripsi
data_sources

VectorStoreDataSource[]

Sumber data

VectorStoreConfigurations

Objek

Struktur, yang berisi daftar konfigurasi penyimpanan vektor yaitu daftar ID aset azure.

Nama Jenis Deskripsi
configuration

VectorStoreConfiguration

Konfigurasi
name

string

Nama

VectorStoreDataSource

Objek

Struktur, yang berisi jalur URI aset Azure dan jenis aset file yang digunakan sebagai sumber data untuk pencarian file perusahaan.

Nama Jenis Deskripsi
type

VectorStoreDataSourceAssetType

Jenis aset
uri

string

URI aset.

VectorStoreDataSourceAssetType

Enumeration

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.

Nilai Deskripsi
id_asset

The data ID
uri_asset

Azure URI