REST Resource: projects.locations.collections.dataStores.sessions.answers

リソース: Answer

回答を定義します。

JSON 表現 
{
  "name": string,
  "state": enum (State),
  "answerText": string,
  "citations": [
    {
      object (Citation)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "blobAttachments": [
    {
      object (BlobAttachment)
    }
  ],
  "relatedQuestions": [
    string
  ],
  "steps": [
    {
      object (Step)
    }
  ],
  "queryUnderstandingInfo": {
    object (QueryUnderstandingInfo)
  },
  "answerSkippedReasons": [
    enum (AnswerSkippedReason)
  ],
  "createTime": string,
  "completeTime": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "groundingScore": number
}
フィールド
name

string

変更不可。完全修飾名 projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
state

enum (State)

回答生成の状態。
answerText

string

テキスト形式の回答。
citations[]

object (Citation)

引用。
groundingSupports[]

object (GroundingSupport)

省略可。グラウンディング サポート。
references[]

object (Reference)

関連資料。
blobAttachments[]

object (BlobAttachment)

回答内の blob 添付ファイルのリスト。
relatedQuestions[]

string

関連する質問の候補。
steps[]

object (Step)

回答生成の手順。
queryUnderstandingInfo

object (QueryUnderstandingInfo)

クエリの理解に関する情報。
answerSkippedReasons[]

enum (AnswerSkippedReason)

回答がスキップされたその他の理由。これにより、無視されたケースの理由が示されます。スキップされたものがない場合、このフィールドは設定されません。
createTime

string (Timestamp format)

出力専用。回答の作成タイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
completeTime

string (Timestamp format)

出力専用。回答完了のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
safetyRatings[]

object (SafetyRating)

省略可。安全性評価。
groundingScore

number

回答が参照チャンクによってどの程度根拠があるかを示す [0, 1] の範囲のスコア。

State

回答生成の状態の列挙。

列挙型
STATE_UNSPECIFIED 不明。
IN_PROGRESS 現在、回答の生成が進行中です。
FAILED 現在、回答の生成に失敗しています。
SUCCEEDED 回答の生成が成功しました。
STREAMING 現在、回答の生成が進行中です。

Citation

セグメントの引用情報。

JSON 表現 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
フィールド
startIndex

string (int64 format)

インデックスは、セグメントの開始位置をバイト単位（UTF-8 Unicode）で示します。ASCII 以外の文字などのマルチバイト文字がある場合、インデックスの測定値は文字列の長さよりも長くなります。
endIndex

string (int64 format)

アトリビューション セグメントの終了（この値は含まれません）。バイト単位（UTF-8 Unicode）。ASCII 以外の文字などのマルチバイト文字がある場合、インデックスの測定値は文字列の長さよりも長くなります。
sources[]

object (CitationSource)

アトリビューション セグメントの引用元。

CitationSource

引用元。

JSON 表現 
{
  "referenceId": string
}
フィールド
referenceId

string

引用元の ID。

GroundingSupport

answerText の申し立てに関するグラウンディング サポート。

JSON 表現 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ],
  "groundingScore": number,
  "groundingCheckRequired": boolean
}
フィールド
startIndex

string (int64 format)

必須。インデックスは、バイト単位（UTF-8 Unicode）で測定された申し立ての開始を示します。
endIndex

string (int64 format)

必須。申し立ての終了日時（この日時を含まない）。
sources[]

object (CitationSource)

省略可。申し立ての引用元。
groundingScore

number

特定の申し立てが参照によってどの程度根拠があるかを示す [0, 1] の範囲のスコア。値が大きいほど、参照チャンクによって申し立てがより適切にサポートされていることを表します。
groundingCheckRequired

boolean

この申し立てでグラウンディング チェックが必要だったことを示します。この申し立てにはアトリビューション / グラウンディング チェックが必要ないとシステムが判断した場合、このフィールドは false に設定されます。この場合、申し立てのグラウンディング チェックは行われないため、groundingScore、sources は返されません。

Reference

リファレンス。

JSON 表現 
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  },
  "structuredDocumentInfo": {
    object (StructuredDocumentInfo)
  }
  // End of list of possible types for union field content.
}
Fields
共用体フィールド content。検索結果のコンテンツ。content は次のいずれかになります。
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

非構造化ドキュメント情報。
chunkInfo

