@langchain/langgraph-sdk
Version:
Client library for interacting with the LangGraph API
1 lines • 13.8 kB
Source Map (JSON)
{"version":3,"file":"schema.d.ts","names":["JSONSchema7","Optional","T","RunStatus","ThreadStatus","MultitaskStrategy","CancelAction","Config","GraphSchema","Subgraphs","Record","Metadata","AssistantBase","AssistantVersion","Assistant","AssistantsSearchResponse","AssistantGraph","Array","Interrupt","TValue","Thread","DefaultValues","ValuesType","TInterruptValue","Cron","ThreadValuesFilter","ThreadState","Checkpoint","ThreadTask","Run","ListNamespaceResponse","Item","SearchItem","SearchItemsResponse","CronCreateResponse","CronCreateForThreadResponse","Omit","AssistantSortBy","ThreadSortBy","CronSortBy","SortOrder","AssistantSelectField","ThreadSelectField","RunSelectField","CronSelectField"],"sources":["../src/schema.d.ts"],"sourcesContent":["import type { JSONSchema7 } from \"json-schema\";\ntype Optional<T> = T | null | undefined;\nexport type RunStatus = \"pending\" | \"running\" | \"error\" | \"success\" | \"timeout\" | \"interrupted\";\nexport type ThreadStatus = \"idle\" | \"busy\" | \"interrupted\" | \"error\";\ntype MultitaskStrategy = \"reject\" | \"interrupt\" | \"rollback\" | \"enqueue\";\nexport type CancelAction = \"interrupt\" | \"rollback\";\nexport type Config = {\n /**\n * Tags for this call and any sub-calls (eg. a Chain calling an LLM).\n * You can use these to filter calls.\n */\n tags?: string[];\n /**\n * Maximum number of times a call can recurse.\n * If not provided, defaults to 25.\n */\n recursion_limit?: number;\n /**\n * Runtime values for attributes previously made configurable on this Runnable.\n */\n configurable?: {\n /**\n * ID of the thread\n */\n thread_id?: Optional<string>;\n /**\n * Timestamp of the state checkpoint\n */\n checkpoint_id?: Optional<string>;\n [key: string]: unknown;\n };\n};\nexport interface GraphSchema {\n /**\n * The ID of the graph.\n */\n graph_id: string;\n /**\n * The schema for the input state.\n * Missing if unable to generate JSON schema from graph.\n */\n input_schema?: JSONSchema7 | null | undefined;\n /**\n * The schema for the output state.\n * Missing if unable to generate JSON schema from graph.\n */\n output_schema?: JSONSchema7 | null | undefined;\n /**\n * The schema for the graph state.\n * Missing if unable to generate JSON schema from graph.\n */\n state_schema?: JSONSchema7 | null | undefined;\n /**\n * The schema for the graph config.\n * Missing if unable to generate JSON schema from graph.\n */\n config_schema?: JSONSchema7 | null | undefined;\n /**\n * The schema for the graph context.\n * Missing if unable to generate JSON schema from graph.\n */\n context_schema?: JSONSchema7 | null | undefined;\n}\nexport type Subgraphs = Record<string, GraphSchema>;\nexport type Metadata = Optional<{\n source?: \"input\" | \"loop\" | \"update\" | (string & {});\n step?: number;\n writes?: Record<string, unknown> | null;\n parents?: Record<string, string>;\n [key: string]: unknown;\n}>;\nexport interface AssistantBase {\n /** The ID of the assistant. */\n assistant_id: string;\n /** The ID of the graph. */\n graph_id: string;\n /** The assistant config. */\n config: Config;\n /** The assistant context. */\n context: unknown;\n /** The time the assistant was created. */\n created_at: string;\n /** The assistant metadata. */\n metadata: Metadata;\n /** The version of the assistant. */\n version: number;\n /** The name of the assistant */\n name: string;\n /** The description of the assistant */\n description?: string;\n}\nexport interface AssistantVersion extends AssistantBase {\n}\nexport interface Assistant extends AssistantBase {\n /** The last time the assistant was updated. */\n updated_at: string;\n}\nexport interface AssistantsSearchResponse {\n /** The assistants returned for the current search page. */\n assistants: Assistant[];\n /** Pagination cursor from the X-Pagination-Next response header. */\n next: string | null;\n}\nexport interface AssistantGraph {\n nodes: Array<{\n id: string | number;\n name?: string;\n data?: Record<string, any> | string;\n metadata?: unknown;\n }>;\n edges: Array<{\n source: string;\n target: string;\n data?: string;\n conditional?: boolean;\n }>;\n}\n/**\n * An interrupt thrown inside a thread.\n */\nexport interface Interrupt<TValue = unknown> {\n /**\n * The ID of the interrupt.\n */\n id?: string;\n /**\n * The value of the interrupt.\n */\n value?: TValue;\n /**\n * Will be deprecated in the future.\n * @deprecated Will be removed in the future.\n */\n when?: \"during\" | (string & {});\n /**\n * Whether the interrupt can be resumed.\n * @deprecated Will be removed in the future.\n */\n resumable?: boolean;\n /**\n * The namespace of the interrupt.\n * @deprecated Replaced by `interrupt_id`\n */\n ns?: string[];\n}\nexport interface Thread<ValuesType = DefaultValues, TInterruptValue = unknown> {\n /** The ID of the thread. */\n thread_id: string;\n /** The time the thread was created. */\n created_at: string;\n /** The last time the thread was updated. */\n updated_at: string;\n /** The thread metadata. */\n metadata: Metadata;\n /** The status of the thread */\n status: ThreadStatus;\n /** The current state of the thread. */\n values: ValuesType;\n /** Interrupts which were thrown in this thread */\n interrupts: Record<string, Array<Interrupt<TInterruptValue>>>;\n /** The config for the thread */\n config?: Config;\n /** The error for the thread (if status == \"error\") */\n error?: Optional<string | Record<string, unknown>>;\n}\nexport interface Cron {\n /** The ID of the cron */\n cron_id: string;\n /** The ID of the assistant */\n assistant_id: string;\n /** The ID of the thread */\n thread_id: Optional<string>;\n /** What to do with the thread after the run completes. Only applicable for stateless crons. */\n on_run_completed?: \"delete\" | \"keep\";\n /** The end date to stop running the cron. */\n end_time: Optional<string>;\n /** The schedule to run, cron format. */\n schedule: string;\n /** The time the cron was created. */\n created_at: string;\n /** The last time the cron was updated. */\n updated_at: string;\n /** The run payload to use for creating new run. */\n payload: Record<string, unknown>;\n /** The user ID of the cron */\n user_id: Optional<string>;\n /** The next run date of the cron */\n next_run_date: Optional<string>;\n /** The metadata of the cron */\n metadata: Record<string, unknown>;\n}\nexport type DefaultValues = Record<string, unknown>[] | Record<string, unknown>;\nexport type ThreadValuesFilter = Record<string, unknown>;\nexport interface ThreadState<ValuesType = DefaultValues> {\n /** The state values */\n values: ValuesType;\n /** The next nodes to execute. If empty, the thread is done until new input is received */\n next: string[];\n /** Checkpoint of the thread state */\n checkpoint: Checkpoint;\n /** Metadata for this state */\n metadata: Metadata;\n /** Time of state creation */\n created_at: Optional<string>;\n /** The parent checkpoint. If missing, this is the root checkpoint */\n parent_checkpoint: Optional<Checkpoint>;\n /** Tasks to execute in this step. If already attempted, may contain an error */\n tasks: Array<ThreadTask>;\n}\nexport interface ThreadTask<ValuesType = DefaultValues, TInterruptValue = unknown> {\n id: string;\n name: string;\n result?: unknown;\n error: Optional<string>;\n interrupts: Array<Interrupt<TInterruptValue>>;\n checkpoint: Optional<Checkpoint>;\n state: Optional<ThreadState<ValuesType>>;\n}\nexport interface Run {\n /** The ID of the run */\n run_id: string;\n /** The ID of the thread */\n thread_id: string;\n /** The assistant that wwas used for this run */\n assistant_id: string;\n /** The time the run was created */\n created_at: string;\n /** The last time the run was updated */\n updated_at: string;\n /** The status of the run. */\n status: RunStatus;\n /** Run metadata */\n metadata: Metadata;\n /** Strategy to handle concurrent runs on the same thread */\n multitask_strategy: Optional<MultitaskStrategy>;\n}\nexport type Checkpoint = {\n thread_id: string;\n checkpoint_ns: string;\n checkpoint_id: Optional<string>;\n checkpoint_map: Optional<Record<string, unknown>>;\n};\nexport interface ListNamespaceResponse {\n namespaces: string[][];\n}\nexport interface Item {\n namespace: string[];\n key: string;\n value: Record<string, any>;\n createdAt: string;\n updatedAt: string;\n}\nexport interface SearchItem extends Item {\n score?: number;\n}\nexport interface SearchItemsResponse {\n items: SearchItem[];\n}\nexport interface CronCreateResponse {\n cron_id: string;\n assistant_id: string;\n thread_id: string | undefined;\n user_id: string;\n payload: Record<string, unknown>;\n schedule: string;\n next_run_date: string;\n end_time: string | undefined;\n created_at: string;\n updated_at: string;\n metadata: Metadata;\n}\nexport interface CronCreateForThreadResponse extends Omit<CronCreateResponse, \"thread_id\"> {\n thread_id: string;\n}\nexport type AssistantSortBy = \"assistant_id\" | \"graph_id\" | \"name\" | \"created_at\" | \"updated_at\";\nexport type ThreadSortBy = \"thread_id\" | \"status\" | \"created_at\" | \"updated_at\";\nexport type CronSortBy = \"cron_id\" | \"assistant_id\" | \"thread_id\" | \"created_at\" | \"updated_at\" | \"next_run_date\";\nexport type SortOrder = \"asc\" | \"desc\";\nexport type AssistantSelectField = \"assistant_id\" | \"graph_id\" | \"name\" | \"description\" | \"config\" | \"context\" | \"created_at\" | \"updated_at\" | \"metadata\" | \"version\";\nexport type ThreadSelectField = \"thread_id\" | \"created_at\" | \"updated_at\" | \"metadata\" | \"config\" | \"context\" | \"status\" | \"values\" | \"interrupts\";\nexport type RunSelectField = \"run_id\" | \"thread_id\" | \"assistant_id\" | \"created_at\" | \"updated_at\" | \"status\" | \"metadata\" | \"kwargs\" | \"multitask_strategy\";\nexport type CronSelectField = \"cron_id\" | \"assistant_id\" | \"thread_id\" | \"end_time\" | \"schedule\" | \"created_at\" | \"updated_at\" | \"user_id\" | \"payload\" | \"next_run_date\" | \"metadata\" | \"now\";\nexport {};\n"],"mappings":";;;KACKC,cAAcC;KACPC,SAAAA;AADPF,KAEOG,YAAAA,GAFOF,MAAC,GAAA,MAAA,GAAA,aAAA,GAAA,OAAA;AACpB,KAEKG,iBAAAA,GAFgB,QAAA,GAAA,WAAA,GAAA,UAAA,GAAA,SAAA;AACTD,KAEAE,YAAAA,GAFY,WAAA,GAAA,UAAA;AACnBD,KAEOE,MAAAA,GAFPF;EACOC;AACZ;;;MAsBwBL,CAAAA,EAAAA,MAAAA,EAAAA;EAAQ;AAIhC;;;iBAcoBD,CAAAA,EAAAA,MAAAA;;;;EAeY,YAAA,CAAA,EAAA;IAEpBS;;;IAAYC,SAAAA,CAAAA,EAvCJT,QAuCIS,CAAAA,MAAAA,CAAAA;IAAM;AAC9B;;IAGaA,aAAAA,CAAAA,EAvCWT,QAuCXS,CAAAA,MAAAA,CAAAA;IACCA,CAAAA,GAAAA,EAAAA,MAAAA,CAAAA,EAAAA,OAAAA;;CAJiB;AAOdE,UAvCAJ,WAAAA,CAuCa;EAAA;;;EAYR,QAAA,EAAA,MAAA;EAQLK;AAEjB;AAIA;AAMA;EAA+B,YAAA,CAAA,EA9DZb,WA8DY,GAAA,IAAA,GAAA,SAAA;;;;;EAiBdkB,aAAS,CAAA,EA1ENlB,WAkFRmB,GAAM,IAAA,GAAA,SAAA;EAiBDC;;;;cAULhB,CAAAA,EAxGOJ,WAwGPI,GAAAA,IAAAA,GAAAA,SAAAA;;;;;eAIIM,CAAAA,EAvGIV,WAuGJU,GAAAA,IAAAA,GAAAA,SAAAA;;;;;EAMCc,cAAI,CAAA,EAxGAxB,WAwGA,GAAA,IAAA,GAAA,SAAA;;AAMNC,KA5GHQ,SAAAA,GAAYC,MA4GTT,CAAAA,MAAAA,EA5GwBO,WA4GxBP,CAAAA;AAIDA,KA/GFU,QAAAA,GAAWV,QA+GTA,CAAAA;QAQDS,CAAAA,EAAAA,OAAAA,GAAAA,MAAAA,GAAAA,QAAAA,GAAAA,CAAAA,MAAAA,GAAAA,CAAAA,CAAAA,CAAAA;MAEAT,CAAAA,EAAAA,MAAAA;QAEMA,CAAAA,EAxHNS,MAwHMT,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,GAAAA,IAAAA;SAELS,CAAAA,EAzHAA,MAyHAA,CAAAA,MAAAA,EAAAA,MAAAA,CAAAA;EAAM,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,OAAA;AAEpB,CAAA,CAAA;AAAyB,UAxHRE,aAAAA,CAwHQ;;cAA+BF,EAAAA,MAAAA;EAAM;EAClDe,QAAAA,EAAAA,MAAAA;EACKC;EAAW,MAAA,EApHhBnB,MAoHgB;;SAEhBe,EAAAA,OAAAA;;YAMEX,EAAAA,MAAAA;;UAIkBgB,EA1HlBhB,QA0HkBgB;;SAEfC,EAAAA,MAAAA;;EAAD,IAAA,EAAA,MAAA;EAECA;EAAU,WAAA,CAAA,EAAA,MAAA;;AAIhB3B,UA1HMY,gBAAAA,SAAyBD,aA0H/BX,CAAAA;AACWiB,UAzHLJ,SAAAA,SAAkBF,aAyHbM,CAAAA;;YACGS,EAAAA,MAAAA;;AACOL,UAvHfP,wBAAAA,CAuHeO;;YAArBrB,EArHKa,SAqHLb,EAAAA;EAAQ;EAEF4B,IAAAA,EAAG,MAAA,GAAA,IAAA;;AAYR1B,UA/HKa,cAAAA,CA+HLb;OAEEQ,EAhIHM,KAgIGN,CAAAA;IAEmBN,EAAAA,EAAAA,MAAAA,GAAAA,MAAAA;IAATJ,IAAAA,CAAAA,EAAAA,MAAAA;IAAQ,IAAA,CAAA,EA/HjBS,MA+HiB,CAAA,MAAA,EAAA,GAAA,CAAA,GAAA,MAAA;IAEpBiB,QAAAA,CAAU,EAAA,OAAA;EAAA,CAAA,CAAA;OAGH1B,EAjIRgB,KAiIQhB,CAAAA;IACUS,MAAAA,EAAAA,MAAAA;IAATT,MAAAA,EAAAA,MAAAA;IAAQ,IAAA,CAAA,EAAA,MAAA;IAEX6B,WAAAA,CAAAA,EAAAA,OAAqB;EAGrBC,CAAAA,CAAAA;AAOjB;AAGA;AAGA;;AAKarB,UA/IIQ,SA+IJR,CAAAA,SAAAA,OAAAA,CAAAA,CAAAA;;;AAQb;EAA4C,EAAA,CAAA,EAAA,MAAA;;;;EAGhC2B,KAAAA,CAAAA,EAlJAlB,MAkJAkB;EACAC;AACZ;AACA;AACA;EACYI,IAAAA,CAAAA,EAAAA,QAAAA,GAAAA,CAAAA,MAAiB,GAAA,CAAA,CAAA,CAAA;EACjBC;AACZ;;;;;;;;;;UAxIiBvB,oBAAoBC;;;;;;;;YAQvBV;;UAEFP;;UAEAkB;;cAEIZ,eAAeO,MAAMC,UAAUK;;WAElChB;;UAEDN,kBAAkBS;;UAEbc,IAAAA;;;;;;aAMFvB;;;;YAIDA;;;;;;;;WAQDS;;WAEAT;;iBAEMA;;YAELS;;KAEFW,aAAAA,GAAgBX,4BAA4BA;KAC5Ce,kBAAAA,GAAqBf;UAChBgB,yBAAyBL;;UAE9BC;;;;cAIIK;;YAEFhB;;cAEEV;;qBAEOA,SAAS0B;;SAErBV,MAAMW;;UAEAA,wBAAwBP;;;;SAI9BpB;cACKgB,MAAMC,UAAUK;cAChBtB,SAAS0B;SACd1B,SAASyB,YAAYJ;;UAEfO,GAAAA;;;;;;;;;;;;UAYL1B;;YAEEQ;;sBAEUV,SAASI;;KAErBsB,UAAAA;;;iBAGO1B;kBACCA,SAASS;;UAEZoB,qBAAAA;;;UAGAC,IAAAA;;;SAGNrB;;;;UAIMsB,UAAAA,SAAmBD;;;UAGnBE,mBAAAA;SACND;;UAEME,kBAAAA;;;;;WAKJxB;;;;;;YAMCC;;UAEGwB,2BAAAA,SAAoCC,KAAKF;;;KAG9CG,eAAAA;KACAC,YAAAA;KACAC,UAAAA;KACAC,SAAAA;KACAC,oBAAAA;KACAC,iBAAAA;KACAC,cAAAA;KACAC,eAAAA"}