Question Answering - Get Answers From Text

Riferimento

Servizio:: Azure AI Services

Versione API:: 2023-04-01

Risponde alla domanda specificata utilizzando il testo fornito nel corpo.

POST {Endpoint}/language/:query-text?api-version=2023-04-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string (uri)	Endpoint di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
question	True	string	Domanda dell'utente per eseguire query sui record di testo specificati.
records	True	TextDocument[]	Record di testo da cercare per una determinata domanda.
language		string	Lingua dei record di testo. Si tratta della 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.
stringIndexType		StringIndexType	Specifica il metodo utilizzato per interpretare gli offset di stringa. L'impostazione predefinita è Elementi di testo (Graphemes) in base a Unicode v8.0.0. Per altre informazioni, vedere https://aka.ms/text-analytics-offsets.

Risposte

Nome	Tipo	Descrizione
200 OK	AnswersFromTextResult	La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Nome

Tipo

Descrizione

200 OK

AnswersFromTextResult

La richiesta ha avuto esito positivo.

Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

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

Ambiti

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

Esempio

Successful query

Esempio di richiesta

HTTP

POST {Endpoint}/language/:query-text?api-version=2023-04-01

{
  "question": "how long it takes to charge surface?",
  "records": [
    {
      "id": "1",
      "text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it."
    },
    {
      "id": "2",
      "text": "You can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface."
    }
  ],
  "language": "en"
}

Risposta di esempio

Codice di stato:: 200

{
  "answers": [
    {
      "answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
      "answerSpan": {
        "confidenceScore": 0,
        "length": 45,
        "offset": 28,
        "text": "two to four hours"
      },
      "confidenceScore": 0.93,
      "id": "1",
      "length": 224,
      "offset": 0
    },
    {
      "answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
      "answerSpan": {
        "confidenceScore": 0,
        "length": 25,
        "offset": 8,
        "text": "two to four hours"
      },
      "confidenceScore": 0.92,
      "id": "1",
      "length": 224,
      "offset": 20
    },
    {
      "answer": "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
      "answerSpan": null,
      "confidenceScore": 0.05,
      "id": "1",
      "length": 244,
      "offset": 110
    }
  ]
}

Definizioni

Nome	Descrizione
AnswersFromTextOptions	Parametri della domanda e del record di testo a cui rispondere.
AnswersFromTextResult	Rappresenta i risultati della risposta.
AnswerSpan	Oggetto intervallo di risposte di QnA.
Error	Oggetto di risposta di errore restituito quando il servizio rileva alcuni errori durante l'elaborazione della richiesta.
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.
StringIndexType	Specifica il metodo utilizzato per interpretare gli offset di stringa. L'impostazione predefinita è Elementi di testo (Graphemes) in base a Unicode v8.0.0. Per altre informazioni, vedere https://aka.ms/text-analytics-offsets.
TextAnswer	Rappresenta il risultato della risposta.
TextDocument	Rappresentare un record di testo di input su cui eseguire query.

AnswersFromTextOptions

Object

Parametri della domanda e del record di testo a cui rispondere.

Nome	Tipo	Valore predefinito	Descrizione
language	string		Lingua dei record di testo. Si tratta della 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.
question	string		Domanda dell'utente per eseguire query sui record di testo specificati.
records	TextDocument[]		Record di testo da cercare per una determinata domanda.
stringIndexType	StringIndexType	TextElements_v8	Specifica il metodo utilizzato per interpretare gli offset di stringa. L'impostazione predefinita è Elementi di testo (Graphemes) in base a Unicode v8.0.0. Per altre informazioni, vedere https://aka.ms/text-analytics-offsets.

AnswersFromTextResult

Object

Rappresenta i risultati della risposta.

Nome	Tipo	Descrizione
answers	TextAnswer[]	Rappresenta i risultati della risposta.

AnswerSpan

Object

Oggetto intervallo di risposte di QnA.

Nome	Tipo	Descrizione
confidenceScore	number (double) minimum: 0 maximum: 1	Punteggio stimato dell'intervallo di risposte, intervallo di valori compreso tra 0 e 1.
length	integer (int32)	Lunghezza dell'intervallo di risposte.
offset	integer (int32)	Offset dell'intervallo di risposte dall'inizio della risposta.
text	string	Testo stimato dell'intervallo di risposte.

