Method: projects.locations.groundingConfigs.check

מבצע בדיקת ביסוס.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
groundingConfig

string

חובה. שם המשאב של הגדרת ההארקה, למשל projects/*/locations/global/groundingConfigs/default_grounding_config.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "answerCandidate": string,
  "facts": [
    {
      object (GroundingFact)
    }
  ],
  "groundingSpec": {
    object (CheckGroundingSpec)
  },
  "userLabels": {
    string: string,
    ...
  }
}
שדות
answerCandidate

string

תשובה של מועמד לבדיקה. האורך המקסימלי הוא 4,096 טוקנים.
facts[]

object (GroundingFact)

רשימת עובדות לבדיקת ההצמדה לקרקע. אנחנו תומכים בעד 200 עובדות.
groundingSpec

object (CheckGroundingSpec)

ההגדרה של בדיקת ההצמדה.
userLabels

map (key: string, value: string)

התוויות של המשתמש שמוחלות על משאב צריכות לעמוד בדרישות הבאות:

  • אפשר להוסיף לכל משאב כמה תוויות, עד 64 לכל היותר.
  • כל תווית צריכה להיות צמד מפתח/ערך.
  • האורך המינימלי של המפתחות הוא תו אחד, והאורך המקסימלי הוא 63 תווים. המפתחות לא יכולים להיות ריקים. הערכים יכולים להיות ריקים, והאורך המקסימלי שלהם הוא 63 תווים.
  • המפתחות והערכים יכולים להכיל רק אותיות קטנות, ספרות, קווים תחתונים ומקפים. כל התווים צריכים להיות בקידוד UTF-8, ומותר להשתמש בתווים בינלאומיים.
  • החלק של המפתח בתווית חייב להיות ייחודי. עם זאת, אפשר להשתמש באותו מפתח עם כמה משאבים.
  • המפתחות צריכים להתחיל באות קטנה או בתו בינלאומי.

פרטים נוספים מופיעים במאמר מסמך Google Cloud.

גוף התשובה

הודעת התגובה לשיטה GroundedGenerationService.CheckGrounding.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "citedChunks": [
    {
      object (FactChunk)
    }
  ],
  "citedFacts": [
    {
      object (CheckGroundingFactChunk)
    }
  ],
  "claims": [
    {
      object (Claim)
    }
  ],
  "supportScore": number
}
שדות
citedChunks[]

object (FactChunk)

רשימה של עובדות שמצוטטות בכל הטענות במועמד לתשובה. התשובות האלה מבוססות על העובדות שסופקו בבקשה.
citedFacts[]

object (CheckGroundingFactChunk)

רשימה של עובדות שמצוטטות בכל הטענות במועמד לתשובה. התשובות האלה מבוססות על העובדות שסופקו בבקשה.
claims[]

object (Claim)

טקסטים של טענות ופרטי ציטוט ביבליוגרפי בכל הטענות במועמד לתשובה.
supportScore

number

ציון התמיכה של התשובה האפשרית שהוזנה. ככל שהציון גבוה יותר, כך חלק גדול יותר מהטענות נתמך על ידי העובדות שסופקו. ההגדרה הזו תמיד מוגדרת כשמוחזרת תשובה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב groundingConfig:

  • discoveryengine.groundingConfigs.check

מידע נוסף מופיע במאמרי העזרה בנושא IAM.

GroundingFact

עובדה לעיגון.

ייצוג ב-JSON 
{
  "factText": string,
  "attributes": {
    string: string,
    ...
  }
}
שדות
factText

string

תוכן הטקסט של העובדה. האורך המקסימלי הוא 10,000 תווים.
attributes

map (key: string, value: string)

מאפיינים שמשויכים לעובדה. מאפיינים נפוצים כוללים את source (שמציין מאיפה העובדה נלקחה), author (שמציין את מחבר העובדה) וכן הלאה.

CheckGroundingSpec

המפרט של בדיקת ההצמדה לקרקע.

ייצוג ב-JSON 
{
  "citationThreshold": number,
  "enableClaimLevelScore": boolean
}
שדות
citationThreshold

number

ערך הסף (בטווח [0,1]) שמשמש לקביעה אם צריך לצטט עובדה כדי לתמוך בטענה בתשובה המוצעת. בחירה בסף גבוה יותר תוביל לפחות ציטוטים אבל חזקים מאוד, ואילו בחירה בסף נמוך יותר תוביל ליותר ציטוטים אבל חלשים יותר. אם לא מגדירים את ערך הסף, ברירת המחדל היא 0.6.
enableClaimLevelScore

boolean

דגל הבקרה שמאפשר לקבל בתגובה ציון אמינות ברמת הטענה.

FactChunk

Fact Chunk.

ייצוג ב-JSON 
{
  "chunkText": string,
  "source": string,
  "index": integer,
  "sourceMetadata": {
    string: string,
    ...
  },
  "uri": string,
  "title": string,
  "domain": string
}
שדות
chunkText

string

תוכן הטקסט של נתח העובדות. האורך המקסימלי הוא 10,000 תווים.
source

string

המקור שממנו נשלף נתח העובדה הזה. אם המידע נלקח מ-GroundingFacts שסופקו בבקשה, השדה הזה יכיל את האינדקס של העובדה הספציפית שממנה נלקח החלק הזה.
index

integer

האינדקס של החלק הזה. בשלב הזה, הוא משמש רק במצב סטרימינג.
sourceMetadata

map (key: string, value: string)

מידע מפורט יותר על הפניה למקור.
uri

string

ה-URI של המקור.
title

string

הכותרת של המקור.
domain

string

הדומיין של המקור.

CheckGroundingFactChunk

קטע עובדתי לבדיקת ביסוס.

ייצוג ב-JSON 
{
  "chunkText": string
}
שדות
chunkText

string

תוכן הטקסט של נתח העובדות. האורך המקסימלי הוא 10,000 תווים.

הצהרה

טקסט ופרטי ציטוט של טענה במועמד לתשובה.

ייצוג ב-JSON 
{
  "claimText": string,
  "citationIndices": [
    integer
  ],
  "startPos": integer,
  "endPos": integer,
  "groundingCheckRequired": boolean,
  "score": number
}
שדות
claimText

string

הטקסט של הטענה במועמד לתשובה. התשובה הזו תמיד מוצגת, גם אם נמצאו ציטוטים או ציטוטים שסותרים את הטענה.
citationIndices[]

integer

רשימה של אינדקסים (בתוך citedChunks) שמציינים את הציטוטים שמשויכים לתלונה. לדוגמה, [1,3,4] פירושו שהעובדות שמופיעות ב-citedChunks[1], ב-citedChunks[3] וב-citedChunks[4] הן העובדות שציטטתם כדי לתמוך בטענה. ציטוט של עובדה מצביע על כך שהטענה נתמכת על ידי העובדה.
startPos

integer

המיקום שמציין את תחילת הטענה במועמד לתשובה, נמדד בבייטים. הערה: האורך לא נמדד בתווים, ולכן צריך להציג אותו בממשק המשתמש תוך התחשבות בכך שחלק מהתווים עשויים לתפוס יותר מבית אחד. לדוגמה, אם הטקסט של התביעה מכיל תווים שאינם ASCII, מיקומי ההתחלה והסיום משתנים כשמבצעים מדידה בתווים (תלוי בשפת התכנות) וכשמבצעים מדידה בבייטים (לא תלוי בשפת התכנות).
endPos

integer

המיקום שמציין את סוף הטענה בתשובה האפשרית, לא כולל, בבייטים. הערה: המדד הזה לא נמדד בתווים, ולכן צריך להציג אותו כפי שהוא. לדוגמה, אם הטקסט של התביעה מכיל תווים שאינם ASCII, מיקומי ההתחלה והסיום משתנים כשמבצעים מדידה בתווים (תלוי בשפת התכנות) וכשמבצעים מדידה בבייטים (לא תלוי בשפת התכנות).
groundingCheckRequired

boolean

מציין שהתלונה הזו דרשה בדיקת ביסוס. אם המערכת החליטה שלא נדרשת בדיקת שיוך או ביסוס לטענה הזו, הערך בשדה הזה יהיה false. במקרה כזה, לא בוצעה בדיקה של טענת ההצדקה, ולכן לא צריך להחזיר את citationIndices.
score

number

ציון המובהקות של הטענה במועמד לתשובה, בטווח [0, 1]. ההגדרה הזו מוגדרת רק אם CheckGroundingRequest.grounding_spec.enable_claim_level_score הוא true.