Js ts SDK 参考

@langchain/langgraph-sdk

@langchain/langgraph-sdk ¶

langchain/langgraph-sdk/auth¶

类¶

Auth
HTTPException

接口¶

AuthEventValueMap

类型别名¶

AuthFilters

@langchain/langgraph-sdk

@langchain/langgraph-sdk / Auth

类：Auth\<TExtra, TAuthReturn, TUser\>¶

定义于：src/auth/index.ts:11

类型参数¶

• TExtra = {}

• TAuthReturn extends BaseAuthReturn = BaseAuthReturn

• TUser extends BaseUser = ToUserLike\<TAuthReturn\>

构造函数¶

new Auth()¶

new Auth\<TExtra, TAuthReturn, TUser\>(): Auth\<TExtra, TAuthReturn, TUser\>

返回¶

Auth\<TExtra, TAuthReturn, TUser\>

方法¶

authenticate()¶

authenticate\<T\>(cb): Auth\<TExtra, T\>

定义于：src/auth/index.ts:25

类型参数¶

• T extends BaseAuthReturn

参数¶

返回¶

Auth\<TExtra, T\>

on()¶

on\<T\>(event, callback): this

定义于：src/auth/index.ts:32

类型参数¶

• T extends CallbackEvent

参数¶

event¶

T

callback¶

OnCallback\<T, TUser\>

返回¶

this

@langchain/langgraph-sdk

@langchain/langgraph-sdk / HTTPException

类：HTTPException¶

定义于：src/auth/error.ts:66

继承¶

Error

构造函数¶

new HTTPException()¶

new HTTPException(status, options?): HTTPException

定义于：src/auth/error.ts:70

参数¶

status¶

number

options?¶

# cause?¶

unknown

# headers?¶

HeadersInit

# message?¶

string

返回¶

HTTPException

覆盖¶

Error.constructor

属性¶

cause?¶

可选 cause: unknown

定义于：node_modules/typescript/lib/lib.es2022.error.d.ts:24

继承自¶

Error.cause

headers¶

headers: HeadersInit

定义于：src/auth/error.ts:68

message¶

message: string

定义于：node_modules/typescript/lib/lib.es5.d.ts:1077

继承自¶

Error.message

name¶

name: string

定义于：node_modules/typescript/lib/lib.es5.d.ts:1076

继承自¶

Error.name

stack?¶

可选 stack: string

定义于：node_modules/typescript/lib/lib.es5.d.ts:1078

继承自¶

Error.stack

status¶

status: number

定义于：src/auth/error.ts:67

prepareStackTrace()?¶

静态 可选 prepareStackTrace: (err, stackTraces) => any

定义于：node_modules/types/node/globals.d.ts:28

格式化堆栈跟踪的可选覆盖

参数¶

err¶

Error

stackTraces¶

CallSite[]

返回¶

any

参考¶

https://v8.node.org.cn/docs/stack-trace-api#customizing-stack-traces

继承自¶

Error.prepareStackTrace

stackTraceLimit¶

静态 stackTraceLimit: number

定义于：node_modules/types/node/globals.d.ts:30

继承自¶

Error.stackTraceLimit

方法¶

captureStackTrace()¶

静态 captureStackTrace(targetObject, constructorOpt?): void

定义于：node_modules/types/node/globals.d.ts:21

在目标对象上创建 .stack 属性

参数¶

targetObject¶

object

constructorOpt?¶

Function

返回¶

void

继承自¶

Error.captureStackTrace

@langchain/langgraph-sdk

@langchain/langgraph-sdk / AuthEventValueMap

接口：AuthEventValueMap¶

定义于：src/auth/types.ts:218

属性¶

assistants:create¶

assistants:create: object

定义于：src/auth/types.ts:226

assistant_id?¶

可选 assistant_id: Maybe\<string\>

config?¶

可选 config: Maybe\<AssistantConfig\>

graph_id¶

graph_id: string

if_exists?¶

可选 if_exists: Maybe\<"raise" | "do_nothing"\>

metadata?¶

可选 metadata: Maybe\<Record\<string, unknown\>\>

name?¶

可选 name: Maybe\<string\>

assistants:delete¶

assistants:delete: object

定义于：src/auth/types.ts:229

assistant_id¶

assistant_id: string

assistants:read¶

assistants:read: object

定义于：src/auth/types.ts:227

assistant_id¶

assistant_id: string

metadata?¶

可选 metadata: Maybe\<Record\<string, unknown\>\>

assistants:search¶

assistants:search: object

定义于：src/auth/types.ts:230

graph_id?¶

可选 graph_id: Maybe\<string\>

limit?¶

可选 limit: Maybe\<number\>

metadata?¶

可选 metadata: Maybe\<Record\<string, unknown\>\>

offset?¶

可选 offset: Maybe\<number\>

assistants:update¶

assistants:update: object

定义于：src/auth/types.ts:228

assistant_id¶

assistant_id: string

config?¶

可选 config: Maybe\<AssistantConfig\>

graph_id?¶

可选 graph_id: Maybe\<string\>

metadata?¶

可选 metadata: Maybe\<Record\<string, unknown\>\>

name?¶

可选 name: Maybe\<string\>

version?¶

可选 version: Maybe\<number\>

crons:create¶

crons:create: object

定义于：src/auth/types.ts:232

cron_id?¶

可选 cron_id: Maybe\<string\>

