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

Resource: AssistAnswer

Resource AssistAnswer, bagian utama dari AssistResponse.

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

object (Reply)

Balasan asisten.
assistSkippedReasons[]

enum (AssistSkippedReason)

Alasan tidak menjawab panggilan bantuan.
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

Opsional. Kolom ini berisi informasi tentang hasil berbagai pemeriksaan kebijakan seperti frasa yang dilarang 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 aliran). Mungkin berisi respons sebagian.

Balas

Salah satu bagian dari respons multi-bagian panggilan bantuan.

Representasi JSON 
{
  "createTime": string,

  // Union field reply can be only one of the following:
  "groundedContent": {
    object (AssistantGroundedContent)
  }
  // End of list of possible types for union field reply.
}
Kolom
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".
Kolom union reply. Alternatif untuk jawaban asisten. reply hanya ada berupa salah satu diantara berikut:
groundedContent

object (AssistantGroundedContent)

Respons teks atau media yang mungkin memiliki rujukan dari asisten.

AssistantGroundedContent

Sebuah konten dan kemungkinan informasi perujukannya.

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)
  },

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

object (AssistantContent)

Konten.
citationMetadata

object (CitationMetadata)

Atribusi sumber konten buatan AI. 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.
Kolom union metadata. Metadata perujukan untuk berbagai modal. Saat ini hanya mendukung teks. metadata hanya ada berupa salah satu diantara berikut:
textGroundingMetadata

object (TextGroundingMetadata)

Metadata untuk perujukan berdasarkan sumber teks.

TextGroundingMetadata

Detail perujukan untuk sumber teks.

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

object (Segment)

Informasi perujukan untuk bagian teks.
visualSegments[]

object (VisualSegment)

Informasi perujukan untuk bagian konten visual.
references[]

object (Reference)

Referensi untuk teks yang memiliki rujukan.

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 perujukan untuk segmen visual.

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

integer

Referensi untuk segmen visual.
contentId

string

ID konten 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)
  }
}
Kolom
content

string

Konten teks yang dirujuk.
codeSnippet

string

Potongan cuplikan kode dari dokumen yang dirujuk.
documentMetadata

object (DocumentMetadata)

Metadata dokumen.

DocumentMetadata

Metadata dokumen.

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

enum (Language)
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

AssistantContent

Konten multi-modal.

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

string

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

boolean

Opsional. Menunjukkan apakah bagian tersebut dipikirkan dari model.
Kolom union data. Data yang terkandung. data hanya ada berupa salah satu diantara berikut:
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 eksekusi ExecutableCode.

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. Mungkin ada atau tidak ada output parsial.

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 publikasi 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 melewati 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).

CustomerPolicyEnforcementResult

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

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

enum (Verdict)

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

object (PolicyEnforcementResult)

Hasil penegakan kebijakan pelanggan. Diisi hanya jika panggilan bantuan dilewati karena pelanggaran kebijakan. Bagian ini berisi hasil dari filter yang memblokir pemrosesan kueri.

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 
{

  // 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.
}
Kolom
Kolom union enforcement_result. Hasil spesifik jenis kebijakan. Nilai ini dapat berupa error atau informasi mendetail tentang hasil penegakan kebijakan. enforcement_result hanya ada berupa salah satu diantara berikut:
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

Hasil penegakan kebijakan untuk kebijakan frasa terlarang.
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

Hasil penerapan kebijakan untuk kebijakan Model Armor.

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 
{

  // 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.
}
Kolom
Kolom union result. Hasil kebijakan Model Armor. result hanya ada berupa salah satu diantara berikut:
modelArmorViolation

string

Pelanggaran Model Armor yang ditemukan.
error

object (Status)

Error yang ditampilkan oleh Model Armor jika penerapan kebijakan gagal karena alasan tertentu.

Metode

get

 Mendapatkan AssistAnswer.