Error

Object

Oggetto di risposta di errore restituito quando il servizio rileva alcuni errori durante l'elaborazione della richiesta.

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

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
AzureCognitiveSearchIndexLimitReached	Errore raggiunto dal limite di indice di Ricerca cognitiva di Azure
AzureCognitiveSearchIndexNotFound	Errore non trovato nell'indice di Ricerca cognitiva di Azure
AzureCognitiveSearchNotFound	Errore di Ricerca cognitiva di Azure non trovato
AzureCognitiveSearchThrottling	Errore di limitazione della limitazione di Ricerca cognitiva di Azure
Conflict	Errore di conflitto
Forbidden	Errore di accesso negato
InternalServerError	Errore interno del server
InvalidArgument	Errore di argomento non valido
InvalidRequest	Errore di richiesta non valido
NotFound	Errore non trovato
OperationNotFound	Errore di operazione non trovata
ProjectNotFound	Errore di progetto non trovato
QuotaExceeded	Errore di superamento della quota
ServiceUnavailable	Errore di servizio non disponibile
Timeout	Errore di timeout
TooManyRequests	Errore di troppe richieste
Unauthorized	Errore di accesso non autorizzato
Warning	Errore di avviso

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
AzureCognitiveSearchNotFound	Errore di Ricerca cognitiva di Azure non trovato
AzureCognitiveSearchThrottling	Errore di limitazione della limitazione di Ricerca cognitiva di Azure
EmptyRequest	Errore di richiesta vuota
ExtractionFailure	Errore di estrazione
InvalidCountryHint	Errore di hint paese non valido
InvalidDocument	Errore del documento non valido
InvalidDocumentBatch	Errore del batch di documenti non valido
InvalidParameterValue	Errore del valore del parametro non valido
InvalidRequest	Errore di richiesta non valido
InvalidRequestBodyFormat	Errore di formato del corpo della richiesta non valido
KnowledgeBaseNotFound	Errore della Knowledge Base non trovato
MissingInputDocuments	Errore dei documenti di input mancanti
ModelVersionIncorrect	Errore di versione del modello non corretto
UnsupportedLanguageCode	Errore di codice della lingua non supportato

InnerErrorModel

Object

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 di un set definito 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 errore.

StringIndexType

Enumerazione

Specifica il metodo utilizzato per interpretare gli offset di stringa. L'impostazione predefinita è Elementi di testo (Graphemes) in base a Unicode v8.0.0. Per altre informazioni, vedere https://aka.ms/text-analytics-offsets.

Valore	Descrizione
TextElements_v8	I valori di offset e lunghezza restituiti corrispondono a TextElements (cluster Graphemes e Grapheme) che confermano lo standard Unicode 8.0.0. Usare questa opzione se l'applicazione è scritta in .Net Framework o .Net Core e si userà StringInfo.
UnicodeCodePoint	I valori di offset e lunghezza restituiti corrispondono ai punti di codice Unicode. Usare questa opzione se l'applicazione è scritta in un linguaggio che supporta Unicode, ad esempio Python.
Utf16CodeUnit	I valori di offset e lunghezza restituiti corrispondono alle unità di codice UTF-16. Usare questa opzione se l'applicazione viene scritta in un linguaggio che supporta Unicode, ad esempio JavaScript.

TextAnswer

Object

Rappresenta il risultato della risposta.

Nome	Tipo	Descrizione
answer	string	Risposta.
answerSpan	AnswerSpan	Oggetto span di risposte rispetto alla domanda dell'utente.
confidenceScore	number (double) minimum: 0 maximum: 1	punteggio di attendibilità della risposta, valore compreso tra 0 e 1.
id	string	ID record.
length	integer (int32)	Lunghezza della frase.
offset	integer (int32)	Offset della frase dall'inizio del documento.

TextDocument

Object

Rappresentare un record di testo di input su cui eseguire query.

Nome	Tipo	Descrizione
id	string	Identificatore univoco per il record di testo.
text	string	Contenuto del testo del record.

Condividi tramite

Question Answering - Get Answers From Text

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

OAuth2Auth

Ambiti

Esempio

Successful query

Esempio di richiesta

Risposta di esempio

Definizioni

AnswersFromTextOptions

AnswersFromTextResult

AnswerSpan

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType

TextAnswer

TextDocument