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

Resource: AssistAnswer

Resource AssistAnswer, bagian utama dari AssistResponse.

Representasi JSON 
{
  "name": string,
  "state": enum (State),
  "connectorDisplayNames": {
    string: string,
    ...
  },
  "replies": [
    {
      object (Reply)
    }
  ],
  "diagnosticInfo": {
    object
  },
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "requiredAuthorizations": [
    {
      object (RequiredAuthorization)
    }
  ],
  "customerPolicyEnforcementResult": {
    object (CustomerPolicyEnforcementResult)
  }
}
Kolom
name

string

Tidak dapat diubah. ID. Nama resource AssistAnswer. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}

Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.
state

enum (State)

Status pembuatan jawaban.
connectorDisplayNames

map (key: string, value: string)

Hanya output. Memetakan nama agen konektor internal (ID mesin yang disematkan dalam nama alat, misalnya custom_mcp_<fingerprint>_agent) ke nama tampilan konektor yang mudah dibaca manusia. Diisi pada waktu penayangan untuk konektor gateway agen / MCP kustom sehingga platform yang ditampilkan kepada pengguna (misalnya, chip panggilan alat) dapat menampilkan nama konektor, bukan ID internalnya. Kosong jika tidak ada konektor tersebut.
replies[]

object (Reply)

Balasan asisten.
diagnosticInfo

object (Struct format)

Opsional. Informasi diagnostik yang dikumpulkan saat memproses permintaan. Ini hanya ditujukan untuk pembaca manusia, terutama untuk membantu proses debug. Struktur data dapat berubah tanpa pemberitahuan.
assistSkippedReasons[]

enum (AssistSkippedReason)

Alasan tidak menjawab panggilan bantuan.
requiredAuthorizations[]

object (RequiredAuthorization)

Hanya output. Daftar otorisasi yang diperlukan. Hanya diisi jika pengguna tidak diberi otorisasi untuk Authorization tertentu, tetapi agen yang dipanggil memerlukannya.
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

Opsional. Kolom ini berisi informasi tentang hasil berbagai pemeriksaan kebijakan seperti frasa terlarang atau pemeriksaan Model Armor. Kolom ini hanya diisi jika panggilan bantuan dilewati karena pelanggaran kebijakan.

Negara Bagian

Status pembuatan jawaban.

Enum
STATE_UNSPECIFIED Tidak diketahui.
IN_PROGRESS Operasi bantuan sedang berlangsung.
FAILED Operasi bantuan gagal.
SUCCEEDED Operasi bantuan berhasil.
SKIPPED Operasi bantuan telah dilewati.
CANCELLED Operasi bantuan telah dibatalkan (misalnya, klien menutup streaming). Mungkin berisi respons sebagian.

Balas

Salah satu bagian dari respons multi-bagian panggilan bantuan.

Representasi 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.
}
Kolom
replyId

string

Hanya output. Jika disetel, secara unik mengidentifikasi balasan dalam resource AssistAnswer. Selama panggilan AssistantService.StreamAssist, beberapa pesan Reply dengan ID yang sama dapat terjadi dalam aliran respons (di beberapa pesan StreamAssistResponse). Bagian ini mewakili bagian dari satu pesan Reply dalam resource AssistAnswer akhir.
createTime

string (Timestamp format)

Waktu saat balasan dibuat.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
Alternatif untuk jawaban asisten. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
groundedContent

object (AssistantGroundedContent)

Respons teks atau media yang mungkin memiliki rujukan dari asisten.
Akhir kolom yang saling eksklusif.

AssistantGroundedContent

Sebuah konten dan kemungkinan informasi perujukan konten tersebut.

Tidak semua konten memerlukan perujukan. Frasa seperti "Tentu, saya akan dengan senang hati menelusurinya untuk Anda" tidak memerlukan perujukan.

Representasi 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.
}
Kolom
content

object (AssistantContent)

