Skip to content

Commit a0369da

Browse files
authored
Merge pull request #2316 from Danielle9897/RDoc-3737-genEmbeddings-fixStartPage
RDoc-3737 Generate Embeddings: Fix "Start" page
2 parents 2ee88b7 + 37f9e00 commit a0369da

File tree

2 files changed

+54
-88
lines changed
  • docs/ai-integration/generating-embeddings
  • versioned_docs/version-7.1/ai-integration/generating-embeddings

2 files changed

+54
-88
lines changed

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

Lines changed: 27 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,10 @@ import CardWithImage from "@site/src/components/Common/CardWithImage";
99
import CardWithImageHorizontal from "@site/src/components/Common/CardWithImageHorizontal";
1010
import ColGrid from "@site/src/components/ColGrid";
1111

12-
import embedGenStartApiImage from "./assets/embeddings-generation_start_api-image.png";
13-
import embedGenStartStudioImage from "./assets/embeddings-generation_start_studio-image.png";
14-
import aiSearchArticleImage from "./assets/ai-search-article-cover.webp";
12+
import aiSearchImage from "./assets/ai-search-article-cover.webp";
13+
import webinarImage from "@site/static/img/webinar.webp";
14+
import discordImage from "@site/static/img/discord-lg.webp";
1515

16-
import ayendeBlogImage from "@site/static/img/from-ayende-com.webp";
17-
import webinarThumbnailPlaceholder from "@site/static/img/webinar.webp";
18-
import discordLargeThumbnailPlaceholder from "@site/static/img/discord-lg.webp";
19-
20-
<Admonition type="note" title="">
21-
2216
### Create embeddings to enable AI-powered similarity search.
2317

