REST Resource: projects.locations.dataAgents

משאב: DataAgent

הודעה שמתארת אובייקט DataAgent.

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,

  // Union field type can be only one of the following:
  "dataAnalyticsAgent": {
    object (DataAnalyticsAgent)
  }
  // End of list of possible types for union field type.
}
שדות
name

string

זה שינוי אופציונלי. מזהה. שם המשאב הייחודי של סוכן. פורמט: ‎"projects/{project}/locations/{location}/dataAgents/{dataAgentId}"‎. {dataAgent} הוא מזהה המשאב, והוא צריך להיות באורך של 63 תווים לכל היותר, ותואמת לפורמט שמתואר בכתובת https://google.aip.dev/122#resource-id-segments

דוגמה: ‎"projects/1234567890/locations/us-central1/dataAgents/my-agent"‎
displayName

string

זה שינוי אופציונלי. שם מוצג ידידותי למשתמש.

  • השם צריך להכיל בין 1 ל-256 תווים.
description

string

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

  • אורך השם צריך להיות בין 1 ל-1,024 תווים.
labels

map (key: string, value: string)

זה שינוי אופציונלי. תוויות שיעזרו למשתמשים לסנן סוכני תמיכה קשורים. לדוגמה, 'מכירות', 'עסק', 'etl' וכו'. הערה: תוויות משמשות רק לסינון ולא למדיניות. סקירה כללית על תוויות

אובייקט שמכיל רשימה של זוגות "key": value. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

פלט בלבד. השעה שבה נוצר סוכן הנתונים.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

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

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
dataAnalyticsAgent

object (DataAnalyticsAgent)

סוכן לניתוח נתונים.

DataAnalyticsAgent

הודעה שמתארת אובייקט DataAnalyticsAgent.

ייצוג ב-JSON 
{
  "stagingContext": {
    object (Context)
  },
  "publishedContext": {
    object (Context)
  }
}
שדות
stagingContext

object (Context)

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

object (Context)

זה שינוי אופציונלי. ההקשר שפורסם לנציג. המערכת של Chat API משתמשת בהקשר הזה בסביבת הייצור.

הקשר

אוסף של הקשר שחלים על השיחה הזו

ייצוג ב-JSON 
{
  "systemInstruction": string,
  "datasourceReferences": {
    object (DatasourceReferences)
  },
  "options": {
    object (ConversationOptions)
  }
}
שדות
systemInstruction

string

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

object (DatasourceReferences)

חובה. מקורות הנתונים שזמינים כדי לענות על השאלה.
options

object (ConversationOptions)

זה שינוי אופציונלי. אפשרויות נוספות לשיחה.

DatasourceReferences

אוסף של הפניות למקורות נתונים.

ייצוג ב-JSON 
{

  // Union field references can be only one of the following:
  "bq": {
    object (BigQueryTableReferences)
  },
  "studio": {
    object (StudioDatasourceReferences)
  },
  "looker": {
    object (LookerExploreReferences)
  }
  // End of list of possible types for union field references.
}
שדות
שדה האיחוד references. מקורות הנתונים שבהם רוצים להשתמש. הערך של references יכול להיות רק אחת מהאפשרויות הבאות:
bq

object (BigQueryTableReferences)

הפניות לטבלאות BigQuery.
studio

object (StudioDatasourceReferences)

הפניות למקורות הנתונים של Looker Studio.
looker

object (LookerExploreReferences)

הפניות לאפשרויות נוספות ב-Looker.

BigQueryTableReferences

הודעה שמייצגת הפניות לטבלאות BigQuery.

ייצוג ב-JSON 
{
  "tableReferences": [
    {
      object (BigQueryTableReference)
    }
  ]
}
שדות
tableReferences[]

object (BigQueryTableReference)

חובה. הפניות לטבלאות BigQuery.

BigQueryTableReference

הודעה שמייצגת הפניה לטבלה אחת ב-BigQuery.

ייצוג ב-JSON 
{
  "projectId": string,
  "datasetId": string,
  "tableId": string
}
שדות
projectId

string

חובה. הפרויקט שאליו שייכת הטבלה.
datasetId

string

חובה. מערך הנתונים שאליו שייכת הטבלה.
tableId

string

חובה. מזהה הטבלה.

StudioDatasourceReferences

הודעה שמייצגת הפניות למקורות נתונים של Looker Studio.

ייצוג ב-JSON 
{
  "studioReferences": [
    {
      object (StudioDatasourceReference)
    }
  ]
}
שדות
studioReferences[]

object (StudioDatasourceReference)

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

StudioDatasourceReference

הודעה שמייצגת הפניה למקור נתונים יחיד ב-Looker Studio.

ייצוג ב-JSON 
{
  "datasourceId": string
}
שדות
datasourceId

string

חובה. המזהה של מקור הנתונים.

LookerExploreReferences

הודעה שמייצגת הפניות לכלי הניתוחים של Looker.

ייצוג ב-JSON 
{
  "exploreReferences": [
    {
      object (LookerExploreReference)
    }
  ],
  "credentials": {
    object (Credentials)
  }
}
שדות
exploreReferences[]

object (LookerExploreReference)

חובה. הפניות לאפשרויות נוספות ב-Looker.
credentials

object (Credentials)

זה שינוי אופציונלי. פרטי הכניסה שישמשו בקריאה ל-Looker API.

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

LookerExploreReference

הודעה שמייצגת הפניה ל-Looker Explore יחיד.

ייצוג ב-JSON 
{
  "lookmlModel": string,
  "explore": string,
  "schema": {
    object (Schema)
  },

  // Union field instance can be only one of the following:
  "lookerInstanceUri": string,
  "privateLookerInstanceInfo": {
    object (PrivateLookerInstanceInfo)
  }
  // End of list of possible types for union field instance.
}
שדות
lookmlModel

