Question Answering Projects - Update Qnas

Service:

Cognitive Services

API Version:

2021-10-01

Aggiornamenti le domande e risposte di un progetto.

PATCH {Endpoint}/language/query-knowledgebases/projects/{projectName}/qnas?api-version=2021-10-01

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.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string

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. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Risposta di errore.

Sicurezza

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Esempio

Successful query

Sample Request

HTTP

PATCH {Endpoint}/language/query-knowledgebases/projects/proj1/qnas?api-version=2021-10-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"
      ]
    }
  }
]

Sample Response

Status code:

202

Operation-Location: job1

Definizioni

Nome	Descrizione
Error	Oggetto error.
ErrorCode	Codice di errore leggibile.
ErrorResponse	Risposta di errore.
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.
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.
updateOperationKind	Aggiornare il tipo di operazione per gli asset.
UpdateQnaRecord	Record QnA da aggiornare.

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
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string

ErrorResponse

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode

Codice di errore leggibile.

Nome	Tipo	Descrizione
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	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.

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.

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.