Question Answering Projects - Update Qnas

Riferimento

Servizio:: Cognitive Services - Language

Versione API:: 2023-04-01

Aggiornamenti le QnA di un progetto.

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint servizi cognitivi supportati (ad esempio, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nome del progetto da usare.
api-version	query	True	string	Versione API client.

Corpo della richiesta

Nome	Tipo	Descrizione
body	UpdateQnaRecord[]	Aggiornare i parametri QnAs di un 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 . Quando è associato 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 basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account delle risorse o alle sotto-risorse. 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 riepilogo, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso in API e ambiti specifici.

Note

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

L'oggetto Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani dispongono di 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 dell'SDK Web Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Attualmente, Azure Active Directory v1.0 o v2.0 supporta Work, School e Guest, ma non supporta gli 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

Chiave di sottoscrizione per una risorsa del servizio lingua.

Tipo: apiKey
In: header

Esempio

Successful query

Esempio di richiesta

HTTP

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/qnas?api-version=2023-04-01

[
  {
    "op": "add",
    "value": {
      "id": 3,
      "answer": "ans3",
      "source": "source1",
      "questions": [
        "question 3.1",
        "question 3.2"
      ],
      "metadata": {
        "k1": "v1",
        "k2": "v2"
      },
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 11,
            "displayText": "prompt 3.1"
          },
          {
            "displayOrder": 2,
            "qnaId": 21,
            "displayText": "prompt 3.2"
          }
        ]
      }
    }
  },
  {
    "op": "replace",
    "value": {
      "id": 1,
      "answer": "ans4",
      "source": "source1",
      "questions": [
        "question 4.1",
        "question 4.2"
      ]
    }
  },
  {
    "op": "delete",
    "value": {
      "id": 2,
      "answer": "ans2",
      "source": "source1",
      "questions": [
        "question 2.1",
        "question 2.2"
      ]
    }
  }
]

Risposta di esempio

Codice di stato:: 202

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

Definizioni

Nome	Descrizione
Error	Oggetto error.
ErrorCode	Codice di errore leggibile dall'utente.
ErrorResponse	Risposta di errore.
InnerErrorCode	Codice di errore leggibile dall'utente.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaDialog	Finestra di dialogo associata al record QnA.
QnaPrompt	Richiedere una risposta.
QnaRecord	Record QnA.
SuggestedQuestion	Domanda suggerita dalla funzionalità Active Learning.
SuggestedQuestionsCluster	Informazioni dettagliate sul cluster di Active Learning suggerite.
updateOperationKind	Aggiornare il tipo di operazione per gli asset.
UpdateQnaRecord	Record QnA da aggiornare.

Error

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'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 dall'utente.

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.

InnerErrorCode

Codice di errore leggibile dall'utente.

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

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

QnaDialog

Finestra di dialogo associata al record QnA.

Nome	Tipo	Descrizione
isContextOnly	boolean	Per contrassegnare se un prompt è 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 ordinare le richieste.
displayText	string	Testo visualizzato per rappresentare un prompt delle domande di completamento.
qna	QnaRecord	Record QnA. Il record QnAId o QnA deve essere presente in un prompt.
qnaId	integer	ID dell'oggetto QnA corrispondente al prompt.

QnaRecord

Record QnA.

Nome	Tipo	Descrizione
activeLearningSuggestions	SuggestedQuestionsCluster[]	Elenco dei suggerimenti di Active Learning per 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, ad esempio https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Domanda suggerita dalla funzionalità Active Learning.

Nome	Tipo	Descrizione
autoSuggestedCount	integer	Numero di volte in cui la domanda è stata suggerita automaticamente dall'algoritmo Active Learning.
question	string	Domanda suggerita dalla funzionalità Active Learning.
userSuggestedCount	integer	Numero di volte in cui la domanda è stata suggerita in modo esplicito dall'utente.

SuggestedQuestionsCluster

Informazioni dettagliate sul cluster di Active Learning suggerite.

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

updateOperationKind

Aggiornare il tipo di operazione per gli asset.

Nome	Tipo	Descrizione
add	string
delete	string
replace	string

UpdateQnaRecord

Record QnA da aggiornare.

Nome	Tipo	Descrizione
op	updateOperationKind	Aggiornare il tipo di operazione per gli asset.
value	QnaRecord	Record QnA.

Condividi tramite

Question Answering Projects - Update Qnas

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

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

updateOperationKind

UpdateQnaRecord

Risorse aggiuntive