- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- ConversationReference
- DataAgentContext
- ContextVersion
יצירת מקור נתונים שמספק תשובה לשאלה על נתונים על ידי יצירת מקור נתונים של אובייקטים מסוג Message
.
בקשת HTTP
POST https://geminidataanalytics.googleapis.com/v1alpha/{parent=projects/*/locations/*}:chat
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. הערך ההורה של בקשת הצ'אט. דפוס: projects/{project}/locations/{location} |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג ב-JSON |
---|
{ "project": string, "messages": [ { object ( |
שדות | |
---|---|
project |
זה שינוי אופציונלי. הפרויקט Google Cloud שבו נעשה שימוש למכסות ולחיוב. |
messages[] |
חובה. התוכן של השיחה הנוכחית. |
שדה האיחוד context_provider . ספק ההקשר של בקשת הצ'אט. הערך יכול להיות: inline_context – הקשר שסופק בתוך הבקשה. data_agent – הפניה למשאב של סוכן נתונים. conversation_reference – הפניה לשיחה ולהקשר שנשמרו באמצעות conversation_id ו-agent_id. הערך של context_provider יכול להיות רק אחת מהאפשרויות הבאות: |
|
inlineContext |
זה שינוי אופציונלי. הקשר של בקשת הצ'אט בתוך הטקסט. אפשר להשתמש באפשרות הזו כדי להתכתב בצ'אט ללא שמירת מצב (ללא שיחה מנוהלת ומתמשכת וללא נציג תמיכה) על ידי העברת כל ההקשר בתוך השורה. |
conversationReference |
זה שינוי אופציונלי. הפניה לשיחה ולהקשר של נציג התמיכה שנשמרו. אפשר להשתמש בקישור הזה כדי לצ'אט עם נציג תמיכה באמצעות שיחה מנוהלת. |
dataAgentContext |
זה שינוי אופציונלי. ההקשר של בקשת הצ'אט. אפשר להשתמש ב-API הזה כדי להתכתב בצ'אט עם נציג תמיכה ללא שמירת מצב, בלי שמירה מנוהלת של שיחות. |
גוף התשובה
אם הפעולה מצליחה, גוף התגובה מכיל פלט של מכונות Message
.
היקפי הרשאה
נדרשת הרשאת OAuth ברמה הבאה:
https://www.googleapis.com/auth/cloud-platform
מידע נוסף זמין בAuthentication Overview.
ConversationReference
הפניה לשיחה ולהקשר של נציג התמיכה שנשמרו.
ייצוג ב-JSON |
---|
{
"conversation": string,
"dataAgentContext": {
object ( |
שדות | |
---|---|
conversation |
חובה. השם של משאב השיחה. פורמט: projects/{project}/locations/{location}/conversations/{conversationId} |
dataAgentContext |
חובה. הקשר לבקשת הצ'אט באמצעות סוכן נתונים. |
DataAgentContext
הקשר לבקשת הצ'אט באמצעות סוכן נתונים.
ייצוג ב-JSON |
---|
{ "dataAgent": string, "credentials": { object ( |
שדות | |
---|---|
dataAgent |
חובה. השם של משאב סוכן הנתונים. |
credentials |
זה שינוי אופציונלי. פרטי הכניסה שצריך להשתמש בהם בזמן הקריאה למקור הנתונים של Looker נכון לעכשיו יש תמיכה גם בפרטי כניסה שמבוססים על אסימון OAuth וגם בפרטי כניסה שמבוססים על מפתחות API, כפי שמתואר במאמר https://cloud.google.com/looker/docs/api-auth#authentication_with_an_sdk |
contextVersion |
זה שינוי אופציונלי. גרסת ההקשר שמערכת DCS תשתמש בה (למשל: STAGING, PUBLISHED) |
ContextVersion
רשימת הגרסאות של ההקשר שנתמכות ב-DCS. יש שתי גרסאות של הקשר. המטרה היא לשמור על ניהול גרסאות של סוכן הנתונים.
טיפוסים בני מנייה (enum) | |
---|---|
CONTEXT_VERSION_UNSPECIFIED |
לא צוין או לא מזוהה. |
STAGING |
בגרסה הזו, DCS ישתמש בהקשר של יצירת סביבות ייעודיות (staging) העדכני ביותר של סוכן הנתונים. |
PUBLISHED |
בגרסה הזו, DCS ישתמש בהקשר העדכני ביותר שפורסם עבור סוכן הנתונים. |