tj:WdZddlmZddlZddlmZmZddlmZmZddl m Z ddl m Z ddl mZmZdd lmZmZmZmZmZmZmZmZmZmZmZmZmZmZGd d ZdS) zBAsync client for managing recurrent runs (cron jobs) in LangGraph.) annotationsN)MappingSequence)datetimetzinfo)Any) HttpClient)_quote_path_param_resolve_timezone)AllConfigContextCronCronSelectField CronSortBy DurabilityInputJsonOnCompletionBehaviorQueryParamTypesRun SortOrder StreamModeceZdZdZdIdZddddddddddddddddddddJd-Zdddddddddddddddddddd.dKd1Zddd2dLd4Zddddddddddddddddddd5dMd7Zddddd8d9dddddd: dNdFZ ddddddGdOdHZ dS)P 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 W/var/www/html/CA-Chatbot/venv/lib/python3.11/site-packages/langgraph_sdk/_async/cron.py__init__zCronClient.__init__7s  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 | Noner0r1str | tzinfo | Noner2(StreamMode | Sequence[StreamMode] | Noner3r4r5Durability | Noner6Mapping[str, str] | Noner7QueryParamTypes | NonercK|tjdtdid|d|d|d|d |d |d |d | d | d| d| r| ndd|dt |d|d|d|d|}| r| |d<d|D}|jdt|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. stacklevelr;r&r(r'r)r:r*r+r,r-r/r0r1r2r3r4r5r.ci|] \}}||| Sr .0kvs r# z0CronClient.create_for_thread..EEEDAqq}1a}}}r%z /threads/ /runs/cronsjsonr6r7) warningswarnDeprecationWarning isoformatr itemsr!postr )r"r8r:r;r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r6r7payloads r#create_for_threadzCronClient.create_for_thread:sb  ( Mv"       U  f    w  L   !2   0    w  B**,,,d  w  )(33  ;   0  0! " *# &  ?,>G( )EEGMMOOEEEY^^ A))44 A A A $         r%)r&r'r(r)r*r+r,r-on_run_completedr.r/r0r1r2r3r4r5r6r7raOnCompletionBehavior | 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, ) ``` NrJrKrLr;r&r(r'r)r:r*r+r,r-rar/r0r1r2r3r4r5r.ci|] \}}||| Sr rOrPs r#rTz%CronClient.create..rUr%rVrW)rYrZr[r\r r]r!r^)r"r:r;r&r'r(r)r*r+r,r-rar.r/r0r1r2r3r4r5r6r7r_s r#createzCronClient.createsd  ( Mv"       U  f    w  L   !2   0    w   0  B**,,,d  w  )(33  ;  0! "  0# $ *%  (  ?,>G( )EEGMMOOEEEY^^ $         r%r6r7cron_idcpK|jdt|||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/rfN)r!deleter )r"rgr6r7s r#rjzCronClient.delete#sh6i 7,W55 7 7QW           r%)r;r/r&r'r(r)r-r+r,rar0r1r2r3r4r5r6r7rcTKid|d|r|ndd|d|d|d|d|d | d | d | d | d t| d|d|d|d|}d|D}|jdt ||||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, ) ``` r;r/Nr&r'r(r)r-r+r,rar0r1r2r3r4r5ci|] \}}||| Sr rOrPs r#rTz%CronClient.update..rUr%rirW)r\r r]r!patchr )r"rgr;r/r&r'r(r)r-r+r,rar0r1r2r3r4r5r6r7r_s r#updatezCronClient.updateBscB  B**,,,d  U    f  w   w   0     0  w  )(33  ;   0   0 *! $FEGMMOOEEEY__ 7,W55 7 7 %         r% r) r:r8r0r'limitoffsetsort_by sort_orderselectr6r7rrpintrqrrCronSortBy | NonersSortOrder | Nonertlist[CronSelectField] | None list[Cron]c K|||||d} |r|| d<|r|| d<|r|| d<| r| | d<d| D} |jd| | | d {VS) aGet 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. metadata: Metadata to filter by. Exact match filter for each KV pair. !!! version-added "Added in Agent Server version 0.9.0" 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' } ] ``` )r:r8r0rprqr'rrrsrtci|] \}}||| Sr rOrPs r#rTz%CronClient.search..rUr%z/runs/crons/searchrWN)r]r!r^) r"r:r8r0r'rprqrrrsrtr6r7r_s r#searchzCronClient.searchsN)" # #   +"*GJ   )!(GI   /$.GL !  ' &GH EEGMMOOEEEY^^ w$         r%)r:r8r'r6r7c|Ki}|r||d<|r||d<|r||d<|jd|||d{VS)aCount cron jobs matching filters. Args: assistant_id: Assistant ID to filter by. thread_id: Thread ID to filter by. metadata: Metadata to filter by. Exact match filter for each KV pair. !!! version-added "Added in Agent Server version 0.9.0" 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. r:r8r'z/runs/crons/countrWN)r!r^)r"r:r8r'r6r7r_s r#countzCronClient.counts,#%  3&2GN #  -#,GK  +"*GJ Y^^ gwv$         r%)rr rr),r8r9r:r9r;r9r&r<r'r=r(r>r)r?r*r@r+rAr,rAr-rBr.rBr/rCr0r@r1rDr2rEr3r@r4r@r5rFr6rGr7rHrr),r:r9r;r9r&r<r'r=r(r>r)r?r*r@r+rAr,rAr-rBrarbr.rBr/rCr0r@r1rDr2rEr3r@r4r@r5rFr6rGr7rHrr)rgr9r6rGr7rHrr)(rgr9r;rBr/rCr&r<r'r=r(r>r)r?r-rBr+rAr,rArarbr0r@r1rDr2rEr3r@r4r@r5rFr6rGr7rHrr)r:rBr8rBr0r@r'rrprurqrurrrvrsrwrtrxr6rGr7rHrry) r:rBr8rBr'rr6rGr7rHrru) __name__ __module__ __qualname____doc__r$r`rerjrnr|r~rOr%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)-       F $$("-1 $"&"37268<#(,@D(,(,(,,0)-+Y Y Y Y Y Y |$( $#%)'+/3,0)-X X X X X X z$( $,0)-        r%r) r __future__rrYcollections.abcrrrrtypingrlanggraph_sdk._async.httpr langgraph_sdk._shared.utilitiesr r langgraph_sdk.schemar r rrrrrrrrrrrrrrOr%r#rsnHH""""""--------%%%%%%%%000000PPPPPPPP$x x x x x x x x x x r%