Text Groundedness Detection Operations - Detect Groundedness Options

Referência

Serviço:: Azure AI Services

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

Detectar aterramento
Uma API síncrona para a análise de saídas de modelo 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 de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
groundingSources	True	string[]	Aproveita uma ampla variedade de fontes de aterramento para validar o texto gerado por IA. Limite: as restrições à 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. Esse campo é opcional, com um valor padrão de Genérico.
llmResource		LLMResource	Detalhes da conexão para o recurso LLM. Esse campo será usado somente quando o campo 'raciocínio' for definido como true; caso contrário, ele será ignorado.
qna		QnAOptions	A entrada de pergunta do usuário em um cenário de QnA. Esse campo é opcional, mas se o tipo de tarefa for definido como QnA, ele se tornará necessário.
reasoning		boolean	Um valor que indica se a saída inclui uma explicação para a aterramento identificada. Esse 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, Resumo. Esse campo é opcional, com um valor padrão de Resumo.

Respostas

Nome	Tipo	Description
200 OK	AnalyzeTextGroundednessResult	A solicitação foi bem-sucedida.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

AnalyzeTextGroundednessResult

A solicitação foi bem-sucedida.

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
Flow: application
URL do Token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Escopos

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

Exemplos

Detect Groundedness

Solicitação de exemplo

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 de exemplo

Código de status:: 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

Nome	Description
AnalyzeTextGroundednessOptions	A solicitação de detecção de aterramento.
AnalyzeTextGroundednessResult	A resposta da detecção de aterramento.
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém 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. Esse 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, Resumo. Esse campo é opcional, com um valor padrão de Resumo.
IndexDetails	Os detalhes do índice.
LLMResource	Detalhes da conexão para o recurso LLM.
LLMResourceType	Tipo de recurso LLM. O valor padrão é AzureOpenAI.
QnAOptions	A solicitação de opções de QnA.
UngroundednessDetails	As informações detalhadas sobre um texto identificado como ungroundedness.

AnalyzeTextGroundednessOptions

Objeto

A solicitação de detecção de aterramento.

Nome	Tipo	Valor padrão	Description
domain	GroundednessDomain	Generic	O domínio do texto para análise. Valores permitidos: Médico, Genérico. Esse campo é opcional, com um valor padrão de Genérico.
groundingSources	string[]		Aproveita uma ampla variedade de fontes de aterramento para validar o texto gerado por IA. Limite: as restrições à quantidade total de fontes de aterramento que podem ser analisadas em uma única solicitação são de 55 mil caracteres.
llmResource	LLMResource		Detalhes da conexão para o recurso LLM. Esse campo será usado somente quando o campo 'raciocínio' for definido como true; caso contrário, ele será ignorado.
qna	QnAOptions		A entrada de pergunta do usuário em um cenário de QnA. Esse campo é opcional, mas se o tipo de tarefa for definido como QnA, ele se tornará necessário.
reasoning	boolean		Um valor que indica se a saída inclui uma explicação para a aterramento identificada. Esse 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, Resumo. Esse campo é opcional, com um valor padrão de Resumo.
text	string maxLength: 7500		O texto específico que precisa ser verificado.

AnalyzeTextGroundednessResult

Objeto

A resposta da detecção de aterramento.

Nome	Tipo	Description
ungroundedDetails	UngroundednessDetails[]	Apresenta insights sobre o conteúdo sem fundamentação com exemplos e percentuais específicos.
ungroundedDetected	boolean	Indica se o texto exibe uma falta de fundamentação.
ungroundedPercentage	number (float)	Especifica a proporção do texto identificado como ungrounded, expresso como uma decimal entre 0 e 1, em que 0 indica nenhum conteúdo aterrado e 1 indica conteúdo totalmente aterrado..

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
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 pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

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

Azure.Core.Foundations.InnerError

Objeto

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.

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

GroundednessDomain

Enumeração

O domínio do texto para análise. Valores permitidos: Médico, Genérico. Esse 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, Resumo. Esse campo é opcional, com um valor padrão de Resumo.

Valor	Description
QnA
Summarization

IndexDetails

Objeto

Os detalhes do índice.

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

LLMResource

Objeto

Detalhes da conexão para o recurso LLM.

Nome	Tipo	Valor padrão	Description
azureOpenAIDeploymentName	string		Nome do modelo de implantação.
azureOpenAIEndpoint	string		Ponto de extremidade para o recurso do Azure OpenAI.
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

Objeto

A solicitação de opções de QnA.

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

UngroundednessDetails

Objeto

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

Nome	Tipo	Description
length	IndexDetails	O comprimento do texto aterrado.
offset	IndexDetails	O deslocamento quando o texto aterrado é iniciado.
reason	string	A explicação para o desterramento detectado, melhorando a compreensão. Somente quando o campo 'raciocínio' na entrada for definido como verdadeiro campo 'reason' será retornado.
text	string	O texto aterrado.

Compartilhar via

Text Groundedness Detection Operations - Detect Groundedness Options

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Escopos

Exemplos

Detect Groundedness

Solicitação de exemplo

Resposta de exemplo

Definições

AnalyzeTextGroundednessOptions

AnalyzeTextGroundednessResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

GroundednessDomain

GroundednessTask

IndexDetails

LLMResource

LLMResourceType

QnAOptions

UngroundednessDetails

Recursos adicionais