Question Answering Projects - Import

Referencia

Servicio:: Cognitive Services - Language

Versión de la API:: 2023-04-01

Importe los recursos del proyecto.

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01

Con parámetros opcionales:

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01&format={format}&assetKind={assetKind}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nombre del proyecto que se va a usar.
api-version	query	True	string	Versión de API del cliente.
assetKind	query		string	Tipo de recurso del proyecto.
format	query		format	Formato de importación o exportación de la base de conocimiento.

Cuerpo de la solicitud

Nombre	Tipo	Description
assets	Assets	Todos los recursos de este proyecto.
fileUri	string	Importe el URI del archivo de datos.
metadata	CreateProjectOptions	Parámetros necesarios para crear el proyecto.

Respuestas

Nombre	Tipo	Description
202 Accepted		Una llamada correcta devuelve un encabezado Operation-Location que se usa para comprobar el estado del trabajo. Encabezados Operation-Location: string
Other Status Codes	ErrorResponse	Respuesta de error.

Nombre

Tipo

Description

202 Accepted

Una llamada correcta devuelve un encabezado Operation-Location que se usa para comprobar el estado del trabajo.

Encabezados

Operation-Location: string

Other Status Codes

ErrorResponse

Respuesta de error.

Seguridad

AADToken

Estos son los flujos de OAuth2 de Azure Active Directory . Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.

Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Azure Active Directory. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST. * El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

Actualmente, Azure Active Directory v1.0 o v2.0 admite Work, School e Invitados, pero no admite cuentas personales.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Una clave de suscripción para un recurso de servicio de lenguaje.

Tipo: apiKey
En: header

Ejemplos

Successful query

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:import?api-version=2023-04-01

{
  "assets": {
    "synonyms": [
      {
        "alterations": [
          "wa",
          "washington",
          "washington state"
        ]
      },
      {
        "alterations": [
          "U.S",
          "usa",
          "united states of america"
        ]
      }
    ],
    "qnas": [
      {
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "id": 1,
        "answer": "ans1",
        "source": "source1",
        "questions": [
          "question 1.1",
          "question 1.2"
        ],
        "metadata": {
          "k1": "v1",
          "k2": "v2"
        },
        "dialog": {
          "isContextOnly": false,
          "prompts": [
            {
              "displayOrder": 1,
              "qnaId": 2,
              "displayText": "prompt 1.1"
            }
          ]
        }
      },
      {
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "id": 2,
        "answer": "ans2",
        "source": "source2",
        "questions": [
          "question 2.1",
          "question 2.2"
        ]
      }
    ]
  }
}

Respuesta de muestra

status code:: 202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/import/jobs/job1?api-version=2023-04-01

Definiciones

Nombre	Description
Assets	Todos los recursos de este proyecto.
CreateProjectOptions	Parámetros necesarios para crear el proyecto.
Error	Objeto de error.
ErrorCode	Código de error legible.
ErrorResponse	Respuesta de error.
format	Formato de importación o exportación de la base de conocimiento.
ImportJobOptions	Recursos del proyecto que se deben importar.
ImportQnaRecord	Importe el registro QnA.
InnerErrorCode	Código de error legible.
InnerErrorModel	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectSettings	Configuración configurable del proyecto.
QnaDialog	Cuadro de diálogo asociado al registro QnA.
QnaPrompt	Pida una respuesta.
QnaRecord	Registro QnA.
SuggestedQuestion	Pregunta sugerida por la característica Aprendizaje activo.
SuggestedQuestionsCluster	Detalles del clúster de preguntas sugeridas de Active Learning.
WordAlterations	Colección de modificaciones de palabras.

Assets

Todos los recursos de este proyecto.

Nombre	Tipo	Description
qnas	ImportQnaRecord[]	Lista de registros de QnA que se van a importar.
synonyms	WordAlterations[]	Colección de sinónimos.

CreateProjectOptions

Parámetros necesarios para crear el proyecto.

Nombre	Tipo	Description
description	string	Descripción del proyecto.
language	string	Idioma de los registros de texto. Esta es una representación BCP-47 de un idioma. Por ejemplo, use "en" para inglés; "es" para español, etc. Si no se establece, use "en" para inglés como valor predeterminado.
multilingualResource	boolean	Establézcalo en true para habilitar la creación de bases de conocimiento en distintos lenguajes para el mismo recurso.
settings	ProjectSettings	Configuración configurable del proyecto.

Error

Objeto de error.

Nombre	Tipo	Description
code	ErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

ErrorCode

Código de error legible.

