Vektorisasi API Web Kustom

Vektorizer API Web Kustom memungkinkan Anda mengonfigurasi kueri pencarian untuk memanggil titik akhir API web yang menghasilkan penyematan pada waktu kueri. Struktur payload JSON yang diperlukan untuk titik akhir dijelaskan nanti dalam artikel ini. Data Anda diproses dalam geography tempat model Anda disebarkan.

Meskipun vektorizer digunakan pada waktu kueri, Anda menentukannya dalam definisi indeks dan mereferensikannya pada bidang vektor melalui profil vektor. Untuk informasi selengkapnya, lihat Mengonfigurasi vektorizer dalam indeks pencarian.

Vektorizer API web kustom dipanggil WebApiVectorizer di REST API. Gunakan versi stabil terbaru Indexes - Create (REST API) atau paket SDK Azure yang menyediakan fitur tersebut.

Parameter vektorisasi

Parameter bersifat peka terhadap huruf besar/kecil.

Jenis kueri vektor yang didukung

API Web Kustom Vectorizer mendukung kueri vektor text, imageUrl, dan imageBinary.

Definisi sampel

"vectorizers": [
    {
        "name": "my-custom-web-api-vectorizer",
        "kind": "customWebApi",
        "customWebApiParameters": {
            "uri": "https://contoso.embeddings.com",
            "httpMethod": "POST",
            "httpHeaders": {
                "api-key": "<your-header-value>"
            },
            "timeout": "PT60S",
            "authResourceId": null,
            "authIdentity": null
        }
    }
]

Memperbarui nilai header setelah GET

Saat Anda mengambil definisi indeks, layanan mengembalikan sentinel <redacted> untuk setiap httpHeaders nilai dalam vektorizer API Web Kustom. Contohnya:

{
    "name": "my-custom-web-api-vectorizer",
    "kind": "customWebApi",
    "customWebApiParameters": {
        "uri": "https://contoso.embeddings.com",
        "httpMethod": "POST",
        "httpHeaders": {
            "api-key": "<redacted>"
        },
        "timeout": "PT60S",
        "authResourceId": null,
        "authIdentity": null
    }
}

Untuk menggunakan kembali nilai yang disimpan api-key , perbarui vektorizer yang ada yang sama dengan yang sama name dan kind, biarkan uri tidak berubah, dan kirim ulang sentinel untuk nama header yang cocok:

{
    "name": "my-custom-web-api-vectorizer",
    "kind": "customWebApi",
    "customWebApiParameters": {
        "uri": "https://contoso.embeddings.com",
        "httpMethod": "POST",
        "httpHeaders": {
            "api-key": "<redacted>"
        },
        "timeout": "PT60S",
        "authResourceId": null,
        "authIdentity": null
    }
}

Dengan yang tidak berubah uri, Anda dapat mencampur <redacted> untuk nilai header yang dipertahankan dengan nilai penggantian aktual untuk header lain yang sudah ada. Berikan nilai aktual untuk setiap header yang ditambahkan atau diganti namanya karena sentinel hanya berlaku untuk header yang ada dengan nama yang sama pada vektorizer yang sama.

Jika Anda mengubah uri, berikan nilai aktual untuk setiap httpHeaders entri dalam pembaruan yang sama. Layanan ini tidak menggunakan kembali nilai yang disimpan untuk yang berbeda uri:

{
    "name": "my-custom-web-api-vectorizer",
    "kind": "customWebApi",
    "customWebApiParameters": {
        "uri": "https://new.contoso.embeddings.com",
        "httpMethod": "POST",
        "httpHeaders": {
            "api-key": "<new-header-value>"
        },
        "timeout": "PT60S",
        "authResourceId": null,
        "authIdentity": null
    }
}

Jika kredensial tidak tersedia dan Anda harus mengubah uri, putar atau regenerasi di titik akhir eksternal. Kemudian kirim nilai baru uri dan header bersama-sama.

Nilainya <redacted> adalah sentinel layanan, bukan kredensial. Ini tidak dapat membuat vektorizer atau mengambil atau menggunakan kembali nilai header yang disimpan untuk vektorizer lain.

Struktur payload JSON

Struktur payload JSON yang diperlukan untuk endpoint yang digunakan dengan vectorizer Custom Web API sama dengan struktur yang digunakan oleh skill Custom Web API. Untuk informasi selengkapnya, lihat dokumentasi keterampilan.

Ingatlah pertimbangan berikut saat menerapkan titik akhir API web untuk vektorizer API Web Kustom:

• Vektorizer hanya mengirim satu rekaman pada satu waktu dalam values array saat membuat permintaan ke titik akhir.

• Vektorizer meneruskan data yang akan diubah menjadi vektor dalam kunci tertentu di data objek JSON dalam payload permintaan. Kunci itu adalah text, , imageUrlatau imageBinary, tergantung pada jenis kueri vektor mana yang diminta.

• Vectorizer mengharapkan embedding yang dihasilkan berada di bawah kunci vector di objek data JSON dalam payload respons.

• Pemvektor mengabaikan kesalahan atau peringatan yang dikembalikan oleh endpoint. Kesalahan dan peringatan ini tidak tersedia untuk proses debug saat kueri dijalankan.

• imageBinary Jika kueri vektor diminta, payload permintaan yang dikirim ke titik akhir adalah sebagai berikut:

  {
      "values": [
          {
              "recordId": "0",
              "data":
              {
                  "imageBinary": {
                      "data": "<base 64 encoded image binary data>"
                  }
              }
          }
      ]
  }
  

Lihat juga

• Vektorisasi terintegrasi
• Cara mengonfigurasi vektorizer dalam indeks pencarian
• Keterampilan API Web Kustom