Question Answering Projects - Import

Riferimento

Servizio:: Cognitive Services - Language

Versione API:: 2023-04-01

Importare gli asset del progetto.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nome del progetto da utilizzare.
api-version	query	True	string	Versione API client.
assetKind	query		string	Tipo di asset del progetto.
format	query		format	Formato di importazione o esportazione della Knowledge Base.

Corpo della richiesta

Nome	Tipo	Descrizione
assets	Assets	Tutti gli asset per questo progetto.
fileUri	string	Importare l'URI del file di dati.
metadata	CreateProjectOptions	Parametri necessari per creare il progetto.

Risposte

Nome	Tipo	Descrizione
202 Accepted		Risultati di una chiamata con esito positivo con un'intestazione Operation-Location utilizzata per controllare lo stato del processo. Intestazioni Operation-Location: string
Other Status Codes	ErrorResponse	Risposta di errore.

Nome

Tipo

Descrizione

202 Accepted

Risultati di una chiamata con esito positivo con un'intestazione Operation-Location utilizzata per controllare lo stato del processo.

Intestazioni

Operation-Location: string

Other Status Codes

ErrorResponse

Risposta di errore.

Sicurezza

AADToken

Si tratta dei flussi OAuth2 di Azure Active Directory . Se abbinato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account di risorse o sottorisorse. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per Mappe di Azure API REST.

Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

Note

Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare a quale Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.

è Authorization URL specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni di Azure Active Directory. * Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST. * L'utilizzo di Mappe di Azure Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Attualmente Azure Active Directory v1.0 o v2.0 supporta account aziendali, dell'istituto di istruzione e guest, ma non supporta account personali.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

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

Ocp-Apim-Subscription-Key

Una chiave di sottoscrizione per una risorsa del servizio linguistico.

Tipo: apiKey
In: header

Esempio

Successful query

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 202

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

Definizioni

Nome	Descrizione
Assets	Tutti gli asset per questo progetto.
CreateProjectOptions	Parametri necessari per creare il progetto.
Error	Oggetto error.
ErrorCode	Codice di errore leggibile.
ErrorResponse	Risposta di errore.
format	Formato di importazione o esportazione della Knowledge Base.
ImportJobOptions	Gli asset di progetto devono essere importati.
ImportQnaRecord	Importa record QnA.
InnerErrorCode	Codice di errore leggibile.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectSettings	Impostazioni configurabili del progetto.
QnaDialog	Finestra di dialogo associata al record QnA.
QnaPrompt	Richiedere una risposta.
QnaRecord	Record QnA.
SuggestedQuestion	Domanda suggerita dalla funzionalità Di apprendimento attivo.
SuggestedQuestionsCluster	Dettagli del cluster delle domande suggerite di Active Learning.
WordAlterations	Raccolta di alterazioni delle parole.

Assets

Tutti gli asset per questo progetto.

Nome	Tipo	Descrizione
qnas	ImportQnaRecord[]	Elenco di record QnA da importare.
synonyms	WordAlterations[]	Raccolta di sinonimi.

CreateProjectOptions

Parametri necessari per creare il progetto.

Nome	Tipo	Descrizione
description	string	Descrizione del progetto.
language	string	Lingua dei record di testo. Questa è la rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese; "es" per spagnolo ecc. Se non è impostato, usare "en" per l'inglese come impostazione predefinita.
multilingualResource	boolean	Impostare su true per abilitare la creazione di knowledge base in lingue diverse per la stessa risorsa.
settings	ProjectSettings	Impostazioni configurabili del progetto.

Error

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Uno dei set definiti dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCode

Codice di errore leggibile.

Nome	Tipo	Descrizione
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

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

format

Formato di importazione o esportazione della Knowledge Base.

Nome	Tipo	Descrizione
excel	string	Esportare o importare knowledge base replica, inclusi tutti gli asset e i metadati in formato Tsv.
json	string	Esportare o importare asset QnA in formato JSON.
tsv	string	Esportare o importare knowledge base replica, inclusi tutti gli asset e i metadati in formato Excel.

ImportJobOptions

Gli asset di progetto devono essere importati.

