|
Service name |
Service ID |
Description |
QPS limit |
|
OpenSearch vector dimensionality reduction service-001 |
ops-embedding-dim-reduction-001 |
Mengurangi dimensi vektor. Anda dapat melakukan fine-tuning pada model untuk membuat layanan khusus sesuai kebutuhan bisnis Anda. Layanan ini mendukung vektor dengan dimensi hingga 4.000. |
50 Catatan
Untuk meminta batas QPS API yang lebih tinggi, kirimkan tiket ke dukungan teknis.
|
Prasyarat
-
Dapatkan kredensial otentikasi
Platform Terbuka AI Search memerlukan Kunci API untuk otentikasi. Untuk petunjuknya, lihat Dapatkan Kunci API.
-
Dapatkan titik akhir layanan
Anda dapat memanggil layanan melalui jaringan publik atau VPC. Untuk detailnya, lihat Dapatkan titik akhir layanan.
Format permintaan
Instruksi umum
-
Ukuran badan permintaan tidak boleh melebihi 8 MB.
Metode permintaan HTTP
POST
URL
{host}/v3/openapi/workspaces/{workspace_name}/embedding-tuning/{service_id}
-
host: Titik akhir layanan. Anda dapat memanggil API melalui jaringan publik atau VPC. Untuk detailnya, lihat Dapatkan titik akhir layanan. Untuk mendapatkan titik akhir tersebut, masuk ke Konsol Platform Terbuka AI Search. Di panel navigasi sebelah kiri, klik API Keys. Di bagian Access domain name, salin nama domain untuk nilai
{host}. Gunakan nama domain publik untuk akses jaringan publik dan nama domain pribadi untuk akses VPC di wilayah China (Shanghai), China (Hangzhou), China (Shenzhen), China (Beijing), China (Zhangjiakou), dan China (Qingdao). Klik Create API Key untuk membuat kunci baru. -
workspace_name: Nama ruang kerja Anda, misalnya
default.
-
service_id: ID layanan bawaan, seperti
ops-embedding-dim-reduction-001.
Parameter permintaan
Parameter Header
Otentikasi kunci API
|
Parameter |
Type |
Required |
Description |
Example |
|
Content-Type |
String |
Yes |
Format permintaan. Tetapkan nilai ini ke |
application/json |
|
Authorization |
String |
Yes |
Kunci API Anda. |
Bearer OS-d1**2a |
Parameter badan
|
Parameter |
Type |
Required |
Description |
Example |
|
input |
List<List<Float>> |
Yes |
Kumpulan vektor input. |
[0.111,0.222,0.333] |
|
parameters |
Map |
No |
Parameter permintaan yang dapat disesuaikan. Parameter yang tersedia bervariasi berdasarkan ID layanan. |
|
|
parameters.output_dimension |
Integer |
No |
Dimensi vektor output. Nilai default: 512. |
512 |
|
parameters.model_name |
String |
No |
Nama model hasil pelatihan kustom Anda. Parameter ini wajib untuk layanan kompresi vektor. |
xxxx-model |
Parameter respons
|
Parameter |
Type |
Description |
Example |
|
result.output |
List<List<Float>> |
Vektor output setelah fine-tuning. |
|
|
usage.doc_count |
Int |
Jumlah vektor dalam permintaan. |
2 |
Contoh permintaan cURL
curl --location 'http://****-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/embedding-tuning/ops-embedding-dim-reduction-001/' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"input": [
[0.111,0.222,0.333],
[0.121,0.221,0.331]
],
"parameters":{
"output_dimension": "512",
"model_name" : "xxxx"
}
}'
Contoh respons
Contoh respons sukses
{
"request_id": "450fcb80-f796-46c1-8d69-e1e86d29aa9f",
"latency": 564.903929,
"usage": {
"doc_count": 2
},
"result": {
"output":[
[0.111,0.222,0.333],
[0.121,0.221,0.331]
]
}
}
Contoh respons error
Jika permintaan gagal, respons mencakup code dan message yang menjelaskan kesalahan tersebut.
{
"request_id": "590A7EB8-AA84-****-AF31-8C35DC965972",
"latency": 0.0,
"code": "InvalidParameter",
"http_code": 400,
"message": "document.file_name required"
}
Kode status
|
HTTP status code |
Error code |
Description |
|
200 |
- |
Permintaan berhasil. |
|
404 |
BadRequest.TaskNotExist |
Tugas yang ditentukan tidak ada. |
|
400 |
InvalidParameter |
Permintaan tidak valid. |
|
500 |
InternalServerError |
Terjadi kesalahan internal server. |
Untuk daftar lengkap kode kesalahan, lihat Kode status.