-
Notifications
You must be signed in to change notification settings - Fork 521
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
Add vector search documentation #9135
Open
kolchfa-aws
wants to merge
43
commits into
main
Choose a base branch
from
vector-restructure
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 9 commits
Commits
Show all changes
43 commits
Select commit
Hold shift + click to select a range
4331ce1
Add vector database section
kolchfa-aws db9e95e
More restructuring
kolchfa-aws 3d93fc8
Layout update
kolchfa-aws 47b235f
Add cards to search topics
kolchfa-aws 2ac67d9
More restructuring
kolchfa-aws 99ac17a
Add images and more rewrites
kolchfa-aws 27107c8
Update settings
kolchfa-aws f009e68
Formatting update
kolchfa-aws 8779a7c
Resolve merge conflicts
kolchfa-aws 6cdb7b0
Add more explanations to getting started
kolchfa-aws f922fae
Change about page and remove k-NN terminology
kolchfa-aws 1900e75
unify terminology
kolchfa-aws a5e8b8d
Review comments
kolchfa-aws 3f5301a
More review comments
kolchfa-aws 18b40af
Resolve merge conflicts
kolchfa-aws 8b8d831
Resolve merge conflicts
kolchfa-aws d977108
More restructuring
kolchfa-aws f73a161
Remove table from exact search
kolchfa-aws 8fde05d
Fix links
kolchfa-aws 7f549c4
Merge branch 'main' into vector-restructure
kolchfa-aws 73f4fd7
Remove text from top page
kolchfa-aws e2a1cf9
Merge branch 'vector-restructure' of https://github.com/opensearch-pr…
kolchfa-aws 0be522f
More updates
kolchfa-aws 63c0d97
Update _query-dsl/specialized/kNN.md
kolchfa-aws 79eeff1
Review comments
kolchfa-aws 9d42335
Fix links
kolchfa-aws a6a1cfb
Fix links
kolchfa-aws ad6fb3c
Rename query file
kolchfa-aws 18e10df
Fix links
kolchfa-aws c007e46
Add sparse vector option
kolchfa-aws e2a7427
Compress requests
kolchfa-aws 8d4ffe4
Apply suggestions from code review
kolchfa-aws e19af36
Apply suggestions from code review
kolchfa-aws 8c49459
Apply suggestions from code review
kolchfa-aws 0ca38f0
Editorial comments
kolchfa-aws e8595c3
Reformat concepts page
kolchfa-aws a10a187
Resolve merge conflicts
kolchfa-aws f0a80eb
Redesign landing page
kolchfa-aws bdefd99
More refactoring
kolchfa-aws 97487f0
Editorial comments
kolchfa-aws 403142b
Add auto workflow
kolchfa-aws f802024
Last editorial comments
kolchfa-aws dff4a5b
Resolve merge conflicts
kolchfa-aws File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,17 @@ | ||
<div class="card-container-wrapper"> | ||
<p class="heading-main">Explore OpenSearch documentation</p> | ||
<div class="card-container"> | ||
<div class="card"> | ||
<a href="{{site.url}}{{site.baseurl}}/about/" class='card-link'></a> | ||
<p class="heading">OpenSearch and OpenSearch Dashboards</p> | ||
<p class="description">Build your OpenSearch solution using core tooling and visualizations</p> | ||
<p class="last-link">Documentation →</p> | ||
</div> | ||
|
||
|
||
<div class="card"> | ||
<a href="{{site.url}}/docs/latest/data-prepper/" class='card-link'></a> | ||
<p class="heading">OpenSearch Data Prepper</p> | ||
<p class="description">Filter, mutate, and sample your data for ingestion into OpenSearch</p> | ||
<p class="last-link" >Documentation →</p> | ||
</div> | ||
|
||
<div class="card"> | ||
<a href="{{site.url}}/docs/latest/clients/" class='card-link'></a> | ||
<p class="heading">Clients</p> | ||
<p class="description">Interact with OpenSearch from your application using language APIs</p> | ||
<p class="last-link">Documentation →</p> | ||
</div> | ||
|
||
|
||
<div class="card"> | ||
<a href="{{site.url}}/docs/latest/benchmark/" class='card-link'></a> | ||
<p class="heading">OpenSearch Benchmark</p> | ||
<p class="description">Measure performance metrics for your OpenSearch cluster</p> | ||
<p class="last-link">Documentation →</p> | ||
</div> | ||
|
||
<div class="card"> | ||
<a href="{{site.url}}/docs/latest/migration-assistant/" class='card-link'></a> | ||
<p class="heading">Migration Assistant</p> | ||
<p class="description">Migrate to OpenSearch</p> | ||
<p class="last-link">Documentation →</p> | ||
</div> | ||
<div class="card-container"> | ||
{% for card in include.cards %} | ||
<div class="card"> | ||
<a href="{{ site.url }}{{ site.baseurl }}{{ card.link }}" class="card-link"></a> | ||
<p class="heading">{{ card.heading }}</p> | ||
{% if card.description %} | ||
<p class="description">{{ card.description }}</p> | ||
{% endif %} | ||
{% if include.documentation_link %} | ||
<p class="last-link">Documentation →</p> | ||
{% endif %} | ||
</div> | ||
{% endfor %} | ||
</div> | ||
</div> | ||
|
||
</div> | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
<div class="home-card-container-wrapper"> | ||
<p class="heading-main">OpenSearch and OpenSearch Dashboards</p> | ||
<div class="home-card-container"> | ||
<div class="home-card"> | ||
<a href="{{site.url}}{{site.baseurl}}/about/" class='card-link'></a> | ||
<p class="heading">All documentation</p> | ||
<p class="description">Build your OpenSearch solution using core tooling and visualizations.</p> | ||
<p class="last-link">Documentation →</p> | ||
</div> | ||
|
||
|
||
<div class="home-card"> | ||
<a href="{{site.url}}{{site.baseurl}}/vector-search/" class='card-link'></a> | ||
<p class="heading">Vector search</p> | ||
<p class="description">Use vector database capabilities for more relevant search results.</p> | ||
<p class="last-link" >Documentation →</p> | ||
</div> | ||
|
||
<div class="home-card"> | ||
<a href="{{site.url}}{{site.baseurl}}/ml-commons-plugin/" class='card-link'></a> | ||
<p class="heading">Machine learning</p> | ||
<p class="description">Power your applications with machine learning model integration.</p> | ||
<p class="last-link">Documentation →</p> | ||
</div> | ||
|
||
|
||
<div class="home-card"> | ||
<a href="{{site.url}}{{site.baseurl}}/dashboards/" class='card-link'></a> | ||
<p class="heading">OpenSearch Dashboards</p> | ||
<p class="description">Explore and visualize your data using interactive dashboards.</p> | ||
<p class="last-link">Documentation →</p> | ||
</div> | ||
</div> | ||
|
||
</div> | ||
|
||
<div class="home-card-container-wrapper"> | ||
<p class="heading-main">Supporting tools</p> | ||
<div class="home-card-container"> | ||
|
||
<div class="home-card"> | ||
<a href="{{site.url}}/docs/latest/data-prepper/" class='card-link'></a> | ||
<p class="heading">Data Prepper</p> | ||
<p class="description">Filter, mutate, and sample your data for ingestion into OpenSearch.</p> | ||
<p class="last-link" >Documentation →</p> | ||
</div> | ||
|
||
<div class="home-card"> | ||
<a href="{{site.url}}/docs/latest/clients/" class='card-link'></a> | ||
<p class="heading">Clients</p> | ||
<p class="description">Interact with OpenSearch from your application using language APIs.</p> | ||
<p class="last-link">Documentation →</p> | ||
</div> | ||
|
||
|
||
<div class="home-card"> | ||
<a href="{{site.url}}/docs/latest/benchmark/" class='card-link'></a> | ||
<p class="heading">OpenSearch Benchmark</p> | ||
<p class="description">Measure performance metrics for your OpenSearch cluster.</p> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Measure OpenSearch cluster performance metrics"?
kolchfa-aws marked this conversation as resolved.
Show resolved
Hide resolved
|
||
<p class="last-link">Documentation →</p> | ||
</div> | ||
|
||
<div class="home-card"> | ||
<a href="{{site.url}}/docs/latest/migration-assistant/" class='card-link'></a> | ||
<p class="heading">Migration Assistant</p> | ||
<p class="description">Migrate to OpenSearch.</p> | ||
<p class="last-link">Documentation →</p> | ||
</div> | ||
</div> | ||
|
||
</div> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<div class="numbered-list"> | ||
{% if include.list_title %} | ||
<div class="heading">{{ include.list_title }}</div> | ||
{% endif %} | ||
{% assign counter = 0 %} | ||
{% for item in include.list_items %} | ||
{% assign counter = counter | plus: 1 %} | ||
<div class="list-item"> | ||
<div class="number-circle">{{ counter }}</div> | ||
<div class="list-content"> | ||
<div class="list-heading"> | ||
{% if item.link %} | ||
<a href="{{ site.url }}{{ site.baseurl }}{{ item.link }}">{{ item.heading }}</a> | ||
{% else %} | ||
{{ item.heading }} | ||
{% endif %} | ||
</div> | ||
<p class="description">{{ item.description | markdownify }}</p> | ||
</div> | ||
</div> | ||
{% endfor %} | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Above method definitions, can we put mode/compression level example? Basically flow for users should be default > method/compression param tuning > method tuning > model ids