Method: projects.locations.chat

התשובה לשאלה לגבי נתונים מתקבלת באמצעות יצירה של זרם של אובייקטים מסוג Message.

בקשת HTTP

POST https://geminidataanalytics.googleapis.com/v1beta/{parent=projects/*/locations/*}:chat

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

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

פרמטרים
parent

string

חובה. ערך ההורה של בקשת צ'אט. דוגמה: projects/{project}/locations/{location}

גוף הבקשה

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

ייצוג ב-JSON 
{
  "project": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "credentials": {
    object (Credentials)
  },
  "thinkingMode": enum (ThinkingMode),
  "model": enum (Model),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "inlineContext": {
    object (Context)
  },
  "conversationReference": {
    object (ConversationReference)
  },
  "dataAgentContext": {
    object (DataAgentContext)
  },
  "clientManagedResourceContext": {
    object (ClientManagedResourceContext)
  }
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "lookerSettings": {
    object (LookerSettings)
  }
  // End of mutually exclusive fields.
}
שדות
project
(deprecated)

string

זה שינוי אופציונלי. השדה הזה הוצא משימוש. במקומו צריך להשתמש בשדה parent. פרויקט Google Cloud שישמש לצורכי מכסה וחיוב.
messages[]

object (Message)

חובה. תוכן השיחה הנוכחית.
credentials

object (Credentials)

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

אפשר להשתמש בשדה הזה כדי לספק פרטי כניסה למקורות נתונים שונים. לדוגמה, כשמתחברים ל-Looker, המערכת תומכת כרגע בפרטי כניסה שמבוססים על טוקן OAuth ועל מפתח API, כמו שמתואר במאמר בנושא אימות באמצעות SDK.
thinkingMode

enum (ThinkingMode)

זה שינוי אופציונלי. מצב החשיבה שבו משתמשים בלולאת הסוכן. אם לא מציינים ערך, ברירת המחדל היא THINKING_MODE_UNSPECIFIED.
model

enum (Model)

זה שינוי אופציונלי. המודל שבו לולאת הסוכן תשתמש כשהיא תעבד את הבקשה. ההגדרה הזו משפיעה רק כשלא מוגדר context.options.model.
ספק ההקשר לבקשה לצ'אט. הערך יכול להיות אחד מהבאים: inline_context, שהוא הקשר שמוגדר בשורה בבקשה. data_agent, שהוא הפניה למשאב של סוכן נתונים. conversation_reference, שהוא הפניה לשיחה ולהקשר שנשמרו באמצעות conversation_id ו-agent_id. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
inlineContext

object (Context)

זה שינוי אופציונלי. הקשר מוטמע לבקשת הצ'אט. אפשר להשתמש בזה כדי לשוחח בצ'אט ללא שמירת מצב (ללא שמירת שיחה מנוהלת וללא נציג) על ידי העברת כל ההקשר בתוך השורה.
conversationReference

object (ConversationReference)

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

object (DataAgentContext)

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

object (ClientManagedResourceContext)

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

object (LookerSettings)

זה שינוי אופציונלי. הגדרות ספציפיות ל-Looker.
סוף השדות שמוציאים זה את זה.

גוף התשובה

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

היקפי הרשאות

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

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

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

ConversationReference

הפניה לשיחה שנשמרה ולהקשר של הסוכן.

ייצוג ב-JSON 
{
  "conversation": string,
  "dataAgentContext": {
    object (DataAgentContext)
  }
}
שדות
conversation

string

חובה. השם של משאב השיחה. פורמט: projects/{project}/locations/{location}/conversations/{conversationId}
dataAgentContext

object (DataAgentContext)

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

DataAgentContext

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

ייצוג ב-JSON 
{
  "dataAgent": string,
  "credentials": {
    object (Credentials)
  },
  "contextVersion": enum (ContextVersion)
}
שדות
dataAgent

string

חובה. השם של משאב סוכן הנתונים.
credentials
(deprecated)

object (Credentials)

זה שינוי אופציונלי. הוצא משימוש: צריך להשתמש בפרטי הכניסה ב-ChatRequest. פרטי הכניסה שבהם צריך להשתמש כששולחים קריאה למקור הנתונים של Looker.

בשלב הזה יש תמיכה בפרטי כניסה שמבוססים על אסימון OAuth ועל מפתח API, כמו שמתואר במאמר אימות באמצעות SDK.
contextVersion

enum (ContextVersion)

זה שינוי אופציונלי. גרסת ההקשר שבה DCS ישתמש (למשל, STAGING,‏ PUBLISHED)

ContextVersion

רשימת גרסאות ההקשר שנתמכות על ידי DCS. יש שתי גרסאות של הקשר. הסיבה לכך היא לשמור על ניהול גרסאות של סוכן הנתונים.

טיפוסים בני מנייה (enum)
CONTEXT_VERSION_UNSPECIFIED לא צוין או לא מוכר.
STAGING בגרסה הזו, DCS ישתמש בהקשר העדכני ביותר של סביבת הפיתוח עבור סוכן הנתונים.
PUBLISHED בגרסה הזו, DCS ישתמש בהקשר האחרון שפורסם עבור סוכן הנתונים.

ClientManagedResourceContext

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

ייצוג ב-JSON 
{
  "inlineContext": {
    object (Context)
  },
  "conversationId": string,
  "agentId": string
}
שדות
inlineContext

object (Context)

חובה. ההקשר של הבקשה לצ'אט. אפשר להשתמש בזה כדי לשוחח בצ'אט בלי ניהול ממשקי API של GDA, ניהול שיחות וסוכנים, על ידי העברת כל ההקשר בתוך השורה.
conversationId

string

זה שינוי אופציונלי. מזהה השיחה שמנוהלת על ידי הלקוח.
agentId

string

זה שינוי אופציונלי. מזהה הסוכן בניהול הלקוח.

LookerSettings

הודעה לשמירת הגדרות מותאמות אישית ספציפיות ל-Looker.

ייצוג ב-JSON 
{
  "enableDevMode": boolean
}
שדות
enableDevMode

boolean

זה שינוי אופציונלי. האם להפעיל את מצב הפיתוח של Looker. אם הערך הוא True, הסשן של ה-API יעבור לסביבת העבודה "dev", וכך תתאפשר אינטראקציה עם שינויי LookML בהסתעפות הפיתוח של המשתמש. אם המדיניות מוגדרת כ-False או לא מוגדרת, הסשן נשאר במצב ברירת המחדל (מצב ייצור). מידע נוסף מופיע כאן: https://cloud.google.com/looker/docs/dev-mode-prod-mode.

ThinkingMode

מצב החשיבה של הסוכן.

טיפוסים בני מנייה (enum)
THINKING_MODE_UNSPECIFIED ערך ברירת המחדל. במקורות נתונים של BigQuery ו-Looker, הסוכן משתמש במודל FAST. בכל שאר מקורות הנתונים, הסוכן משתמש ב-THINKING.
FAST מצב מהיר, תשובות במהירות.
THINKING מצב חשיבה, פתרון בעיות מורכבות.

דגם

בחירת מודל לסוכן למשתמשי BigQuery.

טיפוסים בני מנייה (enum)
MODEL_UNSPECIFIED לא צוין מודל. אפשר להשתמש במודל בגרסת טרום-השקה או במודל בגרסה רגילה.
LATEST_GA_MODEL שימוש במודל העדכני ביותר שאינו בגרסת טרום-השקה. יכול להיות שההגדרה הזו תגביל הגדרות מסוימות ברמת הבקשה.