REST Resource: brands.agents.integrations

משאב: שילוב

מידע על השילוב.

ייצוג JSON 
{
  "name": string,
  "status": enum (IntegrationStatus),

  // Union field integration_info can be only one of the following:
  "dialogflowEsIntegration": {
    object (DialogflowEsIntegration)
  },
  "dialogflowCxIntegration": {
    object (DialogflowCxIntegration)
  }
  // End of list of possible types for union field integration_info.
}
שדות
name

string

פלט בלבד. המזהה הייחודי של השילוב. קריאה בלבד. מוגדר על ידי הפלטפורמה.
status

enum (IntegrationStatus)

פלט בלבד. סטטוס השילוב.
שדה איחוד integration_info. מידע מפורט על השילוב. הערך של integration_info יכול להיות רק אחת מהאפשרויות הבאות:
dialogflowEsIntegration

object (DialogflowEsIntegration)

מידע על פרויקט משויך ב-Dialogflow ES. https://cloud.google.com/dialogflow/es/docs
dialogflowCxIntegration

object (DialogflowCxIntegration)

מידע על פרויקט Dialogflow CX משויך. https://cloud.google.com/dialogflow/cx/docs/basics

IntegrationStatus

סטטוסים של שילוב.

טיפוסים בני מנייה (enums)
INTEGRATION_STATUS_UNSPECIFIED סטטוס השילוב לא צוין.
ENABLED מופעל.
DISABLED מושבת.

DialogflowEsIntegration

מידע על נציג של Business Messages ועל שיוך לפרויקט ב-Dialogflow ES.

ייצוג JSON 
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
שדות
dialogflowProjectId

string

חובה. מזהה הפרויקט ב-Dialogflow.

לא ניתן לערוך אותו. כדי לשנות את הערך הזה, צריך למחוק את הפרויקט ב-Dialogflow מהנציג הזה ואז ליצור שילוב חדש.
autoResponseStatus

enum (AutoResponseStatus)

חובה. אם התשובה היא ENABLED, מערכת Business Messages תשלח למשתמשים באופן אוטומטי את התשובות מ-Dialogflow.
dialogflowServiceAccountEmail

string

פלט בלבד. חשבון השירות שצריך להגדיר בפרויקט Dialogflow עם התפקידים Dialogflow Console Agent Editor' ו-Dialogflow API Client. ההרשאה הזו נדרשת כדי לתת גישה ל-Dialogflow API.
operationInfo

object (OperationInfo)

פלט בלבד. מידע על מצב הפעולה של השילוב עם Dialogflow.
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

מאגרי ידע שמשויכים לפרויקט Dialogflow.

אופציונלי

AutoResponseStatus

סטטוס התגובה האוטומטית ב-Dialogflow.

טיפוסים בני מנייה (enums)
AUTO_RESPONSE_STATUS_UNSPECIFIED התשובה האוטומטית לא צוינה.
ENABLED תשובות אוטומטיות מופעלות.
DISABLED התשובה האוטומטית מושבתת.

OperationInfo

פרטי הפעולה ב-Dialogflow.

ייצוג JSON 
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
שדות
operationName

string

פלט בלבד. השם שהוקצה על ידי השרת (מזהה פעולה), שהוא ייחודי רק בתוך אותו שירות שמחזיר אותו במקור.
operationType

enum (OperationType)

פלט בלבד. סוג הפעולה ב-Dialogflow.
operationState

enum (OperationState)

פלט בלבד. מצב הפעולה ב-Dialogflow.
error

object (Status)

פלט בלבד. תוצאת השגיאה, אם יש.

OperationType

סוגי הפעולות ב-Dialogflow.

טיפוסים בני מנייה (enums)
OPERATION_TYPE_UNSPECIFIED הסוג לא צוין.
ASSOCIATE_DIALOGFLOW שיוך ל-Dialogflow.
DISSOCIATE_DIALOGFLOW ביטול השיוך של Dialogflow.
ADD_DOCUMENT_TO_KNOWLEDGEBASE הוספת מסמך למאגר הידע.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE מחיקת המסמך ממאגר הידע.

OperationState

סטטוסי הפעולה ב-Dialogflow.

טיפוסים בני מנייה (enums)
OPERATION_STATE_UNSPECIFIED הסטטוס לא צוין.
PROCESSING מתבצע עיבוד.
COMPLETED הפעולה הושלמה.
FAILED הפעולה נכשלה.

סטטוס

הסוג Status מגדיר מודל שגיאה לוגית שמתאים לסביבות תכנות שונות, כולל ממשקי REST API ו-RPC API. הוא משמש את gRPC. כל הודעת Status מכילה שלושה קטעי נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה.

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

