Question Answering Projects - Import

Referência

Serviço:: Cognitive Services - Language

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

Importar recursos 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 do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto final dos Serviços Cognitivos suportado (por exemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	O nome do projeto a utilizar.
api-version	query	True	string	Versão da API de Cliente.
assetKind	query		string	Tipo de recurso do projeto.
format	query		format	Formato de Importação ou Exportação da base de dados de conhecimento.

Corpo do Pedido

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

Respostas

Name	Tipo	Description
202 Accepted		Um resultado de chamada bem-sucedido com um cabeçalho de Operation-Location utilizado para verificar o estado da tarefa. Cabeçalhos Operation-Location: string
Other Status Codes	ErrorResponse	Resposta de erro.

Name

Tipo

Description

202 Accepted

Um resultado de chamada bem-sucedido com um cabeçalho de Operation-Location utilizado para verificar o estado da tarefa.

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 controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Azure Active Directory. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Atualmente, o Azure Active Directory v1.0 ou v2.0 suporta o Trabalho, a Escola e os Convidados, mas não suporta contas Pessoais.

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

Âmbitos

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

Ocp-Apim-Subscription-Key

Uma chave de subscrição para um recurso do Serviço de idiomas.

Tipo: apiKey
Em: header

Exemplos

Successful query

Pedido de amostra

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 da amostra

Código de estado:: 202

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

Definições

Name	Description
Assets	Todos os recursos 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	Formato de Importação ou Exportação da base de dados de conhecimento.
ImportJobOptions	Project assets the needs to be imported.
ImportQnaRecord	Importar Registo de FAQ.
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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectSettings	Definições configuráveis do Project.
QnaDialog	Caixa de diálogo associada ao Registo de FAQ.
QnaPrompt	Pedir uma resposta.
QnaRecord	Registo de FAQ.
SuggestedQuestion	Pergunta sugerida pela funcionalidade Aprendizagem Ativa.
SuggestedQuestionsCluster	A Aprendizagem Ativa sugeriu perguntas sobre os detalhes do cluster.
WordAlterations	Coleção de alterações de palavras.

Assets

Todos os recursos para este projeto.

Name	Tipo	Description
qnas	ImportQnaRecord[]	Lista de registos de FAQ a importar.
synonyms	WordAlterations[]	Coleção de sinónimos.

CreateProjectOptions

Parâmetros necessários para criar o projeto.

Name	Tipo	Description
description	string	Descrição do projeto.
language	string	Idioma dos registos de texto. Esta é a representação BCP-47 de um idioma. Por exemplo, utilize "en" para inglês; "es" para espanhol, etc. Se não estiver definido, utilize "en" para inglês como predefinição.
multilingualResource	boolean	Defina como verdadeiro para ativar a criação de bases de dados de conhecimento em idiomas diferentes para o mesmo recurso.
settings	ProjectSettings	Definições configuráveis do Project.

Error

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma série de detalhes sobre erros específicos que levaram a este erro comunicado.
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 destino do erro.

ErrorCode

Código de erro legível por humanos.

Name	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.

Name	Tipo	Description
error	Error	O objeto de erro.

format

Formato de Importação ou Exportação da base de dados de conhecimento.

Name	Tipo	Description
excel	string	Exportar ou Importar base de dados de conhecimento réplica, incluindo todos os recursos e metadados no formato Tsv.
json	string	Exportar ou Importar recursos de FAQ no formato JSON.
tsv	string	Exportar ou Importar base de dados de conhecimento réplica, incluindo todos os recursos e metadados no formato excel.

ImportJobOptions

Project assets the needs to be imported.

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

ImportQnaRecord

Importar Registo de FAQ.

Name	Tipo	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista de sugestões de Aprendizagem Ativa para o FAQ.
answer	string	Responder a texto.
dialog	QnaDialog	Contexto de um FAQ.
id	integer	ID exclusivo para o FAQ.
lastUpdatedDateTime	string	Data/hora em que o FAQ 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	Origem a partir da qual o FAQ 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.

Name	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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	InnerErrorCode	Um dos conjuntos de códigos de erro definidos 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	Destino do erro.

ProjectSettings

Definições configuráveis do Project.

Name	Tipo	Description
defaultAnswer	string	Resposta predefinida quando não é encontrada uma boa correspondência no base de dados de conhecimento.

QnaDialog

Caixa de diálogo associada ao Registo de FAQ.

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

QnaPrompt

Pedir uma resposta.

Name	Tipo	Description
displayOrder	integer	Índice da linha de comandos. É utilizado para ordenar os pedidos.
displayText	string	Texto apresentado para representar um pedido de perguntas de seguimento.
qna	QnaRecord	Registo de FAQ. O QnAId ou o registo de FAQ têm de estar presentes num Pedido.
qnaId	integer	ID da FAQ correspondente à linha de comandos.

QnaRecord

Registo de FAQ.

Name	Tipo	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista de sugestões de Aprendizagem Ativa para o FAQ.
answer	string	Responder a texto.
dialog	QnaDialog	Contexto de um FAQ.
id	integer	ID exclusivo para o FAQ.
metadata	object	Metadados associados à resposta, úteis para categorizar ou filtrar respostas a perguntas.
questions	string[]	Lista de perguntas associadas à resposta.
source	string	Origem a partir da qual o FAQ foi indexado, por exemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Pergunta sugerida pela funcionalidade Aprendizagem Ativa.

Name	Tipo	Description
autoSuggestedCount	integer	O número de vezes que a pergunta foi sugerida automaticamente pelo algoritmo de Aprendizagem Ativa.
question	string	Pergunta sugerida pela funcionalidade Aprendizagem Ativa.
userSuggestedCount	integer	O número de vezes que a pergunta foi sugerida explicitamente pelo utilizador.

SuggestedQuestionsCluster

A Aprendizagem Ativa sugeriu perguntas sobre os detalhes do cluster.

Name	Tipo	Description
clusterHead	string	Pergunta escolhida como responsável pelo cluster de perguntas sugeridas pelo algoritmo de clustering do Active Learning.
suggestedQuestions	SuggestedQuestion[]	Lista de todas as perguntas sugeridas para o FAQ.

WordAlterations

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

Corpo do Pedido

Respostas

Segurança

AADToken

Notas

Âmbitos

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

Recursos adicionais