Question Answering Projects - Import

Serviço:: Azure AI Services

Versão da API:: 2021-10-01

Importar ativos do projeto.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade de Serviços Cognitivos suportado (por exemplo, https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	O nome do projeto a ser usado.
api-version	query	True	string	Versão da API do cliente.
assetKind	query		string	Tipo de ativo do projeto.
format	query		format	Base de dados de conhecimento Formato de importação ou exportação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo do Pedido

Name	Tipo	Description
assets	Assets	Todos os ativos para este projeto.
fileUri	string	Importe o URI do arquivo de dados.
metadata	CreateProjectOptions	Parâmetros necessários para criar o projeto.

Respostas

Name	Tipo	Description
202 Accepted		Uma chamada bem-sucedida resulta com um cabeçalho Operation-Location usado para verificar o status do trabalho. Cabeçalhos Operation-Location: string
Other Status Codes	ErrorResponse	Resposta de erro.

Name

Tipo

Description

202 Accepted

Uma chamada bem-sucedida resulta com um cabeçalho Operation-Location usado para verificar o status do trabalho.

Cabeçalhos

Operation-Location: string

Other Status Codes

ErrorResponse

Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Successful query

Pedido de amostra

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"
        ]
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 202

Operation-Location: job1

Definições

Name	Description
Assets	Todos os ativos para este projeto.
CreateProjectOptions	Parâmetros necessários para criar o projeto.
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
format	Base de dados de conhecimento Formato de importação ou exportação.
ImportJobOptions	Os ativos do projeto precisam ser importados.
ImportQnaRecord	Importe o registro QnA.
InnerErrorCode	Código de erro legível por humanos.
InnerErrorModel	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectSettings	Configurações configuráveis do Projeto.
QnaDialog	Caixa de diálogo associada ao QnA Record.
QnaPrompt	Solicite uma resposta.
QnaRecord	Registo QnA.
SuggestedQuestion	Pergunta sugerida pelo recurso Aprendizagem Ativa.
SuggestedQuestionsCluster	Detalhes do cluster de perguntas sugeridas pelo Ative Learning.
WordAlterations	Coleção de alterações de palavras.

Assets

Object

Todos os ativos para este projeto.

Name	Tipo	Description
qnas	ImportQnaRecord[]	Lista de registros QnA a serem importados.
synonyms	WordAlterations[]	Coleção de sinônimos.

CreateProjectOptions

Object

Parâmetros necessários para criar o projeto.

Name	Tipo	Description
description	string	Descrição do projeto.
language	string	Língua dos registos de texto. Esta é a representação BCP-47 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.
multilingualResource	boolean	Defina como true para permitir a criação de bases de conhecimento em idiomas diferentes para o mesmo recurso.
settings	ProjectSettings	Configurações configuráveis do Projeto.

Error

Object

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

ErrorCode

Enumeração

Código de erro legível por humanos.

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

ErrorResponse

Object

Resposta de erro.

Name	Tipo	Description
error	Error	O objeto de erro.

format

Enumeração

Base de dados de conhecimento Formato de importação ou exportação.

Valor	Description
json	Exporte ou importe ativos QnA no formato JSON.
tsv	Exporte ou importe a réplica da base de dados de conhecimento, incluindo todos os ativos e metadados no formato Excel.
excel	Exporte ou importe a réplica da base de dados de conhecimento, incluindo todos os ativos e metadados no formato Tsv.

ImportJobOptions

Object

Os ativos do projeto precisam ser importados.

Name	Tipo	Description
assets	Assets	Todos os ativos para este projeto.
fileUri	string	Importe o URI do arquivo de dados.
metadata	CreateProjectOptions	Parâmetros necessários para criar o projeto.

ImportQnaRecord

Object

Importe o registro QnA.

Name	Tipo	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista de sugestões de Aprendizagem Ativa para a QnA.
answer	string minLength: 1 maxLength: 25000	Texto da resposta.
dialog	QnaDialog	Contexto de uma QnA.
id	integer (int32)	ID exclusivo para o QnA.
lastUpdatedDateTime	string (date-time)	Data-hora em que o QnA foi atualizado pela última vez.
metadata	object	Metadados associados à resposta, úteis para categorizar ou filtrar respostas a perguntas.
questions	string[]	Lista de perguntas associadas à resposta.
source	string maxLength: 300	Fonte a partir da qual a QnA foi indexada, por exemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .
sourceDisplayName	string minLength: 1 maxLength: 200	Nome amigável da fonte.

InnerErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure

InnerErrorModel

Object

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	InnerErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
details	object	Detalhes do erro.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Mensagem de erro.
target	string	Alvo de erro.

ProjectSettings

Object

Configurações configuráveis do Projeto.

Name	Tipo	Description
defaultAnswer	string	Resposta de resposta padrão quando nenhuma boa correspondência é encontrada na base de dados de conhecimento.

QnaDialog

Object

Caixa de diálogo associada ao QnA Record.

Name	Tipo	Description
isContextOnly	boolean	Para marcar se um prompt é relevante apenas com uma pergunta anterior ou não. Se verdadeiro, não inclua este QnA como resposta para consultas sem contexto; caso contrário, ignora o contexto e inclui este QnA nas respostas.
prompts	QnaPrompt[]	Lista de prompts associados à resposta.

QnaPrompt

Object

Solicite uma resposta.

Name	Tipo	Description
displayOrder	integer (int32)	Índice do prompt. Ele é usado para ordenar os prompts.
displayText	string maxLength: 200	Texto exibido para representar um prompt de pergunta de acompanhamento.
qna	QnaRecord	Registo QnA. O registro QnAId ou QnA precisa estar presente em um prompt.
qnaId	integer (int32)	ID do QnA correspondente ao prompt.

QnaRecord

Object

Registo QnA.

Name	Tipo	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista de sugestões de Aprendizagem Ativa para a QnA.
answer	string minLength: 1 maxLength: 25000	Texto da resposta.
dialog	QnaDialog	Contexto de uma QnA.
id	integer (int32)	ID exclusivo para o QnA.
metadata	object	Metadados associados à resposta, úteis para categorizar ou filtrar respostas a perguntas.
questions	string[]	Lista de perguntas associadas à resposta.
source	string maxLength: 300	Fonte a partir da qual a QnA foi indexada, por exemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Object

Pergunta sugerida pelo recurso Aprendizagem Ativa.

Name	Tipo	Description
autoSuggestedCount	integer (int32)	O número de vezes que a pergunta foi sugerida automaticamente pelo algoritmo Ative Learning.
question	string	Pergunta sugerida pelo recurso Aprendizagem Ativa.
userSuggestedCount	integer (int32)	O número de vezes que a pergunta foi sugerida explicitamente pelo usuário.

SuggestedQuestionsCluster

Object

Detalhes do cluster de perguntas sugeridas pelo Ative Learning.

Name	Tipo	Description
clusterHead	string	Pergunta escolhida como cabeça do cluster de perguntas sugerido pelo algoritmo de agrupamento do Ative Learning.
suggestedQuestions	SuggestedQuestion[]	Lista de todas as perguntas sugeridas para a QnA.

WordAlterations

Object

Coleção de alterações de palavras.

Name	Tipo	Description
alterations	string[]	Coleção de alterações de palavras.

Partilhar via

Question Answering Projects - Import

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Successful query

Pedido de amostra

Resposta da amostra

Definições

Assets

CreateProjectOptions

Error

ErrorCode

ErrorResponse

format

ImportJobOptions

ImportQnaRecord

InnerErrorCode

InnerErrorModel

ProjectSettings

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

WordAlterations