Freigeben über


SynonymMap Klasse

Stellt eine Synonymzuordnungsdefinition dar.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

Alle erforderlichen Parameter müssen aufgefüllt werden, um an Azure senden zu können.

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

Konstruktor

SynonymMap(**kwargs)

Variablen

Name Beschreibung
name
str

Erforderlich. Der Name der Synonymzuordnung.

format
str

Erforderlich. Das Format der Synonymzuordnung. Derzeit wird nur das Solr-Format unterstützt. Standardwert: "solr".

synonyms

Erforderlich. Eine Reihe von Synonymregeln im angegebenen Synonymzuordnungsformat. Die Regeln müssen durch Zeilen newlines getrennt werden.

encryption_key

Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um eine zusätzliche Stufe der Verschlüsselung ruhender Daten für Ihre Daten bereitzustellen, wenn Sie die volle Gewissheit 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.

e_tag
str

Das ETag der Synonymzuordnung.

Methoden

as_dict

Gibt ein Diktat zurück, das mit 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 Diktat 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 hierarchische Ergebnisdikt betrachtet.

Sehen Sie sich die drei Beispiele in dieser Datei an:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

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

deserialize

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

enable_additional_properties_sending
from_dict

Analysieren eines Diktats mit dem angegebenen Schlüsselextraktor gibt ein Modell zurück.

Berücksichtigen Sie standardmäßig Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

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

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

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

as_dict

Gibt ein Diktat zurück, das mit 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 Diktat 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 hierarchische Ergebnisdikt betrachtet.

Sehen Sie sich die drei Beispiele in dieser Datei an:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Wenn Sie eine 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üsseltransformatorfunktion.

keep_readonly
Standardwert: True

Gibt zurück

Typ Beschreibung

Ein JSON-kompatibles Diktatobjekt

deserialize

Analysieren Sie eine 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-Struktur, die die RestAPI-Struktur verwendet. Standardmäßig JSON.

content_type
str

Json standardmäßig, legen Sie application/xml fest, wenn XML.

Standardwert: None

Gibt zurück

Typ Beschreibung

Eine 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 mit dem angegebenen Schlüsselextraktor gibt ein Modell zurück.

Berücksichtigen Sie standardmäßig Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und 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

Parameter

Name Beschreibung
data
Erforderlich

Ein Diktat mithilfe der RestAPI-Struktur

content_type
str

Json standardmäßig, legen Sie application/xml fest, wenn XML.

Standardwert: None
key_extractors
Standardwert: None

Gibt zurück

Typ Beschreibung

Eine 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 wird.

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

Wenn Sie eine 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 Diktatobjekt

Attribute

format

format = 'solr'