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_UNSPECIFIED 不明。
IN_PROGRESS アシスト オペレーションが現在進行中です。
FAILED アシスト操作に失敗しました。
SUCCEEDED アシスト オペレーションが成功しました。
SKIPPED アシスト オペレーションがスキップされました。

返信

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

JSON 表現 
{

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

object (AssistantGroundedContent)

アシスタントからのグラウンディングされたレスポンス テキストまたはメディア。

AssistantGroundedContent

コンテンツと、場合によってはそのグラウンディング情報。

すべてのコンテンツにグラウンディングが必要なわけではありません。「もちろん、喜んでお探しします」などのフレーズはグラウンディングを必要としません。

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 は次のいずれかになります。
textGroundingMetadata

object (TextGroundingMetadata)

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

TextGroundingMetadata

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

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

object (Segment)

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

object (Reference)

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

セグメント

テキストのセグメントのグラウンディング情報。

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

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

リファレンス

参照されたコンテンツと関連するドキュメントのメタデータ。

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 は次のいずれかになります。
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 でエンコードされた文字列。

ファイル

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

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_UNSPECIFIED ステータスが指定されていません。この値は使用しないでください。
OUTCOME_OK コードの実行が正常に完了しました。
OUTCOME_FAILED コードの実行は完了しましたが、失敗しました。stderr に理由が出力されます。
OUTCOME_DEADLINE_EXCEEDED コードの実行に時間がかかり過ぎたため、キャンセルされました。部分的な出力が存在する場合と存在しない場合があります。

CitationMetadata

コンテンツのソース帰属情報のコレクション。

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

object (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)

お客様のポリシー適用結果。アシスト通話がポリシー違反によりスキップされた場合にのみ設定されます。クエリの処理をブロックしたフィルタの結果が含まれています。

判定

お客様のポリシー違反に対する措置の判断。

列挙型
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.
}
Fields
共用体フィールド enforcement_result。ポリシー タイプ固有の結果。エラーまたはポリシー違反の結果に関する詳細情報が表示されます。enforcement_result は次のいずれかになります。
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.
}
Fields
共用体フィールド result。Model Armor ポリシーの結果。result は次のいずれかになります。
modelArmorViolation

string

検出された Model Armor の違反。
error

object (Status)

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

メソッド

get

 AssistAnswer を取得します。