KnowledgebaseOperations Clase

  • Referencia

Operaciones knowledgebaseOperations.

Herencia
builtins.object
KnowledgebaseOperations

Constructor

KnowledgebaseOperations(client, config, serializer, deserializer)

Parámetros

Nombre Description
client
Requerido

Cliente para solicitudes de servicio.
config
Requerido

Configuración del cliente de servicio.
serializer
Requerido

Serializador de modelo de objetos.
deserializer
Requerido

Deserializador de modelo de objetos.

Métodos

create

Operación asincrónica para crear una nueva base de conocimiento.
delete

Elimina la base de conocimiento y todos sus datos.
download

Descarga la base de conocimiento.
generate_answer

Llamada a GenerateAnswer para consultar la base de conocimiento (QnA Maker administrado).
get_details

Obtiene los detalles de una base de conocimiento específica.
list_all

Obtiene todas las bases de conocimiento de un usuario.
publish

Publica todos los cambios en el índice de prueba de una base de conocimiento en su índice de producción.
replace

Reemplace el contenido de la base de conocimiento.
train

Llamada de entrenamiento para agregar sugerencias a la base de conocimiento (QnAMaker administrado).
update

Operación asincrónica para modificar una base de conocimiento.

create

Operación asincrónica para crear una nueva base de conocimiento.

create(create_kb_payload, custom_headers=None, raw=False, **operation_config)

Parámetros

Nombre Description
create_kb_payload
Requerido
CreateKbDTO

Publique el cuerpo de la solicitud.
custom_headers
dict

encabezados que se agregarán a la solicitud

valor predeterminado: None
raw
bool

devuelve la respuesta directa junto con la respuesta deserializada.

valor predeterminado: False
operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Tipo Description
Operation,
<xref:msrest.pipeline.ClientRawResponse>

Operation o ClientRawResponse si raw=true

Excepciones

Tipo Description
ErrorResponseException

delete

Elimina la base de conocimiento y todos sus datos.

delete(kb_id, custom_headers=None, raw=False, **operation_config)

Parámetros

Nombre Description
kb_id
Requerido
str

Id. de la base de conocimiento.
custom_headers
dict

encabezados que se agregarán a la solicitud

valor predeterminado: None
raw
bool

devuelve la respuesta directa junto con la respuesta deserializada.

valor predeterminado: False
operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Tipo Description
None,
<xref:msrest.pipeline.ClientRawResponse>

Ninguno o ClientRawResponse si raw=true

Excepciones

Tipo Description
ErrorResponseException

download

Descarga la base de conocimiento.

download(kb_id, environment, source=None, changed_since=None, custom_headers=None, raw=False, **operation_config)

Parámetros

Nombre Description
kb_id
Requerido
str

Id. de la base de conocimiento.
environment
Requerido
str o EnvironmentType

Especifica si el entorno es Test o Prod. Los valores posibles son: 'Prod', 'Test'
source
str

Filtro de propiedad de origen que se va a aplicar.

valor predeterminado: None
changed_since
str

El último filtro de propiedad de estado cambiado que se va a aplicar.

valor predeterminado: None
custom_headers
dict

encabezados que se agregarán a la solicitud

valor predeterminado: None
raw
bool

devuelve la respuesta directa junto con la respuesta deserializada.

valor predeterminado: False
operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Tipo Description
QnADocumentsDTO,
<xref:msrest.pipeline.ClientRawResponse>

QnADocumentsDTO o ClientRawResponse si raw=true

Excepciones

Tipo Description
ErrorResponseException

generate_answer

Llamada a GenerateAnswer para consultar la base de conocimiento (QnA Maker administrado).

generate_answer(kb_id, generate_answer_payload, custom_headers=None, raw=False, **operation_config)

Parámetros

Nombre Description
kb_id
Requerido
str

Id. de la base de conocimiento.
generate_answer_payload
Requerido
QueryDTO

Publique el cuerpo de la solicitud.
custom_headers
dict

encabezados que se agregarán a la solicitud

valor predeterminado: None
raw
bool

devuelve la respuesta directa junto con la respuesta deserializada.

valor predeterminado: False
operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Tipo Description
QnASearchResultList,
<xref:msrest.pipeline.ClientRawResponse>

QnASearchResultList o ClientRawResponse si raw=true

Excepciones

Tipo Description
ErrorResponseException

get_details

