Documents - Search Post

Service:

Search Service

API Version:

2023-10-01-Preview

Mencari dokumen dalam indeks.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2023-10-01-Preview

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	URL titik akhir layanan pencarian.
indexName	path	True	string	Nama indeks.
api-version	query	True	string	Versi Api Klien.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-request-id		string uuid	ID pelacakan yang dikirim dengan permintaan untuk membantu penelusuran kesalahan.

Isi Permintaan

Nama	Jenis	Deskripsi
answers	QueryAnswerType	Nilai yang menentukan apakah jawaban harus dikembalikan sebagai bagian dari respons pencarian.
captions	QueryCaptionType	Nilai yang menentukan apakah keterangan harus dikembalikan sebagai bagian dari respons pencarian.
count	boolean	Nilai yang menentukan apakah akan mengambil jumlah total hasil. Defaultnya adalah false. Mengatur nilai ini ke true mungkin memiliki dampak performa. Perhatikan bahwa jumlah yang dikembalikan adalah perkiraan.
debug	QueryDebugMode	Memungkinkan alat penelusuran kesalahan yang dapat digunakan untuk menjelajahi lebih lanjut hasil yang direrank.
facets	string[]	Daftar ekspresi faset yang akan diterapkan ke kueri pencarian. Setiap ekspresi faset berisi nama bidang, secara opsional diikuti dengan daftar pasangan nama:nilai yang dipisahkan koma.
filter	string	Ekspresi $filter OData untuk diterapkan ke kueri pencarian.
highlight	string	Daftar nama bidang yang dipisahkan koma yang akan digunakan untuk sorotan temuan. Hanya bidang yang dapat dicari yang dapat digunakan untuk penyorotan hit.
highlightPostTag	string	Tag string yang ditambahkan untuk menekan sorotan. Harus diatur dengan highlightPreTag. Defaultnya adalah </em>.
highlightPreTag	string	Tag string yang telah ditambahkan sebelumnya untuk menekan sorotan. Harus diatur dengan highlightPostTag. Defaultnya adalah <em>.
minimumCoverage	number	Angka antara 0 dan 100 yang menunjukkan persentase indeks yang harus dicakup oleh kueri pencarian agar kueri dilaporkan sebagai keberhasilan. Parameter ini dapat berguna untuk memastikan ketersediaan pencarian bahkan untuk layanan hanya dengan satu replika. Nilai defaultnya adalah 100.
orderby	string	Daftar ekspresi $orderby OData yang dipisahkan koma untuk mengurutkan hasilnya. Setiap ekspresi dapat berupa nama bidang atau panggilan ke fungsi geo.distance() atau search.score(). Setiap ekspresi dapat diikuti oleh asc untuk menunjukkan naik, atau turun untuk menunjukkan menurun. Defaultnya adalah urutan naik. Ikatan akan dipecah oleh skor kecocokan dokumen. Jika tidak ada $orderby yang ditentukan, urutan pengurutan default turun menurut skor kecocokan dokumen. Paling banyak ada 32 klausa $orderby.
queryLanguage	QueryLanguage	Nilai yang menentukan bahasa kueri pencarian.
queryType	QueryType	Nilai yang menentukan sintaks kueri pencarian. Defaultnya adalah 'sederhana'. Gunakan 'penuh' jika kueri Anda menggunakan sintaks kueri Lucene.
scoringParameters	string[]	Daftar nilai parameter yang akan digunakan dalam fungsi penilaian (misalnya, referencePointParameter) menggunakan format nama-nilai. Misalnya, jika profil penilaian mendefinisikan fungsi dengan parameter yang disebut 'mylocation' string parameter adalah "mylocation--122.2,44.8" (tanpa tanda kutip).
scoringProfile	string	Nama profil penilaian untuk mengevaluasi skor kecocokan untuk dokumen yang cocok untuk mengurutkan hasilnya.
scoringStatistics	ScoringStatistics	Nilai yang menentukan apakah kita ingin menghitung statistik penilaian (seperti frekuensi dokumen) secara global untuk penilaian yang lebih konsisten, atau secara lokal, untuk latensi yang lebih rendah. Defaultnya adalah 'lokal'. Gunakan 'global' untuk mengagregasi statistik penilaian secara global sebelum mencetak skor. Menggunakan statistik penilaian global dapat meningkatkan latensi kueri pencarian.
search	string	Ekspresi kueri pencarian teks lengkap; Gunakan "*" atau hilangkan parameter ini agar sesuai dengan semua dokumen.
searchFields	string	Daftar nama bidang yang dipisahkan koma untuk mencakup pencarian teks lengkap. Saat menggunakan pencarian bidang (fieldName:searchExpression) dalam kueri Lucene lengkap, nama bidang dari setiap ekspresi pencarian bidang lebih diutamakan daripada nama bidang apa pun yang tercantum dalam parameter ini.
searchMode	SearchMode	Nilai yang menentukan apakah salah satu atau semua istilah pencarian harus dicocokkan untuk menghitung dokumen sebagai kecocokan.
select	string	Daftar bidang yang dipisahkan koma untuk diambil. Jika tidak ditentukan, semua bidang yang ditandai sebagai dapat diambil dalam skema disertakan.
semanticConfiguration	string	Nama konfigurasi semantik yang akan digunakan saat memproses dokumen untuk kueri semantik jenis.
semanticErrorHandling	SemanticErrorMode	Memungkinkan pengguna untuk memilih apakah panggilan semantik harus gagal sepenuhnya, atau mengembalikan hasil parsial (default).
semanticFields	string	Daftar nama bidang yang dipisahkan koma yang digunakan untuk peringkat semantik.
semanticMaxWaitInMilliseconds	integer	Memungkinkan pengguna untuk mengatur batas atas pada jumlah waktu yang diperlukan agar pengayaan semantik selesai diproses sebelum permintaan gagal.
semanticQuery	string	Memungkinkan pengaturan kueri pencarian terpisah yang hanya akan digunakan untuk reranking semantik, keterangan semantik, dan jawaban semantik. Berguna untuk skenario di mana ada kebutuhan untuk menggunakan kueri yang berbeda antara fase pengambilan dasar dan peringkat, dan fase semantik L2.
sessionId	string	Nilai yang akan digunakan untuk membuat sesi lengket, yang dapat membantu mendapatkan hasil yang lebih konsisten. Selama sessionId yang sama digunakan, upaya terbaik akan dilakukan untuk menargetkan set replika yang sama. Waspadalah bahwa menggunakan kembali nilai sessionID yang sama berulang kali dapat mengganggu penyeimbangan beban permintaan di seluruh replika dan berdampak buruk pada performa layanan pencarian. Nilai yang digunakan sebagai sessionId tidak dapat dimulai dengan karakter '_'.
skip	integer	Jumlah hasil pencarian yang akan dilewati. Nilai ini tidak boleh lebih besar dari 100.000. Jika Anda perlu memindai dokumen secara berurutan, tetapi tidak dapat menggunakan lewati karena batasan ini, pertimbangkan untuk menggunakan orderby pada kunci yang benar-benar diurutkan dan filter dengan kueri rentang sebagai gantinya.
speller	QuerySpellerType	Nilai yang menentukan jenis ejaan yang akan digunakan untuk mengoreksi istilah kueri pencarian individual yang benar.
top	integer	Jumlah hasil pencarian yang akan diambil. Ini dapat digunakan bersama dengan $skip untuk mengimplementasikan halaman sisi klien dari hasil pencarian. Jika hasil dipotong karena halaman sisi server, respons akan menyertakan token kelanjutan yang dapat digunakan untuk mengeluarkan permintaan Pencarian lain untuk halaman hasil berikutnya.
vectorFilterMode	VectorFilterMode	Menentukan apakah filter diterapkan sebelum atau sesudah pencarian vektor dilakukan atau tidak. Defaultnya adalah 'preFilter'.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parameter kueri untuk kueri pencarian vektor dan hibrid.

