リソース: Integration
統合に関する情報。
JSON 表現 |
---|
{ "name": string, "status": enum ( |
フィールド | |
---|---|
name |
出力専用。統合の一意の識別子。読み取り専用。プラットフォームによって定義されます。 |
status |
出力専用。統合ステータス。 |
共用体フィールド integration_info 。統合に関する詳細情報。integration_info は次のいずれかになります。 |
|
dialogflowEsIntegration |
関連付けられている Dialogflow ES プロジェクトに関する情報。https://cloud.google.com/dialogflow/es/docs |
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 ( |
フィールド | |
---|---|
dialogflowProjectId |
必須。Dialogflow プロジェクト ID。 編集できません。この値を変更するには、このエージェントから Dialogflow プロジェクトを削除してから、新しい統合を作成する必要があります。 |
autoResponseStatus |
必須。 |
dialogflowServiceAccountEmail |
出力専用。Dialogflow プロジェクトで「Dialogflow コンソール エージェント エディタ」を使用して構成する必要があるサービス アカウントと「Dialogflow API クライアント」できます。これは、Dialogflow API へのアクセス権を付与するために必要です。 |
operationInfo |
出力専用。Dialogflow インテグレーションの動作状態に関する情報。 |
dialogflowKnowledgeBases[] |
Dialogflow プロジェクトに関連付けられたナレッジベース。 省略可 |
AutoResponseStatus
Dialogflow 自動レスポンスのステータス。
列挙型 | |
---|---|
AUTO_RESPONSE_STATUS_UNSPECIFIED |
自動応答が指定されていません。 |
ENABLED |
自動応答が有効です。 |
DISABLED |
自動返信は無効になっています。 |
OperationInfo
Dialogflow のオペレーション情報。
JSON 表現 |
---|
{ "operationName": string, "operationType": enum ( |
フィールド | |
---|---|
operationName |
出力専用。サーバーが割り当てた名前(オペレーション ID)。最初にそれを返したサービス内でのみ一意です。 |
operationType |
出力専用。Dialogflow オペレーション タイプ。 |
operationState |
出力専用。Dialogflow オペレーションの状態。 |
error |
出力専用。エラーの結果(ある場合)。 |
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 API や RPC API など、さまざまなプログラミング環境に適した論理エラーモデルを定義します。gRPC により使用されます。各 Status
メッセージには、エラーコード、エラー メッセージ、エラーの詳細という 3 種類のデータが含まれます。
このエラーモデルと操作方法について詳しくは、API 設計ガイドをご覧ください。
JSON 表現 |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
フィールド | |
---|---|
code |
ステータス コード。 |
message |
デベロッパー向けのエラー メッセージ。英語で記述します。ユーザー向けのエラー メッセージは、ローカライズして |
details[] |
エラーの詳細を保持するメッセージのリスト。API が使用する共通のメッセージ タイプのセットがあります。 任意のデータ型のフィールドを含むオブジェクト。型を識別する URI を含むフィールド |
DialogflowKnowledgebase
ナレッジベース情報。ナレッジベースには、よくある質問の URL を複数設定できます。
JSON 表現 |
---|
{
"name": string,
"displayName": string,
"documents": [
{
object ( |
フィールド | |
---|---|
name |
出力専用。ナレッジベース ID。 ナレッジベースの作成後に Dialogflow サービスから返される一意の識別子。ブランド ID が「1234」、エージェント ID が「5678」、統合 ID が「9092」、ナレッジベース ID が「1111」の場合、このパラメータは「brands/1234/agents/5678/integrations/9092/knowledgebases/1111」に解決されます。 |
displayName |
必須。ナレッジベースの表示名。 |
documents[] |
ナレッジベース ドキュメント。 省略可 |
updateTime |
出力専用。ナレッジベースが作成または更新された時刻。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
DialogflowDocument
ナレッジベース ドキュメント。ドキュメントには、ウェブサイトの URL または CSV ファイルの URL を指定できます。URL は一般公開されている必要があります。CSV ファイルには、質問と回答のペアを 1 行ずつ、1 つ以上含める必要があります。
JSON 表現 |
---|
{ "name": string, "displayName": string, "updateTime": string, "operationInfo": { object ( |
フィールド | |
---|---|
name |
システム生成のドキュメント ID。 ブランド ID が「1234」、エージェント ID が「5678」、統合 ID が「9092」、ナレッジベース ID が「1111」、ドキュメント ID が「2222」の場合、このパラメータは「brands/1234/agents/5678/integrationdocuments/9092/knowledge12」に解決されます。 |
displayName |
必須。FAQ ドキュメントの表示名。 |
updateTime |
出力専用。ドキュメントが作成または更新された時刻。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
operationInfo |
出力専用。オペレーション情報は、ドキュメントが既存のナレッジベースに追加された場合にのみ入力されます。 |
共用体フィールド content 。ドキュメントのコンテンツ。content は次のいずれかになります。 |
|
faqUrl |
FAQ ドキュメントの URL。 |
rawContent |
ドキュメントの未加工のコンテンツ。 Base64 でエンコードされた文字列。 |
DialogflowCxIntegration
ビジネス メッセージ エージェントと Dialogflow CX プロジェクトの関連付けに関する情報。
JSON 表現 |
---|
{ "dialogflowProjectId": string, "dialogflowAgentId": string, "autoResponseStatus": enum ( |
フィールド | |
---|---|
dialogflowProjectId |
必須。Dialogflow プロジェクト ID。 編集できません。この値を変更するには、このエージェントから Dialogflow プロジェクトを削除してから、新しい統合を作成する必要があります。 |
dialogflowAgentId |
必須。Dialogflow エージェント ID。 |
autoResponseStatus |
必須。 |
dialogflowServiceAccountEmail |
出力専用。Dialogflow プロジェクトで「Dialogflow コンソール エージェント エディタ」を使用して構成する必要があるサービス アカウントと「Dialogflow API クライアント」できます。これは、Dialogflow API へのアクセス権を付与するために必要です。 |
operationInfo |
出力専用。Dialogflow インテグレーションの動作状態に関する情報。 |
メソッド |
|
---|---|
|
統合を作成する |
|
統合を削除します。 |
|
統合する。 |
|
インテグレーションを一覧表示します。 |
|
統合を更新する。 |