Bagikan melalui

Versi REST API (Pencarian Azure AI)

  • Artikel

Artikel ini mencantumkan versi TERBARU dan sebelumnya dari Search REST API untuk Azure AI Search.

Dokumen API versi

Dokumen REST API sekarang diberi versi. Saat Anda membuka halaman referensi API, pemilih versi muncul di atas daftar isi. Pastikan referensi API berasal dari folder ReferensiData Plane.

Cuplikan layar pemilih versi.

Versi stabil

Versi API Spesifikasi Pembaruan API
2024-07-01 (Terbaru) spesifikasi Swagger Catatan rilis
2023-11-01 spesifikasi Swagger Catatan rilis
2020-06-30 spesifikasi Swagger Catatan rilis
2019-05-06 spesifikasi Swagger Menambahkan jenis kompleks.

Versi pratinjau

Versi pratinjau dirilis untuk menguji fungsionalitas baru, mengumpulkan umpan balik, dan menemukan dan memperbaiki masalah. API Pratinjau tersedia di bawah Ketentuan Penggunaan Tambahan untuk Pratinjau Microsoft Azure.

Versi API Spesifikasi Pembaruan API
2024-05-01-preview (Terbaru) spesifikasi Swagger Catatan rilis
2024-03-01-preview spesifikasi Swagger Catatan rilis
2023-10-01-preview spesifikasi Swagger Catatan rilis
2023-07-01-preview (tidak digunakan lagi) spesifikasi Swagger Catatan rilis
2021-04-30-preview spesifikasi Swagger Catatan rilis
2020-06-30-preview spesifikasi Swagger Catatan rilis
2019-05-06-preview spesifikasi Swagger Catatan rilis

Catatan rilis

2024-07-01

Versi ini menyediakan pembaruan yang tersedia secara umum untuk vektorisasi terintegrasi (keterampilan dan vektorizer), kuantisasi skalar, dan kuantisasi biner. Lihat Apa yang baru di Azure AI Search untuk detailnya.

Pemutakhiran REST API yang berlaku
Tersedia secara umum - jenis data vektor Membuat atau Memperbarui Indeks
Tersedia secara umum - properti kuantisasi vektor untuk kuantisasi skalar atau biner bawaan dalam indeks pencarian. Membuat atau Memperbarui Indeks
Tersedia secara umum - properti tersimpan pada bidang vektor yang menentukan apakah salinan tambahan bidang disimpan. Salinan tambahan adalah konten yang dapat diambil dari bidang tersebut. Jika Anda tidak menyimpannya, bidang masih digunakan dalam kueri, tetapi tidak dapat dikembalikan dalam hasil pencarian. Anda dapat mengatur properti ini untuk menghemat ruang pada layanan pencarian atau kuota vektor Anda dalam indeks pencarian. Membuat atau Memperbarui Indeks
Tersedia secara umum - parameter VectorizableTextQuery untuk penyetelan relevansi. Parameter kueri hibrid (MaxTextSizeRecall) masih dalam pratinjau. Dokumen Pencarian
Tersedia secara umum - Keterampilan AzureOpenAIEmbedding untuk mendukung lebih banyak model daripada hanya teks-penyematan-ada-002 untuk vektorisasi terintegrasi selama pengindeksan. Atur properti nama model dan dimensi untuk menargetkan model tertentu. Membuat atau Memperbarui Skillset
Tersedia secara umum - Vektorizer penyematan Azure OpenAI untuk vektorisasi terintegrasi selama kueri. Properti vektorizer mendukung lebih banyak model. Membuat atau Memperbarui Indeks
Efektif 29 Maret 2024: Respons GET tidak lagi mengembalikan string atau kunci koneksi. Lihat perubahan Melanggar untuk kode klien yang membaca informasi koneksi untuk detailnya. Semua versi

Pratinjau 05-01 2024

Pratinjau ini menambahkan dukungan untuk pengindeksan OneLake, penyetelan relevansi, dan integrasi yang lebih dalam dengan model yang lebih menyematkan selama pengindeksan dan kueri. Ini dibangun di atas 2024-03-01-preview, sehingga juga memiliki kuantisasi skalar, jenis data sempit, dan opsi penyimpanan yang diperkenalkan dalam versi tersebut.

Untuk meningkatkan dari 2024-03-01-preview atau 2023-10-01-preview, perbarui keterampilan atau vektorizer AzureOpenAIEmbedding untuk menyertakan nama dan dimensi model. Untuk meningkatkan dari 2023-07-01-preview (tidak digunakan lagi) atau untuk instruksi langkah demi langkah, lihat Meningkatkan REST API.

