Vector Store Files - Create Vector Store File

Layanan:

AI Foundry

Versi API:

v1

Buat file penyimpanan vektor dengan melampirkan file ke penyimpanan vektor.

POST {endpoint}/vector_stores/{vectorStoreId}/files?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/
vectorStoreId	path	True	string	Pengidentifikasi penyimpanan vektor.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
chunking_strategy	VectorStoreChunkingStrategyRequest	Strategi pemotongan yang digunakan untuk memotong file. Jika tidak diatur, gunakan strategi otomatis.
data_source	VectorStoreDataSource	ID aset Azure.
file_id	string	Pengidentifikasi file.

Respons

Nama	Jenis	Deskripsi
200 OK	VectorStoreFile	Permintaan telah berhasil.
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.
AgentV1Error	Payload kesalahan yang dikembalikan oleh API agen.
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.
VectorStoreChunkingStrategyRequestType	Jenis strategi chunking
VectorStoreChunkingStrategyResponseType	Jenis strategi chunking
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.
VectorStoreFile	Deskripsi file yang dilampirkan ke penyimpanan vektor.
VectorStoreFileError	Detail tentang kesalahan yang mungkin terjadi saat memproses file untuk penyimpanan vektor ini
VectorStoreFileErrorCode	Varian kode kesalahan untuk pemrosesan file penyimpanan vektor
VectorStoreFileStatus	Status file penyimpanan vektor
VectorStoreStaticChunkingStrategyOptions	Opsi untuk mengonfigurasi strategi potongan statis penyimpanan vektor.
VectorStoreStaticChunkingStrategyRequest	Strategi penggugusan yang dikonfigurasi secara statis.
VectorStoreStaticChunkingStrategyResponse	Strategi penggugusan yang dikonfigurasi secara statis.

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

AgentV1Error

Objek

Payload kesalahan yang dikembalikan oleh API agen.

Nama	Jenis	Deskripsi
error	AgentErrorDetail	Mewakili kesalahan.

VectorStoreAutoChunkingStrategyRequest

Objek

Strategi default. Strategi ini saat ini menggunakan max_chunk_size_tokens 800 dan chunk_overlap_tokens 400.

Nama	Jenis	Deskripsi
type	string: auto	Jenis objek.

VectorStoreAutoChunkingStrategyResponse

Objek

Ini dikembalikan ketika strategi penggugusan tidak diketahui. Biasanya, ini karena file diindeks sebelum konsep chunking_strategy diperkenalkan di API.

Nama	Jenis	Deskripsi
type	string: other	Jenis objek.

VectorStoreChunkingStrategyRequestType

Enumeration

Jenis strategi chunking

Nilai	Deskripsi
auto
static

VectorStoreChunkingStrategyResponseType

Enumeration

Jenis strategi chunking

Nilai	Deskripsi
other
static

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

VectorStoreFile

Objek

Deskripsi file yang dilampirkan ke penyimpanan vektor.

Nama	Jenis	Deskripsi
chunking_strategy	VectorStoreChunkingStrategyResponse: VectorStoreAutoChunkingStrategyResponse VectorStoreStaticChunkingStrategyResponse	Strategi yang digunakan untuk memotong file.
created_at	integer (unixtime)	Tanda waktu Unix (dalam detik) saat file penyimpanan vektor dibuat.
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.
last_error	VectorStoreFileError	Kesalahan terakhir yang terkait dengan file penyimpanan vektor ini. Akan terjadi null jika tidak ada kesalahan.
object	enum: vector_store.file	Tipe objek, yang selalu vector_store.file.
status	VectorStoreFileStatus	Status file penyimpanan vektor, yang dapat berupa in_progress, , completedcancelled, atau failed. Status completed menunjukkan bahwa file penyimpanan vektor siap digunakan.
usage_bytes	integer (int32)	Total penggunaan penyimpanan vektor dalam byte. Perhatikan bahwa ini mungkin berbeda dari ukuran file asli.
vector_store_id	string	ID penyimpanan vektor tempat file dilampirkan.

VectorStoreFileError

Objek

Detail tentang kesalahan yang mungkin terjadi saat memproses file untuk penyimpanan vektor ini

Nama	Jenis	Deskripsi
code	VectorStoreFileErrorCode	Salah satu server_error atau rate_limit_exceeded.
message	string	Deskripsi kesalahan yang dapat dibaca manusia.

VectorStoreFileErrorCode

Enumeration

Varian kode kesalahan untuk pemrosesan file penyimpanan vektor

Nilai	Deskripsi
invalid_file	File tersebut tidak valid.
server_error	Terjadi kesalahan server.
unsupported_file	File ini adalah jenis yang tidak didukung.

VectorStoreFileStatus

Enumeration

Status file penyimpanan vektor

Nilai	Deskripsi
cancelled	File dibatalkan.
completed	File telah berhasil diproses.
failed	File gagal diproses.
in_progress	File saat ini sedang diproses.

VectorStoreStaticChunkingStrategyOptions

Objek

Opsi untuk mengonfigurasi strategi potongan statis penyimpanan vektor.

Nama	Jenis	Deskripsi
chunk_overlap_tokens	integer (int32)	Jumlah token yang tumpang tindih di antara gugus. Nilai defaultnya adalah 400. Perhatikan bahwa tumpang tindih tidak boleh melebihi setengah dari max_chunk_size_tokens.
max_chunk_size_tokens	integer (int32) minimum: 100 maximum: 4096	Jumlah maksimum token di setiap gugus. Nilai defaultnya adalah 800. Nilai minimum adalah 100 dan nilai maksimumnya adalah 4096.

VectorStoreStaticChunkingStrategyRequest

Objek

Strategi penggugusan yang dikonfigurasi secara statis.

Nama	Jenis	Deskripsi
static	VectorStoreStaticChunkingStrategyOptions	Opsi untuk strategi potongan statis.
type	string: static	Jenis objek.

VectorStoreStaticChunkingStrategyResponse

Objek

Strategi penggugusan yang dikonfigurasi secara statis.

Nama	Jenis	Deskripsi
static	VectorStoreStaticChunkingStrategyOptions	Opsi untuk strategi potongan statis.
type	string: static	Jenis objek.