Konten.
citationMetadata

object (CitationMetadata)

Atribusi sumber konten yang dihasilkan. Lihat juga https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
contentMetadata

object (ContentMetadata)

Opsional. Metadata untuk konten. Saat ini hanya digunakan untuk jawaban asisten riset.
Metadata perujukan untuk berbagai modal. Saat ini, hanya teks yang didukung. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
textGroundingMetadata

object (TextGroundingMetadata)

Metadata untuk perujukan berdasarkan sumber teks.
Akhir kolom yang saling eksklusif.

TextGroundingMetadata

Detail perujukan untuk sumber teks.

Representasi JSON 
{
  "segments": [
    {
      object (Segment)
    }
  ],
  "visualSegments": [
    {
      object (VisualSegment)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "searchEntryPoints": [
    {
      object (SearchEntryPoint)
    }
  ]
}
Kolom
segments[]

object (Segment)

Informasi perujukan untuk bagian teks.
visualSegments[]

object (VisualSegment)

Informasi pendukung untuk bagian konten visual.
references[]

object (Reference)

Referensi untuk teks yang memiliki rujukan.
searchEntryPoints[]

object (SearchEntryPoint)

Opsional. Titik entri Google Penelusuran untuk penelusuran web yang digunakan untuk perujukan.

Segmen

Informasi perujukan untuk segmen teks.

Representasi JSON 
{
  "startIndex": string,
  "endIndex": string,
  "referenceIndices": [
    integer
  ],
  "groundingScore": number,
  "text": string
}
Kolom
startIndex

string (int64 format)

Indeks berbasis nol yang menunjukkan awal segmen, diukur dalam byte string UTF-8 (yaitu karakter yang dienkode pada beberapa byte memiliki panjang lebih dari satu).
endIndex

string (int64 format)

Akhir segmen, eksklusif.
referenceIndices[]

integer

Referensi untuk segmen.
groundingScore

number

Skor untuk segmen.
text

string

Segmen teks itu sendiri.

VisualSegment

Informasi pendukung untuk segmen visual.

Representasi JSON 
{
  "referenceIndices": [
    integer
  ],
  "contentId": string
}
Kolom
referenceIndices[]

integer

Referensi untuk segmen visual.
contentId

string

Content ID segmen visual. Untuk menampilkan kutipan elemen visual, contentId ini harus cocok dengan kolom groundedContent.content_metadata.content_id.

Referensi

Konten yang dirujuk dan metadata dokumen terkait.

Representasi JSON 
{
  "content": string,
  "codeSnippet": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "chunkMetadata": {
    object
  }
}
Kolom
content

string

Konten teks yang dirujuk.
codeSnippet

string

Potongan cuplikan kode dari dokumen yang dirujuk.
documentMetadata

object (DocumentMetadata)

Metadata dokumen.
chunkMetadata

object (Struct format)

Hanya output. Metadata potongan terstruktur generik dari konektor sumber data upstream.

DocumentMetadata

Metadata dokumen.

Representasi JSON 
{
  "language": enum (Language),
  "boundingBoxes": [
    {
      object (BoundingBox)
    }
  ],
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
Kolom
language

enum (Language)
boundingBoxes[]

object (BoundingBox)

Opsional. Kotak pembatas untuk referensi ini. Diulang untuk mendukung referensi yang memunculkan beberapa halaman.
document

string

Nama resource dokumen.
uri

string

URI untuk dokumen. Mungkin berisi URL yang mengalihkan ke situs sebenarnya.
title

string

Judul.
pageIdentifier

string

ID halaman.
domain

string

Nama domain dari URI dokumen. Perhatikan bahwa kolom uri dapat berisi URL yang mengalihkan ke situs sebenarnya, yang dalam hal ini akan berisi nama domain situs target.
mimeType

string

Jenis MIME dokumen. https://www.iana.org/assignments/media-types/media-types.xhtml.

Bahasa

Bahasa konten yang dirujuk. Untuk saat ini, hanya digunakan untuk kode.

Enum
LANGUAGE_UNSPECIFIED
PYTHON
SQL

BoundingBox

Kotak pembatas yang memunculkan satu halaman.

Representasi JSON 
{
  "pageNumber": string,
  "boundingPoly": {
    object (BoundingPoly)
  }
}
Kolom
pageNumber

string
boundingPoly

object (BoundingPoly)

Bounding poly untuk konten teks dalam dokumen.

BoundingPoly

Bounding poly untuk konten teks dalam dokumen.

Representasi JSON 
{
  "normalizedVertices": [
    {
      object (NormalizedVertex)
    }
  ]
}
Kolom
normalizedVertices[]

object (NormalizedVertex)

NormalizedVertex

verteks mewakili titik 2D pada gambar.

CATATAN: koordinat verteks yang dinormalisasi akan relatif terhadap gambar asli dan memiliki rentang dari 0 hingga 1.

Representasi JSON 
{
  "x": number,
  "y": number
}
Kolom
x

number

Koordinat x.
y

number

Koordinat Y (dimulai dari bagian atas gambar).

SearchEntryPoint

Titik entri Google Penelusuran.

Representasi JSON 
{
  "renderedContent": string
}
Kolom
renderedContent

string

Cuplikan konten web yang dapat disematkan di halaman web atau webview aplikasi.

AssistantContent

Konten multi-modal.

Representasi 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.
}
Kolom
role

string

Produser konten. Dapat berupa "model" atau "user".
thought

boolean

Opsional. Menunjukkan apakah bagian tersebut merupakan hasil pemikiran dari model.
Data yang disertakan. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
text

string

Teks inline.
inlineData

object (Blob)

Data biner inline.
file

object (File)

File, misalnya, ringkasan audio.
executableCode

object (ExecutableCode)

kode yang dihasilkan oleh model yang dimaksudkan untuk dieksekusi.
codeExecutionResult

object (CodeExecutionResult)

Hasil menjalankan ExecutableCode.
Akhir kolom yang saling eksklusif.

Blob

Blob inline.

Representasi JSON 
{
  "mimeType": string,
  "data": string
}
Kolom
mimeType

string

Wajib. Jenis media (jenis MIME) data yang dihasilkan.
data

string (bytes format)

Wajib. Byte mentah.

String berenkode base64.

File

File, misalnya, ringkasan audio.

Representasi JSON 
{
  "mimeType": string,
  "fileId": string
}
Kolom
mimeType

string

Wajib. Jenis media (jenis MIME) file.
fileId

string

Wajib. ID file.

ExecutableCode

kode yang dihasilkan oleh model yang dimaksudkan untuk dieksekusi oleh model.

Representasi JSON 
{
  "code": string
}
Kolom
code

string

Wajib. Konten kode. Saat ini hanya mendukung Python.

CodeExecutionResult

Hasil eksekusi ExecutableCode.

Representasi JSON 
{
  "outcome": enum (Outcome),
  "output": string
}
Kolom
outcome

enum (Outcome)

Wajib. Hasil eksekusi kode.
output

string

Opsional. Berisi stdout saat eksekusi kode berhasil, stderr, atau deskripsi lainnya.

Hasil

Enumerasi kemungkinan hasil eksekusi kode.

Enum
OUTCOME_UNSPECIFIED Status tidak ditentukan. Nilai ini tidak boleh digunakan.
OUTCOME_OK eksekusi kode berhasil diselesaikan.
OUTCOME_FAILED eksekusi kode selesai, tetapi gagal. stderr harus berisi alasan.
OUTCOME_DEADLINE_EXCEEDED eksekusi kode berjalan terlalu lama, dan dibatalkan. Output parsial mungkin ada atau tidak ada.

CitationMetadata

Kumpulan atribusi sumber untuk suatu konten.

Representasi JSON 
{
  "citations": [
    {
      object (Citation)
    }
  ]
}
Kolom
citations[]

object (Citation)

Hanya output. Daftar kutipan.

Pengutipan

Atribusi sumber untuk konten.

Representasi JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "title": string,
  "license": string,
  "publicationDate": {
    object (Date)
  }
}
Kolom
startIndex

integer

Hanya output. Indeks awal ke dalam konten.
endIndex

integer

Hanya output. Indeks akhir ke dalam konten.
uri

string

Hanya output. Referensi URL atribusi.
title

string

Hanya output. Judul atribusi.
license

string

Hanya output. Lisensi atribusi.
publicationDate

object (Date)

Hanya output. Tanggal terbit atribusi.

ContentMetadata

metadata untuk konten.

Representasi JSON 
{
  "contentKind": enum (ContentKind),
  "contentId": string
}
Kolom
contentKind

enum (ContentKind)

jenis konten. Menunjukkan bagian jawaban asisten riset yang berisi konten ini.
contentId

string

ID konten. Hal ini digunakan untuk menghubungkan pertanyaan penelitian dengan jawabannya. Misalnya, bagian jawaban atas pertanyaan penelitian akan memiliki contentId yang sama dengan pertanyaan.

ContentKind

Kemungkinan jenis konten. Saat ini hanya digunakan untuk membedakan bagian dalam jawaban lengkap asisten riset.

Enum
CONTENT_KIND_UNSPECIFIED Tidak diketahui.
RESEARCH_PLAN Rencana riset.
RESEARCH_QUESTION Pertanyaan penelitian.
RESEARCH_ANSWER Jawaban penelitian.
RESEARCH_REPORT Research report.
RESEARCH_AUDIO_SUMMARY Ringkasan audio riset.

AssistSkippedReason

Kemungkinan alasan tidak menjawab panggilan bantuan.

Enum
ASSIST_SKIPPED_REASON_UNSPECIFIED Nilai default. Alasan lewati tidak ditentukan.
NON_ASSIST_SEEKING_QUERY_IGNORED Asisten mengabaikan kueri karena tampaknya tidak mencari jawaban.
CUSTOMER_POLICY_VIOLATION Asisten mengabaikan kueri atau menolak menjawab karena pelanggaran kebijakan pelanggan (misalnya, kueri atau jawaban berisi frasa yang dilarang).

RequiredAuthorization

Mewakili otorisasi yang diperlukan agar agen dapat berfungsi.

Representasi JSON 
{
  "authorization": string,
  "displayName": string,
  "authorizationUri": string,
  "authConfig": {
    object (AuthConfig)
  }
}
Kolom
authorization

string

Hanya output. Nama Authorization.
displayName

string

Hanya output. Nama tampilan otorisasi.
authorizationUri

string

Hanya output. URI yang harus dibuka pengguna untuk memberikan otorisasi.
authConfig

object (AuthConfig)

Hanya output. Konfigurasi untuk otorisasi yang diperlukan oleh agen pihak ketiga (ADK). Kolom ini diisi saat otorisasi berasal dari agen ADK; dalam hal ini, nama resource authorization pihak pertama di atas biasanya tidak ditetapkan.

AuthConfig

Konfigurasi untuk otorisasi pihak ketiga.

Representasi 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.
}
Kolom
Konfigurasi untuk kredensial. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
oauth2