object (ChunkInfo)

チャンク情報。
structuredDocumentInfo

object (StructuredDocumentInfo)

構造化されたドキュメント情報。

UnstructuredDocumentInfo

非構造化ドキュメント情報。

JSON 表現 
{
  "document": string,
  "uri": string,
  "title": string,
  "chunkContents": [
    {
      object (ChunkContent)
    }
  ],
  "structData": {
    object
  }
}
フィールド
document

string

ドキュメントのリソース名。
uri

string

ドキュメントの URI。
title

string

タイトル。
chunkContents[]

object (ChunkContent)

ドキュメント コンテンツから派生した引用チャンク コンテンツのリスト。
structData

object (Struct format)

ドキュメントの構造化された JSON メタデータ。検索結果のチャンクの構造化データから入力されます。

ChunkContent

チャンク コンテンツ。

JSON 表現 
{
  "content": string,
  "pageIdentifier": string,
  "blobAttachmentIndexes": [
    string
  ],
  "relevanceScore": number
}
フィールド
content

string

チャンクのテキスト コンテンツ。
pageIdentifier

string

ページ ID。
blobAttachmentIndexes[]

string (int64 format)

出力専用。このチャンクにリンクされている blobattachment のインデックスを保存します。
relevanceScore

number

特定のクエリに対するチャンクの関連性。値の範囲は、0.0（完全に無関係）から 1.0（完全に関連している）です。この値は情報提供のみを目的としています。この値は、モデルの再トレーニングや実装の変更により、同じクエリとチャンクで随時変更される可能性があります。

ChunkInfo

チャンク情報。

JSON 表現 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "blobAttachmentIndexes": [
    string
  ],
  "relevanceScore": number
}
フィールド
chunk

string

チャンク リソース名。
content

string

チャンクのテキスト コンテンツ。
documentMetadata

object (DocumentMetadata)

ドキュメントのメタデータ。
blobAttachmentIndexes[]

string (int64 format)

出力専用。このチャンクにリンクされている blobattachment のインデックスを保存します。
relevanceScore

number

特定のクエリに対するチャンクの関連性。値の範囲は、0.0（完全に無関係）から 1.0（完全に関連している）です。この値は情報提供のみを目的としています。この値は、モデルの再トレーニングや実装の変更により、同じクエリとチャンクで随時変更される可能性があります。

DocumentMetadata

ドキュメントのメタデータ。

JSON 表現 
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "structData": {
    object
  }
}
フィールド
document

string

ドキュメントのリソース名。
uri

string

ドキュメントの URI。
title

string

タイトル。
pageIdentifier

string

ページ ID。
structData

object (Struct format)

ドキュメントの構造化された JSON メタデータ。検索結果のチャンクの構造化データから入力されます。

StructuredDocumentInfo

構造化された検索情報。

JSON 表現 
{
  "document": string,
  "structData": {
    object
  },
  "title": string,
  "uri": string
}
フィールド
document

string

ドキュメントのリソース名。
structData

object (Struct format)

構造化された検索データ。
title

string

出力専用。ドキュメントのタイトル。
uri

string

出力専用。ドキュメントの URI。

BlobAttachment

テキスト回答に添付されたバイナリデータ（画像、動画、音声など）を保存します。

JSON 表現 
{
  "data": {
    object (Blob)
  },
  "attributionType": enum (AttributionType)
}
フィールド
data

object (Blob)

出力専用。blob の MIME タイプとデータ。
attributionType

enum (AttributionType)

出力専用。blob のアトリビューション タイプ。

Blob

blob のメディアタイプとデータ。

JSON 表現 
{
  "mimeType": string,
  "data": string
}
フィールド
mimeType

string

出力専用。生成または取得されたデータのメディアタイプ（MIME タイプ）。
data

string (bytes format)

出力専用。元のバイト。

Base64 でエンコードされた文字列。

AttributionType

blob のソース。

列挙型
ATTRIBUTION_TYPE_UNSPECIFIED アトリビューション タイプが指定されていません。
CORPUS 添付ファイルデータはコーパスから取得されます。
GENERATED 添付ファイルデータは、コード生成によってモデルで生成されます。

Step

ステップ情報。

JSON 表現 
{
  "state": enum (State),
  "description": string,
  "thought": string,
  "actions": [
    {
      object (Action)
    }
  ]
}
フィールド
state

