SearchIndex Klass

Representerar en sökindexdefinition som beskriver fälten och sökbeteendet för ett index.

Alla obligatoriska parametrar måste fyllas i för att kunna skickas till Azure.

Arv

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

SearchIndex

Konstruktor

SearchIndex(**kwargs)

Variabler

Name	Description
name	str Krävs. Namnet på indexet.
fields	list[SearchField] Krävs. Fälten i indexet.
scoring_profiles	list[ScoringProfile] Bedömningsprofilerna för indexet.
default_scoring_profile	str Namnet på den bedömningsprofil som ska användas om ingen anges i frågan. Om den här egenskapen inte har angetts och ingen bedömningsprofil anges i frågan används standardbedömningen (tf-idf).
cors_options	CorsOptions Alternativ för att styra resursdelning för korsande ursprung (CORS) för indexet.
suggesters	list[SearchSuggester] Förslagsarbetarna för indexet.
analyzers	list[LexicalAnalyzer] Analysverktygen för indexet.
tokenizers	list[LexicalTokenizer] Tokenizers för indexet.
token_filters	list[TokenFilter] Tokenfiltren för indexet.
char_filters	list[CharFilter] Tecknet filtrerar för indexet.
encryption_key	SearchResourceEncryptionKey En beskrivning av en krypteringsnyckel som du skapar i Azure Key Vault. Den här nyckeln används för att ge ytterligare kryptering i vila för dina data när du vill ha fullständig säkerhet om att ingen, inte ens Microsoft, kan dekryptera dina data i Azure Cognitive Search. När du har krypterat dina data förblir de alltid krypterade. Azure Cognitive Search ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Dina data påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare.
similarity	SimilarityAlgorithm Den typ av likhetsalgoritm som ska användas vid bedömning och rangordning av dokument som matchar en sökfråga. Likhetsalgoritmen kan bara definieras när index skapas och kan inte ändras i befintliga index. Om det är null används ClassicSimilarity-algoritmen.
semantic_search	SemanticSearch Definierar parametrar för ett sökindex som påverkar semantiska funktioner.
vector_search	VectorSearch Definierar parametrar för ett sökindex som påverkar bedömning i ett vektorutrymme.
e_tag	str ETag för indexet.

Metoder

as_dict	Returnera en diktamen som kan serialiseras med json.dump. Avancerad användning kan också använda ett återanrop som parameter: Nyckeln är det attributnamn som används i Python. Attr_desc är en diktering av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med den RestAPI-kodade nyckeln. Värde är det aktuella värdet i det här objektet. Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt. Se de tre exemplen i den här filen: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.
deserialize	Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.
enable_additional_properties_sending
from_dict	Parsa en diktamen med hjälp av den angivna nyckelextraktorn returnerar en modell. Som standard bör du överväga nyckelextraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Returnera den JSON som skulle skickas till servern från den här modellen. Det här är ett alias för as_dict(full_restapi_key_transformer, keep_readonly=False). Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

as_dict

Returnera en diktamen som kan serialiseras med json.dump.

Avancerad användning kan också använda ett återanrop som parameter:

Nyckeln är det attributnamn som används i Python. Attr_desc är en diktering av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med den RestAPI-kodade nyckeln. Värde är det aktuella värdet i det här objektet.

Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt.

Se de tre exemplen i den här filen:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Om du vill ha XML-serialisering kan du skicka 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]

Parametrar

Name	Description
key_transformer	<xref:function> En nyckeltransformatorfunktion.
keep_readonly	standardvärde: True

Returer

Typ	Description
dict	Ett dict JSON-kompatibelt objekt

deserialize

Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.

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

Parametrar

Name	Description
data Obligatorisk	str En str som använder RestAPI-struktur. JSON som standard.
content_type	str JSON anger som standard application/xml om XML. standardvärde: None

Returer

Typ	Description
	En instans av den här modellen

Undantag

Typ	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Parsa en diktamen med hjälp av den angivna nyckelextraktorn returnerar en modell.

Som standard bör du överväga nyckelextraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och 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

Parametrar

Name	Description
data Obligatorisk	dict En diktamen som använder RestAPI-struktur
content_type	str JSON anger som standard application/xml om XML. standardvärde: None
key_extractors	standardvärde: None

Returer

Typ	Description
	En instans av den här modellen

Undantag

Typ	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Returnera den JSON som skulle skickas till servern från den här modellen.

Det här är ett alias för as_dict(full_restapi_key_transformer, keep_readonly=False).

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

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

Parametrar

Name	Description
keep_readonly	bool Om du vill serialisera skrivskyddade attribut standardvärde: False

Returer

Typ	Description
dict	Ett dict JSON-kompatibelt objekt