SearchDocumentsPageResult interface

Paket:

@azure/search-documents

Respons yang berisi hasil halaman pencarian dari indeks.

Memperluas

SearchDocumentsResultBase

Properti

continuationToken	Token yang digunakan untuk mengambil halaman hasil berikutnya saat server memberlakukan penomoran halaman.
results	Urutan hasil yang dikembalikan oleh kueri. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

Properti yang Diwariskan

answers	Hasil kueri jawaban untuk operasi pencarian; null jika parameter kueri jawaban tidak ditentukan atau diatur ke 'none'. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
count	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. Hal ini dapat terjadi jika Anda menggunakan parameter $top atau $skip, atau jika Azure AI Search tidak dapat mengembalikan semua dokumen yang diminta dalam satu respons Pencarian. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
coverage	Nilai yang menunjukkan persentase indeks yang disertakan dalam kueri, atau null jika minimumCoverage tidak ditentukan dalam permintaan. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
debugInfo	Informasi debug yang berlaku untuk hasil pencarian secara keseluruhan. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
facets	Hasil kueri faset untuk operasi pencarian, diatur sebagai kumpulan wadah untuk setiap bidang tersaring; null jika kueri tidak menyertakan ekspresi faset apa pun. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
semanticErrorReason	Alasan bahwa respons parsial dikembalikan untuk permintaan pencarian semantik. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
semanticQueryRewritesResultType	Jenis penulisan ulang kueri yang digunakan untuk mengambil dokumen. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
semanticSearchResultsType	Jenis respons parsial yang dikembalikan untuk permintaan pencarian semantik. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

Detail Properti

continuationToken

Token yang digunakan untuk mengambil halaman hasil berikutnya saat server memberlakukan penomoran halaman.

continuationToken?: string

Nilai Properti

string

results

Urutan hasil yang dikembalikan oleh kueri. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

results: SearchResult<TModel, TFields>[]

Nilai Properti

SearchResult<TModel, TFields>[]

Detail Properti yang Diwariskan

answers

Hasil kueri jawaban untuk operasi pencarian; null jika parameter kueri jawaban tidak ditentukan atau diatur ke 'none'. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

answers?: QueryAnswerResult[]

Nilai Properti

QueryAnswerResult[]

Diwarisi dariSearchDocumentsResultBase.answers

count

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. Hal ini dapat terjadi jika Anda menggunakan parameter $top atau $skip, atau jika Azure AI Search tidak dapat mengembalikan semua dokumen yang diminta dalam satu respons Pencarian. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

count?: number

Nilai Properti

number

Diwarisi dariSearchDocumentsResultBase.count

coverage

Nilai yang menunjukkan persentase indeks yang disertakan dalam kueri, atau null jika minimumCoverage tidak ditentukan dalam permintaan. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

coverage?: number

Nilai Properti

number

Diwarisi dariSearchDocumentsResultBase.coverage

debugInfo

Informasi debug yang berlaku untuk hasil pencarian secara keseluruhan. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

debugInfo?: DebugInfo

Nilai Properti

DebugInfo

Diwarisi dariSearchDocumentsResultBase.debugInfo

facets

Hasil kueri faset untuk operasi pencarian, diatur sebagai kumpulan wadah untuk setiap bidang tersaring; null jika kueri tidak menyertakan ekspresi faset apa pun. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

facets?: {[propertyName: string]: FacetResult[]}

Nilai Properti

{[propertyName: string]: FacetResult[]}

Diwarisi dariSearchDocumentsResultBase.facets

semanticErrorReason

Alasan bahwa respons parsial dikembalikan untuk permintaan pencarian semantik. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

semanticErrorReason?: "maxWaitExceeded" | "capacityOverloaded" | "transient"

Nilai Properti

"maxWaitExceeded" | "capacityOverloaded" | "transient"

Diwarisi dariSearchDocumentsResultBase.semanticErrorReason

semanticQueryRewritesResultType

Jenis penulisan ulang kueri yang digunakan untuk mengambil dokumen. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

semanticQueryRewritesResultType?: string

Nilai Properti

string

Diwarisi dariSearchDocumentsResultBase.semanticQueryRewritesResultType

semanticSearchResultsType

Jenis respons parsial yang dikembalikan untuk permintaan pencarian semantik. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

semanticSearchResultsType?: "baseResults" | "rerankedResults"

Nilai Properti

"baseResults" | "rerankedResults"

Diwarisi dariSearchDocumentsResultBase.semanticSearchResultsType