Documents - Search Get

Referensi

Layanan:: Search Service

Versi API:: 2024-07-01

Mencari dokumen dalam indeks.

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

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}&searchFields={searchFields}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&api-version=2024-07-01&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}

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`. Default ke `None`.
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. Defaultnya adalah 100.
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).
semanticMaxWaitInMilliseconds	query		integer int32	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 '_'.

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

SearchIndexSearchDocumentsSemanticGet

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&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2024-07-01

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"
    }
  ]
}

SearchIndexSearchDocumentsSemanticGet

Permintaan sampel

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2024-07-01&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}

Respon sampel

Kode status:: 200

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ]
}

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 `semantic`.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons 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.
QueryType	Menentukan sintaks kueri pencarian. Defaultnya adalah 'sederhana'. Gunakan 'penuh' jika kueri Anda menggunakan sintaks kueri Lucene.
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.
SemanticErrorMode	Memungkinkan pengguna untuk memilih apakah panggilan semantik harus gagal sepenuhnya (perilaku default/ saat ini), atau mengembalikan hasil parsial.
SemanticErrorReason	Alasan bahwa respons parsial dikembalikan untuk permintaan peringkat semantik.
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 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	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 semantic.

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.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

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

ErrorDetail

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

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

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 kembalikan keterangan untuk kueri.

QueryType

Menentukan sintaks kueri pencarian. Defaultnya adalah 'sederhana'. Gunakan 'penuh' jika kueri Anda menggunakan sintaks kueri Lucene.

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 jenis Collection(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.
oversampling	number	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[]	Representasi vektor kueri pencarian.
weight	number	Bobot relatif kueri vektor jika dibandingkan dengan kueri vektor lain dan/atau kueri teks dalam permintaan pencarian yang sama. Nilai ini digunakan saat menggabungkan hasil beberapa daftar peringkat yang dihasilkan oleh kueri vektor yang berbeda dan/atau hasil yang diambil melalui kueri teks. Semakin tinggi bobotnya, semakin tinggi dokumen yang cocok dengan kueri tersebut akan berada di peringkat akhir. Defaultnya adalah 1,0 dan nilainya harus berupa angka positif yang lebih besar dari nol.

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.

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 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	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

Menentukan apakah salah satu 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.
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	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. 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.
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 (perilaku default/ saat ini), atau mengembalikan hasil parsial.
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 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	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.
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' untuk indeks baru.
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.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.

SemanticErrorMode

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

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 proses semantik gagal.

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 dirankam ulang dengan model reranker dan akan menyertakan keterangan semantik. Mereka tidak akan menyertakan jawaban, sorotan jawaban, atau sorotan keterangan.

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 lebih sedikit hasil 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 jenis Collection(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.
oversampling	number	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.
weight	number	Bobot relatif kueri vektor jika dibandingkan dengan kueri vektor lain dan/atau kueri teks dalam permintaan pencarian yang sama. Nilai ini digunakan saat menggabungkan hasil beberapa daftar peringkat yang dihasilkan oleh kueri vektor yang berbeda dan/atau hasil yang diambil melalui kueri teks. Semakin tinggi bobotnya, semakin tinggi dokumen yang cocok dengan kueri tersebut akan berada di peringkat akhir. Defaultnya adalah 1,0 dan nilainya harus berupa angka positif yang lebih besar dari nol.

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.

Bagikan melalui

Documents - Search Get

Parameter URI

Header Permintaan

Respons

Contoh

SearchIndexSearchDocumentsGet

Permintaan sampel

Respon sampel

SearchIndexSearchDocumentsSemanticGet

Permintaan sampel

Respon sampel

Definisi

AnswerResult

CaptionResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorizableTextQuery

VectorQueryKind

Sumber Daya Tambahan: