SimpleField interface

Paket:

@azure/search-documents

Bir alanın adını, veri türünü ve arama davranışını açıklayan dizin tanımındaki bir alanı temsil eder.

Özellikler

analyzerName	Alan için kullanılacak çözümleyicinin adı. Bu seçenek yalnızca aranabilir alanlarla kullanılabilir ve searchAnalyzer veya indexAnalyzer ile birlikte ayarlanamaz. Çözümleyici seçildikten sonra alan için değiştirilemez.
facetable	Model sorgularında alana başvurulmasının etkinleştirilip etkinleştirilmeymeyeceğini gösteren değer. Genellikle kategoriye göre isabet sayısını içeren arama sonuçlarının bir sunumunda kullanılır (örneğin, dijital kameraları arayın ve markaya göre, megapiksellere, fiyata vb. göre isabetleri görün). Edm.GeographyPoint veya Collection(Edm.GeographyPoint) türünde alanlar modellenemez. Varsayılan değer false'tur.
filterable	$filter sorgularda alana başvurulmasının etkinleştirilip etkinleştirilmeymeyeceğini gösteren değer. filterable, dizelerin işlenme biçiminde aranabilirden farklıdır. Filtrelenebilir Edm.String veya Collection(Edm.String) türündeki alanlarda sözcük kesme işlemi yapılmaz, bu nedenle karşılaştırmalar yalnızca tam eşleşmeler içindir. Örneğin, f alanını "güneşli gün" olarak ayarlarsanız, $filter=f eq 'güneşli' eşleşme bulamaz, ancak $filter=f eq 'güneşli gün'. Varsayılan değer false'tur.
hidden	Alanın bir arama sonucunda döndürülebilir olup olmadığını gösteren değer. Bir alanı (örneğin, kenar boşluğu) filtre, sıralama veya puanlama mekanizması olarak kullanmak ancak alanın son kullanıcıya görünür olmasını istemiyorsanız bu seçeneği devre dışı bırakabilirsiniz. Anahtar alanları için bu özellik false olmalıdır. Bu özellik mevcut alanlarda değiştirilebilir. Bu özelliğin etkinleştirilmesi dizin depolama gereksinimlerinde herhangi bir artışa neden olmaz. Vektör alanları için varsayılan değer true, aksi takdirde yanlıştır.
indexAnalyzerName	Alan için dizin oluşturma zamanında kullanılan çözümleyicinin adı. Bu seçenek yalnızca aranabilir alanlarla kullanılabilir. SearchAnalyzer ile birlikte ayarlanmalıdır ve çözümleyici seçeneğiyle birlikte ayarlanamaz. Bu özellik bir dil çözümleyicisinin adına ayarlanamaz; dil çözümleyicisine ihtiyacınız varsa çözümleyici özelliğini kullanın. Çözümleyici seçildikten sonra alan için değiştirilemez.
key	Alanın dizindeki belgeleri benzersiz olarak tanımlayıp tanımlamadığını gösteren değer. Her dizinde tam olarak bir üst düzey alan anahtar alanı olarak seçilmeli ve Edm.String türünde olmalıdır. Önemli alanlar, belgeleri doğrudan aramak ve belirli belgeleri güncelleştirmek veya silmek için kullanılabilir. Varsayılan değer false'tur.
name	Dizin veya üst alanın alan koleksiyonu içinde benzersiz olması gereken alanın adı.
searchable	Alanın tam metin aranabilir olup olmadığını gösteren değer. Bu, dizin oluşturma sırasında sözcük kesme gibi bir analizden geçeceği anlamına gelir. Aranabilir bir alanı "güneşli gün" gibi bir değere ayarlarsanız, dahili olarak "güneşli" ve "gün" belirteçlerine bölünür. Bu, bu terimler için tam metin aramaları sağlar. Edm.String veya Collection(Edm.String) türündeki alanlar varsayılan olarak aranabilir. Bu özellik, diğer dize olmayan veri türlerinin basit alanları için false olmalıdır. Not: Aranabilir alanlar, tam metin aramaları için alan değerinin ek belirteçli sürümlerini barındırmak için dizininizde fazladan alan kullanır. Dizininizde yer kazanmak istiyorsanız ve aramalara bir alanın eklenmesi gerekmiyorsa, aranabilir değerini false olarak ayarlayın. Varsayılan değer false'tur.
searchAnalyzerName	Alan için arama zamanında kullanılan çözümleyicinin adı. Bu seçenek yalnızca aranabilir alanlarla kullanılabilir. indexAnalyzerName ile birlikte ayarlanmalıdır ve analyzerName seçeneğiyle birlikte ayarlanamaz. Bu özellik bir dil çözümleyicisinin adına ayarlanamaz; dil çözümleyicisine ihtiyacınız varsa bunun yerine analyzerName özelliğini kullanın. Bu çözümleyici mevcut bir alanda güncelleştirilebilir.
sortable	$orderby ifadelerinde alana başvurulmasının etkinleştirilip etkinleştirilmeymeyeceğini gösteren değer. Varsayılan olarak, arama altyapısı sonuçları puana göre sıralar, ancak birçok deneyimde kullanıcılar belgelerdeki alanlara göre sıralamak isteyecektir. Basit bir alan yalnızca tek değerliyse sıralanabilir (üst belge kapsamında tek bir değere sahiptir). Basit koleksiyon alanları çok değerli olduğundan sıralanabilir olamaz. Karmaşık koleksiyonların basit alt alanları da çok değerlidir ve bu nedenle sıralanamaz. Bu, ister anlık bir üst alan ister bir üst alan olsun, karmaşık koleksiyondur. Varsayılan değer false'tur.
stored	Alanın bir arama sonucunda döndürülmek üzere diskte ayrı olarak kalıcı olup olmayacağını gösteren sabit bir değer. Depolama ek yükünden tasarruf etmek için arama yanıtında alan içeriğini döndürmeyi planlamıyorsanız bu seçeneği devre dışı bırakabilirsiniz. Bu yalnızca dizin oluşturma sırasında ve yalnızca vektör alanları için ayarlanabilir. Bu özellik mevcut alanlar için değiştirilemez veya yeni alanlar için false olarak ayarlanamaz. Bu özellik false olarak ayarlanırsa, 'hidden' özelliği 'true' olarak ayarlanmalıdır. Bu özellik, anahtar alanlar, yeni alanlar ve vektör olmayan alanlar için false veya unset olmalıdır. Bu özelliğin devre dışı bırakılması dizin depolama gereksinimlerini azaltır.
synonymMapNames	Bu alanla ilişkilendirilecek eş anlamlı eşlemelerinin adlarının listesi. Bu seçenek yalnızca aranabilir alanlarla kullanılabilir. Şu anda alan başına yalnızca bir eş anlamlı eşleme desteklenir. Bir alana eş anlamlı eşlem atamak, bu alanı hedefleyen sorgu terimlerinin eş anlamlı eşlemedeki kurallar kullanılarak sorgu zamanında genişletilmesini sağlar. Bu öznitelik mevcut alanlarda değiştirilebilir.
type	Alanın veri türü.
vectorEncodingFormat	Alan içeriğini yorumlamak için kodlama biçimi.
vectorSearchDimensions	Vektör alanının boyutsallığı.
vectorSearchProfileName	Vektör alanında arama yaparken kullanılacak algoritmayı ve vektörleştiriciyi belirten vektör arama profilinin adı.

