Method: projects.locations.dataStores.conversations.converse

מנהל שיחה.

בקשת HTTP


POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/dataStores/*/conversations/*}:converse

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

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

פרמטרים
name

string

חובה. שם המשאב של השיחה שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/{conversationId} משתמשים ב-projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/- כדי להפעיל את מצב הסשן האוטומטי, שיוצר באופן אוטומטי שיחה חדשה בתוך סשן conversations.converse.

גוף הבקשה

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

ייצוג ב-JSON 
{
  "query": {
    object (TextInput)
  },
  "servingConfig": string,
  "conversation": {
    object (Conversation)
  },
  "safeSearch": boolean,
  "userLabels": {
    string: string,
    ...
  },
  "summarySpec": {
    object (SummarySpec)
  },
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  }
}
שדות
query

object (TextInput)

חובה. קלט מהמשתמש הנוכחי.
servingConfig

string

שם המשאב של הגדרת התצורה להצגת מודעות שבה רוצים להשתמש. פורמט: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/servingConfigs/{servingConfigId} אם לא מגדירים את המדיניות, המערכת תשתמש בהגדרת ברירת המחדל להצגת מודעות.
conversation

object (Conversation)

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

map (key: string, value: string)

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

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

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

object (SummarySpec)

מפרט להגדרת הסיכום שמוחזר בתשובה.
filter

string

תחביר המסנן מורכב משפת ביטויים לבניית פרדיקט משדה אחד או יותר של המסמכים שמסוננים. ביטוי המסנן תלוי אותיות רישיות (case-sensitive). המידע הזה ישמש לסינון תוצאות החיפוש, ויכול להיות שהוא ישפיע על סיכום התשובה.

אם השדה הזה לא מזוהה, מוחזרת שגיאה INVALID_ARGUMENT.

סינון בחיפוש מבוסס-Vertex AI מתבצע על ידי מיפוי של מפתח הסינון בצד שמאל למאפיין מפתח שמוגדר ב-backend של חיפוש מבוסס-Vertex AI – הלקוח מגדיר את המיפוי הזה בסכימה שלו. לדוגמה, ללקוח בתחום המדיה יכול להיות שדה בשם 'name' בסכימה שלו. במקרה הזה, המסנן ייראה כך: filter --> name:'ANY("king kong")'

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

object (BoostSpec)

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

גוף התשובה

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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 הבאה במשאב name:

  • discoveryengine.conversations.converse

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