end_time?¶

可选 end_time: Maybe\<string\>

payload?¶

可选 payload: Maybe\<Record\<string, unknown\>\>

schedule¶

schedule: string

thread_id?¶

可选 thread_id: Maybe\<string\>

user_id?¶

可选 user_id: Maybe\<string\>

crons:delete¶

crons:delete: object

定义于：src/auth/types.ts:235

cron_id¶

cron_id: string

crons:read¶

crons:read: object

定义于：src/auth/types.ts:233

cron_id¶

cron_id: string

crons:search¶

crons:search: object

定义于：src/auth/types.ts:236

assistant_id?¶

可选 assistant_id: Maybe\<string\>

limit?¶

可选 limit: Maybe\<number\>

offset?¶

可选 offset: Maybe\<number\>

thread_id?¶

可选 thread_id: Maybe\<string\>

crons:update¶

crons:update: object

定义于：src/auth/types.ts:234

cron_id¶

cron_id: string

payload?¶

可选 payload: Maybe\<Record\<string, unknown\>\>

schedule?¶

可选 schedule: Maybe\<string\>

store:delete¶

store:delete: object

定义于：src/auth/types.ts:242

key¶

key: string

namespace?¶

可选 namespace: Maybe\<string[]\>

store:get¶

store:get: object

定义于：src/auth/types.ts:239

key¶

key: string

namespace¶

namespace: Maybe\<string[]\>

store:list_namespaces¶

store:list_namespaces: object

定义于：src/auth/types.ts:241

limit?¶

可选 limit: Maybe\<number\>

max_depth?¶

可选 max_depth: Maybe\<number\>

namespace?¶

可选 namespace: Maybe\<string[]\>

offset?¶

可选 offset: Maybe\<number\>

suffix?¶

可选 suffix: Maybe\<string[]\>

store:put¶

store:put: object

定义于：src/auth/types.ts:238

key¶

key: string

namespace¶

namespace: string[]

value¶

value: Record\<string, unknown\>

store:search¶

store:search: object

定义于：src/auth/types.ts:240

filter?¶

可选 filter: Maybe\<Record\<string, unknown\>\>

limit?¶

可选 limit: Maybe\<number\>

namespace?¶

可选 namespace: Maybe\<string[]\>

offset?¶

可选 offset: Maybe\<number\>

query?¶

可选 query: Maybe\<string\>

threads:create¶

threads:create: object

定义于：src/auth/types.ts:219

if_exists?¶

可选 if_exists: Maybe\<"raise" | "do_nothing"\>

metadata?¶

可选 metadata: Maybe\<Record\<string, unknown\>\>

thread_id?¶

可选 thread_id: Maybe\<string\>

threads:create_run¶

threads:create_run: object

定义于：src/auth/types.ts:224

after_seconds?¶

可选 after_seconds: Maybe\<number\>

assistant_id¶

assistant_id: string

if_not_exists?¶

可选 if_not_exists: Maybe\<"reject" | "create"\>

kwargs¶

kwargs: Record\<string, unknown\>

metadata?¶

可选 metadata: Maybe\<Record\<string, unknown\>\>

multitask_strategy?¶

可选 multitask_strategy: Maybe\<"reject" | "interrupt" | "rollback" | "enqueue"\>

prevent_insert_if_inflight?¶

可选 prevent_insert_if_inflight: Maybe\<boolean\>

run_id¶

run_id: string

status¶

status: Maybe\<"pending" | "running" | "error" | "success" | "timeout" | "interrupted"\>

thread_id?¶

可选 thread_id: Maybe\<string\>

threads:delete¶

threads:delete: object

定义于：src/auth/types.ts:222

run_id?¶

可选 run_id: Maybe\<string\>

thread_id?¶

可选 thread_id: Maybe\<string\>

threads:read¶

threads:read: object

定义于：src/auth/types.ts:220

thread_id?¶

可选 thread_id: Maybe\<string\>

threads:search¶

threads:search: object

定义于：src/auth/types.ts:223

limit?¶

可选 limit: Maybe\<number\>

metadata?¶

可选 metadata: Maybe\<Record\<string, unknown\>\>

offset?¶

可选 offset: Maybe\<number\>

status?¶

可选 status: Maybe\<"error" | "interrupted" | "idle" | "busy" | string & object\>

thread_id?¶

可选 thread_id: Maybe\<string\>

values?¶

可选 values: Maybe\<Record\<string, unknown\>\>

threads:update¶

threads:update: object

定义于：src/auth/types.ts:221

action?¶

可选 action: Maybe\<"interrupt" | "rollback"\>

metadata?¶

可选 metadata: Maybe\<Record\<string, unknown\>\>

thread_id?¶

可选 thread_id: Maybe\<string\>

@langchain/langgraph-sdk

@langchain/langgraph-sdk / AuthFilters

类型别名：AuthFilters\<TKey\>¶

AuthFilters\<TKey\>: { [key in TKey]: string | { [op in "\(contains" \| "\)eq"]?: string } }

定义于：src/auth/types.ts:367

类型参数¶

• TKey extends string | number | symbol

@langchain/langgraph-sdk

@langchain/langgraph-sdk / AssistantsClient

类：AssistantsClient¶

定义于：client.ts:294

继承¶

BaseClient

构造函数¶

new AssistantsClient()¶

new AssistantsClient(config?): AssistantsClient

定义于：client.ts:88

