list_search_history
Retrieve search history from a deepset workspace to analyze user queries, pipeline performance, and feedback. Filter and paginate results for targeted inspection.
Instructions
Retrieves search history for the configured deepset workspace.
Returns past searches run in the workspace, including queries, answers, prompts, feedback, and metadata. Use this to inspect what users have searched for, analyze usage, or debug pipeline behavior.
Each entry includes:
request.query— the search query texttime/created_at— when the search randuration— how long it took (seconds)status— 'success' or 'failed'pipeline.name— which pipeline handled the queryresponse— the list of search resultsfeedback,labels,note— user annotations
Use the after parameter with the next_cursor value from the
previous response to fetch the next page.
:param limit: Maximum number of entries to return per page (default 10, max 1000).
:param after: ISO-8601 timestamp cursor to fetch entries older than this point.
Pass the value from next_cursor on the previous response.
:param query_filter: An OData filter expression to narrow down results.
Supported fields: query, client_source_path, pipeline_version_id, answer,
api_key, created_at, created_by, tags/tag_id, feedbacks, feedbacks/score,
feedbacks/comment, feedbacks/bookmarked, session_id, search_session_id,
feedbacks/result_id, request/filters, request/params, duration, labels,
status, note.
Example: "created_at ge 2024-01-01T00:00:00Z" or "query eq 'my search'".
:param sort_field: Field to sort results by. One of: created_at, query,
duration, feedbacks/score. Defaults to created_at.
:param sort_order: Sort direction — ASC (oldest first) or DESC (newest first).
Defaults to DESC.
:returns: Paginated list of search history entries or error message.
The output is automatically stored and can be referenced in other functions.
Returns a formatted preview with an object ID (e.g., @obj_123).
Use the object store tools in combination with the object ID to view nested properties of the object.
Use the returned object ID to pass this result to other functions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | ||
| limit | No | ||
| sort_field | No | created_at | |
| sort_order | No | DESC | |
| query_filter | No |