Nombre	Tipo	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

format

Formato de importación o exportación de la base de conocimiento.

Nombre	Tipo	Description
excel	string	Exporte o importe knowledge base réplica, incluidos todos los recursos y metadatos en formato Tsv.
json	string	Exporte o importe recursos de QnA en formato JSON.
tsv	string	Exporte o importe knowledge base réplica, incluidos todos los recursos y metadatos en formato de Excel.

ImportJobOptions

Recursos del proyecto que se deben importar.

Nombre	Tipo	Description
assets	Assets	Todos los recursos de este proyecto.
fileUri	string	Importe el URI del archivo de datos.
metadata	CreateProjectOptions	Parámetros necesarios para crear el proyecto.

ImportQnaRecord

Importe el registro QnA.

Nombre	Tipo	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista de sugerencias de Aprendizaje activo para la QnA.
answer	string	Texto de respuesta.
dialog	QnaDialog	Contexto de una QnA.
id	integer	Identificador único de QnA.
lastUpdatedDateTime	string	Fecha y hora en que se actualizó por última vez la QnA.
metadata	object	Metadatos asociados a la respuesta, útiles para clasificar o filtrar respuestas de preguntas.
questions	string[]	Lista de preguntas asociadas a la respuesta.
source	string	Origen desde el que QnA se indizó, por ejemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .
sourceDisplayName	string	Nombre descriptivo del origen.

InnerErrorCode

Código de error legible.

Nombre	Tipo	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	InnerErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	object	Detalles del error.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Mensaje de error.
target	string	Destino de error.

ProjectSettings

Configuración configurable del proyecto.

Nombre	Tipo	Description
defaultAnswer	string	Respuesta predeterminada cuando no se encuentra ninguna buena coincidencia en el knowledge base.

QnaDialog

Cuadro de diálogo asociado al registro QnA.

Nombre	Tipo	Description
isContextOnly	boolean	Para marcar si una solicitud solo es relevante con una pregunta anterior o no. Si es true, no incluya esta QnA como respuesta para las consultas sin contexto; de lo contrario, omite el contexto e incluye esta QnA en las respuestas.
prompts	QnaPrompt[]	Lista de mensajes asociados a la respuesta.

QnaPrompt

Pida una respuesta.

Nombre	Tipo	Description
displayOrder	integer	Índice del símbolo del sistema. Se usa para ordenar los mensajes.
displayText	string	Texto que se muestra para representar un mensaje de pregunta de seguimiento.
qna	QnaRecord	Registro QnA. El registro QnAId o QnA debe estar presente en un símbolo del sistema.
qnaId	integer	Identificador de la QnA correspondiente al símbolo del sistema.

QnaRecord

Registro QnA.

Nombre	Tipo	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista de sugerencias de Aprendizaje activo para la QnA.
answer	string	Texto de respuesta.
dialog	QnaDialog	Contexto de una QnA.
id	integer	Identificador único de QnA.
metadata	object	Metadatos asociados a la respuesta, útiles para clasificar o filtrar respuestas de preguntas.
questions	string[]	Lista de preguntas asociadas a la respuesta.
source	string	Origen desde el que QnA se indizó, por ejemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Pregunta sugerida por la característica Aprendizaje activo.

Nombre	Tipo	Description
autoSuggestedCount	integer	El número de veces que el algoritmo de Aprendizaje activo sugirió automáticamente la pregunta.
question	string	Pregunta sugerida por la característica Aprendizaje activo.
userSuggestedCount	integer	El usuario sugirió explícitamente el número de veces que la pregunta.

SuggestedQuestionsCluster

Detalles del clúster de preguntas sugeridas de Active Learning.

Nombre	Tipo	Description
clusterHead	string	Pregunta elegida como encabezado del clúster de preguntas sugeridas por el algoritmo de agrupación en clústeres de Active Learning.
suggestedQuestions	SuggestedQuestion[]	Lista de todas las preguntas sugeridas para la QnA.

WordAlterations

Colección de modificaciones de palabras.

Nombre	Tipo	Description
alterations	string[]	Colección de modificaciones de palabras.

Compartir a través de

Question Answering Projects - Import

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

AADToken

Notas

Ámbitos

Ocp-Apim-Subscription-Key

Ejemplos

Successful query

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Assets

CreateProjectOptions

Error

ErrorCode

ErrorResponse

format

ImportJobOptions

ImportQnaRecord

InnerErrorCode

InnerErrorModel

ProjectSettings

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

WordAlterations

Recursos adicionales