REST Resource: brands.agents.integrations

Kaynak: Entegrasyon

Entegrasyon hakkında bilgi.

JSON gösterimi 
{
  "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.
}
Alanlar
name

string

Yalnızca çıkış. Entegrasyonun benzersiz tanımlayıcısı. Salt okunurdur. Platform tarafından tanımlanır.
status

enum (IntegrationStatus)

Yalnızca çıkış. Entegrasyon durumu.
Birleştirme alanı integration_info. Entegrasyon hakkında ayrıntılı bilgi. integration_info şunlardan yalnızca biri olabilir:
dialogflowEsIntegration

object (DialogflowEsIntegration)

İlişkilendirilmiş bir Dialogflow ES projesi hakkında bilgi. https://cloud.google.com/dialogflow/es/docs
dialogflowCxIntegration

object (DialogflowCxIntegration)

İlişkilendirilmiş bir Dialogflow CX projesi hakkında bilgi. https://cloud.google.com/dialogflow/cx/docs/basics
agentWebhookIntegration

object (AgentWebhookIntegration)

Temsilciler için webhook hakkında bilgi. Temsilci düzeyinde yapılandırılan webhook'lar, iş ortağı düzeyindeki webhook'u geçersiz kılar.

IntegrationStatus

Entegrasyon durumları.

Sıralamalar
INTEGRATION_STATUS_UNSPECIFIED Entegrasyon durumu belirtilmedi.
ENABLED Etkinleştirildi.
DISABLED Devre dışı.

DialogflowEsIntegration

Business Messages aracısı ve Dialogflow ES proje ilişkilendirmesi hakkında bilgi.

JSON gösterimi 
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
Alanlar
dialogflowProjectId

string

Zorunlu. Dialogflow projesinin kimliği.

Düzenlenemez. Bu değeri değiştirmek için Dialogflow projesini bu aracıdan silmeniz ve ardından yeni bir entegrasyon oluşturmanız gerekir.
autoResponseStatus

enum (AutoResponseStatus)

Zorunlu. ENABLED ise Business Messages, Dialogflow yanıtlarını kullanıcılara otomatik olarak gönderir.
dialogflowServiceAccountEmail

string

Yalnızca çıkış. Dialogflow projesinde "Dialogflow Console Aracı Düzenleyici" ve "Dialogflow API İstemcisi" rolleriyle yapılandırılması gereken hizmet hesabıdır. Bu, Dialogflow API'ye erişim sağlamak için gereklidir.
operationInfo

object (OperationInfo)

Yalnızca çıkış. Dialogflow entegrasyonunun çalışma durumu hakkında bilgi.
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

Dialogflow projesiyle ilişkili bilgi tabanları.

İsteğe bağlı

AutoResponseStatus

Dialogflow otomatik yanıt durumu.

Sıralamalar
AUTO_RESPONSE_STATUS_UNSPECIFIED Otomatik yanıt belirtilmedi.
ENABLED Otomatik yanıt etkinleştirildi.
DISABLED Otomatik yanıt devre dışı bırakıldı.

OperationInfo

Dialogflow işlem bilgileri.

JSON gösterimi 
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
Alanlar
operationName

string

Yalnızca çıkış. Sunucu tarafından atanan ad (işlem kimliği). Bu ad, yalnızca bunu ilk döndüren hizmette benzersizdir.
operationType

enum (OperationType)

Yalnızca çıkış. Dialogflow İşlem türü.
operationState

enum (OperationState)

Yalnızca çıkış. Dialogflow İşleminin durumu.
error

object (Status)

Yalnızca çıkış. Varsa hata sonucu.

OperationType

Dialogflow işlem türleri.

Sıralamalar
OPERATION_TYPE_UNSPECIFIED Belirtilmemiş tür.
ASSOCIATE_DIALOGFLOW Dialogflow'u ilişkilendirin.
DISSOCIATE_DIALOGFLOW Dialogflow'un bağlantısını kesin.
ADD_DOCUMENT_TO_KNOWLEDGEBASE Bilgi tabanına belge ekleyin.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE Belgeyi bilgi tabanından sil.

OperationState

Dialogflow'daki işlem durumları.

Sıralamalar
OPERATION_STATE_UNSPECIFIED Belirtilmemiş durum.
PROCESSING İşleniyor.
COMPLETED Tamamlandı.
FAILED Başarısız oldu.

Durum

Status türü, REST API'ler ve RPC API'leri dahil olmak üzere farklı programlama ortamları için uygun bir mantıksal hata modeli tanımlar. gRPC tarafından kullanılır. Her Status mesajı üç veri parçası içerir: hata kodu, hata mesajı ve hata ayrıntıları.

Bu hata modeli ve modelle nasıl çalışabileceğiniz hakkında daha fazla bilgiyi API Tasarım Kılavuzu'nda bulabilirsiniz.

JSON gösterimi 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Alanlar
code

