REST Resource: projects.locations.collections.engines.sessions.assistAnswers

リソース: AssistAnswer

AssistAnswer リソース。AssistResponse の主要な部分。

JSON 表現 
{
  "name": string,
  "state": enum (State),
  "connectorDisplayNames": {
    string: string,
    ...
  },
  "replies": [
    {
      object (Reply)
    }
  ],
  "diagnosticInfo": {
    object
  },
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "requiredAuthorizations": [
    {
      object (RequiredAuthorization)
    }
  ],
  "customerPolicyEnforcementResult": {
    object (CustomerPolicyEnforcementResult)
  }
}
フィールド
name

string

変更不可。ID。AssistAnswer のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}

このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列でなければなりません。
state

enum (State)

回答生成の状態。
connectorDisplayNames

map (key: string, value: string)

出力専用。内部コネクタ エージェント名（ツール名に埋め込まれたマシン識別子（custom_mcp_<fingerprint>_agent など））をコネクタの人が読める表示名にマッピングします。カスタム MCP / Agent Gateway コネクタのサービング時に設定されます。これにより、ユーザー向けのサーフェス（ツール呼び出しチップなど）で、内部 ID ではなくコネクタ名を表示できます。このようなコネクタがない場合は空になります。
replies[]

object (Reply)

アシスタントの応答。
diagnosticInfo

object (Struct format)

省略可。リクエストの処理中に収集された診断情報。これは主にデバッグを目的としており、人間が読むことを想定しています。データの構造は予告なく変更される場合があります。
assistSkippedReasons[]

enum (AssistSkippedReason)

アシスタント機能の呼び出しに応答しない理由。
requiredAuthorizations[]

object (RequiredAuthorization)

出力専用。必要な認可のリスト。ユーザーが特定の Authorization の権限を持っていないが、呼び出されたエージェントがその権限を必要とする場合にのみ入力されます。
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

省略可。このフィールドには、禁止フレーズや Model Armor チェックなど、さまざまなポリシー チェックの結果に関する情報が含まれます。このフィールドは、ポリシー違反が原因でアシスト通話がスキップされた場合にのみ情報が入力されます。

State

回答生成の状態。

列挙型
STATE_UNSPECIFIED 不明。
IN_PROGRESS アシスト オペレーションが現在進行中です。
FAILED アシスト オペレーションが失敗しました。
SUCCEEDED アシスト オペレーションが成功しました。
SKIPPED アシスト オペレーションがスキップされました。
CANCELLED アシスト オペレーションがキャンセルされました（クライアントがストリームを閉じたなど）。部分的な回答が含まれる場合があります。

返信

アシスト通話のマルチパート レスポンスの一部分。

JSON 表現 
{
  "replyId": string,
  "createTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "groundedContent": {
    object (AssistantGroundedContent)
  }
  // End of mutually exclusive fields.
}
フィールド
replyId

string

出力専用。設定されている場合、AssistAnswer リソース内の返信を一意に識別します。AssistantService.StreamAssist 呼び出し中に、同じ ID を持つ複数の Reply メッセージがレスポンス ストリーム内で（複数の StreamAssistResponse メッセージにわたって）発生する可能性があります。これらは、最終的な AssistAnswer リソース内の単一の Reply メッセージの一部を表します。
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"。
アシスタント応答の代替。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
groundedContent

object (AssistantGroundedContent)

アシスタントからの、グラウンディングされた可能性のあるレスポンス テキスト / メディア。
相互に排他的なフィールドの終わり。

AssistantGroundedContent

コンテンツの一部分、および場合によってはそのグラウンディング情報。

すべてのコンテンツにグラウンディングが必要なわけではありません。「Of course, I will gladly search it for you.（もちろん、喜んでお探しします）」などのフレーズはグラウンディングを必要としません。

