Text Groundedness Detection Operations - Detect Groundedness Options

Servizio:: Azure AI Services

Versione API:: 2024-02-15-preview

Rilevare il terreno
API sincrona per l'analisi degli output del modello linguistico per determinare l'allineamento con le informazioni fornite dall'utente o identificare il contenuto fittizio.

POST {endpoint}/contentsafety/text:detectGroundedness?api-version=2024-02-15-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://< nome-risorsa.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
groundingSources	True	string[]	Sfrutta una vasta gamma di origini di base per convalidare il testo generato dall'intelligenza artificiale. Limite: le restrizioni relative alla quantità totale di origini di terra che possono essere analizzate in una singola richiesta sono di 55.000 caratteri.
text	True	string maxLength: 7500	Testo specifico da controllare.
domain		GroundednessDomain	Dominio del testo per l'analisi. Valori consentiti: Medical, Generic. Questo campo è facoltativo, con un valore predefinito Generic.
llmResource		LLMResource	Dettagli della connessione per la risorsa LLM. Questo campo verrà utilizzato solo quando il campo "motivo" è impostato su true; in caso contrario, verrà ignorato.
qna		QnAOptions	Input della domanda dell'utente in uno scenario QnA. Questo campo è facoltativo, ma se il tipo di attività è impostato su QnA, diventa obbligatorio.
reasoning		boolean	Valore che indica se l'output include una spiegazione per la base identificata. Questo campo è facoltativo, con un valore predefinito false.
task		GroundednessTask	Tipo di attività per l'analisi del testo. Tipo di attività: QnA, Riepilogo. Questo campo è facoltativo, con un valore predefinito Di riepilogo.

Risposte

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

Nome

Tipo

Descrizione

200 OK

AnalyzeTextGroundednessResult

La richiesta ha avuto esito positivo.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: application
URL token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Ambiti

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

Esempio

Detect Groundedness

Esempio di richiesta

HTTP

POST {endpoint}/contentsafety/text:detectGroundedness?api-version=2024-02-15-preview

