Skip to content

Commit cd267f4

Browse files
committed
RDoc-3682 fix links
1 parent 4e9c6a0 commit cd267f4

2 files changed

Lines changed: 103 additions & 103 deletions

File tree

docs/ai-integration/ai-agents/creating-ai-agents/content/_creating-ai-agents_api-csharp.mdx

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,26 @@ import Panel from "@site/src/components/Panel";
1616
and perform actions based on LLM insights.
1717

1818
* This article provides a step-by-step guide to creating an AI agent and interacting with it using the **Client API**.
19-
To create an AI agent from Studio, see [Creating AI agents - Studio](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio).
19+
To create an AI agent from Studio, see [Creating AI agents - Studio](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio).
2020

2121
* In this article:
22-
* [Create a connection string](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#creating-a-connection-string)
23-
* [Define the agent](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#defining-an-agent-configuration)
24-
* [Add agent tools](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#adding-agent-tools)
25-
* [Query tools](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#query-tools)
26-
* [Action tools](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#action-tools)
27-
* [Create the agent](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#creating-the-agent)
28-
* [Manage conversations](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#managing-conversations)
29-
* [Create a conversation](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#setting-a-conversation)
30-
* [Process action-tool requests](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#processing-action-tool-requests)
31-
* [Action-tool handlers](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#action-tool-handlers)
32-
* [Action-tool receivers](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#action-tool-receivers)
33-
* [Set user prompt and RUN the conversation](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#setting-user-prompt-and-running-the-conversation)
34-
* [Handle the conversation response](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#conversation-response)
35-
* [Stream LLM responses](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#stream-llm-responses)
36-
* [Full example](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#full-example)
37-
* [Retrieve existing agents](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#retrieving-existing-agent-configurations)
38-
* [Syntax](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#syntax)
22+
* [Create a connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-a-connection-string)
23+
* [Define the agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#defining-an-agent-configuration)
24+
* [Add agent tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#adding-agent-tools)
25+
* [Query tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#query-tools)
26+
* [Action tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tools)
27+
* [Create the agent](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-the-agent)
28+
* [Manage conversations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#managing-conversations)
29+
* [Create a conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-a-conversation)
30+
* [Process action-tool requests](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#processing-action-tool-requests)
31+
* [Action-tool handlers](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-handlers)
32+
* [Action-tool receivers](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-receivers)
33+
* [Set user prompt and RUN the conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-user-prompt-and-running-the-conversation)
34+
* [Handle the conversation response](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#conversation-response)
35+
* [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses)
36+
* [Full example](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#full-example)
37+
* [Retrieve existing agents](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#retrieving-existing-agent-configurations)
38+
* [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax)
3939

4040
</Admonition>
4141

@@ -44,9 +44,9 @@ import Panel from "@site/src/components/Panel";
4444

4545
Your agent will need a connection string to connect to a **conversational or text generation LLM**.
4646
RavenDB supports the following providers for these model types:
47-
[Ollama](../../../ai-integration/connection-strings/ollama),
48-
[OpenAI and compatible providers](../../../ai-integration/connection-strings/open-ai),
49-
and [Azure OpenAI](../../../ai-integration/connection-strings/azure-open-ai).
47+
[Ollama](../../../../ai-integration/connection-strings/ollama),
48+
[OpenAI and compatible providers](../../../../ai-integration/connection-strings/open-ai),
49+
and [Azure OpenAI](../../../../ai-integration/connection-strings/azure-open-ai).
5050

5151
Choose the model that best suits your needs:
5252
You can use a local _Ollama_ model if your priorities are speed, cost, open-source usage, or security.
@@ -57,9 +57,9 @@ Or use a remote _OpenAI_ service for its broader resources and capabilities.
5757

5858
* **From the Studio**:
5959
You can define a connection string in the _AI Connection Strings_ view.
60-
See [AI connection strings - Overview](../../../ai-integration/connection-strings/overview).
60+
See [AI connection strings - Overview](../../../../ai-integration/connection-strings/overview).
6161
You can also create a connection string when defining an AI agent.
62-
See [Configure basic settings](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio#configure-basic-settings).
62+
See [Configure basic settings](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_studio.mdx#configure-basic-settings).
6363

6464
---
6565

@@ -158,9 +158,9 @@ using (var store = new DocumentStore())
158158

159159
**Syntax reference**
160160
See the dedicated syntax sections in the following articles for full configuration details:
161-
* [Ollama (syntax)](../../../ai-integration/connection-strings/ollama#syntax)
162-
* [OpenAI and compatible providers (syntax)](../../../ai-integration/connection-strings/open-ai#syntax)
163-
* [Azure OpenAI (syntax)](../../../ai-integration/connection-strings/azure-open-ai#syntax)
161+
* [Ollama (syntax)](../../../../ai-integration/connection-strings/ollama.mdx#syntax)
162+
* [OpenAI and compatible providers (syntax)](../../../../ai-integration/connection-strings/open-ai.mdx#syntax)
163+
* [Azure OpenAI (syntax)](../../../../ai-integration/connection-strings/azure-open-ai.mdx#syntax)
164164

165165
</Panel>
166166

@@ -178,14 +178,14 @@ See the dedicated syntax sections in the following articles for full configurati
178178

179179
* Populate the `AiAgentConfiguration` instance with your system prompt, agent settings, and tools.
180180
The following sections explain how to configure each component of the agent:
181-
* [System prompt](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#system-prompt)
182-
* [Agent name](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#agent-name)
183-
* [Agent ID](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#agent-id)
184-
* [Connection string](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#connection-string)
185-
* [Expected response format](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#expected-response-format)
186-
* [Agent parameters](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#agent-parameters)
187-
* [Maximum number of iterations](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#maximum-number-of-iterations)
188-
* [Chat trimming configuration](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#chat-trimming-configuration)
181+
* [System prompt](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#system-prompt)
182+
* [Agent name](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-name)
183+
* [Agent ID](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-id)
184+
* [Connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#connection-string)
185+
* [Expected response format](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#expected-response-format)
186+
* [Agent parameters](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-parameters)
187+
* [Maximum number of iterations](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#maximum-number-of-iterations)
188+
* [Chat trimming configuration](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#chat-trimming-configuration)
189189

190190
---
191191

@@ -240,7 +240,7 @@ agentConfiguration.Identifier = "reward-productive-employee";
240240
<ContentFrame>
241241
### Connection string
242242

243-
Provide the name of the connection string you created above in [Create a connection string](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#creating-a-connection-string).
243+
Provide the name of the connection string you created above in [Create a connection string](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#creating-a-connection-string).
244244

245245
```csharp
246246
agentConfiguration.ConnectionStringName = connectionString.Name;
@@ -321,9 +321,9 @@ agentConfiguration.OutputSchema = @"
321321
Agent parameters let you define named placeholders for values used in queries inside query tools.
322322

323323
At configuration time, you define the parameter name (e.g. `country`),
324-
which you can then use in the RQL of your [query tools](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#query-tools) as a placeholder (e.g. `$country`).
324+
which you can then use in the RQL of your [query tools](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#query-tools) as a placeholder (e.g. `$country`).
325325
The values for these parameters are Not set by the LLM -
326-
you must provide the actual value at [conversation startup](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#setting-a-conversation).
326+
you must provide the actual value at [conversation startup](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-a-conversation).
327327

328328
When the agent is requested to execute a query that references an agent parameter,
329329
it replaces each placeholder with the corresponding value you supplied at chat startup, before running the query.
@@ -362,8 +362,8 @@ agentConfiguration.MaxModelIterationsPerCall = 3;
362362
<Admonition type="note" title="">
363363
* Note that you can reduce Time To First Byte (TTFB) by streaming the LLM response as it's being generated.
364364
This allows the LLM to return selected fields in chunks before the full response is complete.
365-
* Find more about streaming in [Streaming LLM responses - overview](../../../ai-integration/ai-agents/overview#streaming-llm-responses)
366-
and in [Stream LLM responses](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#stream-llm-responses) below.
365+
* Find more about streaming in [Streaming LLM responses - overview](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses)
366+
and in [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses) below.
367367
</Admonition>
368368

369369
</ContentFrame>
@@ -424,19 +424,19 @@ agentConfiguration.ChatTrimming =
424424

425425
### Query tools
426426

427-
* [Query tools](../../../ai-integration/ai-agents/overview#query-tools) provide the LLM with the ability to retrieve data from the database.
427+
* [Query tools](../../../../ai-integration/ai-agents/overview.mdx#query-tools) provide the LLM with the ability to retrieve data from the database.
428428
Each query tool includes:
429429
* **Description** - a natural-language description that tells the LLM when to use it,
430-
* **RQL** - an [RQL query](../../../client-api/session/querying/what-is-rql) that defines what data to retrieve.
430+
* **RQL** - an [RQL query](../../../../querying/rql/what-is-rql.mdx) that defines what data to retrieve.
431431

432432
* To run a query tool at agent startup and provide initial context to the LLM **before** the conversation begins,
433-
see: [Initial-context queries](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#initial-context-queries) below.
433+
see: [Initial-context queries](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#initial-context-queries) below.
434434

435435
* **Passing values to a query tool**
436436
The RQL in the query tool may include parameter placeholders prefixed with `$` (e.g. `$country`).
437437
Both the user and the LLM can pass values to these parameters.
438438
* **Passing values from the user**:
439-
Users can pass values to queries through [Agent parameters](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#agent-parameters).
439+
Users can pass values to queries through [Agent parameters](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#agent-parameters).
440440
If agent parameters are defined in the agent configuration -
441441
* The client must provide values for them when initiating a conversation with the agent.
442442
* Before executing the query, the agent will replace the placeholders with the provided values.
@@ -519,7 +519,7 @@ agentConfiguration.ChatTrimming =
519519

520520
#### <u>Initial-context queries</u>
521521

522-
* Use the `Options.AddToInitialContext` property to configure a query tool as an [initial-context query](../../../ai-integration/ai-agents/overview#initial-context-queries)
522+
* Use the `Options.AddToInitialContext` property to configure a query tool as an [initial-context query](../../../../ai-integration/ai-agents/overview.mdx#initial-context-queries)
523523
so that it executes immediately when the agent starts, before the LLM receives any user input.
524524
The results are provided to the LLM as part of the initial conversation context.
525525

@@ -653,7 +653,7 @@ agentConfiguration.ChatTrimming =
653653
* Conversation creation options - including values for any agent parameters, if defined.
654654

655655
* The object returned by the `Conversation` method is used to run the conversation.
656-
See [Set user prompt and run the conversation](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#setting-user-prompt-and-running-the-conversation).
656+
See [Set user prompt and run the conversation](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#setting-user-prompt-and-running-the-conversation).
657657

658658
* **Example**
659659
<TabItem>
@@ -676,7 +676,7 @@ agentConfiguration.ChatTrimming =
676676

677677
* **Start a new conversation**
678678
To start a new conversation, provide a prefix ending with `/` or `|` (e.g., `Performers/`).
679-
RavenDB will auto-generate the rest of the conversation document ID (see [document ID generation](../../../server/kb/document-identifier-generation)).
679+
RavenDB will auto-generate the rest of the conversation document ID (see [document ID generation](../../../../server/kb/document-identifier-generation)).
680680

681681
* **Resume an existing conversation**
682682
To resume an existing conversation, provide the full ID of an existing conversation document
@@ -696,8 +696,8 @@ agentConfiguration.ChatTrimming =
696696
When this happens, the agent forwards the tools name and parameters to the client -
697697
and its up to the client to handle the request.
698698

699-
* The client can process an action-tool request using either a [Handler](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#action-tool-handlers)
700-
or a [Receiver](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#action-tool-receivers).
699+
* The client can process an action-tool request using either a [Handler](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-handlers)
700+
or a [Receiver](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#action-tool-receivers).
701701

702702
---
703703

@@ -909,7 +909,7 @@ if (response.Status == AiConversationResult.Done)
909909

910910
<Admonition type="note" title="">
911911
Instead of `Run` or `RunAsync`, you can use `StreamAsync` to **stream** the LLM's response as it is generated.
912-
See [Stream LLM responses](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#stream-llm-responses).
912+
See [Stream LLM responses](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#stream-llm-responses).
913913
</Admonition>
914914

915915
</ContentFrame>
@@ -935,8 +935,8 @@ See [Stream LLM responses](../../../ai-integration/ai-agents/creating-ai-agents/
935935
The conversation requires further interaction.
936936
For example, the LLM may have triggered a tool request, and the conversation is paused until the client processes it.
937937

938-
* See [Return value of Run & Stream](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#return-value-of--run----stream)
939-
in the [Syntax](../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api#syntax) section below.
938+
* See [Return value of Run & Stream](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#return-value-of--run----stream)
939+
in the [Syntax](../../../../ai-integration/ai-agents/creating-ai-agents/creating-ai-agents_api.mdx#syntax) section below.
940940

941941
</ContentFrame>
942942

@@ -945,7 +945,7 @@ See [Stream LLM responses](../../../ai-integration/ai-agents/creating-ai-agents/
945945
### Stream LLM responses
946946

947947
* Instead of calling `Run` / `RunAsync`, which returns the LLM's response to the client when it is fully prepared,
948-
you can call `StreamAsync` to [Stream llm responses](../../../ai-integration/ai-agents/overview#streaming-llm-responses),
948+
you can call `StreamAsync` to [Stream llm responses](../../../../ai-integration/ai-agents/overview.mdx#streaming-llm-responses),
949949
and receive the LLM's response in real time as it is being generated.
950950

951951
* Streaming allows the client to start processing the response before it is complete,

0 commit comments

Comments
 (0)