Özellik Ayrıntıları

analyzerName

Alan için kullanılacak çözümleyicinin adı. Bu seçenek yalnızca aranabilir alanlarla kullanılabilir ve searchAnalyzer veya indexAnalyzer ile birlikte ayarlanamaz. Çözümleyici seçildikten sonra alan için değiştirilemez.

analyzerName?: string

Özellik Değeri

string

facetable

Model sorgularında alana başvurulmasının etkinleştirilip etkinleştirilmeymeyeceğini gösteren değer. Genellikle kategoriye göre isabet sayısını içeren arama sonuçlarının bir sunumunda kullanılır (örneğin, dijital kameraları arayın ve markaya göre, megapiksellere, fiyata vb. göre isabetleri görün). Edm.GeographyPoint veya Collection(Edm.GeographyPoint) türünde alanlar modellenemez. Varsayılan değer false'tur.

facetable?: boolean

Özellik Değeri

boolean

filterable

$filter sorgularda alana başvurulmasının etkinleştirilip etkinleştirilmeymeyeceğini gösteren değer. filterable, dizelerin işlenme biçiminde aranabilirden farklıdır. Filtrelenebilir Edm.String veya Collection(Edm.String) türündeki alanlarda sözcük kesme işlemi yapılmaz, bu nedenle karşılaştırmalar yalnızca tam eşleşmeler içindir. Örneğin, f alanını "güneşli gün" olarak ayarlarsanız, $filter=f eq 'güneşli' eşleşme bulamaz, ancak $filter=f eq 'güneşli gün'. Varsayılan değer false'tur.