Berikut adalah pembaruan dalam pratinjau ini. Kami juga merekomendasikan Apa yang baru dalam Azure AI Search.

Pemutakhiran REST API yang berlaku
Sumber data pengindeks untuk file dan pintasan OneLake. Membuat atau Memperbarui Sumber Data
Collection(Edm.Byte), jenis data biner untuk menyematkan model yang mendukungnya. Definisi bidang vektor mendukung jenis data ini. Membuat atau Memperbarui Indeks
Beberapa parameter kueri vektor dan hibrid untuk penyetelan relevansi. Atur ambang batas untuk mengecualikan hasil penilaian rendah. Kueri vektor berat. Untuk kueri hibrid, atur dokumen maksimum untuk diambil di bagian teks kueri hibrid. Dokumen Pencarian
Keterampilan Azure AI Vision baru untuk vektorisasi terintegrasi multimodal selama pengindeksan. Keterampilan ini memanggil API multimodal Azure AI Vision. Membuat atau Memperbarui Skillset
Vektorizer Azure AI Vision baru untuk kueri multimodal. Vektorizer ditentukan dalam definisi indeks, tetapi digunakan selama eksekusi kueri. Membuat atau Memperbarui Indeks
Keterampilan AzureOpenAIEmbedding yang diperbarui untuk mendukung lebih banyak model daripada hanya penyematan teks-ada-002 untuk vektorisasi terintegrasi selama pengindeksan. Atur properti nama model dan dimensi untuk menargetkan model tertentu. Membuat atau Memperbarui Skillset
Vektorizer penyematan Azure OpenAI yang diperbarui untuk vektorisasi terintegrasi selama kueri. Properti vektorizer mendukung lebih banyak model. Membuat atau Memperbarui Indeks
Efektif 29 Maret 2024: Respons GET tidak lagi mengembalikan string atau kunci koneksi. Lihat perubahan Melanggar untuk kode klien yang membaca informasi koneksi untuk detailnya. Semua versi

Pratinjau 03-03-2024

Versi pratinjau ini dibangun di 2023-10-01-preview dengan menambahkan API pratinjau yang meningkatkan penyimpanan vektor. Lihat Apa yang baru di Azure AI Search untuk detailnya.

Pemutakhiran REST API yang berlaku
Baru jenis data sempit untuk bidang vektor jika Anda memiliki model penyematan yang mendukungnya atau logika kuantisasi yang menghasilkan vektor yang lebih kecil. Membuat atau Memperbarui Indeks
Properti kuantisasi vektor baru untuk pemadatan vektor bawaan dalam indeks pencarian. Membuat atau Memperbarui Indeks
Properti boolean baru disimpan pada bidang vektor yang menentukan apakah salinan tambahan bidang disimpan. Salinan tambahan adalah konten yang dapat diambil dari bidang tersebut. Jika Anda tidak menyimpannya, bidang masih digunakan dalam kueri, tetapi tidak dapat dikembalikan dalam hasil pencarian. Anda dapat mengatur properti ini untuk menghemat ruang pada layanan pencarian atau kuota vektor Anda dalam indeks pencarian. Membuat atau Memperbarui Indeks
Efektif 29 Maret 2024: Respons GET tidak lagi mengembalikan string atau kunci koneksi. Lihat perubahan Melanggar untuk kode klien yang membaca informasi koneksi untuk detailnya. Semua versi

2023-11-01

Versi ini menyediakan fitur yang tersedia secara umum. Lihat Apa yang baru di Azure AI Search untuk detailnya.

Pemutakhiran REST API yang berlaku
Peringkat semantik dalam permintaan Posting Pencarian. Dokumen Pencarian
Konfigurasi pencarian vektor untuk mengindeks bidang vektor Membuat atau Memperbarui Indeks
Kueri vektor dalam permintaan Posting Pencarian. Dokumen Pencarian
Efektif 29 Maret 2024: Respons GET tidak lagi mengembalikan string atau kunci koneksi. Lihat perubahan Melanggar untuk kode klien yang membaca informasi koneksi untuk detailnya. Semua versi

Pratinjau 10-10-2023

Versi ini mencakup semua fitur yang diperkenalkan dalam pratinjau sebelumnya, ditambah penambahan dan modifikasi pada API pencarian vektor. Pembaruan pada API pencarian vektor adalah perubahan yang melanggar dari Pratinjau 2023-07-01. Lihat Menambahkan bidang vektor dan Membuat kueri vektor untuk bantuan migrasi.

Jika Anda berencana menggunakan kemampuan prafilter baru, Anda harus menggunakan indeks yang dibuat setelah 2023-10-01.

