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

حالات الدمج

عمليات التعداد
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/12/1/2".
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.

الطُرق

create

 إنشاء عملية دمج

delete

 حذف عملية دمج

get

 إجراء عملية دمج

list

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

patch

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