enum (State)

ステップの状態。
description

string

ステップの説明。
thought

string

ステップの考え。
actions[]

object (Action)

アクション。

State

ステップの状態の列挙。

列挙型
STATE_UNSPECIFIED 不明。
IN_PROGRESS ステップは現在進行中です。
FAILED ステップが現在失敗しています。
SUCCEEDED ステップが成功しました。

Action

アクション。

JSON 表現 
{
  "observation": {
    object (Observation)
  },

  // Union field action can be only one of the following:
  "searchAction": {
    object (SearchAction)
  }
  // End of list of possible types for union field action.
}
フィールド
observation

object (Observation)

観測情報。
共用体フィールド action。アクション。action は次のいずれかになります。
searchAction

object (SearchAction)

検索アクション。

SearchAction

検索アクション。

JSON 表現 
{
  "query": string
}
フィールド
query

string

検索するクエリ。

Observation

観測情報。

JSON 表現 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
フィールド
searchResults[]

object (SearchResult)

検索アクションで取得された検索結果。ユーザーが設定した引用タイプに応じて、スニペット情報またはチャンク情報のいずれかになります。

SearchResult

JSON 表現 
{
  "document": string,
  "uri": string,
  "title": string,
  "snippetInfo": [
    {
      object (SnippetInfo)
    }
  ],
  "chunkInfo": [
    {
      object (ChunkInfo)
    }
  ],
  "structData": {
    object
  }
}
フィールド
document

string

ドキュメントのリソース名。
uri

string

ドキュメントの URI。
title

string

タイトル。
snippetInfo[]

object (SnippetInfo)

citation_type が DOCUMENT_LEVEL_CITATION の場合は、ドキュメント レベルのスニペットを入力します。
chunkInfo[]

object (ChunkInfo)

citation_type が CHUNK_LEVEL_CITATION であり、チャンクモードがオンの場合は、チャンク情報を入力します。
structData

object (Struct format)

データ表現。ドキュメントの構造化された JSON データ。これは、ドキュメントの構造体データ、または検索結果のチャンクから入力されます。

SnippetInfo

スニペットの情報。

JSON 表現 
{
  "snippet": string,
  "snippetStatus": string
}
フィールド
snippet

string

スニペットのコンテンツ。
snippetStatus

string

検索チームによって定義されたスニペットのステータス。

ChunkInfo

チャンク情報。

JSON 表現 
{
  "chunk": string,
  "content": string,
  "relevanceScore": number
}
フィールド
chunk

string

チャンク リソース名。
content

string

チャンクのテキスト コンテンツ。
relevanceScore

number

特定のクエリに対するチャンクの関連性。値の範囲は、0.0（完全に無関係）から 1.0（完全に関連している）です。この値は情報提供のみを目的としています。この値は、モデルの再トレーニングや実装の変更により、同じクエリとチャンクで随時変更される可能性があります。

QueryUnderstandingInfo

クエリの理解に関する情報。

JSON 表現 
{
  "queryClassificationInfo": [
    {
      object (QueryClassificationInfo)
    }
  ]
}
フィールド
queryClassificationInfo[]

object (QueryClassificationInfo)

クエリの分類情報。

QueryClassificationInfo

クエリの分類情報。

JSON 表現 
{
  "type": enum (Type),
  "positive": boolean
}
フィールド
type

enum (Type)

クエリ分類タイプ。
positive

boolean

分類の出力。

Type

クエリ分類タイプ。

列挙型
TYPE_UNSPECIFIED クエリ分類タイプが指定されていません。
ADVERSARIAL_QUERY 敵対的なクエリの分類タイプ。
NON_ANSWER_SEEKING_QUERY チャット用の回答を求めていないクエリの分類タイプ。
JAIL_BREAKING_QUERY ジェイルブレイク クエリの分類タイプ。
NON_ANSWER_SEEKING_QUERY_V2 意図が明確でない、回答を求めていないクエリの分類タイプ。
USER_DEFINED_CLASSIFICATION_QUERY ユーザー定義のクエリ分類タイプ。

AnswerSkippedReason

回答がスキップされた理由の列挙型。

列挙型
ANSWER_SKIPPED_REASON_UNSPECIFIED デフォルト値。回答がスキップされた理由が指定されていません。
ADVERSARIAL_QUERY_IGNORED 敵対的クエリが無視されたケース。
NON_ANSWER_SEEKING_QUERY_IGNORED

