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 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 elementem searchAnalyzer lub indexAnalyzer. Po wybraniu analizatora nie można go zmienić dla pola.
facetable	Wartość wskazująca, czy pole ma być przywołyne w zapytaniach aspektowych. Zazwyczaj używane w prezentacji wyników wyszukiwania, które obejmują liczbę trafień według kategorii (na przykład wyszukiwanie aparatów cyfrowych i wyświetlanie trafień według marki, megapikseli, ceny itd.). Pola typu Edm.GeographyPoint lub Collection(Edm.GeographyPoint) nie mogą być aspektami. Wartość domyślna to false.
filterable	Wartość wskazująca, czy pole ma być przywołyne w zapytaniach $filter. funkcja filtrowania 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, dlatego porównania są przeznaczone tylko dla 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. Możesz wyłączyć tę opcję, 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. Włączenie tej właściwości nie powoduje zwiększenia wymagań dotyczących magazynu indeksów. Wartość domyślna ma wartość true dla pól wektorów, w przeciwnym razie wartość 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. Nie można ustawić tej właściwości na nazwę analizatora języka; Zamiast tego należy użyć właściwości analizatora, jeśli potrzebujesz analizatora języka. Po wybraniu analizatora nie można go zmienić dla pola.
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 klucza 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 można przeszukiwać pełnotekstowo. Oznacza to, że zostanie ona poddana analizie, takiej jak łamanie wyrazów podczas indeksowania. Jeśli ustawisz pole z możliwością wyszukiwania na wartość podobną do "słonecznego dnia", wewnętrznie zostanie ono podzielone na poszczególne tokeny "słoneczne" i "dzień". Umożliwia to wyszukiwanie pełnotekstowe dla tych terminów. Pola typu Edm.String lub Collection(Edm.String) można wyszukiwać domyślnie. 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, aby uwzględnić dodatkowe tokenizowane wersje wartości pola na potrzeby wyszukiwania pełnotekstowego. Jeśli chcesz zaoszczędzić miejsce w indeksie i nie musisz uwzględniać pola w wyszukiwaniu, ustaw wartość false. Wartość domyślna to false.
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 indexAnalyzerName i nie można go ustawić razem z opcją analyzerName. Nie można ustawić tej właściwości na nazwę analizatora języka; Zamiast tego należy użyć właściwości analyzerName, jeśli potrzebujesz analizatora języka. Ten analizator można zaktualizować w istniejącym polu.
sortable	Wartość wskazująca, czy pole ma być przywoływane w wyrażeniach $orderby. Domyślnie wyszukiwarka sortuje wyniki według wyniku, ale w wielu środowiskach użytkownicy będą chcieli sortować według pól w dokumentach. Proste pole może być sortowane 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 można sortować. Dotyczy to zarówno natychmiastowego pola nadrzędnego, jak i pola przodka, czyli kolekcji złożonej. Wartość domyślna to false.
stored	Niezmienna wartość wskazująca, czy pole będzie utrwalane oddzielnie na dysku, który ma zostać zwrócony w wynikach wyszukiwania. Tę opcję można wyłączyć, jeśli nie planujesz zwracać zawartości pola w odpowiedzi wyszukiwania, aby zaoszczędzić obciążenie magazynu. Można to ustawić tylko podczas tworzenia indeksu i tylko dla pól wektorów. Tej właściwości nie można zmienić dla istniejących pól ani ustawić jako false dla nowych pól. Jeśli ta właściwość jest ustawiona jako false, właściwość "hidden" musi być ustawiona na wartość "true". Ta właściwość musi być fałszem lub nieskonstawiona dla pól klucza, dla nowych pól i dla pól niewektorowych. Wyłączenie tej właściwości spowoduje zmniejszenie wymagań dotyczących magazynu indeksów.
synonymMapNames	Lista nazw map synonimów do skojarzenia z tym polem. Tej opcji można używać tylko z polami z możliwością wyszukiwania. Obecnie obsługiwana jest tylko jedna mapa synonimów na pole. Przypisanie mapy synonimów do pola zapewnia, że terminy zapytania przeznaczone dla tego pola są rozszerzane w czasie wykonywania zapytań przy użyciu reguł w mapie synonimów. Ten atrybut można zmienić w istniejących polach.
type	Typ danych pola.
vectorEncodingFormat	Format kodowania do interpretowania zawartości pola.
vectorSearchDimensions	Wymiarowość pola wektora.
vectorSearchProfileName	Nazwa profilu wyszukiwania wektorowego, który określa algorytm i wektoryzator używany podczas wyszukiwania pola wektorowego.

Szczegóły właściwości

analyzerName