JSON 表現 
{
  "content": {
    object (AssistantContent)
  },
  "citationMetadata": {
    object (CitationMetadata)
  },
  "contentMetadata": {
    object (ContentMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "textGroundingMetadata": {
    object (TextGroundingMetadata)
  }
  // End of mutually exclusive fields.
}
フィールド
content

object (AssistantContent)

コンテンツ。
citationMetadata

object (CitationMetadata)

生成されたコンテンツのソース アトリビューション。https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check もご覧ください。
contentMetadata

object (ContentMetadata)

省略可。コンテンツのメタデータ。現時点では、リサーチ アシスタントの回答でのみ使用されます。
さまざまなモーダルに関するグラウンディング メタデータ。現時点ではテキストのみがサポートされています。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
textGroundingMetadata

object (TextGroundingMetadata)

テキストソースに基づくグラウンディング用のメタデータ。
相互に排他的なフィールドの終わり。

TextGroundingMetadata

テキストソースのグラウンディング詳細。

JSON 表現 
{
  "segments": [
    {
      object (Segment)
    }
  ],
  "visualSegments": [
    {
      object (VisualSegment)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "searchEntryPoints": [
    {
      object (SearchEntryPoint)
    }
  ]
}
フィールド
segments[]

object (Segment)

テキストの一部に関するグラウンディング情報。
visualSegments[]

object (VisualSegment)

ビジュアル コンテンツの一部に関するグラウンディング情報。
references[]

object (Reference)

グラウンディングされたテキストの参照。
searchEntryPoints[]

object (SearchEntryPoint)

省略可。グラウンディングに使用されるウェブ検索の Google 検索エントリ ポイント。

セグメント

テキストの 1 つのセグメントに関するグラウンディング情報。

JSON 表現 
{
  "startIndex": string,
  "endIndex": string,
  "referenceIndices": [
    integer
  ],
  "groundingScore": number,
  "text": string
}
フィールド
startIndex

string (int64 format)

セグメントの開始を示す、0 ベースのインデックス。UTF-8 文字列のバイト単位で測定されます（つまり複数バイトでエンコードされた文字の長さは 1 より大きくなります）。
endIndex

string (int64 format)

セグメントの終了（終点を含まない）。
referenceIndices[]

integer

セグメントの参照。
groundingScore

number

セグメントのスコア。
text

string

テキスト セグメント自体。

VisualSegment

ビジュアル セグメントのグラウンディング情報。

JSON 表現 
{
  "referenceIndices": [
    integer
  ],
  "contentId": string
}
フィールド
referenceIndices[]

integer

ビジュアル セグメントの参照。
contentId

string

ビジュアル セグメントの Content ID。ビジュアル要素の引用を表示するには、この contentId が groundedContent.content_metadata.content_id フィールドと一致している必要があります。

リファレンス

参照されたコンテンツ、および関連するドキュメント メタデータ。

JSON 表現 
{
  "content": string,
  "codeSnippet": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "chunkMetadata": {
    object
  }
}
フィールド
content

string

参照されたテキスト コンテンツ。
codeSnippet

string

参照ドキュメントのコード スニペットのチャンク。
documentMetadata

object (DocumentMetadata)

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

object (Struct format)

出力専用。アップストリーム データソース コネクタからの汎用構造化チャンク メタデータ。

DocumentMetadata

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

JSON 表現 
{
  "language": enum (Language),
  "boundingBoxes": [
    {
      object (BoundingBox)
    }
  ],
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
フィールド
language

enum (Language)
boundingBoxes[]

object (BoundingBox)

省略可。このリファレンスの境界ボックス。複数のページにまたがる参照をサポートするために繰り返されます。
document

string

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

string

ドキュメントの URI。 実際のウェブサイトにリダイレクトする URL が含まれる場合があります。
title

string

タイトル。
pageIdentifier

string

ページ ID。
domain

string

ドキュメント URI のドメイン名。注: uri フィールドには、実際のウェブサイトにリダイレクトする URL が含まれることがあります。その場合、ここにはターゲット サイトのドメイン名が含まれます。
mimeType

string

ドキュメントの MIME タイプ。https://www.iana.org/assignments/media-types/media-types.xhtml。

言語

参照されるコンテンツの言語。現時点では、コードでのみ使用されます。

列挙型
LANGUAGE_UNSPECIFIED
PYTHON
SQL

BoundingBox

1 つのページを生成する境界ボックス。

JSON 表現 
{
  "pageNumber": string,
  "boundingPoly": {
    object (BoundingPoly)
  }
}
フィールド
pageNumber

string
boundingPoly

object (BoundingPoly)

ドキュメント内のテキスト コンテンツの境界ポリゴン。

BoundingPoly

ドキュメント内のテキスト コンテンツの境界ポリゴン。

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

object (NormalizedVertex)

NormalizedVertex

頂点は、画像内の 2D ポイントを表します。

注: 正規化された頂点座標は、元の画像と相対しており、0～1 の範囲になります。

JSON 表現 
{
  "x": number,
  "y": number
}
フィールド
x

number

X 座標。
y

number

Y 座標（画像の最上部から始まります）。

SearchEntryPoint

Google 検索のエントリ ポイント。

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

string

ウェブページまたはアプリのウェブビューに埋め込むことができるウェブ コンテンツ スニペット。

AssistantContent

マルチモーダル コンテンツ。

JSON 表現 
{
  "role": string,
  "thought": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "inlineData": {
    object (Blob)
  },
  "file": {
    object (File)
  },
  "executableCode": {
    object (ExecutableCode)
  },
  "codeExecutionResult": {
    object (CodeExecutionResult)
  }
  // End of mutually exclusive fields.
}
フィールド
role

string

コンテンツの作成者。「model」または「user」が可能です。
thought

boolean

省略可。この部分がモデルによる「思考」かどうかを示します。
含まれるデータ。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
text

string

インライン テキスト。
inlineData

object (Blob)

インライン バイナリデータ。
file

object (File)

ファイル（音声の要約など）。
executableCode

object (ExecutableCode)

実行されることを目的とする、モデルによって生成されたコード。
codeExecutionResult

object (CodeExecutionResult)

ExecutableCode の実行結果。
相互に排他的なフィールドの終わり。

Blob

インライン blob。

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

string

必須。生成されたデータのメディアタイプ（MIME タイプ）。
data

string (bytes format)

必須。元のバイト。

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

File

ファイル（音声の要約など）。

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

string

必須。ファイルのメディアタイプ（MIME タイプ）。
fileId

string

必須。ファイル ID。

ExecutableCode

モデルによって実行されることを目的とする、モデルによって生成されたコード。

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

string

必須。コード コンテンツ。現時点では、Python のみがサポートされています。

CodeExecutionResult

ExecutableCode の実行結果。

JSON 表現 
{
  "outcome": enum (Outcome),
  "output": string
}
フィールド
outcome

enum (Outcome)

必須。コード実行の結果。
output

string

省略可。コード実行が成功した場合は stdout、それ以外の場合は stderr または他の説明が含まれます。

Outcome

可能性のあるコード実行結果の列挙。

列挙型
OUTCOME_UNSPECIFIED ステータスの指定がありません。この値は使用されるべきではありません。
OUTCOME_OK コード実行が完了し、成功しました。
OUTCOME_FAILED コード実行が完了しましたが、失敗しました。stderr にその理由が含まれています。
OUTCOME_DEADLINE_EXCEEDED コード実行に時間がかかりすぎたため、キャンセルされました。部分的な出力が存在する場合も、存在しない場合もあります。

CitationMetadata

コンテンツの一部分に関するソース アトリビューションの集合。

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

object (Citation)

出力専用。引用のリスト。

Citation

コンテンツのソース アトリビューション。

JSON 表現 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "title": string,
  "license": string,
  "publicationDate": {
    object (Date)
  }
}
フィールド
startIndex

integer

出力専用。コンテンツの開始インデックス。
endIndex

integer

出力専用。コンテンツの末尾のインデックス。
uri

string

出力専用。アトリビューションの URL 参照。
title

string

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

string

出力専用。アトリビューションのライセンス。
publicationDate

object (Date)

出力専用。アトリビューションの公開日。

ContentMetadata

コンテンツのメタデータ。

JSON 表現 
{
  "contentKind": enum (ContentKind),
  "contentId": string
}
フィールド
contentKind

enum (ContentKind)

コンテンツのタイプ。このコンテンツがリサーチ アシスタントの回答のどの部分に属するかを示します。
contentId

string

コンテンツの ID。これは、調査の質問とその回答を結び付けるために使用されます。たとえば、調査の質問に対する回答の各部分には、その質問と同じ contentId が割り当てられます。

ContentKind

可能なコンテンツの種類。現時点では、リサーチ アシスタントの回答全体の中でセクションを区別するためにのみ使用されます。

列挙型
CONTENT_KIND_UNSPECIFIED 不明。
RESEARCH_PLAN リサーチプラン。
RESEARCH_QUESTION 調査の質問。
RESEARCH_ANSWER 調査の回答。
RESEARCH_REPORT 調査レポート。
RESEARCH_AUDIO_SUMMARY 音声による調査の要約。

AssistSkippedReason

アシスト通話に応答しない理由として可能性のあるもの。

列挙型
ASSIST_SKIPPED_REASON_UNSPECIFIED デフォルト値。スキップの理由が指定されていません。
NON_ASSIST_SEEKING_QUERY_IGNORED 回答を求めているようには見えなかったため、アシスタントはクエリを無視しました。
CUSTOMER_POLICY_VIOLATION 顧客ポリシーに違反している（例: クエリまたは回答に禁止フレーズが含まれている）ため、アシスタントはクエリを無視したか、回答を拒否しました。

RequiredAuthorization

エージェントが機能するために必要な認可を表します。

JSON 表現 
{
  "authorization": string,
  "displayName": string,
  "authorizationUri": string,
  "authConfig": {
    object (AuthConfig)
  }
}
フィールド
authorization

string

出力専用。Authorization の名前。
displayName

string

出力専用。認可の表示名。
authorizationUri

string

出力専用。ユーザーが認証のために開く必要がある URI。
authConfig

object (AuthConfig)

出力専用。サードパーティ（ADK）エージェントに必要な認可の構成。これは、認証が ADK エージェントから発信された場合に設定されます。その場合、上記のファーストパーティの authorization リソース名は通常設定されません。

AuthConfig

サードパーティの認可の構成。

JSON 表現 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oauth2": {
    object (OAuth2Credential)
  }
  // End of mutually exclusive fields.
}
フィールド
認証情報の構成。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
oauth2

object (OAuth2Credential)

OAuth2 認証情報の構成。
相互に排他的なフィールドの終わり。

OAuth2Credential

OAuth2 認証の構成。

JSON 表現 
{
  "clientId": string,
  "clientSecret": string,
  "nonce": string,
  "state": string,
  "redirectUri": string,
  "authResponseUri": string,
  "authCode": string,
  "accessToken": string,
  "refreshToken": string,
  "idToken": string,
  "expireTime": string,
  "expireDuration": string,
  "audience": string,
  "codeVerifier": string,
  "codeChallengeMethod": string,
  "tokenEndpointAuthMethod": string
}
フィールド
clientId

string

出力専用。クライアント ID。
clientSecret

string

出力専用。クライアント シークレット。
nonce

string

出力専用。nonce 値。
state

string

出力専用。状態の値。
redirectUri

string

出力専用。リダイレクト URI。
authResponseUri

string

出力専用。認可レスポンス URI。
authCode

string

出力専用。認証コード。
accessToken

string

出力専用。アクセス トークン。
refreshToken

string

出力専用。更新トークン。
idToken

string

出力専用。ID トークン。
expireTime

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

string (Duration format)

出力専用。有効期限。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
audience

string

出力専用。対象者。
codeVerifier

string

出力専用。コード検証ツール。
codeChallengeMethod

string

出力専用。コードチャレンジ メソッド。
tokenEndpointAuthMethod

string

出力専用。トークン エンドポイントの認証方法。

CustomerPolicyEnforcementResult

顧客ポリシーの適用結果。禁止フレーズや Model Armor チェックなど、さまざまなポリシー チェックの結果が含まれます。

JSON 表現 
{
  "verdict": enum (Verdict),
  "policyResults": [
    {
      object (PolicyEnforcementResult)
    }
  ],
  "violationSource": enum (ViolationSource)
}
フィールド
verdict

enum (Verdict)

顧客ポリシー適用の最終的な判定。1 つのポリシーだけが処理をブロックした場合、判定は BLOCK になります。
policyResults[]

object (PolicyEnforcementResult)

顧客ポリシーの適用結果。ポリシー違反によりアシスト通話がスキップされた場合にのみ、情報が入ります。クエリの処理をブロックしたフィルタからの結果がここに含まれます。
violationSource

enum (ViolationSource)

出力専用。違反の発生源。

判定結果

顧客ポリシー適用による判定。

列挙型
UNSPECIFIED 不明な値。
ALLOW ポリシー違反はありませんでした。
BLOCK 顧客ポリシーによって処理がブロックされました。

PolicyEnforcementResult

単一ポリシータイプの顧客ポリシーの適用結果。

JSON 表現 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "bannedPhraseEnforcementResult": {
    object (BannedPhraseEnforcementResult)
  },
  "modelArmorEnforcementResult": {
    object (ModelArmorEnforcementResult)
  }
  // End of mutually exclusive fields.
}
フィールド
ポリシータイプに固有の結果。これはエラー、またはポリシー適用結果の詳細情報です。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

禁止フレーズ ポリシーの適用結果。
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

Model Armor ポリシーの適用結果。
相互に排他的なフィールドの終わり。

BannedPhraseEnforcementResult

禁止フレーズ ポリシーに関する顧客ポリシー適用結果。

JSON 表現 
{
  "bannedPhrases": [
    string
  ]
}
フィールド
bannedPhrases[]

string

クエリまたは回答の中で見つかった禁止フレーズ。

ModelArmorEnforcementResult

Model Armor ポリシーに関する顧客ポリシー適用結果。

JSON 表現 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "modelArmorViolation": string,
  "error": {
    object (Status)
  }
  // End of mutually exclusive fields.
}
フィールド
Model Armor ポリシーの結果。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
modelArmorViolation

string

検出された Model Armor 違反。
error

object (Status)

なんらかの理由でポリシー適用が失敗した場合に Model Armor から返されるエラー。
相互に排他的なフィールドの終わり。

ViolationSource

ポリシー違反によりアシスト通話がスキップされた場合、違反の原因が含まれます。

列挙型
VIOLATION_SOURCE_UNSPECIFIED 不明な値。
SYSTEM システム レスポンスで違反が見つかりました。
PROMPT ユーザーのプロンプトで違反が見つかりました。
ATTACHMENT ユーザーの添付ファイルで違反が検出されました。

メソッド

get

 AssistAnswer を取得します。