SimpleField interface

Pakiet:

@azure/search-documents

Reprezentuje pole w definicji indeksu, które opisuje nazwę, typ danych i zachowanie wyszukiwania pola.

Właściwości

analyzerName	Nazwa analizatora języka do użycia dla pola. Tej opcji można używać tylko z polami z możliwością wyszukiwania i nie można jej ustawić razem z parametrem searchAnalyzer lub indexAnalyzer. Po wybraniu analizatora nie można go zmienić dla pola. KnownAnalyzerNames to wyliczenie zawierające wbudowane nazwy analizatorów.
facetable	Wartość wskazująca, czy umożliwić odwoływanie się do pola w zapytaniach aspektowych. Zazwyczaj używane w prezentacji wyników wyszukiwania, które obejmują liczbę trafień według kategorii (na przykład wyszukiwanie cyfrowych aparatów fotograficznych i wyświetlanie trafień według marki, przez megapięci, według ceny itd.). Pola typu Edm.GeographyPoint lub Collection(Edm.GeographyPoint) nie mogą być aspektami. Wartość domyślna to false dla wszystkich innych prostych pól.
filterable	Wartość wskazująca, czy umożliwić przywoływanie pola w zapytaniach $filter. Filtrowanie różni się od możliwości wyszukiwania w sposobie obsługi ciągów. Pola typu Edm.String lub Collection(Edm.String), które można filtrować, nie są poddawane łamaniu wyrazów, więc porównania dotyczą tylko dokładnych dopasowań. Jeśli na przykład ustawisz takie pole f na "słoneczny dzień", $filter=f eq "sunny" nie znajdzie dopasowań, ale $filter=f eq "słoneczny dzień". Wartość domyślna to false.
hidden	Wartość wskazująca, czy pole może być zwracane w wynikach wyszukiwania. Tę opcję można włączyć, jeśli chcesz użyć pola (na przykład marginesu) jako mechanizmu filtrowania, sortowania lub oceniania, ale nie chcesz, aby pole było widoczne dla użytkownika końcowego. Ta właściwość musi być fałszem dla pól klucza. Tę właściwość można zmienić w istniejących polach. Wyłączenie tej właściwości nie powoduje wzrostu wymagań dotyczących magazynu indeksów. Wartość domyślna to false.
indexAnalyzerName	Nazwa analizatora używanego w czasie indeksowania dla pola. Tej opcji można używać tylko z polami z możliwością wyszukiwania. Należy go ustawić razem z elementem searchAnalyzer i nie można go ustawić razem z opcją analizatora. Po wybraniu analizatora nie można go zmienić dla pola. KnownAnalyzerNames to wyliczenie zawierające wbudowane nazwy analizatorów.
key	Wartość wskazująca, czy pole jednoznacznie identyfikuje dokumenty w indeksie. Należy wybrać dokładnie jedno pole najwyższego poziomu w każdym indeksie jako pole klucza i musi mieć typ Edm.String. Pola kluczy mogą służyć do bezpośredniego wyszukiwania dokumentów i aktualizowania lub usuwania określonych dokumentów. Wartość domyślna to false.
name	Nazwa pola, które musi być unikatowe w kolekcji pól indeksu lub pola nadrzędnego.
searchable	Wartość wskazująca, czy pole jest możliwe do przeszukiwania pełnotekstowego. Oznacza to, że zostanie ona poddana analizie, takiej jak łamanie wyrazów podczas indeksowania. Ustawienie wartości „sunny day” dla pola z możliwością wyszukiwania spowoduje podział na dwa oddzielne tokeny „sunny” i „day”. Umożliwia to wyszukiwanie pełnotekstowe dla tych terminów. Ta właściwość musi być fałszem dla prostych pól innych typów danych innych niż ciąg. Uwaga: pola z możliwością wyszukiwania zużywają dodatkowe miejsce w indeksie, ponieważ Azure Cognitive Search będą przechowywać dodatkową tokenizowaną wersję wartości pola na potrzeby wyszukiwania pełnotekstowego. Wartość domyślna to false dla prostych pól.
searchAnalyzerName	Nazwa analizatora używanego w czasie wyszukiwania pola. Tej opcji można używać tylko z polami z możliwością wyszukiwania. Należy go ustawić razem z parametrem indexAnalyzer i nie można go ustawić razem z opcją analizatora. Ten analizator można zaktualizować w istniejącym polu. KnownAnalyzerNames to wyliczenie zawierające wbudowane nazwy analizatorów.
sortable	Wartość wskazująca, czy pole ma być przywoływane w wyrażeniach $orderby. Domyślnie Azure Cognitive Search sortuje wyniki według wyniku, ale w wielu środowiskach użytkownicy będą chcieli sortować według pól w dokumentach. Proste pole można sortować tylko wtedy, gdy jest jednowartościowe (ma jedną wartość w zakresie dokumentu nadrzędnego). Proste pola kolekcji nie mogą być sortowane, ponieważ są wielowartośćowe. Proste podpola złożonych kolekcji są również wielowartościowe i dlatego nie mogą być sortowalne. Dotyczy to zarówno natychmiastowego pola nadrzędnego, jak i pola nadrzędnego, czyli kolekcji złożonej. Wartość domyślna sortowania to false.
synonymMapNames	Lista nazw synonimów map do skojarzenia z tym polem. Tej opcji można używać tylko z polami z możliwością wyszukiwania. Obecnie jest obsługiwana tylko jedna mapa synonimów na pole. Przypisanie mapy synonimów do pola zapewnia, że terminy zapytania przeznaczone dla tego pola są rozwijane w czasie wykonywania zapytań przy użyciu reguł na mapie synonimów. Ten atrybut można zmienić w istniejących polach.
type	Typ danych pola. Możliwe wartości to: "Edm.String", "Edm.Int32", "Edm.Int64", "Edm.Double", "Edm.Boolean", "Edm.DateTimeOffset", "Edm.GeographyPoint", "Collection(Edm.String)", "Collection(Edm.Int32)", "Collection(Edm.Int64)", "Collection(Edm.Double)", "Collection(Edm.Boolean)", "Collection(Edm.DateTimeOffset)", "Collection(Edm.GeographyPoint)", "Collection(Edm.Single)"
vectorSearchDimensions	Wymiarowość pola wektorowego.
vectorSearchProfileName	Nazwa konfiguracji algorytmu wyszukiwania wektorowego, która określa algorytm i parametry opcjonalne do przeszukiwania pola wektora.