Nazwa analizatora 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 elementem searchAnalyzer lub indexAnalyzer. Po wybraniu analizatora nie można go zmienić dla pola.

analyzerName?: string

Wartość właściwości

string

facetable

Wartość wskazująca, czy pole ma być przywołyne w zapytaniach aspektowych. Zazwyczaj używane w prezentacji wyników wyszukiwania, które obejmują liczbę trafień według kategorii (na przykład wyszukiwanie aparatów cyfrowych i wyświetlanie trafień według marki, megapikseli, ceny itd.). Pola typu Edm.GeographyPoint lub Collection(Edm.GeographyPoint) nie mogą być aspektami. Wartość domyślna to false.

facetable?: boolean

Wartość właściwości

boolean

filterable

Wartość wskazująca, czy pole ma być przywołyne w zapytaniach $filter. funkcja filtrowania 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, dlatego porównania są przeznaczone tylko dla 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. Możesz wyłączyć tę opcję, 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. Włączenie tej właściwości nie powoduje zwiększenia wymagań dotyczących magazynu indeksów. Wartość domyślna ma wartość true dla pól wektorów, w przeciwnym razie wartość 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. Nie można ustawić tej właściwości na nazwę analizatora języka; Zamiast tego należy użyć właściwości analizatora, jeśli potrzebujesz analizatora języka. Po wybraniu analizatora nie można go zmienić dla pola.

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 klucza 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 można przeszukiwać pełnotekstowo. Oznacza to, że zostanie ona poddana analizie, takiej jak łamanie wyrazów podczas indeksowania. Jeśli ustawisz pole z możliwością wyszukiwania na wartość podobną do "słonecznego dnia", wewnętrznie zostanie ono podzielone na poszczególne tokeny "słoneczne" i "dzień". Umożliwia to wyszukiwanie pełnotekstowe dla tych terminów. Pola typu Edm.String lub Collection(Edm.String) można wyszukiwać domyślnie. 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, aby uwzględnić dodatkowe tokenizowane wersje wartości pola na potrzeby wyszukiwania pełnotekstowego. Jeśli chcesz zaoszczędzić miejsce w indeksie i nie musisz uwzględniać pola w wyszukiwaniu, ustaw wartość false. Wartość domyślna to false.

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 indexAnalyzerName i nie można go ustawić razem z opcją analyzerName. Nie można ustawić tej właściwości na nazwę analizatora języka; Zamiast tego należy użyć właściwości analyzerName, jeśli potrzebujesz analizatora języka. Ten analizator można zaktualizować w istniejącym polu.

searchAnalyzerName?: string

Wartość właściwości

string

sortable

Wartość wskazująca, czy pole ma być przywoływane w wyrażeniach $orderby. Domyślnie wyszukiwarka sortuje wyniki według wyniku, ale w wielu środowiskach użytkownicy będą chcieli sortować według pól w dokumentach. Proste pole może być sortowane 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 można sortować. Dotyczy to zarówno natychmiastowego pola nadrzędnego, jak i pola przodka, czyli kolekcji złożonej. Wartość domyślna to false.

sortable?: boolean

Wartość właściwości

boolean

stored

Niezmienna wartość wskazująca, czy pole będzie utrwalane oddzielnie na dysku, który ma zostać zwrócony w wynikach wyszukiwania. Tę opcję można wyłączyć, jeśli nie planujesz zwracać zawartości pola w odpowiedzi wyszukiwania, aby zaoszczędzić obciążenie magazynu. Można to ustawić tylko podczas tworzenia indeksu i tylko dla pól wektorów. Tej właściwości nie można zmienić dla istniejących pól ani ustawić jako false dla nowych pól. Jeśli ta właściwość jest ustawiona jako false, właściwość "hidden" musi być ustawiona na wartość "true". Ta właściwość musi być fałszem lub nieskonstawiona dla pól klucza, dla nowych pól i dla pól niewektorowych. Wyłączenie tej właściwości spowoduje zmniejszenie wymagań dotyczących magazynu indeksów.

stored?: boolean

Wartość właściwości

boolean

synonymMapNames

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

synonymMapNames?: string[]

Wartość właściwości

string[]

type

Typ danych pola.

type: SearchFieldDataType

Wartość właściwości

SearchFieldDataType

vectorEncodingFormat

Format kodowania do interpretowania zawartości pola.

vectorEncodingFormat?: string

Wartość właściwości

string

vectorSearchDimensions

Wymiarowość pola wektora.

vectorSearchDimensions?: number

Wartość właściwości

number

vectorSearchProfileName

Nazwa profilu wyszukiwania wektorowego, który określa algorytm i wektoryzator używany podczas wyszukiwania pola wektorowego.

vectorSearchProfileName?: string

Wartość właściwości

string