REST Resource: projects.locations.collections.dataStores.sessions.answers

Resource: Jawaban

Menentukan jawaban.

Representasi JSON
{
  "name": string,
  "state": enum (State),
  "answerText": string,
  "citations": [
    {
      object (Citation)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "blobAttachments": [
    {
      object (BlobAttachment)
    }
  ],
  "relatedQuestions": [
    string
  ],
  "steps": [
    {
      object (Step)
    }
  ],
  "queryUnderstandingInfo": {
    object (QueryUnderstandingInfo)
  },
  "answerSkippedReasons": [
    enum (AnswerSkippedReason)
  ],
  "createTime": string,
  "completeTime": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "groundingScore": number
}
Kolom
name

string

Tidak dapat diubah. Nama yang sepenuhnya memenuhi syarat projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*

state

enum (State)

Status pembuatan jawaban.

answerText

string

Jawaban tekstual.

citations[]

object (Citation)

Kutipan.

groundingSupports[]

object (GroundingSupport)

Opsional. Dukungan perujukan.

references[]

object (Reference)

Referensi.

blobAttachments[]

object (BlobAttachment)

Daftar lampiran blob dalam jawaban.

relatedQuestions[]

string

Pertanyaan terkait yang disarankan.

steps[]

object (Step)

Langkah-langkah pembuatan jawaban.

queryUnderstandingInfo

object (QueryUnderstandingInfo)

Informasi pemahaman kueri.

answerSkippedReasons[]

enum (AnswerSkippedReason)

Alasan tambahan jawaban dilewati. Hal ini memberikan alasan untuk kasus yang diabaikan. Jika tidak ada yang dilewati, kolom ini tidak ditetapkan.

createTime

string (Timestamp format)

Hanya output. Stempel waktu pembuatan jawaban.

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".

completeTime

string (Timestamp format)

Hanya output. Stempel waktu penyelesaian jawaban.

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".

safetyRatings[]

object (SafetyRating)

Opsional. Peringkat keselamatan.

groundingScore

number

Skor dalam rentang [0, 1] yang menjelaskan seberapa kuat jawaban didasarkan pada potongan referensi.

Negara bagian/Provinsi

Enumerasi Status pembuatan jawaban.

Enum
STATE_UNSPECIFIED Tidak diketahui.
IN_PROGRESS Pembuatan jawaban sedang berlangsung.
FAILED Pembuatan jawaban saat ini gagal.
SUCCEEDED Pembuatan jawaban berhasil.
STREAMING Pembuatan jawaban sedang berlangsung.

Pengutipan

Info kutipan untuk segmen.

Representasi JSON
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Kolom
startIndex

string (int64 format)

Indeks menunjukkan awal segmen, diukur dalam byte (Unicode UTF-8). Jika ada karakter multi-byte,seperti karakter non-ASCII, pengukuran indeks lebih panjang daripada panjang string.

endIndex

string (int64 format)

Akhir segmen yang diatribusikan, eksklusif. Diukur dalam byte (Unicode UTF-8). Jika ada karakter multi-byte,seperti karakter non-ASCII, pengukuran indeks lebih panjang daripada panjang string.

sources[]

object (CitationSource)

Sumber kutipan untuk segmen yang diatribusikan.

CitationSource

Sumber kutipan.

Representasi JSON
{
  "referenceId": string
}
Kolom
referenceId

string

ID sumber kutipan.

GroundingSupport

Dukungan perujukan untuk klaim di answerText.

Representasi JSON
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ],
  "groundingScore": number,
  "groundingCheckRequired": boolean
}
Kolom
startIndex

string (int64 format)

Wajib. Indeks menunjukkan awal klaim, diukur dalam byte (Unicode UTF-8).

endIndex

string (int64 format)

Wajib. Akhir klaim, eksklusif.

sources[]

object (CitationSource)

Opsional. Sumber kutipan untuk klaim.

groundingScore

number

Skor dalam rentang [0, 1] yang menjelaskan seberapa kuat klaim tertentu didukung oleh referensi. Nilai yang lebih tinggi berarti klaim lebih didukung oleh potongan referensi.

groundingCheckRequired

boolean

Menunjukkan bahwa klaim ini memerlukan pemeriksaan perujukan. Jika sistem memutuskan bahwa klaim ini tidak memerlukan pemeriksaan perujukan/perujukan, kolom ini disetel ke salah (false). Dalam hal ini, tidak ada pemeriksaan perujukan yang dilakukan untuk klaim tersebut, sehingga groundingScore, sources tidak ditampilkan.

Referensi

Referensi.

Representasi JSON
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  },
  "structuredDocumentInfo": {
    object (StructuredDocumentInfo)
  }
  // End of list of possible types for union field content.
}
Kolom
Kolom union content. Konten hasil penelusuran. content hanya ada berupa salah satu diantara berikut:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Informasi dokumen tidak terstruktur.