参数¶

config?¶

ClientConfig

返回¶

AssistantsClient

继承自¶

BaseClient.constructor

方法¶

create()¶

create(payload): Promise\<Assistant\>

定义于：client.ts:359

创建一个新助手。

参数¶

payload¶

用于创建助手的载荷。

# assistantId?¶

string

# config?¶

配置

# description?¶

string

# graphId¶

string

# ifExists?¶

OnConflictBehavior

# metadata?¶

Metadata

# name?¶

string

返回¶

Promise\<Assistant\>

创建的助手。

delete()¶

delete(assistantId): Promise\<void\>

定义于：client.ts:415

删除助手。

参数¶

assistantId¶

string

助手的ID。

返回¶

Promise\<void\>

get()¶

get(assistantId): Promise\<Assistant\>

定义于：client.ts:301

通过 ID 获取助手。

参数¶

assistantId¶

string

助手的 ID。

返回¶

Promise\<Assistant\>

Assistant

getGraph()¶

getGraph(assistantId, options?): Promise\<AssistantGraph\>

定义于：client.ts:311

获取分配给可运行对象的图的 JSON 表示。

参数¶

assistantId¶

string

助手的 ID。

options?¶

# xray?¶

number | boolean

是否在序列化的图表示中包含子图。如果提供整数值，则仅包含深度小于或等于该值的子图。

返回¶

Promise\<AssistantGraph\>

序列化的图

getSchemas()¶

getSchemas(assistantId): Promise\<GraphSchema\>

定义于：client.ts:325

获取分配给可运行对象的图的状态和配置模式。

参数¶

assistantId¶

string

助手的 ID。

返回¶

Promise\<GraphSchema\>

图模式

getSubgraphs()¶

getSubgraphs(assistantId, options?): Promise\<Subgraphs\>

定义于：client.ts:336

通过 ID 获取助手的 schema。

参数¶

assistantId¶

string

要获取其 schema 的助手的 ID。

options?¶

获取子图的额外选项，例如命名空间或递归提取。

# namespace?¶

string

# recurse?¶

boolean

返回¶

Promise\<Subgraphs\>

助手的子图。

getVersions()¶

getVersions(assistantId, payload?): Promise\<AssistantVersion[]\>

定义于：client.ts:453

列出助手的全部版本。

参数¶

assistantId¶

string

助手的ID。

payload?¶

# limit?¶

number

# metadata?¶

Metadata

# offset?¶

number

返回¶

Promise\<AssistantVersion[]\>

助手版本列表。

search()¶

search(query?): Promise\<Assistant[]\>

定义于：client.ts:426

列出助手。

参数¶

query?¶

查询选项。

# graphId?¶

string

# limit?¶

number

# metadata?¶

Metadata

# offset?¶

number

# sortBy?¶

AssistantSortBy

# sortOrder?¶

SortOrder

返回¶

Promise\<Assistant[]\>

助手列表。

setLatest()¶

setLatest(assistantId, version): Promise\<Assistant\>

定义于：client.ts:481

更改助手的版本。

参数¶

assistantId¶

string

助手的ID。

version¶

number

要更改为的版本。

返回¶

Promise\<Assistant\>

更新后的助手。

update()¶

update(assistantId, payload): Promise\<Assistant\>

定义于：client.ts:388

更新助手。

参数¶

assistantId¶

string

助手的ID。

payload¶

用于更新助手的载荷。

# config?¶

配置

# description?¶

string

# graphId?¶

string

# metadata?¶

Metadata

# name?¶

string

返回¶

Promise\<Assistant\>

更新后的助手。

@langchain/langgraph-sdk

@langchain/langgraph-sdk / Client

类：Client\<TStateType, TUpdateType, TCustomEventType\>¶

定义于：client.ts:1448

类型参数¶

• TStateType = DefaultValues

• TUpdateType = TStateType

• TCustomEventType = unknown

构造函数¶

new Client()¶

new Client\<TStateType, TUpdateType, TCustomEventType\>(config?): Client\<TStateType, TUpdateType, TCustomEventType\>

定义于：client.ts:1484

参数¶

config?¶

ClientConfig

返回¶

Client\<TStateType, TUpdateType, TCustomEventType\>

属性¶

~ui¶

~ui: UiClient

定义于：client.ts:1482

内部

用于与 UI 交互的客户端。由 `LoadExternalComponent` 使用，其 API 未来可能会更改。

assistants¶

assistants: AssistantsClient

定义于：client.ts:1456

用于与助手交互的客户端。

crons¶

crons: CronsClient

定义于：client.ts:1471

用于与 cron 运行交互的客户端。

runs¶

runs: RunsClient\<TStateType, TUpdateType, TCustomEventType\>

定义于：client.ts:1466

用于与运行交互的客户端。

store¶

store: StoreClient

定义于：client.ts:1476

用于与 KV 存储交互的客户端。

threads¶

threads: ThreadsClient\<TStateType, TUpdateType\>

定义于：client.ts:1461

用于与线程交互的客户端。

@langchain/langgraph-sdk

@langchain/langgraph-sdk / CronsClient

类：CronsClient¶

定义于：client.ts:197

继承¶

BaseClient

构造函数¶

new CronsClient()¶

new CronsClient(config?): CronsClient

定义于：client.ts:88

参数¶

config?¶

ClientConfig

返回¶

CronsClient

继承自¶

BaseClient.constructor

