Documents - Search Get

Layanan:: Search Service

Versi API:: 2024-03-01-Preview

Mencari dokumen dalam indeks.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-03-01-Preview

Dengan parameter opsional:

GET {endpoint}/indexes('{indexName}')/docs?search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&semanticQuery={semanticQuery}&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&debug={debug}&searchFields={searchFields}&queryLanguage={queryLanguage}&speller={speller}&answers={answers}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&captions={captions}&semanticFields={semanticFields}&api-version=2024-03-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.
$count	query		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.
$filter	query		string	Ekspresi $filter OData untuk diterapkan ke kueri pencarian.
$orderby	query		string[]	Daftar ekspresi $orderby OData 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, dan 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.
$select	query		string[]	Daftar bidang yang akan diambil. Jika tidak ditentukan, semua bidang yang ditandai sebagai dapat diambil dalam skema disertakan.
$skip	query		integer (int32)	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 $skip karena keterbatasan ini, pertimbangkan untuk menggunakan $orderby pada kunci yang benar-benar diurutkan dan $filter dengan kueri rentang sebagai gantinya.
$top	query		integer (int32)	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.
answers	query		QueryAnswerType	Parameter ini hanya valid jika jenis kueri `semantic`. Jika diatur, kueri mengembalikan jawaban yang diekstrak dari bagian kunci dalam dokumen berperingkat tertinggi. Jumlah jawaban yang dikembalikan dapat dikonfigurasi dengan menambahkan karakter pipa `\|` diikuti oleh opsi `count-<number of answers>` setelah nilai parameter jawaban, seperti `extractive\|count-3`. Jumlah default adalah 1. Ambang keyakinan dapat dikonfigurasi dengan menambahkan karakter pipa `\|` diikuti oleh opsi `threshold-<confidence threshold>` setelah nilai parameter jawaban, seperti `extractive\|threshold-0.9`. Ambang default adalah 0,7.
captions	query		QueryCaptionType	Parameter ini hanya valid jika jenis kueri `semantic`. Jika diatur, kueri mengembalikan keterangan yang diekstrak dari bagian kunci dalam dokumen berperingkat tertinggi. Saat Keterangan diatur ke `extractive`, penyorotan diaktifkan secara default, dan dapat dikonfigurasi dengan menambahkan karakter pipa `\|` diikuti dengan opsi `highlight-<true/false>`, seperti `extractive\|highlight-true`. Secara otomatis beralih ke `None`.
debug	query		QueryDebugMode	Mengaktifkan alat penelusuran kesalahan yang dapat digunakan untuk menjelajahi hasil pencarian Anda lebih lanjut.
facet	query		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.
highlight	query		string[]	Daftar nama bidang yang akan digunakan untuk sorotan temuan. Hanya bidang yang dapat dicari yang dapat digunakan untuk penyorotan temuan.
highlightPostTag	query		string	Tag string yang ditambahkan untuk menekan sorotan. Harus diatur dengan highlightPreTag. Defaultnya adalah </em>.
highlightPreTag	query		string	Tag string yang sebelumnya ditangguhkan untuk menekan sorotan. Harus diatur dengan highlightPostTag. Defaultnya adalah <em>.
minimumCoverage	query		number (double)	Angka antara 0 dan 100 yang menunjukkan persentase indeks yang harus dicakup oleh kueri pencarian agar kueri dilaporkan berhasil. Parameter ini dapat berguna untuk memastikan ketersediaan pencarian bahkan untuk layanan hanya dengan satu replika. Nilai defaultnya adalah 100.
queryLanguage	query		QueryLanguage	Bahasa kueri.
queryType	query		QueryType	Nilai yang menentukan sintaks kueri pencarian. Defaultnya adalah 'sederhana'. Gunakan 'penuh' jika kueri Anda menggunakan sintaks kueri Lucene.
scoringParameter	query		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	query		string	Nama profil penilaian untuk mengevaluasi skor kecocokan untuk dokumen yang cocok untuk mengurutkan hasilnya.
scoringStatistics	query		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.
search	query		string	Ekspresi kueri pencarian teks lengkap; Gunakan "*" atau hilangkan parameter ini untuk mencocokkan semua dokumen.
searchFields	query		string[]	Daftar nama bidang yang akan dicakup dalam 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	query		SearchMode	Nilai yang menentukan apakah salah satu atau semua istilah pencarian harus dicocokkan untuk menghitung dokumen sebagai kecocokan.
semanticConfiguration	query		string	Nama konfigurasi semantik yang mencantumkan bidang mana yang harus digunakan untuk peringkat semantik, keterangan, sorotan, dan jawaban
semanticErrorHandling	query		SemanticErrorMode	Memungkinkan pengguna untuk memilih apakah panggilan semantik harus gagal sepenuhnya, atau mengembalikan hasil parsial (default).
semanticFields	query		string[]	Daftar nama bidang yang digunakan untuk peringkat semantik.
semanticMaxWaitInMilliseconds	query		integer (int32) minimum: 700	Memungkinkan pengguna untuk mengatur batas atas pada jumlah waktu yang diperlukan agar pengayaan semantik selesai diproses sebelum permintaan gagal.
semanticQuery	query		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 dan peringkat dasar, dan fase semantik L2.
sessionId	query		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 '_'.
speller	query		Speller	Tingkatkan pengenalan pencarian dengan mengoreksi istilah kueri pencarian individual.

