Method: projects.locations.groundingConfigs.check

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

בקשת HTTP


POST https://discoveryengine.googleapis.com/v1alpha/{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 Document.

גוף התשובה

הודעת תגובה לשיטה 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
  • https://www.googleapis.com/auth/discoveryengine.serving.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.