Skip to content

RavenDB-25962 - Document DeleteAgent method in AI agents Client API #2336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ppekrol wants to merge 1 commit into
base: main
Choose a base branch
from
Open

RavenDB-25962 - Document DeleteAgent method in AI agents Client API #2336

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions ...gration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-csharp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import ContentFrame from "@site/src/components/ContentFrame";
* [Action tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tools)
* [Creating the Agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-the-agent)
* [Retrieving existing agent configurations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#retrieving-existing-agent-configurations)
* [Deleting an agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#deleting-an-agent)
* [Managing conversations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#managing-conversations)
* [Setting a conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-a-conversation)
* [Processing action-tool requests](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#processing-action-tool-requests)
Expand Down Expand Up @@ -745,6 +746,36 @@ You can also retrieve the configurations of **all existing agents** using `GetAg

</Panel>

<Panel heading="Deleting an agent">

You can delete an existing AI agent from the database using the `DeleteAgent` method.

* **Example**
```csharp
// Delete an agent by its ID
var deleteResult = await store.AI.DeleteAgentAsync("reward-productive-employee");
```

* `DeleteAgent` Overloads
```csharp
// Synchronously deletes an AI agent from the database
AiAgentConfigurationResult DeleteAgent(string agentId)

// Asynchronously deletes an AI agent from the database
Task<AiAgentConfigurationResult> DeleteAgentAsync(string agentId, CancellationToken token = default)
```

* `DeleteAgent` Properties
| Property | Type | Description |
|----------|------|-------------|
| agentId | `string` | The ID of the AI agent to delete |

| Return value | Description |
|--------------|-------------|
| `AiAgentConfigurationResult` | The result of the delete operation |

</Panel>

<Panel heading="Managing conversations">

<ContentFrame>
Expand Down
Loading