Buat atau Perbarui Indeks:

  • vectorSearch memiliki definisi untuk algorithms, profiles, dan vectorizers:

    • algorithms terus mendukung hnsw dan sekarang juga mendukung eknn, dalam mengacu pada Hierarkis Navigable Small World (HNSW) dan tetangga terdekat (eKNN) yang lengkap. Dalam bagian algoritma, Anda dapat menentukan beberapa kombinasi parameter HNSW dan eKNN bernama. Ini menggantikan algorithmConfigurations dalam properti vectorSearch dalam Pratinjau 2023-07-01.

    • profiles adalah definisi baru yang menentukan konfigurasi algoritma. Misalnya, Anda memiliki konfigurasi algoritma bernama HNSW-1, HSNW-2, eKNN-1. Profil mungkin menentukan HNSW-1.

    • vectorizers ditentukan dalam indeks tetapi digunakan pada waktu kueri untuk menyematkan string kueri teks. Vektorizer mereferensikan model penyematan. Layanan pencarian melakukan panggilan ke model penyematan untuk mem-vektorisasi string kueri teks, lalu meneruskan hasilnya ke mesin pencari untuk kueri vektor.

  • Pada bidang vektor, vectorSearchProfile menggantikan vectorSearchConfiguration. Properti vectorSearchProfile menentukan profil pencarian vektor mana yang akan digunakan pada bidang .

  • Pada indeks yang dibuat sebelum versi API ini, setelah memanggil API Pratinjau 2023-10-01, dalam permintaan Anda, Anda harus mengubah bidang untuk menentukan vectorSearchProfile selama profil menentukan algoritma yang sama persis yang sebelumnya ditentukan dalam vectorSearchConfiguration. Misalnya, jika definisi bidang yang ada menentukan "vectorSearchConfiguration": "myHnsw", Anda harus menggantinya dengan "vectorSearchProfile": "your profile name", dan profil harus didefinisikan untuk mereferensikan "algorithm": "myHnsw"yang sama.

Dokumen Pencarian :

  • vectorQueries menggantikan vectors dalam Pratinjau 2023-07-01
  • vectorQueries.vectors menggantikan vectors.values di Pratinjau 2023-07-01.
  • Kueri vektor sekarang menjadi struktur polimorfik. kind harus ditentukan untuk menunjukkan jenis kueri vektor yang diminta. "kind": "vector" berarti kueri adalah vektor, sehingga pemanggil seharusnya sudah mem-vektor string kueri pencarian ke dalam penyematan vektor.
  • "exhaustive": "true" adalah properti baru menentukan apakah akan melakukan pencarian tetangga terdekat k lengkap (brute-force) di semua vektor dalam indeks vektor.
  • vectorFilterMode adalah parameter baru untuk menentukan prafilter (default untuk indeks yang dibuat setelah 2023-10-01) atau postfiltering (default pada indeks sebelumnya) dalam kueri.

Efektif 29 Maret 2024: Respons GET tidak lagi mengembalikan string atau kunci koneksi. Lihat perubahan Melanggar untuk kode klien yang membaca informasi koneksi untuk detailnya.

Pratinjau 07-01 2023

Penting

Jangan gunakan versi API ini. Penghentian versi pratinjau ini diumumkan pada 15 April 2024 dan tidak lagi didukung setelah 8 Juli 2024. Untuk bantuan terkait migrasi, lihat Meningkatkan REST API di Azure AI Search.

Versi ini memperkenalkan dukungan vektor dan menggunakan konfigurasi vektor yang tidak kompatibel dengan versi API yang lebih baru.

  • Menambahkan jenis data Collection(Edm.Single) pada bidang yang berisi array angka titik mengambang presisi tunggal. Ini adalah jenis data untuk vektor, digunakan untuk menyimpan satu penyematan yang dihasilkan per bidang dokumen. Indeks pencarian juga menentukan properti konfigurasi vektor. Lihat Membuat atau Memperbarui Indeks untuk API ini.
  • Beban kerja pengindeksan yang diperbarui untuk menerima data vektor. Lihat Menambahkan, Memperbarui, atau Menghapus Dokumen.
  • Menambahkan parameter kueri untuk pencarian vektor. Lihat Dokumen Pencarian untuk parameter ini.
  • Dapatkan Statistik Layanan: mengembalikan kuota dan penggunaan indeks vektor untuk layanan.
  • Dapatkan Statistik Indeks: mengembalikan kuota dan penggunaan indeks vektor untuk indeks pencarian.
  • Efektif 29 Maret 2024: Respons GET tidak lagi mengembalikan string atau kunci koneksi. Lihat perubahan Melanggar untuk kode klien yang membaca informasi koneksi untuk detailnya.

