jPddlmZmZmZmZmZddlZddlZddlZ ddl m Z m Z ddl mZddlmZddlmZddlmZej.Gd d ZGd d Zy) )AnyDictListOptionalTupleN)clientPromptVersionUpdate)core)prompt_version_detail)opik_query_language)typescDeZdZUdZeed<eed<ejed<y)PromptSearchResultz_Result from searching prompts, containing name, template structure, and latest version details.nametemplate_structurer N)__name__ __module__ __qualname____doc__str__annotations__r PromptVersionDetailw/Users/manta/Documents/Projects/TheRoad-I1/backend/.venv/lib/python3.12/site-packages/opik/api_objects/prompt/client.pyrr si I0DDDrrceZdZdejfdZejjdddddfde de de e e e fdejd e d e e d e e d e e d e e e dejfdZ d!de de dej"de e e e fd e d e e d e e d e e d e e e dejfdZde de ejfdZ d"de de e de e de ejfdZ d"de de e de e de ejfdZ d"de de e de e de ejfdZdddde e de e e e e fde efdZ d"de e d e e e de eddfd Zy)# PromptClientrc||_y)N) _rest_client)selfrs r__init__zPromptClient.__init__s "rtextNrpromptmetadatatyperid descriptionchange_descriptiontagsreturnc ,|j|} d} | | j|k7r,tjj || j||dk(r; t j | j} t j |} | | k(} n| j|k(} | *| r(| j|k7s| j|jk7r|j|||||||||  } | S#t jtf$r| j|k(} YrwxYw)a Creates the prompt detail for the given prompt name and template. Parameters: - name: The name of the prompt. - prompt: The template content for the prompt. - metadata: Optional metadata for the prompt. - type: The template type (MUSTACHE or JINJA2). - template_structure: Either "text" (default) or "chat". - id: Optional unique identifier (UUID) for the prompt. - description: Optional description of the prompt (up to 255 characters). - change_description: Optional description of changes in this version. - tags: Optional list of tags to associate with the prompt. Returns: - A Prompt object for the provided prompt name and template. Raises: - PromptTemplateStructureMismatch: If a prompt with the same name already exists but has a different template_structure (e.g., trying to create a text prompt when a chat prompt exists, or vice versa). Template structure is immutable after prompt creation. F prompt_nameexisting_structureattempted_structurechat) rr$r&r%rr'r(r)r*)_get_latest_versionropik exceptionsPromptTemplateStructureMismatchjsonloadstemplateJSONDecodeError TypeErrorr%r&value_create_new_version)r!rr$r%r&rr'r(r)r*prompt_versiontemplates_equalexisting_messages new_messagess r create_promptzPromptClient.create_prompts=D11$7   %004FFooEE $'5'H'H(:F "V+H(, >3J3J(K%#'::f#5L&7<&GO#1"9"9V"C  ""&&(2""djj0!55!#5'#56 N;,,i8H&4&=&=&GOHs9C(((DDc |j|} | ||| |jjj|||||||||  |jjj |} | | j t j| j| j| j| j| j| j| j| | j| j | j"| j$ } | St j|||} |jjj'|| |} | S)N) rr'r(r8r%r)r&rr*r r' prompt_idcommitr8r%r&r)r* variablesr created_at created_by)r8r%r&)rversionr)r2r promptsrAretrieve_prompt_versionr*r rr'rErFr8r%r&r)rGrrHrIcreate_prompt_version) r!rr$r&r%rr'r(r)r*existing_versionnew_prompt_version_detailnew_prompt_version_detail_datas rr<z PromptClient._create_new_versionmsv 33D9  # Nk59I    % % 3 3'!#5#5 4 !!))AAB &$=$B$B$J,A,U,U0337AA4;;6??6??277'@'S'S7AA'@'S'S8CC8CC -)4)(.C-V-V!. * )-(9(9(A(A(W(W6#5)X) % )(rc(|j|dS)NrrF) get_prompt)r!rs rr2z PromptClient._get_latest_versionsD66rrFraise_if_not_template_structurecd |jjj||}|jduxr|dk(}|r|S|;|j|k7r,tj j ||j||S#tj$r}|jdk7r|Yd}~yd}~wwxYw)a Retrieve the prompt detail for a given prompt name and commit version. Parameters: name: The name of the prompt. commit: An optional commit version of the prompt. If not provided, the latest version is retrieved. raise_if_not_template_structure: Optional template structure validation. If provided and doesn't match, raises PromptTemplateStructureMismatch. Returns: Prompt: The details of the specified prompt. rRNr#r-) r rKrLrr3r4r5 rest_api_coreApiError status_code)r!rrFrTr=should_skip_validationes rrSzPromptClient.get_prompts" !..66NNON 11T9>3v= #&%%0;"559XXooEE $'5'H'H(GF " !%% }}#$  s?B>BB/B**B/search filter_stringc( |jjj|j}|t |dk(rt d|z|Dcgc]}||j k(s|j }}t |dk(rt d|zd}|r+tjj|}|j}|d} |j| ||Scc}w#tj$r} | jdk7r| Yd} ~ gSd} ~ wwxYw)a4 Retrieve all the prompt details for a given prompt name. Parameters: name: The name of the prompt. search: Optional search text to find in template or change description fields. filter_string: A filter string to narrow down the search using Opik Query Language (OQL). The format is: " [AND ]*" Supported columns include: - `id`, `commit`, `template`, `change_description`, `created_by`: String fields with full operator support - `metadata`: Dictionary field (use dot notation, e.g., "metadata.environment") - `type`: Enum field (=, != only) - `tags`: List field (use "contains" operator only) - `created_at`: DateTime field (use ISO 8601 format, e.g., "2024-01-01T00:00:00Z") Examples: - `tags contains "production"` - Filter by tag - `tags contains "v1" AND tags contains "production"` - Filter by multiple tags - `template contains "customer"` - Filter by template content - `created_by = "user@example.com"` - Filter by creator - `created_at >= "2024-01-01T00:00:00Z"` - Filter by creation date - `metadata.environment = "prod"` - Filter by metadata field Returns: List[PromptVersionDetail]: A list of prompt versions for the given name. Example: # Get all versions of a prompt versions = prompt_client.get_all_prompt_versions(name="my-prompt") # Filter by tags (versions containing "production" tag) versions = prompt_client.get_all_prompt_versions( name="my-prompt", filter_string='tags contains "production"' ) # Search for specific text in template or change description fields versions = prompt_client.get_all_prompt_versions( name="my-prompt", search="customer" ) # Combine search and filtering versions = prompt_client.get_all_prompt_versions( name="my-prompt", search="customer", filter_string='tags contains "production"' ) rCNrzNo prompts found for name: )r\filtersrV)r rK get_promptscontentlen ValueErrorrr'r OpikQueryLanguagefor_prompt_versionsparsed_filters$_get_prompt_versions_by_id_paginatedrWrXrY) r!rr\r]prompts_matching_name_stringxfiltered_prompt_listr_oqlrEr[s rget_all_prompt_versionsz$PromptClient.get_all_prompt_versionss;p +/+<+<+D+D+P+P,Q,g )-4349 !>!EFF;$:daffn: !$'(A- !>!EFF%)G);;OO!,,,Q/I<<&'= $$%% }}#$  s1AC"C)C7A%C"C""D5D  DrEr_cd}d}g} |jjj|||||j}|xsg}|j |D cgc]z} t j | j| j| j| j| j| j| j| j| j |c} t!||kr |S|dz }cc} w)Nr d)r'pagesizer\r_) r'rEr8r&r%rFrHrIr*)r rKget_prompt_versionsraextendr rr'rEr8r&r%rFrHrIr*rb) r!rEr\r_rorprKprompt_versions_pageversionsrJs rrgz1PromptClient._get_prompt_versions_by_id_paginatedCs  CE#'#4#4#<#<#P#P $Q$ g !,1rH NN$,$,*=="::")"3"3!(!1!1$\\!(!1!1&~~#*#5#5#*#5#5$\\ $, &8}t# AID?sA?C.)rrfrfcZ |tj|nd}d}d}g} |jjj ||||}|j xsg}t |dk(rnY|j|D cgc])} | j| jxsd| jf+c} t ||krn|dz }t |dk(rgSg} |D]\} } } |jjj| }| |jtj|j|j|j |j"|j$|j&|j(| |j*|j|j,|j. }| j1t3| | | | Scc} w#t4j6$r}|j8d k(rYd}~|d}~wwxYw#t4j6$r}|j8d k7r|gcYd}~Sd}~wwxYw) a Search prompt containers by optional name substring and filters, then return the latest version detail for each matched prompt container. Parameters: name: Optional substring of the prompt name to search for. parsed_filters: List of parsed filters (OQL) that will be stringified for the backend. Returns: List[PromptSearchResult]: Each result contains name, template_structure, and prompt_version_detail. Nr i)rorprr_rr#rCrD)rrr rV)r6dumpsr rKr`rarbrrrrr*rLr rr'rErFr8r%r&r)rGrHrIappendrrWrXrY)r!rrf filters_strrorp prompt_info prompts_pagerapresultsr.rr*latest_versionr[s rsearch_promptszPromptClient.search_promptsosE"H .<.H >*d  DDFHK#0088DD' E  '..4"w<1$""OVWw!affa22%>%V%V(&W&N'N,?,?,G)>)R)R-00&4&>&>#1#8#8%3%<%<%3%<%&>/=/P/P'5'@'@'5'@'@ *NN*!,/A2@-:EFN]XP%--}}+ G %% }}#I sgA7G:9.G'+G: G:C G?G:G:G7G2*G:0G22G77G::H* H%H*%H* version_idsmergeclt|}|jjj|||y)a` Update tags for one or more prompt versions in a single batch operation. Parameters: version_ids: List of prompt version IDs to update. tags: Tags to set or merge. Semantics: - None: No change to tags (preserves existing tags). - []: Clear all tags (when merge is False or None). - ['tag1', 'tag2']: Set or merge tags (based on merge parameter). merge: Controls tag update behavior. Semantics: - None: Use backend default behavior (replace mode). - False: Replace all existing tags (replace mode). - True: Merge new tags with existing tags (union). Example: # Replace tags on multiple versions (default behavior) prompts_client.batch_update_prompt_version_tags( version_ids=["version-id-1", "version-id-2"], tags=["production", "v2"] ) # Merge new tags with existing tags prompts_client.batch_update_prompt_version_tags( version_ids=["version-id-1"], tags=["hotfix"], merge=True ) # Clear all tags prompts_client.batch_update_prompt_version_tags( version_ids=["version-id-1"], tags=[] ) )r*)idsupdate merge_tagsN)r r rKupdate_prompt_versions)r!rr*rrs r batch_update_prompt_version_tagsz-PromptClient.batch_update_prompt_version_tagss5P%$/ !!88Fu 9 r)r#NNNN)NN)rrr rest_clientOpikApir" prompt_types PromptTypeMUSTACHErrrrrr rrAPromptVersionDetailTyper<r2rSrlrgrr~boolrrrrrrs#{22#)5(?(?(H(H"( %),0$(QQQ4S>* Q %% Q  Q SMQc]Q%SMQtCy!Q  2 2Qr#) %),0$(C)C)C)$;; C) 4S>* C)  C) SMC)c]C)%SMC)tCy!C)  2 2C)J77 ';; <7!%9= .. .*2# . ';; < .j!%'+ XX X } X #77 8 Xz!%!% ** *# * #77 8 *^#9= YsmY!d38n!56 Y  ! Y|%) $ + #Y+ tCy!+ ~ +  + rr)typingrrrrrr6 dataclassesopik.exceptionsr3 opik.rest_apirrr r rWopik.rest_api.typesr opik.api_objectsr rr dataclassrrrrrrsQ33 D/50# EEE_ _ r