Question Answering Projects - Import

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2021-10-01

Importar recursos del proyecto.

POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:import?api-version=2021-10-01

Con parámetros opcionales:

POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:import?api-version=2021-10-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 maxLength: 100	Nombre del proyecto que se va a usar.
api-version	query	True	string	Versión de la API de cliente.
assetKind	query		string	Tipo de recurso del proyecto.
format	query		format	Formato de importación o exportación de la base de conocimiento.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

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

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Successful query

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/query-knowledgebases/projects/proj1/:import?api-version=2021-10-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": 11,
              "displayText": "prompt 1.1"
            },
            {
              "displayOrder": 2,
              "qnaId": 21,
              "displayText": "prompt 1.2"
            }
          ]
        }
      },
      {
        "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: job1

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 para personas.
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 para personas.
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	Opciones configurables del proyecto.
QnaDialog	Cuadro de diálogo asociado con el registro de QnA.
QnaPrompt	Solicitar una respuesta.
QnaRecord	Registro QnA.
SuggestedQuestion	Pregunta sugerida por la característica De aprendizaje activo.
SuggestedQuestionsCluster	Detalles del clúster de preguntas sugeridas de Active Learning.
WordAlterations	Colección de modificaciones de palabras.

Assets

Object

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

Object

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 la 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 idiomas para el mismo recurso.
settings	ProjectSettings	Opciones configurables del proyecto.

Error

Object

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

Enumeración

Código de error legible para personas.

Valor	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

format

Enumeración

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

Valor	Description
excel	Exporte o importe la réplica de la base de conocimiento, incluidos todos los recursos y metadatos en formato Tsv.
json	Exporte o importe recursos de QnA en formato JSON.
tsv	Exporte o importe la réplica de la base de conocimiento, incluidos todos los recursos y metadatos en formato excel.

ImportJobOptions

Object

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

Object

Importe el registro QnA.

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

InnerErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

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

Object

Opciones configurables del proyecto.

Nombre	Tipo	Description
defaultAnswer	string	Respuesta de respuesta predeterminada cuando no se encuentra ninguna coincidencia correcta en la base de conocimiento.

QnaDialog

Object

Cuadro de diálogo asociado con el registro de 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 respuestas.
prompts	QnaPrompt[]	Lista de mensajes asociados a la respuesta.

QnaPrompt

Object

Solicitar una respuesta.

Nombre	Tipo	Description
displayOrder	integer (int32)	Índice del símbolo del sistema. Se usa para ordenar las solicitudes.
displayText	string maxLength: 200	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 (int32)	Identificador de la QnA correspondiente al símbolo del sistema.

QnaRecord

Object

Registro QnA.

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

SuggestedQuestion

Object

Pregunta sugerida por la característica De aprendizaje activo.

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

SuggestedQuestionsCluster

Object

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 el QnA.

WordAlterations

Object

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

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

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