Method: projects.locations.chat

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

בקשת HTTP

POST https://geminidataanalytics.googleapis.com/v1alpha/{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),

  // Union field context_provider can be only one of the following:
  "inlineContext": {
    object (Context)
  },
  "conversationReference": {
    object (ConversationReference)
  },
  "dataAgentContext": {
    object (DataAgentContext)
  },
  "clientManagedResourceContext": {
    object (ClientManagedResourceContext)
  }
  // End of list of possible types for union field context_provider.

  // Union field datasource_settings can be only one of the following:
  "lookerSettings": {
    object (LookerSettings)
  }
  // End of list of possible types for union field datasource_settings.
}
שדות
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 לא מוגדרת.
שדה איחוד context_provider. ספק ההקשר לבקשת הצ'אט. הערך יכול להיות אחד מהבאים: inline_context, שהוא הקשר שמופיע בשורה בבקשה. data_agent, שהוא הפניה למשאב של סוכן נתונים. conversation_reference, שהוא הפניה לשיחה ולהקשר שנשמרו באמצעות conversation_id ו-agent_id. הערך context_provider יכול להיות רק אחד מהבאים:
inlineContext

object (Context)

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

object (ConversationReference)

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

object (DataAgentContext)

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

object (ClientManagedResourceContext)

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

object (LookerSettings)

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

גוף התשובה

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

ניתן למצוא מידע נוסף כאן: 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)

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

string

זה שינוי אופציונלי. מזהה השיחה בניהול הלקוח.
agentId

string

זה שינוי אופציונלי. מזהה הנציג בניהול הלקוח.

LookerSettings

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

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

boolean

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

ThinkingMode

אופן החשיבה של הסוכן.

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

דגם

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

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