跳到内容

SDK (JS/TS)

@langchain/langgraph-sdk


@langchain/langgraph-sdk

接口

函数

langchain/langgraph-sdk


langchain/langgraph-sdk/auth

接口

类型别名

@langchain/langgraph-sdk


@langchain/langgraph-sdk / Auth

类:Auth\<TExtra, TAuthReturn, TUser\>

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

类型参数

TExtra = {}

TAuthReturn 继承自 BaseAuthReturn = BaseAuthReturn

TUser 继承自 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 继承自 BaseAuthReturn

参数
cb

AuthenticateCallback\<T\>

返回值

Auth\<TExtra, T\>


on()

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

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

类型参数

T 继承自 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 继承自 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

获取分配给 runnable 的图的 JSON 表示

参数
assistantId

string

助手的ID。

options?
# xray?

number | boolean

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

返回

Promise\<AssistantGraph>

序列化的图


getSchemas()

getSchemas(assistantId): Promise\<GraphSchema>

定义于: client.ts:325

获取分配给 runnable 的图的状态和配置模式

参数
assistantId

string

助手的ID。

返回

Promise\<GraphSchema>

图模式


getSubgraphs()

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

定义于: client.ts:336

按ID获取助手的模式。

参数
assistantId

string

要获取模式的助手的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(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: 控制从流接收哪些类型的事件(可以是单一模式或模式数组) 必须是创建运行时传递的流模式的子集。后台运行默认为启用所有流模式的联合。

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 继承自 StreamMode | StreamMode[] = StreamMode

TSubgraphs 继承自 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 继承自 StreamMode | StreamMode[] = StreamMode

TSubgraphs 继承自 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 表示不设置过期时间。

返回

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?

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

接口

类型别名

函数

@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

string & object | "on_tool_start" | "on_tool_stream" | "on_tool_end" | "on_chat_model_start" | "on_chat_model_stream" | "on_chat_model_end" | "on_llm_start" | "on_llm_stream" | "on_llm_end" | "on_chain_start" | "on_chain_stream" | "on_chain_end" | "on_retriever_start" | "on_retriever_stream" | "on_retriever_end" | "on_prompt_start" | "on_prompt_stream" | "on_prompt_end"

# 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。

评论