chunkInfo

object (ChunkInfo)

Informasi bagian.

structuredDocumentInfo

object (StructuredDocumentInfo)

Informasi dokumen terstruktur.

UnstructuredDocumentInfo

Informasi dokumen tidak terstruktur.

Representasi JSON
{
  "document": string,
  "uri": string,
  "title": string,
  "chunkContents": [
    {
      object (ChunkContent)
    }
  ],
  "structData": {
    object
  }
}
Kolom
document

string

Nama resource dokumen.

uri

string

URI untuk dokumen.

title

string

Judul.

chunkContents[]

object (ChunkContent)

Daftar konten potongan yang dikutip yang berasal dari konten dokumen.

structData

object (Struct format)

Metadata JSON terstruktur untuk dokumen. Kolom ini diisi dari data struct dari Chunk di hasil penelusuran.

ChunkContent

Memecah konten.

Representasi JSON
{
  "content": string,
  "pageIdentifier": string,
  "blobAttachmentIndexes": [
    string
  ],
  "relevanceScore": number
}
Kolom
content

string

Mengelompokkan konten tekstual.

pageIdentifier

string

ID halaman.

blobAttachmentIndexes[]

string (int64 format)

Hanya output. Menyimpan indeks blobattachment yang ditautkan ke bagian ini.

relevanceScore

number

Relevansi potongan untuk kueri tertentu. Nilai berkisar dari 0,0 (sama sekali tidak relevan) hingga 1,0 (sangat relevan). Nilai ini hanya untuk tujuan informasi. Nilai ini dapat berubah untuk kueri dan potongan yang sama kapan saja karena pelatihan ulang model atau perubahan dalam penerapan.

ChunkInfo

Informasi bagian.

Representasi JSON
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "blobAttachmentIndexes": [
    string
  ],
  "relevanceScore": number
}
Kolom
chunk

string

Nama resource chunk.

content

string

Mengelompokkan konten tekstual.

documentMetadata

object (DocumentMetadata)

Metadata dokumen.

blobAttachmentIndexes[]

string (int64 format)

Hanya output. Menyimpan indeks blobattachment yang ditautkan ke bagian ini.

relevanceScore

number

Relevansi potongan untuk kueri tertentu. Nilai berkisar dari 0,0 (sama sekali tidak relevan) hingga 1,0 (sangat relevan). Nilai ini hanya untuk tujuan informasi. Nilai ini dapat berubah untuk kueri dan potongan yang sama kapan saja karena pelatihan ulang model atau perubahan dalam penerapan.

DocumentMetadata

Metadata dokumen.

Representasi JSON
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "structData": {
    object
  }
}
Kolom
document

string

Nama resource dokumen.

uri

string

URI untuk dokumen.

title

string

Judul.

pageIdentifier

string

ID halaman.

structData

object (Struct format)

Metadata JSON terstruktur untuk dokumen. Kolom ini diisi dari data struct dari Chunk di hasil penelusuran.

StructuredDocumentInfo

Informasi penelusuran terstruktur.

Representasi JSON
{
  "document": string,
  "structData": {
    object
  },
  "title": string,
  "uri": string
}
Kolom
document

string

Nama resource dokumen.

structData

object (Struct format)

Data penelusuran terstruktur.

title

string

Hanya output. Judul dokumen.

uri

string

Hanya output. URI dokumen.

BlobAttachment

Menyimpan data biner yang dilampirkan pada jawaban teks, misalnya gambar, video, audio, dll.

Representasi JSON
{
  "data": {
    object (Blob)
  },
  "attributionType": enum (AttributionType)
}
Kolom
data

object (Blob)

Hanya output. Jenis MIME dan data blob.

attributionType

enum (AttributionType)

Hanya output. Jenis atribusi blob.

Blob

Jenis media dan data blob.

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

string

Hanya output. Jenis media (jenis MIME) dari data yang dibuat atau diambil.

data

string (bytes format)

Hanya output. Byte mentah.

String berenkode base64.

AttributionType

Sumber blob.

Enum
ATTRIBUTION_TYPE_UNSPECIFIED Jenis atribusi tidak ditentukan.
CORPUS Data lampiran berasal dari korpus.
GENERATED Data lampiran dihasilkan oleh model melalui pembuatan kode.

Langkah

Informasi langkah.

Representasi JSON
{
  "state": enum (State),
  "description": string,
  "thought": string,
  "actions": [
    {
      object (Action)
    }
  ]
}
Kolom
state

enum (State)

Status langkah.

description

string

Deskripsi langkah.

thought

string

Pemikiran tentang langkah.

actions[]

object (Action)

Tindakan.

Negara bagian/Provinsi

Enumerasi status langkah.

