Skip to content

Commit 81c9c58

Browse files
docs: sync Core Integrations API reference (elasticsearch) on Docusaurus (#12115)
Co-authored-by: anakin87 <44616784+anakin87@users.noreply.github.com>
1 parent a8ffb71 commit 81c9c58

16 files changed

Lines changed: 1040 additions & 16 deletions

File tree

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

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,22 @@ Deserializes the component from a dictionary.
100100

101101
- <code>ElasticsearchBM25Retriever</code> – Deserialized component.
102102

103+
#### close
104+
105+
```python
106+
close() -> None
107+
```
108+
109+
Release the synchronous resources of the underlying Document Store.
110+
111+
#### close_async
112+
113+
```python
114+
close_async() -> None
115+
```
116+
117+
Release the asynchronous resources of the underlying Document Store.
118+
103119
#### run
104120

105121
```python
@@ -247,6 +263,22 @@ Deserializes the component from a dictionary.
247263

248264
- <code>ElasticsearchEmbeddingRetriever</code> – Deserialized component.
249265

266+
#### close
267+
268+
```python
269+
close() -> None
270+
```
271+
272+
Release the synchronous resources of the underlying Document Store.
273+
274+
#### close_async
275+
276+
```python
277+
close_async() -> None
278+
```
279+
280+
Release the asynchronous resources of the underlying Document Store.
281+
250282
#### run
251283

252284
```python
@@ -377,6 +409,22 @@ Deserializes the component from a dictionary.
377409

378410
- <code>ElasticsearchSQLRetriever</code> – Deserialized component.
379411

412+
#### close
413+
414+
```python
415+
close() -> None
416+
```
417+
418+
Release the synchronous resources of the underlying Document Store.
419+
420+
#### close_async
421+
422+
```python
423+
close_async() -> None
424+
```
425+
426+
Release the asynchronous resources of the underlying Document Store.
427+
380428
#### run
381429

382430
```python
@@ -557,7 +605,23 @@ Returns the synchronous Elasticsearch client, initializing it if necessary.
557605
async_client: AsyncElasticsearch
558606
```
559607

560-
Returns the asynchronous Elasticsearch client, initializing it if necessary.
608+
Returns the asynchronous Elasticsearch client, constructing it if necessary.
609+
610+
#### close
611+
612+
```python
613+
close() -> None
614+
```
615+
616+
Release the associated synchronous resources.
617+
618+
#### close_async
619+
620+
```python
621+
close_async() -> None
622+
```
623+
624+
Release the associated asynchronous resources.
561625

562626
#### to_dict
563627

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

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,22 @@ Deserializes the component from a dictionary.
100100

101101
- <code>ElasticsearchBM25Retriever</code> – Deserialized component.
102102

103+
#### close
104+
105+
```python
106+
close() -> None
107+
```
108+
109+
Release the synchronous resources of the underlying Document Store.
110+
111+
#### close_async
112+
113+
```python
114+
close_async() -> None
115+
```
116+
117+
Release the asynchronous resources of the underlying Document Store.
118+
103119
#### run
104120

105121
```python
@@ -247,6 +263,22 @@ Deserializes the component from a dictionary.
247263

248264
- <code>ElasticsearchEmbeddingRetriever</code> – Deserialized component.
249265

266+
#### close
267+
268+
```python
269+
close() -> None
270+
```
271+
272+
Release the synchronous resources of the underlying Document Store.
273+
274+
#### close_async
275+
276+
```python
277+
close_async() -> None
278+
```
279+
280+
Release the asynchronous resources of the underlying Document Store.
281+
250282
#### run
251283

252284
```python
@@ -377,6 +409,22 @@ Deserializes the component from a dictionary.
377409

378410
- <code>ElasticsearchSQLRetriever</code> – Deserialized component.
379411

412+
#### close
413+
414+
```python
415+
close() -> None
416+
```
417+
418+
Release the synchronous resources of the underlying Document Store.
419+
420+
#### close_async
421+
422+
```python
423+
close_async() -> None
424+
```
425+
426+
Release the asynchronous resources of the underlying Document Store.
427+
380428
#### run
381429

382430
```python
@@ -557,7 +605,23 @@ Returns the synchronous Elasticsearch client, initializing it if necessary.
557605
async_client: AsyncElasticsearch
558606
```
559607

560-
Returns the asynchronous Elasticsearch client, initializing it if necessary.
608+
Returns the asynchronous Elasticsearch client, constructing it if necessary.
609+
610+
#### close
611+
612+
```python
613+
close() -> None
614+
```
615+
616+
Release the associated synchronous resources.
617+
618+
#### close_async
619+
620+
```python
621+
close_async() -> None
622+
```
623+
624+
Release the associated asynchronous resources.
561625

562626
#### to_dict
563627

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

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,22 @@ Deserializes the component from a dictionary.
100100

101101
- <code>ElasticsearchBM25Retriever</code> – Deserialized component.
102102

103+
#### close
104+
105+
```python
106+
close() -> None
107+
```
108+
109+
Release the synchronous resources of the underlying Document Store.
110+
111+
#### close_async
112+
113+
```python
114+
close_async() -> None
115+
```
116+
117+
Release the asynchronous resources of the underlying Document Store.
118+
103119
#### run
104120

105121
```python
@@ -247,6 +263,22 @@ Deserializes the component from a dictionary.
247263

248264
- <code>ElasticsearchEmbeddingRetriever</code> – Deserialized component.
249265

266+
#### close
267+
268+
```python
269+
close() -> None
270+
```
271+
272+
Release the synchronous resources of the underlying Document Store.
273+
274+
#### close_async
275+
276+
```python
277+
close_async() -> None
278+
```
279+
280+
Release the asynchronous resources of the underlying Document Store.
281+
250282
#### run
251283

252284
```python
@@ -377,6 +409,22 @@ Deserializes the component from a dictionary.
377409

378410
- <code>ElasticsearchSQLRetriever</code> – Deserialized component.
379411

412+
#### close
413+
414+
```python
415+
close() -> None
416+
```
417+
418+
Release the synchronous resources of the underlying Document Store.
419+
420+
#### close_async
421+
422+
```python
423+
close_async() -> None
424+
```
425+
426+
Release the asynchronous resources of the underlying Document Store.
427+
380428
#### run
381429

382430
```python
@@ -557,7 +605,23 @@ Returns the synchronous Elasticsearch client, initializing it if necessary.
557605
async_client: AsyncElasticsearch
558606
```
559607

560-
Returns the asynchronous Elasticsearch client, initializing it if necessary.
608+
Returns the asynchronous Elasticsearch client, constructing it if necessary.
609+
610+
#### close
611+
612+
```python
613+
close() -> None
614+
```
615+
616+
Release the associated synchronous resources.
617+
618+
#### close_async
619+
620+
```python
621+
close_async() -> None
622+
```
623+
624+
Release the associated asynchronous resources.
561625

562626
#### to_dict
563627

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

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,22 @@ Deserializes the component from a dictionary.
100100

101101
- <code>ElasticsearchBM25Retriever</code> – Deserialized component.
102102

103+
#### close
104+
105+
```python
106+
close() -> None
107+
```
108+
109+
Release the synchronous resources of the underlying Document Store.
110+
111+
#### close_async
112+
113+
```python
114+
close_async() -> None
115+
```
116+
117+
Release the asynchronous resources of the underlying Document Store.
118+
103119
#### run
104120

105121
```python
@@ -247,6 +263,22 @@ Deserializes the component from a dictionary.
247263

248264
- <code>ElasticsearchEmbeddingRetriever</code> – Deserialized component.
249265

266+
#### close
267+
268+
```python
269+
close() -> None
270+
```
271+
272+
Release the synchronous resources of the underlying Document Store.
273+
274+
#### close_async
275+
276+
```python
277+
close_async() -> None
278+
```
279+
280+
Release the asynchronous resources of the underlying Document Store.
281+
250282
#### run
251283

252284
```python
@@ -377,6 +409,22 @@ Deserializes the component from a dictionary.
377409

378410
- <code>ElasticsearchSQLRetriever</code> – Deserialized component.
379411

412+
#### close
413+
414+
```python
415+
close() -> None
416+
```
417+
418+
Release the synchronous resources of the underlying Document Store.
419+
420+
#### close_async
421+
422+
```python
423+
close_async() -> None
424+
```
425+
426+
Release the asynchronous resources of the underlying Document Store.
427+
380428
#### run
381429

382430
```python
@@ -557,7 +605,23 @@ Returns the synchronous Elasticsearch client, initializing it if necessary.
557605
async_client: AsyncElasticsearch
558606
```
559607

560-
Returns the asynchronous Elasticsearch client, initializing it if necessary.
608+
Returns the asynchronous Elasticsearch client, constructing it if necessary.
609+
610+
#### close
611+
612+
```python
613+
close() -> None
614+
```
615+
616+
Release the associated synchronous resources.
617+
618+
#### close_async
619+
620+
```python
621+
close_async() -> None
622+
```
623+
624+
Release the associated asynchronous resources.
561625

562626
#### to_dict
563627

0 commit comments

Comments
 (0)