Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main' into semantic-search-upd…
Browse files Browse the repository at this point in the history
…ates
  • Loading branch information
kosabogi committed Nov 21, 2024
2 parents 38ddc51 + 353b9dd commit a44c6dc
Show file tree
Hide file tree
Showing 88 changed files with 256 additions and 300 deletions.
7 changes: 2 additions & 5 deletions serverless/index-serverless-elasticsearch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
++++

include::./pages/what-is-elasticsearch-serverless.asciidoc[leveloffset=+2]
include::./pages/serverless-differences.asciidoc[leveloffset=+2]

include::./pages/pricing.asciidoc[leveloffset=+2]

Expand Down Expand Up @@ -42,8 +43,4 @@ include::./pages/search-your-data-semantic-search.asciidoc[leveloffset=+3]

include::./pages/explore-your-data.asciidoc[leveloffset=+2]

include::./pages/search-playground.asciidoc[leveloffset=+2]

include::./pages/serverless-differences.asciidoc[leveloffset=+2]

include::./pages/technical-preview-limitations.asciidoc[leveloffset=+2]
include::./pages/search-playground.asciidoc[leveloffset=+2]
2 changes: 0 additions & 2 deletions serverless/pages/action-connectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: Configure connections to third party systems for use in cases and rules.
// :keywords: serverless

preview:[]

This content applies to: {es-badge} {obs-badge} {sec-badge}

The list of available connectors varies by project type.
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/api-keys.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: API keys allow access to the {stack} on behalf of a user.
// :keywords: serverless, Elasticsearch, Observability, Security

preview:[]

This content applies to: {es-badge} {obs-badge} {sec-badge}

API keys are security mechanisms used to authenticate and authorize access to {stack} resources,
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/apis-elasticsearch-conventions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: The {es-serverless} REST APIs have conventions for headers and request bodies.
// :keywords: serverless, elasticsearch, API, reference

preview:[]

You can run {es} API requests in **{dev-tools-app} → Console**.
For example:

Expand Down
33 changes: 29 additions & 4 deletions serverless/pages/apis-http-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,33 @@
// :description: {es} and {kib} expose REST APIs that can be called directly to configure and access {stack} features.
// :keywords: serverless, elasticsearch, http, rest, overview

preview:[]
[discrete]
[[elasticsearch-api-references-links]]
== API references

* <<elasticsearch-api-conventions>>: The {es-serverless} REST APIs have conventions for headers and request bodies.
* <<elasticsearch-kibana-api-conventions>>: The Management APIs for {serverless-short} have request header conventions.
* https://www.elastic.co/docs/api/[API Reference]: Explore the reference information for Elastic Serverless REST APIs
The following APIs are available for {es-serverless} users.
These links will take you to the autogenerated API reference documentation.

https://www.elastic.co/docs/api/doc/elasticsearch-serverless[Elasticsearch Serverless APIs →]::
Use these APIs to index, manage, search, and analyze your data in {es-serverless}.
+
[TIP]
====
Learn how to <<elasticsearch-connecting-to-es-serverless-endpoint,connect to your {es-serverless} endpoint>>.
====

https://www.elastic.co/docs/api/doc/serverless[Kibana Serverless APIs →]::
Use these APIs to manage resources such as connectors, data views, and saved objects for your {serverless-full} project.

https://www.elastic.co/docs/api/doc/elastic-cloud-serverless[{serverless-full} APIs →]::
Use these APIs to manage your {serverless-full} projects.

[discrete]
[[additional-api-details]]
== Additional API information

<<elasticsearch-api-conventions>>::
Reference information about headers and request body conventions for {es-serverless} REST APIs.

<<elasticsearch-kibana-api-conventions>>::
Reference information about request header conventions for {serverless-full} REST APIs.
2 changes: 0 additions & 2 deletions serverless/pages/apis-kibana-conventions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: The Management APIs for {serverless-short} have request header conventions.
// :keywords: serverless, kibana, API, reference

preview:[]

The Management REST APIs for {serverless-full} let you manage resources that are available in multiple solutions.
These resources include connectors, data views, and saved objects.
If you've previously used the {stack}, the Management APIs are similar to {kib} APIs.
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/clients-dot-net-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: Set up and use the .NET client for {es3}.
// :keywords: serverless, elasticsearch, .net, how to

preview:[]

[NOTE]
====
This client is for use with {es-serverless} only. See also the https://www.elastic.co/guide/en/elasticsearch/client/index.html[{es} clients].
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/clients-go-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: Set up and use the Go client for {es3}.
// :keywords: serverless, elasticsearch, go, how to

preview:[]

[NOTE]
====
This client is for use with {es-serverless} only. See also the https://www.elastic.co/guide/en/elasticsearch/client/index.html[{es} clients].
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/clients-java-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: Set up and use the Java client for {es3}.
// :keywords: serverless, elasticsearch, java, how to

