BaseSearchRequestOptions interface

Paket:
@azure/search-documents

Filtreleme, sıralama, yüz tanıma, sayfalama ve diğer arama sorgusu davranışları için parametreler.

Özellikler

facets

Arama sorgusuna uygulanacak model ifadelerinin listesi. Her model ifadesi, isteğe bağlı olarak virgülle ayrılmış ad:değer çiftleri listesi içeren bir alan adı içerir.
filter

Arama sorgusuna uygulanacak OData $filter ifadesi.
highlightFields

Vurgulama vurguları için kullanılacak alan adlarının virgülle ayrılmış listesi. Yalnızca aranabilir alanlar isabet vurgulama için kullanılabilir.
highlightPostTag

Vurgulamalara isabet etmek için eklenen bir dize etiketi. HighlightPreTag ile ayarlanmalıdır. Varsayılan değer </em>değeridir.
highlightPreTag

Vurgulamalara basmak için önceden eklenen bir dize etiketi. highlightPostTag ile ayarlanmalıdır. Varsayılan değer, em<>.
hybridSearch

Karma arama davranışlarını yapılandırmak için sorgu parametreleri.
includeTotalCount

Toplam sonuç sayısının getirilip getirilmeyeceğini belirten bir değer. Varsayılan değer false'tur. Bu değeri true olarak ayarlamak performansı etkileyebilir. Döndürülen sayın bir yaklaşık değer olduğunu unutmayın.
minimumCoverage

0 ile 100 arasında bir sayı, sorgunun başarılı olarak bildirilebilmesi için bir arama sorgusu tarafından kapsanması gereken dizinin yüzdesini gösterir. Bu parametre, yalnızca bir çoğaltması olan hizmetler için bile arama kullanılabilirliğini sağlamak için yararlı olabilir. Varsayılan değer 100'dür.
orderBy

Sonuçların sıralandığı OData $orderby ifadelerinin listesi. Her ifade bir alan adı veya geo.distance() veya search.score() işlevlerine yapılan bir çağrı olabilir. Her ifadeyi artanı belirtmek için asc, azalanı belirtmek için desc takip edebilir. Varsayılan değer artan düzendir. Bağlar, belgelerin eşleşme puanlarıyla bozulur. $orderby belirtilmezse, varsayılan sıralama düzeni belge eşleşme puanına göre azalan düzendedir. En fazla 32 $orderby yan tümcesi olabilir.
queryLanguage

Sorgunun dili.
queryType

Arama sorgusunun söz dizimini belirten değer. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu söz dizimini kullanıyorsa 'full' kullanın. Olası değerler şunlardır: 'simple', 'full', 'semantic'
scoringParameters

Ad-değer biçimi kullanılarak puanlama işlevlerinde (örneğin, referencePointParameter) kullanılacak parametre değerlerinin listesi. Örneğin, puanlama profili 'mylocation' adlı bir parametreye sahip bir işlev tanımlarsa, parametre dizesi "mylocation--122.2,44.8" (tırnak işaretleri olmadan) olur.
scoringProfile

Sonuçları sıralamak için eşleşen belgeler için maç puanlarını değerlendirmek için bir puanlama profilinin adı.
scoringStatistics

Daha tutarlı puanlama için puanlama istatistiklerini (belge sıklığı gibi) genel olarak mı yoksa daha düşük gecikme süresi için yerel olarak mı hesaplamak istediğimizi belirten bir değer. Olası değerler şunlardır: 'Local', 'Global'
searchFields

Tam metin aramasının kapsamına dahil edilen alan adlarının virgülle ayrılmış listesi. Tam Lucene sorgusunda alanlı arama (fieldName:searchExpression) kullanıldığında, her alanlı arama ifadesinin alan adları bu parametrede listelenen alan adlarından önceliklidir.
searchMode

Belgeyi eşleşme olarak saymak için arama terimlerinden herhangi birinin veya tümünün eşleştirilip eşleştirilmeyeceğini belirten bir değer. Olası değerler şunlardır: 'any', 'all'
select

Alınacak alanların listesi. Belirtilmezse, şemada alınabilir olarak işaretlenmiş tüm alanlar eklenir.
sessionId

Daha tutarlı sonuçlar elde etmeye yardımcı olabilecek yapışkan bir oturum oluşturmak için kullanılacak değer. Aynı sessionId kullanıldığı sürece, aynı çoğaltma kümesini hedeflemek için en iyi girişimde bulunulacaktır. Aynı sessionID değerlerini tekrar tekrar yeniden kullanmanın çoğaltmalar arasında isteklerin yük dengelemesini engelleyeceğine ve arama hizmetinin performansını olumsuz etkileyebileceğine dikkat edin. sessionId olarak kullanılan değer '_' karakteriyle başlayamaz.
skip