string

חובה. השם של מודל ה-LookML, כפי שמתואר בקטע מבנים עיקריים של LookML.
explore

string

חובה. השם של האפשרויות הנוספות ב-Looker, כפי שמתואר בקטע המבנים העיקריים של LookML.
schema

object (Schema)

זה שינוי אופציונלי. הסכימה של מקור הנתונים.
שדה האיחוד instance. המכונה של Looker Explore. הערך של instance יכול להיות רק אחת מהאפשרויות הבאות:
lookerInstanceUri

string

חובה. כתובת ה-URL הבסיסית של המכונה של Looker.
privateLookerInstanceInfo

object (PrivateLookerInstanceInfo)

פרטים פרטיים של מכונה ב-Looker.

PrivateLookerInstanceInfo

הודעה שמייצגת פרטים של מכונה פרטית של Looker, שנדרשים אם המכונה של Looker נמצאת מאחורי רשת פרטית.

ייצוג ב-JSON 
{
  "lookerInstanceId": string,
  "serviceDirectoryName": string
}
שדות
lookerInstanceId

string

מזהה המכונה ב-Looker.
serviceDirectoryName

string

שם ספריית השירות של מכונה של Looker.

סכימה

הסכימה של מופע של Datasource או QueryResult.

ייצוג ב-JSON 
{
  "fields": [
    {
      object (Field)
    }
  ]
}
שדות
fields[]

object (Field)

פלט בלבד. השדות בסכימה.

שדה

שדה בסכימה.

ייצוג ב-JSON 
{
  "name": string,
  "type": string,
  "description": string,
  "mode": string,
  "displayName": string,
  "subfields": [
    {
      object (Field)
    }
  ]
}
שדות
name

string

פלט בלבד. שם השדה.
type

string

פלט בלבד. סוג השדה.
description

string

פלט בלבד. תיאור קצר של השדה.
mode

string

פלט בלבד. המצב של השדה (למשל, NULLABLE, REPEATED).
displayName

string

זה שינוי אופציונלי. displayName של השדה (זהה לתווית ב-
subfields[]

object (Field)

זה שינוי אופציונלי. מאפיין רספונסיבי למבנים של סכימות בתצוגת עץ.

פרטי כניסה

מייצג צורות שונות של הגדרת פרטי כניסה.

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "oauth": {
    object (OAuthCredentials)
  }
  // End of list of possible types for union field kind.
}
שדות
oauth

object (OAuthCredentials)

פרטי כניסה ל-OAuth.

OAuthCredentials

מייצג פרטי כניסה של OAuth.

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "secret": {
    object (SecretBased)
  },
  "token": {
    object (TokenBased)
  }
  // End of list of possible types for union field kind.
}
שדות
שדה האיחוד kind. הסוג של פרטי הכניסה ל-OAuth. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות:
secret

object (SecretBased)

פרטי כניסה ב-OAuth שמבוססים על סוד.
token

object (TokenBased)

פרטי כניסה של OAuth שמבוססים על אסימונים.

SecretBased

השם של הסוד שמכיל את אסימון הגישה. מייצג פרטי כניסה של OAuth שמבוססים על סוד.

ייצוג ב-JSON 
{
  "clientId": string,
  "clientSecret": string
}
שדות
clientId

string

חובה. מזהה לקוח ב-OAuth.
clientSecret

string

חובה. סוד לקוח OAuth.

TokenBased

מידע נוסף על אסימוני הגישה של Looker זמין במאמר אימות API של Looker.

ייצוג ב-JSON 
{
  "accessToken": string
}
שדות
accessToken

string

חובה. השם של הסוד שמכיל את אסימון הגישה.

ConversationOptions

אפשרויות לשיחה.

ייצוג ב-JSON 
{
  "chart": {
    object (ChartOptions)
  },
  "analysis": {
    object (AnalysisOptions)
  }
}
שדות
chart

object (ChartOptions)

זה שינוי אופציונלי. אפשרויות ליצירת תרשימים.
analysis

object (AnalysisOptions)

זה שינוי אופציונלי. אפשרויות לניתוח.

ChartOptions

אפשרויות ליצירת תרשימים.

ייצוג ב-JSON 
{
  "image": {
    object (ImageOptions)
  }
}
שדות
image

object (ImageOptions)

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

ImageOptions

אפשרויות לעיבוד תמונות של תרשימים שנוצרו.

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "noImage": {
    object (NoImage)
  },
  "svg": {
    object (SvgOptions)
  }
  // End of list of possible types for union field kind.
}
שדות
שדה האיחוד kind. סוג התמונה לעיבוד. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות:
noImage

object (NoImage)

אין תמונה.
svg

object (SvgOptions)

פורמט SVG.

NoImage

אין שדות לסוג הזה.

אין תמונה.

SvgOptions

אין שדות לסוג הזה.

אפשרויות SVG.

AnalysisOptions

אפשרויות לניתוח.

ייצוג ב-JSON 
{
  "python": {
    object (Python)
  }
}
שדות
python

object (Python)

זה שינוי אופציונלי. אפשרויות לניתוח ב-Python.

Python

אפשרויות לניתוח ב-Python.

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

boolean

זה שינוי אופציונלי. האם להפעיל ניתוח ב-Python. ברירת המחדל היא false.

שיטות

create

 יצירת סוכן נתונים חדש בפרויקט ובמיקום נתונים נתונים.

delete

 מחיקה של סוכן נתונים יחיד.

get

 אחזור פרטים של סוכן נתונים יחיד.

list

 הצגת רשימה של DataAgents בפרויקט ובמיקום נתונים.

patch

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