SearchIndexerSkill Classe

Tipo base para competências.

É provável que queira utilizar as subclasses e não esta classe diretamente. As sub classes conhecidas são: WebApiSkill, CustomEntityLookupSkill, EntityRecognitionSkill, KeyPhraseExtractionSkill, LanguageDetectionSkill, MergeSkill, PIIDetectionSkill, SentimentSkill, SplitSkill, TextTranslationSkill, EntityLinkingSkill, EntityRecognitionSkillV3, SentimentSkillV3, ConditionalSkill, DocumentExtractionSkill, ShaperSkill, ImageAnalysisSkill, OcrSkill

Todos os parâmetros necessários têm de ser preenchidos para enviar para o Azure.

Herança

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

SearchIndexerSkill

Construtor

SearchIndexerSkill(*, inputs: List[_models.InputFieldMappingEntry], outputs: List[_models.OutputFieldMappingEntry], name: str | None = None, description: str | None = None, context: str | None = None, **kwargs: Any)

Parâmetros Só de Palavra-Chave

Name	Description
name	str O nome da competência que a identifica exclusivamente no conjunto de competências. Uma competência sem nome definido receberá um nome predefinido do respetivo índice baseado em 1 na matriz de competências, com o prefixo com o caráter #.
description	str A descrição da competência que descreve as entradas, saídas e utilização da competência.
context	str Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /documento ou /documento/conteúdo). A predefinição é /document.
inputs	list[<xref:search_service_client.models.InputFieldMappingEntry>] As entradas das competências podem ser uma coluna no conjunto de dados de origem ou a saída de uma competência a montante. Obrigatório.
outputs	list[<xref:search_service_client.models.OutputFieldMappingEntry>] O resultado de uma competência é um campo num índice de pesquisa ou um valor que pode ser consumido como entrada por outra competência. Obrigatório.

Variáveis

Name	Description
odata_type	str Um fragmento de URI que especifica o tipo de competência. Obrigatório.
name	str O nome da competência que a identifica exclusivamente no conjunto de competências. Uma competência sem nome definido receberá um nome predefinido do respetivo índice baseado em 1 na matriz de competências, com o prefixo com o caráter #.
description	str A descrição da competência que descreve as entradas, saídas e utilização da competência.
context	str Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /documento ou /documento/conteúdo). A predefinição é /document.
inputs	list[<xref:search_service_client.models.InputFieldMappingEntry>] As entradas das competências podem ser uma coluna no conjunto de dados de origem ou a saída de uma competência a montante. Obrigatório.
outputs	list[<xref:search_service_client.models.OutputFieldMappingEntry>] O resultado de uma competência é um campo num índice de pesquisa ou um valor que pode ser consumido como entrada por outra competência. Obrigatório.

Métodos

as_dict	Devolver um ditado que pode ser serializado com json.dump. Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro: A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente, contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. O valor é o valor atual neste objeto. A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict de resultado hierárquico. Veja os três exemplos neste ficheiro: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Se quiser serialização XML, pode transmitir os kwargs is_xml=True.
deserialize	Analise um str com a sintaxe RestAPI e devolva um modelo.
enable_additional_properties_sending
from_dict	Analisar um ditado com um determinado extrator de chaves devolve um modelo. Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Devolver o JSON que seria enviado para o servidor a partir deste modelo. Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso). Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

as_dict

Devolver um ditado que pode ser serializado com json.dump.

Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro:

A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente, contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. O valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict de resultado hierárquico.

Veja os três exemplos neste ficheiro:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

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]

Parâmetros

Name	Description
key_transformer	<xref:function> Uma função de transformador de chaves.
keep_readonly	valor predefinido: True

Devoluções

Tipo	Description
dict	Um objeto compatível com JSON de ditado

deserialize

Analise um str com a sintaxe RestAPI e devolva um modelo.

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

Parâmetros

Name	Description
data Necessário	str Um str com a estrutura RestAPI. JSON por predefinição.
content_type	str JSON por predefinição, defina application/xml se XML. valor predefinido: None

Devoluções

Tipo	Description
	Uma instância deste modelo

Exceções

Tipo	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analisar um ditado com um determinado extrator de chaves devolve um modelo.

Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e 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

Parâmetros

Name	Description
data Necessário	dict Um ditado com a estrutura restAPI
content_type	str JSON por predefinição, defina application/xml se XML. valor predefinido: None
key_extractors	valor predefinido: None

Devoluções

Tipo	Description
	Uma instância deste modelo

Exceções

Tipo	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Devolver o JSON que seria enviado para o servidor a partir deste modelo.

Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso).

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

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

Parâmetros

Name	Description
keep_readonly	bool Se quiser serializar os atributos só de leitura valor predefinido: False

Devoluções

Tipo	Description
dict	Um objeto compatível com JSON de ditado