Freigeben über


SearchIndex Klasse

Stellt eine Suchindexdefinition dar, die die Felder und das Suchverhalten eines Indexes beschreibt.

Zum Senden an Azure müssen alle erforderlichen Parameter aufgefüllt werden.

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

Konstruktor

SearchIndex(**kwargs)

Variablen

Name Beschreibung
name
str

Erforderlich. Der Name des Index.

fields

Erforderlich. Die Felder des Indexes.

scoring_profiles

Die Bewertungsprofile für den Index.

default_scoring_profile
str

Der Name des Bewertungsprofils, das verwendet werden soll, wenn keines in der Abfrage angegeben ist. Wenn diese Eigenschaft nicht festgelegt ist und in der Abfrage kein Bewertungsprofil angegeben wird, wird die Standardbewertung (tf-idf) verwendet.

cors_options

Optionen zum Steuern der cross-origin Resource Sharing (CORS) für den Index.

suggesters

Die Vorschlagsgeber für den Index.

analyzers

Die Analysetools für den Index.

tokenizers

Die Tokenisierer für den Index.

token_filters

Das Token filtert für den Index.

char_filters

Das Zeichen filtert für den Index.

encryption_key

Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um ein zusätzliches Maß an Verschlüsselung ruhender Daten für Ihre Daten bereitzustellen, wenn Sie die volle Sicherheit haben möchten, dass niemand, nicht einmal Microsoft, Ihre Daten in Azure Cognitive Search entschlüsseln kann. Sobald Sie Ihre Daten verschlüsselt haben, bleiben sie immer verschlüsselt. Azure Cognitive Search ignoriert Versuche, diese Eigenschaft auf NULL festzulegen. Sie können diese Eigenschaft bei Bedarf ändern, wenn Sie Ihren Verschlüsselungsschlüssel rotieren möchten. Ihre Daten bleiben unberührt. Die Verschlüsselung mit kundenseitig verwalteten Schlüsseln ist für kostenlose Suchdienste nicht verfügbar und nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden.

similarity

Der Typ des Ähnlichkeitsalgorithmus, der bei der Bewertung und Rangfolge der Dokumente verwendet werden soll, die einer Suchabfrage entsprechen. Der Ähnlichkeitsalgorithmus kann nur zum Zeitpunkt der Indexerstellung definiert werden und kann nicht für vorhandene Indizes geändert werden. Bei NULL wird der ClassicSimilarity-Algorithmus verwendet.

semantic_search

Definiert Parameter für einen Suchindex, die semantische Funktionen beeinflussen.

vector_search

Definiert Parameter für einen Suchindex, die die Bewertung in einem Vektorraum beeinflussen.

e_tag
str

Das ETag des Indexes.

Methoden

as_dict

Gibt ein Diktat zurück, das mithilfe von json.dump serialisiert werden kann.

Bei erweiterter Verwendung kann optional ein Rückruf als Parameter verwendet werden:

Key ist der Attributname, der in Python verwendet wird. Attr_desc ist ein Dict von Metadaten. Enthält derzeit "type" mit dem msrest-Typ und "key" mit dem RestAPI-codierten Schlüssel. Value ist der aktuelle Wert in diesem Objekt.

Die zurückgegebene Zeichenfolge wird verwendet, um den Schlüssel zu serialisieren. Wenn der Rückgabetyp eine Liste ist, wird dies als hierarchisches Ergebnisdikt betrachtet.

Sehen Sie sich die drei Beispiele in dieser Datei an:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

deserialize

Analysieren Sie einen Str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.

enable_additional_properties_sending
from_dict

Analysieren eines Diktats mithilfe des angegebenen Schlüsselextraktors gibt ein Modell zurück.

Standardmäßig werden Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor) berücksichtigt.

is_xml_model
serialize

Gibt den JSON-Code zurück, der von diesem Modell an den Server gesendet würde.

Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False).

Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

as_dict

Gibt ein Diktat zurück, das mithilfe von json.dump serialisiert werden kann.

Bei erweiterter Verwendung kann optional ein Rückruf als Parameter verwendet werden:

Key ist der Attributname, der in Python verwendet wird. Attr_desc ist ein Dict von Metadaten. Enthält derzeit "type" mit dem msrest-Typ und "key" mit dem RestAPI-codierten Schlüssel. Value ist der aktuelle Wert in diesem Objekt.

Die zurückgegebene Zeichenfolge wird verwendet, um den Schlüssel zu serialisieren. Wenn der Rückgabetyp eine Liste ist, wird dies als hierarchisches Ergebnisdikt betrachtet.

Sehen Sie sich die drei Beispiele in dieser Datei an:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

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]

Parameter

Name Beschreibung
key_transformer
<xref:function>

Eine Schlüsseltransformerfunktion.

keep_readonly
Standardwert: True

Gibt zurück

Typ Beschreibung

Ein JSON-kompatibles Objekt mit Dict

deserialize

Analysieren Sie einen Str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.

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

Parameter

Name Beschreibung
data
Erforderlich
str

Eine Str-Instanz mit RestAPI-Struktur. JSON standardmäßig.

content_type
str

JSON standardmäßig, legen Sie application/xml if XML fest.

Standardwert: None

Gibt zurück

Typ Beschreibung

Ein instance dieses Modells

Ausnahmen

Typ Beschreibung
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analysieren eines Diktats mithilfe des angegebenen Schlüsselextraktors gibt ein Modell zurück.

Standardmäßig werden Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor) berücksichtigt.

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

Parameter

Name Beschreibung
data
Erforderlich

Ein Diktat mithilfe der RestAPI-Struktur

content_type
str

JSON standardmäßig, legen Sie application/xml if XML fest.

Standardwert: None
key_extractors
Standardwert: None

Gibt zurück

Typ Beschreibung

Ein instance dieses Modells

Ausnahmen

Typ Beschreibung
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Gibt den JSON-Code zurück, der von diesem Modell an den Server gesendet würde.

Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False).

Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

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

Parameter

Name Beschreibung
keep_readonly

Wenn Sie die schreibgeschützten Attribute serialisieren möchten

Standardwert: False

Gibt zurück

Typ Beschreibung

Ein JSON-kompatibles Objekt mit Dict