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

وضعیت ادغام

وضعیت های یکپارچه سازی

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» و «Client Dialogflow API» پیکربندی شود. این برای دسترسی به Dialogflow API مورد نیاز است.

operationInfo

object ( OperationInfo )

فقط خروجی اطلاعاتی در مورد وضعیت عملکرد ادغام Dialogflow.

dialogflowKnowledgeBases[]

object ( DialogflowKnowledgebase )

پایگاه های دانش مرتبط با پروژه Dialogflow.

اختیاری

AutoResponseStatus

وضعیت پاسخ خودکار Dialogflow.

Enums
AUTO_RESPONSE_STATUS_UNSPECIFIED پاسخ خودکار مشخص نشده است.
ENABLED پاسخ خودکار فعال است.
DISABLED پاسخ خودکار غیرفعال است.

اطلاعات عملیات

اطلاعات عملیات 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 )

فقط خروجی نتیجه خطا، در صورت وجود.

نوع عملیات

انواع عملیات Dialogflow

Enums
OPERATION_TYPE_UNSPECIFIED نوع نامشخص
ASSOCIATE_DIALOGFLOW Associate Dialogflow.
DISSOCIATE_DIALOGFLOW Dialogflow را جدا کنید.
ADD_DOCUMENT_TO_KNOWLEDGEBASE سند را به پایگاه دانش اضافه کنید.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE حذف سند از پایگاه دانش

حالت عملیاتی

وضعیت عملکرد در 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

کد وضعیت، که باید مقداری از google.rpc.Code باشد.

message

string

یک پیغام خطای برنامه‌نویس، که باید به زبان انگلیسی باشد. هر پیام خطای کاربر باید بومی سازی شده و در قسمت google.rpc.Status.details ارسال شود یا توسط مشتری بومی سازی شود.

details[]

object

لیستی از پیام هایی که حاوی جزئیات خطا هستند. مجموعه ای متداول از انواع پیام ها برای استفاده API ها وجود دارد.

یک شی حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی "@type" حاوی یک URI است که نوع را مشخص می کند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" } .

DialogflowKnowledbase

اطلاعات پایه دانش یک پایگاه دانش می تواند چندین 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" .

Dialogflow Document

یک سند پایه دانش یک سند می تواند یک 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" باشد، این پارامتر به "برندهای/ 1234/agents/5678/integrations/9092/knowledgebases/1111/documents/2222".

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

اطلاعاتی درباره یک نماینده Business Messages و انجمن پروژه 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 ، Business Messages به طور خودکار پاسخ های Dialogflow را برای کاربران ارسال می کند.

dialogflowServiceAccountEmail

string

فقط خروجی حساب سرویسی که باید در پروژه Dialogflow با نقش‌های «ویرایشگر عامل کنسول Dialogflow» و «Client Dialogflow API» پیکربندی شود. این برای دسترسی به Dialogflow API مورد نیاز است.

operationInfo

object ( OperationInfo )

فقط خروجی اطلاعاتی در مورد وضعیت عملکرد ادغام Dialogflow.

مواد و روش ها

create

 یک ادغام ایجاد کنید.

delete

 یک ادغام را حذف کنید

get

 یک ادغام دریافت کنید.

list

 لیست ادغام ها

patch

 یک ادغام را به روز کنید