object (OAuth2Credential)

Konfigurasi kredensial OAuth2.
Akhir kolom yang saling eksklusif.

OAuth2Credential

Konfigurasi untuk otorisasi OAuth2.

Representasi 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
}
Kolom
clientId

string

Hanya output. ID klien.
clientSecret

string

Hanya output. Rahasia klien.
nonce

string

Hanya output. Nilai nonce.
state

string

Hanya output. Nilai status.
redirectUri

string

Hanya output. URI pengalihan.
authResponseUri

string

Hanya output. URI respons otorisasi.
authCode

string

Hanya output. Kode otorisasi.
accessToken

string

Hanya output. Token akses.
refreshToken

string

Hanya output. Token refresh.
idToken

string

Hanya output. Token ID.
expireTime

string (Timestamp format)

Hanya output. Waktu habis masa berlaku.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
expireDuration

string (Duration format)

Hanya output. Durasi masa berlaku.

Durasi dalam detik dengan maksimal sembilan digit pecahan, diakhiri dengan 's'. Contoh: "3.5s".
audience

string

Hanya output. Audiens.
codeVerifier

string

Hanya output. Verifier kode.
codeChallengeMethod

string

Hanya output. Metode tantangan kode.
tokenEndpointAuthMethod

string

Hanya output. Metode otorisasi endpoint token.

