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

משאב: AssistAnswer

משאב AssistAnswer, החלק העיקרי של AssistResponse.

ייצוג JSON 
{
  "name": string,
  "state": enum (State),
  "replies": [
    {
      object (Reply)
    }
  ],
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "customerPolicyEnforcementResult": {
    object (CustomerPolicyEnforcementResult)
  }
}
שדות
name

string

אי אפשר לשנות. מזהה. שם המשאב של AssistAnswer. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}

השדה הזה חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 1,024 תווים.
state

enum (State)

הסטטוס של יצירת התשובה.
replies[]

object (Reply)

תשובות של העוזר הדיגיטלי.
assistSkippedReasons[]

enum (AssistSkippedReason)

הסיבות לכך שלא עניתם לשיחה לקבלת עזרה.
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

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

מדינה

הסטטוס של יצירת התשובה.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לא ידוע.
IN_PROGRESS הפעולה של העזרה בעיצומה.
FAILED הפעולה של העזרה נכשלה.
SUCCEEDED הפעולה של העזרה הצליחה.
SKIPPED הפעולה של העזרה בדיווח דילגה.
CANCELLED הפעולה של העזרה בוטלה (לדוגמה, הלקוח סגר את הזרם). יכול להיות שהתשובה תהיה חלקית.

כתיבת תשובה

חלק אחד מהתשובה המרובת-חלקים של שיחת העזרה.

ייצוג 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.
}
שדות
createTime

string (Timestamp format)

השעה שבה התשובה נוצרה.

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
שדה איחוד reply. אפשרויות חלופיות לתשובה של העוזר הדיגיטלי. הערך reply יכול להיות רק אחד מהבאים:
groundedContent

object (AssistantGroundedContent)

יכול להיות שהתשובה של העוזר הדיגיטלי תהיה מבוססת על טקסט או מדיה.

AssistantGroundedContent

קטע תוכן, ואולי גם מידע על ההארקה שלו.

לא כל התוכן צריך להיות מבוסס על מידע. אין צורך בהארקה של משפטים כמו "Of course, I will gladly search it for you".

ייצוג 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.
}
שדות
content

object (AssistantContent)

התוכן.
citationMetadata

object (CitationMetadata)

ציון המקור של התוכן שנוצר. אפשר גם לעיין בכתובת https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
contentMetadata

object (ContentMetadata)

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

object (TextGroundingMetadata)

מטא-נתונים להארקה על סמך מקורות טקסט.

TextGroundingMetadata

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

