Kaynak: Entegrasyon
Entegrasyon hakkında bilgi.
JSON gösterimi |
---|
{ "name": string, "status": enum ( |
Alanlar | |
---|---|
name |
Yalnızca çıkış. Entegrasyonun benzersiz tanımlayıcısı. Salt okunur. Platform tarafından tanımlanır. |
status |
Yalnızca çıkış. Entegrasyon durumu. |
integration_info alanı. Entegrasyonla ilgili ayrıntılı bilgi. integration_info şunlardan yalnızca biri olabilir: |
|
dialogflowEsIntegration |
İlişkilendirilmiş Dialogflow ES projesi hakkında bilgi. https://cloud.google.com/dialogflow/es/docs |
dialogflowCxIntegration |
İlişkilendirilmiş Dialogflow CX projesi hakkında bilgi. https://cloud.google.com/dialogflow/cx/docs/basics |
IntegrationStatus
Entegrasyon durumları.
Sıralamalar | |
---|---|
INTEGRATION_STATUS_UNSPECIFIED |
Entegrasyon durumu belirtilmedi. |
ENABLED |
Etkinleştirildi. |
DISABLED |
Devre dışı. |
DialogflowEsIntegration
Business Messages temsilcisi ve Dialogflow ES proje ilişkilendirmesi hakkında bilgi.
JSON gösterimi |
---|
{ "dialogflowProjectId": string, "autoResponseStatus": enum ( |
Alanlar | |
---|---|
dialogflowProjectId |
Zorunlu. Dialogflow projesi 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 |
Zorunlu. |
dialogflowServiceAccountEmail |
Yalnızca çıkış. Dialogflow projesinde "Dialogflow Console Aracı Düzenleyici" ve "Dialogflow API İstemcisi" rolleriyle yapılandırılması gereken hizmet hesabı. Bu, Dialogflow API'ye erişim sağlamak için gereklidir. |
operationInfo |
Yalnızca çıkış. Dialogflow entegrasyonunun çalışma durumu hakkında bilgiler. |
dialogflowKnowledgeBases[] |
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 ( |
Alanlar | |
---|---|
operationName |
Yalnızca çıkış. Sunucu tarafından atanan ad (işlem kimliği). Bu ad, yalnızca onu ilk döndüren hizmette benzersizdir. |
operationType |
Yalnızca çıkış. Dialogflow İşlem türü. |
operationState |
Yalnızca çıkış. Dialogflow İşlem durumu. |
error |
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 bağlantısını kaldırın. |
ADD_DOCUMENT_TO_KNOWLEDGEBASE |
Bilgi bankasına belge ekleyin. |
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE |
Belgeyi bilgi bankası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ışılacağı 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 |
|
message |
Geliştiricinin karşılaştığı İngilizce hata mesajı. Kullanıcılara yönelik tüm hata mesajları yerelleştirilip |
details[] |
Hata ayrıntılarını içeren mesajların listesi. API'lerin kullanabileceği yaygın bir dizi mesaj türü vardır. Rastgele türde alanlar içeren bir nesne. |
DialogflowKnowledgebase
Bilgi tabanı bilgileri. Bir bilgi tabanında birden fazla SSS URL'si bulunabilir.
JSON gösterimi |
---|
{
"name": string,
"displayName": string,
"documents": [
{
object ( |
Alanlar | |
---|---|
name |
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" ise 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 |
Zorunlu. Bilgi tabanı görünen adı. |
documents[] |
Bilgi bankası dokümanları. İsteğe bağlı |
updateTime |
Yalnızca çıkış. Bilgi tabanının oluşturulduğu veya güncellendiği zaman. Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: |
DialogflowDocument
Bilgi bankası belgesi. 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 ( |
Alanlar | |
---|---|
name |
Sistem tarafından oluşturulan Doküman Kimliği. Marka tanımlayıcısı "1234" ise aracı tanımlayıcısı "5678", entegrasyon tanımlayıcısı "9092", bilgi tabanı tanımlayıcısı "1111" ve belge tanımlayıcısı "2222" ise bu parametre "brands/1234/agents/5678/integrations/9092/knowledge21/documents.11" olarak çözümlenir. |
displayName |
Zorunlu. SSS dokümanının görünen adı. |
updateTime |
Yalnızca çıkış. Belgenin oluşturulduğu/güncellendiği saat. Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: |
operationInfo |
Yalnızca çıkış. İşlem Bilgileri yalnızca bir belge mevcut bir bilgi tabanına eklendiğinde doldurulur. |
content alanı. Belgenin içeriği. content şunlardan yalnızca biri olabilir: |
|
faqUrl |
SSS dokümanının URL'si. |
rawContent |
Belgenin ham içeriği. Base64 olarak kodlanmış bir dize. |
DialogflowCxIntegration
Business Messages temsilcisi ve Dialogflow CX proje ilişkilendirmesi hakkında bilgi.
JSON gösterimi |
---|
{ "dialogflowProjectId": string, "dialogflowAgentId": string, "autoResponseStatus": enum ( |
Alanlar | |
---|---|
dialogflowProjectId |
Zorunlu. Dialogflow projesi 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 |
Zorunlu. Dialogflow Aracı Kimliği. |
autoResponseStatus |
Zorunlu. |
dialogflowServiceAccountEmail |
Yalnızca çıkış. Dialogflow projesinde "Dialogflow Console Aracı Düzenleyici" ve "Dialogflow API İstemcisi" rolleriyle yapılandırılması gereken hizmet hesabı. Bu, Dialogflow API'ye erişim sağlamak için gereklidir. |
operationInfo |
Yalnızca çıkış. Dialogflow entegrasyonunun çalışma durumu hakkında bilgiler. |
Yöntemler |
|
---|---|
|
Entegrasyon oluşturun. |
|
Entegrasyonu silin. |
|
Entegrasyon edinin. |
|
Entegrasyonları listeleyin. |
|
Bir entegrasyonu güncelleyin. |