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[]	AI で生成されたテキストを検証するために、さまざまな基礎ソースを活用します。制限: 1 つの要求で分析できる接地ソースの総量に関する制限は 55,000 文字です。
text	True	string maxLength: 7500	チェックする必要がある特定のテキスト。
___domain		GroundednessDomain	分析用のテキストのドメイン。使用できる値: 医療、ジェネリック。このフィールドは省略可能で、既定値は Generic です。
llmResource		LLMResource	LLM リソースの接続の詳細。このフィールドは、'reasoning' フィールドが 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
フロー: application
Token URL (トークン 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	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - 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

接地検出の要求。

名前	型	規定値	説明
___domain	GroundednessDomain	Generic	分析用のテキストのドメイン。使用できる値: 医療、ジェネリック。このフィールドは省略可能で、既定値は Generic です。
groundingSources	string[]		AI で生成されたテキストを検証するために、さまざまな基礎ソースを活用します。制限: 1 つの要求で分析できる接地ソースの総量に関する制限は 55,000 文字です。
llmResource	LLMResource		LLM リソースの接続の詳細。このフィールドは、'reasoning' フィールドが 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 の 10 進数で表します。0 は固定されたコンテンツがないことを示し、1 は完全に固定されたコンテンツを示します。

Azure.Core.Foundations.Error

Object

エラーオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
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

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
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 リソースの接続の詳細。

名前	型	規定値	説明
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	検出された非座礁性に関する説明。理解を深める。入力の 'reasoning' フィールドが true 'reason' フィールドに設定されている場合にのみ返されます。
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