j$ddlZddlmZmZddlZddlmZddlmZddl m Z m Z m Z ddl m Z dd lmZdd lmZdd lmZej(eZGd d Zy)N)ListOptional) TraceThread)BatchFeedbackScoreDict)helpersrest_stream_parser constants)config)messages)sequence_splitter)trace_thread_filterc eZdZdZddZ ddeedeededede e f d Z dd e e deeddfd Z d ededdfd ZeddZy) ThreadsClienta Client for managing and interacting with conversational threads. This class provides methods for searching threads and logging feedback scores related to threads using an underlying client instance. It is intended to be used in scenarios where thread management and feedback tracking are required. Args: client: Instance of the underlying OPIK client. c||_yN _opik_client)selfclients /Users/manta/Documents/Projects/TheRoad-I1/backend/.venv/lib/python3.12/site-packages/opik/api_objects/threads/threads_client.py__init__zThreadsClient.__init__s "N project_name filter_string max_resultstruncatereturnctj|tjdxsjj t jfd|t}|S)aSearch for threads in a given project based on specific criteria. This method retrieves a list of TraceThread objects that match the specified filter criteria. It takes an optional project name, a filter string to narrow down the results, and a maximum number of threads to return. The filter string should be a string that represents a filter condition in the form of a string expression. For example, to search for threads with a specific status, you could use the following filter string: `filter_string = 'status = "active"'`. The filter string can include logical operators (AND) to combine multiple conditions, for example, `filter_string = 'status = "active" and id = "{thread_id}"'`. Args: project_name: The name of the project to search the threads for. If None, the search will include threads from all projects. filter_string: A filter string to narrow down the search using Opik Query Language (OQL). The format is: " [AND ]*" Supported columns include: - `id`, `name`, `created_by`, `thread_id`, `type`, `model`, `provider`: String fields with full operator support - `status`: String field (=, contains, not_contains only) - `start_time`, `end_time`: DateTime fields (use ISO 8601 format, e.g., "2024-01-01T00:00:00Z") - `input`, `output`: String fields for content (=, contains, not_contains only) - `metadata`: Dictionary field (use dot notation, e.g., "metadata.model") - `feedback_scores`: Numeric field (use dot notation, e.g., "feedback_scores.accuracy") - `tags`: List field (use "contains" operator only) - `usage.total_tokens`, `usage.prompt_tokens`, `usage.completion_tokens`: Numeric usage fields - `duration`, `number_of_messages`, `total_estimated_cost`: Numeric fields Supported operators by column: - `id`, `name`, `created_by`, `thread_id`, `type`, `model`, `provider`: =, !=, contains, not_contains, starts_with, ends_with, >, < - `status`: =, contains, not_contains - `start_time`, `end_time`: =, >, <, >=, <= - `input`, `output`: =, contains, not_contains - `metadata`: =, contains, >, < - `feedback_scores`: =, >, <, >=, <=, is_empty, is_not_empty - `tags`: contains (only) - `usage.total_tokens`, `usage.prompt_tokens`, `usage.completion_tokens`, `duration`, `number_of_messages`, `total_estimated_cost`: =, !=, >, <, >=, <= Examples: - `status = "inactive"` - Filter by thread status - `id = "thread_123"` - Filter by specific thread ID - `duration > 300` - Filter by thread duration (seconds) - `number_of_messages >= 5` - Filter by message count - `feedback_scores.user_frustration > 0.5` - Filter by feedback score - `feedback_scores.my_metric is_empty` - Filter threads with empty feedback score - `feedback_scores.my_metric is_not_empty` - Filter threads with non-empty feedback score - `tags contains "important"` - Filter by tag If not provided, all threads in the project will be returned up to the limit. max_results: The maximum number of threads to retrieve. The default value is 1000 if not specified. truncate: Whether to truncate image data stored in input, output, or metadata Returns: List[TraceThread]: A list of TraceThread objects that match the search criteria. Example: >>> from opik import Opik >>> client = Opik(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME") >>> thread_id = "your_thread_id" >>> threads = client.get_threads_client().search_threads( >>> project_name="Demo Project", >>> filter_string=f'id = "{thread_id}"', >>> max_results=10) threads)parsed_item_class entity_typecljjjj||S)N)rfilterslimitrlast_retrieved_thread_model_id)r rest_clienttracessearch_trace_threads)current_batch_sizelast_retrieved_idr%rrrs rz.ThreadsClient.search_threads..xs8#00<<CCXX)(!/@ Y r) read_sourcerr") rparse_filter_expressionsrTraceThreadFilterrrr read_and_parse_full_streamr)rrrrrr!r%s`` ` @rsearch_threadszThreadsClient.search_threads!sa\22 1CC!  $Et'8'8'E'E $??$)  rscoresc|xs|jj}tj||tj t }|t jd|ytj|tjtjD]=}t j|}|jjj!|?y)a Logs feedback scores for threads in a specific project. This method processes the given feedback scores and associates them with the specified project if a project name is provided. It is designed to handle multiple scores in a structured manner. Args: scores: A list of dictionaries containing feedback scores for threads to be logged. Specifying a thread id via `id` key for each score is mandatory. project_name: The name of the project to associate with the logged scores. If not provided, the project name configured in the Opik client will be used. This parameter is used as a fallback if `project_name` is not specified in the score dictionary. )r3rr"loggerNz>%&BB    ! LLNvhW  &99  & 8 8 ?? E ==EJ 6    ' ' + +,U V r thread_idcddl}|jdtd|jjj j ||y)a Closes a thread in a specific project. .. deprecated:: This method is deprecated. Thread status (active/inactive) is no longer required for adding feedback scores. Feedback scores can now be added to threads at any time. This method is kept for backwards compatibility but will be removed in a future version. Args: thread_id: The identifier of the thread to close. project_name: The name of the project to close the thread in. rNzclose_thread() is deprecated. Thread status is no longer required for adding feedback scores. Feedback scores can now be added to threads at any time. This method will be removed in a future version.r) stacklevel)rFr)warningswarnDeprecationWarningrr(r)close_trace_thread)rrFrrIs r close_threadzThreadsClient.close_threadsS   I    %%,,??l @ rc|jSrr)rs r opik_clientzThreadsClient.opik_clients   r)r opik.Opik)NNiTr)rrP)__name__ __module__ __qualname____doc__rrstrintboolrrr2rrErMpropertyrOrrrrs # '+'+ bsmb }b b  b k  bJSW&W12&WBJ3-&W &WP c   6!!rr)loggingtypingrropik opik.rest_apir opik.typesrrr r r message_processingr message_processing.batchingrrest_api.typesr getLoggerrQr;rrYrrrdsF! %-55*<1   8 $x!x!r