Obtiene los detalles de una base de conocimiento específica.

get_details(kb_id, custom_headers=None, raw=False, **operation_config)

Parámetros

Nombre Description
kb_id
Requerido
str

Id. de la base de conocimiento.
custom_headers
dict

encabezados que se agregarán a la solicitud

valor predeterminado: None
raw
bool

devuelve la respuesta directa junto con la respuesta deserializada.

valor predeterminado: False
operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Tipo Description
KnowledgebaseDTO,
<xref:msrest.pipeline.ClientRawResponse>

KnowledgebaseDTO o ClientRawResponse si raw=true

Excepciones

Tipo Description
ErrorResponseException

list_all

Obtiene todas las bases de conocimiento de un usuario.

list_all(custom_headers=None, raw=False, **operation_config)

Parámetros

Nombre Description
custom_headers
dict

encabezados que se agregarán a la solicitud

valor predeterminado: None
raw
bool

devuelve la respuesta directa junto con la respuesta deserializada.

valor predeterminado: False
operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Tipo Description
KnowledgebasesDTO,
<xref:msrest.pipeline.ClientRawResponse>

KnowledgebasesDTO o ClientRawResponse si raw=true

Excepciones

Tipo Description
ErrorResponseException

publish

Publica todos los cambios en el índice de prueba de una base de conocimiento en su índice de producción.

publish(kb_id, custom_headers=None, raw=False, **operation_config)

Parámetros

Nombre Description
kb_id
Requerido
str

Id. de la base de conocimiento.
custom_headers
dict

encabezados que se agregarán a la solicitud

valor predeterminado: None
raw
bool

devuelve la respuesta directa junto con la respuesta deserializada.

valor predeterminado: False
operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Tipo Description
None,
<xref:msrest.pipeline.ClientRawResponse>

Ninguno o ClientRawResponse si raw=true

Excepciones

Tipo Description
ErrorResponseException

replace

Reemplace el contenido de la base de conocimiento.

replace(kb_id, qn_alist, custom_headers=None, raw=False, **operation_config)

Parámetros

Nombre Description
kb_id
Requerido
str

Id. de la base de conocimiento.
qn_alist
Requerido
list[QnADTO]

Lista de Q-A (QnADTO) que se va a agregar a la base de conocimiento. El servicio asigna los identificadores de Q-A y se debe omitir.
custom_headers
dict

encabezados que se agregarán a la solicitud

valor predeterminado: None
raw
bool

devuelve la respuesta directa junto con la respuesta deserializada.

valor predeterminado: False
operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Tipo Description
None,
<xref:msrest.pipeline.ClientRawResponse>

Ninguno o ClientRawResponse si raw=true

Excepciones

Tipo Description
ErrorResponseException

train

Llamada de entrenamiento para agregar sugerencias a la base de conocimiento (QnAMaker administrado).

train(kb_id, feedback_records=None, custom_headers=None, raw=False, **operation_config)

Parámetros

Nombre Description
kb_id
Requerido
str

Id. de la base de conocimiento.
feedback_records
list[FeedbackRecordDTO]

Lista de registros de comentarios.

valor predeterminado: None
custom_headers
dict

encabezados que se agregarán a la solicitud

valor predeterminado: None
raw
bool

devuelve la respuesta directa junto con la respuesta deserializada.

valor predeterminado: False
operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Tipo Description
None,
<xref:msrest.pipeline.ClientRawResponse>

Ninguno o ClientRawResponse si raw=true

Excepciones

Tipo Description
ErrorResponseException

update

Operación asincrónica para modificar una base de conocimiento.

update(kb_id, update_kb, custom_headers=None, raw=False, **operation_config)

Parámetros

Nombre Description
kb_id
Requerido
str

Id. de la base de conocimiento.
update_kb
Requerido
UpdateKbOperationDTO

Publique el cuerpo de la solicitud.
custom_headers
dict

encabezados que se agregarán a la solicitud

valor predeterminado: None
raw
bool

devuelve la respuesta directa junto con la respuesta deserializada.

valor predeterminado: False
operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Tipo Description
Operation,
<xref:msrest.pipeline.ClientRawResponse>

Operation o ClientRawResponse si raw=true

Excepciones

Tipo Description
ErrorResponseException

Atributos

models 

models = <module 'azure.cognitiveservices.knowledge.qnamaker.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\knowledge\\qnamaker\\models\\__init__.py'>