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

リソース: AssistAnswer

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

JSON 表現 
{
  "name": string,
  "state": enum (State),
  "replies": [
    {
      object (Reply)
    }
  ],
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "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)

回答生成の状態。
replies[]

object (Reply)

アシスタントの応答。
assistSkippedReasons[]

enum (AssistSkippedReason)

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

object (CustomerPolicyEnforcementResult)

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

State

回答生成の状態。

列挙型
STATE_UNSPECIFIED 不明。
IN_PROGRESS アシスト オペレーションが現在進行中です。
FAILED アシスト オペレーションが失敗しました。
SUCCEEDED アシスト オペレーションが成功しました。
SKIPPED アシスト オペレーションがスキップされました。

Reply

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

JSON 表現 
{

  // Union field reply can be only one of the following:
  "groundedContent": {
    object (AssistantGroundedContent)
  }
  // End of list of possible types for union field reply.
}
フィールド
共用体フィールド reply。アシスタント応答の代替。reply は次のいずれか 1 つになります。
groundedContent

object (AssistantGroundedContent)

アシスタントからの、グラウンディングされた可能性のあるレスポンス テキスト / メディア。

AssistantGroundedContent

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

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

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

  // Union field metadata can be only one of the following:
  "textGroundingMetadata": {
    object (TextGroundingMetadata)
  }
  // End of list of possible types for union field metadata.
}
フィールド
content

object (AssistantContent)

コンテンツ。
citationMetadata

object (CitationMetadata)

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

object (ContentMetadata)

省略可。コンテンツのメタデータ。現時点では、リサーチ アシスタントの回答でのみ使用されます。
共用体フィールド metadata。さまざまなモーダルに関するグラウンディング メタデータ。現時点ではテキストのみがサポートされています。metadata は次のいずれか 1 つになります。
textGroundingMetadata

object (TextGroundingMetadata)

テキストソースに基づくグラウンディング用のメタデータ。

TextGroundingMetadata

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

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

object (Segment)

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

object (Reference)

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

Segment

テキストの 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

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

Reference

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

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

string

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

object (DocumentMetadata)

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

DocumentMetadata

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

JSON 表現 
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
フィールド
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。

AssistantContent

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

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

  // Union field data can be only one of the following:
  "text": string,
  "inlineData": {
    object (Blob)
  },
  "file": {
    object (File)
  },
  "executableCode": {
    object (ExecutableCode)
  },
  "codeExecutionResult": {
    object (CodeExecutionResult)
  }
  // End of list of possible types for union field data.
}
フィールド
role

string

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

boolean

省略可。この部分がモデルによる「思考」かどうかを示します。
共用体フィールド data。含まれるデータ。data は次のいずれか 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 顧客ポリシーに違反している（例: クエリまたは回答に禁止フレーズが含まれている）ため、アシスタントはクエリを無視したか、回答を拒否しました。

CustomerPolicyEnforcementResult

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

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

enum (Verdict)

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

object (PolicyEnforcementResult)

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

Verdict

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

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

PolicyEnforcementResult

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

JSON 表現 
{

  // Union field enforcement_result can be only one of the following:
  "bannedPhraseEnforcementResult": {
    object (BannedPhraseEnforcementResult)
  },
  "modelArmorEnforcementResult": {
    object (ModelArmorEnforcementResult)
  }
  // End of list of possible types for union field enforcement_result.
}
フィールド
共用体フィールド enforcement_result。ポリシータイプ固有の結果。これはエラー、またはポリシー適用結果の詳細情報です。enforcement_result は次のいずれか 1 つになります。
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

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

object (ModelArmorEnforcementResult)

Model Armor ポリシーの適用結果。

BannedPhraseEnforcementResult

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

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

string

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

ModelArmorEnforcementResult

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

JSON 表現 
{

  // Union field result can be only one of the following:
  "modelArmorViolation": string,
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
フィールド
共用体フィールド result。Model Armor ポリシーの結果。result は次のいずれか 1 つになります。
modelArmorViolation

string

検出された Model Armor 違反。
error

object (Status)

なんらかの理由でポリシー適用が失敗した場合に Model Armor から返されるエラー。

メソッド

get

 AssistAnswer を取得します。