フィルタを使用してデータを一覧表示する

API を使用してデータを一覧表示する場合、一部の list メソッド リクエストでは filter フィールドが指定されます。これらのフィルタを使用すると、関心のある結果のみを返すことができます。このフィルタリング機能は、多くの Google Cloud APIs で共通しています。

次の例は、テストケースの結果を一覧表示する際に、レスポンスをフィルタリングする方法を示しています。

Java

Dialogflow CX への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。

import com.google.cloud.dialogflow.cx.v3.ListTestCaseResultsRequest;
import com.google.cloud.dialogflow.cx.v3.ListTestCaseResultsRequest.Builder;
import com.google.cloud.dialogflow.cx.v3.TestCaseResult;
import com.google.cloud.dialogflow.cx.v3.TestCasesClient;
import com.google.cloud.dialogflow.cx.v3.TestCasesSettings;
import java.io.IOException;

public class ListTestCaseResults {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project-id";
    String agentId = "my-agent-id";
    String testId = "my-test-id";
    String location = "my-location";
    listTestCaseResults(projectId, agentId, testId, location);
  }

  public static void listTestCaseResults(
      String projectId, String agentId, String testId, String location) throws IOException {
    String parent =
        "projects/"
            + projectId
            + "/locations/"
            + location
            + "/agents/"
            + agentId
            + "/testCases/"
            + testId;

    Builder req = ListTestCaseResultsRequest.newBuilder();

    req.setParent(parent);
    req.setFilter("environment=draft");

    TestCasesSettings testCasesSettings =
        TestCasesSettings.newBuilder()
            .setEndpoint(location + "-dialogflow.googleapis.com:443")
            .build();

    // Note: close() needs to be called on the TestCasesClient object to clean up resources
    // such as threads. In the example below, try-with-resources is used,
    // which automatically calls close().
    try (TestCasesClient client = TestCasesClient.create(testCasesSettings)) {
      for (TestCaseResult element : client.listTestCaseResults(req.build()).iterateAll()) {
        System.out.println(element);
      }
    }
  }
}

Node.js

Dialogflow CX への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。

const parent = `projects/${projectId}/locations/${location}/agents/${agentId}/testCases/${testId}`;

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

const client = new TestCasesClient({
  apiEndpoint: 'global-dialogflow.googleapis.com',
});
const req = {
  parent,
  filter: 'environment=draft',
};

const res = await client.listTestCaseResults(req);

console.log(res);

Python

Dialogflow CX への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。

from google.cloud.dialogflowcx_v3.services.test_cases.client import TestCasesClient
from google.cloud.dialogflowcx_v3.types.test_case import ListTestCaseResultsRequest


def list_test_case(project_id, agent_id, test_id, location):
    req = ListTestCaseResultsRequest()
    req.parent = f"projects/{project_id}/locations/{location}/agents/{agent_id}/testCases/{test_id}"
    req.filter = "environment=draft"
    client = TestCasesClient(
        client_options={"api_endpoint": f"{location}-dialogflow.googleapis.com"}
    )
    # Makes a call to list all test case results that match filter
    result = client.list_test_case_results(request=req)
    print(result)
    return result