filterable?: boolean

Özellik Değeri

boolean

hidden

Alanın bir arama sonucunda döndürülebilir olup olmadığını gösteren değer. Bir alanı (örneğin, kenar boşluğu) filtre, sıralama veya puanlama mekanizması olarak kullanmak ancak alanın son kullanıcıya görünür olmasını istemiyorsanız bu seçeneği devre dışı bırakabilirsiniz. Anahtar alanları için bu özellik false olmalıdır. Bu özellik mevcut alanlarda değiştirilebilir. Bu özelliğin etkinleştirilmesi dizin depolama gereksinimlerinde herhangi bir artışa neden olmaz. Vektör alanları için varsayılan değer true, aksi takdirde yanlıştır.

hidden?: boolean

Özellik Değeri

boolean

indexAnalyzerName

Alan için dizin oluşturma zamanında kullanılan çözümleyicinin adı. Bu seçenek yalnızca aranabilir alanlarla kullanılabilir. SearchAnalyzer ile birlikte ayarlanmalıdır ve çözümleyici seçeneğiyle birlikte ayarlanamaz. Bu özellik bir dil çözümleyicisinin adına ayarlanamaz; dil çözümleyicisine ihtiyacınız varsa çözümleyici özelliğini kullanın. Çözümleyici seçildikten sonra alan için değiştirilemez.

indexAnalyzerName?: string

Özellik Değeri

string

key

Alanın dizindeki belgeleri benzersiz olarak tanımlayıp tanımlamadığını gösteren değer. Her dizinde tam olarak bir üst düzey alan anahtar alanı olarak seçilmeli ve Edm.String türünde olmalıdır. Önemli alanlar, belgeleri doğrudan aramak ve belirli belgeleri güncelleştirmek veya silmek için kullanılabilir. Varsayılan değer false'tur.

key?: boolean

Özellik Değeri

boolean

name

Dizin veya üst alanın alan koleksiyonu içinde benzersiz olması gereken alanın adı.

name: string

Özellik Değeri

string

searchable

Alanın tam metin aranabilir olup olmadığını gösteren değer. Bu, dizin oluşturma sırasında sözcük kesme gibi bir analizden geçeceği anlamına gelir. Aranabilir bir alanı "güneşli gün" gibi bir değere ayarlarsanız, dahili olarak "güneşli" ve "gün" belirteçlerine bölünür. Bu, bu terimler için tam metin aramaları sağlar. Edm.String veya Collection(Edm.String) türündeki alanlar varsayılan olarak aranabilir. Bu özellik, diğer dize olmayan veri türlerinin basit alanları için false olmalıdır. Not: Aranabilir alanlar, tam metin aramaları için alan değerinin ek belirteçli sürümlerini barındırmak için dizininizde fazladan alan kullanır. Dizininizde yer kazanmak istiyorsanız ve aramalara bir alanın eklenmesi gerekmiyorsa, aranabilir değerini false olarak ayarlayın. Varsayılan değer false'tur.