Header Permintaan

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

Respons

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

Contoh

SearchIndexSearchDocumentsGet

Permintaan sampel

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&speller={speller}&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2024-03-01-Preview

Respon sampel

Kode status:: 200

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "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"
    }
  ]
}

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 dinilai 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.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
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 tipe ejaan yang akan digunakan untuk mengoreksi ejaan istilah kueri pencarian individual.
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 menilai. Menggunakan statistik penilaian global dapat meningkatkan latensi kueri pencarian.
SearchDocumentsResult	Respons yang berisi hasil pencarian dari indeks.
SearchMode	Menentukan apakah salah satu 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.
Speller	Tingkatkan pengenalan pencarian dengan mengoreksi istilah kueri pencarian individual.
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

Objek

Jawabannya adalah bagian teks yang diekstrak dari konten dokumen yang paling relevan yang cocok dengan kueri. Jawaban diekstrak dari hasil pencarian teratas. Kandidat jawaban dinilai 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 (double)	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

Objek

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

Objek

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.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

QueryAnswerType

Enumerasi

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

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

QueryCaptionType

Enumerasi

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

Nilai	Deskripsi
none	Jangan kembalikan keterangan untuk kueri.
extractive	Mengekstrak keterangan dari dokumen yang cocok yang berisi bagian yang relevan dengan kueri pencarian.

QueryDebugMode

Enumerasi

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

Nilai	Deskripsi
disabled	Tidak ada informasi penelusuran kesalahan kueri yang akan dikembalikan.
semantic	Memungkinkan pengguna untuk menjelajahi lebih lanjut hasil yang direrankasi.

QueryLanguage

Enumerasi

Bahasa kueri.

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

QueryResultDocumentRerankerInput

Objek

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

Objek

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

Enumerasi

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

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

QueryType

Enumerasi

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

Nilai	Deskripsi
simple	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.
full	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	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.

RawVectorQuery

Objek

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	Daftar nama bidang yang dipisahkan koma yang akan disertakan dalam pencarian vektor. Setiap bidang harus berupa jenis vektor yang valid, seperti Collection(Edm.Single). Jika beberapa bidang diberikan, vektor akan digunakan untuk menemukan kecocokan terdekat di semua bidang.
k	integer (int32)	Jumlah tetangga terdekat untuk kembali sebagai hit teratas.
kind	string: vector	Jenis kueri vektor yang sedang dilakukan.
oversampling	number (double)	Faktor pengambilan sampel berlebih. Nilai minimum adalah 1. Ini mengambil alih parameter 'defaultOversampling' yang dikonfigurasi dalam definisi indeks. Ini hanya dapat diatur ketika 'rerankWithOriginalVectors' benar. Parameter ini hanya diizinkan ketika metode kompresi digunakan pada bidang vektor yang mendasar.
vector	number[] (float)	Representasi vektor kueri pencarian.