Pratinjau 04-30 2021

Versi pratinjau ini mencakup semua fitur yang diperkenalkan dalam Pratinjau 2020-06-30, ditambah penambahan ke API berikut:

  • Indeks alias menambahkan nama sekunder yang digunakan untuk mereferensikan indeks dalam permintaan kueri dan pengindeksan. Operasi alias meliputi membuat, memperbarui, menghapus, mendapatkan, dan mencantumkan.
  • Identitas terkelola untuk koneksi keluar. Nilai baru untuk string koneksi di Membuat atau Memperbarui Sumber Data mendukung koneksi menggunakan autentikasi dan peran ID Microsoft Entra alih-alih kredensial atau kunci database yang dikodekan secara permanen.
  • Dukungan identitas terkelola juga didukung untuk koneksi brankas kunci, untuk solusi pencarian yang melengkapi enkripsi default dengan enkripsi yang dikelola pelanggan .
  • Lebih banyak bahasa untuk keterampilan kognitif Terjemahan Teks.
  • Lebih banyak queryLanguages untuk pencarian semantik dan ejaan di Cari Dokumen (pratinjau).
  • Parameter keterangan untuk meminta keterangan secara opsional dari pencarian semantik di Cari Dokumen (pratinjau).
  • konfigurasi Semantik ditentukan dalam Buat atau Perbarui Indeks. Konfigurasi semantik menentukan bidang mana yang harus digunakan untuk peringkat semantik, keterangan, sorotan, dan jawaban.
  • Parameter semanticConfiguration yang diperlukan untuk kueri semantik di Cari Dokumen (pratinjau).
  • Efektif 29 Maret 2024: Respons GET tidak lagi mengembalikan string atau kunci koneksi. Lihat perubahan Melanggar untuk kode klien yang membaca informasi koneksi untuk detailnya.

2020-06-30

Versi ini menyediakan fitur yang tersedia secara umum, termasuk:

  • Kontrol akses berbasis peran Azure untuk operasi sarana data
  • Penilaian relevansi (BM25)
  • Penyimpanan pengetahuan
  • Sumber data pengindeks untuk Azure Data Lake Storage (ADLS) Gen2
  • Keterampilan Pencarian Entitas Kustom
  • Pengindeks yang berjalan di bawah sistem atau identitas yang dikelola pengguna melalui ID Microsoft Entra
  • Efektif 29 Maret 2024: Respons GET tidak lagi mengembalikan string atau kunci koneksi. Lihat perubahan Melanggar untuk kode klien yang membaca informasi koneksi untuk detailnya.

Pratinjau 06-30 2020

Versi pratinjau ini mencakup semua fitur yang diperkenalkan dalam Pratinjau 2019-05-06, ditambah penambahan berikut:

  • Pencarian semantik, fitur premium yang berjalan pada layanan tingkat Standar dan yang memanggil peringkat semantik.
  • Sumber data pengindeks untuk Konektor Power Query
  • Sumber data pengindeks untuk MySQL
  • Sumber data pengindeks untuk Cosmos DB Gremlin API
  • Sumber data pengindeks untuk SharePoint Online
  • Properti normalizer untuk normalisasi teks, untuk pemfilteran, faset, dan pengurutan yang tidak peka huruf besar/kecil
  • Reset Dokumen untuk pengindeksan berbasis pengindeks untuk secara khusus me-refresh dokumen tertentu berdasarkan ID
  • Keterampilan kognitif Penautan Entitas (v3)
  • Keterampilan kognitif Pengenalan Entitas (v3)
  • Keterampilan kognitif Analisis Sentimen (v3)
  • Efektif 29 Maret 2024: Respons GET tidak lagi mengembalikan string atau kunci koneksi. Lihat perubahan Melanggar untuk kode klien yang membaca informasi koneksi untuk detailnya.

Pratinjau 06-05-2019

  • Dukungan sumber data pengindeks untuk Cosmos DB MongoDB API
  • Sumber data pengindeks untuk penghapusan sementara di Blob Storage
  • parameter featuresMode yang mengembalikan informasi terperinci tentang skor relevansi
  • Keterampilan kognitif Azure Machine Learning (AML)
  • Keterampilan kognitif deteksi identifikasi pribadi
  • Cache dokumen yang diperkaya untuk mempertahankan dan menggunakan kembali pemrosesan gambar (dan pengayaan AI lainnya)
  • Efektif 29 Maret 2024: Respons GET tidak lagi mengembalikan string atau kunci koneksi. Lihat perubahan Melanggar untuk kode klien yang membaca informasi koneksi untuk detailnya.

Lihat juga