Skip to content

Commit bcbdd41

Browse files
reebhubmateuszbartosik
authored andcommitted
AI start pages - changed by review comments
1 parent 49cd751 commit bcbdd41

File tree

3 files changed

+19
-51
lines changed

3 files changed

+19
-51
lines changed

docs/ai-integration/ai-integration_start.mdx

Lines changed: 9 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "AI Integration: Start"
33
hide_table_of_contents: true
4-
sidebar_label: Start
4+
sidebar_label: "Start"
55
sidebar_position: 0
66
---
77

@@ -26,19 +26,11 @@ These features include [AI agents](../ai-integration/ai-integration_start#ai-age
2626
<br />
2727

2828
### AI agents
29-
AI agents are server-side components that act as secure proxies between RavenDB clients and AI models. They can be easily customized to handle specific client needs, tasks or workflows, such as answering questions, performing data analysis, or automating processes.
30-
- Using AI agents frees developers from the need to manage the communication with the AI model in their code, and enables rapid integration of AI capabilities into their applications.
31-
- An agent receives requests from clients and maintains continuous conversations with AI models to fulfill them. During the conversation, the agent can enable the model to securely query a RavenDB database (e.g., fetch recent orders or run vector searches on products) and request the client to perform actions (like sending emails or creating new orders).
32-
- You can use AI agents to quickly create an intelligent, actionable, conversational interface for your applications, in a way that abstracts much of the complexity of AI integration.
3329

34-
<Admonition type="note" title="">
35-
See common AI agents use cases:
30+
AI agents are conversational proxy components that reside on the server and autonomously handle client requests using an AI model. Instead of spending your time on integrating AI capabilities into your application, you can rapidly configure AI agents using Studio or the client API. Agents can securely read from the database and request the client for actions on behalf of the AI model, infusing intelligence into the workflow. Whether you need chatbots, automated reporting, or intelligent data processing, you get immediate production-ready AI features without the integration overhead.
3631

37-
[Customer support chatbot agents](../ai-integration/ai-agents/ai-agents_overview#customer-support-chatbot-agents)
38-
[Data analysis and reporting agents](../ai-integration/ai-agents/ai-agents_overview#data-analysis-and-reporting-agents)
39-
[Content generation agents](../ai-integration/ai-agents/ai-agents_overview#content-generation-agents)
40-
[Workflow automation agents](../ai-integration/ai-agents/ai-agents_overview#workflow-automation-agents)
41-
[Intelligent recommendation agents](../ai-integration/ai-agents/ai-agents_overview#intelligent-recommendation-agents)
32+
<Admonition type="note" title="">
33+
[See common AI agents use cases](../ai-integration/ai-agents/ai-agents_start#use-cases)
4234
</Admonition>
4335

4436
<Admonition type="note" title="">
@@ -58,22 +50,10 @@ See common AI agents use cases:
5850
<br />
5951

6052
### GenAI tasks
61-
GenAI tasks are [ongoing operations](../studio/database/tasks/ongoing-tasks/general-info) that continuously monitor specified collections and process documents as they are added or modified.
62-
- Similar to [ETL tasks](../studio/database/tasks/ongoing-tasks/ravendb-etl-task), a GenAI task extracts content from documents. But instead of sending the content to another database, the task sends it to an AI model (like OpenAI) along with a guiding **prompt** and a **JSON schema** that defines the layout for the model's response.
63-
- When the LLM responds, the GenAI task can use its response to, for example, update the source document with LLM-generated content, or create new documents in the database.
64-
- GenAI tasks can infuse intelligence into a wide variety of content handling scenarios.
65-
E.g., they can enrich documents with AI-generated summaries or classifications, translate text into different languages, or generate new content based on existing data.
66-
- You can easily create GenAI tasks using Studio or the client API.
67-
When created via Studio, each step of their creation can be easily tested and validated before deployment.
53+
GenAI tasks are configurable [ongoing operations](../studio/database/tasks/ongoing-tasks/general-info) that process your documents systematically in the background using an AI model. Instead of building custom AI integration pipelines yourself, you can easily create tasks that weave AI capabilities into your data flow. They can enrich documents with AI-generated content, validate and categorize data, translate documents, or execute countless other automated workflows that leverage AI capabilities.
6854

6955
<Admonition type="note" title="">
70-
See common GenAI tasks use cases:
71-
72-
[Data enrichment & enhancement use cases](../ai-integration/gen-ai-integration/gen-ai-overview#data-enrichment--enhancement-use-cases)
73-
[Smart automation & workflows use cases](../ai-integration/gen-ai-integration/gen-ai-overview#smart-automation--workflows-use-cases)
74-
[Enhanced search & discovery use cases](../ai-integration/gen-ai-integration/gen-ai-overview#enhanced-search--discovery-use-cases)
75-
[Business intelligence & insights use cases](../ai-integration/gen-ai-integration/gen-ai-overview#business-intelligence--insights-use-cases)
76-
[Content analysis & moderation use cases](../ai-integration/gen-ai-integration/gen-ai-overview#content-analysis--moderation-use-cases)
56+
[See common GenAI tasks use cases](../ai-integration/gen-ai-integration/gen-ai_start#use-cases)
7757
</Admonition>
7858

7959
<Admonition type="note" title="">
@@ -93,11 +73,7 @@ See common GenAI tasks use cases:
9373
<br />
9474

9575
### Embeddings generation
96-
[Embeddings](https://en.wikipedia.org/wiki/Embedding_(machine_learning)) are numeric vectors that you can create for data (like a text or an image) to capture meanings, contexts, or relationships related to the data. You can then search the data by running intelligent queries over its embeddings using [vector search](../../ai-integration/vector-search/vector-search_start) to find content by semantic similarity rather than exact matches.
97-
- RavenDB allows you to create embeddings using native [ongoing embeddings-generation tasks](../../ai-integration/generating-embeddings/embeddings-generation-task) that systematically process document collections and convert document fields (like texts or arrays) into embeddings. To create the embeddings, the tasks can use either an external AI model (such as OpenAI) or RavenDB's default embedding model.
98-
- You can also create embeddings using external embeddings providers and store them in your database (e.g., to handle other content types such as images).
99-
- You can avoid pre-generating embeddings, and let vector search operations generate embeddings on-the-fly, while searching.
100-
- Embeddings can be used by other RavenDB AI features, e.g., [AI agents](../../ai-integration/ai-agents/ai-agents_start) can use vector search to retrieve relevant data requested by the LLM.
76+
Embeddings generation tasks transform your content into semantic vectors that enable intelligent similarity-based searches. Instead of building complex search infrastructure, you can leverage native tasks that seamlessly embed vector capabilities into your data, enabling intelligent search by meaning and context.
10177

10278
<Admonition type="note" title="">
10379
[See common embeddings-generation use cases](../ai-integration/generating-embeddings/embeddings-generation_start#use-cases)
@@ -120,19 +96,10 @@ See common GenAI tasks use cases:
12096
<br />
12197

12298
### Vector search
123-
[Vector search](../ai-integration/vector-search/vector-search_start) operations let you find related content by comparing embeddings, e.g. to find texts by meaning or images by context.
124-
- When running a vector search, your query is converted into an embedding and compared against document embeddings. The document embeddings can be either pre-generated (by an embeddings-generation task or an external provider) or generated on-the-fly while searching.
125-
- You can run vector search using either a dynamic query for ad-hoc or infrequent searches or a static index for optimized performance.
126-
- Vector search is designed so other RavenDB AI features can easily use it. A [GenAI task](../ai-integration/gen-ai-integration/gen-ai_start), for example, can use vector search to find documents and update them with LLM-generated content, and an [AI agent](../ai-integration/ai-agents/ai-agents_start) can use vector search to retrieve relevant data requested by the LLM.
99+
Vector search enables intelligent similarity-based discovery using embeddings rather than exact matching. Instead of developing custom similarity algorithms yourself, you can leverage native vector operations for diverse applications. Whether you need to categorize content, find similar items, or automate recommendations, vector search delivers intelligent matching capabilities that understand meaning and context.
127100

128101
<Admonition type="note" title="">
129-
See common vector search use cases:
130-
131-
[Document & Knowledge Search](../ai-integration/vector-search/vector-search_start#document--knowledge-search)
132-
[Product & Content Recommendation](../ai-integration/vector-search/vector-search_start#product--content-recommendation)
133-
[Customer Support Automation](../ai-integration/vector-search/vector-search_start#customer-support-automation)
134-
[Business Intelligence](../ai-integration/vector-search/vector-search_start#business-intelligence)
135-
[Media & Content Analysis](../ai-integration/vector-search/vector-search_start#media--content-analysis)
102+
[See common vector search use cases](../ai-integration/vector-search/vector-search_start#use-cases)
136103
</Admonition>
137104

138105
<Admonition type="note" title="">

docs/ai-integration/generating-embeddings/embeddings-generation_start.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ import embedGenStartStudioImage from "./assets/embeddings-generation_start_studi
1818
# Generating embeddings
1919
### Create embeddings to enable AI-powered similarity search.
2020

21-
[Embeddings](https://en.wikipedia.org/wiki/Embedding_(machine_learning)) are numeric vectors that you can create for data (like a text or an image) to capture meanings, contexts, or relationships related to the data. You can then search the data by running intelligent queries over its embeddings using [vector search](../../ai-integration/vector-search/vector-search_start) to find content by semantic similarity rather than exact matches.
22-
- RavenDB allows you to create embeddings using native [ongoing embeddings-generation tasks](../../ai-integration/generating-embeddings/embeddings-generation-task) that systematically process document collections and convert document fields (like texts or arrays) into embeddings. To create the embeddings, the tasks can use either an external AI model (such as OpenAI) or RavenDB's default embedding model.
23-
- You can also create embeddings using external embeddings providers and store them in your database (e.g., to handle other content types such as images).
24-
- You can avoid pre-generating embeddings, and let vector search operations generate embeddings on-the-fly, while searching.
25-
- Embeddings can be used by other RavenDB AI features, e.g., [AI agents](../../ai-integration/ai-agents/ai-agents_start) can use vector search to retrieve relevant data requested by the LLM.
21+
[Embeddings](https://en.wikipedia.org/wiki/Embedding_(machine_learning)) are numeric vectors that you can create for data (like a text or an image) to capture meanings, contexts, or relationships related to the data. You can then search the data by running intelligent queries over its embeddings using [vector search](../../ai-integration/vector-search/vector-search_start) to find content by similarity rather than exact match.
22+
- RavenDB allows you to create embeddings using native [ongoing embeddings-generation tasks](../../ai-integration/generating-embeddings/embeddings-generation-task) that systematically process document collections and convert document fields (like texts or arrays) into embeddings. To create the embeddings, the tasks can use either an external AI model (such as OpenAI) or RavenDB's default embedding model.
23+
- You can also create embeddings using external embeddings providers and store them in your database (e.g., to handle other content types such as images).
24+
- You can avoid pre-generating embeddings, and let vector search operations generate embeddings on-the-fly, while searching.
25+
- Embeddings can be used by other RavenDB AI features. E.g., [AI agents](../../ai-integration/ai-agents/ai-agents_start) can use vector search to retrieve relevant data requested by the LLM.
2626
- [See common embeddings-generation use cases](../../ai-integration/generating-embeddings/embeddings-generation_start#use-cases)
2727

2828
## Technical documentation

docs/ai-integration/vector-search/vector-search_start.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ import vectorSearchStartStaticIndexImage from "./assets/vector-search_start_stat
1717
# Vector search
1818
### Search by meaning and context using vector search operations.
1919

20-
Vector search operations allow you to compare [Embeddings](https://en.wikipedia.org/wiki/Embedding_(machine_learning)) to find content by proximity rather than by exact matches, e.g. to find text by meaning or image by context.
21-
You can search over embeddings that were generated by RavenDB [ongoing embeddings-generation tasks](../../ai-integration/generating-embeddings/embeddings-generation-task) or by an external embeddings provider, or generate the embeddings for your documents on-the-fly while searching.
22-
- When you run a vector search, your search query is converted into an embedding as well, and can be compared against document embeddings using either a dynamic query for ad-hoc or infrequent searches or a static index for optimized performance.
23-
- Vector search can be used by other RavenDB AI features. For example, [GenAI tasks](../../ai-integration/gen-ai-integration/gen-ai_start) can use vector search to find documents and update them with LLM-generated content, or [AI agents](../../ai-integration/ai-agents/ai-agents_start) can use vector search to retrieve relevant data requested by the LLM.
20+
Vector search operations allow you to compare [Embeddings](https://en.wikipedia.org/wiki/Embedding_(machine_learning)) to find content by similarity rather than by exact matches. E.g., to find text by meaning or image by context.
21+
- You can search over embeddings that were generated by RavenDB [ongoing embeddings-generation tasks](../../ai-integration/generating-embeddings/embeddings-generation-task) or by an external embeddings provider.
22+
- You can also generate the embeddings for your documents on-the-fly, while searching.
23+
- When you run a vector search, your search query is converted into an embedding as well, and compared against document embeddings using either a dynamic query for ad-hoc or infrequent searches, or a static index for optimized performance.
24+
- Vector search can be used by other RavenDB AI features. E.g., [AI agents](../../ai-integration/ai-agents/ai-agents_start) can use vector search to retrieve relevant data requested by the LLM.
2425
- [See common vector search use cases](../../ai-integration/vector-search/vector-search_start#use-cases)
2526

2627
## Technical documentation

0 commit comments

Comments
 (0)