Skip to content

AI

Bases: DuploResourceV3

Resource for creating tickets in the DuploCloud AI HelpDesk.

Commands

apply

Apply a AI

Create or Update a AI resource with Duplocloud cli.

CLI Usage

duploctl ai apply -f 'ai.yaml'
Contents of the ai.yaml file

Returns:

Name Type Description
message dict

Success message.

Parameters:

--file, -f, --cli-input
A file to read the input from
FileType('r') action: YamlAction
--patches, --add, --remove, --copy, --replace, --test, --move
The json patch to apply
str action: JsonPatchAction

create

Create a AI resource.

CLI Usage

duploctl ai create -f 'ai.yaml'
Contents of the ai.yaml file

One liner example
echo """
""" | duploctl ai create -f -

Returns:

Name Type Description
message dict

Success message.

Raises:

Type Description
DuploError

If the resource could not be created.

Parameters:

--file, -f, --cli-input
A file to read the input from
FileType('r') action: YamlAction

create_ticket

Create DuploCloud AI ticket.

Create a ticket in the DuploCloud AI HelpDesk.

Usage
duploctl ai create_ticket --title <title> --content <content> --agent_name <agent name> --instance_id <instance id> [--origin <origin>] [--api_version v1]
Create DuploCloud AI helpdesk ticket

Run this command Create a ticket for a failed build pipeline in test environment.

duploctl ai create_ticket \
  --title "Build pipeline failed for release-2025.07.10" \
  --content "Build pipeline failed at unit test stage with error ..." \
  --agent_name "cicd" \
  --instance_id "cicd" \
  --origin "pipelines" \
  --api_version v1

Returns:

Name Type Description
ticket_response dict

A dictionary containing the following keys: ticketname : The name of the created AI helpdesk ticket. ai_response: The AI agent's response object or message content returned from the service. chat_url: The URL to the helpdesk chat interface for the created ticket.

Parameters:

--title, --title required
The Title for ticket
str
--agent_name, --agent_name, --agent required
AI Agent to be used to process the ticket
str
--instance_id, --instance_id, --instance required
AI Agent Instance Id
str
--message, --content, --msg, --message
The message you want to send to the AI agent
str
--helpdesk_origin, --helpdesk-origin, --origin
The helpdesk origin to use for the ticket
str
--api_version, --api-version
API Version
str default: v1

delete

Delete a AI resource by name.

cli usage
duploctl ai delete <name>

Returns:

Name Type Description
message dict

A success message.

Raises:

Type Description
DuploError

If the {{kind}} resource could not be found or deleted.

Parameters:

name positional
The resource name
str

find

Find AI resources by name.

cli usage
duploctl ai find <name>

Returns:

Name Type Description
resource dict

The AI object.

Raises:

Type Description
DuploError

If the {{kind}} could not be found.

Parameters:

name positional
The resource name
str

list

Retrieve a List of AI resources

cli usage
duploctl ai list

Returns:

Name Type Description
list list

A list of AI.

send_message

Send DuploCloud AI Message.

Send a message to an existing ticket in the DuploCloud AI HelpDesk.

Usage
duploctl ai send_message --ticket_id <ticket id> --content <content>
Send a message to an AI helpdesk ticket

Run this command to send a message to ai helpdesk ticket.

duploctl ai send_message \
  --ticket_id "andy-250717131532" \
  --content "My app is still failing after restarting the pod." \
  --api_version v1

Returns:

Name Type Description
chat_response dict

A dictionary containing the following keys: ai_response: The AI agent's response object or message content returned from the service. chat_url: The URL to the helpdesk chat interface for the specified ticket.

Parameters:

--ticket_id, --ticket_id, --ticket required
The ID of the AI HelpDesk ticket
str
--message, --content, --msg, --message
The message you want to send to the AI agent
str
--api_version, --api-version
API Version
str default: v1

update

Update a V3 resource by name.

Returns:

Name Type Description
message

Success message.

Raises:

Type Description
DuploError

If the resource could not be created.

Parameters:

name positional
The resource name
str
--file, -f, --cli-input
A file to read the input from
FileType('r') action: YamlAction
--patches, --add, --remove, --copy, --replace, --test, --move
The json patch to apply
str action: JsonPatchAction