Atlana arama sonuçlarının sayısı. Bu değer 100.000'den büyük olamaz. Belgeleri sırayla taramanız gerekiyorsa ancak bu sınırlama nedeniyle atlamayı kullanamıyorsanız, tamamen sıralı bir anahtarda orderby kullanmayı ve bunun yerine bir aralık sorgusuyla filtrelemeyi göz önünde bulundurun.
speller

Tek tek arama sorgusu terimlerini yazım düzelterek arama geri çağırmayı geliştirin.
top

Alınacak arama sonuçlarının sayısı. Bu, arama sonuçlarının istemci tarafı disk belleğini uygulamak için $skip ile birlikte kullanılabilir. Sunucu tarafı sayfalama nedeniyle sonuçlar kesilirse yanıt, sonraki sonuç sayfası için başka bir Arama isteği göndermek için kullanılabilecek bir devam belirteci içerir.
vectorSearchOptions

Vektör arama sorguları için seçenekleri tanımlar
xMsEnableElevatedRead

Sorgu işlemi için belge düzeyi izin denetimlerini atlayan yükseltilmiş okumayı etkinleştiren bir değer.
xMsQuerySourceAuthorization

Sorgunun yürütüldüğü kullanıcıyı tanımlayan belirteç. Bu belirteç, belgelerde güvenlik kısıtlamalarını zorlamak için kullanılır.

Özellik Ayrıntıları

facets

Arama sorgusuna uygulanacak model ifadelerinin listesi. Her model ifadesi, isteğe bağlı olarak virgülle ayrılmış ad:değer çiftleri listesi içeren bir alan adı içerir.

facets?: string[]

Özellik Değeri

string[]

filter

Arama sorgusuna uygulanacak OData $filter ifadesi.

filter?: string

Özellik Değeri

string

highlightFields

Vurgulama vurguları için kullanılacak alan adlarının virgülle ayrılmış listesi. Yalnızca aranabilir alanlar isabet vurgulama için kullanılabilir.

highlightFields?: string

Özellik Değeri

string

highlightPostTag

Vurgulamalara isabet etmek için eklenen bir dize etiketi. HighlightPreTag ile ayarlanmalıdır. Varsayılan değer </em>değeridir.

highlightPostTag?: string

Özellik Değeri

string

highlightPreTag

Vurgulamalara basmak için önceden eklenen bir dize etiketi. highlightPostTag ile ayarlanmalıdır. Varsayılan değer, em<>.

highlightPreTag?: string

Özellik Değeri

string

hybridSearch

Karma arama davranışlarını yapılandırmak için sorgu parametreleri.

hybridSearch?: HybridSearch

Özellik Değeri

HybridSearchOptions

includeTotalCount

Toplam sonuç sayısının getirilip getirilmeyeceğini belirten bir değer. Varsayılan değer false'tur. Bu değeri true olarak ayarlamak performansı etkileyebilir. Döndürülen sayın bir yaklaşık değer olduğunu unutmayın.

includeTotalCount?: boolean

Özellik Değeri

boolean

minimumCoverage

0 ile 100 arasında bir sayı, sorgunun başarılı olarak bildirilebilmesi için bir arama sorgusu tarafından kapsanması gereken dizinin yüzdesini gösterir. Bu parametre, yalnızca bir çoğaltması olan hizmetler için bile arama kullanılabilirliğini sağlamak için yararlı olabilir. Varsayılan değer 100'dür.

minimumCoverage?: number

Özellik Değeri

number

orderBy

Sonuçların sıralandığı OData $orderby ifadelerinin listesi. Her ifade bir alan adı veya geo.distance() veya search.score() işlevlerine yapılan bir çağrı olabilir. Her ifadeyi artanı belirtmek için asc, azalanı belirtmek için desc takip edebilir. Varsayılan değer artan düzendir. Bağlar, belgelerin eşleşme puanlarıyla bozulur. $orderby belirtilmezse, varsayılan sıralama düzeni belge eşleşme puanına göre azalan düzendedir. En fazla 32 $orderby yan tümcesi olabilir.

orderBy?: string[]

Özellik Değeri

string[]

queryLanguage

Sorgunun dili.

queryLanguage?: string

Özellik Değeri

string

queryType

Arama sorgusunun söz dizimini belirten değer. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu söz dizimini kullanıyorsa 'full' kullanın. Olası değerler şunlardır: 'simple', 'full', 'semantic'

