SearchIndex Klas

Vertegenwoordigt een zoekindexdefinitie, waarmee de velden en het zoekgedrag van een index worden beschreven.

Alle vereiste parameters moeten worden ingevuld om naar Azure te kunnen worden verzonden.

Overname

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

SearchIndex

Constructor

SearchIndex(**kwargs)

Variabelen

Name	Description
name	str Vereist. De naam van de index.
fields	list[SearchField] Vereist. De velden van de index.
scoring_profiles	list[ScoringProfile] De scoreprofielen voor de index.
default_scoring_profile	str De naam van het scoreprofiel dat moet worden gebruikt als er geen is opgegeven in de query. Als deze eigenschap niet is ingesteld en er geen scoreprofiel is opgegeven in de query, wordt standaardscore (tf-idf) gebruikt.
cors_options	CorsOptions Opties voor het beheren van CORS (Cross-Origin Resource Sharing) voor de index.
suggesters	list[SearchSuggester] De suggesties voor de index.
analyzers	list[LexicalAnalyzer] De analysefuncties voor de index.
tokenizers	list[LexicalTokenizer] De tokenizers voor de index.
token_filters	list[TokenFilter] Het tokenfilters voor de index.
char_filters	list[CharFilter] De tekenfilters voor de index.
encryption_key	SearchResourceEncryptionKey Een beschrijving van een versleutelingssleutel die u maakt in Azure Key Vault. Deze sleutel wordt gebruikt om een extra versleutelingsniveau voor uw gegevens te bieden wanneer u volledige zekerheid wilt dat niemand, zelfs Microsoft, uw gegevens in Azure Cognitive Search kan ontsleutelen. Zodra u uw gegevens hebt versleuteld, blijven deze altijd versleuteld. Azure Cognitive Search negeert pogingen om deze eigenschap in te stellen op null. U kunt deze eigenschap indien nodig wijzigen als u uw versleutelingssleutel wilt roteren; Uw gegevens worden niet beïnvloed. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.
similarity	SimilarityAlgorithm Het type gelijkenis-algoritme dat moet worden gebruikt bij het scoren en rangschikken van de documenten die overeenkomen met een zoekopdracht. Het gelijkenisalgoritme kan alleen worden gedefinieerd tijdens het maken van de index en kan niet worden gewijzigd in bestaande indexen. Als dit null is, wordt het algoritme ClassicSimilarity gebruikt.
semantic_search	SemanticSearch Hiermee definieert u parameters voor een zoekindex die semantische mogelijkheden beïnvloeden.
vector_search	VectorSearch Hiermee definieert u parameters voor een zoekindex die het scoren in een vectorruimte beïnvloeden.
e_tag	str De ETag van de index.

Methoden

as_dict	Een dict retourneren dat kan worden geserialiseerd met behulp van json.dump. Geavanceerd gebruik kan desgewenst een callback gebruiken als parameter: Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dict van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de restAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object. De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiërarchisch resultaatdicteren. Bekijk de drie voorbeelden in dit bestand: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.
deserialize	Parseert een str met behulp van de RestAPI-syntaxis en retourneert een model.
enable_additional_properties_sending
from_dict	Een dict parseren met behulp van de opgegeven sleutelextractor retourneert een model. Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Retourneert de JSON die vanuit dit model naar de server wordt verzonden. Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False). Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

as_dict

Een dict retourneren dat kan worden geserialiseerd met behulp van json.dump.

Geavanceerd gebruik kan desgewenst een callback gebruiken als parameter:

Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dict van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de restAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object.

De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiërarchisch resultaatdicteren.

Bekijk de drie voorbeelden in dit bestand:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

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]

Parameters

Name	Description
key_transformer	<xref:function> Een sleuteltransformatorfunctie.
keep_readonly	standaardwaarde: True

Retouren

Type	Description
dict	Een dict JSON-compatibel object

deserialize

Parseert een str met behulp van de RestAPI-syntaxis en retourneert een model.

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

Parameters

Name	Description
data Vereist	str Een str met behulp van restAPI-structuur. JSON standaard.
content_type	str JSON standaard: stel application/xml in als XML. standaardwaarde: None

Retouren

Type	Description
	Een exemplaar van dit model

Uitzonderingen

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Een dict parseren met behulp van de opgegeven sleutelextractor retourneert een model.

Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en 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

Parameters

Name	Description
data Vereist	dict Een dict met behulp van de RestAPI-structuur
content_type	str JSON standaard: stel application/xml in als XML. standaardwaarde: None
key_extractors	standaardwaarde: None

Retouren

Type	Description
	Een exemplaar van dit model

Uitzonderingen

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Retourneert de JSON die vanuit dit model naar de server wordt verzonden.

Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False).

Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

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

Parameters

Name	Description
keep_readonly	bool Als u de alleen-lezen kenmerken wilt serialiseren standaardwaarde: False

Retouren

Type	Description
dict	Een dict JSON-compatibel object