Method: projects.locations.groundingConfigs.check

Melakukan pemeriksaan grounding.

Permintaan HTTP

POST https://discoveryengine.googleapis.com/v1beta/{groundingConfig=projects/*/locations/*/groundingConfigs/*}:check

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
groundingConfig

string

Wajib. Nama resource konfigurasi perujukan, seperti projects/*/locations/global/groundingConfigs/default_grounding_config.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "answerCandidate": string,
  "facts": [
    {
      object (GroundingFact)
    }
  ],
  "groundingSpec": {
    object (CheckGroundingSpec)
  },
  "userLabels": {
    string: string,
    ...
  }
}
Kolom
answerCandidate

string

Jawaban kandidat yang akan diperiksa. Panjang maksimumnya adalah 4096 token.
facts[]

object (GroundingFact)

Daftar fakta untuk pemeriksaan perujukan. Kami mendukung hingga 200 fakta.
groundingSpec

object (CheckGroundingSpec)

Konfigurasi pemeriksaan perujukan.
userLabels

map (key: string, value: string)

Label pengguna yang diterapkan ke resource harus memenuhi persyaratan berikut:

  • Setiap resource dapat memiliki beberapa label, hingga maksimum 64 label.
  • Setiap label harus berupa pasangan nilai kunci.
  • Kunci memiliki panjang minimum 1 karakter dan panjang maksimum 63 karakter, serta tidak boleh kosong. Nilai boleh kosong dan memiliki panjang maksimum 63 karakter.
  • Kunci dan nilai hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung. Semua karakter harus menggunakan encoding UTF-8, dan karakter internasional boleh digunakan.
  • Bagian kunci label harus unik. Namun, Anda dapat menggunakan kunci yang sama dengan beberapa resource.
  • Kunci harus diawali dengan huruf kecil atau karakter internasional.

Lihat Dokumen Google Cloud untuk mengetahui detail selengkapnya.

Isi respons

Pesan respons untuk metode GroundedGenerationService.CheckGrounding.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "citedChunks": [
    {
      object (FactChunk)
    }
  ],
  "citedFacts": [
    {
      object (CheckGroundingFactChunk)
    }
  ],
  "claims": [
    {
      object (Claim)
    }
  ],
  "supportScore": number
}
Kolom
citedChunks[]

object (FactChunk)

Daftar fakta yang dikutip di semua klaim dalam kandidat jawaban. Jawaban ini berasal dari fakta yang diberikan dalam permintaan.
citedFacts[]

object (CheckGroundingFactChunk)

Daftar fakta yang dikutip di semua klaim dalam kandidat jawaban. Jawaban ini berasal dari fakta yang diberikan dalam permintaan.
claims[]

object (Claim)

Teks klaim dan info kutipan di semua klaim dalam kandidat jawaban.
supportScore

number

Skor dukungan untuk kandidat jawaban input. Makin tinggi skornya, makin tinggi pula fraksi klaim yang didukung oleh fakta yang diberikan. Ini selalu disetel saat respons ditampilkan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource groundingConfig:

  • discoveryengine.groundingConfigs.check

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

GroundingFact

Menemukan Fakta.

Representasi JSON 
{
  "factText": string,
  "attributes": {
    string: string,
    ...
  }
}
Kolom
factText

string

Konten teks fakta. Panjang maksimal 10 ribu karakter.
attributes

map (key: string, value: string)

Atribut yang terkait dengan fakta. Atribut umum mencakup source (yang menunjukkan sumber fakta), author (yang menunjukkan penulis fakta), dan sebagainya.

CheckGroundingSpec

Spesifikasi untuk pemeriksaan perujukan.

Representasi JSON 
{
  "citationThreshold": number,
  "enableClaimLevelScore": boolean
}
Kolom
citationThreshold

number

Ambang batas (dalam [0,1]) yang digunakan untuk menentukan apakah suatu fakta harus dikutip untuk klaim dalam kandidat jawaban. Memilih nilai minimum yang lebih tinggi akan menghasilkan lebih sedikit kutipan, tetapi sangat kuat, sementara memilih nilai minimum yang lebih rendah dapat menghasilkan lebih banyak kutipan, tetapi agak lemah. Jika tidak disetel, nilai minimum defaultnya adalah 0,6.
enableClaimLevelScore

boolean

Flag kontrol yang mengaktifkan skor perujukan tingkat klaim dalam respons.

FactChunk

Chunk Fakta.

Representasi JSON 
{
  "chunkText": string,
  "source": string,
  "index": integer,
  "sourceMetadata": {
    string: string,
    ...
  },
  "uri": string,
  "title": string,
  "domain": string
}
Kolom
chunkText

string

Konten teks dari bagian fakta. Panjang maksimal 10 ribu karakter.
source

string

Sumber tempat potongan fakta ini diambil. Jika diambil dari GroundingFacts yang disediakan dalam permintaan, kolom ini akan berisi indeks fakta spesifik tempat potongan ini diambil.
index

integer

Indeks potongan ini. Saat ini hanya digunakan untuk mode streaming.
sourceMetadata

map (key: string, value: string)

Informasi yang lebih terperinci untuk referensi sumber.
uri

string

URI sumber.
title

string

Judul sumber.
domain

string

Domain sumber.

CheckGroundingFactChunk

Potongan fakta untuk pemeriksaan perujukan.

Representasi JSON 
{
  "chunkText": string
}
Kolom
chunkText

string

Konten teks dari bagian fakta. Panjang maksimal 10 ribu karakter.

Klaim

Info teks dan kutipan untuk klaim dalam kandidat jawaban.

Representasi JSON 
{
  "claimText": string,
  "citationIndices": [
    integer
  ],
  "startPos": integer,
  "endPos": integer,
  "groundingCheckRequired": boolean,
  "score": number
}
Kolom
claimText

string

Teks untuk klaim dalam kandidat jawaban. Selalu disediakan, terlepas dari apakah kutipan atau anti-kutipan ditemukan.
citationIndices[]

integer

Daftar indeks (ke dalam 'citedChunks') yang menentukan kutipan yang terkait dengan klaim. Misalnya, [1,3,4] berarti citedChunks[1], citedChunks[3], citedChunks[4] adalah fakta yang dikutip untuk mendukung klaim. Kutipan fakta menunjukkan bahwa klaim didukung oleh fakta tersebut.
startPos

integer

Posisi yang menunjukkan awal klaim dalam kandidat jawaban, diukur dalam byte. Perhatikan bahwa hal ini tidak diukur dalam karakter dan, oleh karena itu, harus dirender di antarmuka pengguna dengan mengingat bahwa beberapa karakter mungkin memerlukan lebih dari satu byte. Misalnya, jika teks klaim berisi karakter non-ASCII, posisi awal dan akhir akan bervariasi jika diukur dalam karakter (bergantung pada bahasa pemrograman) dan jika diukur dalam byte (tidak bergantung pada bahasa pemrograman).
endPos

integer

Posisi yang menunjukkan akhir klaim dalam kandidat jawaban, eksklusif, dalam byte. Perhatikan bahwa hal ini tidak diukur dalam karakter dan, oleh karena itu, harus dirender seperti itu. Misalnya, jika teks klaim berisi karakter non-ASCII, posisi awal dan akhir akan bervariasi jika diukur dalam karakter (bergantung pada bahasa pemrograman) dan jika diukur dalam byte (tidak bergantung pada bahasa pemrograman).
groundingCheckRequired

boolean

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

number

Skor keyakinan untuk klaim dalam kandidat jawaban, dalam rentang [0, 1]. Ini hanya disetel jika CheckGroundingRequest.grounding_spec.enable_claim_level_score benar (true).