sgLBddlZddlZddlZddlmZddlmZddlmZddlm Z m Z m Z m Z m Z mZmZmZmZmZddlmZddlmZmZmZerddlZdd lmZdd lmZndZerdd lmZerdd l m!Z!e"e#e$e%e e&dd fZ'ejPdejRZ*ejPdejRZ+ejPdejRejXzZ-ejPdejRZ.Gdde/Z0Gdde/Z1de$de e$e$ffdZ2de$de fdZ3de de fdZ4de$dee e$e e e e$ffdZ5de de fdZ6d Z7ed!Z8y)"N)contextmanager)datetime) lru_cache) AnyCallableDictListOptionalTupleUnionget_args get_originget_type_hints)version)is_jinja_availableis_torch_availableis_vision_available) Extension)ImmutableSandboxedEnvironment)Image)Tensor.z(^(.*?)[\n\s]*(Args:|Returns:|Raises:|\Z)z0\n\s*Args:\n\s*(.*?)[\n\s]*(Returns:|Raises:|\Z)a1 (?:^|\n) # Match the start of the args block, or a newline \s*(\w+):\s* # Capture the argument name and strip spacing (.*?)\s* # Capture the argument description, which can span multiple lines, and strip trailing spacing (?=\n\s*\w+:|\Z) # Stop when you hit the next argument or the end of the block z*\n\s*Returns:\n\s*(.*?)[\n\s]*(Raises:|\Z)ceZdZdZy)TypeHintParsingExceptionzJException raised for errors in parsing type hints to generate JSON schemasN__name__ __module__ __qualname____doc__Y/var/www/html/venv/lib/python3.12/site-packages/transformers/utils/chat_template_utils.pyrr=Tr!rceZdZdZy)DocstringParsingExceptionzJException raised for errors in parsing docstrings to generate JSON schemasNrr r!r"r%r%Cr#r!r% param_typereturnc tdditdditdditdditii}t r ddi|t <tr ddi|t<|j|ddiS) Ntypeintegernumberstringbooleanimageaudioobject) intfloatstrboolrrrrrget)r& type_mappings r"_get_json_schema_typer7Isz fi  ! fh  vy! R L%w/ U &0 V   J(: ;;r!hintc>t|}t|}| t|S|t ur|Dcgc]}|t dust|}}t|dk(r|d}n5td|Drdt|Dcgc]}|d c}i}nd|i}t d|vrd|d<|S|tur|sdd iSd t|dd S|turg|sdd iSt|dk(r(t d t|jd d dd|vr t dd |Dcgc] }t|c}dS|tur%ddi}t|dk(rt|d|d<|St d|#t$r t d|wxYwcc}wcc}wcc}w)NzGCouldn't parse this type hint, likely due to a custom class or object: rrc3BK|]}t|dtyw)r)N) isinstancer3).0subtypes r" z#_parse_type_hint..jsJgGFOS1Jsr)anyOfTnullablearray)r)itemszThe type hint ztyping.a1 is a Tuple with a single element, which we do not automatically convert to JSON schema as it is rarely necessary. If this input can contain more than one element, we recommend using a List[] type instead, or if it really is a single element, remove the Tuple[] wrapper and just pass the element directly..znConversion of '...' is not supported in Tuple type hints. Use List[] types for variable-length inputs instead.)r) prefixItemsr0additionalProperties)rr r7KeyErrorrr r)_parse_type_hintlenallsortedlisttupler3replacedict)r8originargstsubtypes return_dictr=outs r"rHrHXs  F D>D ~ (. . 515MA$t*9L$Q'MM x=A "1+K JJ J!6(*Sw76?*S#TUK#H-K : &*K # 4G$ $$.>tAw.GH H 5G$ $ t9>* T!2!29b!A BC--  $;*#   d0S1A!1D0STT 4x  t9>*:47*CC& ' "#lnr sso *Y[_  N +T@1Ts" E7F F F 'F7F funcct|}tj|}g}|jj D]\}}|j tj jk(r%td|jd|j|jtj jk(sz|j|i}|j D]\}}t|||<d|d}|r||d<|S)Nz Argument z$ is missing a type hint in function r0)r) propertiesrequired)rinspect signature parametersrB annotation ParameteremptyrnamerdefaultappendrH) rV type_hintsr[rY param_nameparamrXr&schemas r""_convert_type_hints_to_json_schemargs%J!!$'IH&11779( E   w0066 6*YuzzlBfgkgtgtfu+vw w ==G--33 3 OOJ ' ( J","2"2"4> J!1*!= :>j 9F%z Mr! docstringc tj|}tj|}tj|}|r|j dj nd}|r|j dj nd}|r|j dj nd}|dj |jdDcgc]}|j s|c}}tj|}|D cic].} | dtjdd| dj 0} } ni} || |fScc}wcc} w)a Parses a Google-style docstring to extract the function description, argument descriptions, and return description. Args: docstring (str): The docstring to parse. Returns: The function description, arguments, and return description. rN rz \s*\n+\s* ) description_researchargs_re returns_regroupstripjoinsplit args_split_refindallresub) rhdescription_match args_match returns_match descriptiondocstring_argsreturnslinematchesmatch args_dicts r"parse_google_format_docstringrs%'--i8 *J%%i0M9J#))!,224tK4>Z%%a(..0DN0=m!!!$**,4G!^5I5I$5O#`TSWS]S]S_D#`a''7X_`uU1XrvvlCq9IJJ` `  7 ** $a`s EE3Ectj|}|std|jd|j }t |\}}}t |}|djddx}|||d<|djD]\}}||vrtd|jd|d||} tjd | tj } | rntj| jd D cgc]} | j c} |d <| jd| j!j } | |d<|j||d } ||| d<d| dScc} w)a This function generates a JSON schema for a given function, based on its docstring and type hints. This is mostly used for passing lists of tools to a chat template. The JSON schema contains the name and description of the function, as well as the names, types and descriptions for each of its arguments. `get_json_schema()` requires that the function has a docstring, and that each argument has a description in the docstring, in the standard Google docstring format shown below. It also requires that all the function arguments have a valid Python type hint. Although it is not required, a `Returns` block can also be added, which will be included in the schema. This is optional because most chat templates ignore the return value of the function. Args: func: The function to generate a JSON schema for. Returns: A dictionary containing the JSON schema for the function. Examples: ```python >>> def multiply(x: float, y: float): >>> ''' >>> A function that multiplies two numbers >>> >>> Args: >>> x: The first number to multiply >>> y: The second number to multiply >>> ''' >>> return x * y >>> >>> print(get_json_schema(multiply)) { "name": "multiply", "description": "A function that multiplies two numbers", "parameters": { "type": "object", "properties": { "x": {"type": "number", "description": "The first number to multiply"}, "y": {"type": "number", "description": "The second number to multiply"} }, "required": ["x", "y"] } } ``` The general use for these schemas is that they are used to generate tool descriptions for chat templates that support them, like so: ```python >>> from transformers import AutoTokenizer >>> from transformers.utils import get_json_schema >>> >>> def multiply(x: float, y: float): >>> ''' >>> A function that multiplies two numbers >>> >>> Args: >>> x: The first number to multiply >>> y: The second number to multiply >>> return x * y >>> ''' >>> >>> multiply_schema = get_json_schema(multiply) >>> tokenizer = AutoTokenizer.from_pretrained("CohereForAI/c4ai-command-r-v01") >>> messages = [{"role": "user", "content": "What is 179 x 4571?"}] >>> formatted_chat = tokenizer.apply_chat_template( >>> messages, >>> tools=[multiply_schema], >>> chat_template="tool_use", >>> return_dict=True, >>> return_tensors="pt", >>> add_generation_prompt=True >>> ) >>> # The formatted chat can now be passed to model.generate() ``` Each argument description can also have an optional `(choices: ...)` block at the end, such as `(choices: ["tea", "coffee"])`, which will be parsed into an `enum` field in the schema. Note that this will only be parsed correctly if it is at the end of the line: ```python >>> def drink_beverage(beverage: str): >>> ''' >>> A function that drinks a beverage >>> >>> Args: >>> beverage: The beverage to drink (choices: ["tea", "coffee"]) >>> ''' >>> pass >>> >>> print(get_json_schema(drink_beverage)) ``` { 'name': 'drink_beverage', 'description': 'A function that drinks a beverage', 'parameters': { 'type': 'object', 'properties': { 'beverage': { 'type': 'string', 'enum': ['tea', 'coffee'], 'description': 'The beverage to drink' } }, 'required': ['beverage'] } } z Cannot generate JSON schema for z because it has no docstring!rXr'Nr{z< because the docstring has no description for the argument ''z\(choices:\s*(.*?)\)\s*$)flagsrenum)r`r{r\function)r)r)rZgetdocr%rrqrrgpoprBrvrm IGNORECASEjsonloadsrpr,start) rVdocmain_docparam_descriptions return_doc json_schemarTargrfdesc enum_choicescoutputs r"get_json_schemarsV .. C '.t}}o=Z [   ))+C/LS/Q,H *4T:K"<044XtDD Q  !)3K &"<0668 % V ( (+24==/A}B~CCDE "#&yy!DDFD $} %mmHK XF&xF 33TsE0c g}g}|jj||5|jd||||d|D]}|j|dj |} ddd| |fS#1swY |fSxYw)N)messagestools documentsadd_generation_promptrCr ) environmentactivate_trackergeneraterbrr) compiled_templaterrrrtemplate_kwargsrendered_blocksgeneration_indicesblock rendered_chats r"_render_with_assistant_indicesrXsO  & & 7 7I[ \ 1/&// "7     *E  " "5 ) *0  1 , ,, 1 , ,,s ?A,,A8cGddt}tjtjtjdkrt dtjdd}dd}d}t d d |tjjg }||jd <||jd <||jd <|j|S)Nc>eZdZdhZdeffd ZdejjdejjfdZ ejdejjdejjdefd Zdefd Zed eed eefd ZxZS)1_compile_jinja_template..AssistantTracker generationrcxt|||j|jd|_d|_y)N)r)super__init__extendr_rendered_blocks_generation_indices)selfr __class__s r"rz:_compile_jinja_template..AssistantTracker.__init__ps7 G [ )   0E0E  F$(D !'+D $r!parserr'ct|jj}|jdgd}tj j |jdgg|j|S)Nzname:endgenerationT) drop_needle_generation_support) nextstreamlinenoparse_statementsjinja2nodes CallBlock call_method set_lineno)rrrbodys r"parsez7_compile_jinja_template..AssistantTracker.parsewse&--(//F**,@+At*TD<<))$*:*:;P*QSUWY[_`kklrs sr!contextcallerc|}|jrOtdj|j}|t|z}|jj ||f|S)NrC) is_activerIrrrrrb)rrrrv start_index end_indexs r"rzE_compile_jinja_template..AssistantTracker._generation_support|sXB~~!"''$*?*?"@A '#b'1 ((//i0HIIr!c6|jxs |jSN)rr)rs r"rz;_compile_jinja_template..AssistantTracker.is_actives((DD,D,D Dr!rrc3K |jr td||_||_dd|_d|_y#d|_d|_wxYww)Nz3AssistantTracker should not be reused before closed)r ValueErrorrr)rrrs r"rzB_compile_jinja_template..AssistantTracker.activate_trackersW 0>>#$%Z[[(7%+=((,%+/()-%+/(sA-AAAA)rrrtagsrrrrParserrrrpass_eval_context EvalContextruntimeMacror3rr4rrr r1r __classcell__)rs@r"AssistantTrackerrls~ ,(E , t 4 4 t9O9O t  ! ! v||/G/G QWQ_Q_QeQe jm  "  Et E  0DI 0SWX[S\ 0  0r!rz3.1.0zLapply_chat_template requires jinja2>=3.1.0 to be installed. Your version is .c@tjj|r)r exceptions TemplateError)messages r"raise_exceptionz0_compile_jinja_template..raise_exceptions--g66r!c6tj|||||S)N) ensure_asciiindent separators sort_keys)rdumps)xrrrrs r"tojsonz'_compile_jinja_template..tojsonszz!,vR\hqrrr!cHtjj|Sr)rnowstrftime)formats r" strftime_nowz-_compile_jinja_template..strftime_nows||~&&v..r!T) trim_blocks lstrip_blocks extensionsrrr)FNNF) rrrr __version__ ImportErrorrext loopcontrolsfiltersglobals from_string) chat_templaterrrr jinja_envs r"_compile_jinja_templaterjs(09(0T}}V''(7==+AA Z^d^p^p]qqr s  7s /.:JFJJLcLc9dI#)Ih+:I'((4In%   //r!)9rZrrv contextlibrr functoolsrtypingrrrr r r r r rr packagingr import_utilsrrrr jinja2.extrjinja2.sandboxr PIL.Imagertorchrr1r2r3r4r) BASIC_TYPEScompileDOTALLrlrnVERBOSErtro Exceptionrr%r7rHrgrrrrr r!r"rs %jjjUU$< FE3c4:s; GS "**H")) T  II  RZZEryy Q  y   t3>t4>tBX$*+S+U8C=(SW.ZbcfZg;g5h+BF4(F4tF4R-$ A0 A0r!