方法¶

create()¶

create(assistantId, payload?): Promise\<CronCreateResponse\>

定义于：client.ts:238

参数¶

assistantId¶

string

用于此 cron 任务的助手 ID。

payload?¶

CronsCreatePayload

用于创建 cron 任务的载荷。

返回¶

Promise\<CronCreateResponse\>

createForThread()¶

createForThread(threadId, assistantId, payload?): Promise\<CronCreateForThreadResponse\>

定义于：client.ts:205

参数¶

threadId¶

string

线程的 ID。

assistantId¶

string

用于此 cron 任务的助手 ID。

payload?¶

CronsCreatePayload

用于创建 cron 任务的载荷。

返回¶

Promise\<CronCreateForThreadResponse\>

创建的后台运行。

delete()¶

delete(cronId): Promise\<void\>

定义于：client.ts:265

参数¶

cronId¶

string

要删除的 Cron 任务的 Cron ID。

返回¶

Promise\<void\>

search()¶

search(query?): Promise\<Cron[]\>

定义于：client.ts:276

参数¶

query?¶

查询选项。

# assistantId?¶

string

# limit?¶

number

# offset?¶

number

# threadId?¶

string

返回¶

Promise\<Cron[]\>

cron 任务列表。

@langchain/langgraph-sdk

@langchain/langgraph-sdk / RunsClient

类：RunsClient\<TStateType, TUpdateType, TCustomEventType\>¶

定义于：client.ts:776

继承¶

BaseClient

类型参数¶

• TStateType = DefaultValues

• TUpdateType = TStateType

• TCustomEventType = unknown

构造函数¶

new RunsClient()¶

new RunsClient\<TStateType, TUpdateType, TCustomEventType\>(config?): RunsClient\<TStateType, TUpdateType, TCustomEventType\>

定义于：client.ts:88

参数¶

config?¶

ClientConfig

返回¶

RunsClient\<TStateType, TUpdateType, TCustomEventType\>

继承自¶

BaseClient.constructor

方法¶

cancel()¶

cancel(threadId, runId, wait, action): Promise\<void\>

定义于：client.ts:1063

取消一次运行。

参数¶

threadId¶

string

线程的 ID。

runId¶

string

运行的 ID。

wait¶

boolean = false

取消时是否阻塞

action¶

CancelAction = "interrupt"

取消运行时要采取的操作。可能的值为 interrupt 或 rollback。默认为 interrupt。

返回¶

Promise\<void\>

create()¶

create(threadId, assistantId, payload?): Promise\<Run\>

定义于：client.ts:885

创建一次运行。

参数¶

threadId¶

string

线程的 ID。

assistantId¶

string

用于此运行的助手 ID。

payload?¶

RunsCreatePayload

用于创建运行的载荷。

返回¶

Promise\<Run\>

创建的运行。

createBatch()¶

createBatch(payloads): Promise\<Run[]\>

定义于：client.ts:921

创建一批无状态后台运行。

参数¶

payloads¶

RunsCreatePayload & object[]

用于创建运行的载荷数组。

返回¶

Promise\<Run[]\>

创建的运行数组。

delete()¶

delete(threadId, runId): Promise\<void\>

定义于：client.ts:1157

删除运行。

参数¶

threadId¶

string

线程的 ID。

runId¶

string

运行的 ID。

返回¶

Promise\<void\>

get()¶

get(threadId, runId): Promise\<Run\>

定义于：client.ts:1050

按 ID 获取运行。

参数¶

threadId¶

string

线程的 ID。

runId¶

string

运行的 ID。

返回¶

Promise\<Run\>

运行。

join()¶

join(threadId, runId, options?): Promise\<void\>

定义于：client.ts:1085

阻塞直到运行完成。

参数¶

threadId¶

string

线程的 ID。

runId¶

string

运行的 ID。

options?¶

# signal?¶

AbortSignal

返回¶

Promise\<void\>

joinStream()¶

joinStream(threadId, runId, options?): AsyncGenerator\<{ data: any; event: StreamEvent; }\>

定义于：client.ts:1111

实时流式传输运行的输出，直到运行完成。输出不进行缓冲，因此在此调用之前产生的任何输出将不会在此处收到。

参数¶

threadId¶

string

线程的 ID。

runId¶

string

运行的 ID。

options?¶

控制流行为的额外选项：- signal：可用于取消流请求的 AbortSignal - cancelOnDisconnect：如果客户端与流断开连接，则为 true 时自动取消运行 - streamMode：控制从流接收的事件类型（可以是单个模式或多种模式的数组）。必须是创建运行t时传递的流模式的子集。后台运行默认启用所有流模式的联合。

AbortSignal | { cancelOnDisconnect: boolean; signal: AbortSignal; streamMode: StreamMode | StreamMode[]; }

返回¶

AsyncGenerator\<{ data: any; event: StreamEvent; }\>

产生流部分的异步生成器。

list()¶

list(threadId, options?): Promise\<Run[]\>

定义于：client.ts:1013

列出线程的所有运行。

参数¶

threadId¶

string

线程的 ID。

options?¶

过滤和分页选项。

# limit?¶

number

要返回的最大运行数量。默认为 10。

# offset?¶

number

起始偏移量。默认为 0。

# status?¶

RunStatus

用于过滤的运行状态。

返回¶

Promise\<Run[]\>

运行列表。

stream()¶