CustomerPolicyEnforcementResult

Hasil penegakan kebijakan pelanggan. Berisi hasil dari berbagai pemeriksaan kebijakan, seperti frasa terlarang atau pemeriksaan Model Armor.

Representasi JSON 
{
  "verdict": enum (Verdict),
  "policyResults": [
    {
      object (PolicyEnforcementResult)
    }
  ],
  "violationSource": enum (ViolationSource)
}
Kolom
verdict

enum (Verdict)

Putusan akhir penegakan kebijakan pelanggan. Jika hanya satu kebijakan yang memblokir pemrosesan, putusannya adalah BLOKIR.
policyResults[]

object (PolicyEnforcementResult)

Hasil penegakan kebijakan pelanggan. Diisi hanya jika panggilan bantuan dilewati karena pelanggaran kebijakan. Berisi hasil dari filter yang memblokir pemrosesan kueri tersebut.
violationSource

enum (ViolationSource)

Hanya output. Sumber pelanggaran.

Putusan

Putusan penegakan kebijakan pelanggan.

Enum
UNSPECIFIED Nilai tidak diketahui.
ALLOW Tidak ada pelanggaran kebijakan.
BLOCK Pemrosesan diblokir oleh kebijakan pelanggan.

PolicyEnforcementResult

Hasil penegakan kebijakan pelanggan untuk satu jenis kebijakan.