Enum
STATE_UNSPECIFIED Tidak diketahui.
IN_PROGRESS Langkah sedang berlangsung.
FAILED Langkah saat ini gagal.
SUCCEEDED Langkah berhasil.

Tindakan

Tindakan.

Representasi JSON
{
  "observation": {
    object (Observation)
  },

  // Union field action can be only one of the following:
  "searchAction": {
    object (SearchAction)
  }
  // End of list of possible types for union field action.
}
Kolom
observation

object (Observation)

Pengamatan.

Kolom union action. Tindakan. action hanya ada berupa salah satu diantara berikut:
searchAction

object (SearchAction)

Tindakan penelusuran.

SearchAction

Tindakan penelusuran.

Representasi JSON
{
  "query": string
}
Kolom
query

string

Kueri yang akan ditelusuri.

Pengamatan

Pengamatan.

Representasi JSON
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Kolom
searchResults[]

object (SearchResult)

Hasil penelusuran yang diamati oleh tindakan penelusuran, dapat berupa info cuplikan atau info bagian, bergantung pada jenis kutipan yang ditetapkan oleh pengguna.

SearchResult

Representasi JSON
{
  "document": string,
  "uri": string,
  "title": string,
  "snippetInfo": [
    {
      object (SnippetInfo)
    }
  ],
  "chunkInfo": [
    {
      object (ChunkInfo)
    }
  ],
  "structData": {
    object
  }
}
Kolom
document

string

Nama resource dokumen.

uri

string

URI untuk dokumen.

title

string

Judul.

snippetInfo[]

object (SnippetInfo)

Jika citation_type adalah DOCUMENT_LEVEL_CITATION, isi cuplikan tingkat dokumen.

chunkInfo[]

object (ChunkInfo)

Jika citation_type adalah CHUNK_LEVEL_CITATION dan mode chunk aktif, isi info chunk.

structData

object (Struct format)

Representasi data. Data JSON terstruktur untuk dokumen. Bagian ini diisi dari data struct dari Dokumen, atau Chunk dalam hasil penelusuran.

SnippetInfo

Informasi cuplikan.

Representasi JSON
{
  "snippet": string,
  "snippetStatus": string
}
Kolom
snippet

string

Konten cuplikan.

snippetStatus

string

Status cuplikan yang ditentukan oleh tim penelusuran.

ChunkInfo

Informasi bagian.

Representasi JSON
{
  "chunk": string,
  "content": string,
  "relevanceScore": number
}
Kolom
chunk

string

Nama resource chunk.

content

string

Mengelompokkan konten tekstual.

relevanceScore

number

Relevansi potongan untuk kueri tertentu. Nilai berkisar dari 0,0 (sama sekali tidak relevan) hingga 1,0 (sangat relevan). Nilai ini hanya untuk tujuan informasi. Nilai ini dapat berubah untuk kueri dan potongan yang sama kapan saja karena pelatihan ulang model atau perubahan dalam penerapan.

QueryUnderstandingInfo

Informasi pemahaman kueri.

Representasi JSON
{
  "queryClassificationInfo": [
    {
      object (QueryClassificationInfo)
    }
  ]
}
Kolom
queryClassificationInfo[]

object (QueryClassificationInfo)

Informasi klasifikasi kueri.

QueryClassificationInfo

Informasi klasifikasi kueri.

Representasi JSON
{
  "type": enum (Type),
  "positive": boolean
}
Kolom
type

enum (Type)

Jenis klasifikasi kueri.

positive

boolean

Output klasifikasi.

Jenis

Jenis klasifikasi kueri.

Enum
TYPE_UNSPECIFIED Jenis klasifikasi kueri tidak ditentukan.
ADVERSARIAL_QUERY Jenis klasifikasi kueri adversarial.
NON_ANSWER_SEEKING_QUERY Jenis klasifikasi kueri yang tidak mencari jawaban, untuk percakapan santai.
JAIL_BREAKING_QUERY Jenis klasifikasi kueri pelarian dari batasan.
NON_ANSWER_SEEKING_QUERY_V2 Jenis klasifikasi kueri non-pencarian jawaban, tanpa maksud yang jelas.
USER_DEFINED_CLASSIFICATION_QUERY Jenis klasifikasi kueri yang ditentukan pengguna.

AnswerSkippedReason

Enum untuk alasan jawaban dilewati.

Enum
ANSWER_SKIPPED_REASON_UNSPECIFIED Nilai default. Alasan melewati jawaban tidak ditentukan.
ADVERSARIAL_QUERY_IGNORED Kueri adversarial mengabaikan huruf besar/kecil.
NON_ANSWER_SEEKING_QUERY_IGNORED

Kueri mencari non-jawaban mengabaikan huruf besar/kecil

Google akan melewati jawaban jika kuerinya adalah percakapan santai.

OUT_OF_DOMAIN_QUERY_IGNORED