ScoringStatistics

Enumerasi

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 menilai. Menggunakan statistik penilaian global dapat meningkatkan latensi kueri pencarian.

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

SearchDocumentsResult

Objek

Respons yang berisi hasil pencarian dari indeks.

Nama	Jenis	Deskripsi
@odata.count	integer (int64)	Jumlah total hasil yang ditemukan oleh operasi pencarian, atau null jika jumlah 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 GET atau POST Search lain 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 (double)	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.

SearchMode

Enumerasi

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

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

SearchRequest

Objek

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	Mengaktifkan alat penelusuran kesalahan yang dapat digunakan untuk menjelajahi lebih lanjut hasil yang dirank ulang.
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 temuan.
highlightPostTag	string	Tag string yang ditambahkan untuk menekan sorotan. Harus diatur dengan highlightPreTag. Defaultnya adalah </em>.
highlightPreTag	string	Tag string yang sebelumnya ditangguhkan untuk menekan sorotan. Harus diatur dengan highlightPostTag. Defaultnya adalah <em>.
minimumCoverage	number (double)	Angka antara 0 dan 100 yang menunjukkan persentase indeks yang harus dicakup oleh kueri pencarian agar kueri dilaporkan berhasil. 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 menilai. Menggunakan statistik penilaian global dapat meningkatkan latensi kueri pencarian.
search	string	Ekspresi kueri pencarian teks lengkap; Gunakan "*" atau hilangkan parameter ini untuk mencocokkan 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 (int32) minimum: 700	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 dan peringkat dasar, 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 (int32)	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 tipe ejaan yang akan digunakan untuk mengoreksi ejaan istilah kueri pencarian individual.
top	integer (int32)	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

Objek

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 (double)	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 (double)	Skor relevansi dokumen dibandingkan dengan dokumen lain yang dikembalikan oleh kueri.

SemanticDebugInfo

Objek

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

Enumerasi

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

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

SemanticErrorReason

Enumerasi

Alasan bahwa respons parsial dikembalikan untuk permintaan peringkat semantik.

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

SemanticFieldState

Enumerasi

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

Nilai	Deskripsi
used	Bidang ini sepenuhnya digunakan untuk pengayaan semantik.
unused	Bidang ini tidak digunakan untuk pengayaan semantik.
partial	Bidang ini sebagian digunakan untuk pengayaan semantik.

SemanticSearchResultsType

Enumerasi

Jenis respons parsial yang dikembalikan untuk permintaan peringkat semantik.

Nilai	Deskripsi
baseResults	Hasil tanpa pengayaan semantik atau reranking.
rerankedResults	Hasil telah dirankam ulang dengan model reranker dan akan menyertakan keterangan semantik. Mereka tidak akan menyertakan jawaban, sorotan jawaban, atau sorotan keterangan.

Speller

Enumerasi

Tingkatkan pengenalan pencarian dengan mengoreksi istilah kueri pencarian individual.

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

VectorFilterMode

Enumerasi

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

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

VectorizableTextQuery

Objek

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	Daftar nama bidang yang dipisahkan koma yang akan disertakan dalam pencarian vektor. Setiap bidang harus berupa jenis vektor yang valid, seperti Collection(Edm.Single). Jika beberapa bidang diberikan, vektor akan digunakan untuk menemukan kecocokan terdekat di semua bidang.
k	integer (int32)	Jumlah tetangga terdekat untuk kembali sebagai hit teratas.
kind	string: text	Jenis kueri vektor yang sedang dilakukan.
oversampling	number (double)	Faktor pengambilan sampel berlebih. Nilai minimum adalah 1. Ini mengambil alih parameter 'defaultOversampling' yang dikonfigurasi dalam definisi indeks. Ini hanya dapat diatur ketika 'rerankWithOriginalVectors' benar. Parameter ini hanya diizinkan ketika metode kompresi digunakan pada bidang vektor yang mendasar.
text	string	Teks yang akan di-vektorisasi untuk melakukan kueri pencarian vektor.

VectorQueryKind

Enumerasi

Jenis kueri vektor yang sedang dilakukan.

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