-
Notifications
You must be signed in to change notification settings - Fork 186
[DRAFT][POC] Split Elasticsearch solution and search use case #4251
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
base: main
Are you sure you want to change the base?
Changes from all commits
c70c2d5
ef803d9
597e532
45e407b
6a5fb4b
2efdd52
a561b33
31d7bfe
b67429e
460e69c
c94e778
168f2d9
490f92f
ae00cdf
cb7669a
369a369
0a97210
1b59a93
0e687bf
1be8f3f
817c0b2
ae1a361
471b254
752a53e
3893f33
58db21a
45f2b62
60583fc
be72056
337360f
35db040
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,14 @@ | ||
| redirects: | ||
| # Search primitives moved from ES solution to Search use case | ||
| 'solutions/elasticsearch-solution-project/full-text/search-with-synonyms.md': 'solutions/search/full-text/search-with-synonyms.md' | ||
|
Collaborator
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. I don't see this page being moved in this pr |
||
| 'solutions/elasticsearch-solution-project/full-text/create-update-synonyms-api-example.md': 'solutions/search/full-text/create-update-synonyms-api-example.md' | ||
| # ES solution pages moved from Search to ES solution | ||
| 'solutions/search/agent-builder/get-started.md': 'solutions/elasticsearch-solution-project/agent-builder/get-started.md' | ||
| 'solutions/search/elastic-agent-builder.md': 'solutions/elasticsearch-solution-project/elastic-agent-builder.md' | ||
| 'solutions/search/query-rules-ui.md': 'solutions/elasticsearch-solution-project/query-rules-ui.md' | ||
| 'solutions/search/search-applications.md': 'solutions/elasticsearch-solution-project/search-applications.md' | ||
| 'solutions/search/search-applications/search-application-client.md': 'solutions/elasticsearch-solution-project/search-applications/search-application-client.md' | ||
| 'solutions/search/search-connection-details.md': 'solutions/elasticsearch-solution-project/search-connection-details.md' | ||
| 'deploy-manage/security/secure-http-communications.md': '!deploy-manage/security/secure-cluster-communications.md' | ||
| 'deploy-manage/security/manually-configure-security-in-self-managed-cluster.md': '!deploy-manage/security/self-setup.md' | ||
| 'deploy-manage/security/security-certificates-keys.md': '!deploy-manage/security/self-auto-setup.md' | ||
|
|
@@ -326,13 +336,13 @@ redirects: | |
| 'deploy-manage/monitor/autoops/ec-autoops-dismiss-event.md': 'deploy-manage/monitor/autoops/ec-autoops-events.md' | ||
|
|
||
| # Related to https://github.com/elastic/docs-content/pull/2245/ | ||
| 'solutions/search/elasticsearch-basics-quickstart.md': 'solutions/search/get-started/index-basics.md' | ||
| 'solutions/search/elasticsearch-basics-quickstart.md': 'solutions/elasticsearch-solution-project/get-started/index-basics.md' | ||
|
|
||
| # Related to https://github.com/elastic/elasticsearch/pull/133362 | ||
| 'solutions/search/querydsl-full-text-filter-tutorial.md': 'elasticsearch://reference/query-languages/query-dsl/full-text-filter-tutorial.md' | ||
|
|
||
| # Related to https://github.com/elastic/docs-content/pull/2719 | ||
| 'solutions/search/api-quickstarts.md': 'solutions/search/get-started/quickstarts.md' | ||
| 'solutions/search/api-quickstarts.md': 'solutions/elasticsearch-solution-project/get-started/quickstarts.md' | ||
|
|
||
| # Related to https://github.com/elastic/docs-content/pull/2745 | ||
| 'solutions/search/run-elasticsearch-locally.md': 'deploy-manage/deploy/self-managed/local-development-installation-quickstart.md' | ||
|
|
@@ -355,7 +365,7 @@ redirects: | |
| 'troubleshoot/observability/apm-agent-swift/apm-ios-agent.md': 'troubleshoot/ingest/opentelemetry/edot-sdks/ios/index.md' | ||
|
|
||
| # Related to https://github.com/elastic/docs-content/pull/2843 | ||
| 'solutions/search/serverless-elasticsearch-get-started.md': 'solutions/search/get-started.md' | ||
| 'solutions/search/serverless-elasticsearch-get-started.md': 'solutions/elasticsearch-solution-project/get-started.md' | ||
|
|
||
| # Related to https://github.com/elastic/docs-content/pull/3032 | ||
| 'manage-data/lifecycle/index-lifecycle-management/tutorial-automate-rollover.md': 'manage-data/lifecycle/index-lifecycle-management/ilm-tutorials.md' | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,5 +22,5 @@ products: | |
| - [Rust](elasticsearch-rs://reference/index.md) | ||
|
|
||
| ::::{tip} | ||
| Learn how to [connect to your {{es}} endpoint](/solutions/search/search-connection-details.md). | ||
| Learn how to [connect to your {{es}} endpoint](/solutions/elasticsearch-solution-project/search-connection-details.md). | ||
|
Collaborator
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. do we care to tell people how to connect to these in other contexts, if we can assume that clients are solution-agnostic? probably a problem for later
Contributor
Author
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. good q not sure, need to check what the experience is like on other project types too + if we should have a raw non-UI section for connection details |
||
| :::: | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| --- | ||
| mapped_pages: | ||
| - https://www.elastic.co/guide/en/serverless/current/what-is-elasticsearch-serverless.html | ||
| - https://www.elastic.co/guide/en/kibana/current/search-space.html | ||
| applies_to: | ||
| stack: | ||
| serverless: | ||
| products: | ||
| - id: elasticsearch | ||
| - id: cloud-serverless | ||
| - id: kibana | ||
| navigation_title: Elasticsearch solution | ||
| --- | ||
|
|
||
| # {{es}} solution & project type overview | ||
|
|
||
| ::::{tip} | ||
| Not sure which deployment type is right for you? Use the following resources to help you decide: | ||
|
|
||
| - Read the Elastic [deployment types overview](/deploy-manage/deploy.md) | ||
| - Compare [serverless and {{ech}}](/deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings.md) | ||
| - Compare pricing models between [Elastic Cloud](/deploy-manage/cloud-organization/billing/cloud-hosted-deployment-billing-dimensions.md) and [Serverless](/deploy-manage/cloud-organization/billing/serverless-project-billing-dimensions.md) | ||
| :::: | ||
|
|
||
|
|
||
| The {{es}} solution and serverless project type provide specialized UI tools and interfaces that help you build search applications on top of the {{es}} platform. | ||
|
|
||
| These UI affordances are exclusive to the {{es}} **solution** (on non-serverless deployments) and the {{es}} serverless **project type**. They complement the core [search primitives](/solutions/search.md) available across all Elastic deployments. | ||
|
Collaborator
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. maybe saying explicitly "you don't need to use this solution or project type to build search" would be nice, paired with how the solution makes you go faster? |
||
|
|
||
| ## Features and tools | ||
|
|
||
| The {{es}} solution provides the following specialized UI tools: | ||
|
|
||
| ### Agent Builder | ||
|
|
||
| [Agent Builder](/solutions/elasticsearch-solution-project/elastic-agent-builder.md) enables you to create AI agents that can interact with your {{es}} data, execute queries, and provide intelligent responses. It provides a complete framework for building conversational AI experiences on top of your search infrastructure. | ||
|
Collaborator
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. snippetable |
||
|
|
||
| ### Playground | ||
|
|
||
| [Playground](/solutions/elasticsearch-solution-project/playground.md) lets you use large language models (LLMs) to understand, explore, and analyze your {{es}} data using retrieval augmented generation (RAG), via a chat interface. Playground is also useful for testing and debugging your {{es}} queries using the [retrievers](/solutions/search/retrievers-overview.md) syntax. | ||
|
|
||
| ### Synonyms UI | ||
|
|
||
| The [Search with synonyms](/solutions/search/full-text/search-with-synonyms.md) interface provides a dedicated UI for managing synonym sets directly within {{kib}}, making it easier to improve search relevance without editing configuration files. | ||
|
|
||
| ### Query Rules UI | ||
|
|
||
| [Query Rules UI](/solutions/elasticsearch-solution-project/query-rules-ui.md) enables you to create and manage query rules that modify search behavior based on specific conditions, helping you deliver more relevant results for common queries. | ||
|
|
||
| ### AI Assistant | ||
|
|
||
| The [AI Assistant](/solutions/elasticsearch-solution-project/ai-assistant.md) provides intelligent assistance and insights across the Elastic platform, helping you understand your data and workflows more effectively. | ||
|
|
||
| ### Model Context Protocol (MCP) | ||
|
|
||
| The [Model Context Protocol (MCP)](/solutions/elasticsearch-solution-project/mcp.md) lets you connect AI agents and assistants to your {{es}} data to enable natural language interactions with your indices. | ||
|
|
||
| ## Get started | ||
|
|
||
| Ready to start using the {{es}} solution? Refer to [Get started](/solutions/elasticsearch-solution-project/get-started.md) for setup instructions and quickstart guides. | ||
|
|
||
| For a deeper understanding of search concepts and techniques, refer to the [Search use case](/solutions/search.md) documentation. | ||
|
|
||
| ## Related reference | ||
|
|
||
| * [Search use case documentation](/solutions/search.md) | ||
| * [{{es}} reference documentation](elasticsearch://reference/elasticsearch/index.md) | ||
| * [{{es}} API documentation]({{es-apis}}) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,7 +15,7 @@ Learn how to get started by enabling the {{agent-builder}} features and begin ch | |
| ::::::{stepper} | ||
| ::::{step} Set up an Elastic deployment | ||
|
|
||
| If you don't already have an Elastic deployment, refer to [Select your deployment type](/solutions/search/get-started.md#choose-your-deployment-type). | ||
| If you don't already have an Elastic deployment, refer to [Get started with search](/solutions/search/get-started.md). | ||
|
Comment on lines
16
to
+18
Collaborator
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. this requires specifically an elasticsearch one right? can we be more particular about the requirement? |
||
|
|
||
| :::{note} | ||
| For {{ech}} deployments, make sure you are using the solution navigation instead of classic navigation. | ||
|
|
@@ -68,7 +68,7 @@ For a broader overview of ingestion options, go to [](/manage-data/ingest.md). | |
| :::{tip} | ||
| If you're not ready to add your own data, you can: | ||
| - Use the Elastic [sample data](/manage-data/ingest/sample-data.md). | ||
| - Generate synthetic financial data using [this Python tool](https://github.com/jeffvestal/synthetic-financial-data?tab=readme-ov-file#synthetic-financial-data-generator-). (This requires your [{{es}} URL and an API key](/solutions/search/search-connection-details.md)). | ||
| - Generate synthetic financial data using [this Python tool](https://github.com/jeffvestal/synthetic-financial-data?tab=readme-ov-file#synthetic-financial-data-generator-). (This requires your [{{es}} URL and an API key](/solutions/elasticsearch-solution-project/search-connection-details.md)). | ||
|
|
||
| % TODO: we can link to a an agent builder tutorial if we add one in the docs | ||
| ::: | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -63,7 +63,7 @@ export KIBANA_URL="your-kibana-url" | |
| export API_KEY="your-api-key" | ||
| ``` | ||
|
|
||
| For information on generating API keys, refer to [API keys](https://www.elastic.co/docs/solutions/search/search-connection-details). | ||
| For information on generating API keys, refer to [API keys](/solutions/elasticsearch-solution-project/search-connection-details.md). | ||
|
Collaborator
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. this title no longer exists anywhere on the page. if you still prefer to use it, it should be updated wonder if this page would be a better option |
||
|
|
||
| Tools execute with the scope assigned to the API key. Make sure your API key has the appropriate permissions to only access the indices and data that you want to expose through the MCP server. To learn more, refer to [](#api-key-application-privileges). | ||
| ::: | ||
|
|
||
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.
assuming that this list of redirects is currently incomplete
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.
correct