searchable?: boolean

Özellik Değeri

boolean

searchAnalyzerName

Alan için arama zamanında kullanılan çözümleyicinin adı. Bu seçenek yalnızca aranabilir alanlarla kullanılabilir. indexAnalyzerName ile birlikte ayarlanmalıdır ve analyzerName seçeneğiyle birlikte ayarlanamaz. Bu özellik bir dil çözümleyicisinin adına ayarlanamaz; dil çözümleyicisine ihtiyacınız varsa bunun yerine analyzerName özelliğini kullanın. Bu çözümleyici mevcut bir alanda güncelleştirilebilir.

searchAnalyzerName?: string

Özellik Değeri

string

sortable

$orderby ifadelerinde alana başvurulmasının etkinleştirilip etkinleştirilmeymeyeceğini gösteren değer. Varsayılan olarak, arama altyapısı sonuçları puana göre sıralar, ancak birçok deneyimde kullanıcılar belgelerdeki alanlara göre sıralamak isteyecektir. Basit bir alan yalnızca tek değerliyse sıralanabilir (üst belge kapsamında tek bir değere sahiptir). Basit koleksiyon alanları çok değerli olduğundan sıralanabilir olamaz. Karmaşık koleksiyonların basit alt alanları da çok değerlidir ve bu nedenle sıralanamaz. Bu, ister anlık bir üst alan ister bir üst alan olsun, karmaşık koleksiyondur. Varsayılan değer false'tur.

sortable?: boolean

Özellik Değeri

boolean

stored

Alanın bir arama sonucunda döndürülmek üzere diskte ayrı olarak kalıcı olup olmayacağını gösteren sabit bir değer. Depolama ek yükünden tasarruf etmek için arama yanıtında alan içeriğini döndürmeyi planlamıyorsanız bu seçeneği devre dışı bırakabilirsiniz. Bu yalnızca dizin oluşturma sırasında ve yalnızca vektör alanları için ayarlanabilir. Bu özellik mevcut alanlar için değiştirilemez veya yeni alanlar için false olarak ayarlanamaz. Bu özellik false olarak ayarlanırsa, 'hidden' özelliği 'true' olarak ayarlanmalıdır. Bu özellik, anahtar alanlar, yeni alanlar ve vektör olmayan alanlar için false veya unset olmalıdır. Bu özelliğin devre dışı bırakılması dizin depolama gereksinimlerini azaltır.

stored?: boolean

Özellik Değeri

boolean

synonymMapNames

Bu alanla ilişkilendirilecek eş anlamlı eşlemelerinin adlarının listesi. Bu seçenek yalnızca aranabilir alanlarla kullanılabilir. Şu anda alan başına yalnızca bir eş anlamlı eşleme desteklenir. Bir alana eş anlamlı eşlem atamak, bu alanı hedefleyen sorgu terimlerinin eş anlamlı eşlemedeki kurallar kullanılarak sorgu zamanında genişletilmesini sağlar. Bu öznitelik mevcut alanlarda değiştirilebilir.

synonymMapNames?: string[]

Özellik Değeri

string[]

type

Alanın veri türü.

type: SearchFieldDataType

Özellik Değeri

SearchFieldDataType

vectorEncodingFormat

Alan içeriğini yorumlamak için kodlama biçimi.

vectorEncodingFormat?: string

Özellik Değeri

string

vectorSearchDimensions

Vektör alanının boyutsallığı.

vectorSearchDimensions?: number

Özellik Değeri

number

vectorSearchProfileName

Vektör alanında arama yaparken kullanılacak algoritmayı ve vektörleştiriciyi belirten vektör arama profilinin adı.

vectorSearchProfileName?: string

Özellik Değeri

string