Szczegóły właściwości

analyzerName

Nazwa analizatora języka do użycia dla pola. Tej opcji można używać tylko z polami z możliwością wyszukiwania i nie można jej ustawić razem z parametrem searchAnalyzer lub indexAnalyzer. Po wybraniu analizatora nie można go zmienić dla pola. KnownAnalyzerNames to wyliczenie zawierające wbudowane nazwy analizatorów.

analyzerName?: string

Wartość właściwości

string

facetable

Wartość wskazująca, czy umożliwić odwoływanie się do pola w zapytaniach aspektowych. Zazwyczaj używane w prezentacji wyników wyszukiwania, które obejmują liczbę trafień według kategorii (na przykład wyszukiwanie cyfrowych aparatów fotograficznych i wyświetlanie trafień według marki, przez megapięci, według ceny itd.). Pola typu Edm.GeographyPoint lub Collection(Edm.GeographyPoint) nie mogą być aspektami. Wartość domyślna to false dla wszystkich innych prostych pól.

facetable?: boolean

Wartość właściwości

boolean

filterable

Wartość wskazująca, czy umożliwić przywoływanie pola w zapytaniach $filter. Filtrowanie różni się od możliwości wyszukiwania w sposobie obsługi ciągów. Pola typu Edm.String lub Collection(Edm.String), które można filtrować, nie są poddawane łamaniu wyrazów, więc porównania dotyczą tylko dokładnych dopasowań. Jeśli na przykład ustawisz takie pole f na "słoneczny dzień", $filter=f eq "sunny" nie znajdzie dopasowań, ale $filter=f eq "słoneczny dzień". Wartość domyślna to false.

filterable?: boolean

Wartość właściwości

boolean

hidden

Wartość wskazująca, czy pole może być zwracane w wynikach wyszukiwania. Tę opcję można włączyć, jeśli chcesz użyć pola (na przykład marginesu) jako mechanizmu filtrowania, sortowania lub oceniania, ale nie chcesz, aby pole było widoczne dla użytkownika końcowego. Ta właściwość musi być fałszem dla pól klucza. Tę właściwość można zmienić w istniejących polach. Wyłączenie tej właściwości nie powoduje wzrostu wymagań dotyczących magazynu indeksów. Wartość domyślna to false.

hidden?: boolean

Wartość właściwości

boolean

indexAnalyzerName

Nazwa analizatora używanego w czasie indeksowania dla pola. Tej opcji można używać tylko z polami z możliwością wyszukiwania. Należy go ustawić razem z elementem searchAnalyzer i nie można go ustawić razem z opcją analizatora. Po wybraniu analizatora nie można go zmienić dla pola. KnownAnalyzerNames to wyliczenie zawierające wbudowane nazwy analizatorów.