queryType?: QueryType

Özellik Değeri

QueryType

scoringParameters

Ad-değer biçimi kullanılarak puanlama işlevlerinde (örneğin, referencePointParameter) kullanılacak parametre değerlerinin listesi. Örneğin, puanlama profili 'mylocation' adlı bir parametreye sahip bir işlev tanımlarsa, parametre dizesi "mylocation--122.2,44.8" (tırnak işaretleri olmadan) olur.

scoringParameters?: string[]

Özellik Değeri

string[]

scoringProfile

Sonuçları sıralamak için eşleşen belgeler için maç puanlarını değerlendirmek için bir puanlama profilinin adı.

scoringProfile?: string

Özellik Değeri

string

scoringStatistics

Daha tutarlı puanlama için puanlama istatistiklerini (belge sıklığı gibi) genel olarak mı yoksa daha düşük gecikme süresi için yerel olarak mı hesaplamak istediğimizi belirten bir değer. Olası değerler şunlardır: 'Local', 'Global'

scoringStatistics?: ScoringStatistics

Özellik Değeri

ScoringStatistics

searchFields

Tam metin aramasının kapsamına dahil edilen alan adlarının virgülle ayrılmış listesi. Tam Lucene sorgusunda alanlı arama (fieldName:searchExpression) kullanıldığında, her alanlı arama ifadesinin alan adları bu parametrede listelenen alan adlarından önceliklidir.

searchFields?: SearchFieldArray<TModel>

Özellik Değeri

SearchFieldArray<TModel>

searchMode

Belgeyi eşleşme olarak saymak için arama terimlerinden herhangi birinin veya tümünün eşleştirilip eşleştirilmeyeceğini belirten bir değer. Olası değerler şunlardır: 'any', 'all'

searchMode?: SearchMode

Özellik Değeri

SearchMode

select

Alınacak alanların listesi. Belirtilmezse, şemada alınabilir olarak işaretlenmiş tüm alanlar eklenir.

select?: SelectArray<TFields>

Özellik Değeri

SelectArray<TFields>

sessionId

Daha tutarlı sonuçlar elde etmeye yardımcı olabilecek yapışkan bir oturum oluşturmak için kullanılacak değer. Aynı sessionId kullanıldığı sürece, aynı çoğaltma kümesini hedeflemek için en iyi girişimde bulunulacaktır. Aynı sessionID değerlerini tekrar tekrar yeniden kullanmanın çoğaltmalar arasında isteklerin yük dengelemesini engelleyeceğine ve arama hizmetinin performansını olumsuz etkileyebileceğine dikkat edin. sessionId olarak kullanılan değer '_' karakteriyle başlayamaz.

sessionId?: string

Özellik Değeri

string

skip

Atlana arama sonuçlarının sayısı. Bu değer 100.000'den büyük olamaz. Belgeleri sırayla taramanız gerekiyorsa ancak bu sınırlama nedeniyle atlamayı kullanamıyorsanız, tamamen sıralı bir anahtarda orderby kullanmayı ve bunun yerine bir aralık sorgusuyla filtrelemeyi göz önünde bulundurun.

skip?: number

Özellik Değeri

number

speller

Tek tek arama sorgusu terimlerini yazım düzelterek arama geri çağırmayı geliştirin.

speller?: string

Özellik Değeri

string

top

Alınacak arama sonuçlarının sayısı. Bu, arama sonuçlarının istemci tarafı disk belleğini uygulamak için $skip ile birlikte kullanılabilir. Sunucu tarafı sayfalama nedeniyle sonuçlar kesilirse yanıt, sonraki sonuç sayfası için başka bir Arama isteği göndermek için kullanılabilecek bir devam belirteci içerir.

top?: number

Özellik Değeri

number

vectorSearchOptions

Vektör arama sorguları için seçenekleri tanımlar

vectorSearchOptions?: VectorSearchOptions<TModel>

Özellik Değeri

VectorSearchOptions<TModel>

xMsEnableElevatedRead

Sorgu işlemi için belge düzeyi izin denetimlerini atlayan yükseltilmiş okumayı etkinleştiren bir değer.

xMsEnableElevatedRead?: boolean

Özellik Değeri

boolean

xMsQuerySourceAuthorization

Sorgunun yürütüldüğü kullanıcıyı tanımlayan belirteç. Bu belirteç, belgelerde güvenlik kısıtlamalarını zorlamak için kullanılır.

xMsQuerySourceAuthorization?: string

Özellik Değeri

string