Skip to content

Commit 1f3dcad

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

16 files changed

Lines changed: 800 additions & 32 deletions

File tree

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

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,22 @@ Deserializes the component from a dictionary.
7676

7777
- <code>WeaviateBM25Retriever</code> – Deserialized component.
7878

79+
#### close
80+
81+
```python
82+
close() -> None
83+
```
84+
85+
Release the synchronous resources of the underlying Document Store.
86+
87+
#### close_async
88+
89+
```python
90+
close_async() -> None
91+
```
92+
93+
Release the asynchronous resources of the underlying Document Store.
94+
7995
#### run
8096

8197
```python
@@ -187,6 +203,22 @@ Deserializes the component from a dictionary.
187203

188204
- <code>WeaviateEmbeddingRetriever</code> – Deserialized component.
189205

206+
#### close
207+
208+
```python
209+
close() -> None
210+
```
211+
212+
Release the synchronous resources of the underlying Document Store.
213+
214+
#### close_async
215+
216+
```python
217+
close_async() -> None
218+
```
219+
220+
Release the asynchronous resources of the underlying Document Store.
221+
190222
#### run
191223

192224
```python
@@ -340,6 +372,22 @@ Deserializes the component from a dictionary.
340372

341373
- <code>WeaviateHybridRetriever</code> – Deserialized component.
342374

375+
#### close
376+
377+
```python
378+
close() -> None
379+
```
380+
381+
Release the synchronous resources of the underlying Document Store.
382+
383+
#### close_async
384+
385+
```python
386+
close_async() -> None
387+
```
388+
389+
Release the asynchronous resources of the underlying Document Store.
390+
343391
#### run
344392

345393
```python
@@ -704,15 +752,15 @@ Return the asynchronous Weaviate collection, initializing it via the async clien
704752
close() -> None
705753
```
706754

707-
Close the synchronous Weaviate client connection.
755+
Release the associated synchronous resources.
708756

709757
#### close_async
710758

711759
```python
712760
close_async() -> None
713761
```
714762

715-
Close the asynchronous Weaviate client connection.
763+
Release the associated asynchronous resources.
716764

717765
#### to_dict
718766

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

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,22 @@ Deserializes the component from a dictionary.
7676

7777
- <code>WeaviateBM25Retriever</code> – Deserialized component.
7878

79+
#### close
80+
81+
```python
82+
close() -> None
83+
```
84+
85+
Release the synchronous resources of the underlying Document Store.
86+
87+
#### close_async
88+
89+
```python
90+
close_async() -> None
91+
```
92+
93+
Release the asynchronous resources of the underlying Document Store.
94+
7995
#### run
8096

8197
```python
@@ -187,6 +203,22 @@ Deserializes the component from a dictionary.
187203

188204
- <code>WeaviateEmbeddingRetriever</code> – Deserialized component.
189205

206+
#### close
207+
208+
```python
209+
close() -> None
210+
```
211+
212+
Release the synchronous resources of the underlying Document Store.
213+
214+
#### close_async
215+
216+
```python
217+
close_async() -> None
218+
```
219+
220+
Release the asynchronous resources of the underlying Document Store.
221+
190222
#### run
191223

192224
```python
@@ -340,6 +372,22 @@ Deserializes the component from a dictionary.
340372

341373
- <code>WeaviateHybridRetriever</code> – Deserialized component.
342374

375+
#### close
376+
377+
```python
378+
close() -> None
379+
```
380+
381+
Release the synchronous resources of the underlying Document Store.
382+
383+
#### close_async
384+
385+
```python
386+
close_async() -> None
387+
```
388+
389+
Release the asynchronous resources of the underlying Document Store.
390+
343391
#### run
344392

345393
```python
@@ -704,15 +752,15 @@ Return the asynchronous Weaviate collection, initializing it via the async clien
704752
close() -> None
705753
```
706754

707-
Close the synchronous Weaviate client connection.
755+
Release the associated synchronous resources.
708756

709757
#### close_async
710758

711759
```python
712760
close_async() -> None
713761
```
714762

715-
Close the asynchronous Weaviate client connection.
763+
Release the associated asynchronous resources.
716764

