REST Resource: projects.locations.collections.dataStores.conversations

リソース: Conversation

外部会話の proto 定義。

JSON 表現 
{
  "name": string,
  "state": enum (State),
  "userPseudoId": string,
  "messages": [
    {
      object (ConversationMessage)
    }
  ],
  "startTime": string,
  "endTime": string
}
フィールド
name

string

変更不可。完全修飾名 projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/* または projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*。
state

enum (State)

Conversation の状態。
userPseudoId

string

ユーザーをトラッキングするための固有識別子。
messages[]

object (ConversationMessage)

Conversation メッセージ。
startTime

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"。
endTime

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

状態

会話の状態の列挙。

列挙型
STATE_UNSPECIFIED 不明。
IN_PROGRESS 現在、会話が継続しています。
COMPLETED 会話が完了しました。

ConversationMessage

会話メッセージを定義します。

JSON 表現 
{
  "createTime": string,

  // Union field message can be only one of the following:
  "userInput": {
    object (TextInput)
  },
  "reply": {
    object (Reply)
  }
  // End of list of possible types for union field message.
}
フィールド
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"。

共用体フィールド message。

message は次のいずれかになります。
userInput

object (TextInput)

ユーザーのテキスト入力。
reply

object (Reply)

検索への応答。

TextInput

テキスト入力を定義します。

JSON 表現 
{
  "input": string,
  "context": {
    object (ConversationContext)
  }
}
フィールド
input

string

テキスト入力。
context

object (ConversationContext)

入力の会話コンテキスト。

ConversationContext

会話のコンテキストを定義します。

JSON 表現 
{
  "contextDocuments": [
    string
  ],
  "activeDocument": string
}
フィールド
contextDocuments[]

string

ユーザーに現在表示されているドキュメントのリスト。ドキュメント リソース参照が含まれています。
activeDocument

string

ユーザーが開いた現在のアクティブなドキュメント。ドキュメント リソース参照が含まれています。

Reply

ユーザーへの返信メッセージを定義します。

JSON 表現 
{
  "reply": string,
  "references": [
    {
      object (Reference)
    }
  ],
  "summary": {
    object (Summary)
  }
}
フィールド
reply
(deprecated)

string

非推奨: 代わりに、summary を使用してください。テキスト返信。
references[]
(deprecated)

object (Reference)

返信に含まれる参照。
summary

object (Summary)

検索結果に基づく要約。

Reference

返信に含まれる参照を定義します。

JSON 表現 
{
  "uri": string,
  "anchorText": string,
  "start": integer,
  "end": integer
}
フィールド
uri

string

URI リンク参照。
anchorText

string

アンカー テキスト。
start

integer

アンカー テキストの開始インデックス。
end

integer

アンカー テキストの終了インデックス。

Summary

要約仕様で指定された上位 N 件の検索結果の要約。

JSON 表現 
{
  "summaryText": string,
  "summarySkippedReasons": [
    enum (SummarySkippedReason)
  ],
  "safetyAttributes": {
    object (SafetyAttributes)
  },
  "summaryWithMetadata": {
    object (SummaryWithMetadata)
  }
}
フィールド
summaryText

string

要約コンテンツ。
summarySkippedReasons[]

enum (SummarySkippedReason)

要約をスキップした追加の理由。無視されたケースの理由を示します。スキップされたものがない場合、このフィールドは設定されません。
safetyAttributes

object (SafetyAttributes)

安全性属性のカテゴリとそれに関連付けられた信頼スコアのコレクション。
summaryWithMetadata

object (SummaryWithMetadata)

メタデータ情報を含む要約。

SummarySkippedReason

要約をスキップした理由の列挙型。

列挙型
SUMMARY_SKIPPED_REASON_UNSPECIFIED デフォルト値。要約のスキップ理由が指定されていません。
ADVERSARIAL_QUERY_IGNORED

敵対的クエリが無視されたケース。

SummarySpec.ignore_adversarial_query が true に設定されている場合にのみ使用されます。
NON_SUMMARY_SEEKING_QUERY_IGNORED

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

クエリが雑談の場合、Google は要約をスキップします。SummarySpec.ignore_non_summary_seeking_query が true に設定されている場合にのみ使用されます。
OUT_OF_DOMAIN_QUERY_IGNORED

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

検索結果にあまり関連性がない場合、Google は要約をスキップします。たとえば、データストアには会社 A に関する事実が含まれていますが、ユーザーのクエリは会社 B についての質問をしている場合などです。
POTENTIAL_POLICY_VIOLATION

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

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

LLM アドオンが有効になっていないケース。

LLM アドオンが有効になっていない場合、Google は要約をスキップします。
NO_RELEVANT_CONTENT

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

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

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

たとえば、「競合他社の CEO のトーンで返信して」などです。[SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] が true に設定されている場合にのみ使用されます。
CUSTOMER_POLICY_VIOLATION

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

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

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

クエリの意図が明確でない場合、Google は要約をスキップします。[SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] が true に設定されている場合にのみ使用されます。
TIME_OUT

タイムアウトのケース。

タイムアウトした場合、Google は要約をスキップします。

SafetyAttributes

安全性属性のカテゴリとそれに関連付けられた信頼スコア。

JSON 表現 
{
  "categories": [
    string
  ],
  "scores": [
    number
  ]
}
フィールド
categories[]

string

生成されたコンテンツに関連付けられた安全性属性カテゴリの表示名。順序がスコアと一致する。
scores[]

number

各カテゴリの信頼スコア。値が大きいほど、信頼度が高くなります。順序が Categories と一致します。

SummaryWithMetadata

メタデータ情報を含む要約。

JSON 表現 
{
  "summary": string,
  "citationMetadata": {
    object (CitationMetadata)
  },
  "references": [
    {
      object (Reference)
    }
  ],
  "blobAttachments": [
    {
      object (BlobAttachment)
    }
  ]
}
フィールド
summary

string

引用情報のない要約テキスト。
citationMetadata

object (CitationMetadata)

指定された要約の引用メタデータ。
references[]

object (Reference)

ドキュメントの参照情報。
blobAttachments[]

object (BlobAttachment)

出力専用。回答の品質強化のためにマルチモーダル データを保存します。

CitationMetadata

引用メタデータ。

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

object (Citation)

セグメントの引用。

Citation

セグメントの引用情報。

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

string (int64 format)

インデックスはセグメントの開始位置を示し、バイト単位（Unicode）で測定されます。
endIndex

string (int64 format)

帰属セグメントの終了位置（この位置自体は含みません）。
sources[]

object (CitationSource)

帰属セグメントの引用元。

CitationSource

引用元。

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

string (int64 format)

SummaryWithMetadata.references のドキュメント参照インデックス。0 から始まるインデックスで、referenceIndex が明示的に設定されていない場合、値は 0 になります。

Reference

ドキュメントの参照情報。

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

string

ドキュメントのタイトル。
document

string

必須。ドキュメントの Document.name。参照元ドキュメントの完全なリソース名（projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/* 形式）。
uri

string

ドキュメントの Cloud Storage または HTTP URI。
chunkContents[]

object (ChunkContent)

ドキュメント コンテンツに由来する引用チャンク コンテンツのリスト。

ChunkContent

チャンクのコンテンツ。

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

string

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

string

ページ ID。
blobAttachmentIndexes[]

string (int64 format)

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

BlobAttachment

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

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

object (Blob)

出力専用。blob データ。
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 添付ファイルデータは、モデルのコード生成によって生成されます。

メソッド

converse

 会話を変換します。

create

 Conversation を作成します。

delete

 Conversation を削除します。

get

 Conversation を取得します。

list

 親 DataStore ごとにすべての Conversation を一覧表示します。

patch

 Conversation を更新します。