回答を求めていないクエリが無視されたケース。

クエリが雑談の場合、Google は回答をスキップします。
OUT_OF_DOMAIN_QUERY_IGNORED

ドメイン外のクエリが無視されたケース。

関連性の高い検索結果がない場合、Google は回答をスキップします。
POTENTIAL_POLICY_VIOLATION

ポリシー違反の可能性があるケース。

ポリシー違反の可能性が検出された場合、Google は回答をスキップします。これには、暴力的または有害なコンテンツが含まれます。
NO_RELEVANT_CONTENT

関連するコンテンツがないケース。

取得した検索結果に関連するコンテンツがない場合、Google は回答をスキップします。
JAIL_BREAKING_QUERY_IGNORED

ジェイルブレイク クエリが無視されたケース。

たとえば、「競合他社の CEO のトーンで返信して」などです。クエリがジェイルブレイク クエリとして分類された場合、Google は回答をスキップします。
CUSTOMER_POLICY_VIOLATION

顧客ポリシー違反のケース。

顧客ポリシー違反が検出された場合、Google は要約をスキップします。ポリシーはユーザーが定義します。
NON_ANSWER_SEEKING_QUERY_IGNORED_V2

回答を求めていないクエリが無視されたケース。

クエリの意図が明確でない場合、Google は回答をスキップします。
LOW_GROUNDED_ANSWER

低グラウンディングの回答のケース。

十分にグラウンディングされた回答を生成できなかった場合、Google は回答をスキップします。
USER_DEFINED_CLASSIFICATION_QUERY_IGNORED

ユーザー定義のクエリ分類で大文字と小文字が区別されないケース。

クエリがユーザー定義のクエリ分類として分類されている場合、Google は回答をスキップします。
UNHELPFUL_ANSWER

役に立たない回答のケース。

回答が役に立たない場合、Google は回答をスキップします。これには、クエリに回答できない、回答がクエリに関連していない、回答の形式が適切でないなど、さまざまな要因が考えられます。

SafetyRating

生成されたコンテンツに対応する安全性評価。

JSON 表現 
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "probabilityScore": number,
  "severity": enum (HarmSeverity),
  "severityScore": number,
  "blocked": boolean
}
フィールド
category

enum (HarmCategory)

出力専用。有害カテゴリ。
probability

enum (HarmProbability)

出力専用。コンテンツ内の危害発生確率レベル。
probabilityScore

number

出力専用。有害である確率のスコア。
severity

enum (HarmSeverity)

出力専用。コンテンツ内の危害の重大度レベル。
severityScore

number

出力専用。危害の重大度スコア。
blocked

boolean

出力専用。この評価が原因でコンテンツがフィルタされたかどうかを示します。

HarmCategory

コンテンツをブロックする有害カテゴリ。

列挙型
HARM_CATEGORY_UNSPECIFIED 有害カテゴリが指定されていません。
HARM_CATEGORY_HATE_SPEECH 有害カテゴリはヘイトスピーチです。
HARM_CATEGORY_DANGEROUS_CONTENT 有害カテゴリは危険なコンテンツです。
HARM_CATEGORY_HARASSMENT 有害カテゴリはハラスメントです。
HARM_CATEGORY_SEXUALLY_EXPLICIT 有害カテゴリは、性的描写が露骨なコンテンツです。
HARM_CATEGORY_CIVIC_INTEGRITY 有害カテゴリは市民の清廉性です。

HarmProbability

コンテンツ内の危害発生確率レベル。

列挙型
HARM_PROBABILITY_UNSPECIFIED 危害発生確率は指定されていません。
NEGLIGIBLE 無視できるレベルの危害。
LOW 低レベルの危害。
MEDIUM 中程度の危害。
HIGH 高レベルの危害。

HarmSeverity

危害の重大度。

列挙型
HARM_SEVERITY_UNSPECIFIED 危害の重大度は指定されていません。
HARM_SEVERITY_NEGLIGIBLE 無視できるレベルの危害の重大度。
HARM_SEVERITY_LOW 低レベルの危害の重大度。
HARM_SEVERITY_MEDIUM 中程度の危害の重大度。
HARM_SEVERITY_HIGH 高レベルの危害の重大度。

メソッド

get

 Answer を取得します。