2418
* [Embeddings](https://en.wikipedia.org/wiki/Embedding_(machine_learning)) are numeric vectors that represent the meaning, context, or relationships within the data (e.g., text or images).
@@ -38,77 +32,66 @@ import discordLargeThumbnailPlaceholder from "@site/static/img/discord-lg.webp";
3832
* Embeddings also power other AI features in RavenDB, such as [GenAI](../../ai-integration/gen-ai-integration/start.mdx) and [AI agents](../../ai-integration/ai-agents/start.mdx),
3933
which may use vector search queries to retrieve relevant documents in response to LLM requests.
4034

41-
* On this start page, you'll find:
42-
* [Use cases](../../ai-integration/generating-embeddings/start.mdx#use-cases)
43-
* [Technical documentation links](../../ai-integration/generating-embeddings/start.mdx#technical-documentation-links-)
44-
* [Related in-depth articles](../../ai-integration/generating-embeddings/start.mdx#related-in-depth-articles)
45-
* [Related lives & videos](../../ai-integration/generating-embeddings/start.mdx#related-lives--videos)
46-
47-
</Admonition>
48-
49-
---
50-
5135
### Use cases
5236

5337
Embeddings-generation tasks can prepare your data for AI-powered search, analysis, and retrieval.
5438
Common use cases include:
5539

56-
* **Enterprise knowledge bases**
57-
Generate embeddings for thousands of documents, policies, and procedures to enable fast, semantic search.
58-
* **Legal document libraries**
59-
Process case law, contracts, and regulations to build a searchable legal knowledge base.
60-
* **Product catalogs**
61-
Convert product descriptions, specifications, and reviews into embeddings for intelligent e-commerce search and recommendations.
62-
* **Content management systems**
63-
Transform blog posts, articles, and marketing materials into searchable vector embeddings.
64-
65-
---
40+
* Generate embeddings for thousands of documents, policies, and procedures to enable fast, semantic search.
41+
* Process case law, contracts, and regulations to build a searchable legal knowledge base.
42+
* Convert product descriptions, specifications, and reviews into embeddings for intelligent e-commerce search and recommendations.
43+
* Transform blog posts, articles, and marketing materials into searchable vector embeddings.
44+
* Generate embeddings for the semantic search step in RAG pipelines.
6645

67-
### Technical documentation links ✨
46+
### Technical documentation
6847

69-
* [Generating embeddings - overview](../../ai-integration/generating-embeddings/overview.mdx)
70-
* [Configure an embeddings generation task - from the Studio](../../ai-integration/generating-embeddings/embeddings-generation-task.mdx)
71-
* [Configure an embeddings generation task - from the Client API](../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configuring-an-embeddings-generation-task---from-the-client-api)
72-
* [The embedding collections](../../ai-integration/generating-embeddings/embedding-collections.mdx)
48+
Refer to the technical documentation to learn how to automatically vectorize data from your documents by configuring embedding generation tasks.
7349

74-
---
50+
<ColGrid colCount={2}>
51+
<CardWithImage title="Generating embeddings - overview"
52+
description="Learn what an embeddings generation task is and how it works."
53+
url="../../ai-integration/generating-embeddings/overview"
54+
imgIcon="embeddings" />
55+
<CardWithImage title="Configure an embeddings generation task using Studio"
56+
description="Learn how to configure an embeddings generation task from Studio."
57+
url="../../ai-integration/generating-embeddings/embeddings-generation-task#configuring-an-embeddings-generation-task-from-the-studio"
58+
imgIcon="embeddings" />
59+
</ColGrid>
7560

76-
### Related in-depth articles
61+
### Learn more: In-depth articles
7762

7863
<ColGrid colCount={2}>
7964
<CardWithImage
8065
title="Embeddings with RavenDB and External Models"
8166
description="Step-by-step setup guide for AI-powered semantic search, by Paweł Lachowski"
82-
imgSrc={aiSearchArticleImage} url="https://ravendb.net/articles/embeddings-generation-with-ravendb"
67+
imgSrc={aiSearchImage}
68+
url="https://ravendb.net/articles/embeddings-generation-with-ravendb"
8369
imgAlt="Embeddings with RavenDB and External Models"
8470
/>
8571
<CardWithImage
8672
title="The integration of embeddings generation in RavenDB"
8773
description="The reasoning and architecture behind RavenDB's embeddings feature, by Oren Eini"
88-
imgSrc={ayendeBlogImage} url="https://ravendb.net/articles/ai-integration-in-ravendb-embeddings-generation"
74+
imgSrc={aiSearchImage}
75+
url="https://ravendb.net/articles/ai-integration-in-ravendb-embeddings-generation"
8976
imgAlt="The integration of embeddings generation in RavenDB"
9077
/>
9178
</ColGrid>
9279

93-
---
94-
9580
### Related lives & videos
9681

97-
Learn more about enhancing your applications using vector search operations.
98-
9982
<ColGrid colCount={1}>
10083
<CardWithImageHorizontal
10184
title="Taking over the world with AI and RavenDB"
10285
description="Learn how to integrate AI into your apps using RavenDB for semantic search, vector embeddings, and LLM-powered features - with real examples from Oren Eini."
10386
url="https://www.youtube.com/watch?v=7DhbgfH_rSE"
104-
imgSrc={webinarThumbnailPlaceholder}
87+
imgSrc={webinarImage}
10588
imgAlt="Taking over the world with AI and RavenDB"
10689
/>
10790
<CardWithImageHorizontal
10891
title="Vector search in RavenDB"
10992
description="The AI trend developers simply cannot ignore."
11093
url="https://www.youtube.com/watch?v=zZwid8LA-e4"
111-
imgSrc={discordLargeThumbnailPlaceholder}
94+
imgSrc={discordImage}
11295
imgAlt="Vector search in RavenDB"
11396
/>
11497
</ColGrid>

versioned_docs/version-7.1/ai-integration/generating-embeddings/start.mdx

Lines changed: 27 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,10 @@ import CardWithImage from "@site/src/components/Common/CardWithImage";
99
import CardWithImageHorizontal from "@site/src/components/Common/CardWithImageHorizontal";
1010
import ColGrid from "@site/src/components/ColGrid";
1111

12-
import embedGenStartApiImage from "./assets/embeddings-generation_start_api-image.png";
13-
import embedGenStartStudioImage from "./assets/embeddings-generation_start_studio-image.png";
14-
import aiSearchArticleImage from "./assets/ai-search-article-cover.webp";
12+
import aiSearchImage from "./assets/ai-search-article-cover.webp";
13+
import webinarImage from "@site/static/img/webinar.webp";
14+
import discordImage from "@site/static/img/discord-lg.webp";
1515

16-
import ayendeBlogImage from "@site/static/img/from-ayende-com.webp";
17-
import webinarThumbnailPlaceholder from "@site/static/img/webinar.webp";
18-
import discordLargeThumbnailPlaceholder from "@site/static/img/discord-lg.webp";
19-
20-
<Admonition type="note" title="">
21-
2216
### Create embeddings to enable AI-powered similarity search.
2317

2418
* [Embeddings](https://en.wikipedia.org/wiki/Embedding_(machine_learning)) are numeric vectors that represent the meaning, context, or relationships within the data (e.g., text or images).
@@ -38,77 +32,66 @@ import discordLargeThumbnailPlaceholder from "@site/static/img/discord-lg.webp";
3832
* Embeddings also power other AI features in RavenDB, such as [GenAI](../../ai-integration/gen-ai-integration/start.mdx) and [AI agents](../../ai-integration/ai-agents/start.mdx),
3933
which may use vector search queries to retrieve relevant documents in response to LLM requests.
4034

41-
* On this start page, you'll find:
42-
* [Use cases](../../ai-integration/generating-embeddings/start.mdx#use-cases)
43-
* [Technical documentation links](../../ai-integration/generating-embeddings/start.mdx#technical-documentation-links-)
44-
* [Related in-depth articles](../../ai-integration/generating-embeddings/start.mdx#related-in-depth-articles)
45-
* [Related lives & videos](../../ai-integration/generating-embeddings/start.mdx#related-lives--videos)
46-
47-
</Admonition>
48-
49-
---
50-
5135
### Use cases
5236

5337
Embeddings-generation tasks can prepare your data for AI-powered search, analysis, and retrieval.
5438
Common use cases include:
5539

56-
* **Enterprise knowledge bases**
57-
Generate embeddings for thousands of documents, policies, and procedures to enable fast, semantic search.
58-
* **Legal document libraries**
59-
Process case law, contracts, and regulations to build a searchable legal knowledge base.
60-
* **Product catalogs**
61-
Convert product descriptions, specifications, and reviews into embeddings for intelligent e-commerce search and recommendations.
62-
* **Content management systems**
63-
Transform blog posts, articles, and marketing materials into searchable vector embeddings.
64-
65-
---
40+
* Generate embeddings for thousands of documents, policies, and procedures to enable fast, semantic search.
41+
* Process case law, contracts, and regulations to build a searchable legal knowledge base.
42+
* Convert product descriptions, specifications, and reviews into embeddings for intelligent e-commerce search and recommendations.
43+
* Transform blog posts, articles, and marketing materials into searchable vector embeddings.
44+
* Generate embeddings for the semantic search step in RAG pipelines.
6645

67-
### Technical documentation links ✨
46+
### Technical documentation
6847

69-
* [Generating embeddings - overview](../../ai-integration/generating-embeddings/overview.mdx)
70-
* [Configure an embeddings generation task - from the Studio](../../ai-integration/generating-embeddings/embeddings-generation-task.mdx)
71-
* [Configure an embeddings generation task - from the Client API](../../ai-integration/generating-embeddings/embeddings-generation-task.mdx#configuring-an-embeddings-generation-task---from-the-client-api)
72-
* [The embedding collections](../../ai-integration/generating-embeddings/embedding-collections.mdx)
48+
Refer to the technical documentation to learn how to automatically vectorize data from your documents by configuring embedding generation tasks.
7349

74-
---
50+
<ColGrid colCount={2}>
51+
<CardWithImage title="Generating embeddings - overview"
52+
description="Learn what an embeddings generation task is and how it works."
53+
url="../../ai-integration/generating-embeddings/overview"
54+
imgIcon="embeddings" />
55+
<CardWithImage title="Configure an embeddings generation task using Studio"
56+
description="Learn how to configure an embeddings generation task from Studio."
57+
url="../../ai-integration/generating-embeddings/embeddings-generation-task#configuring-an-embeddings-generation-task-from-the-studio"
58+
imgIcon="embeddings" />
59+
</ColGrid>
7560

76-
### Related in-depth articles
61+
### Learn more: In-depth articles
7762

7863
<ColGrid colCount={2}>
7964
<CardWithImage
8065
title="Embeddings with RavenDB and External Models"
8166
description="Step-by-step setup guide for AI-powered semantic search, by Paweł Lachowski"
82-
imgSrc={aiSearchArticleImage} url="https://ravendb.net/articles/embeddings-generation-with-ravendb"
67+
imgSrc={aiSearchImage}
68+
url="https://ravendb.net/articles/embeddings-generation-with-ravendb"
8369
imgAlt="Embeddings with RavenDB and External Models"
8470
/>
8571
<CardWithImage
8672
title="The integration of embeddings generation in RavenDB"
8773
description="The reasoning and architecture behind RavenDB's embeddings feature, by Oren Eini"
88-
imgSrc={ayendeBlogImage} url="https://ravendb.net/articles/ai-integration-in-ravendb-embeddings-generation"
74+
imgSrc={aiSearchImage}
75+
url="https://ravendb.net/articles/ai-integration-in-ravendb-embeddings-generation"
8976
imgAlt="The integration of embeddings generation in RavenDB"
9077
/>
9178
</ColGrid>
9279

93-
---
94-
9580
### Related lives & videos
9681

97-
Learn more about enhancing your applications using vector search operations.
98-
9982
<ColGrid colCount={1}>
10083
<CardWithImageHorizontal
10184
title="Taking over the world with AI and RavenDB"
10285
description="Learn how to integrate AI into your apps using RavenDB for semantic search, vector embeddings, and LLM-powered features - with real examples from Oren Eini."
10386
url="https://www.youtube.com/watch?v=7DhbgfH_rSE"
104-
imgSrc={webinarThumbnailPlaceholder}
87+
imgSrc={webinarImage}
10588
imgAlt="Taking over the world with AI and RavenDB"
10689
/>
10790
<CardWithImageHorizontal
10891
title="Vector search in RavenDB"
10992
description="The AI trend developers simply cannot ignore."
11093
url="https://www.youtube.com/watch?v=zZwid8LA-e4"
111-
imgSrc={discordLargeThumbnailPlaceholder}
94+
imgSrc={discordImage}
11295
imgAlt="Vector search in RavenDB"
11396
/>
11497
</ColGrid>

0 commit comments

Comments
 (0)