WebApiSkill Klas

Een vaardigheid die een web-API-eindpunt kan aanroepen, zodat u een vaardighedenset kunt uitbreiden door uw aangepaste code aan te roepen.

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

Overname

azure.search.documents.indexes._generated.models._models_py3.SearchIndexerSkill

WebApiSkill

Constructor

WebApiSkill(*, inputs: List[_models.InputFieldMappingEntry], outputs: List[_models.OutputFieldMappingEntry], uri: str, name: str | None = None, description: str | None = None, context: str | None = None, http_headers: Dict[str, str] | None = None, http_method: str | None = None, timeout: timedelta | None = None, batch_size: int | None = None, degree_of_parallelism: int | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
name	str De naam van de vaardigheid die deze uniek identificeert binnen de vaardighedenset. Een vaardigheid zonder gedefinieerde naam krijgt een standaardnaam van de op 1 gebaseerde index in de vaardighedenmatrix, voorafgegaan door het teken #.
description	str De beschrijving van de vaardigheid die de invoer, uitvoer en het gebruik van de vaardigheid beschrijft.
context	str Vertegenwoordigt het niveau 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 in de brongegevensset zijn 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.
uri	str De URL voor de web-API. Vereist.
http_headers	dict[str, str] De headers die nodig zijn om de HTTP-aanvraag te maken.
http_method	str De methode voor de HTTP-aanvraag.
timeout	timedelta De gewenste time-out voor de aanvraag. De standaardwaarde is 30 seconden.
batch_size	int De gewenste batchgrootte die het aantal documenten aangeeft.
degree_of_parallelism	int Indien ingesteld, het aantal parallelle aanroepen dat kan worden uitgevoerd naar de web-API.

Variabelen

Name	Description
odata_type	str Een URI-fragment dat het type vaardigheid aangeeft. Vereist.
name	str De naam van de vaardigheid die deze uniek identificeert binnen de vaardighedenset. Een vaardigheid zonder gedefinieerde naam krijgt een standaardnaam van de op 1 gebaseerde index in de vaardighedenmatrix, voorafgegaan door het teken #.
description	str De beschrijving van de vaardigheid die de invoer, uitvoer en het gebruik van de vaardigheid beschrijft.
context	str Vertegenwoordigt het niveau 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 in de brongegevensset zijn 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.
uri	str De URL voor de web-API. Vereist.
http_headers	dict[str, str] De headers die nodig zijn om de HTTP-aanvraag te maken.
http_method	str De methode voor de HTTP-aanvraag.
timeout	timedelta De gewenste time-out voor de aanvraag. De standaardwaarde is 30 seconden.
batch_size	int De gewenste batchgrootte die het aantal documenten aangeeft.
degree_of_parallelism	int Indien ingesteld, het aantal parallelle aanroepen dat kan worden uitgevoerd naar de web-API.

Methoden

as_dict	Een dict retourneren dat kan worden geserialiseerd met behulp van json.dump. Geavanceerd gebruik kan eventueel een callback gebruiken als parameter: Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dictaat 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ërarchische resultaatdicteerfunctie. 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 retourneer een model.
enable_additional_properties_sending
from_dict	Een dicteren 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	Retourneer 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 eventueel een callback gebruiken als parameter:

Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dictaat 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ërarchische resultaatdicteerfunctie.

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 retourneer 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 stelt standaard toepassing/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 dicteren 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 dicteerfunctie met restAPI-structuur
content_type	str JSON stelt standaard toepassing/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

Retourneer 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