Text Groundedness Detection Operations - Detect Groundedness Options

Ссылка

Служба:: Azure AI Services

Версия API:: 2024-02-15-preview

Обнаружение заземления
Синхронный API для анализа выходных данных языковой модели, чтобы определить выравнивание с предоставленными пользователем сведениями или определить вымышленное содержимое.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Текст запроса

Имя	Обязательно	Тип	Описание
groundingSources	True	string[]	Использует огромный массив источников приземления для проверки текста, созданного ИИ. Ограничение. Ограничения на общий объем источников заземления, которые можно проанализировать в одном запросе, составляют 55 000 символов.
text	True	string maxLength: 7500	Определенный текст, который необходимо проверить.
domain		GroundednessDomain	Домен текста для анализа. Допустимые значения: медицинские, универсальные. Это поле является необязательным, с значением по умолчанию generic.
llmResource		LLMResource	Сведения о подключении для ресурса LLM. Это поле будет использоваться только в том случае, если для поля "причина" задано значение true; в противном случае он будет игнорироваться.
qna		QnAOptions	Входные данные пользователя в сценарии QnA. Это поле является необязательным, но если для типа задачи задано значение QnA, он становится обязательным.
reasoning		boolean	Значение, указывающее, содержит ли выходные данные объяснение определенной заземленности. Это поле является необязательным с значением false по умолчанию.
task		GroundednessTask	Тип задачи для анализа текста. Тип задачи: QnA, Сводка. Это поле является необязательным с значением суммирования по умолчанию.

Ответы

Имя	Тип	Описание
200 OK	AnalyzeTextGroundednessResult	Запрос выполнен успешно.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

AnalyzeTextGroundednessResult

Запрос выполнен успешно.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Непредвиденное сообщение об ошибке.

Заголовки

x-ms-error-code: string

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: application
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/v2.0/token

Области

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

Detect Groundedness

Образец запроса

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

Пример ответа

Код состояния:: 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"
    }
  ]
}

Определения

Имя	Описание
AnalyzeTextGroundednessOptions	Запрос обнаружения заземления.
AnalyzeTextGroundednessResult	Ответ обнаружения заземления.
Azure.Core.Foundations.Error	Объект ошибки.
Azure.Core.Foundations.ErrorResponse	Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
GroundednessDomain	Домен текста для анализа. Допустимые значения: медицинские, универсальные. Это поле является необязательным, с значением по умолчанию generic.
GroundednessTask	Тип задачи для анализа текста. Тип задачи: QnA, Сводка. Это поле является необязательным с значением суммирования по умолчанию.
IndexDetails	Сведения об индексе.
LLMResource	Сведения о подключении для ресурса LLM.
LLMResourceType	Тип ресурса LLM. Значением по умолчанию является AzureOpenAI.
QnAOptions	Запрос параметров QnA.
UngroundednessDetails	Подробные сведения о тексте, определяемом как незапланированное.

AnalyzeTextGroundednessOptions

Object

Запрос обнаружения заземления.

Имя	Тип	Default value	Описание
domain	GroundednessDomain	Generic	Домен текста для анализа. Допустимые значения: медицинские, универсальные. Это поле является необязательным, с значением по умолчанию generic.
groundingSources	string[]		Использует огромный массив источников приземления для проверки текста, созданного ИИ. Ограничение. Ограничения на общий объем источников заземления, которые можно проанализировать в одном запросе, составляют 55 000 символов.
llmResource	LLMResource		Сведения о подключении для ресурса LLM. Это поле будет использоваться только в том случае, если для поля "причина" задано значение true; в противном случае он будет игнорироваться.
qna	QnAOptions		Входные данные пользователя в сценарии QnA. Это поле является необязательным, но если для типа задачи задано значение QnA, он становится обязательным.
reasoning	boolean		Значение, указывающее, содержит ли выходные данные объяснение определенной заземленности. Это поле является необязательным с значением false по умолчанию.
task	GroundednessTask	Summarization	Тип задачи для анализа текста. Тип задачи: QnA, Сводка. Это поле является необязательным с значением суммирования по умолчанию.
text	string maxLength: 7500		Определенный текст, который необходимо проверить.

AnalyzeTextGroundednessResult

Object

Ответ обнаружения заземления.

Имя	Тип	Описание
ungroundedDetails	UngroundednessDetails[]	Предоставляет аналитические сведения о незапланированного содержимом с конкретными примерами и процентными значениями.
ungroundedDetected	boolean	Указывает, отображается ли текст незамеченностью.
ungroundedPercentage	number (float)	Указывает пропорцию текста, определяемого как незапланированные, выраженные как десятичные значения в диапазоне от 0 до 1, где 0 указывает, что не заземленное содержимое, а 1 — полностью заземленное содержимое.

Azure.Core.Foundations.Error

Object

Объект ошибки.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	Azure.Core.Foundations.Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Object

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	Azure.Core.Foundations.Error	Объект ошибки.

Azure.Core.Foundations.InnerError

Object

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.

GroundednessDomain

Перечисление

Домен текста для анализа. Допустимые значения: медицинские, универсальные. Это поле является необязательным, с значением по умолчанию generic.

Значение	Описание
Generic
Medical

GroundednessTask

Перечисление

Тип задачи для анализа текста. Тип задачи: QnA, Сводка. Это поле является необязательным с значением суммирования по умолчанию.

Значение	Описание
QnA
Summarization

IndexDetails

Object

Сведения об индексе.

Имя	Тип	Описание
codePoint	integer (int64)	Укажите индекс с форматом точки кода.
utf16	integer (int64)	Укажите индекс, если кодировка — UTF-16.
utf8	integer (int64)	Укажите индекс, если кодировка — UTF-8.

LLMResource

Object

Сведения о подключении для ресурса LLM.

Имя	Тип	Default value	Описание
azureOpenAIDeploymentName	string		Имя модели развертывания.
azureOpenAIEndpoint	string		Конечная точка для ресурса Azure OpenAI.
resourceType	LLMResourceType	AzureOpenAI	Тип ресурса LLM. Значением по умолчанию является AzureOpenAI.

LLMResourceType

Перечисление

Тип ресурса LLM. Значением по умолчанию является AzureOpenAI.

Значение	Описание
AzureOpenAI	Тип ресурса Azure OpenAI.

QnAOptions

Object

Запрос параметров QnA.

Имя	Тип	Описание
query	string maxLength: 7500	Входные данные пользователя в сценарии QnA.

UngroundednessDetails

Object

Подробные сведения о тексте, определяемом как незапланированное.

Имя	Тип	Описание
length	IndexDetails	Длина заземленного текста.
offset	IndexDetails	Смещение при запуске заземленного текста.
reason	string	Объяснение обнаруженной незапланированности, повышение понимания. Только если поле "аргументирование" в входных данных имеет значение true "причина" будет возвращено.
text	string	Заземленный текст.

Поделиться через

Text Groundedness Detection Operations - Detect Groundedness Options

Параметры URI

Текст запроса

Ответы

Безопасность

Ocp-Apim-Subscription-Key

OAuth2Auth

Области

Примеры

Detect Groundedness

Образец запроса

Пример ответа

Определения

AnalyzeTextGroundednessOptions

AnalyzeTextGroundednessResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

GroundednessDomain

GroundednessTask

IndexDetails

LLMResource

LLMResourceType

QnAOptions

UngroundednessDetails

Дополнительные ресурсы