Text Groundedness Detection Operations - Detect Groundedness Options

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2024-02-15-preview

Detección de la base de datos
API sincrónica para el análisis de salidas del modelo de lenguaje para determinar la alineación con la información proporcionada por el usuario o identificar el contenido ficticio.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
groundingSources	True	string[]	Aprovecha una amplia gama de orígenes de puesta en tierra para validar el texto generado por ia. Límite: las restricciones en la cantidad total de orígenes de base que se pueden analizar en una sola solicitud son de 55 000 caracteres.
text	True	string maxLength: 7500	Texto específico que debe comprobarse.
domain		GroundednessDomain	Dominio del texto para el análisis. Valores permitidos: Medical, Generic. Este campo es opcional, con un valor predeterminado de Genérico.
llmResource		LLMResource	Detalles de conexión del recurso LLM. Este campo solo se usará cuando el campo "razonamiento" esté establecido en true; de lo contrario, se omitirá.
qna		QnAOptions	Entrada de pregunta del usuario en un escenario de QnA. Este campo es opcional, pero si el tipo de tarea está establecido en QnA, se requiere.
reasoning		boolean	Valor que indica si la salida incluye una explicación de la base identificada. Este campo es opcional, con un valor predeterminado de false.
task		GroundednessTask	Tipo de tarea para el análisis de texto. Tipo de tarea: QnA, Resumen. Este campo es opcional, con un valor predeterminado de Resumen.

Respuestas

Nombre	Tipo	Description
200 OK	AnalyzeTextGroundednessResult	La solicitud se ha realizado correctamente.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

AnalyzeTextGroundednessResult

La solicitud se ha realizado correctamente.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: application
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Ámbitos

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

Ejemplos

Detect Groundedness

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
AnalyzeTextGroundednessOptions	Solicitud de detección de base.
AnalyzeTextGroundednessResult	Respuesta de la detección de la base.
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
GroundednessDomain	Dominio del texto para el análisis. Valores permitidos: Medical, Generic. Este campo es opcional, con un valor predeterminado de Genérico.
GroundednessTask	Tipo de tarea para el análisis de texto. Tipo de tarea: QnA, Resumen. Este campo es opcional, con un valor predeterminado de Resumen.
IndexDetails	Detalles del índice.
LLMResource	Detalles de conexión del recurso LLM.
LLMResourceType	Tipo de recurso LLM. El valor predeterminado es AzureOpenAI.
QnAOptions	Solicitud de opciones de QnA.
UngroundednessDetails	Información detallada sobre un texto identificado como no en primer plano.

AnalyzeTextGroundednessOptions

Object

Solicitud de detección de base.

Nombre	Tipo	Valor predeterminado	Description
domain	GroundednessDomain	Generic	Dominio del texto para el análisis. Valores permitidos: Medical, Generic. Este campo es opcional, con un valor predeterminado de Genérico.
groundingSources	string[]		Aprovecha una amplia gama de orígenes de puesta en tierra para validar el texto generado por ia. Límite: las restricciones en la cantidad total de orígenes de base que se pueden analizar en una sola solicitud son de 55 000 caracteres.
llmResource	LLMResource		Detalles de conexión del recurso LLM. Este campo solo se usará cuando el campo "razonamiento" esté establecido en true; de lo contrario, se omitirá.
qna	QnAOptions		Entrada de pregunta del usuario en un escenario de QnA. Este campo es opcional, pero si el tipo de tarea está establecido en QnA, se requiere.
reasoning	boolean		Valor que indica si la salida incluye una explicación de la base identificada. Este campo es opcional, con un valor predeterminado de false.
task	GroundednessTask	Summarization	Tipo de tarea para el análisis de texto. Tipo de tarea: QnA, Resumen. Este campo es opcional, con un valor predeterminado de Resumen.
text	string maxLength: 7500		Texto específico que debe comprobarse.

AnalyzeTextGroundednessResult

Object

Respuesta de la detección de la base.

Nombre	Tipo	Description
ungroundedDetails	UngroundednessDetails[]	Proporciona información sobre el contenido sin base con ejemplos y porcentajes específicos.
ungroundedDetected	boolean	Indica si el texto muestra una ausencia de base.
ungroundedPercentage	number (float)	Especifica la proporción del texto identificado como en primer plano, expresado como un decimal entre 0 y 1, donde 0 indica que no hay contenido con base y 1 indica contenido con base completa.

Azure.Core.Foundations.Error

Object

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Object

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

GroundednessDomain

Enumeración

Dominio del texto para el análisis. Valores permitidos: Medical, Generic. Este campo es opcional, con un valor predeterminado de Genérico.

Valor	Description
Generic
Medical

GroundednessTask

Enumeración

Tipo de tarea para el análisis de texto. Tipo de tarea: QnA, Resumen. Este campo es opcional, con un valor predeterminado de Resumen.

Valor	Description
QnA
Summarization

IndexDetails

Object

Detalles del índice.

Nombre	Tipo	Description
codePoint	integer (int64)	Indique el índice con formato de punto de código.
utf16	integer (int64)	Indique el índice cuando la codificación es UTF-16.
utf8	integer (int64)	Indique el índice cuando la codificación es UTF-8.

LLMResource

Object

Detalles de conexión del recurso LLM.

Nombre	Tipo	Valor predeterminado	Description
azureOpenAIDeploymentName	string		Nombre del modelo de implementación.
azureOpenAIEndpoint	string		Punto de conexión para el recurso de Azure OpenAI.
resourceType	LLMResourceType	AzureOpenAI	Tipo de recurso LLM. El valor predeterminado es AzureOpenAI.

LLMResourceType

Enumeración

Tipo de recurso LLM. El valor predeterminado es AzureOpenAI.

Valor	Description
AzureOpenAI	Tipo de recurso de Azure OpenAI.

QnAOptions

Object

Solicitud de opciones de QnA.

Nombre	Tipo	Description
query	string maxLength: 7500	Entrada de pregunta del usuario en un escenario de QnA.

UngroundednessDetails

Object

Información detallada sobre un texto identificado como no en primer plano.

Nombre	Tipo	Description
length	IndexDetails	Longitud del texto con suelo.
offset	IndexDetails	Desplazamiento cuando se inicia el texto con tierra.
reason	string	Explicación de la falta de primer plano detectada, lo que mejora la comprensión. Solo cuando el campo "razonamiento" de la entrada esté establecido en el campo "reason" true se devolverá.
text	string	Texto con suelo.

Compartir a través de

Text Groundedness Detection Operations - Detect Groundedness Options

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

OAuth2Auth

Ámbitos

Ejemplos

Detect Groundedness

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AnalyzeTextGroundednessOptions

AnalyzeTextGroundednessResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

GroundednessDomain

GroundednessTask

IndexDetails

LLMResource

LLMResourceType

QnAOptions

UngroundednessDetails

Recursos adicionales