717765
#### to_dict
718766

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

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,22 @@ Deserializes the component from a dictionary.
7676

7777
- <code>WeaviateBM25Retriever</code> – Deserialized component.
7878

79+
#### close
80+
81+
```python
82+
close() -> None
83+
```
84+
85+
Release the synchronous resources of the underlying Document Store.
86+
87+
#### close_async
88+
89+
```python
90+
close_async() -> None
91+
```
92+
93+
Release the asynchronous resources of the underlying Document Store.
94+
7995
#### run
8096

8197
```python
@@ -187,6 +203,22 @@ Deserializes the component from a dictionary.
187203

188204
- <code>WeaviateEmbeddingRetriever</code> – Deserialized component.
189205

206+
#### close
207+
208+
```python
209+
close() -> None
210+
```
211+
212+
Release the synchronous resources of the underlying Document Store.
213+
214+
#### close_async
215+
216+
```python
217+
close_async() -> None
218+
```
219+
220+
Release the asynchronous resources of the underlying Document Store.
221+
190222
#### run
191223

192224
```python
@@ -340,6 +372,22 @@ Deserializes the component from a dictionary.
340372

341373
- <code>WeaviateHybridRetriever</code> – Deserialized component.
342374

375+
#### close
376+
377+
```python
378+
close() -> None
379+
```
380+
381+
Release the synchronous resources of the underlying Document Store.
382+
383+
#### close_async
384+
385+
```python
386+
close_async() -> None
387+
```
388+
389+
Release the asynchronous resources of the underlying Document Store.
390+
343391
#### run
344392

345393
```python
@@ -704,15 +752,15 @@ Return the asynchronous Weaviate collection, initializing it via the async clien
704752
close() -> None
705753
```
706754

707-
Close the synchronous Weaviate client connection.
755+
Release the associated synchronous resources.
708756

709757
#### close_async
710758

711759
```python
712760
close_async() -> None
713761
```
714762

715-
Close the asynchronous Weaviate client connection.
763+
Release the associated asynchronous resources.
716764

717765
#### to_dict
718766

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

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,22 @@ Deserializes the component from a dictionary.
7676

7777
- <code>WeaviateBM25Retriever</code> – Deserialized component.
7878

79+
#### close
80+
81+
```python
82+
close() -> None
83+
```
84+
85+
Release the synchronous resources of the underlying Document Store.
86+
87+
#### close_async
88+
89+
```python
90+
close_async() -> None
91+
```
92+
93+
Release the asynchronous resources of the underlying Document Store.
94+
7995
#### run
8096

8197
```python
@@ -187,6 +203,22 @@ Deserializes the component from a dictionary.
187203

188204
- <code>WeaviateEmbeddingRetriever</code> – Deserialized component.
189205

206+
#### close
207+
208+
```python
209+
close() -> None
210+
```
211+
212+
Release the synchronous resources of the underlying Document Store.
213+
214+
#### close_async
215+
216+
```python
217+
close_async() -> None
218+
```
219+
220+
Release the asynchronous resources of the underlying Document Store.
221+
190222
#### run
191223

192224
```python
@@ -340,6 +372,22 @@ Deserializes the component from a dictionary.
340372

341373
- <code>WeaviateHybridRetriever</code> – Deserialized component.
342374

375+
#### close
376+
377+
```python
378+
close() -> None
379+
```
380+
381+
Release the synchronous resources of the underlying Document Store.
382+
383+
#### close_async
384+
385+
```python
386+
close_async() -> None
387+
```
388+
389+
Release the asynchronous resources of the underlying Document Store.
390+
343391
#### run
344392

345393
```python
@@ -704,15 +752,15 @@ Return the asynchronous Weaviate collection, initializing it via the async clien
704752
close() -> None
705753
```
706754

707-
Close the synchronous Weaviate client connection.
755+
Release the associated synchronous resources.
708756

709757
#### close_async
710758

711759
```python
712760
close_async() -> None
713761
```
714762

715-
Close the asynchronous Weaviate client connection.
763+
Release the associated asynchronous resources.
716764

717765
#### to_dict
718766

0 commit comments

Comments
 (0)