使用 API 管理服務專員

一般來說，您會使用控制台建立及刪除代理程式。不過，在某些進階情境下，使用 API 可能會比較容易。

建立虛擬服務專員

下列範例說明如何為 Agent 型別呼叫 Create 方法。

為代理程式參照選取通訊協定和版本：

通訊協定 V3 V3beta1
REST 服務專員資源 服務專員資源
RPC 服務專員介面 服務專員介面
C++ AgentsClient 不適用
C# AgentsClient 不適用
Go AgentsClient 不適用
Java AgentsClient AgentsClient
Node.js AgentsClient AgentsClient
PHP 不適用 不適用
Python AgentsClient AgentsClient
Ruby 不適用 不適用

REST

使用任何要求資料之前，請先替換以下項目：

  • PROJECT_ID：您的 Google Cloud 專案 ID
  • REGION_ID：您的區域 ID

HTTP 方法和網址：

POST https://REGION_ID-dialogflow.googleapis.com/v3/projects/PROJECT_ID/locations/REGION_ID/agents

JSON 要求主體：

{
  "displayName": "My display name",
  "defaultLanguageCode": "en",
  "timeZone": "America/New_York"
}

如要傳送要求，請展開以下其中一個選項：

您應該會收到如下的 JSON 回應：

{
  "name": "projects/PROJECT_ID/locations/REGION_ID/agents/AGENT_ID",
  "displayName": "My display name",
  "defaultLanguageCode": "en",
  "timeZone": "America/New_York",
  "startFlow": "projects/PROJECT_ID/locations/REGION_ID/agents/AGENT_ID/flows/00000000-0000-0000-0000-000000000000",
  "advancedSettings": {
    "loggingSettings": {}
  }
}

Java

如要向 Dialogflow 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。


import com.google.cloud.dialogflow.cx.v3.Agent;
import com.google.cloud.dialogflow.cx.v3.Agent.Builder;
import com.google.cloud.dialogflow.cx.v3.AgentsClient;
import com.google.cloud.dialogflow.cx.v3.AgentsSettings;
import java.io.IOException;

public class CreateAgent {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project-id";
    String displayName = "my-display-name";

    createAgent(projectId, displayName);
  }

  public static Agent createAgent(String parent, String displayName) throws IOException {

    String apiEndpoint = "global-dialogflow.googleapis.com:443";

    AgentsSettings agentsSettings = AgentsSettings.newBuilder().setEndpoint(apiEndpoint).build();
    // Note: close() needs to be called on the AgentsClient object to clean up resources
    // such as threads. In the example below, try-with-resources is used,
    // which automatically calls close().
    try (AgentsClient client = AgentsClient.create(agentsSettings)) {
      // Set the details of the Agent to create
      Builder build = Agent.newBuilder();

      build.setDefaultLanguageCode("en");
      build.setDisplayName(displayName);
      // Correct format for timezone is location/city
      // For example America/Los_Angeles, Europe/Madrid, Asia/Tokyo
      build.setTimeZone("America/Los_Angeles");

      Agent agent = build.build();
      String parentPath = String.format("projects/%s/locations/%s", parent, "global");

      // Calls the create agent api and returns the created Agent
      Agent response = client.createAgent(parentPath, agent);
      System.out.println(response);
      return response;
    }
  }
}

Node.js

如要向 Dialogflow 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。


const parent = 'projects/' + projectId + '/locations/global';

const api_endpoint = 'global-dialogflow.googleapis.com';

const agent = {
  displayName: displayName,
  defaultLanguageCode: 'en',
  timeZone: 'America/Los_Angeles',
};

const {AgentsClient} = require('@google-cloud/dialogflow-cx');

const client = new AgentsClient({apiEndpoint: api_endpoint});

async function setAgentSample() {
  const request = {
    agent,
    parent,
  };

  const [response] = await client.createAgent(request);
  console.log(`response: ${JSON.stringify(response, null, 2)}`);

  // Delete created agent resource
  client.deleteAgent({name: response.name});
}
await setAgentSample();

Python

如要向 Dialogflow 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

from google.cloud.dialogflowcx_v3.services.agents.client import AgentsClient
from google.cloud.dialogflowcx_v3.types.agent import Agent


def create_agent(project_id, display_name):
    parent = "projects/" + project_id + "/locations/global"

    agents_client = AgentsClient()

    agent = Agent(
        display_name=display_name,
        default_language_code="en",
        time_zone="America/Los_Angeles",
    )

    response = agents_client.create_agent(request={"agent": agent, "parent": parent})

    return response

刪除代理程式

下列範例說明如何為 Agent 型別呼叫 Delete 方法。

為代理程式參照選取通訊協定和版本：

通訊協定 V3 V3beta1
REST 服務專員資源 服務專員資源
RPC 服務專員介面 服務專員介面
C++ AgentsClient 不適用
C# AgentsClient 不適用
Go AgentsClient 不適用
Java AgentsClient AgentsClient
Node.js AgentsClient AgentsClient
PHP 不適用 不適用
Python AgentsClient AgentsClient
Ruby 不適用 不適用

REST

使用任何要求資料之前，請先替換以下項目：

  • PROJECT_ID：您的 Google Cloud 專案 ID
  • REGION_ID：您的區域 ID
  • AGENT_ID：您的代理程式 ID，可在代理程式建立回應中找到

HTTP 方法和網址：

DELETE https://REGION_ID-dialogflow.googleapis.com/v3/projects/PROJECT_ID/locations/REGION_ID/agents/AGENT_ID

如要傳送要求，請展開以下其中一個選項：

您應該會收到執行成功的狀態碼 (2xx) 和空白回應。

上一頁
實作 Webhook
下一頁
使用 API 管理網頁