创建运行并流式传输结果。

参数¶

线程的 ID。

参数¶

用于此运行的助手 ID。

参数¶

用于创建运行的载荷。

调用签名¶

stream\<TStreamMode, TSubgraphs\>(threadId, assistantId, payload?): TypedAsyncGenerator\<TStreamMode, TSubgraphs, TStateType, TUpdateType, TCustomEventType\>

定义于：client.ts:781

类型参数¶

• TStreamMode extends StreamMode | StreamMode[] = StreamMode

• TSubgraphs extends boolean = false

参数¶

# threadId¶

null

# assistantId¶

string

# payload?¶

Omit\<RunsStreamPayload\<TStreamMode, TSubgraphs\>, "multitaskStrategy" | "onCompletion"\>

返回¶

TypedAsyncGenerator\<TStreamMode, TSubgraphs, TStateType, TUpdateType, TCustomEventType\>

调用签名¶

stream\<TStreamMode, TSubgraphs\>(threadId, assistantId, payload?): TypedAsyncGenerator\<TStreamMode, TSubgraphs, TStateType, TUpdateType, TCustomEventType\>

定义于：client.ts:799

类型参数¶

• TStreamMode extends StreamMode | StreamMode[] = StreamMode

• TSubgraphs extends boolean = false

参数¶

# threadId¶

string

# assistantId¶

string

# payload?¶

RunsStreamPayload\<TStreamMode, TSubgraphs\>

返回¶

TypedAsyncGenerator\<TStreamMode, TSubgraphs, TStateType, TUpdateType, TCustomEventType\>

wait()¶

创建一次运行并等待其完成。

参数¶

线程的 ID。

参数¶

用于此运行的助手 ID。

参数¶

用于创建运行的载荷。

调用签名¶

wait(threadId, assistantId, payload?): Promise\<DefaultValues\>

定义于：client.ts:938

参数¶

# threadId¶

null

# assistantId¶

string

# payload?¶

Omit\<RunsWaitPayload, "multitaskStrategy" | "onCompletion"\>

返回¶

Promise\<DefaultValues\>

调用签名¶

wait(threadId, assistantId, payload?): Promise\<DefaultValues\>

定义于：client.ts:944

参数¶

# threadId¶

string

# assistantId¶

string

# payload?¶

RunsWaitPayload

返回¶

Promise\<DefaultValues\>

@langchain/langgraph-sdk

@langchain/langgraph-sdk / StoreClient

类：StoreClient¶

定义于：client.ts:1175

继承¶

BaseClient

构造函数¶

new StoreClient()¶

new StoreClient(config?): StoreClient

定义于：client.ts:88

参数¶

config?¶

ClientConfig

返回¶

StoreClient

继承自¶

BaseClient.constructor

方法¶

deleteItem()¶

deleteItem(namespace, key): Promise\<void\>

定义于：client.ts:1296

删除项。

参数¶

namespace¶

string[]

表示命名空间路径的字符串列表。

key¶

string

项目的唯一标识符。

返回¶

Promise\<void\>

Promise

getItem()¶

getItem(namespace, key, options?): Promise\<null | Item\>

定义于：client.ts:1252

检索单个项。

参数¶

namespace¶

string[]

表示命名空间路径的字符串列表。

key¶

string

项目的唯一标识符。

options?¶

# refreshTtl?¶

null | boolean

是否在此读取操作上刷新 TTL。如果为 null，则使用存储的默认行为。

返回¶

Promise\<null | Item\>

Promise

示例¶

const item = await client.store.getItem(
  ["documents", "user123"],
  "item456",
  { refreshTtl: true }
);
console.log(item);
// {
//   namespace: ["documents", "user123"],
//   key: "item456",
//   value: { title: "My Document", content: "Hello World" },
//   createdAt: "2024-07-30T12:00:00Z",
//   updatedAt: "2024-07-30T12:00:00Z"
// }

listNamespaces()¶

listNamespaces(options?): Promise\<ListNamespaceResponse\>

定义于：client.ts:1392

列出带可选匹配条件的命名空间。

参数¶

options?¶

# limit?¶

number

要返回的最大命名空间数（默认值为 100）。

# maxDepth?¶

number

可选整数，指定要返回的命名空间的最大深度。

# offset?¶

number

在返回结果之前要跳过的命名空间数（默认值为 0）。

# prefix?¶

string[]

表示命名空间前缀的可选字符串列表，用于过滤命名空间。

# suffix?¶

string[]

表示命名空间后缀的可选字符串列表，用于过滤命名空间。

返回¶

Promise\<ListNamespaceResponse\>

Promise

putItem()¶

putItem(namespace, key, value, options?): Promise\<void>

定义于： client.ts:1196

存储或更新项目。

参数¶

namespace¶

string[]

表示命名空间路径的字符串列表。

key¶

string

命名空间内项目的唯一标识符。

value¶

Record\<string, any>

包含项目数据的字典。

options?¶

# index?¶

null | false | string[]

控制搜索索引 - null（使用默认值），false（禁用），或要索引的字段路径列表。

# ttl?¶

null | number

项的可选生存时间（分钟），null 表示永不 expires。

返回值¶

Promise\<void\>

Promise

示例¶

await client.store.putItem(
  ["documents", "user123"],
  "item456",
  { title: "My Document", content: "Hello World" },
  { ttl: 60 } // expires in 60 minutes
);

searchItems()¶

