Sync Core Integrations API reference (elasticsearch) on Docusaurus (#11090)

Co-authored-by: davidsbatista <7937824+davidsbatista@users.noreply.github.com>

Author: HaystackBot

docs-website/reference/integrations-api/elasticsearch.md

@@ -473,6 +473,7 @@ __init__(
     embedding_similarity_function: Literal[
         "cosine", "dot_product", "l2_norm", "max_inner_product"
     ] = "cosine",
+    sparse_vector_field: str | None = None,
     **kwargs: Any
 ) -> None
 ```
@@ -507,6 +508,9 @@ of `id:secret`. Secret instances can also be loaded from a token using the `Secr
   To choose the most appropriate function, look for information about your embedding model.
   To understand how document scores are computed, see the Elasticsearch
   [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/dense-vector.html#dense-vector-params)
+- **sparse_vector_field** (<code>str | None</code>) – If set, the name of the Elasticsearch field where sparse embeddings
+  will be stored using the `sparse_vector` field type. When not set, any `sparse_embedding`
+  data on Documents is silently dropped during writes.
 - \*\***kwargs** (<code>Any</code>) – Optional arguments that `Elasticsearch` takes.
 
 #### client

docs-website/reference_versioned_docs/version-2.18/integrations-api/elasticsearch.md

@@ -473,6 +473,7 @@ __init__(
     embedding_similarity_function: Literal[
         "cosine", "dot_product", "l2_norm", "max_inner_product"
     ] = "cosine",
+    sparse_vector_field: str | None = None,
     **kwargs: Any
 ) -> None
 ```
@@ -507,6 +508,9 @@ of `id:secret`. Secret instances can also be loaded from a token using the `Secr
   To choose the most appropriate function, look for information about your embedding model.
   To understand how document scores are computed, see the Elasticsearch
   [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/dense-vector.html#dense-vector-params)
+- **sparse_vector_field** (<code>str | None</code>) – If set, the name of the Elasticsearch field where sparse embeddings
+  will be stored using the `sparse_vector` field type. When not set, any `sparse_embedding`
+  data on Documents is silently dropped during writes.
 - \*\***kwargs** (<code>Any</code>) – Optional arguments that `Elasticsearch` takes.
 
 #### client

docs-website/reference_versioned_docs/version-2.19/integrations-api/elasticsearch.md

@@ -473,6 +473,7 @@ __init__(
     embedding_similarity_function: Literal[
         "cosine", "dot_product", "l2_norm", "max_inner_product"
     ] = "cosine",
+    sparse_vector_field: str | None = None,
     **kwargs: Any
 ) -> None
 ```
@@ -507,6 +508,9 @@ of `id:secret`. Secret instances can also be loaded from a token using the `Secr
   To choose the most appropriate function, look for information about your embedding model.
   To understand how document scores are computed, see the Elasticsearch
   [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/dense-vector.html#dense-vector-params)
+- **sparse_vector_field** (<code>str | None</code>) – If set, the name of the Elasticsearch field where sparse embeddings
+  will be stored using the `sparse_vector` field type. When not set, any `sparse_embedding`
+  data on Documents is silently dropped during writes.
 - \*\***kwargs** (<code>Any</code>) – Optional arguments that `Elasticsearch` takes.
 
 #### client

docs-website/reference_versioned_docs/version-2.20/integrations-api/elasticsearch.md

@@ -473,6 +473,7 @@ __init__(
     embedding_similarity_function: Literal[
         "cosine", "dot_product", "l2_norm", "max_inner_product"
     ] = "cosine",
+    sparse_vector_field: str | None = None,
     **kwargs: Any
 ) -> None
 ```
@@ -507,6 +508,9 @@ of `id:secret`. Secret instances can also be loaded from a token using the `Secr
   To choose the most appropriate function, look for information about your embedding model.
   To understand how document scores are computed, see the Elasticsearch
   [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/dense-vector.html#dense-vector-params)
+- **sparse_vector_field** (<code>str | None</code>) – If set, the name of the Elasticsearch field where sparse embeddings
+  will be stored using the `sparse_vector` field type. When not set, any `sparse_embedding`
+  data on Documents is silently dropped during writes.
 - \*\***kwargs** (<code>Any</code>) – Optional arguments that `Elasticsearch` takes.
 
 #### client

docs-website/reference_versioned_docs/version-2.21/integrations-api/elasticsearch.md

@@ -473,6 +473,7 @@ __init__(
     embedding_similarity_function: Literal[
         "cosine", "dot_product", "l2_norm", "max_inner_product"
     ] = "cosine",
+    sparse_vector_field: str | None = None,
     **kwargs: Any
 ) -> None
 ```
@@ -507,6 +508,9 @@ of `id:secret`. Secret instances can also be loaded from a token using the `Secr
   To choose the most appropriate function, look for information about your embedding model.
   To understand how document scores are computed, see the Elasticsearch
   [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/dense-vector.html#dense-vector-params)
+- **sparse_vector_field** (<code>str | None</code>) – If set, the name of the Elasticsearch field where sparse embeddings
+  will be stored using the `sparse_vector` field type. When not set, any `sparse_embedding`
+  data on Documents is silently dropped during writes.
 - \*\***kwargs** (<code>Any</code>) – Optional arguments that `Elasticsearch` takes.
 
 #### client

docs-website/reference_versioned_docs/version-2.22/integrations-api/elasticsearch.md

@@ -473,6 +473,7 @@ __init__(
     embedding_similarity_function: Literal[
         "cosine", "dot_product", "l2_norm", "max_inner_product"
     ] = "cosine",
+    sparse_vector_field: str | None = None,
     **kwargs: Any
 ) -> None
 ```
@@ -507,6 +508,9 @@ of `id:secret`. Secret instances can also be loaded from a token using the `Secr
   To choose the most appropriate function, look for information about your embedding model.
   To understand how document scores are computed, see the Elasticsearch
   [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/dense-vector.html#dense-vector-params)
+- **sparse_vector_field** (<code>str | None</code>) – If set, the name of the Elasticsearch field where sparse embeddings
+  will be stored using the `sparse_vector` field type. When not set, any `sparse_embedding`
+  data on Documents is silently dropped during writes.
 - \*\***kwargs** (<code>Any</code>) – Optional arguments that `Elasticsearch` takes.
 
 #### client

docs-website/reference_versioned_docs/version-2.23/integrations-api/elasticsearch.md

@@ -473,6 +473,7 @@ __init__(
     embedding_similarity_function: Literal[
         "cosine", "dot_product", "l2_norm", "max_inner_product"
     ] = "cosine",
+    sparse_vector_field: str | None = None,
     **kwargs: Any
 ) -> None
 ```
@@ -507,6 +508,9 @@ of `id:secret`. Secret instances can also be loaded from a token using the `Secr
   To choose the most appropriate function, look for information about your embedding model.
   To understand how document scores are computed, see the Elasticsearch
   [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/dense-vector.html#dense-vector-params)
+- **sparse_vector_field** (<code>str | None</code>) – If set, the name of the Elasticsearch field where sparse embeddings
+  will be stored using the `sparse_vector` field type. When not set, any `sparse_embedding`
+  data on Documents is silently dropped during writes.
 - \*\***kwargs** (<code>Any</code>) – Optional arguments that `Elasticsearch` takes.
 
 #### client

docs-website/reference_versioned_docs/version-2.24/integrations-api/elasticsearch.md

@@ -473,6 +473,7 @@ __init__(
     embedding_similarity_function: Literal[
         "cosine", "dot_product", "l2_norm", "max_inner_product"
     ] = "cosine",
+    sparse_vector_field: str | None = None,
     **kwargs: Any
 ) -> None
 ```
@@ -507,6 +508,9 @@ of `id:secret`. Secret instances can also be loaded from a token using the `Secr
   To choose the most appropriate function, look for information about your embedding model.
   To understand how document scores are computed, see the Elasticsearch
   [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/dense-vector.html#dense-vector-params)
+- **sparse_vector_field** (<code>str | None</code>) – If set, the name of the Elasticsearch field where sparse embeddings
+  will be stored using the `sparse_vector` field type. When not set, any `sparse_embedding`
+  data on Documents is silently dropped during writes.
 - \*\***kwargs** (<code>Any</code>) – Optional arguments that `Elasticsearch` takes.
 
 #### client

docs-website/reference_versioned_docs/version-2.25/integrations-api/elasticsearch.md

@@ -473,6 +473,7 @@ __init__(
     embedding_similarity_function: Literal[
         "cosine", "dot_product", "l2_norm", "max_inner_product"
     ] = "cosine",
+    sparse_vector_field: str | None = None,
     **kwargs: Any
 ) -> None
 ```
@@ -507,6 +508,9 @@ of `id:secret`. Secret instances can also be loaded from a token using the `Secr
   To choose the most appropriate function, look for information about your embedding model.
   To understand how document scores are computed, see the Elasticsearch
   [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/dense-vector.html#dense-vector-params)
+- **sparse_vector_field** (<code>str | None</code>) – If set, the name of the Elasticsearch field where sparse embeddings
+  will be stored using the `sparse_vector` field type. When not set, any `sparse_embedding`
+  data on Documents is silently dropped during writes.
 - \*\***kwargs** (<code>Any</code>) – Optional arguments that `Elasticsearch` takes.
 
 #### client

docs-website/reference_versioned_docs/version-2.26/integrations-api/elasticsearch.md

@@ -473,6 +473,7 @@ __init__(
     embedding_similarity_function: Literal[
         "cosine", "dot_product", "l2_norm", "max_inner_product"
     ] = "cosine",
+    sparse_vector_field: str | None = None,
     **kwargs: Any
 ) -> None
 ```
@@ -507,6 +508,9 @@ of `id:secret`. Secret instances can also be loaded from a token using the `Secr
   To choose the most appropriate function, look for information about your embedding model.
   To understand how document scores are computed, see the Elasticsearch
   [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/dense-vector.html#dense-vector-params)
+- **sparse_vector_field** (<code>str | None</code>) – If set, the name of the Elasticsearch field where sparse embeddings
+  will be stored using the `sparse_vector` field type. When not set, any `sparse_embedding`
+  data on Documents is silently dropped during writes.
 - \*\***kwargs** (<code>Any</code>) – Optional arguments that `Elasticsearch` takes.
 
 #### client