Bagikan melalui

Threads - Create Thread

  • Referensi
Layanan:
AI Foundry
Versi API:
v1

Membuat utas baru. Utas berisi pesan dan dapat dijalankan oleh agen.

POST {endpoint}/threads?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 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.

Respons

Nama Jenis Deskripsi
200 OK

AgentThread

Informasi tentang utas yang baru dibuat.
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.
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.
AISearchIndexResource

Sumber daya Indeks Pencarian AI.
AzureAISearchQueryType

Jenis kueri yang tersedia untuk alat Azure AI Search.
AzureAISearchToolResource

Sekumpulan sumber daya indeks yang digunakan oleh alat azure_ai_search.
CodeInterpreterToolResource

Sekumpulan sumber daya yang digunakan oleh alat code_interpreter.
FileSearchToolResource

Sekumpulan sumber daya yang digunakan oleh alat file_search.
MessageAttachment

Ini menjelaskan alat mana file telah dilampirkan.
MessageRole

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

Satu pesan dalam utas agen, sebagaimana disediakan selama pembuatan utas tersebut untuk status awalnya.
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.
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).

AgentThread

Objek

Informasi tentang satu utas yang terkait dengan agen.

Nama Jenis Deskripsi
created_at

integer (unixtime)

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

string

Pengidentifikasi, yang dapat dirujuk di titik akhir API.
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.
object enum:

thread

Jenis objek, yang selalu 'utas'.
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.

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

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.

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.

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.

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.

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

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.

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