GoogleCloudDialogflowCxV3Example

import type { GoogleCloudDialogflowCxV3Example } from "https://googleapis.deno.dev/v1/dialogflow:v3.ts";

Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.

interface GoogleCloudDialogflowCxV3Example {

actions?: GoogleCloudDialogflowCxV3Action[];

conversationState?:

| "OUTPUT_STATE_UNSPECIFIED"

| "OUTPUT_STATE_OK"

| "OUTPUT_STATE_CANCELLED"

| "OUTPUT_STATE_FAILED"

| "OUTPUT_STATE_ESCALATED"

| "OUTPUT_STATE_PENDING";

readonly createTime?: Date;

description?: string;

displayName?: string;

languageCode?: string;

name?: string;

playbookInput?: GoogleCloudDialogflowCxV3PlaybookInput;

playbookOutput?: GoogleCloudDialogflowCxV3PlaybookOutput;

readonly tokenCount?: bigint;

readonly updateTime?: Date;

}

§Properties

actions?: GoogleCloudDialogflowCxV3Action[]

[src]

Required. The ordered list of actions performed by the end user and the Dialogflow agent.

[src]

Required. Example's output state.

readonly createTime?: Date

[src]

Output only. The timestamp of initial example creation.

description?: string

[src]

Optional. The high level concise description of the example. The max number of characters is 200.

displayName?: string

[src]

Required. The display name of the example.

languageCode?: string

[src]

Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents.

name?: string

[src]

The unique identifier of the playbook example. Format: projects//locations//agents//playbooks//examples/.

playbookInput?: GoogleCloudDialogflowCxV3PlaybookInput

[src]

Optional. The input to the playbook in the example.

playbookOutput?: GoogleCloudDialogflowCxV3PlaybookOutput

[src]

Optional. The output of the playbook in the example.

readonly tokenCount?: bigint

[src]

Output only. Estimated number of tokes current example takes when sent to the LLM.

readonly updateTime?: Date

[src]

Output only. Last time the example was updated.