{
  "domain": "Generic",
  "task": "Summarization",
  "text": "The sun rises from the west.",
  "groundingSources": [
    "The sun rises from the east due to the visual effect caused by the Earth"
  ],
  "reasoning": true,
  "llmResource": {
    "resourceType": "AzureOpenAI",
    "azureOpenAIEndpoint": "https://your-azure-openai-name.openai.azure.com",
    "azureOpenAIDeploymentName": "deployment-1130"
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "ungroundedDetected": true,
  "ungroundedPercentage": 0,
  "ungroundedDetails": [
    {
      "text": "string",
      "offset": {
        "utf8": 0,
        "utf16": 0,
        "codePoint": 0
      },
      "length": {
        "utf8": 28,
        "utf16": 28,
        "codePoint": 28
      },
      "reason": "The sun rises from the east due to the visual effect caused by the Earth"
    }
  ]
}

Definizioni

Nome	Descrizione
AnalyzeTextGroundednessOptions	Richiesta di rilevamento di suolo.
AnalyzeTextGroundednessResult	Risposta del rilevamento di suolo.
Azure.Core.Foundations.Error	Oggetto error.
Azure.Core.Foundations.ErrorResponse	Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError	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.
GroundednessDomain	Dominio del testo per l'analisi. Valori consentiti: Medical, Generic. Questo campo è facoltativo, con un valore predefinito Generic.
GroundednessTask	Tipo di attività per l'analisi del testo. Tipo di attività: QnA, Riepilogo. Questo campo è facoltativo, con un valore predefinito Di riepilogo.
IndexDetails	Dettagli dell'indice.
LLMResource	Dettagli della connessione per la risorsa LLM.
LLMResourceType	Tipo di risorsa LLM. Il valore predefinito è AzureOpenAI.
QnAOptions	Richiesta di opzioni QnA.
UngroundednessDetails	Informazioni dettagliate su un testo identificato come non in primo piano.

AnalyzeTextGroundednessOptions

Object

Richiesta di rilevamento di suolo.

Nome	Tipo	Valore predefinito	Descrizione
domain	GroundednessDomain	Generic	Dominio del testo per l'analisi. Valori consentiti: Medical, Generic. Questo campo è facoltativo, con un valore predefinito Generic.
groundingSources	string[]		Sfrutta una vasta gamma di origini di base per convalidare il testo generato dall'intelligenza artificiale. Limite: le restrizioni relative alla quantità totale di origini di terra che possono essere analizzate in una singola richiesta sono di 55.000 caratteri.
llmResource	LLMResource		Dettagli della connessione per la risorsa LLM. Questo campo verrà utilizzato solo quando il campo "motivo" è impostato su true; in caso contrario, verrà ignorato.
qna	QnAOptions		Input della domanda dell'utente in uno scenario QnA. Questo campo è facoltativo, ma se il tipo di attività è impostato su QnA, diventa obbligatorio.
reasoning	boolean		Valore che indica se l'output include una spiegazione per la base identificata. Questo campo è facoltativo, con un valore predefinito false.
task	GroundednessTask	Summarization	Tipo di attività per l'analisi del testo. Tipo di attività: QnA, Riepilogo. Questo campo è facoltativo, con un valore predefinito Di riepilogo.
text	string maxLength: 7500		Testo specifico da controllare.

AnalyzeTextGroundednessResult

Object

Risposta del rilevamento di suolo.

Nome	Tipo	Descrizione
ungroundedDetails	UngroundednessDetails[]	Fornisce informazioni dettagliate sul contenuto non fondato con esempi e percentuali specifici.
ungroundedDetected	boolean	Indica se il testo presenta elementi non fondati.
ungroundedPercentage	number (float)	Specifica la proporzione del testo identificato come non in primo piano, espressa come decimale compresa tra 0 e 1, dove 0 indica che non è presente alcun contenuto a terra e 1 indica il contenuto completamente a terra.

Azure.Core.Foundations.Error

Object

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Azure.Core.Foundations.Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Object

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	Oggetto error.

Azure.Core.Foundations.InnerError

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	string	Uno di un set definito dal server di codici di errore.
innererror	Azure.Core.Foundations.InnerError	Errore interno.

GroundednessDomain

Enumerazione

Dominio del testo per l'analisi. Valori consentiti: Medical, Generic. Questo campo è facoltativo, con un valore predefinito Generic.

Valore	Descrizione
Generic
Medical

GroundednessTask

Enumerazione

Tipo di attività per l'analisi del testo. Tipo di attività: QnA, Riepilogo. Questo campo è facoltativo, con un valore predefinito Di riepilogo.

Valore	Descrizione
Summarization
QnA

IndexDetails

Object

Dettagli dell'indice.

Nome	Tipo	Descrizione
codePoint	integer (int64)	Indicare l'indice con formato punto di codice.
utf16	integer (int64)	Indicare l'indice quando la codifica è UTF-16.
utf8	integer (int64)	Indicare l'indice quando la codifica è UTF-8.

LLMResource

Object

Dettagli della connessione per la risorsa LLM.

Nome	Tipo	Valore predefinito	Descrizione
azureOpenAIDeploymentName	string		Nome del modello di distribuzione.
azureOpenAIEndpoint	string		Endpoint per la risorsa OpenAI di Azure.
resourceType	LLMResourceType	AzureOpenAI	Tipo di risorsa LLM. Il valore predefinito è AzureOpenAI.

LLMResourceType

Enumerazione

Tipo di risorsa LLM. Il valore predefinito è AzureOpenAI.

Valore	Descrizione
AzureOpenAI	Tipo di risorsa OpenAI di Azure.

QnAOptions

Object

Richiesta di opzioni QnA.

Nome	Tipo	Descrizione
query	string maxLength: 7500	Input della domanda dell'utente in uno scenario QnA.

UngroundednessDetails

Object

Informazioni dettagliate su un testo identificato come non in primo piano.

Nome	Tipo	Descrizione
length	IndexDetails	Lunghezza del testo a terra.
offset	IndexDetails	Offset all'inizio del testo a terra.
reason	string	Spiegazione dell'infondatezza rilevata, migliorando la comprensione. Verrà restituito solo quando il campo 'reasoning' nell'input è impostato su true 'reason'.
text	string	Testo a terra.