REST Resource: brands.agents.integrations

संसाधन: इंटिग्रेशन

इंटिग्रेशन के बारे में जानकारी.

जेएसओएन के काेड में दिखाना 
{
  "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

इंटिग्रेशन के स्टेटस.

Enums
INTEGRATION_STATUS_UNSPECIFIED इंटिग्रेशन के स्टेटस की जानकारी नहीं है.
ENABLED चालू है.
DISABLED सबमिट नहीं किया जा सकता.

DialogflowEsIntegration

Business Messages के एजेंट और Dialogflow ES प्रोजेक्ट असोसिएशन के बारे में जानकारी.

जेएसओएन के काेड में दिखाना 
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
फ़ील्ड
dialogflowProjectId

string

ज़रूरी है. डायलॉग फ़्लो प्रोजेक्ट आईडी.

बदलाव नहीं किया जा सकता. इस वैल्यू को बदलने के लिए, आपको इस एजेंट से Dialogflow प्रोजेक्ट मिटाना होगा. इसके बाद, नया इंटिग्रेशन बनाना होगा.
autoResponseStatus

enum (AutoResponseStatus)

ज़रूरी है. अगर ENABLED होता है, तो Business Messages उपयोगकर्ताओं को Dialogflow के जवाब अपने-आप भेजता है.
dialogflowServiceAccountEmail

string

सिर्फ़ आउटपुट के लिए. ऐसा सेवा खाता जिसे Dialogflow प्रोजेक्ट में "Dialogflow Console के एजेंट एडिटर" और "Dialogflow API क्लाइंट" की भूमिकाओं के साथ कॉन्फ़िगर किया जाना चाहिए. डायलॉग फ़्लो एपीआई का ऐक्सेस देने के लिए यह ज़रूरी है.
operationInfo

object (OperationInfo)

सिर्फ़ आउटपुट के लिए. Dialogflow इंटिग्रेशन के काम करने की स्थिति के बारे में जानकारी.
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

Dialogflow प्रोजेक्ट से जुड़े नॉलेज बेस.

ज़रूरी नहीं

AutoResponseStatus

डायलॉग फ़्लो से अपने-आप दिए गए जवाब का स्टेटस.

Enums
AUTO_RESPONSE_STATUS_UNSPECIFIED अपने-आप दिए जाने वाले जवाब की जानकारी नहीं दी गई है.
ENABLED अपने-आप जवाब देने की सुविधा चालू है.
DISABLED अपने-आप जवाब देने की सुविधा बंद है.

OperationInfo

डायलॉग फ़्लो से जुड़ी कार्रवाई की जानकारी.

जेएसओएन के काेड में दिखाना 
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
फ़ील्ड
operationName

string

सिर्फ़ आउटपुट के लिए. सर्वर से असाइन किया गया नाम (ऑपरेशन आईडी), जो सिर्फ़ उसी सेवा के लिए यूनीक होता है जो इसे मूल रूप से दिखाती है.
operationType

enum (OperationType)

सिर्फ़ आउटपुट के लिए. डायलॉग फ़्लो से जुड़ा ऑपरेशन टाइप.
operationState

enum (OperationState)

सिर्फ़ आउटपुट के लिए. डायलॉग फ़्लो की कार्रवाई की स्थिति.
error

object (Status)

सिर्फ़ आउटपुट के लिए. अगर कोई गड़बड़ी होती है, तो उसका नतीजा.

OperationType

डायलॉग फ़्लो से जुड़े अलग-अलग तरह के ऑपरेशन.

Enums
OPERATION_TYPE_UNSPECIFIED टाइप की जानकारी नहीं है.
ASSOCIATE_DIALOGFLOW डायलॉग फ़्लो को असोसिएट करें.
DISSOCIATE_DIALOGFLOW डायलॉग फ़्लो को अलग करें.
ADD_DOCUMENT_TO_KNOWLEDGEBASE नॉलेज बेस में दस्तावेज़ जोड़ें.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE नॉलेज बेस से दस्तावेज़ मिटाएं.

OperationState

डायलॉग फ़्लो में कार्रवाई की स्थितियां.

Enums
OPERATION_STATE_UNSPECIFIED स्थिति सेट नहीं की गई है.
PROCESSING अनुरोध प्रोसेस किया जा रहा है.
COMPLETED पूरा हुआ.
FAILED रिकॉर्डिंग नहीं हो पाई.

स्थिति

Status टाइप, एक लॉजिकल गड़बड़ी वाले मॉडल के बारे में बताता है. यह मॉडल अलग-अलग प्रोग्रामिंग एनवायरमेंट के लिए सही होता है. इनमें REST API और RPC एपीआई शामिल हैं. इसका इस्तेमाल gRPC करता है. हर Status मैसेज में तीन तरह का डेटा होता है: गड़बड़ी कोड, गड़बड़ी का मैसेज, और गड़बड़ी की जानकारी.

एपीआई की डिज़ाइन गाइड में, गड़बड़ी के इस मॉडल और उस पर काम करने के तरीके के बारे में ज़्यादा जानें.

जेएसओएन के काेड में दिखाना 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
फ़ील्ड
code

integer

स्टेटस कोड, जो google.rpc.Code की एनम वैल्यू होना चाहिए.
message

string

डेवलपर को दिखने वाला गड़बड़ी का मैसेज, जो अंग्रेज़ी में होना चाहिए. उपयोगकर्ता को दिखने वाली गड़बड़ी के मैसेज को स्थानीय भाषा में लिखना चाहिए और google.rpc.Status.details फ़ील्ड में भेजना चाहिए. इसके अलावा, क्लाइंट की मदद से भी इस मैसेज को स्थानीय भाषा में लिखा जाना चाहिए.
details[]

object

मैसेज की ऐसी सूची जिसमें गड़बड़ी की जानकारी होती है. एपीआई के इस्तेमाल के लिए, मैसेज का एक सामान्य सेट है.

ऐसा ऑब्जेक्ट जिसमें किसी आर्बिट्रेरी टाइप के फ़ील्ड होते हैं. एक और फ़ील्ड "@type" में, टाइप की पहचान करने वाला एक यूआरआई शामिल है. उदाहरण: { "id": 1234, "@type": "types.example.com/standard/id" }.

DialogflowKnowledgebase

नॉलेज बेस की जानकारी. नॉलेज बेस में, अक्सर पूछे जाने वाले सवालों के कई यूआरएल हो सकते हैं.

जेएसओएन के काेड में दिखाना 
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. नॉलेजबेस आईडी.

नॉलेज बेस बनाए जाने के बाद, Dialogflow सेवा से मिला यूनीक आइडेंटिफ़ायर. अगर ब्रैंड आइडेंटिफ़ायर "1234" है, एजेंट आइडेंटिफ़ायर "5678", इंटिग्रेशन आइडेंटिफ़ायर "9092", और नॉलेज बेस आइडेंटिफ़ायर "1111" है, तो यह पैरामीटर "brands/1234/agents/5678/इंटिग्रेशन/9092/knowledgebases/1111" से जुड़ा होता है.
displayName

string

ज़रूरी है. नॉलेज बेस का डिसप्ले नेम.
documents[]

object (DialogflowDocument)

नॉलेज बेस दस्तावेज़.

ज़रूरी नहीं
updateTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह समय जब नॉलेज बेस बनाया या अपडेट किया गया था.

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

DialogflowDocument

नॉलेज बेस दस्तावेज़. दस्तावेज़ किसी वेबसाइट का यूआरएल या किसी CSV फ़ाइल का यूआरएल हो सकता है. यूआरएल सार्वजनिक तौर पर उपलब्ध होने चाहिए. CSV फ़ाइलों में एक या उससे ज़्यादा सवाल/जवाब के जोड़े होने चाहिए. साथ ही, हर जोड़े के लिए एक लाइन होनी चाहिए.

जेएसओएन के काेड में दिखाना 
{
  "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/1knowledge1.bases."
displayName

string

ज़रूरी है. अक्सर पूछे जाने वाले सवाल के दस्तावेज़ का डिसप्ले नेम.
updateTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह समय जब दस्तावेज़ बनाया/अपडेट किया गया था.

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
operationInfo

object (OperationInfo)

सिर्फ़ आउटपुट के लिए. ऑपरेशन की जानकारी सिर्फ़ तब अपने-आप भर जाती है, जब कोई दस्तावेज़ किसी मौजूदा नॉलेज बेस में जोड़ा जाता है.
यूनियन फ़ील्ड content. दस्तावेज़ का कॉन्टेंट. content इनमें से सिर्फ़ एक हो सकती है:
faqUrl

string

अक्सर पूछे जाने वाले सवाल से जुड़े दस्तावेज़ का यूआरएल.
rawContent

string (bytes format)

दस्तावेज़ का रॉ कॉन्टेंट.

base64 कोड में बदली गई स्ट्रिंग.

DialogflowCxIntegration

Business Messages के एजेंट और Dialogflow CX प्रोजेक्ट असोसिएशन के बारे में जानकारी.

जेएसओएन के काेड में दिखाना 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
फ़ील्ड
dialogflowProjectId

string

ज़रूरी है. डायलॉग फ़्लो प्रोजेक्ट आईडी.

बदलाव नहीं किया जा सकता. इस वैल्यू को बदलने के लिए, आपको इस एजेंट से Dialogflow प्रोजेक्ट मिटाना होगा. इसके बाद, नया इंटिग्रेशन बनाना होगा.
dialogflowAgentId

string

ज़रूरी है. डायलॉग फ़्लो एजेंट आईडी.
autoResponseStatus

enum (AutoResponseStatus)

ज़रूरी है. अगर ENABLED होता है, तो Business Messages उपयोगकर्ताओं को Dialogflow के जवाब अपने-आप भेजता है.
dialogflowServiceAccountEmail

string

सिर्फ़ आउटपुट के लिए. ऐसा सेवा खाता जिसे Dialogflow प्रोजेक्ट में "Dialogflow Console के एजेंट एडिटर" और "Dialogflow API क्लाइंट" की भूमिकाओं के साथ कॉन्फ़िगर किया जाना चाहिए. डायलॉग फ़्लो एपीआई का ऐक्सेस देने के लिए यह ज़रूरी है.
operationInfo

object (OperationInfo)

सिर्फ़ आउटपुट के लिए. Dialogflow इंटिग्रेशन के काम करने की स्थिति के बारे में जानकारी.

AgentWebhookIntegration

Business Messages के एजेंट के वेबहुक के बारे में जानकारी.

जेएसओएन के काेड में दिखाना 
{
  "webhookUri": string,
  "verificationToken": string
}
फ़ील्ड
webhookUri

string

ज़रूरी है. वह वेबहुक यूआरएल जहां मैसेज डिलीवर किए जाते हैं.
verificationToken

string

सिर्फ़ इनपुट. पुष्टि करने वाला टोकन.

तरीके

create

 इंटिग्रेशन बनाएं.

delete

 इंटिग्रेशन को मिटाएं.

get

 इंटिग्रेशन पाएं.

list

 इंटिग्रेशन की सूची बनाएं.

patch

 इंटिग्रेशन अपडेट करें.