Nome	Tipo	Descrizione
assets	Assets	Tutti gli asset per questo progetto.
fileUri	string	Importare l'URI del file di dati.
metadata	CreateProjectOptions	Parametri necessari per creare il progetto.

ImportQnaRecord

Importa record QnA.

Nome	Tipo	Descrizione
activeLearningSuggestions	SuggestedQuestionsCluster[]	Elenco dei suggerimenti di Apprendimento attivo per il QnA.
answer	string	Testo della risposta.
dialog	QnaDialog	Contesto di un QnA.
id	integer	ID univoco per QnA.
lastUpdatedDateTime	string	Data e ora dell'ultimo aggiornamento del QnA.
metadata	object	Metadati associati alla risposta, utili per classificare o filtrare le risposte alle domande.
questions	string[]	Elenco di domande associate alla risposta.
source	string	Origine da cui è stato indicizzato QnA, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs ad esempio .
sourceDisplayName	string	Nome descrittivo dell'origine.

InnerErrorCode

Codice di errore leggibile.

Nome	Tipo	Descrizione
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

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	InnerErrorCode	Uno dei set definiti dal server di codici di errore.
details	object	Dettagli errore.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione degli errori.

ProjectSettings

Impostazioni configurabili del progetto.

Nome	Tipo	Descrizione
defaultAnswer	string	Risposta predefinita quando non viene trovata alcuna corrispondenza valida nel knowledge base.

QnaDialog

Finestra di dialogo associata al record QnA.

Nome	Tipo	Descrizione
isContextOnly	boolean	Per contrassegnare se una richiesta è rilevante solo con una domanda precedente o meno. Se true, non includere questo QnA come risposta per le query senza contesto; in caso contrario, ignora il contesto e include questo QnA nelle risposte.
prompts	QnaPrompt[]	Elenco di richieste associate alla risposta.

QnaPrompt

Richiedere una risposta.

Nome	Tipo	Descrizione
displayOrder	integer	Indice del prompt. Viene usato per l'ordinamento delle richieste.
displayText	string	Testo visualizzato per rappresentare una richiesta di domande di completamento.
qna	QnaRecord	Record QnA. Il record QnAId o QnA deve essere presente in un prompt.
qnaId	integer	ID del QnA corrispondente al prompt.

QnaRecord

Record QnA.

Nome	Tipo	Descrizione
activeLearningSuggestions	SuggestedQuestionsCluster[]	Elenco dei suggerimenti di Apprendimento attivo per il QnA.
answer	string	Testo della risposta.
dialog	QnaDialog	Contesto di un QnA.
id	integer	ID univoco per QnA.
metadata	object	Metadati associati alla risposta, utili per classificare o filtrare le risposte alle domande.
questions	string[]	Elenco di domande associate alla risposta.
source	string	Origine da cui è stato indicizzato QnA, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs ad esempio .

SuggestedQuestion

Domanda suggerita dalla funzionalità Di apprendimento attivo.

Nome	Tipo	Descrizione
autoSuggestedCount	integer	Il numero di volte in cui la domanda è stata suggerita automaticamente dall'algoritmo active learning.
question	string	Domanda suggerita dalla funzionalità Di apprendimento attivo.
userSuggestedCount	integer	Numero di volte in cui la domanda è stata suggerita in modo esplicito dall'utente.

SuggestedQuestionsCluster

Dettagli del cluster delle domande suggerite di Active Learning.

Nome	Tipo	Descrizione
clusterHead	string	Domanda scelta come responsabile del cluster di domande suggerite dall'algoritmo di clustering di Active Learning.
suggestedQuestions	SuggestedQuestion[]	Elenco di tutte le domande suggerite per il QnA.

WordAlterations

Raccolta di alterazioni delle parole.

Nome	Tipo	Descrizione
alterations	string[]	Raccolta di alterazioni delle parole.

Condividi tramite

Question Answering Projects - Import

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

AADToken

Note

Ambiti

Ocp-Apim-Subscription-Key

Esempio

Successful query

Esempio di richiesta

Risposta di esempio

Definizioni

Assets

CreateProjectOptions

Error

ErrorCode

ErrorResponse

format

ImportJobOptions

ImportQnaRecord

InnerErrorCode

InnerErrorModel

ProjectSettings

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

WordAlterations

Risorse aggiuntive