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)
  },
  "agentWebhookIntegration": {
    object (AgentWebhookIntegration)
  }
  // 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
agentWebhookIntegration

object (AgentWebhookIntegration)

معلومات عن الردّ التلقائي على الويب لأحد موظّفي الدعم في حال ضبط ردّ تلقائي على الويب على مستوى الوكيل، سيتم إلغاء الردّ التلقائي على الويب على مستوى الشريك.

IntegrationStatus

حالات الدمج

عمليات التعداد
INTEGRATION_STATUS_UNSPECIFIED لم يتم تحديد حالة الدمج.
ENABLED تم تفعيله.
DISABLED الزر غير مفعّل.

DialogflowEsIntegration

معلومات عن وكيل في ميزة "الرسائل التجارية" ورابطة مشروع Dialogflow ES.

تمثيل JSON 
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
الحقول
dialogflowProjectId

string

مطلوبة. رقم تعريف مشروع Dialogflow.

غير قابلة للتعديل. لتغيير هذه القيمة، عليك حذف مشروع Dialogflow من هذا الوكيل، ثم إنشاء عملية دمج جديدة.
autoResponseStatus

enum (AutoResponseStatus)

مطلوبة. إذا كان ENABLED، سترسل ميزة "الرسائل التجارية" ردود Dialogflow إلى المستخدمين تلقائيًا.
dialogflowServiceAccountEmail

string

النتائج فقط. حساب الخدمة الذي يجب إعداده في مشروع Dialogflow باستخدام الدورَين "محرِّر وكيل وحدة تحكُّم Dialogflow" و "عميل واجهة برمجة تطبيقات Dialogflow". هذا الإجراء مطلوب لتوفير إمكانية الوصول إلى واجهة برمجة تطبيقات Dialogflow.
operationInfo

object (OperationInfo)

النتائج فقط. معلومات عن حالة تشغيل عملية دمج Dialogflow.
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

قواعد المعرفة المرتبطة بمشروع Dialogflow.

اختياري

AutoResponseStatus

حالة الرد التلقائي في Dialogflow.

عمليات التعداد
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.

عمليات التعداد
OPERATION_TYPE_UNSPECIFIED نوع غير محدَّد.
ASSOCIATE_DIALOGFLOW ربط Dialogflow.
DISSOCIATE_DIALOGFLOW إلغاء ارتباط Dialogflow.
ADD_DOCUMENT_TO_KNOWLEDGEBASE إضافة مستند إلى قاعدة المعرفة
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE حذف المستند من قاعدة المعرفة.

OperationState

حالات العمل في Dialogflow.

عمليات التعداد
OPERATION_STATE_UNSPECIFIED حالة غير محدّدة
PROCESSING تتم المعالجة.
COMPLETED مكتملة.
FAILED تعذّر إكمال العملية:

الحالة

يحدد النوع Status نموذج خطأ منطقي مناسبًا لبيئات البرمجة المختلفة، بما في ذلك واجهات برمجة تطبيقات REST وواجهات برمجة التطبيقات RPC. ويتم استخدامها من قِبل gRPC. تحتوي كل رسالة Status على ثلاث بيانات: رمز الخطأ ورسالة الخطأ وتفاصيل الخطأ.

يمكنك معرفة المزيد حول نموذج الخطأ هذا وكيفية التعامل معه في دليل تصميم واجهة برمجة التطبيقات.

تمثيل JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
الحقول
code

integer

تمثّل هذه السمة رمز الحالة، ويجب أن تكون قيمة التعداد google.rpc.Code.
message

string

رسالة خطأ موجَّهة للمطوِّر، يجب أن تكون باللغة الإنجليزية. يجب ترجمة أي رسالة خطأ موجَّهة للمستخدمين وإرسالها في الحقل google.rpc.Status.details، أو يجب أن يترجمها البرنامج.
details[]

object

قائمة بالرسائل التي تحتوي على تفاصيل الخطأ. تتوفّر مجموعة شائعة من أنواع الرسائل التي يمكن أن تستخدمها واجهات برمجة التطبيقات.

يشير ذلك المصطلح إلى كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي "@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 "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

DialogflowDocument

مستند قاعدة المعرفة يمكن أن يكون المستند عنوان URL لموقع إلكتروني أو عنوان URL لملف 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/knowledgebase/1/1092".
displayName

string

مطلوبة. الاسم المعروض لمستند الأسئلة الشائعة
updateTime

string (Timestamp format)

النتائج فقط. وقت إنشاء أو تعديل المستند

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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

معلومات عن وكيل "الرسائل التجارية" ورابطة مشروع Dialogflow CX.

تمثيل JSON 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
الحقول
dialogflowProjectId

string

مطلوبة. رقم تعريف مشروع Dialogflow.

غير قابلة للتعديل. لتغيير هذه القيمة، عليك حذف مشروع Dialogflow من هذا الوكيل، ثم إنشاء عملية دمج جديدة.
dialogflowAgentId

string

مطلوبة. رقم تعريف وكيل Dialogflow.
autoResponseStatus

enum (AutoResponseStatus)

مطلوبة. إذا كان ENABLED، سترسل ميزة "الرسائل التجارية" ردود Dialogflow إلى المستخدمين تلقائيًا.
dialogflowServiceAccountEmail

string

النتائج فقط. حساب الخدمة الذي يجب إعداده في مشروع Dialogflow باستخدام الدورَين "محرِّر وكيل وحدة تحكُّم Dialogflow" و "عميل واجهة برمجة تطبيقات Dialogflow". هذا الإجراء مطلوب لتوفير إمكانية الوصول إلى واجهة برمجة تطبيقات Dialogflow.
operationInfo

object (OperationInfo)

النتائج فقط. معلومات عن حالة تشغيل عملية دمج Dialogflow.

AgentWebhookIntegration

معلومات عن الردّ التلقائي على الويب لوكيل في ميزة "الرسائل التجارية"

تمثيل JSON 
{
  "webhookUri": string,
  "verificationToken": string
}
الحقول
webhookUri

string

مطلوبة. عنوان URL للردّ التلقائي على الويب الذي يتم تسليم الرسائل إليه
verificationToken

string

الإدخال فقط. الرمز المميّز لإثبات الملكية

الطُرق

create

 أنشئ عملية دمج.

delete

 حذف عملية دمج

get

 الحصول على عملية دمج

list

 عمليات دمج القوائم

patch

 عدِّل عملية دمج.