indexAnalyzerName?: string

Wartość właściwości

string

key

Wartość wskazująca, czy pole jednoznacznie identyfikuje dokumenty w indeksie. Należy wybrać dokładnie jedno pole najwyższego poziomu w każdym indeksie jako pole klucza i musi mieć typ Edm.String. Pola kluczy mogą służyć do bezpośredniego wyszukiwania dokumentów i aktualizowania lub usuwania określonych dokumentów. Wartość domyślna to false.

key?: boolean

Wartość właściwości

boolean

name

Nazwa pola, które musi być unikatowe w kolekcji pól indeksu lub pola nadrzędnego.

name: string

Wartość właściwości

string

searchable

Wartość wskazująca, czy pole jest możliwe do przeszukiwania pełnotekstowego. Oznacza to, że zostanie ona poddana analizie, takiej jak łamanie wyrazów podczas indeksowania. Ustawienie wartości „sunny day” dla pola z możliwością wyszukiwania spowoduje podział na dwa oddzielne tokeny „sunny” i „day”. Umożliwia to wyszukiwanie pełnotekstowe dla tych terminów. Ta właściwość musi być fałszem dla prostych pól innych typów danych innych niż ciąg. Uwaga: pola z możliwością wyszukiwania zużywają dodatkowe miejsce w indeksie, ponieważ Azure Cognitive Search będą przechowywać dodatkową tokenizowaną wersję wartości pola na potrzeby wyszukiwania pełnotekstowego. Wartość domyślna to false dla prostych pól.

searchable?: boolean

Wartość właściwości

boolean

searchAnalyzerName

Nazwa analizatora używanego w czasie wyszukiwania pola. Tej opcji można używać tylko z polami z możliwością wyszukiwania. Należy go ustawić razem z parametrem indexAnalyzer i nie można go ustawić razem z opcją analizatora. Ten analizator można zaktualizować w istniejącym polu. KnownAnalyzerNames to wyliczenie zawierające wbudowane nazwy analizatorów.

searchAnalyzerName?: string

Wartość właściwości

string

sortable

Wartość wskazująca, czy pole ma być przywoływane w wyrażeniach $orderby. Domyślnie Azure Cognitive Search sortuje wyniki według wyniku, ale w wielu środowiskach użytkownicy będą chcieli sortować według pól w dokumentach. Proste pole można sortować tylko wtedy, gdy jest jednowartościowe (ma jedną wartość w zakresie dokumentu nadrzędnego). Proste pola kolekcji nie mogą być sortowane, ponieważ są wielowartośćowe. Proste podpola złożonych kolekcji są również wielowartościowe i dlatego nie mogą być sortowalne. Dotyczy to zarówno natychmiastowego pola nadrzędnego, jak i pola nadrzędnego, czyli kolekcji złożonej. Wartość domyślna sortowania to false.

sortable?: boolean

Wartość właściwości

boolean

synonymMapNames

Lista nazw synonimów map do skojarzenia z tym polem. Tej opcji można używać tylko z polami z możliwością wyszukiwania. Obecnie jest obsługiwana tylko jedna mapa synonimów na pole. Przypisanie mapy synonimów do pola zapewnia, że terminy zapytania przeznaczone dla tego pola są rozwijane w czasie wykonywania zapytań przy użyciu reguł na mapie synonimów. Ten atrybut można zmienić w istniejących polach.

synonymMapNames?: string[]

Wartość właściwości

string[]

type

Typ danych pola. Możliwe wartości to: "Edm.String", "Edm.Int32", "Edm.Int64", "Edm.Double", "Edm.Boolean", "Edm.DateTimeOffset", "Edm.GeographyPoint", "Collection(Edm.String)", "Collection(Edm.Int32)", "Collection(Edm.Int64)", "Collection(Edm.Double)", "Collection(Edm.Boolean)", "Collection(Edm.DateTimeOffset)", "Collection(Edm.GeographyPoint)", "Collection(Edm.Single)"

type: SearchFieldDataType

Wartość właściwości

SearchFieldDataType

vectorSearchDimensions

Wymiarowość pola wektorowego.

vectorSearchDimensions?: number

Wartość właściwości

number

vectorSearchProfileName

Nazwa konfiguracji algorytmu wyszukiwania wektorowego, która określa algorytm i parametry opcjonalne do przeszukiwania pola wektora.

vectorSearchProfileName?: string

Wartość właściwości

string