integer

google.rpc.Code öğesinin enum değeri olması gereken durum kodu.
message

string

Geliştiricinin karşılaştığı İngilizce hata mesajı. Kullanıcılara yönelik tüm hata mesajları yerelleştirilip google.rpc.Status.details alanında gönderilmeli veya istemci tarafından yerelleştirilmelidir.
details[]

object

Hata ayrıntılarını içeren mesajların listesi. API'lerin kullanabileceği bir dizi yaygın mesaj türü vardır.

Rastgele türde alanlar içeren bir nesne. "@type" adlı ek alan, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

DialogflowKnowledgebase

Bilgi tabanı bilgileri. Bir bilgi tabanında birden çok SSS URL'si olabilir.

JSON gösterimi 
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
Alanlar
name

string

Yalnızca çıkış. Bilgi bankası kimliği.

Bilgi tabanı oluşturulduktan sonra Dialogflow hizmeti tarafından döndürülen benzersiz tanımlayıcı. Marka tanımlayıcısı "1234", aracı tanımlayıcısı "5678", entegrasyon tanımlayıcısı "9092" ve bilgi tabanı tanımlayıcısı "1111" ise bu parametre "brands/1234/agents/5678/integrations/9092/knowledgebases/1111" olarak çözümlenir.
displayName

string

Zorunlu. Bilgi tabanı görünen adı.
documents[]

object (DialogflowDocument)

Bilgi bankası dokümanları.

İsteğe bağlı
updateTime

string (Timestamp format)

Yalnızca çıkış. Bilgi tabanının oluşturulduğu veya güncellendiği zaman.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

DialogflowDocument

Bilgi bankası dokümanı. Doküman, bir web sitesi URL'si veya bir CSV dosyasının URL'si olabilir. URL'ler herkese açık olmalıdır. CSV dosyaları, her çift için bir satır olmak üzere bir veya daha fazla soru/yanıt çifti içermelidir.

JSON gösterimi 
{
  "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.
}
Alanlar
name

string

Sistem tarafından oluşturulan Doküman Kimliği.

Marka tanımlayıcısı "1234", aracı tanımlayıcısı "5678", entegrasyon tanımlayıcısı "9092", bilgi tabanı tanımlayıcısı "1111" ve doküman tanımlayıcısı "2222" ise bu parametre "brands/1234/agents/5678/integrations/9092/knowledge21/documents/11" olarak çözümlenir.
displayName

string

Zorunlu. SSS dokümanının görünen adı.
updateTime

string (Timestamp format)

Yalnızca çıkış. Dokümanın oluşturulduğu/güncellendiği saat.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
operationInfo

object (OperationInfo)

Yalnızca çıkış. İşlem Bilgileri yalnızca bir belge mevcut bir bilgi tabanına eklendiğinde doldurulur.
Birleştirme alanı content. Belgenin içeriği. content şunlardan yalnızca biri olabilir:
faqUrl

string

SSS dokümanının URL'si.
rawContent

string (bytes format)

Belgenin ham içeriği.

Base64 kodlu bir dize.

DialogflowCxIntegration

Business Messages aracısı ve Dialogflow CX proje ilişkilendirmesi hakkında bilgi.

JSON gösterimi 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
Alanlar
dialogflowProjectId

string

Zorunlu. Dialogflow projesinin kimliği.

Düzenlenemez. Bu değeri değiştirmek için Dialogflow projesini bu aracıdan silmeniz ve ardından yeni bir entegrasyon oluşturmanız gerekir.
dialogflowAgentId

string

Zorunlu. Dialogflow Aracı Kimliği.
autoResponseStatus

enum (AutoResponseStatus)

Zorunlu. ENABLED ise Business Messages, Dialogflow yanıtlarını kullanıcılara otomatik olarak gönderir.
dialogflowServiceAccountEmail

string

Yalnızca çıkış. Dialogflow projesinde "Dialogflow Console Aracı Düzenleyici" ve "Dialogflow API İstemcisi" rolleriyle yapılandırılması gereken hizmet hesabıdır. Bu, Dialogflow API'ye erişim sağlamak için gereklidir.
operationInfo

object (OperationInfo)

Yalnızca çıkış. Dialogflow entegrasyonunun çalışma durumu hakkında bilgi.

AgentWebhookIntegration

Business Messages temsilcisi için webhook hakkında bilgi.

JSON gösterimi 
{
  "webhookUri": string,
  "verificationToken": string
}
Alanlar
webhookUri

string

Zorunlu. Mesajların iletildiği webhook URL'si.
verificationToken

string

Yalnızca giriş'e dokunun. Doğrulama jetonu.

Yöntemler

create

 Entegrasyon oluşturun.

delete

 Entegrasyonu silin.

get

 Entegrasyon edinin.

list

 Entegrasyonları listeleme.

patch

 Entegrasyonu güncelleyin.