ShaperSkill Klas
Een vaardigheid voor het opnieuw vormgeven van de uitvoer. Er wordt een complex type gemaakt ter ondersteuning van samengestelde velden (ook wel meerdelige velden genoemd).
Alle vereiste parameters moeten worden ingevuld om naar Azure te kunnen worden verzonden.
- Overname
-
azure.search.documents.indexes._generated.models._models_py3.SearchIndexerSkillShaperSkill
Constructor
ShaperSkill(*, inputs: List[_models.InputFieldMappingEntry], outputs: List[_models.OutputFieldMappingEntry], name: str | None = None, description: str | None = None, context: str | None = None, **kwargs: Any)
Keyword-Only Parameters
Name | Description |
---|---|
name
|
De naam van de vaardigheid die deze uniek identificeert binnen de vaardighedenset. Een vaardigheid zonder gedefinieerde naam krijgt een standaardnaam van de index op basis van 1 in de vaardighedenmatrix, voorafgegaan door het teken |
description
|
De beschrijving van de vaardigheid die de invoer, uitvoer en het gebruik van de vaardigheid beschrijft. |
context
|
Geeft het niveau aan waarop bewerkingen worden uitgevoerd, zoals de hoofdmap van het document of de inhoud van het document (bijvoorbeeld /document of /document/content). De standaardwaarde is /document. |
inputs
|
list[<xref:search_service_client.models.InputFieldMappingEntry>]
Invoer van de vaardigheden kan een kolom zijn in de brongegevensset of de uitvoer van een upstream-vaardigheid. Vereist. |
outputs
|
list[<xref:search_service_client.models.OutputFieldMappingEntry>]
De uitvoer van een vaardigheid is een veld in een zoekindex of een waarde die kan worden gebruikt als invoer door een andere vaardigheid. Vereist. |
Variabelen
Name | Description |
---|---|
odata_type
|
Een URI-fragment dat het type vaardigheid aangeeft. Vereist. |
name
|
De naam van de vaardigheid die deze uniek identificeert binnen de vaardighedenset. Een vaardigheid zonder gedefinieerde naam krijgt een standaardnaam van de index op basis van 1 in de vaardighedenmatrix, voorafgegaan door het teken |
description
|
De beschrijving van de vaardigheid die de invoer, uitvoer en het gebruik van de vaardigheid beschrijft. |
context
|
Geeft het niveau aan waarop bewerkingen worden uitgevoerd, zoals de hoofdmap van het document of de inhoud van het document (bijvoorbeeld /document of /document/content). De standaardwaarde is /document. |
inputs
|
list[<xref:search_service_client.models.InputFieldMappingEntry>]
Invoer van de vaardigheden kan een kolom zijn in de brongegevensset of de uitvoer van een upstream-vaardigheid. Vereist. |
outputs
|
list[<xref:search_service_client.models.OutputFieldMappingEntry>]
De uitvoer van een vaardigheid is een veld in een zoekindex of een waarde die kan worden gebruikt als invoer door een andere vaardigheid. Vereist. |
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:
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 |
---|---|
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
|
Een str met behulp van restAPI-structuur. JSON standaard. |
content_type
|
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
|
Een dict met behulp van de RestAPI-structuur |
content_type
|
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
|
Als u de alleen-lezen kenmerken wilt serialiseren standaardwaarde: False
|
Retouren
Type | Description |
---|---|
Een dict JSON-compatibel object |
Azure SDK for Python