CreateKbDTO Classe

  • Referência

Esquema pós-corpo para a operação CreateKb.

Todos os parâmetros necessários devem ser preenchidos para enviar ao Azure.

Herança
Model
CreateKbDTO

Construtor

CreateKbDTO(*, name: str, qna_list=None, urls=None, files=None, enable_hierarchical_extraction: bool = None, default_answer_used_for_extraction: str = None, language: str = None, enable_multiple_languages: bool = None, default_answer: str = None, **kwargs)

Parâmetros

name
str
Obrigatório

Obrigatórios. Nome amigável para a base de dados de conhecimento.

qna_list
list[QnADTO]
Obrigatório

Lista de QnADTO (QnADTO) a serem adicionados à base de dados de conhecimento. As IDs de Q-A são atribuídas pelo serviço e devem ser omitidas.

urls
list[str]
Obrigatório

Lista de URLs a serem usadas para extrair Q-A.

files
list[FileDTO]
Obrigatório

Lista de arquivos dos quais extrair Q-A.

enable_hierarchical_extraction
bool
Obrigatório

Habilite a extração hierárquica de Q-A de arquivos e urls. Valor a ser considerado False se este campo não estiver presente.

default_answer_used_for_extraction
str
Obrigatório

Cadeia de caracteres de texto a ser usada como resposta em qualquer Q-A que não tenha resposta extraída do documento, mas que tenha uma hierarquia. Necessário quando o campo EnableHierarchicalExtraction é definido como True.

language
str
Obrigatório

Linguagem da base de dados de conhecimento. Localize a lista de idiomas com suporte aqui.

enable_multiple_languages
bool
Obrigatório

Defina como true para habilitar a criação de KBs em idiomas diferentes para o mesmo recurso.

default_answer
str
Obrigatório

Resposta padrão enviada ao usuário se nenhuma boa correspondência for encontrada no KB.

Métodos

as_dict

Retornar um ditado que pode ser JSONify usando json.dump.

O uso avançado pode, opcionalmente, usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um ditado de metadados. Atualmente, contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto.

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.
deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.
enable_additional_properties_sending
from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Retorne o JSON que seria enviado para o azure desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.
validate

Valide esse modelo recursivamente e retorne uma lista de ValidationError.

as_dict

Retornar um ditado que pode ser JSONify usando json.dump.

O uso avançado pode, opcionalmente, usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um ditado de metadados. Atualmente, contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto.

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parâmetros

key_transformer
<xref:function>

Uma função de transformador de chave.

keep_readonly
valor padrão: True

Retornos

Um objeto compatível com JSON de ditado

Tipo de retorno

dict

deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.

deserialize(data, content_type=None)

Parâmetros

data
str
Obrigatório

Um str usando a estrutura RestAPI. JSON por padrão.

content_type
str
valor padrão: None

JSON por padrão, defina application/xml se XML.

Retornos

Uma instância desse modelo

Exceções

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parâmetros

data
dict
Obrigatório

Um ditado usando a estrutura RestAPI

content_type
str
valor padrão: None

JSON por padrão, defina application/xml se XML.

key_extractors
valor padrão: None

Retornos

Uma instância desse modelo

Exceções

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

Retorne o JSON que seria enviado para o azure desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parâmetros

keep_readonly
bool
valor padrão: False

Se você quiser serializar os atributos somente leitura

Retornos

Um objeto compatível com JSON de ditado

Tipo de retorno

dict

validate

Valide esse modelo recursivamente e retorne uma lista de ValidationError.

validate()

Retornos

Uma lista de erros de validação

Tipo de retorno

list