searchItems(namespacePrefix, options?): Promise\<SearchItemsResponse>

定义于： client.ts:1347

在命名空间前缀内搜索项。

参数¶

namespacePrefix¶

string[]

表示命名空间前缀的字符串列表。

options?¶

# filter?¶

Record\<string, any>

可选的键值对字典，用于过滤结果。

# limit?¶

number

要返回的最大项目数（默认值为 10）。

# offset?¶

number

在返回结果之前要跳过的项目数（默认值为 0）。

# query?¶

string

可选的搜索查询。

# refreshTtl?¶

null | boolean

是否刷新此搜索返回的项的 TTL。如果为 null，则使用存储的默认行为。

返回值¶

Promise\<SearchItemsResponse>

Promise

示例¶

const results = await client.store.searchItems(
  ["documents"],
  {
    filter: { author: "John Doe" },
    limit: 5,
    refreshTtl: true
  }
);
console.log(results);
// {
//   items: [
//     {
//       namespace: ["documents", "user123"],
//       key: "item789",
//       value: { title: "Another Document", author: "John Doe" },
//       createdAt: "2024-07-30T12:00:00Z",
//       updatedAt: "2024-07-30T12:00:00Z"
//     },
//     // ... additional items ...
//   ]
// }

@langchain/langgraph-sdk

@langchain/langgraph-sdk / ThreadsClient

类： ThreadsClient\<TStateType, TUpdateType>¶

定义于： client.ts:489

继承自¶

BaseClient

类型参数¶

• TStateType = DefaultValues

• TUpdateType = TStateType

构造函数¶

new ThreadsClient()¶

new ThreadsClient\<TStateType, TUpdateType>(config?): ThreadsClient\<TStateType, TUpdateType>

定义于：client.ts:88

参数¶

config?¶

ClientConfig

返回值¶

ThreadsClient\<TStateType, TUpdateType>

继承自¶

BaseClient.constructor

方法¶

copy()¶

copy(threadId): Promise\<Thread\<TStateType>>

定义于： client.ts:566

复制现有线程

参数¶

threadId¶

string

要复制的线程 ID

返回值¶

Promise\<Thread\<TStateType>>

新复制的线程

create()¶

create(payload?): Promise\<Thread\<TStateType>>

定义于： client.ts:511

创建新会话。

参数¶

payload?¶

用于创建线程的负载。

# graphId?¶

string

要与线程关联的图 ID。

# ifExists?¶

OnConflictBehavior

如何处理重复创建。

默认值

"raise"

# metadata?¶

Metadata

线程的元数据。

# supersteps?¶

object[]

创建线程时应用超步骤列表，每个超步骤包含一系列更新。

用于在部署之间复制线程。

# threadId?¶

string

要创建的线程 ID。

如果未提供，将生成一个随机 UUID。

返回值¶

Promise\<Thread\<TStateType>>

创建的会话。

delete()¶

delete(threadId): Promise\<void>

定义于： client.ts:599

删除会话。

参数¶

threadId¶

string

线程 ID。

返回值¶

Promise\<void\>

get()¶

get\<ValuesType>(threadId): Promise\<Thread\<ValuesType>>

定义于： client.ts:499

通过 ID 获取会话。

类型参数¶

• ValuesType = TStateType

参数¶

threadId¶

string

线程 ID。

返回值¶

Promise\<Thread\<ValuesType>>

线程。

getHistory()¶

getHistory\<ValuesType>(threadId, options?): Promise\<ThreadState\<ValuesType>[]>

定义于： client.ts:752

获取线程的所有历史状态。

类型参数¶

• ValuesType = TStateType

参数¶

threadId¶

string

线程 ID。

options?¶

附加选项。

# before?¶

配置

# checkpoint?¶

Partial\<Omit\<Checkpoint, "thread_id">>

# limit?¶

number

# metadata?¶

Metadata

返回值¶

Promise\<ThreadState\<ValuesType>[]>

线程状态列表。

getState()¶

getState\<ValuesType>(threadId, checkpoint?, options?): Promise\<ThreadState\<ValuesType>>

定义于： client.ts:659

获取线程状态。

类型参数¶

• ValuesType = TStateType

参数¶

threadId¶

string

线程 ID。

checkpoint?¶

string | Checkpoint

options?¶

# subgraphs?¶

boolean

返回值¶

Promise\<ThreadState\<ValuesType>>

线程状态。

patchState()¶

patchState(threadIdOrConfig, metadata): Promise\<void>

定义于： client.ts:722

修补线程的元数据。

参数¶

threadIdOrConfig¶

要修补状态的线程 ID 或配置。

string | Config

metadata¶

Metadata

用于修补状态的元数据。

返回值¶

Promise\<void\>

search()¶

search\<ValuesType>(query?): Promise\<Thread\<ValuesType>[]>

定义于： client.ts:611

列出线程

类型参数¶

• ValuesType = TStateType

参数¶

query?¶

查询选项

# limit?¶

number

要返回的最大线程数。默认为 10

# metadata?¶

Metadata

用于过滤线程的元数据。

# offset?¶

number

起始偏移量。

# sortBy?¶

ThreadSortBy

排序方式。

# sortOrder?¶

SortOrder

排序顺序。必须是 'asc' 或 'desc' 之一。

# status?¶

ThreadStatus

要过滤的会话状态。必须是 'idle'、'busy'、'interrupted' 或 'error' 之一。

