SynonymMap Class
Represents a synonym map definition.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Inheritance
-
azure.search.documents.indexes._generated._serialization.ModelSynonymMap
Constructor
SynonymMap(*, name: str, synonyms: List[str], encryption_key: SearchResourceEncryptionKey | None = None, e_tag: str | None = None, **kwargs)
Keyword-Only Parameters
Name | Description |
---|---|
name
Required
|
|
synonyms
Required
|
|
encryption_key
Required
|
|
e_tag
Required
|
|
Variables
Name | Description |
---|---|
name
|
Required. The name of the synonym map. |
format
|
Required. The format of the synonym map. Only the 'solr' format is currently supported. Default value: "solr". |
synonyms
|
Required. A series of synonym rules in the specified synonym map format. The rules must be separated by newlines. |
encryption_key
|
A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. |
e_tag
|
The ETag of the synonym map. |
Methods
as_dict |
Return a dict that can be serialized using json.dump. |
deserialize |
Parse a str using the RestAPI syntax and return a SynonymMap instance. |
enable_additional_properties_sending | |
from_dict |
Parse a dict using given key extractor return a model. By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor) |
is_xml_model | |
serialize |
Return the JSON that would be sent to server from this model. :param bool keep_readonly: If you want to serialize the readonly attributes :returns: A dict JSON compatible object :rtype: dict |
as_dict
Return a dict that can be serialized using json.dump.
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 |
---|---|
keep_readonly
|
If you want to serialize the readonly attributes Default value: True
|
key_transformer
|
A callable that will transform the key of the dict |
Returns
Type | Description |
---|---|
A dict JSON compatible object |
deserialize
Parse a str using the RestAPI syntax and return a SynonymMap instance.
deserialize(data: Any, content_type: str | None = None) -> Self | None
Parameters
Name | Description |
---|---|
data
Required
|
A str using RestAPI structure. JSON by default. |
content_type
|
JSON by default, set application/xml if XML. Default value: None
|
Returns
Type | Description |
---|---|
A SynonymMap instance |
Exceptions
Type | Description |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> None
from_dict
Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and 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) -> Self | None
Parameters
Name | Description |
---|---|
data
Required
|
A dict using RestAPI structure |
key_extractors
|
A callable that will extract a key from a dict Default value: None
|
content_type
|
JSON by default, set application/xml if XML. Default value: None
|
Returns
Type | Description |
---|---|
A SynonymMap instance |
Exceptions
Type | Description |
---|---|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> bool
serialize
Return the JSON that would be sent to server from this model. :param bool keep_readonly: If you want to serialize the readonly attributes :returns: A dict JSON compatible object :rtype: dict
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]
Parameters
Name | Description |
---|---|
keep_readonly
|
Default value: False
|
Attributes
format
format = 'solr'
Azure SDK for Python