Search for threads.
search(
self,
*,
metadata: Json = None,
values: Json = None,
ids: Sequence[str] | None = None,
status: ThreadStatus | None = None,
limit: int = 10,
offset: int = 0,
sort_by: ThreadSortBy | None = None,
sort_order: SortOrder | None = None,
select: list[ThreadSelectField] | None = None,
headers: Mapping[str, str] | None = None,
params: QueryParamTypes | None = None
) -> list[Thread]client = get_client(url="http://localhost:2024")
threads = await client.threads.search(
metadata={"number":1},
status="interrupted",
limit=15,
offset=5
)| Name | Type | Description |
|---|---|---|
metadata | Json | Default: NoneThread metadata to filter on. |
values | Json | Default: NoneState values to filter on. |
ids | Sequence[str] | None | Default: NoneList of thread IDs to filter by. |
status | ThreadStatus | None | Default: NoneThread status to filter on. Must be one of 'idle', 'busy', 'interrupted' or 'error'. |
limit | int | Default: 10Limit on number of threads to return. |
offset | int | Default: 0Offset in threads table to start search from. |
sort_by | ThreadSortBy | None | Default: NoneSort by field. |
sort_order | SortOrder | None | Default: NoneSort order. |
headers | Mapping[str, str] | None | Default: NoneOptional custom headers to include with the request. |
params | QueryParamTypes | None | Default: NoneOptional query parameters to include with the request. |