c iTdZddlmZddlZddlmZmZddlmZmZddl m Z ddl m Z ddl mZdd lmZmZmZmZmZmZmZmZmZmZmZmZmZGd d ZdS) zBAsync client for managing recurrent runs (cron jobs) in LangGraph.) annotationsN)MappingSequence)datetimetzinfo)Any) HttpClient)_resolve_timezone) AllConfigContextCronCronSelectField CronSortBy DurabilityInputOnCompletionBehaviorQueryParamTypesRun SortOrder StreamModeceZdZdZdHdZddddddddddddddddddddId-Zdddddddddddddddddddd.dJd1Zddd2dKd4Zddddddddddddddddddd5dLd7Zdddd8d9dddddd: dMdEZ dddddFdNdGZ dS)O CronClienta%Client for managing recurrent runs (cron jobs) in LangGraph. A run is a single invocation of an assistant with optional input, config, and context. This client allows scheduling recurring runs to occur automatically. ???+ example "Example Usage" ```python client = get_client(url="http://localhost:2024")) cron_job = await client.crons.create_for_thread( thread_id="thread_123", assistant_id="asst_456", schedule="0 9 * * *", input={"message": "Daily update"} ) ``` !!! note "Feature Availability" The crons client functionality is not supported on all licenses. Please check the relevant license documentation for the most up-to-date details on feature availability. http_clientr returnNonec||_dSN)http)selfrs C:\Users\Dell Inspiron 16\Desktop\tws\AgrotaPowerBi\back-agrota-powerbi\mcp-client-agrota\venv\Lib\site-packages\langgraph_sdk/_async/cron.py__init__zCronClient.__init__6s  N)inputmetadataconfigcontextcheckpoint_duringinterrupt_beforeinterrupt_afterwebhookmultitask_strategyend_timeenabledtimezone stream_modestream_subgraphsstream_resumable durabilityheadersparams thread_idstr assistant_idscheduler$ Input | Noner%Mapping[str, Any] | Noner& Config | Noner'Context | Noner( bool | Noner)All | list[str] | Noner*r+ str | Noner,r-datetime | Noner.r/str | tzinfo | Noner0(StreamMode | Sequence[StreamMode] | Noner1r2r3Durability | Noner4Mapping[str, str] | Noner5QueryParamTypes | NonercK|tjdtdid|d|d|d|d |d |d |d | d | d| d| r| ndd|dt |d|d|d|d|}| r| |d<d|D}|jd|d|||d{VS)a Create a cron job for a thread. Args: thread_id: the thread ID to run the cron job on. assistant_id: The assistant ID or graph name to use for the cron job. If using graph name, will default to first assistant created from that graph. schedule: The cron schedule to execute this job on. Schedules are interpreted in UTC unless a timezone is specified. input: The input to the graph. metadata: Metadata to assign to the cron job runs. config: The configuration for the assistant. context: Static context to add to the assistant. !!! version-added "Added in version 0.6.0" checkpoint_during: (deprecated) Whether to checkpoint during the run (or only at the end/interruption). interrupt_before: Nodes to interrupt immediately before they get executed. interrupt_after: Nodes to Nodes to interrupt immediately after they get executed. webhook: Webhook to call after LangGraph API call is done. multitask_strategy: Multitask strategy to use. Must be one of 'reject', 'interrupt', 'rollback', or 'enqueue'. end_time: The time to stop running the cron job. If not provided, the cron job will run indefinitely. enabled: Whether the cron job is enabled or not. timezone: IANA timezone for the cron schedule. Accepts a string (e.g. 'America/New_York') or a ``datetime.tzinfo`` instance (e.g. ``ZoneInfo("America/New_York")``). stream_mode: The stream mode(s) to use. stream_subgraphs: Whether to stream output from subgraphs. stream_resumable: Whether to persist the stream chunks in order to resume the stream later. durability: Durability level for the run. Must be one of 'sync', 'async', or 'exit'. "async" means checkpoints are persisted async while next graph step executes, replaces checkpoint_during=True "sync" means checkpoints are persisted sync after graph step executes, replaces checkpoint_during=False "exit" means checkpoints are only persisted when the run exits, does not save intermediate steps headers: Optional custom headers to include with the request. params: Optional query parameters to include with the request. Returns: The cron run. ???+ example "Example Usage" ```python client = get_client(url="http://localhost:2024") cron_run = await client.crons.create_for_thread( thread_id="my-thread-id", assistant_id="agent", schedule="27 15 * * *", input={"messages": [{"role": "user", "content": "hello!"}]}, metadata={"name":"my_run"}, context={"model_name": "openai"}, interrupt_before=["node_to_stop_before_1","node_to_stop_before_2"], interrupt_after=["node_to_stop_after_1","node_to_stop_after_2"], webhook="https://my.fake.webhook.com", multitask_strategy="interrupt", enabled=True, ) ``` Nd`checkpoint_during` is deprecated and will be removed in a future version. Use `durability` instead. stacklevelr9r$r&r%r'r8r(r)r*r+r-r.r/r0r1r2r3r,ci|] \}}||| Sr.0kvs r! z0CronClient.create_for_thread..EEEDAqq}1a}}}r#z /threads/ /runs/cronsjsonr4r5warningswarnDeprecationWarning isoformatr itemsrpost)r r6r8r9r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5payloads r!create_for_threadzCronClient.create_for_thread9sb  ( Mv"       U  f    w  L   !2   0    w  B**,,,d  w  )(33  ;   0  0! " *# &  ?,>G( )EEGMMOOEEEY^^ . . . . $         r#)r$r%r&r'r(r)r*r+on_run_completedr,r-r.r/r0r1r2r3r4r5r`OnCompletionBehavior | NonecK|tjdtdid|d|d|d|d |d |d |d |d | d| d| d| r| ndd|dt |d|d|d|d|i}| r| |d<d|D}|jd|||d{VS)a Create a cron run. Args: assistant_id: The assistant ID or graph name to use for the cron job. If using graph name, will default to first assistant created from that graph. schedule: The cron schedule to execute this job on. Schedules are interpreted in UTC unless a timezone is specified. input: The input to the graph. metadata: Metadata to assign to the cron job runs. config: The configuration for the assistant. context: Static context to add to the assistant. !!! version-added "Added in version 0.6.0" checkpoint_during: (deprecated) Whether to checkpoint during the run (or only at the end/interruption). interrupt_before: Nodes to interrupt immediately before they get executed. interrupt_after: Nodes to Nodes to interrupt immediately after they get executed. webhook: Webhook to call after LangGraph API call is done. on_run_completed: What to do with the thread after the run completes. Must be one of 'delete' (default) or 'keep'. 'delete' removes the thread after execution. 'keep' creates a new thread for each execution but does not clean them up. Clients are responsible for cleaning up kept threads. multitask_strategy: Multitask strategy to use. Must be one of 'reject', 'interrupt', 'rollback', or 'enqueue'. end_time: The time to stop running the cron job. If not provided, the cron job will run indefinitely. enabled: Whether the cron job is enabled or not. timezone: IANA timezone for the cron schedule. Accepts a string (e.g. 'America/New_York') or a ``datetime.tzinfo`` instance (e.g. ``ZoneInfo("America/New_York")``). stream_mode: The stream mode(s) to use. stream_subgraphs: Whether to stream output from subgraphs. stream_resumable: Whether to persist the stream chunks in order to resume the stream later. durability: Durability level for the run. Must be one of 'sync', 'async', or 'exit'. "async" means checkpoints are persisted async while next graph step executes, replaces checkpoint_during=True "sync" means checkpoints are persisted sync after graph step executes, replaces checkpoint_during=False "exit" means checkpoints are only persisted when the run exits, does not save intermediate steps headers: Optional custom headers to include with the request. params: Optional query parameters to include with the request. Returns: The cron run. ???+ example "Example Usage" ```python client = get_client(url="http://localhost:2024") cron_run = client.crons.create( assistant_id="agent", schedule="27 15 * * *", input={"messages": [{"role": "user", "content": "hello!"}]}, metadata={"name":"my_run"}, context={"model_name": "openai"}, interrupt_before=["node_to_stop_before_1","node_to_stop_before_2"], interrupt_after=["node_to_stop_after_1","node_to_stop_after_2"], webhook="https://my.fake.webhook.com", multitask_strategy="interrupt", enabled=True, ) ``` NrHrIrJr9r$r&r%r'r8r(r)r*r+r`r-r.r/r0r1r2r3r,ci|] \}}||| SrrMrNs r!rRz%CronClient.create..rSr#rTrUrW)r r8r9r$r%r&r'r(r)r*r+r`r,r-r.r/r0r1r2r3r4r5r^s r!createzCronClient.createsd  ( Mv"       U  f    w  L   !2   0    w   0  B**,,,d  w  )(33  ;  0! "  0# $ *%  (  ?,>G( )EEGMMOOEEEY^^ $         r#r4r5cron_idcVK|jd|||d{VdS)aDelete a cron. Args: cron_id: The cron ID to delete. headers: Optional custom headers to include with the request. params: Optional query parameters to include with the request. Returns: `None` ???+ example "Example Usage" ```python client = get_client(url="http://localhost:2024") await client.crons.delete( cron_id="cron_to_delete" ) ``` /runs/crons/reN)rdelete)r rfr4r5s r!rizCronClient.delete"sG6i7g77QWXXXXXXXXXXXr#)r9r-r$r%r&r'r+r)r*r`r.r/r0r1r2r3r4r5rc:Kid|d|r|ndd|d|d|d|d|d | d | d | d | d t| d|d|d|d|}d|D}|jd||||d{VS)aaUpdate a cron job by ID. Args: cron_id: The cron ID to update. schedule: The cron schedule to execute this job on. Schedules are interpreted in UTC unless a timezone is specified. end_time: The end date to stop running the cron. input: The input to the graph. metadata: Metadata to assign to the cron job runs. config: The configuration for the assistant. context: Static context added to the assistant. webhook: Webhook to call after LangGraph API call is done. interrupt_before: Nodes to interrupt immediately before they get executed. interrupt_after: Nodes to interrupt immediately after they get executed. on_run_completed: What to do with the thread after the run completes. Must be one of 'delete' or 'keep'. 'delete' removes the thread after execution. 'keep' creates a new thread for each execution but does not clean them up. enabled: Enable or disable the cron job. timezone: IANA timezone for the cron schedule. Accepts a string (e.g. 'America/New_York') or a ``datetime.tzinfo`` instance (e.g. ``ZoneInfo("America/New_York")``). stream_mode: The stream mode(s) to use. stream_subgraphs: Whether to stream output from subgraphs. stream_resumable: Whether to persist the stream chunks in order to resume the stream later. durability: Durability level for the run. Must be one of 'sync', 'async', or 'exit'. headers: Optional custom headers to include with the request. params: Optional query parameters to include with the request. Returns: The updated cron job. ???+ example "Example Usage" ```python client = get_client(url="http://localhost:2024") updated_cron = await client.crons.update( cron_id="1ef3cefa-4c09-6926-96d0-3dc97fd5e39b", schedule="0 10 * * *", enabled=False, ) ``` r9r-Nr$r%r&r'r+r)r*r`r.r/r0r1r2r3ci|] \}}||| SrrMrNs r!rRz%CronClient.update..rSr#rhrU)r[r r\rpatch)r rfr9r-r$r%r&r'r+r)r*r`r.r/r0r1r2r3r4r5r^s r!updatezCronClient.update?sZB  B**,,,d  U    f  w   w   0     0  w  )(33  ;   0   0 *! $FEGMMOOEEEY__ $7 $ $ %         r# r) r8r6r.limitoffsetsort_by sort_orderselectr4r5rointrprqCronSortBy | NonerrSortOrder | Nonerslist[CronSelectField] | None list[Cron]c K|||||d} |r|| d<|r|| d<|r|| d<d| D} |jd| | | d{VS) aiGet a list of cron jobs. Args: assistant_id: The assistant ID or graph name to search for. thread_id: the thread ID to search for. enabled: The enabled status to search for. limit: The maximum number of results to return. offset: The number of results to skip. headers: Optional custom headers to include with the request. params: Optional query parameters to include with the request. Returns: The list of cron jobs returned by the search, ???+ example "Example Usage" ```python client = get_client(url="http://localhost:2024") cron_jobs = await client.crons.search( assistant_id="my_assistant_id", thread_id="my_thread_id", enabled=True, limit=5, offset=5, ) print(cron_jobs) ``` ```shell ---------------------------------------------------------- [ { 'cron_id': '1ef3cefa-4c09-6926-96d0-3dc97fd5e39b', 'assistant_id': 'my_assistant_id', 'thread_id': 'my_thread_id', 'user_id': None, 'payload': { 'input': {'start_time': ''}, 'schedule': '4 * * * *', 'assistant_id': 'my_assistant_id' }, 'schedule': '4 * * * *', 'next_run_date': '2024-07-25T17:04:00+00:00', 'end_time': None, 'created_at': '2024-07-08T06:02:23.073257+00:00', 'updated_at': '2024-07-08T06:02:23.073257+00:00' } ] ``` )r8r6r.rorprqrrrsci|] \}}||| SrrMrNs r!rRz%CronClient.search..rSr#z/runs/crons/searchrUN)r\rr]) r r8r6r.rorprqrrrsr4r5r^s r!searchzCronClient.searchsH)" # #   )!(GI   /$.GL !  ' &GH EEGMMOOEEEY^^ w$         r#)r8r6r4r5cnKi}|r||d<|r||d<|jd|||d{VS)a|Count cron jobs matching filters. Args: assistant_id: Assistant ID to filter by. thread_id: Thread ID to filter by. headers: Optional custom headers to include with the request. params: Optional query parameters to include with the request. Returns: int: Number of crons matching the criteria. r8r6z/runs/crons/countrUN)rr])r r8r6r4r5r^s r!countzCronClient.countsu&#%  3&2GN #  -#,GK Y^^ gwv$         r#)rr rr),r6r7r8r7r9r7r$r:r%r;r&r<r'r=r(r>r)r?r*r?r+r@r,r@r-rAr.r>r/rBr0rCr1r>r2r>r3rDr4rEr5rFrr),r8r7r9r7r$r:r%r;r&r<r'r=r(r>r)r?r*r?r+r@r`rar,r@r-rAr.r>r/rBr0rCr1r>r2r>r3rDr4rEr5rFrr)rfr7r4rEr5rFrr)(rfr7r9r@r-rAr$r:r%r;r&r<r'r=r+r@r)r?r*r?r`rar.r>r/rBr0rCr1r>r2r>r3rDr4rEr5rFrr)r8r@r6r@r.r>rortrprtrqrurrrvrsrwr4rEr5rFrrx) r8r@r6r@r4rEr5rFrrt) __name__ __module__ __qualname____doc__r"r_rdrirmr{r}rMr#r!rrs0    #-1 $"&)-3726")-$(#(,@D(,(,(,,0)-/s s s s s s t#-1 $"&)-3726"8<)-$(#(,@D(,(,(,,0)-/r r r r r r p-1)- YYYYYYB $$("-1 $"&"37268<#(,@D(,(,(,,0)-+Y Y Y Y Y Y |$( $#%)'+/3,0)-S S S S S S p$( $,0)-         r#r)r __future__rrXcollections.abcrrrrtypingrlanggraph_sdk._async.httpr langgraph_sdk._shared.utilitiesr langgraph_sdk.schemar r r rrrrrrrrrrrrMr#r!rs^HH""""""--------%%%%%%%%000000======"l l l l l l l l l l r#