返回值¶

Promise\<Thread\<ValuesType>[]>

线程列表

update()¶

update(threadId, payload?): Promise\<Thread\<DefaultValues>>

定义于： client.ts:579

更新会话。

参数¶

threadId¶

string

线程 ID。

payload?¶

用于更新线程的负载。

# metadata?¶

Metadata

线程的元数据。

返回值¶

Promise\<Thread\<DefaultValues>>

更新后的线程。

updateState()¶

updateState\<ValuesType>(threadId, options): Promise\<Pick\<Config, "configurable">>

定义于： client.ts:693

向线程添加状态。

类型参数¶

• ValuesType = TUpdateType

参数¶

threadId¶

string

线程的 ID。

options¶

# asNode?¶

string

# checkpoint?¶

检查点

# checkpointId?¶

string

# values¶

ValuesType

返回值¶

Promise\<Pick\<Config, "configurable">>

@langchain/langgraph-sdk

@langchain/langgraph-sdk / getApiKey

函数： getApiKey()¶

getApiKey(apiKey?): undefined | string

定义于： client.ts:53

从环境中获取 API 密钥。优先级：1. 显式参数 2. LANGGRAPH_API_KEY 3. LANGSMITH_API_KEY 4. LANGCHAIN_API_KEY

参数¶

apiKey?¶

string

作为参数提供的可选 API 密钥

返回值¶

undefined | string

如果找到 API 密钥则返回，否则返回 undefined

@langchain/langgraph-sdk

@langchain/langgraph-sdk / ClientConfig

接口： ClientConfig¶

定义于： client.ts:71

属性¶

apiKey?¶

optional apiKey: string

定义于： client.ts:73

apiUrl?¶

optional apiUrl: string

定义于： client.ts:72

callerOptions?¶

optional callerOptions: AsyncCallerParams

定义于： client.ts:74

defaultHeaders?¶

optional defaultHeaders: Record\<string, undefined | null | string>

定义于： client.ts:76

timeoutMs?¶

optional timeoutMs: number

定义于： client.ts:75

langchain/langgraph-sdk

langchain/langgraph-sdk/react¶

类型别名¶

MessageMetadata

函数¶

useStream

@langchain/langgraph-sdk

@langchain/langgraph-sdk / useStream

函数： useStream()¶

useStream\<StateType, Bag>(options): UseStream\<StateType, Bag>

定义于： react/stream.tsx:618

类型参数¶

• StateType extends Record\<string, unknown> = Record\<string, unknown>

• Bag extends object = BagTemplate

参数¶

options¶

UseStreamOptions\<StateType, Bag>

返回值¶

UseStream\<StateType, Bag>

@langchain/langgraph-sdk

@langchain/langgraph-sdk / UseStream

接口： UseStream\<StateType, Bag>¶

定义于： react/stream.tsx:507

类型参数¶

• StateType extends Record\<string, unknown> = Record\<string, unknown>

• Bag extends BagTemplate = BagTemplate

属性¶

assistantId¶

assistantId: string

定义于： react/stream.tsx:592

要使用的助手 ID。

branch¶

branch: string

定义于： react/stream.tsx:542

线程的当前分支。

client¶

client: Client

定义于： react/stream.tsx:587

用于发送请求和接收响应的 LangGraph SDK 客户端。

error¶

error: unknown

定义于： react/stream.tsx:519

从线程或流式传输期间遇到的最后一个错误。

experimental_branchTree¶

experimental_branchTree: Sequence\<StateType>

定义于： react/stream.tsx:558

实验性

线程的所有分支树。

getMessagesMetadata()¶

getMessagesMetadata: (message, index?) => undefined | MessageMetadata\<StateType>

定义于： react/stream.tsx:579

获取消息的元数据，例如消息首次出现的线程状态和分支信息。

参数¶

message¶

消息

要获取元数据的消息。

index?¶

number

消息在线程中的索引。

返回值¶

undefined | MessageMetadata\<StateType>

消息的元数据。

history¶

history: ThreadState\<StateType>[]

定义于： react/stream.tsx:552

线程状态的扁平化历史记录。

interrupt¶

interrupt: undefined | Interrupt\<GetInterruptType\<Bag>>

定义于： react/stream.tsx:563

如果流被中断，获取中断值。

isLoading¶

isLoading: boolean

定义于： react/stream.tsx:524

流当前是否正在运行。

messages¶

messages: Message[]

定义于： react/stream.tsx:569

从线程推断出的消息。将根据传入的消息块自动更新。

setBranch()¶

setBranch: (branch) => void

定义于： react/stream.tsx:547

设置线程的分支。

参数¶

branch¶

string

返回值¶

void

stop()¶

stop: () => void

定义于： react/stream.tsx:529

停止流。

返回值¶

void

submit()¶

submit: (values, options?) => void

定义于： react/stream.tsx:534

创建并向线程流式传输运行。

参数¶

values¶

undefined | null | GetUpdateType\<Bag, StateType>

options?¶

SubmitOptions\<StateType, GetConfigurableType\<Bag>>

返回值¶

void

values¶

values: StateType

定义于： react/stream.tsx:514

线程的当前值。

@langchain/langgraph-sdk

@langchain/langgraph-sdk / UseStreamOptions

接口： UseStreamOptions\<StateType, Bag>¶

定义于： react/stream.tsx:408

类型参数¶