Kueri di luar domain mengabaikan huruf besar/kecil.

Google akan melewati jawaban jika tidak ada hasil penelusuran yang sangat relevan.

POTENTIAL_POLICY_VIOLATION

Kasus potensi pelanggaran kebijakan.

Google akan melewati jawaban jika terdeteksi potensi pelanggaran kebijakan. Hal ini mencakup konten yang mungkin mengandung kekerasan atau tidak baik.

NO_RELEVANT_CONTENT

Kasus tidak ada konten yang relevan.

Google akan melewati jawaban jika tidak ada konten yang relevan dalam hasil penelusuran yang diambil.

JAIL_BREAKING_QUERY_IGNORED

Kueri pelarian dari batasan mengabaikan huruf besar/kecil.

Misalnya, "Balas dengan gaya bahasa CEO perusahaan pesaing". Google akan melewati jawaban jika kueri diklasifikasikan sebagai kueri pelarian dari batasan.

CUSTOMER_POLICY_VIOLATION

Kasus pelanggaran kebijakan pelanggan.

Google akan melewati ringkasan jika ada pelanggaran kebijakan pelanggan yang terdeteksi. Kebijakan ini ditentukan oleh pelanggan.

NON_ANSWER_SEEKING_QUERY_IGNORED_V2

Kueri yang tidak mencari jawaban mengabaikan huruf besar/kecil.

Google akan melewati jawaban jika kueri tidak memiliki maksud yang jelas.

LOW_GROUNDED_ANSWER

Kasus jawaban yang tidak berdasar.

Google akan melewati jawaban jika jawaban yang memiliki rujukan kuat tidak dapat dibuat.

USER_DEFINED_CLASSIFICATION_QUERY_IGNORED

Klasifikasi kueri yang ditentukan pengguna mengabaikan huruf besar/kecil.

Google akan melewati jawaban jika kueri diklasifikasikan sebagai klasifikasi kueri yang ditentukan pengguna.

UNHELPFUL_ANSWER

Kasus jawaban yang tidak membantu.

Google akan melewati jawaban jika jawaban tersebut tidak membantu. Hal ini dapat disebabkan oleh berbagai faktor, termasuk, tetapi tidak terbatas pada: kueri tidak dapat dijawab, jawaban tidak relevan dengan kueri, atau jawaban tidak diformat dengan baik.

SafetyRating

Rating keamanan yang sesuai dengan konten yang dihasilkan.

Representasi JSON
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "probabilityScore": number,
  "severity": enum (HarmSeverity),
  "severityScore": number,
  "blocked": boolean
}
Kolom
category

enum (HarmCategory)

Hanya output. Kategori bahaya.

probability

enum (HarmProbability)

Hanya output. Tingkat probabilitas bahaya dalam konten.

probabilityScore

number

Hanya output. Skor probabilitas bahaya.

severity

enum (HarmSeverity)

Hanya output. Tingkat keparahan bahaya dalam konten.

severityScore

number

Hanya output. Skor tingkat keparahan bahaya.

blocked

boolean

Hanya output. Menunjukkan apakah konten difilter karena rating ini.

HarmCategory

Kategori bahaya yang akan memblokir konten.

Enum
HARM_CATEGORY_UNSPECIFIED Kategori bahaya tidak ditentukan.
HARM_CATEGORY_HATE_SPEECH Kategori bahaya adalah ujaran kebencian.
HARM_CATEGORY_DANGEROUS_CONTENT Kategori bahayanya adalah konten berbahaya.
HARM_CATEGORY_HARASSMENT Kategori bahayanya adalah pelecehan.
HARM_CATEGORY_SEXUALLY_EXPLICIT Kategori bahayanya adalah konten seksual vulgar.
HARM_CATEGORY_CIVIC_INTEGRITY Kategori bahayanya adalah integritas sipil.

HarmProbability

Tingkat probabilitas bahaya dalam konten.

Enum
HARM_PROBABILITY_UNSPECIFIED Kemungkinan bahaya tidak ditentukan.
NEGLIGIBLE Tingkat bahaya yang dapat diabaikan.
LOW Tingkat bahaya rendah.
MEDIUM Tingkat bahaya sedang.
HIGH Tingkat bahaya tinggi.

HarmSeverity

Tingkat keparahan bahaya.

Enum
HARM_SEVERITY_UNSPECIFIED Tingkat keparahan bahaya tidak ditentukan.
HARM_SEVERITY_NEGLIGIBLE Tingkat keparahan bahaya yang dapat diabaikan.
HARM_SEVERITY_LOW Tingkat keparahan bahaya rendah.
HARM_SEVERITY_MEDIUM Tingkat keparahan bahaya sedang.
HARM_SEVERITY_HIGH Tingkat keparahan bahaya tinggi.

Metode

get

Mendapatkan Jawaban.