Representasi 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.
}
Kolom
Hasil khusus jenis kebijakan. Nilai ini dapat berupa error atau informasi mendetail tentang hasil penegakan kebijakan. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

Hasil penegakan kebijakan untuk kebijakan frasa terlarang.
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

Hasil penerapan kebijakan untuk kebijakan Model Armor.
Akhir kolom yang saling eksklusif.

BannedPhraseEnforcementResult

Hasil penegakan kebijakan pelanggan untuk kebijakan frasa terlarang.

Representasi JSON 
{
  "bannedPhrases": [
    string
  ]
}
Kolom
bannedPhrases[]

string

Frasa terlarang yang ditemukan dalam kueri atau jawaban.

ModelArmorEnforcementResult

Hasil penegakan kebijakan pelanggan untuk kebijakan Model Armor.

Representasi 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.
}
Kolom
Hasil kebijakan Model Armor. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
modelArmorViolation

string

Pelanggaran Model Armor yang ditemukan.
error

object (Status)

Error yang ditampilkan oleh Model Armor jika penerapan kebijakan gagal karena alasan tertentu.
Akhir kolom yang saling eksklusif.

ViolationSource

Jika panggilan bantuan dilewati karena pelanggaran kebijakan, kolom ini akan berisi sumber pelanggaran.

Enum
VIOLATION_SOURCE_UNSPECIFIED Nilai tidak diketahui.
SYSTEM Pelanggaran ditemukan dalam respons sistem.
PROMPT Pelanggaran ditemukan dalam perintah pengguna.
ATTACHMENT Pelanggaran ditemukan dalam lampiran pengguna.

Metode

get

 Mendapatkan AssistAnswer.