Question Answering Projects - Import

Referência

Serviço:: Cognitive Services - Language

Versão da API:: 2023-04-01

Importar ativos do projeto.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	O nome do projeto a ser usado.
api-version	query	True	string	Versão de API do cliente.
assetKind	query		string	Tipo de ativo do projeto.
format	query		format	Formato de Importação ou Exportação da base de dados de conhecimento.

Corpo da solicitação

Nome	Tipo	Description
assets	Assets	Todos os ativos deste projeto.
fileUri	string	Importar URI de arquivo de dados.
metadata	CreateProjectOptions	Parâmetros necessários para criar o projeto.

Respostas

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

Nome

Tipo

Description

202 Accepted

Uma chamada bem-sucedida resulta em 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

AADToken

Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso a Azure Mapas APIs REST. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações do Azure Active Directory. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Atualmente, o Azure Active Directory v1.0 ou v2.0 dá suporte a Trabalho, Escola e Convidados, mas não dá suporte a contas pessoais.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

Ocp-Apim-Subscription-Key

Uma chave de assinatura para um recurso de serviço de linguagem.

Tipo: apiKey
Em: header

Exemplos

Successful query

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 202

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

Definições

Nome	Description
Assets	Todos os ativos deste 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	Formato de importação ou exportação da base de dados de conhecimento.
ImportJobOptions	Ativos de projeto que precisam ser importados.
ImportQnaRecord	Importar 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 Registro QnA.
QnaPrompt	Solicite uma resposta.
QnaRecord	Registro QnA.
SuggestedQuestion	Pergunta sugerida pelo recurso do Active Learning.
SuggestedQuestionsCluster	Detalhes do cluster de perguntas sugeridas do Active Learning.
WordAlterations	Coleção de alterações de palavras.

Assets

Todos os ativos deste projeto.

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

CreateProjectOptions

Parâmetros necessários para criar o projeto.

Nome	Tipo	Description
description	string	Descrição do projeto.
language	string	Idioma dos registros de texto. Esta é a representação BCP-47 de uma linguagem. 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 habilitar a criação de bases de dados de conhecimento em idiomas diferentes para o mesmo recurso.
settings	ProjectSettings	Configurações configuráveis do Projeto.

Error

O objeto de erro.

Nome	Tipo	Description
code	ErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
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 do erro.
target	string	O destino do erro.

ErrorCode

Código de erro legível por humanos.

Nome	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

Resposta de erro.

Nome	Tipo	Description
error	Error	O objeto de erro.

format

Formato de importação ou exportação da base de dados de conhecimento.

Nome	Tipo	Description
excel	string	Exporte ou importe base de dados de conhecimento réplica incluindo todos os ativos e metadados no formato Tsv.
json	string	Exportar ou importar ativos QnA no formato JSON.
tsv	string	Exporte ou importe base de dados de conhecimento réplica incluindo todos os ativos e metadados no formato excel.

ImportJobOptions

Ativos de projeto que precisam ser importados.

Nome	Tipo	Description
assets	Assets	Todos os ativos deste projeto.
fileUri	string	Importar URI de arquivo de dados.
metadata	CreateProjectOptions	Parâmetros necessários para criar o projeto.

ImportQnaRecord

Importar registro QnA.

Nome	Tipo	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista de sugestões do Active Learning para o QnA.
answer	string	Texto da resposta.
dialog	QnaDialog	Contexto de um QnA.
id	integer	ID exclusiva para o QnA.
lastUpdatedDateTime	string	Data e hora em que o QnA foi atualizado pela última vez.
metadata	object	Metadados associados à resposta, úteis para categorizar ou filtrar respostas às perguntas.
questions	string[]	Lista de perguntas associadas à resposta.
source	string	Fonte da qual o QnA foi indexado, por exemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .
sourceDisplayName	string	Nome amigável da Origem.

InnerErrorCode

Código de erro legível por humanos.

Nome	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

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.

Nome	Tipo	Description
code	InnerErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
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	Destino de erro.

ProjectSettings

Configurações configuráveis do Projeto.

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

QnaDialog

Caixa de diálogo associada ao Registro QnA.

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

QnaPrompt

Solicite uma resposta.

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

QnaRecord

Registro QnA.

Nome	Tipo	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista de sugestões do Active Learning para o QnA.
answer	string	Texto da resposta.
dialog	QnaDialog	Contexto de um QnA.
id	integer	ID exclusiva para o QnA.
metadata	object	Metadados associados à resposta, úteis para categorizar ou filtrar respostas às perguntas.
questions	string[]	Lista de perguntas associadas à resposta.
source	string	Fonte da qual o QnA foi indexado, por exemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Pergunta sugerida pelo recurso do Active Learning.

Nome	Tipo	Description
autoSuggestedCount	integer	O número de vezes que a pergunta foi sugerida automaticamente pelo algoritmo do Active Learning.
question	string	Pergunta sugerida pelo recurso do Active Learning.
userSuggestedCount	integer	O número de vezes que a pergunta foi sugerida explicitamente pelo usuário.

SuggestedQuestionsCluster

Detalhes do cluster de perguntas sugeridas do Active Learning.

Nome	Tipo	Description
clusterHead	string	Pergunta escolhida como o chefe do cluster de perguntas sugeridas pelo algoritmo de clustering do Active Learning.
suggestedQuestions	SuggestedQuestion[]	Lista de todas as perguntas sugeridas para o QnA.

WordAlterations

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

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

Compartilhar via

Question Answering Projects - Import

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

AADToken

Observações

Escopos

Ocp-Apim-Subscription-Key

Exemplos

Successful query

Solicitação de exemplo

Resposta de exemplo

Definições

Assets

CreateProjectOptions

Error

ErrorCode

ErrorResponse

format

ImportJobOptions

ImportQnaRecord

InnerErrorCode

InnerErrorModel

ProjectSettings

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

WordAlterations

Recursos adicionais