Interface ChainOfThoughtStep

This schema is in beta. A chain of thought step is meant to show tool calls and other steps made by your agent to reach its final answer.

interface ChainOfThoughtStep {
    description?: string;
    request?: { args?: unknown };
    response?: { content: unknown };
    status?: ChainOfThoughtStepStatus;
    title?: string;
    tool_name?: string;
}

Properties

description? request? response? status? title? tool_name?

Properties

Optionaldescription

description?: string

An optional human readable description of what the tool does.

Accepts markdown formatted text.

Optionalrequest

request?: { args?: unknown }

Optional request metadata sent to a tool.

Type declaration

  • Optionalargs?: unknown

    Arguments sent to the tool. If this is properly formed JSON, it will be shown as a code block.

Optionalresponse

response?: { content: unknown }

Optional response from a tool.

Type declaration

  • content: unknown

    Content returned by the tool. If this is properly formed JSON, it will be shown as a code block.

    You can also return markdown compatible text here.

Optionalstatus

status?: ChainOfThoughtStepStatus

Optionally, share the status of this step. An icon will appear in the view showing the status. If no status is shared, the UI will assume success.

Optionaltitle

title?: string

The plain text name of the step.

Optionaltool_name

tool_name?: string

The plain text name of the tool called.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR