Text Groundedness Detection Operations - Detect Groundedness Options

Reference

Service:: Cognitive Services

API Version:: 2024-02-15-preview

Detekce uzemnění
Synchronní rozhraní API pro analýzu výstupů jazykových modelů za účelem určení souladu s informacemi poskytnutými uživatelem nebo identifikace fiktivního obsahu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://.cognitiveservices.azure.com).
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
groundingSources	True	string[]	Využívá širokou škálu uzemněných zdrojů k ověření textu generovaného AI. Limit: Omezení celkového množství zdrojů uzemnění, které lze analyzovat v rámci jednoho požadavku, je 55 tisíc znaků.
text	True	string	Konkrétní text, který je třeba zkontrolovat.
domain		GroundednessDomain	Doména textu pro analýzu. Povolené hodnoty: Medical, Generic. Toto pole je volitelné s výchozí hodnotou Obecné.
llmResource		LLMResource	Podrobnosti o připojení k prostředku LLM. Toto pole bude použito pouze v případě, že pole "odůvodnění" je nastavena na true; jinak se bude ignorovat.
qna		QnAOptions	Zadání otázky uživatele ve scénáři otázek a odpovědí. Toto pole je volitelné, ale pokud je typ úkolu nastavený na QnA, stane se povinným.
reasoning		boolean	Hodnota označující, jestli výstup obsahuje vysvětlení zjištěné uzemnění. Toto pole je volitelné s výchozí hodnotou false.
task		GroundednessTask	Typ úlohy pro analýzu textu. Typ úkolu: QnA, Shrnutí. Toto pole je volitelné s výchozí hodnotou Sumarizace.

Odpovědi

Name	Typ	Description
200 OK	AnalyzeTextGroundednessResult	Žádost byla úspěšná.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď. Headers x-ms-error-code: string

Name

Typ

Description

200 OK

AnalyzeTextGroundednessResult

Žádost byla úspěšná.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Neočekávaná chybová odpověď.

Headers

x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

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

Scopes

Name	Description
https://cognitiveservices.azure.com/.default

Příklady

Detect Groundedness

Sample Request

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

Sample Response

Status code:: 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"
    }
  ]
}

Definice

Name	Description
AnalyzeTextGroundednessOptions	Požadavek na detekci uzemnění.
AnalyzeTextGroundednessResult	Reakce detekce uzemnění.
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
GroundednessDomain	Doména textu pro analýzu. Povolené hodnoty: Medical, Generic. Toto pole je volitelné s výchozí hodnotou Obecné.
GroundednessTask	Typ úlohy pro analýzu textu. Typ úkolu: QnA, Shrnutí. Toto pole je volitelné s výchozí hodnotou Sumarizace.
IndexDetails	Podrobnosti o indexu.
LLMResource	Podrobnosti o připojení k prostředku LLM.
LLMResourceType	Typ prostředku LLM. Výchozí hodnota je AzureOpenAI.
QnAOptions	Požadavek na možnosti otázek a odpovědí.
UngroundednessDetails	Podrobné informace o textu identifikovaném jako neuzemněný.

AnalyzeTextGroundednessOptions

Požadavek na detekci uzemnění.

Name	Typ	Výchozí hodnota	Description
domain	GroundednessDomain	Generic	Doména textu pro analýzu. Povolené hodnoty: Medical, Generic. Toto pole je volitelné s výchozí hodnotou Obecné.
groundingSources	string[]		Využívá širokou škálu uzemněných zdrojů k ověření textu generovaného AI. Limit: Omezení celkového množství zdrojů uzemnění, které lze analyzovat v rámci jednoho požadavku, je 55 tisíc znaků.
llmResource	LLMResource		Podrobnosti o připojení k prostředku LLM. Toto pole bude použito pouze v případě, že pole "odůvodnění" je nastavena na true; jinak se bude ignorovat.
qna	QnAOptions		Zadání otázky uživatele ve scénáři otázek a odpovědí. Toto pole je volitelné, ale pokud je typ úkolu nastavený na QnA, stane se povinným.
reasoning	boolean		Hodnota označující, jestli výstup obsahuje vysvětlení zjištěné uzemnění. Toto pole je volitelné s výchozí hodnotou false.
task	GroundednessTask	Summarization	Typ úlohy pro analýzu textu. Typ úkolu: QnA, Shrnutí. Toto pole je volitelné s výchozí hodnotou Sumarizace.
text	string		Konkrétní text, který je třeba zkontrolovat.

AnalyzeTextGroundednessResult

Reakce detekce uzemnění.

Name	Typ	Description
ungroundedDetails	UngroundednessDetails[]	Poskytuje přehledy o neuzemněném obsahu s konkrétními příklady a procenty.
ungroundedDetected	boolean	Určuje, jestli text vykazuje neuzemněnost.
ungroundedPercentage	number	Určuje podíl textu identifikovaného jako neuzemněný vyjádřený desetinnou čárkou mezi 0 a 1, kde 0 znamená žádný uzemněný obsah a 1 zcela uzemněný obsah.

Azure.Core.Foundations.Error

Objekt chyby.

Name	Typ	Description
code	string	Jeden ze serverem definovaných chybových kódů.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	Jeden ze serverem definovaných chybových kódů.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

GroundednessDomain

Doména textu pro analýzu. Povolené hodnoty: Medical, Generic. Toto pole je volitelné s výchozí hodnotou Obecné.

Name	Typ	Description
Generic	string
Medical	string

GroundednessTask

Typ úlohy pro analýzu textu. Typ úkolu: QnA, Shrnutí. Toto pole je volitelné s výchozí hodnotou Sumarizace.

Name	Typ	Description
QnA	string
Summarization	string

IndexDetails

Podrobnosti o indexu.

Name	Typ	Description
codePoint	integer	Označte index ve formátu bodu kódu.
utf16	integer	Pokud je kódování UTF-16, označte index.
utf8	integer	Označte index, pokud je kódování UTF-8.

LLMResource

Podrobnosti o připojení k prostředku LLM.

Name	Typ	Výchozí hodnota	Description
azureOpenAIDeploymentName	string		Název modelu nasazení.
azureOpenAIEndpoint	string		Koncový bod pro prostředek Azure OpenAI.
resourceType	LLMResourceType	AzureOpenAI	Typ prostředku LLM. Výchozí hodnota je AzureOpenAI.

LLMResourceType

Typ prostředku LLM. Výchozí hodnota je AzureOpenAI.

Name	Typ	Description
AzureOpenAI	string	Typ prostředku Azure OpenAI

QnAOptions

Požadavek na možnosti otázek a odpovědí.

Name	Typ	Description
query	string	Zadání otázky uživatele ve scénáři otázek a odpovědí.

UngroundednessDetails

Podrobné informace o textu identifikovaném jako neuzemněný.

Name	Typ	Description
length	IndexDetails	Délka uzemněného textu
offset	IndexDetails	Posun při spuštění uzemněného textu
reason	string	Vysvětlení zjištěné neuzemnění, které zlepšuje porozumění. Vrátí se pouze tehdy, když je pole "reasoning" ve vstupu nastaveno na true "reason" pole.
text	string	Uzemněný text.

Sdílet prostřednictvím

Text Groundedness Detection Operations - Detect Groundedness Options

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

OAuth2Auth

Scopes

Příklady

Detect Groundedness

Sample Request

Sample Response

Definice

AnalyzeTextGroundednessOptions

AnalyzeTextGroundednessResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

GroundednessDomain

GroundednessTask

IndexDetails

LLMResource

LLMResourceType

QnAOptions

UngroundednessDetails

Další materiály