ייצוג JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
שדות
code

integer

קוד הסטטוס, שצריך להיות ערך 'טיפוסים בני מנייה (enum)' google.rpc.Code.
message

string

הודעת שגיאה למפתחים, שאמורה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמש צריכה להיות מותאמת לשוק המקומי ולשלוח אותה בשדה google.rpc.Status.details, או לתרגם אותה על ידי הלקוח.
details[]

object

רשימת ההודעות עם פרטי השגיאה. יש קבוצה משותפת של סוגי הודעות שבהם אפשר להשתמש בממשקי API.

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI שמזהה את הסוג. דוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }

DialogflowKnowledgebase

מידע על מאגר ידע. לבסיס ידע יכולות להיות כמה כתובות URL של שאלות נפוצות.

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
שדות
name

string

פלט בלבד. מזהה מאגר ידע.

מזהה ייחודי שהוחזר על ידי שירות Dialogflow אחרי היצירה של מאגר ידע. אם מזהה המותג הוא 1234, מזהה הסוכן הוא 5678, מזהה השילוב הוא 9092 והמזהה של מאגר הידע הוא 1111. הפרמטר הזה מקבל את הערך 'brands/1234/agents/5678/integrations/9092/knowledgebases/1111'.
displayName

string

חובה. השם המוצג של מאגר הידע.
documents[]

object (DialogflowDocument)

מסמכים של מאגר ידע.

אופציונלי
updateTime

string (Timestamp format)

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

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

DialogflowDocument

מסמך של מאגר ידע. מסמך יכול להיות כתובת אתר או כתובת אתר של קובץ CSV. כתובות ה-URL חייבות להיות גלויות לכולם. קובצי CSV צריכים להכיל צמד אחד או יותר של שאלות/תשובות, עם שורה אחת לכל צמד.

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "updateTime": string,
  "operationInfo": {
    object (OperationInfo)
  },

  // Union field content can be only one of the following:
  "faqUrl": string,
  "rawContent": string
  // End of list of possible types for union field content.
}
שדות
name

string

מזהה מסמך שנוצר על ידי המערכת.

אם מזהה המותג הוא 1234, מזהה הסוכן הוא 5678, מזהה השילוב הוא 9092, המזהה של מאגר הידע הוא 1111 ומזהה המסמך הוא 2222. הפרמטר הזה מקבל את הערך 'brands/1234/agents/5678/integrations/9092/1221base1bases/
displayName

string

חובה. השם המוצג של מסמך שאלות נפוצות.
updateTime

string (Timestamp format)

פלט בלבד. השעה שבה המסמך נוצר/עודכן.

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
operationInfo

object (OperationInfo)

פלט בלבד. פרטי הפעולה מאוכלסים רק כשמסמך נוסף למאגר ידע קיים.
שדה איחוד content. תוכן המסמך. הערך של content יכול להיות רק אחת מהאפשרויות הבאות:
faqUrl

string

כתובת URL של מסמך שאלות נפוצות.
rawContent

string (bytes format)

התוכן הגולמי של המסמך.

מחרוזת בקידוד base64.

DialogflowCxIntegration

מידע על נציג של Business Messages ועל שיוך לפרויקט CX ב-Dialogflow.

ייצוג JSON 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
שדות
dialogflowProjectId

string

חובה. מזהה הפרויקט ב-Dialogflow.

לא ניתן לערוך אותו. כדי לשנות את הערך הזה, צריך למחוק את הפרויקט ב-Dialogflow מהנציג הזה ואז ליצור שילוב חדש.
dialogflowAgentId

string

חובה. מזהה הנציג ב-Dialogflow.
autoResponseStatus

enum (AutoResponseStatus)

חובה. אם התשובה היא ENABLED, מערכת Business Messages תשלח למשתמשים באופן אוטומטי את התשובות מ-Dialogflow.
dialogflowServiceAccountEmail

string

פלט בלבד. חשבון השירות שצריך להגדיר בפרויקט Dialogflow עם התפקידים Dialogflow Console Agent Editor' ו-Dialogflow API Client. ההרשאה הזו נדרשת כדי לתת גישה ל-Dialogflow API.
operationInfo

object (OperationInfo)

פלט בלבד. מידע על מצב הפעולה של השילוב עם Dialogflow.

שיטות

create

 יוצרים שילוב.

delete

 מחיקת שילוב.

get

 קבלת שילוב.

list

 רשימה של שילובים.

patch

 מעדכנים שילוב.