@@ -54,6 +54,14 @@ run_async(
5454
5555Async variant of :meth:` run ` .
5656
57+ #### close
58+
59+ ``` python
60+ close() -> None
61+ ```
62+
63+ Release the synchronous resources of the underlying Document Store.
64+
5765#### to_dict
5866
5967``` python
@@ -191,6 +199,14 @@ Initialise the document store and optionally create the backing table and indexe
191199- <code >ValueError</code > – If ` table_name ` is not a valid Oracle identifier or ` embedding_dim ` is not
192200 a positive integer.
193201
202+ #### close
203+
204+ ``` python
205+ close() -> None
206+ ```
207+
208+ Release the associated synchronous resources.
209+
194210#### create_keyword_index
195211
196212``` python
@@ -635,7 +651,7 @@ get_metadata_field_unique_values(
635651 metadata_field: str ,
636652 search_term: str | None = None ,
637653 from_: int = 0 ,
638- size: int | None = None ,
654+ size: int | None = 10 ,
639655) -> tuple[list[str ], int ]
640656```
641657
@@ -645,10 +661,10 @@ Return a paginated list of distinct values for a metadata field, plus the total
645661
646662- ** metadata_field** (<code >str</code >) – Metadata field name. May be prefixed with ` "meta." `
647663 (e.g. ` "meta.lang" ` or ` "lang" ` ).
648- - ** search_term** (<code >str | None</code >) – Optional substring filter applied to both the document text and the field value.
664+ - ** search_term** (<code >str | None</code >) – Optional case-insensitive substring filter applied to the metadata field's own value.
649665- ** from\_ ** (<code >int</code >) – Zero-based offset for pagination. Defaults to ` 0 ` .
650- - ** size** (<code >int | None</code >) – Maximum number of values to return. When ` None ` all values from ` from_ ` onward
651- are returned.
666+ - ** size** (<code >int | None</code >) – Maximum number of values to return. Defaults to ` 10 ` . When ` None ` all values
667+ from ` from_ ` onward are returned.
652668
653669** Returns:**
654670
@@ -707,7 +723,7 @@ get_metadata_field_unique_values_async(
707723 metadata_field: str ,
708724 search_term: str | None = None ,
709725 from_: int = 0 ,
710- size: int | None = None ,
726+ size: int | None = 10 ,
711727) -> tuple[list[str ], int ]
712728```
713729
@@ -717,10 +733,10 @@ Asynchronously returns a paginated list of distinct values for a metadata field,
717733
718734- ** metadata_field** (<code >str</code >) – Metadata field name. May be prefixed with ` "meta." `
719735 (e.g. ` "meta.lang" ` or ` "lang" ` ).
720- - ** search_term** (<code >str | None</code >) – Optional substring filter applied to both the document text and the field value.
736+ - ** search_term** (<code >str | None</code >) – Optional case-insensitive substring filter applied to the metadata field's own value.
721737- ** from\_ ** (<code >int</code >) – Zero-based offset for pagination. Defaults to ` 0 ` .
722- - ** size** (<code >int | None</code >) – Maximum number of values to return. When ` None ` all values from ` from_ ` onward
723- are returned.
738+ - ** size** (<code >int | None</code >) – Maximum number of values to return. Defaults to ` 10 ` . When ` None ` all values
739+ from ` from_ ` onward are returned.
724740
725741** Returns:**
726742
0 commit comments