Respons

Nama	Jenis	Deskripsi
200 OK	SearchDocumentsResult	Respons yang berisi dokumen yang cocok dengan kriteria pencarian.
Other Status Codes	SearchError	Respons kesalahan.

Contoh

SearchIndexSearchDocumentsPost

Sample Request

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-01-Preview

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": null,
  "orderby": "rating desc",
  "queryType": "simple",
  "scoringParameters": [
    "currentLocation--122.123,44.77233"
  ],
  "scoringProfile": "sp",
  "search": "nice hotels",
  "searchFields": "category,description",
  "searchMode": "any",
  "sessionId": "mysessionid",
  "scoringStatistics": "global",
  "select": "hotelId,description",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "kind": "vector",
      "vector": [
        0.103,
        0.0712,
        0.0852,
        0.1547,
        0.1183
      ],
      "fields": "descriptionEmbedding",
      "k": 5,
      "exhaustive": true
    }
  ],
  "vectorFilterMode": "preFilter"
}

Sample Response

Status code:

200

{
  "@odata.count": 25,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "@search.nextPageParameters": {
    "count": true,
    "facets": [
      "category,count:10,sort:count"
    ],
    "filter": "rating gt 4.0",
    "highlight": "title",
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "minimumCoverage": null,
    "orderby": "search.score() desc,rating desc",
    "queryType": "simple",
    "sessionId": "mysessionid",
    "scoringStatistics": "global",
    "scoringParameters": [
      "currentLocation--122.123,44.77233"
    ],
    "scoringProfile": "sp",
    "search": "nice hotels",
    "searchFields": "title,description",
    "searchMode": "any",
    "select": "docId,title,description",
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 1.5,
      "@search.highlights": {
        "title": [
          "<em>Nice</em> <em>Hotel</em>"
        ]
      },
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.score": 0.7,
      "@search.highlights": {
        "title": [
          "Fancy <em>Hotel</em>"
        ]
      },
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-01-Preview"
}

Definisi

Nama	Deskripsi
AnswerResult	Jawabannya adalah bagian teks yang diekstrak dari konten dokumen yang paling relevan yang cocok dengan kueri. Jawaban diekstrak dari hasil pencarian teratas. Kandidat jawaban diberi skor dan jawaban teratas dipilih.
CaptionResult	Keterangan adalah bagian yang paling representatif dari dokumen relatif ke kueri pencarian. Mereka sering digunakan sebagai ringkasan dokumen. Keterangan hanya dikembalikan untuk kueri jenis 'semantik'..
DocumentDebugInfo	Berisi informasi penelusuran kesalahan yang dapat digunakan untuk menjelajahi hasil pencarian Anda lebih lanjut.
QueryAnswerType	Nilai yang menentukan apakah jawaban harus dikembalikan sebagai bagian dari respons pencarian.
QueryCaptionType	Nilai yang menentukan apakah keterangan harus dikembalikan sebagai bagian dari respons pencarian.
QueryDebugMode	Mengaktifkan alat penelusuran kesalahan yang dapat digunakan untuk menjelajahi hasil pencarian Anda lebih lanjut.
QueryLanguage	Bahasa kueri.
QueryResultDocumentRerankerInput	String yang digabungkan mentah yang dikirim ke proses pengayaan semantik.
QueryResultDocumentSemanticField	Deskripsi bidang yang dikirim ke proses pengayaan semantik, serta bagaimana bidang tersebut digunakan
QuerySpellerType	Nilai yang menentukan jenis ejaan yang akan digunakan untuk mengoreksi istilah kueri pencarian individual yang benar.
QueryType	Menentukan sintaks kueri pencarian. Defaultnya adalah 'sederhana'. Gunakan 'penuh' jika kueri Anda menggunakan sintaks kueri Lucene dan 'semantik' jika sintaks kueri tidak diperlukan.
RawVectorQuery	Parameter kueri yang digunakan untuk pencarian vektor saat nilai vektor mentah disediakan.
ScoringStatistics	Nilai yang menentukan apakah kita ingin menghitung statistik penilaian (seperti frekuensi dokumen) secara global untuk penilaian yang lebih konsisten, atau secara lokal, untuk latensi yang lebih rendah. Defaultnya adalah 'lokal'. Gunakan 'global' untuk mengagregasi statistik penilaian secara global sebelum mencetak skor. Menggunakan statistik penilaian global dapat meningkatkan latensi kueri pencarian.
SearchDocumentsResult	Respons yang berisi hasil pencarian dari indeks.
SearchError	Menjelaskan kondisi kesalahan untuk API.
SearchMode	Menentukan apakah ada atau semua istilah pencarian harus dicocokkan untuk menghitung dokumen sebagai kecocokan.
SearchRequest	Parameter untuk pemfilteran, pengurutan, faset, penomoran halaman, dan perilaku kueri pencarian lainnya.
SearchResult	Berisi dokumen yang ditemukan oleh kueri pencarian, ditambah metadata terkait.
SemanticDebugInfo
SemanticErrorMode	Memungkinkan pengguna untuk memilih apakah panggilan semantik harus gagal sepenuhnya, atau mengembalikan hasil parsial (default).
SemanticErrorReason	Alasan bahwa respons parsial dikembalikan untuk permintaan peringkat semantik.
SemanticFieldState	Cara bidang digunakan untuk proses pengayaan semantik (sepenuhnya digunakan, digunakan sebagian, atau tidak digunakan)
SemanticSearchResultsType	Jenis respons parsial yang dikembalikan untuk permintaan peringkat semantik.
VectorFilterMode	Menentukan apakah filter diterapkan sebelum atau sesudah pencarian vektor dilakukan atau tidak.
VectorizableTextQuery	Parameter kueri yang digunakan untuk pencarian vektor saat nilai teks yang perlu di-vektorisasi disediakan.
VectorQueryKind	Jenis kueri vektor yang sedang dilakukan.

AnswerResult

Jawabannya adalah bagian teks yang diekstrak dari konten dokumen yang paling relevan yang cocok dengan kueri. Jawaban diekstrak dari hasil pencarian teratas. Kandidat jawaban diberi skor dan jawaban teratas dipilih.

Nama	Jenis	Deskripsi
highlights	string	Bagian teks yang sama seperti di properti Teks dengan frasa teks yang disorot paling relevan dengan kueri.
key	string	Kunci dokumen tempat jawaban diekstrak.
score	number	Nilai skor menunjukkan seberapa relevan jawabannya terhadap kueri relatif terhadap jawaban lain yang dikembalikan untuk kueri.
text	string	Bagian teks yang diekstrak dari konten dokumen sebagai jawabannya.

CaptionResult

Keterangan adalah bagian yang paling representatif dari dokumen relatif ke kueri pencarian. Mereka sering digunakan sebagai ringkasan dokumen. Keterangan hanya dikembalikan untuk kueri jenis 'semantik'..

Nama	Jenis	Deskripsi
highlights	string	Bagian teks yang sama seperti di properti Teks dengan frasa yang disorot paling relevan dengan kueri.
text	string	Bagian teks perwakilan yang diekstrak dari dokumen yang paling relevan dengan kueri pencarian.

DocumentDebugInfo

Berisi informasi penelusuran kesalahan yang dapat digunakan untuk menjelajahi hasil pencarian Anda lebih lanjut.

Nama	Jenis	Deskripsi
semantic	SemanticDebugInfo	Berisi informasi penelusuran kesalahan khusus untuk permintaan peringkat semantik.

QueryAnswerType

Nilai yang menentukan apakah jawaban harus dikembalikan sebagai bagian dari respons pencarian.

Nama	Jenis	Deskripsi
extractive	string	Mengekstrak kandidat jawaban dari konten dokumen yang dikembalikan sebagai respons terhadap kueri yang dinyatakan sebagai pertanyaan dalam bahasa alami.
none	string	Jangan mengembalikan jawaban untuk kueri.

QueryCaptionType

Nilai yang menentukan apakah keterangan harus dikembalikan sebagai bagian dari respons pencarian.

Nama	Jenis	Deskripsi
extractive	string	Mengekstrak keterangan dari dokumen yang cocok yang berisi bagian yang relevan dengan kueri pencarian.
none	string	Jangan mengembalikan keterangan untuk kueri.

QueryDebugMode

Mengaktifkan alat penelusuran kesalahan yang dapat digunakan untuk menjelajahi hasil pencarian Anda lebih lanjut.

Nama	Jenis	Deskripsi
disabled	string	Tidak ada informasi penelusuran kesalahan kueri yang akan dikembalikan.
semantic	string	Memungkinkan pengguna untuk mengeksplorasi lebih lanjut hasil yang direrank.

QueryLanguage

Bahasa kueri.

Nama	Jenis	Deskripsi
ar-eg	string	Nilai bahasa kueri untuk Bahasa Arab (Mesir).
ar-jo	string	Nilai bahasa kueri untuk bahasa Arab (Yordania).
ar-kw	string	Nilai bahasa kueri untuk Bahasa Arab (Kuwait).
ar-ma	string	Nilai bahasa kueri untuk Bahasa Arab (Maroko).
ar-sa	string	Nilai bahasa kueri untuk Bahasa Arab (Arab Saudi).
bg-bg	string	Nilai bahasa kueri untuk bahasa Bulgaria (Bulgaria).
bn-in	string	Nilai bahasa kueri untuk Bengali (India).
ca-es	string	Nilai bahasa kueri untuk Katala.
cs-cz	string	Nilai bahasa kueri untuk Ceko (Republik Ceko).
da-dk	string	Nilai bahasa kueri untuk Bahasa Denmark (Denmark).
de-de	string	Nilai bahasa kueri untuk Bahasa Jerman (Jerman).
el-gr	string	Nilai bahasa kueri untuk bahasa Yunani (Yunani).
en-au	string	Nilai bahasa kueri untuk bahasa Inggris (Australia).
en-ca	string	Nilai bahasa kueri untuk bahasa Inggris (Kanada).
en-gb	string	Nilai bahasa kueri untuk bahasa Inggris (Inggris Raya).
en-in	string	Nilai bahasa kueri untuk bahasa Inggris (India).
en-us	string	Nilai bahasa kueri untuk bahasa Inggris (Amerika Serikat).
es-es	string	Nilai bahasa kueri untuk bahasa Spanyol (Spanyol).
es-mx	string	Nilai bahasa kueri untuk bahasa Spanyol (Meksiko).
et-ee	string	Nilai bahasa kueri untuk Bahasa Estonia (Estonia).
eu-es	string	Nilai bahasa kueri untuk Basque.
fa-ae	string	Nilai bahasa kueri untuk Bahasa Persia (A.A.E.).
fi-fi	string	Nilai bahasa kueri untuk Bahasa Finlandia (Finlandia).
fr-ca	string	Nilai bahasa kueri untuk bahasa Prancis (Kanada).
fr-fr	string	Nilai bahasa kueri untuk bahasa Prancis (Prancis).
ga-ie	string	Nilai bahasa kueri untuk Irlandia (Irlandia).
gl-es	string	Nilai bahasa kueri untuk Bahasa Galisia.
gu-in	string	Nilai bahasa kueri untuk Gujarati (India).
he-il	string	Nilai bahasa kueri untuk bahasa Ibrani (Israel).
hi-in	string	Nilai bahasa kueri untuk Bahasa Hindi (India).
hr-ba	string	Nilai bahasa kueri untuk Kroasia (Bosnia dan Herzegovina).
hr-hr	string	Nilai bahasa kueri untuk Kroasia (Kroasia).
hu-hu	string	Nilai bahasa kueri untuk Hungaria (Hongaria).
hy-am	string	Nilai bahasa kueri untuk Bahasa Armenia (Armenia).
id-id	string	Nilai bahasa kueri untuk Bahasa Indonesia (Indonesia).
is-is	string	Nilai bahasa kueri untuk Islandia (Islandia).
it-it	string	Nilai bahasa kueri untuk Bahasa Italia (Italia).
ja-jp	string	Nilai bahasa kueri untuk bahasa Jepang (Jepang).
kn-in	string	Nilai bahasa kueri untuk Kannada (India).
ko-kr	string	Nilai bahasa kueri untuk bahasa Korea (Korea).
lt-lt	string	Nilai bahasa kueri untuk bahasa Lithuania (Lituania).
lv-lv	string	Nilai bahasa kueri untuk bahasa Latvia (Latvia).
ml-in	string	Nilai bahasa kueri untuk Malayalam (India).
mr-in	string	Nilai bahasa kueri untuk Marathi (India).
ms-bn	string	Nilai bahasa kueri untuk Bahasa Melayu (Brunei Darussalam).
ms-my	string	Nilai bahasa kueri untuk Bahasa Melayu (Malaysia).
nb-no	string	Nilai bahasa kueri untuk Norwegia (Norwegia).
nl-be	string	Nilai bahasa kueri untuk bahasa Belanda (Belgia).
nl-nl	string	Nilai bahasa kueri untuk Bahasa Belanda (Belanda).
no-no	string	Nilai bahasa kueri untuk Norwegia (Norwegia).
none	string	Bahasa kueri tidak ditentukan.
pa-in	string	Nilai bahasa kueri untuk Punjabi (India).
pl-pl	string	Nilai bahasa kueri untuk Polandia (Polandia).
pt-br	string	Nilai bahasa kueri untuk bahasa Portugis (Brasil).
pt-pt	string	Nilai bahasa kueri untuk bahasa Portugis (Portugal).
ro-ro	string	Nilai bahasa kueri untuk Rumania (Rumania).
ru-ru	string	Nilai bahasa kueri untuk Bahasa Rusia (Rusia).
sk-sk	string	Nilai bahasa kueri untuk Slowakia (Slowakia).
sl-sl	string	Nilai bahasa kueri untuk bahasa Slovenia (Slovenia).
sr-ba	string	Nilai bahasa kueri untuk bahasa Serbia (Bosnia dan Herzegovina).
sr-me	string	Nilai bahasa kueri untuk bahasa Serbia (Montenegro).
sr-rs	string	Nilai bahasa kueri untuk bahasa Serbia (Serbia).
sv-se	string	Nilai bahasa kueri untuk bahasa Swedia (Swedia).
ta-in	string	Nilai bahasa kueri untuk Tamil (India).
te-in	string	Nilai bahasa kueri untuk Telugu (India).
th-th	string	Nilai bahasa kueri untuk Thailand (Thailand).
tr-tr	string	Nilai bahasa kueri untuk Turki (Turki).
uk-ua	string	Nilai bahasa kueri untuk Ukraina (Ukraina).
ur-pk	string	Nilai bahasa kueri untuk Urdu (Pakistan).
vi-vn	string	Nilai bahasa kueri untuk bahasa Vietnam (Viet Nam).
zh-cn	string	Nilai bahasa kueri untuk Bahasa Tionghoa (Tiongkok).
zh-tw	string	Nilai bahasa kueri untuk Bahasa Tionghoa (Taiwan).

QueryResultDocumentRerankerInput

String yang digabungkan mentah yang dikirim ke proses pengayaan semantik.

Nama	Jenis	Deskripsi
content	string	String yang digabungkan mentah untuk bidang konten yang digunakan untuk pengayaan semantik.
keywords	string	String yang digabungkan mentah untuk bidang kata kunci yang digunakan untuk pengayaan semantik.
title	string	String mentah untuk bidang judul yang digunakan untuk pengayaan semantik.

QueryResultDocumentSemanticField

Deskripsi bidang yang dikirim ke proses pengayaan semantik, serta bagaimana bidang tersebut digunakan

Nama	Jenis	Deskripsi
name	string	Nama bidang yang dikirim ke proses pengayaan semantik
state	SemanticFieldState	Cara bidang digunakan untuk proses pengayaan semantik (sepenuhnya digunakan, digunakan sebagian, atau tidak digunakan)

QuerySpellerType

Nilai yang menentukan jenis ejaan yang akan digunakan untuk mengoreksi istilah kueri pencarian individual yang benar.

Nama	Jenis	Deskripsi
lexicon	string	Speller mengoreksi istilah kueri individual menggunakan leksikon statis untuk bahasa yang ditentukan oleh parameter queryLanguage.
none	string	Ejaan tidak diaktifkan.

QueryType

Menentukan sintaks kueri pencarian. Defaultnya adalah 'sederhana'. Gunakan 'penuh' jika kueri Anda menggunakan sintaks kueri Lucene dan 'semantik' jika sintaks kueri tidak diperlukan.

Nama	Jenis	Deskripsi
full	string	Menggunakan sintaks kueri Lucene lengkap untuk pencarian. Teks pencarian ditafsirkan menggunakan bahasa kueri Lucene yang memungkinkan pencarian khusus bidang dan tertimbang, serta fitur tingkat lanjut lainnya.
semantic	string	Paling cocok untuk kueri yang dinyatakan dalam bahasa alami dibandingkan dengan kata kunci. Meningkatkan presisi hasil pencarian dengan memberi peringkat ulang hasil pencarian teratas menggunakan model peringkat yang dilatih di korpus Web.
simple	string	Menggunakan sintaks kueri sederhana untuk pencarian. Teks pencarian ditafsirkan menggunakan bahasa kueri sederhana yang memungkinkan simbol seperti +, * dan "". Kueri dievaluasi di semua bidang yang dapat dicari secara default, kecuali parameter searchFields ditentukan.

RawVectorQuery

Parameter kueri yang digunakan untuk pencarian vektor saat nilai vektor mentah disediakan.

Nama	Jenis	Deskripsi
exhaustive	boolean	Jika benar, memicu pencarian tetangga k-terdekat yang lengkap di semua vektor dalam indeks vektor. Berguna untuk skenario di mana kecocokan yang tepat sangat penting, seperti menentukan nilai kebenaran dasar.
fields	string	Bidang Vektor dari jenis Koleksi (Edm.Single) yang akan disertakan dalam vektor yang dicari.
k	integer	Jumlah tetangga terdekat untuk kembali sebagai hit teratas.
kind	string: vector	Jenis kueri vektor yang sedang dilakukan.
vector	number[]	Representasi vektor kueri pencarian.

ScoringStatistics

Nilai yang menentukan apakah kita ingin menghitung statistik penilaian (seperti frekuensi dokumen) secara global untuk penilaian yang lebih konsisten, atau secara lokal, untuk latensi yang lebih rendah. Defaultnya adalah 'lokal'. Gunakan 'global' untuk mengagregasi statistik penilaian secara global sebelum mencetak skor. Menggunakan statistik penilaian global dapat meningkatkan latensi kueri pencarian.

Nama	Jenis	Deskripsi
global	string	Statistik penilaian akan dihitung secara global untuk penilaian yang lebih konsisten.
local	string	Statistik penilaian akan dihitung secara lokal untuk latensi yang lebih rendah.

SearchDocumentsResult

Respons yang berisi hasil pencarian dari indeks.

Nama	Jenis	Deskripsi
@odata.count	integer	Jumlah total hasil yang ditemukan oleh operasi pencarian, atau null jika jumlahnya tidak diminta. Jika ada, jumlahnya mungkin lebih besar dari jumlah hasil dalam respons ini. Ini dapat terjadi jika Anda menggunakan parameter $top atau $skip, atau jika kueri tidak dapat mengembalikan semua dokumen yang diminta dalam satu respons.
@odata.nextLink	string	URL kelanjutan dikembalikan saat kueri tidak dapat mengembalikan semua hasil yang diminta dalam satu respons. Anda dapat menggunakan URL ini untuk merumuskan permintaan PENCARIAN GET atau POST lainnya untuk mendapatkan bagian berikutnya dari respons pencarian. Pastikan untuk menggunakan kata kerja yang sama (GET atau POST) sebagai permintaan yang menghasilkan respons ini.
@search.answers	AnswerResult[]	Hasil kueri jawaban untuk operasi pencarian; null jika parameter kueri jawaban tidak ditentukan atau diatur ke 'none'.
@search.coverage	number	Nilai yang menunjukkan persentase indeks yang disertakan dalam kueri, atau null jika minimumCoverage tidak ditentukan dalam permintaan.
@search.facets	object	Hasil kueri faset untuk operasi pencarian, diatur sebagai kumpulan wadah untuk setiap bidang tersaring; null jika kueri tidak menyertakan ekspresi faset apa pun.
@search.nextPageParameters	SearchRequest	Payload JSON kelanjutan dikembalikan saat kueri tidak dapat mengembalikan semua hasil yang diminta dalam satu respons. Anda dapat menggunakan JSON ini bersama dengan @odata.nextLink untuk merumuskan permintaan Pencarian POST lain untuk mendapatkan bagian berikutnya dari respons pencarian.
@search.semanticPartialResponseReason	SemanticErrorReason	Alasan bahwa respons parsial dikembalikan untuk permintaan peringkat semantik.
@search.semanticPartialResponseType	SemanticSearchResultsType	Jenis respons parsial yang dikembalikan untuk permintaan peringkat semantik.
value	SearchResult[]	Urutan hasil yang dikembalikan oleh kueri.

SearchError

Menjelaskan kondisi kesalahan untuk API.

Nama	Jenis	Deskripsi
code	string	Salah satu set kode kesalahan yang ditentukan server.
details	SearchError[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
message	string	Representasi kesalahan yang dapat dibaca manusia.

SearchMode

Menentukan apakah ada atau semua istilah pencarian harus dicocokkan untuk menghitung dokumen sebagai kecocokan.

Nama	Jenis	Deskripsi
all	string	Semua istilah pencarian harus dicocokkan untuk menghitung dokumen sebagai kecocokan.
any	string	Salah satu istilah pencarian harus dicocokkan untuk menghitung dokumen sebagai kecocokan.

SearchRequest

Parameter untuk pemfilteran, pengurutan, faset, penomoran halaman, dan perilaku kueri pencarian lainnya.

Nama	Jenis	Deskripsi
answers	QueryAnswerType	Nilai yang menentukan apakah jawaban harus dikembalikan sebagai bagian dari respons pencarian.
captions	QueryCaptionType	Nilai yang menentukan apakah keterangan harus dikembalikan sebagai bagian dari respons pencarian.
count	boolean	Nilai yang menentukan apakah akan mengambil jumlah total hasil. Defaultnya adalah false. Mengatur nilai ini ke true mungkin memiliki dampak performa. Perhatikan bahwa jumlah yang dikembalikan adalah perkiraan.
debug	QueryDebugMode	Memungkinkan alat penelusuran kesalahan yang dapat digunakan untuk menjelajahi lebih lanjut hasil yang direrank.
facets	string[]	Daftar ekspresi faset yang akan diterapkan ke kueri pencarian. Setiap ekspresi faset berisi nama bidang, secara opsional diikuti dengan daftar pasangan nama:nilai yang dipisahkan koma.
filter	string	Ekspresi $filter OData untuk diterapkan ke kueri pencarian.
highlight	string	Daftar nama bidang yang dipisahkan koma yang akan digunakan untuk sorotan temuan. Hanya bidang yang dapat dicari yang dapat digunakan untuk penyorotan hit.
highlightPostTag	string	Tag string yang ditambahkan untuk menekan sorotan. Harus diatur dengan highlightPreTag. Defaultnya adalah </em>.
highlightPreTag	string	Tag string yang telah ditambahkan sebelumnya untuk menekan sorotan. Harus diatur dengan highlightPostTag. Defaultnya adalah <em>.
minimumCoverage	number	Angka antara 0 dan 100 yang menunjukkan persentase indeks yang harus dicakup oleh kueri pencarian agar kueri dilaporkan sebagai keberhasilan. Parameter ini dapat berguna untuk memastikan ketersediaan pencarian bahkan untuk layanan hanya dengan satu replika. Nilai defaultnya adalah 100.
orderby	string	Daftar ekspresi $orderby OData yang dipisahkan koma untuk mengurutkan hasilnya. Setiap ekspresi dapat berupa nama bidang atau panggilan ke fungsi geo.distance() atau search.score(). Setiap ekspresi dapat diikuti oleh asc untuk menunjukkan naik, atau turun untuk menunjukkan menurun. Defaultnya adalah urutan naik. Ikatan akan dipecah oleh skor kecocokan dokumen. Jika tidak ada $orderby yang ditentukan, urutan pengurutan default turun menurut skor kecocokan dokumen. Paling banyak ada 32 klausa $orderby.
queryLanguage	QueryLanguage	Nilai yang menentukan bahasa kueri pencarian.
queryType	QueryType	Nilai yang menentukan sintaks kueri pencarian. Defaultnya adalah 'sederhana'. Gunakan 'penuh' jika kueri Anda menggunakan sintaks kueri Lucene.
scoringParameters	string[]	Daftar nilai parameter yang akan digunakan dalam fungsi penilaian (misalnya, referencePointParameter) menggunakan format nama-nilai. Misalnya, jika profil penilaian mendefinisikan fungsi dengan parameter yang disebut 'mylocation' string parameter adalah "mylocation--122.2,44.8" (tanpa tanda kutip).
scoringProfile	string	Nama profil penilaian untuk mengevaluasi skor kecocokan untuk dokumen yang cocok untuk mengurutkan hasilnya.
scoringStatistics	ScoringStatistics	Nilai yang menentukan apakah kita ingin menghitung statistik penilaian (seperti frekuensi dokumen) secara global untuk penilaian yang lebih konsisten, atau secara lokal, untuk latensi yang lebih rendah. Defaultnya adalah 'lokal'. Gunakan 'global' untuk mengagregasi statistik penilaian secara global sebelum mencetak skor. Menggunakan statistik penilaian global dapat meningkatkan latensi kueri pencarian.
search	string	Ekspresi kueri pencarian teks lengkap; Gunakan "*" atau hilangkan parameter ini agar sesuai dengan semua dokumen.
searchFields	string	Daftar nama bidang yang dipisahkan koma untuk mencakup pencarian teks lengkap. Saat menggunakan pencarian bidang (fieldName:searchExpression) dalam kueri Lucene lengkap, nama bidang dari setiap ekspresi pencarian bidang lebih diutamakan daripada nama bidang apa pun yang tercantum dalam parameter ini.
searchMode	SearchMode	Nilai yang menentukan apakah salah satu atau semua istilah pencarian harus dicocokkan untuk menghitung dokumen sebagai kecocokan.
select	string	Daftar bidang yang dipisahkan koma untuk diambil. Jika tidak ditentukan, semua bidang yang ditandai sebagai dapat diambil dalam skema disertakan.
semanticConfiguration	string	Nama konfigurasi semantik yang akan digunakan saat memproses dokumen untuk kueri semantik jenis.
semanticErrorHandling	SemanticErrorMode	Memungkinkan pengguna untuk memilih apakah panggilan semantik harus gagal sepenuhnya, atau mengembalikan hasil parsial (default).
semanticFields	string	Daftar nama bidang yang dipisahkan koma yang digunakan untuk peringkat semantik.
semanticMaxWaitInMilliseconds	integer	Memungkinkan pengguna untuk mengatur batas atas pada jumlah waktu yang diperlukan agar pengayaan semantik selesai diproses sebelum permintaan gagal.
semanticQuery	string	Memungkinkan pengaturan kueri pencarian terpisah yang hanya akan digunakan untuk reranking semantik, keterangan semantik, dan jawaban semantik. Berguna untuk skenario di mana ada kebutuhan untuk menggunakan kueri yang berbeda antara fase pengambilan dasar dan peringkat, dan fase semantik L2.
sessionId	string	Nilai yang akan digunakan untuk membuat sesi lengket, yang dapat membantu mendapatkan hasil yang lebih konsisten. Selama sessionId yang sama digunakan, upaya terbaik akan dilakukan untuk menargetkan set replika yang sama. Waspadalah bahwa menggunakan kembali nilai sessionID yang sama berulang kali dapat mengganggu penyeimbangan beban permintaan di seluruh replika dan berdampak buruk pada performa layanan pencarian. Nilai yang digunakan sebagai sessionId tidak dapat dimulai dengan karakter '_'.
skip	integer	Jumlah hasil pencarian yang akan dilewati. Nilai ini tidak boleh lebih besar dari 100.000. Jika Anda perlu memindai dokumen secara berurutan, tetapi tidak dapat menggunakan lewati karena batasan ini, pertimbangkan untuk menggunakan orderby pada kunci yang benar-benar diurutkan dan filter dengan kueri rentang sebagai gantinya.
speller	QuerySpellerType	Nilai yang menentukan jenis ejaan yang akan digunakan untuk mengoreksi istilah kueri pencarian individual yang benar.
top	integer	Jumlah hasil pencarian yang akan diambil. Ini dapat digunakan bersama dengan $skip untuk mengimplementasikan halaman sisi klien dari hasil pencarian. Jika hasil dipotong karena halaman sisi server, respons akan menyertakan token kelanjutan yang dapat digunakan untuk mengeluarkan permintaan Pencarian lain untuk halaman hasil berikutnya.
vectorFilterMode	VectorFilterMode	Menentukan apakah filter diterapkan sebelum atau sesudah pencarian vektor dilakukan atau tidak. Defaultnya adalah 'preFilter'.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parameter kueri untuk kueri pencarian vektor dan hibrid.

SearchResult

Berisi dokumen yang ditemukan oleh kueri pencarian, ditambah metadata terkait.

Nama	Jenis	Deskripsi
@search.captions	CaptionResult[]	Keterangan adalah bagian yang paling representatif dari dokumen relatif ke kueri pencarian. Mereka sering digunakan sebagai ringkasan dokumen. Keterangan hanya dikembalikan untuk kueri jenis 'semantik'.
@search.documentDebugInfo	DocumentDebugInfo[]	Berisi informasi penelusuran kesalahan yang dapat digunakan untuk menjelajahi hasil pencarian Anda lebih lanjut.
@search.highlights	object	Fragmen teks dari dokumen yang menunjukkan istilah pencarian yang cocok, diatur oleh setiap bidang yang berlaku; null jika penyorotan hit tidak diaktifkan untuk kueri.
@search.rerankerScore	number	Skor relevansi yang dihitung oleh ranker semantik untuk hasil pencarian teratas. Hasil pencarian diurutkan berdasarkan RerankerScore terlebih dahulu lalu berdasarkan Skor. RerankerScore hanya dikembalikan untuk kueri jenis 'semantik'.
@search.score	number	Skor relevansi dokumen dibandingkan dengan dokumen lain yang dikembalikan oleh kueri.

SemanticDebugInfo

Nama	Jenis	Deskripsi
contentFields	QueryResultDocumentSemanticField[]	Bidang konten yang dikirim ke proses pengayaan semantik, serta bagaimana bidang tersebut digunakan
keywordFields	QueryResultDocumentSemanticField[]	Bidang kata kunci yang dikirim ke proses pengayaan semantik, serta bagaimana bidang tersebut digunakan
rerankerInput	QueryResultDocumentRerankerInput	String yang digabungkan mentah yang dikirim ke proses pengayaan semantik.
titleField	QueryResultDocumentSemanticField	Bidang judul yang dikirim ke proses pengayaan semantik, serta cara penggunaannya

SemanticErrorMode

Memungkinkan pengguna untuk memilih apakah panggilan semantik harus gagal sepenuhnya, atau mengembalikan hasil parsial (default).

Nama	Jenis	Deskripsi
fail	string	Jika ada pengecualian selama langkah pemrosesan semantik, kueri akan gagal dan mengembalikan kode HTTP yang sesuai tergantung pada kesalahan.
partial	string	Jika pemrosesan semantik gagal, hasil parsial masih kembali. Definisi hasil parsial tergantung pada langkah semantik apa yang gagal dan apa alasan kegagalannya.

SemanticErrorReason

Alasan bahwa respons parsial dikembalikan untuk permintaan peringkat semantik.

Nama	Jenis	Deskripsi
capacityOverloaded	string	Permintaan dibatasi. Hanya hasil dasar yang dikembalikan.
maxWaitExceeded	string	Jika 'semanticMaxWaitInMilliseconds' diatur dan durasi pemrosesan semantik melebihi nilai tersebut. Hanya hasil dasar yang dikembalikan.
transient	string	Setidaknya satu langkah dari proses semantik gagal.

SemanticFieldState

Cara bidang digunakan untuk proses pengayaan semantik (sepenuhnya digunakan, digunakan sebagian, atau tidak digunakan)

Nama	Jenis	Deskripsi
partial	string	Bidang ini sebagian digunakan untuk pengayaan semantik.
unused	string	Bidang ini tidak digunakan untuk pengayaan semantik.
used	string	Bidang ini sepenuhnya digunakan untuk pengayaan semantik.

SemanticSearchResultsType

Jenis respons parsial yang dikembalikan untuk permintaan peringkat semantik.

Nama	Jenis	Deskripsi
baseResults	string	Hasil tanpa pengayaan semantik atau reranking.
rerankedResults	string	Hasil telah direrank dengan model reranker dan akan menyertakan keterangan semantik. Mereka tidak akan menyertakan jawaban, sorotan jawaban, atau sorotan caption.

VectorFilterMode

Menentukan apakah filter diterapkan sebelum atau sesudah pencarian vektor dilakukan atau tidak.

Nama	Jenis	Deskripsi
postFilter	string	Filter akan diterapkan setelah kumpulan kandidat hasil vektor dikembalikan. Bergantung pada selektivitas filter, ini dapat menghasilkan hasil yang lebih sedikit daripada yang diminta oleh parameter 'k'.
preFilter	string	Filter akan diterapkan sebelum kueri pencarian.

VectorizableTextQuery

Parameter kueri yang digunakan untuk pencarian vektor saat nilai teks yang perlu di-vektorisasi disediakan.

Nama	Jenis	Deskripsi
exhaustive	boolean	Jika benar, memicu pencarian tetangga k-terdekat yang lengkap di semua vektor dalam indeks vektor. Berguna untuk skenario di mana kecocokan yang tepat sangat penting, seperti menentukan nilai kebenaran dasar.
fields	string	Bidang Vektor dari jenis Koleksi (Edm.Single) yang akan disertakan dalam vektor yang dicari.
k	integer	Jumlah tetangga terdekat untuk kembali sebagai hit teratas.
kind	string: text	Jenis kueri vektor yang sedang dilakukan.
text	string	Teks yang akan di-vektorisasi untuk melakukan kueri pencarian vektor.

VectorQueryKind

Jenis kueri vektor yang sedang dilakukan.

Nama	Jenis	Deskripsi
text	string	Kueri vektor tempat nilai teks yang perlu di-vektorisasi disediakan.
vector	string	Kueri vektor tempat nilai vektor mentah disediakan.