Skip to content
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.

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

[DOCS] RAG overview #119590

Merged
merged 10 commits into from
Jan 7, 2025
Merged

[DOCS] RAG overview #119590

merged 10 commits into from
Jan 7, 2025

Conversation

leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Jan 6, 2025

▻ URL preview

The docs were missing a RAG overview page. This tries to fill that gap with intro, overview, link to Playground as recommended Elastic implementation, plus links to various RAGgy resources.

TODO:

  • Update content spreadsheet

@leemthompo leemthompo added >docs General docs changes auto-backport Automatically create backport pull requests when merged v8.16.0 v8.17.0 labels Jan 6, 2025
@leemthompo leemthompo self-assigned this Jan 6, 2025
Copy link
Contributor

github-actions bot commented Jan 6, 2025

Documentation preview:

@elasticsearchmachine elasticsearchmachine added v9.0.0 Team:Docs Meta label for docs team labels Jan 6, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔥 🔥 🔥 a brilliant addition. couple small edits as usual

[rag-elasticsearch]
== Retrieval augmented generation

.🍿 Prefer a video introduction?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very cute

docs/reference/images/search/rag-venn-diagram.svg Outdated Show resolved Hide resolved
docs/reference/images/search/rag-schema.svg Outdated Show resolved Hide resolved
***********************

Retrieval augmented generation (RAG) is a technique where additional context is retrieved from an external datastore before prompting a language model to generate a response using the retrieved context.
This grounds the model with in-context learning.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence is a little colloquial - could rephrase to clarify what you mean by "grounds"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 grounding is the term of art but agree shouldn't assume knowledge

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ahhh consider my comment retracted then

@leemthompo leemthompo merged commit 92bb091 into elastic:main Jan 7, 2025
5 checks passed
@leemthompo leemthompo deleted the rag branch January 7, 2025 14:19
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.16
8.17
8.x

leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Jan 7, 2025
leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Jan 7, 2025
leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Jan 7, 2025
sarog pushed a commit to sarog/elasticsearch that referenced this pull request Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes Team:Docs Meta label for docs team v8.16.0 v8.17.0 v8.18.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants