REST Resource: projects.locations.collections.dataStores.conversations

משאב: שיחה

הגדרת פרוטו של שיחה חיצונית.

ייצוג JSON 
{
  "name": string,
  "state": enum (State),
  "userPseudoId": string,
  "messages": [
    {
      object (ConversationMessage)
    }
  ],
  "startTime": string,
  "endTime": string
}
שדות
name

string

אי אפשר לשנות. שם מוגדר במלואו projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/* או projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*.
state

enum (State)

הסטטוס של השיחה.
userPseudoId

string

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

object (ConversationMessage)

הודעות בשיחה.
startTime

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

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

מדינה

רשימה של מצב השיחה.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לא ידוע.
IN_PROGRESS השיחה פתוחה כרגע.
COMPLETED השיחה הסתיימה.

ConversationMessage

מגדיר הודעה בשיחה.

ייצוג JSON 
{
  "createTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userInput": {
    object (TextInput)
  },
  "reply": {
    object (Reply)
  }
  // End of mutually exclusive fields.
}
שדות
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".
בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה:
userInput

object (TextInput)

קלט טקסט של המשתמש.
reply

object (Reply)

חיפוש התשובה.
סוף השדות הבלעדיים.

TextInput

הגדרה של קלט טקסט.

ייצוג JSON 
{
  "input": string,
  "context": {
    object (ConversationContext)
  }
}
שדות
input

string

קלט טקסט.
context

object (ConversationContext)

ההקשר של הקלט בשיחה.

ConversationContext

הגדרת ההקשר של השיחה

ייצוג JSON 
{
  "contextDocuments": [
    string
  ],
  "activeDocument": string
}
שדות
contextDocuments[]

string

הרשימה הנוכחית של המסמכים שהמשתמש רואה. הוא מכיל הפניות למקורות מידע של המסמך.
activeDocument

string

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

כתיבת תשובה

הגדרת הודעת תשובה למשתמש.

ייצוג JSON 
{
  "reply": string,
  "references": [
    {
      object (Reference)
    }
  ],
  "summary": {
    object (Summary)
  }
}
שדות
reply
(deprecated)

string

הפונקציה הזו יצאה משימוש. במקומה צריך להשתמש ב-summary. תשובה בהודעת טקסט.
references[]
(deprecated)

object (Reference)

הפניות בתשובה.
summary

object (Summary)

סיכום שמבוסס על תוצאות החיפוש.

חומרי עזר

הגדרת הפניה בתשובה.

ייצוג JSON 
{
  "uri": string,
  "anchorText": string,
  "start": integer,
  "end": integer
}
שדות
uri

string

הפניה לקישור URI.
anchorText

string

טקסט מקושר.
start

integer

אינדקס ההתחלה של הטקסט המקושר.
end

integer

אינדקס הסיום של הטקסט המקושר.

סיכום

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

ייצוג JSON 
{
  "summaryText": string,
  "summarySkippedReasons": [
    enum (SummarySkippedReason)
  ],
  "safetyAttributes": {
    object (SafetyAttributes)
  },
  "summaryWithMetadata": {
    object (SummaryWithMetadata)
  }
}
שדות
summaryText

string

תוכן הסיכום.
summarySkippedReasons[]

enum (SummarySkippedReason)

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

object (SafetyAttributes)

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

object (SummaryWithMetadata)

סיכום עם פרטי מטא-נתונים.

SummarySkippedReason

‫Enum של סיבות לדילוג על סיכום.

טיפוסים בני מנייה (enum)
SUMMARY_SKIPPED_REASON_UNSPECIFIED ערך ברירת המחדל. לא צוינה סיבה לדילוג על הסיכום.
ADVERSARIAL_QUERY_IGNORED

השאילתה התוקפנית התעלמה מאותיות רישיות.

בשימוש רק כשמאפיין SummarySpec.ignore_adversarial_query מוגדר לערך true.
NON_SUMMARY_SEEKING_QUERY_IGNORED

השאילתה שלא מחפשת סיכום התעלמה מהרישיות.

אם השאילתה היא שיחה חופשית, Google מדלגת על הסיכום. בשימוש רק כשמאפיין SummarySpec.ignore_non_summary_seeking_query מוגדר לערך true.
OUT_OF_DOMAIN_QUERY_IGNORED

השאילתה מחוץ לדומיין התעלמה מהרישיות.

אם אין תוצאות חיפוש עם רלוונטיות גבוהה, Google מדלגת על הסיכום. לדוגמה, מאגר הנתונים מכיל עובדות על חברה א', אבל בשאילתת המשתמש מופיעות שאלות על חברה ב'.
POTENTIAL_POLICY_VIOLATION

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

אם המערכת מזהה הפרה פוטנציאלית של המדיניות, Google מדלגת על הסיכום. האיסור הזה כולל תוכן אלים או רעיל.
LLM_ADDON_NOT_ENABLED

המקרה שבו התוסף של מודל שפה גדול לא מופעל.

אם התוסף של מודל שפה גדול לא מופעל, Google מדלגת על הסיכום.
NO_RELEVANT_CONTENT

המקרה שבו אין תוכן רלוונטי.

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

השאילתה לפריצת ההגנה התעלמה מאותיות רישיות.

לדוגמה, "תענה לי כאילו אתה מנכ"ל של חברה מתחרה". בשימוש רק כשהערך של [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] הוא true.
CUSTOMER_POLICY_VIOLATION

המקרה של הפרת מדיניות הלקוח.

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

השאילתה שלא מחפשת תשובה התעלמה מהרישיות.

אם לשאילתה אין כוונה ברורה, Google מדלגת על הסיכום. בשימוש רק כש[SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] מוגדר ל-true.
TIME_OUT

הזמן הקצוב לתגובה.

אם הזמן הקצוב לתקציר יסתיים, Google לא תספק אותו.

SafetyAttributes

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

ייצוג JSON 
{
  "categories": [
    string
  ],
  "scores": [
    number
  ]
}
שדות
categories[]

string

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

number

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

SummaryWithMetadata

סיכום עם פרטי מטא-נתונים.

ייצוג JSON 
{
  "summary": string,
  "citationMetadata": {
    object (CitationMetadata)
  },
  "references": [
    {
      object (Reference)
    }
  ],
  "blobAttachments": [
    {
      object (BlobAttachment)
    }
  ]
}
שדות
summary

string

טקסט סיכום ללא פרטי ציטוט.
citationMetadata

object (CitationMetadata)

מטא-נתונים של ציטוט ביבליוגרפי לסיכום נתון.
references[]

object (Reference)

הפניות למסמכים.
blobAttachments[]

object (BlobAttachment)

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

CitationMetadata

מטא-נתונים של ציטוט ביבליוגרפי.

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

object (Citation)

ציטוטים של פלחים.

ציטוט

פרטי ציטוט של פלח.

ייצוג JSON 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
שדות
startIndex

string (int64 format)

האינדקס מציין את תחילת הפלח, שנמדד בבייטים או ב-Unicode.
endIndex

string (int64 format)

סיום הקטע המשויך, לא כולל.
sources[]

object (CitationSource)

מקורות הציטוטים של הפלח המשויך.

CitationSource

מקור הציטוט.

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

string (int64 format)

אינדקס של מסמכי העזר מתוך SummaryWithMetadata.references. האינדקס מתחיל מ-0, והערך יהיה אפס אם לא מוגדר referenceIndex באופן מפורש.

חומרי עזר

הפניה למסמך.

ייצוג JSON 
{
  "title": string,
  "document": string,
  "uri": string,
  "chunkContents": [
    {
      object (ChunkContent)
    }
  ]
}
שדות
title

string

שם המסמך.
document

string

חובה. Document.name של המסמך. השם המלא של המשאב של המסמך שאליו מתייחסים, בפורמט projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.
uri

string

כתובת URI של HTTP או Cloud Storage למסמך.
chunkContents[]

object (ChunkContent)

רשימה של תכני מקטעים מצוטטים שנגזרים מתוכן המסמך.

ChunkContent

חלוקת התוכן לחלקים.

ייצוג JSON 
{
  "content": string,
  "pageIdentifier": string,
  "blobAttachmentIndexes": [
    string
  ]
}
שדות
content

string

חלוקת תוכן טקסט לחלקים.
pageIdentifier

string

מזהה הדף.
blobAttachmentIndexes[]

string (int64 format)

פלט בלבד. מאחסן אינדקסים של blobattachments שמקושרים לחלק הזה.

BlobAttachment

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

ייצוג JSON 
{
  "data": {
    object (Blob)
  },
  "attributionType": enum (AttributionType)
}
שדות
data

object (Blob)

פלט בלבד. נתוני ה-blob.
attributionType

enum (AttributionType)

פלט בלבד. סוג השיוך של ה-blob.

Blob

מאחסן את הסוג והנתונים של ה-blob.

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

string

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

string (bytes format)

פלט בלבד. בייטים גולמיים.

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

AttributionType

הגדרה של סוג השיוך של ה-blob.

טיפוסים בני מנייה (enum)
ATTRIBUTION_TYPE_UNSPECIFIED סוג השיוך לא צוין.
CORPUS נתוני הקובץ המצורף מגיעים מהמאגר.
GENERATED נתוני הקובץ המצורף נוצרים על ידי המודל באמצעות יצירת קוד.

Methods

converse

 מנהל שיחה.

create

 יצירת שיחה.

delete

 מחיקת שיחה.

get

 קבלת שיחה.

list

 רשימה של כל השיחות לפי ההורה שלהן DataStore.

patch

 עדכון של שיחה.