Text Groundedness Detection Operations - Detect Groundedness Options

Referentie

Service:: Azure AI Services

API-versie:: 2024-02-15-preview

Groundedness detecteren
Een synchrone API voor de analyse van taalmodeluitvoer om de afstemming met door de gebruiker verstrekte informatie te bepalen of fictieve inhoud te identificeren.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
groundingSources	True	string[]	Maakt gebruik van een grote reeks grondbronnen om door AI gegenereerde tekst te valideren. Limiet: Beperkingen voor de totale hoeveelheid grondbronnen die in één aanvraag kunnen worden geanalyseerd, zijn 55.000 tekens.
text	True	string maxLength: 7500	De specifieke tekst die moet worden gecontroleerd.
domain		GroundednessDomain	Het domein van de tekst voor analyse. Toegestane waarden: Medisch, Algemeen. Dit veld is optioneel, met een standaardwaarde van Algemeen.
llmResource		LLMResource	Verbindingsgegevens voor de LLM-resource. Dit veld wordt alleen gebruikt wanneer het veld 'redeneren' is ingesteld op waar; anders wordt deze genegeerd.
qna		QnAOptions	De vraaginvoer van de gebruiker in een QnA-scenario. Dit veld is optioneel, maar als het taaktype is ingesteld op QnA, wordt dit vereist.
reasoning		boolean	Een waarde die aangeeft of de uitvoer een verklaring bevat voor de geïdentificeerde grondheid. Dit veld is optioneel, met een standaardwaarde onwaar.
task		GroundednessTask	Het taaktype voor de tekstanalyse. Type taak: QnA, Samenvatting. Dit veld is optioneel, met een standaardwaarde voor samenvatting.

Antwoorden

Name	Type	Description
200 OK	AnalyzeTextGroundednessResult	De aanvraag is voltooid.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

AnalyzeTextGroundednessResult

De aanvraag is voltooid.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

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

Bereiken

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

Voorbeelden

Detect Groundedness

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AnalyzeTextGroundednessOptions	De aanvraag van geaardheidsdetectie.
AnalyzeTextGroundednessResult	Het antwoord van geaardheidsdetectie.
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
GroundednessDomain	Het domein van de tekst voor analyse. Toegestane waarden: Medisch, Algemeen. Dit veld is optioneel, met een standaardwaarde van Algemeen.
GroundednessTask	Het taaktype voor de tekstanalyse. Type taak: QnA, Samenvatting. Dit veld is optioneel, met een standaardwaarde voor samenvatting.
IndexDetails	De indexgegevens.
LLMResource	Verbindingsgegevens voor de LLM-resource.
LLMResourceType	LLM-resourcetype. De standaardwaarde is AzureOpenAI.
QnAOptions	De aanvraag van QnA-opties.
UngroundednessDetails	De gedetailleerde informatie over een tekst die is geïdentificeerd als niet-geaardheid.

AnalyzeTextGroundednessOptions

Object

De aanvraag van geaardheidsdetectie.

Name	Type	Default value	Description
domain	GroundednessDomain	Generic	Het domein van de tekst voor analyse. Toegestane waarden: Medisch, Algemeen. Dit veld is optioneel, met een standaardwaarde van Algemeen.
groundingSources	string[]		Maakt gebruik van een grote reeks grondbronnen om door AI gegenereerde tekst te valideren. Limiet: Beperkingen voor de totale hoeveelheid grondbronnen die in één aanvraag kunnen worden geanalyseerd, zijn 55.000 tekens.
llmResource	LLMResource		Verbindingsgegevens voor de LLM-resource. Dit veld wordt alleen gebruikt wanneer het veld 'redeneren' is ingesteld op waar; anders wordt deze genegeerd.
qna	QnAOptions		De vraaginvoer van de gebruiker in een QnA-scenario. Dit veld is optioneel, maar als het taaktype is ingesteld op QnA, wordt dit vereist.
reasoning	boolean		Een waarde die aangeeft of de uitvoer een verklaring bevat voor de geïdentificeerde grondheid. Dit veld is optioneel, met een standaardwaarde onwaar.
task	GroundednessTask	Summarization	Het taaktype voor de tekstanalyse. Type taak: QnA, Samenvatting. Dit veld is optioneel, met een standaardwaarde voor samenvatting.
text	string maxLength: 7500		De specifieke tekst die moet worden gecontroleerd.

AnalyzeTextGroundednessResult

Object

Het antwoord van geaardheidsdetectie.

Name	Type	Description
ungroundedDetails	UngroundednessDetails[]	Biedt inzicht in niet-geaarde inhoud met specifieke voorbeelden en percentages.
ungroundedDetected	boolean	Geeft aan of de tekst onaardigheid vertoont.
ungroundedPercentage	number (float)	Hiermee geeft u het aandeel van de tekst aan die is geïdentificeerd als niet-geaard, uitgedrukt als een decimaal tussen 0 en 1, waarbij 0 geen geaarde inhoud aangeeft en 1 geheel geaarde inhoud aangeeft.

Azure.Core.Foundations.Error

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

GroundednessDomain

Inventarisatie

Het domein van de tekst voor analyse. Toegestane waarden: Medisch, Algemeen. Dit veld is optioneel, met een standaardwaarde van Algemeen.

Waarde	Description
Generic
Medical

GroundednessTask

Inventarisatie

Het taaktype voor de tekstanalyse. Type taak: QnA, Samenvatting. Dit veld is optioneel, met een standaardwaarde voor samenvatting.

Waarde	Description
QnA
Summarization

IndexDetails

Object

De indexgegevens.

Name	Type	Description
codePoint	integer (int64)	Geef de index aan met codepuntindeling.
utf16	integer (int64)	Geef de index aan wanneer codering UTF-16 is.
utf8	integer (int64)	Geef de index aan wanneer codering UTF-8 is.

LLMResource

Object

Verbindingsgegevens voor de LLM-resource.

Name	Type	Default value	Description
azureOpenAIDeploymentName	string		Naam van implementatiemodel.
azureOpenAIEndpoint	string		Eindpunt voor Azure OpenAI-resource.
resourceType	LLMResourceType	AzureOpenAI	LLM-resourcetype. De standaardwaarde is AzureOpenAI.

LLMResourceType

Inventarisatie

LLM-resourcetype. De standaardwaarde is AzureOpenAI.

Waarde	Description
AzureOpenAI	Azure OpenAI-resourcetype.

QnAOptions

Object

De aanvraag van QnA-opties.

Name	Type	Description
query	string maxLength: 7500	De vraaginvoer van de gebruiker in een QnA-scenario.

UngroundednessDetails

Object

De gedetailleerde informatie over een tekst die is geïdentificeerd als niet-geaardheid.

Name	Type	Description
length	IndexDetails	De lengte van de geaarde tekst.
offset	IndexDetails	De verschuiving wanneer geaarde tekst wordt gestart.
reason	string	De verklaring voor gedetecteerde niet-geaardheid, waardoor het begrip wordt verbeterd. Alleen wanneer het veld 'redeneren' in de invoer is ingesteld op waar 'reden' veld wordt geretourneerd.
text	string	De geaarde tekst.

Delen via

Text Groundedness Detection Operations - Detect Groundedness Options

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

OAuth2Auth

Bereiken

Voorbeelden

Detect Groundedness

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AnalyzeTextGroundednessOptions

AnalyzeTextGroundednessResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

GroundednessDomain

GroundednessTask

IndexDetails

LLMResource

LLMResourceType

QnAOptions

UngroundednessDetails

Aanvullende resources