Text Groundedness Detection Operations - Detect Groundedness Options

Serviço:: Azure AI Services

Versão da API:: 2024-02-15-preview

Detetar aterramento
Uma API síncrona para a análise de saídas de modelos de linguagem para determinar o alinhamento com informações fornecidas pelo usuário ou identificar conteúdo fictício.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://< resource-name.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
groundingSources	True	string[]	Aproveita uma vasta gama de fontes de aterramento para validar texto gerado por IA. Limite: As restrições sobre a quantidade total de fontes de aterramento que podem ser analisadas em uma única solicitação são de 55 mil caracteres.
text	True	string maxLength: 7500	O texto específico que precisa ser verificado.
domain		GroundednessDomain	O domínio do texto para análise. Valores permitidos: Médico, Genérico. Este campo é opcional, com um valor padrão de Genérico.
llmResource		LLMResource	Detalhes de conexão para o recurso LLM. Este campo só será utilizado quando o campo «raciocínio» estiver definido como verdadeiro; caso contrário, será ignorado.
qna		QnAOptions	A entrada da pergunta do usuário em um cenário de QnA. Este campo é opcional, mas se o tipo de tarefa estiver definido como QnA, torna-se obrigatório.
reasoning		boolean	Um valor que indica se a saída inclui uma explicação para a fundamentação identificada. Este campo é opcional, com um valor padrão de false.
task		GroundednessTask	O tipo de tarefa para a análise de texto. Tipo de tarefa: QnA, Sumarização. Este campo é opcional, com um valor padrão de Sumarização.

Respostas

Name	Tipo	Description
200 OK	AnalyzeTextGroundednessResult	O pedido foi bem-sucedido.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

AnalyzeTextGroundednessResult

O pedido foi bem-sucedido.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

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

Âmbitos

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

Exemplos

Detect Groundedness

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
    }
  ]
}

Definições

Name	Description
AnalyzeTextGroundednessOptions	O pedido de deteção de aterramento.
AnalyzeTextGroundednessResult	A resposta da deteção de aterramento.
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
GroundednessDomain	O domínio do texto para análise. Valores permitidos: Médico, Genérico. Este campo é opcional, com um valor padrão de Genérico.
GroundednessTask	O tipo de tarefa para a análise de texto. Tipo de tarefa: QnA, Sumarização. Este campo é opcional, com um valor padrão de Sumarização.
IndexDetails	Os detalhes do índice.
LLMResource	Detalhes de conexão para o recurso LLM.
LLMResourceType	Tipo de recurso LLM. O valor padrão é AzureOpenAI.
QnAOptions	O pedido de opções QnA.
UngroundednessDetails	As informações detalhadas sobre um texto identificado como infundado.

AnalyzeTextGroundednessOptions

Object

O pedido de deteção de aterramento.

Name	Tipo	Default value	Description
domain	GroundednessDomain	Generic	O domínio do texto para análise. Valores permitidos: Médico, Genérico. Este campo é opcional, com um valor padrão de Genérico.
groundingSources	string[]		Aproveita uma vasta gama de fontes de aterramento para validar texto gerado por IA. Limite: As restrições sobre a quantidade total de fontes de aterramento que podem ser analisadas em uma única solicitação são de 55 mil caracteres.
llmResource	LLMResource		Detalhes de conexão para o recurso LLM. Este campo só será utilizado quando o campo «raciocínio» estiver definido como verdadeiro; caso contrário, será ignorado.
qna	QnAOptions		A entrada da pergunta do usuário em um cenário de QnA. Este campo é opcional, mas se o tipo de tarefa estiver definido como QnA, torna-se obrigatório.
reasoning	boolean		Um valor que indica se a saída inclui uma explicação para a fundamentação identificada. Este campo é opcional, com um valor padrão de false.
task	GroundednessTask	Summarization	O tipo de tarefa para a análise de texto. Tipo de tarefa: QnA, Sumarização. Este campo é opcional, com um valor padrão de Sumarização.
text	string maxLength: 7500		O texto específico que precisa ser verificado.

AnalyzeTextGroundednessResult

Object

A resposta da deteção de aterramento.

Name	Tipo	Description
ungroundedDetails	UngroundednessDetails[]	Fornece informações sobre conteúdo não fundamentado com exemplos e porcentagens específicos.
ungroundedDetected	boolean	Indica se o texto apresenta falta de fundamento.
ungroundedPercentage	number (float)	Especifica a proporção do texto identificado como não fundamentado, expressa como uma casa decimal entre 0 e 1, onde 0 indica nenhum conteúdo fundamentado e 1 indica conteúdo totalmente fundamentado.

Azure.Core.Foundations.Error

Object

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Object

Uma resposta contendo detalhes do erro.

Name	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Object

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

GroundednessDomain

Enumeração

O domínio do texto para análise. Valores permitidos: Médico, Genérico. Este campo é opcional, com um valor padrão de Genérico.

Valor	Description
Generic
Medical

GroundednessTask

Enumeração

O tipo de tarefa para a análise de texto. Tipo de tarefa: QnA, Sumarização. Este campo é opcional, com um valor padrão de Sumarização.

Valor	Description
Summarization
QnA

IndexDetails

Object

Os detalhes do índice.

Name	Tipo	Description
codePoint	integer (int64)	Indique o índice com formato de ponto de código.
utf16	integer (int64)	Indique o índice quando a codificação for UTF-16.
utf8	integer (int64)	Indique o índice quando a codificação for UTF-8.

LLMResource

Object

Detalhes de conexão para o recurso LLM.

Name	Tipo	Default value	Description
azureOpenAIDeploymentName	string		Nome do modelo de implantação.
azureOpenAIEndpoint	string		Ponto de extremidade para o recurso OpenAI do Azure.
resourceType	LLMResourceType	AzureOpenAI	Tipo de recurso LLM. O valor padrão é AzureOpenAI.

LLMResourceType

Enumeração

Tipo de recurso LLM. O valor padrão é AzureOpenAI.

Valor	Description
AzureOpenAI	Tipo de recurso do Azure OpenAI.

QnAOptions

Object

O pedido de opções QnA.

Name	Tipo	Description
query	string maxLength: 7500	A entrada da pergunta do usuário em um cenário de QnA.

UngroundednessDetails

Object

As informações detalhadas sobre um texto identificado como infundado.

Name	Tipo	Description
length	IndexDetails	A extensão do texto fundamentado.
offset	IndexDetails	O deslocamento quando o texto fundamentado é iniciado.
reason	string	A explicação para a falta de fundamento detetada, melhorando a compreensão. Somente quando o campo 'raciocínio' na entrada estiver definido como campo 'razão' verdadeiro será retornado.
text	string	O texto fundamentado.

Partilhar via

Text Groundedness Detection Operations - Detect Groundedness Options

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Âmbitos

Exemplos

Detect Groundedness

Pedido de amostra

Resposta da amostra

Definições

AnalyzeTextGroundednessOptions

AnalyzeTextGroundednessResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

GroundednessDomain

GroundednessTask

IndexDetails

LLMResource

LLMResourceType

QnAOptions

UngroundednessDetails