preview:[]

[NOTE]
====
This client is for use with {es-serverless} only. See also the https://www.elastic.co/guide/en/elasticsearch/client/index.html[{es} clients].
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/clients-nodejs-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: Set up and use the Node.js client for {es3}.
// :keywords: serverless, elasticsearch, nodejs, how to

preview:[]

[NOTE]
====
This client is for use with {es-serverless} only. See also the https://www.elastic.co/guide/en/elasticsearch/client/index.html[{es} clients].
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/clients-php-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: Set up and use the PHP client for {es3}.
// :keywords: serverless, elasticsearch, php, how to

preview:[]

[NOTE]
====
This client is for use with {es-serverless} only. See also the https://www.elastic.co/guide/en/elasticsearch/client/index.html[{es} clients].
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/clients-python-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: Set up and use the Python client for {es3}.
// :keywords: serverless, elasticsearch, python, how to

preview:[]

[NOTE]
====
This client is for use with {es-serverless} only. See also the https://www.elastic.co/guide/en/elasticsearch/client/index.html[{es} clients].
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/clients-ruby-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: Set up and use the Ruby client for {es3}.
// :keywords: serverless, elasticsearch, ruby, how to

preview:[]

[NOTE]
====
This client is for use with {es-serverless} only. See also the https://www.elastic.co/guide/en/elasticsearch/client/index.html[{es} clients].
Expand Down
7 changes: 5 additions & 2 deletions serverless/pages/clients.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: Index, search, and manage {es} data in your preferred language.
// :keywords: serverless, elasticsearch, clients, overview

preview:[]

{es3} provides official language clients for {es} REST APIs.

[NOTE]
Expand All @@ -22,3 +20,8 @@ Currently, the following language clients are supported:
* <<elasticsearch-php-client-getting-started,PHP>> | https://github.com/elastic/elasticsearch-serverless-php[Repository]
* <<elasticsearch-python-client-getting-started,Python>> | https://github.com/elastic/elasticsearch-serverless-python[Repository]
* <<elasticsearch-ruby-client-getting-started,Ruby>> | https://github.com/elastic/elasticsearch-serverless-ruby[Repository]

[TIP]
====
Learn how to <<elasticsearch-connecting-to-es-serverless-endpoint,connect to your {es-serverless} endpoint>>.
====
5 changes: 4 additions & 1 deletion serverless/pages/connecting-to-es-endpoint.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[elasticsearch-connecting-to-es-serverless-endpoint]]
= Connecting to your Elasticsearch Serverless endpoint
= Connect to your Elasticsearch Serverless endpoint
++++
<titleabbrev>Connect to your endpoint</titleabbrev>
++++

[TIP]
====
Expand Down
1 change: 0 additions & 1 deletion serverless/pages/custom-roles.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ coming:[]
endif::[]

ifdef::serverlessCustomRoles[]
preview:[]

This content applies to: {es-badge} {sec-badge}

Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/data-views.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: Elastic requires a {data-source} to access the {es} data that you want to explore.
// :keywords: serverless, Elasticsearch, Observability, Security

preview:[]

This content applies to: {es-badge} {obs-badge} {sec-badge}

A {data-source} can point to one or more indices, {ref}/data-streams.html[data streams], or {ref}/alias.html[index aliases].
Expand Down
4 changes: 1 addition & 3 deletions serverless/pages/debug-grok-expressions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: Build and debug grok patterns before you use them in your data processing pipelines.
// :keywords: serverless, dev tools, how-to

preview:[]

This content applies to: {es-badge} {obs-badge} {sec-badge}

You can build and debug grok patterns in the **Grok Debugger** before you use them in your data processing pipelines.
Expand Down Expand Up @@ -43,7 +41,7 @@ The **Admin** role is required to use the Grok Debugger.
For more information, refer to <<general-assign-user-roles>>
====

. From the main menu, click **Developer Tools**, then click **Grok Debugger**.
. In the main menu, go to **Developer Tools** under *Build*, then click **Grok Debugger**.
. In **Sample Data**, enter a message that is representative of the data you want to parse.
For example:
+
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/debug-painless-scripts.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: Use our interactive code editor to test and debug Painless scripts in real-time.
// :keywords: serverless, dev tools, how-to

preview:[]

This content applies to: {obs-badge} {sec-badge}

beta::[]
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/developer-tools-troubleshooting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: Troubleshoot searches.
// :keywords: serverless, troubleshooting

preview:[]

When you query your data, {es} may return an error, no search results,
or results in an unexpected order. This guide describes how to troubleshoot
searches.
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/elasticsearch-developer-tools.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// :description: Elastic tools for developers.
// :keywords: serverless, elasticsearch, overview

preview:[]

A number of developer tools are available in your project's UI under the **Dev Tools** section.

