RunsCreateRunOptionalParams interface

Paket:
@azure/ai-agents

Parameter opsional.

Memperluas

OperationOptions,PollingOptionsParams

Properti

additionalInstructions

Instruksi tambahan untuk ditambahkan di akhir instruksi untuk eksekusi. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi tanpa menimpa instruksi lain.
additionalMessages

Menambahkan pesan tambahan ke utas sebelum membuat eksekusi.
include

Daftar bidang tambahan untuk disertakan dalam respons. Saat ini satu-satunya nilai yang didukung adalah step_details.tool_calls[*].file_search.results[*].content mengambil konten hasil pencarian file.
instructions

Instruksi sistem yang ditimpa yang harus digunakan agen untuk menjalankan utas.
maxCompletionTokens

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.
maxPromptTokens

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

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

Nama model yang ditimpa yang harus digunakan agen untuk menjalankan utas.
parallelToolCalls

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

Menentukan format yang harus dihasilkan model.
stream

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

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.
toolChoice

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

Sumber daya alat yang diaktifkan yang ditimpa yang harus digunakan agen untuk menjalankan utas.
tools

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

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.
truncationStrategy

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

Properti yang Diwariskan

abortSignal

Sinyal yang dapat digunakan untuk membatalkan permintaan.
onResponse

Fungsi yang akan dipanggil setiap kali respons diterima dari server saat melakukan operasi yang diminta. Dapat dipanggil beberapa kali.
pollingOptions

Opsi untuk mengonfigurasi perilaku polling.
requestOptions

Opsi yang digunakan saat membuat dan mengirim permintaan HTTP untuk operasi ini.
tracingOptions

Opsi yang digunakan saat pelacakan diaktifkan.

Detail Properti

additionalInstructions

Instruksi tambahan untuk ditambahkan di akhir instruksi untuk eksekusi. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi tanpa menimpa instruksi lain.

additionalInstructions?: null | string

Nilai Properti

null | string

additionalMessages

Menambahkan pesan tambahan ke utas sebelum membuat eksekusi.

additionalMessages?: null | ThreadMessageOptions[]

Nilai Properti

null | ThreadMessageOptions[]

include

Daftar bidang tambahan untuk disertakan dalam respons. Saat ini satu-satunya nilai yang didukung adalah step_details.tool_calls[*].file_search.results[*].content mengambil konten hasil pencarian file.

include?: "step_details.tool_calls[*].file_search.results[*].content"[]

Nilai Properti

"step_details.tool_calls[].file_search.results[].content"[]

instructions

Instruksi sistem yang ditimpa yang harus digunakan agen untuk menjalankan utas.

instructions?: null | string

Nilai Properti

null | string

maxCompletionTokens

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.

maxCompletionTokens?: null | number

Nilai Properti

null | number

maxPromptTokens

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.

maxPromptTokens?: null | number

Nilai Properti

null | number

metadata

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.

metadata?: null | Record<string, string>

Nilai Properti

null | Record<string, string>

model

Nama model yang ditimpa yang harus digunakan agen untuk menjalankan utas.

model?: null | string

Nilai Properti

null | string

parallelToolCalls

Jika fungsi true akan berjalan secara paralel selama penggunaan alat.

parallelToolCalls?: boolean

Nilai Properti

boolean

responseFormat

Menentukan format yang harus dihasilkan model.

responseFormat?: null | AgentsResponseFormatOption

Nilai Properti

null | AgentsResponseFormatOption

stream

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

stream?: boolean

Nilai Properti

boolean

temperature

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.

temperature?: null | number

Nilai Properti

null | number

toolChoice

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

toolChoice?: null | AgentsToolChoiceOption

Nilai Properti

null | AgentsToolChoiceOption

toolResources

Sumber daya alat yang diaktifkan yang ditimpa yang harus digunakan agen untuk menjalankan utas.

toolResources?: null | ToolResources

Nilai Properti

null | ToolResources

tools

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

tools?: null | ToolDefinitionUnion[]

Nilai Properti

null | ToolDefinitionUnion[]

topP

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.

topP?: null | number

Nilai Properti

null | number

truncationStrategy

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

truncationStrategy?: null | TruncationObject

Nilai Properti

null | TruncationObject

Detail Properti yang Diwariskan

abortSignal

Sinyal yang dapat digunakan untuk membatalkan permintaan.

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

Diwariskan Dari OperationOptions.abortSignal

onResponse

Fungsi yang akan dipanggil setiap kali respons diterima dari server saat melakukan operasi yang diminta. Dapat dipanggil beberapa kali.

onResponse?: RawResponseCallback

Nilai Properti

RawResponseCallback

Diwariskan Dari OperationOptions.onResponse

pollingOptions

Opsi untuk mengonfigurasi perilaku polling.

pollingOptions?: PollingOptions

Nilai Properti

PollingOptions

Diwariskan DariPollingOptionsParams.pollingOptions

requestOptions

Opsi yang digunakan saat membuat dan mengirim permintaan HTTP untuk operasi ini.

requestOptions?: OperationRequestOptions

Nilai Properti

OperationRequestOptions

Diwariskan Dari OperationOptions.requestOptions

tracingOptions

Opsi yang digunakan saat pelacakan diaktifkan.

tracingOptions?: OperationTracingOptions

Nilai Properti

OperationTracingOptions

Diwariskan Dari OperationOptions.tracingOptions