ייצוג JSON 
{
  "segments": [
    {
      object (Segment)
    }
  ],
  "visualSegments": [
    {
      object (VisualSegment)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ]
}
שדות
segments[]

object (Segment)

מידע על ההקשר של חלקים מהטקסט.
visualSegments[]

object (VisualSegment)

מידע על ההקשר של חלקים מהתוכן החזותי.
references[]

object (Reference)

הפניות לטקסט המבוסס.

פלח

מידע על ההארקה של פלח טקסט.

ייצוג JSON 
{
  "startIndex": string,
  "endIndex": string,
  "referenceIndices": [
    integer
  ],
  "groundingScore": number,
  "text": string
}
שדות
startIndex

string (int64 format)

אינדקס מבוסס-אפס שמציין את תחילת הפלח, שנמדד בבייטים של מחרוזת UTF-8 (כלומר, תווים שמקודדים בכמה בייטים הם באורך של יותר מאחד).
endIndex

string (int64 format)

סוף הקטע, לא כולל.
referenceIndices[]

integer

הפניות לפלח.
groundingScore

number

הציון של הפלח.
text

string

קטע הטקסט עצמו.

VisualSegment

מידע על ביסוס של פלח חזותי.

ייצוג JSON 
{
  "referenceIndices": [
    integer
  ],
  "contentId": string
}
שדות
referenceIndices[]

integer

הפניות לקטע החזותי.
contentId

string

מזהה התוכן של הקטע הוויזואלי. כדי להציג את הציטוט של הרכיב החזותי, הערך של contentId צריך להיות זהה לערך בשדה groundedContent.content_metadata.content_id.

חומרי עזר

תוכן שהמערכת נעזרה בו ומטא-נתונים קשורים של המסמך.

ייצוג JSON 
{
  "content": string,
  "codeSnippet": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
שדות
content

string

תוכן טקסט שהמערכת נעזרה בו.
codeSnippet

string

חלק מקטע קוד מהמסמך שאליו מתייחסים.
documentMetadata

object (DocumentMetadata)

מטא-נתונים של המסמך.

DocumentMetadata

מטא-נתונים של המסמך.

ייצוג JSON 
{
  "language": enum (Language),
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
שדות
language

enum (Language)
document

string

שם המשאב של המסמך.
uri

string

‫URI של המסמך. יכול להיות שהיא תכיל כתובת URL שמפנה מחדש לאתר בפועל.
title

string

שם.
pageIdentifier

string

מזהה הדף.
domain

string

שם הדומיין מ-URI המסמך. שימו לב שהשדה uri עשוי להכיל כתובת URL שמפנה לאתר בפועל. במקרה כזה, השדה יכיל את שם הדומיין של אתר היעד.
mimeType

string

סוג ה-MIME של המסמך. https://www.iana.org/assignments/media-types/media-types.xhtml.

שפה

השפה של התוכן שאליו מתייחסים. בשלב הזה, הוא משמש רק לקוד.

טיפוסים בני מנייה (enum)
LANGUAGE_UNSPECIFIED
PYTHON
SQL

AssistantContent

תוכן מולטימודאלי.

ייצוג 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.
}
שדות
role

string

יוצר התוכן. יכול להיות 'מודל' או 'משתמש'.
thought

boolean

זה שינוי אופציונלי. מציין אם החלק נוצר על ידי המודל.
שדה איחוד data. הנתונים שכלולים בו. הערך data יכול להיות רק אחד מהבאים:
text

string

טקסט מוטבע.
inlineData

object (Blob)

נתונים בינאריים מוטבעים.
file

object (File)

קובץ, למשל סיכום אודיו.
executableCode

object (ExecutableCode)

קוד שנוצר על ידי המודל ומיועד להרצה.
codeExecutionResult

object (CodeExecutionResult)

התוצאה של הרצת ExecutableCode.

Blob

‫blob בתוך השורה.

ייצוג JSON 
{
  "mimeType": string,
  "data": string
}
שדות
mimeType

string

חובה. סוג המדיה (סוג MIME) של הנתונים שנוצרו.
data

string (bytes format)

חובה. בייטים גולמיים.

מחרוזת בקידוד Base64.

קובץ

קובץ, למשל סיכום אודיו.

ייצוג JSON 
{
  "mimeType": string,
  "fileId": string
}
שדות
mimeType

string

חובה. סוג המדיה (סוג MIME) של הקובץ.
fileId

string

חובה. מזהה הקובץ.

ExecutableCode

קוד שנוצר על ידי המודל ומיועד להרצה על ידי המודל.

ייצוג JSON 
{
  "code": string
}
שדות
code

string

חובה. תוכן הקוד. בשלב הזה יש תמיכה רק ב-Python.

CodeExecutionResult

התוצאה של הרצת ExecutableCode.

ייצוג JSON 
{
  "outcome": enum (Outcome),
  "output": string
}
שדות
outcome

enum (Outcome)

חובה. התוצאה של הרצת הקוד.
output

string

זה שינוי אופציונלי. התשובה מכילה את הפלט הרגיל (stdout) אם ביצוע הקוד הצליח, או את הפלט לשגיאות (stderr) או תיאור אחר אם הביצוע נכשל.

תוצאת הסריקה

ספירה של התוצאות האפשריות של הרצת הקוד.

טיפוסים בני מנייה (enum)
OUTCOME_UNSPECIFIED הסטטוס לא צוין. אין להשתמש בערך הזה.
OUTCOME_OK ביצוע הקוד הושלם בהצלחה.
OUTCOME_FAILED ביצוע הקוד הסתיים אבל נכשל. הפרמטר stderr צריך להכיל את הסיבה.
OUTCOME_DEADLINE_EXCEEDED ההרצה של הקוד נמשכה יותר מדי זמן והיא בוטלה. יכול להיות שיוצג פלט חלקי, ויכול להיות שלא.

CitationMetadata

אוסף של שיוכים למקורות של קטע תוכן.

ייצוג JSON 
{
  "citations": [
    {
      object (Citation)
    }
  ]
}
שדות
citations[]

object (Citation)

פלט בלבד. רשימת ציטוטים.

ציטוט

שיוך מקורות לתוכן.

ייצוג JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "title": string,
  "license": string,
  "publicationDate": {
    object (Date)
  }
}
שדות
startIndex

integer

פלט בלבד. אינדקס ההתחלה בתוכן.
endIndex

integer

פלט בלבד. אינדקס הסיום של התוכן.
uri

string

פלט בלבד. הפניה לכתובת ה-URL של השיוך.
title

string

פלט בלבד. שם השיוך.
license

string

פלט בלבד. רישיון הייחוס.
publicationDate

object (Date)

פלט בלבד. תאריך הפרסום של השיוך.

ContentMetadata

מטא-נתונים של התוכן.

ייצוג JSON 
{
  "contentKind": enum (ContentKind),
  "contentId": string
}
שדות
contentKind

enum (ContentKind)

סוג התוכן. מציג את החלק בתשובה של עוזר המחקר שאליו התוכן הזה שייך.
contentId

string

המזהה של התוכן. הוא משמש לקישור בין שאלות מחקר לבין תשובות לשאלות האלה. לדוגמה, לחלקים של התשובה לשאלת מחקר יהיה אותו contentId כמו לשאלה.

ContentKind

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

טיפוסים בני מנייה (enum)
CONTENT_KIND_UNSPECIFIED לא ידוע.
RESEARCH_PLAN תוכנית מחקר.
RESEARCH_QUESTION שאלת המחקר.
RESEARCH_ANSWER תשובה מחקר.
RESEARCH_REPORT דוח מחקר.
RESEARCH_AUDIO_SUMMARY הקלטת אודיו עם סיכום של המחקר.

AssistSkippedReason

סיבות אפשריות לכך שלא עניתם לשיחת הסיוע.

טיפוסים בני מנייה (enum)
ASSIST_SKIPPED_REASON_UNSPECIFIED ערך ברירת המחדל. לא צוינה סיבה לדילוג.
NON_ASSIST_SEEKING_QUERY_IGNORED העוזר הדיגיטלי התעלם מהשאילתה, כי נראה שהיא לא נועדה לקבל תשובה.
CUSTOMER_POLICY_VIOLATION העוזר הדיגיטלי התעלם מהשאילתה או סירב לענות בגלל הפרת מדיניות הלקוחות (לדוגמה, השאילתה או התשובה הכילו ביטוי אסור).

CustomerPolicyEnforcementResult

תוצאות של אכיפת מדיניות הלקוחות. מכיל את התוצאות של בדיקות המדיניות השונות, כמו בדיקות של ביטויים אסורים או של Model Armor.

ייצוג JSON 
{
  "verdict": enum (Verdict),
  "policyResults": [
    {
      object (PolicyEnforcementResult)
    }
  ]
}
שדות
verdict

enum (Verdict)

ההחלטה הסופית לגבי אכיפת המדיניות בנושא לקוחות. אם רק מדיניות אחת חסמה את העיבוד, פסק הדין הוא חסימה.
policyResults[]

object (PolicyEnforcementResult)

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

תוצאה

ההחלטה בנוגע לאכיפת המדיניות כלפי הלקוח.

טיפוסים בני מנייה (enum)
UNSPECIFIED ערך לא ידוע.
ALLOW לא הייתה הפרת מדיניות.
BLOCK העיבוד נחסם בגלל מדיניות הלקוחות.

PolicyEnforcementResult

תוצאת אכיפת מדיניות הלקוח עבור סוג מדיניות יחיד.

ייצוג 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.
}
שדות
שדה איחוד enforcement_result. התוצאה הספציפית לסוג המדיניות. יכול להיות שזו שגיאה או מידע מפורט על תוצאת האכיפה של המדיניות. הערך enforcement_result יכול להיות רק אחד מהבאים:
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

תוצאת אכיפת המדיניות לגבי מדיניות הביטויים האסורים.
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

תוצאת האכיפה של מדיניות Model Armor.

BannedPhraseEnforcementResult

תוצאת אכיפת מדיניות הלקוחות בנושא מדיניות הביטויים האסורים.

ייצוג JSON 
{
  "bannedPhrases": [
    string
  ]
}
שדות
bannedPhrases[]

string

הביטויים האסורים שנמצאו בשאילתה או בתשובה.

ModelArmorEnforcementResult

תוצאת האכיפה של מדיניות הלקוחות בנושא הגנת המודל.

ייצוג 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.
}
שדות
שדה איחוד result. התוצאה של מדיניות Model Armor. הערך result יכול להיות רק אחד מהבאים:
modelArmorViolation

string

ההפרה של הגנת המודל שנמצאה.
error

object (Status)

השגיאה שמוחזרת על ידי Model Armor אם אכיפת המדיניות נכשלה מסיבה כלשהי.

Methods

get

 הפונקציה מחזירה AssistAnswer.