• StateType extends Record\<string, unknown> = Record\<string, unknown>

• Bag extends BagTemplate = BagTemplate

属性¶

apiKey?¶

optional apiKey: string

定义于： react/stream.tsx:430

要使用的 API 密钥。

apiUrl?¶

optional apiUrl: string

定义于： react/stream.tsx:425

要使用的 API URL。

assistantId¶

assistantId: string

定义于： react/stream.tsx:415

要使用的助手 ID。

callerOptions?¶

optional callerOptions: AsyncCallerParams

定义于： react/stream.tsx:435

自定义调用选项，例如自定义 fetch 实现。

client?¶

optional client: Client\<DefaultValues, DefaultValues, unknown>

定义于： react/stream.tsx:420

用于发送请求的客户端。

defaultHeaders?¶

optional defaultHeaders: Record\<string, undefined | null | string>

定义于： react/stream.tsx:440

发送请求时使用的默认标头。

messagesKey?¶

optional messagesKey: string

定义于： react/stream.tsx:448

指定状态中包含消息的键。默认为 "messages"。

默认¶

"messages"

onCustomEvent()?¶

optional onCustomEvent: (data, options) => void

定义于： react/stream.tsx:470

接收到自定义事件时调用的回调。

参数¶

data¶

GetCustomEventType\<Bag>

options¶

# mutate¶

(update) => void

返回值¶

void

onDebugEvent()?¶

optional onDebugEvent: (data) => void

定义于： react/stream.tsx:494

内部

接收到调试事件时调用的回调。此 API 处于实验阶段，可能会更改。

参数¶

data¶

unknown

返回值¶

void

onError()?¶

optional onError: (error) => void

定义于： react/stream.tsx:453

发生错误时调用的回调。

参数¶

error¶

unknown

返回值¶

void

onFinish()?¶

optional onFinish: (state) => void

定义于： react/stream.tsx:458

流结束时调用的回调。

参数¶

state¶

ThreadState\<StateType>

返回值¶

void

onLangChainEvent()?¶

optional onLangChainEvent: (data) => void

定义于： react/stream.tsx:488

接收到 LangChain 事件时调用的回调。

参数¶

data¶

# data¶

unknown

# event¶

# metadata¶

Record\<string, unknown>

# name¶

string

# parent_ids¶

string[]

# run_id¶

string

# tags¶

string[]

返回值¶

void

参见¶

https://github.langchain.ac.cn/langgraph/cloud/how-tos/stream_events/#stream-graph-in-events-mode 了解更多详情。

onMetadataEvent()?¶

optional onMetadataEvent: (data) => void

定义于： react/stream.tsx:482

接收到元数据事件时调用的回调。

参数¶

data¶

# run_id¶

string

# thread_id¶

string

返回值¶

void

onThreadId()?¶

optional onThreadId: (threadId) => void

定义于： react/stream.tsx:504

线程 ID 更新时（即创建新线程时）调用的回调。

参数¶

threadId¶

string

返回值¶

void

onUpdateEvent()?¶

optional onUpdateEvent: (data) => void

定义于： react/stream.tsx:463

接收到更新事件时调用的回调。

参数¶

data¶

返回值¶

void

threadId?¶

optional threadId: null | string

定义于： react/stream.tsx:499

要从中获取历史记录和当前值的线程 ID。

@langchain/langgraph-sdk

@langchain/langgraph-sdk / MessageMetadata

类型别名： MessageMetadata\<StateType>¶

MessageMetadata\<StateType>: object

定义于： react/stream.tsx:169

类型参数¶

• StateType extends Record\<string, unknown>

类型声明¶

branch¶

branch: string | undefined

消息的分支。

branchOptions¶

branchOptions: string[] | undefined

此消息所属的分支列表。这对于显示分支控制很有用。

firstSeenState¶

firstSeenState: ThreadState\<StateType> | undefined

消息首次出现的线程状态。

messageId¶

messageId: string

使用的消息 ID。

Js ts SDK 参考

@langchain/langgraph-sdk¶

类¶

接口¶

函数¶

langchain/langgraph-sdk/auth¶

类¶

接口¶

类型别名¶

类：Auth\<TExtra, TAuthReturn, TUser\>¶

类型参数¶

构造函数¶

new Auth()¶

返回¶

方法¶

authenticate()¶

类型参数¶

参数¶

cb¶

返回¶

on()¶

类型参数¶

参数¶

event¶

callback¶

返回¶

类：HTTPException¶

继承¶

构造函数¶

new HTTPException()¶

参数¶

status¶

options?¶

# cause?¶

# headers?¶

# message?¶

返回¶

覆盖¶

属性¶

cause?¶

继承自¶

headers¶

message¶

继承自¶

name¶

继承自¶

stack?¶

继承自¶

status¶

prepareStackTrace()?¶

参数¶

err¶

stackTraces¶

返回¶

参考¶

继承自¶

stackTraceLimit¶

继承自¶

方法¶

captureStackTrace()¶

参数¶

targetObject¶

constructorOpt?¶

返回¶

继承自¶

接口：AuthEventValueMap¶

属性¶

assistants:create¶

assistant_id?¶

config?¶

graph_id¶

if_exists?¶

metadata?¶

name?¶

assistants:delete¶

assistant_id¶

assistants:read¶

assistant_id¶

metadata?¶

assistants:search¶

@langchain/langgraph-sdk ¶