* <<devtools-run-api-requests-in-the-console,Console>>: Make API calls to your {es} instance using the Query DSL and view the responses.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
// :description: NLP tasks that classify input text or determine the language of text.
// :keywords: serverless, elasticsearch, tbd

preview:[]

These NLP tasks enable you to identify the language of text and classify or
label unstructured input text:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

// :description: Description to be written

preview:[]

After you import the model and vocabulary, you can use {kib} to view and
manage their deployment across your cluster under **{ml-app}**
**Model Management**. Alternatively, you can use the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
// :description: You can import trained models into your cluster and configure them for specific NLP tasks.
// :keywords: serverless, elasticsearch, tbd

preview:[]

If you want to perform {nlp} tasks in your cluster, you must deploy an
appropriate trained model. There is tooling support in
https://github.com/elastic/eland[Eland] and {kib} to help you prepare and
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/explore-your-data-ml-nlp-elser.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
// :description: ELSER is a learned sparse ranking model trained by Elastic.
// :keywords: serverless, elasticsearch, tbd

preview:[]

Elastic Learned Sparse EncodeR - or ELSER - is a retrieval model trained by
Elastic that enables you to perform
{ref}/semantic-search-elser.html[semantic search] to retrieve more relevant
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/explore-your-data-ml-nlp-examples.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

// :description: Description to be written

preview:[]

The following pages contain end-to-end examples of how to use the different
{nlp} tasks in the {stack}.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
// :description: NLP tasks that extract information from unstructured text.
// :keywords: serverless, elasticsearch, tbd

preview:[]

These NLP tasks enable you to extract information from your unstructured text:

* https://www.elastic.co/docs/current/serverless/elasticsearch/explore-your-data-ml-nlp/extract-info[Named entity recognition]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

// :keywords: serverless, elasticsearch, tbd

preview:[]

[IMPORTANT]
====
If you want to install a trained model in a restricted or closed
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/explore-your-data-ml-nlp-inference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
// :description: You can import trained models into your cluster and configure them for specific NLP tasks.
// :keywords: serverless, elasticsearch, tbd

preview:[]

After you https://www.elastic.co/docs/current/serverless/elasticsearch/explore-your-data-ml-nlp/deploy-trained-models[deploy a trained model in your cluster],
you can use it to perform {nlp} tasks in ingest pipelines.

Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/explore-your-data-ml-nlp-lang-ident.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
// :description: Language identification is an NLP task and a model that enables you to determine the language of text.
// :keywords: serverless, elasticsearch, tbd

preview:[]

{lang-ident-cap} enables you to determine the language of text.

A {lang-ident} model is provided in your cluster, which you can use in an
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/explore-your-data-ml-nlp-model-ref.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
// :description: The list of compatible third party NLP models.
// :keywords: ml, reference, analyze

preview:[]

The {stack-ml-features} support transformer models that conform to the
standard BERT model interface and use the WordPiece tokenization algorithm.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

// :description: Description to be written

preview:[]

You can use these instructions to deploy a
https://www.elastic.co/docs/current/serverless/elasticsearch/explore-your-data-ml-nlp/extract-info[named entity recognition (NER)]
model in {es}, test the model, and add it to an {infer} ingest pipeline. The
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
// :description: Models trained and provided by Elastic
// :keywords: serverless, elasticsearch, tbd

preview:[]

You can use models that are trained and provided by Elastic that are available
within the {stack} with a click of a button.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
// :description: NLP tasks for generate embeddings which can be used to search in text or compare different peieces of text.
// :keywords: serverless, elasticsearch, tbd

preview:[]

The {stack-ml-features} can generate embeddings, which you can use to search in
unstructured text or compare different pieces of text.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

// :keywords: serverless, elasticsearch, tbd

preview:[]

Per the
<<elasticsearch-explore-your-data-ml-nlp,Overview>>,
there are multiple ways that you can use NLP features within the {stack}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
// :description: You can import trained models into your cluster and configure them for specific NLP tasks.
// :keywords: serverless, elasticsearch, tbd

preview:[]

When the model is deployed on at least one node in the cluster, you can begin to
perform inference. _{infer-cap}_ is a {ml} feature that enables you to use
your trained models to perform NLP tasks (such as text extraction,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

// :description: Description to be written

preview:[]

You can use these instructions to deploy a
https://www.elastic.co/docs/current/serverless/elasticsearch/explore-your-data-ml-nlp/search-compare-text[text embedding]
model in {es}, test the model, and add it to an {infer} ingest pipeline. It
Expand Down
2 changes: 0 additions & 2 deletions serverless/pages/explore-your-data-ml-nlp.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

// :keywords: serverless, elasticsearch, tbd

preview:[]

{nlp-cap} (NLP) refers to the way in which we can use software to understand
natural language in spoken word or written text.

Expand Down
Loading

0 comments on commit a44c6dc

Please sign in to comment.