Udostępnij za pośrednictwem

SearchIndex Klasa

  • Odwołanie

Reprezentuje definicję indeksu wyszukiwania, która opisuje pola i zachowanie wyszukiwania indeksu.

Wszystkie wymagane parametry muszą zostać wypełnione w celu wysłania ich na platformę Azure.

Dziedziczenie
azure.search.documents.indexes._generated._serialization.Model
SearchIndex

Konstruktor

SearchIndex(**kwargs)

Zmienne

Nazwa Opis
name
str

Wymagane. Nazwa indeksu.
fields
list[SearchField]

Wymagane. Pola indeksu.
scoring_profiles
list[ScoringProfile]

Profile oceniania dla indeksu.
default_scoring_profile
str

Nazwa profilu oceniania, który ma być używany, jeśli w zapytaniu nie określono żadnego. Jeśli ta właściwość nie jest ustawiona i nie określono profilu oceniania w zapytaniu, zostanie użyta domyślna ocenianie (tf-idf).
cors_options
CorsOptions

Opcje kontrolowania współużytkowania zasobów między źródłami (CORS) dla indeksu.
suggesters
list[SearchSuggester]

Sugestory indeksu.
analyzers
list[LexicalAnalyzer]

Analizatory indeksu.
tokenizers
list[LexicalTokenizer]

Tokenizatory indeksu.
token_filters
list[TokenFilter]

Token filtruje indeks.
char_filters
list[CharFilter]

Znaki filtruje indeks.
encryption_key
SearchResourceEncryptionKey

Opis klucza szyfrowania tworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania danych magazynowanych, gdy chcesz mieć pełną pewność, że nikt, nawet firma Microsoft, nie może odszyfrować dane w Azure Cognitive Search. Po zaszyfrowaniu danych zawsze pozostaną one zaszyfrowane. Azure Cognitive Search zignoruje próby ustawienia tej właściwości na wartość null. Tę właściwość można zmienić w razie potrzeby, jeśli chcesz obrócić klucz szyfrowania; Twoje dane nie będą miały wpływu. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych 1 stycznia 2019 r. lub później.
similarity
SimilarityAlgorithm

Typ algorytmu podobieństwa, który ma być używany podczas oceniania i klasyfikowania dokumentów pasujących do zapytania wyszukiwania. Algorytm podobieństwa można zdefiniować tylko w czasie tworzenia indeksu i nie można go modyfikować w istniejących indeksach. Jeśli ma wartość null, jest używany algorytm ClassicSimilarity.
semantic_search
SemanticSearch

Definiuje parametry indeksu wyszukiwania, który ma wpływ na możliwości semantyczne.
vector_search
VectorSearch

Definiuje parametry indeksu wyszukiwania mające wpływ na ocenianie w przestrzeni wektorowej.
e_tag
str

Element ETag indeksu.

Metody

as_dict

Zwróć dykt, który można serializować przy użyciu pliku json.dump.

Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru:

Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym za pomocą interfejsu RESTAPI. Wartość jest bieżącą wartością w tym obiekcie.

Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uznawane za hierarchiczny dykt wyniku.

Zobacz trzy przykłady w tym pliku:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.
deserialize

Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.
enable_additional_properties_sending
from_dict

Przeanalizuj dykt przy użyciu danego modułu wyodrębniającego klucz, który zwraca model.

Domyślnie należy rozważyć wyodrębnianie kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Zwróć kod JSON, który zostanie wysłany do serwera z tego modelu.

Jest to alias as_dict (full_restapi_key_transformer, keep_readonly=False).

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

as_dict

Zwróć dykt, który można serializować przy użyciu pliku json.dump.

Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru:

Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym za pomocą interfejsu RESTAPI. Wartość jest bieżącą wartością w tym obiekcie.

Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uznawane za hierarchiczny dykt wyniku.

Zobacz trzy przykłady w tym pliku:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

Parametry

Nazwa Opis
key_transformer
<xref:function>

Funkcja transformatora klucza.
keep_readonly
wartość domyślna: True

Zwraca

Typ Opis
dict

Obiekt zgodny z dyktacją JSON

deserialize

Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.

deserialize(data: Any, content_type: str | None = None) -> ModelType

Parametry

Nazwa Opis
data
Wymagane
str

Str używający struktury RestAPI. Domyślnie dane JSON.
content_type
str

Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML.

wartość domyślna: None

Zwraca

Typ Opis

Wystąpienie tego modelu

Wyjątki

Typ Opis
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_dict

Przeanalizuj dykt przy użyciu danego modułu wyodrębniającego klucz, który zwraca model.

Domyślnie należy rozważyć wyodrębnianie kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor)

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

Parametry

Nazwa Opis
data
Wymagane
dict

Dykt używający struktury RestAPI
content_type
str

Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML.

wartość domyślna: None
key_extractors
wartość domyślna: None

Zwraca

Typ Opis

Wystąpienie tego modelu

Wyjątki

Typ Opis
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

Zwróć kod JSON, który zostanie wysłany do serwera z tego modelu.

Jest to alias as_dict (full_restapi_key_transformer, keep_readonly=False).

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Parametry

Nazwa Opis
keep_readonly
bool

Jeśli chcesz serializować atrybuty tylko do odczytu

wartość domyślna: False

Zwraca

Typ Opis
dict

Obiekt zgodny z dyktacją JSON