Class ThreadsClient<TStateType, TUpdateType>

Type Parameters

TStateType = DefaultValues
TUpdateType = TStateType

Hierarchy

BaseClient
- ThreadsClient

Index

Constructors

constructor

new ThreadsClient<TStateType = DefaultValues, TUpdateType = TStateType>(
config?: ClientConfig,
): ThreadsClient<TStateType, TUpdateType>
Type Parameters
- TStateType = DefaultValues
- TUpdateType = TStateType
Parameters
- Optionalconfig: ClientConfig
Returns ThreadsClient<TStateType, TUpdateType>
Inherited from BaseClient.constructor
- Defined in client.ts:193

Properties

`Protected`apiUrl

apiUrl: string

`Protected`asyncCaller

asyncCaller: AsyncCaller

`Protected`defaultHeaders

defaultHeaders: Record<string, HeaderValue>

`Protected` `Optional`onRequest

onRequest?: RequestHook

`Protected`timeoutMs

timeoutMs: undefined | number

Methods

copy

copy(threadId: string): Promise<Thread<TStateType>>
Copy an existing thread
Parameters
- threadId: string
  ID of the thread to be copied
Returns Promise<Thread<TStateType>>
Newly copied thread
- Defined in client.ts:782

count

count<ValuesType = TStateType>(
    query?: {
        metadata?: Metadata;
        status?: ThreadStatus;
        values?: ValuesType;
    },
): Promise<number>
Count threads matching filters.
Type Parameters
- ValuesType = TStateType
Parameters
- Optionalquery: { metadata?: Metadata; status?: ThreadStatus; values?: ValuesType }
  - Optionalmetadata?: Metadata
    Thread metadata to filter on.
  - Optionalstatus?: ThreadStatus
    Thread status to filter on.
  - Optionalvalues?: ValuesType
    State values to filter on.
Returns Promise<number>
Number of threads matching the criteria.
- Defined in client.ts:894

create

create(
    payload?: {
        graphId?: string;
        ifExists?: OnConflictBehavior;
        metadata?: Metadata;
        supersteps?: {
            updates: { asNode: string; command?: Command; values: unknown }[];
        }[];
        threadId?: string;
        ttl?: number
        | { strategy?: "delete"; ttl: number };
    },
): Promise<Thread<TStateType>>
Create a new thread.
Parameters
- Optionalpayload: {
      graphId?: string;
      ifExists?: OnConflictBehavior;
      metadata?: Metadata;
      supersteps?: {
          updates: { asNode: string; command?: Command; values: unknown }[];
      }[];
      threadId?: string;
      ttl?: number
      | { strategy?: "delete"; ttl: number };
  }
  Payload for creating a thread.
  - OptionalgraphId?: string
    Graph ID to associate with the thread.
  - OptionalifExists?: OnConflictBehavior
    How to handle duplicate creation.
    
    Default
    "raise"
  - Optionalmetadata?: Metadata
    Metadata for the thread.
  - Optionalsupersteps?: { updates: { asNode: string; command?: Command; values: unknown }[] }[]
    Apply a list of supersteps when creating a thread, each containing a sequence of updates.
    
    Used for copying a thread between deployments.
  - OptionalthreadId?: string
    ID of the thread to create.
    
    If not provided, a random UUID will be generated.
  - Optionalttl?: number | { strategy?: "delete"; ttl: number }
    Optional time-to-live in minutes for the thread. If a number is provided, it is treated as minutes and defaults to strategy "delete". You may also provide an object { ttl: number, strategy?: "delete" }.
Returns Promise<Thread<TStateType>>
The created thread.
- Defined in client.ts:714

delete

delete(threadId: string): Promise<void>
Delete a thread.
Parameters
- threadId: string
  ID of the thread.
Returns Promise<void>
- Defined in client.ts:826

`Protected`fetch

fetch<T>(
    path: string,
    options: RequestInit & {
        json?: unknown;
        params?: Record<string, unknown>;
        signal?: AbortSignal;
        timeoutMs?: null | number;
        withResponse: true;
    },
): Promise<[T, Response]>
Type Parameters
- T
Parameters
- path: string
- options: RequestInit & {
      json?: unknown;
      params?: Record<string, unknown>;
      signal?: AbortSignal;
      timeoutMs?: null | number;
      withResponse: true;
  }
Returns Promise<[T, Response]>
Inherited from BaseClient.fetch
- Defined in client.ts:288
fetch<T>(
    path: string,
    options?: RequestInit & {
        json?: unknown;
        params?: Record<string, unknown>;
        signal?: AbortSignal;
        timeoutMs?: null | number;
        withResponse?: false;
    },
): Promise<T>
Type Parameters
- T
Parameters
- path: string
- Optionaloptions: RequestInit & {
      json?: unknown;
      params?: Record<string, unknown>;
      signal?: AbortSignal;
      timeoutMs?: null | number;
      withResponse?: false;
  }
Returns Promise<T>
Inherited from BaseClient.fetch
- Defined in client.ts:299

get

get<ValuesType = TStateType>(threadId: string): Promise<Thread<ValuesType>>
Get a thread by ID.
Type Parameters
- ValuesType = TStateType
Parameters
- threadId: string
  ID of the thread.
Returns Promise<Thread<ValuesType>>
The thread.
- Defined in client.ts:702

getHistory

getHistory<ValuesType = TStateType>(
    threadId: string,
    options?: {
        before?: Config;
        checkpoint?: Partial<Omit<Checkpoint, "thread_id">>;
        limit?: number;
        metadata?: Metadata;
    },
): Promise<ThreadState<ValuesType>[]>
Get all past states for a thread.
Type Parameters
- ValuesType = TStateType
Parameters
- threadId: string
  ID of the thread.
- Optionaloptions: {
      before?: Config;
      checkpoint?: Partial<Omit<Checkpoint, "thread_id">>;
      limit?: number;
      metadata?: Metadata;
  }
  Additional options.
Returns Promise<ThreadState<ValuesType>[]>
List of thread states.
- Defined in client.ts:1008

getState

getState<ValuesType = TStateType>(
    threadId: string,
    checkpoint?: string | Checkpoint,
    options?: { subgraphs?: boolean },
): Promise<ThreadState<ValuesType>>
Get state for a thread.
Type Parameters
- ValuesType = TStateType
Parameters
- threadId: string
  ID of the thread.
- Optionalcheckpoint: string | Checkpoint
- Optionaloptions: { subgraphs?: boolean }
Returns Promise<ThreadState<ValuesType>>
Thread state.
- Defined in client.ts:915

joinStream

joinStream(
    threadId: string,
    options?: {
        lastEventId?: string;
        streamMode?: ThreadStreamMode | ThreadStreamMode[];
    },
): AsyncGenerator<{ data: any; event: StreamEvent; id?: string }>
Parameters
- threadId: string
- Optionaloptions: { lastEventId?: string; streamMode?: ThreadStreamMode | ThreadStreamMode[] }
Returns AsyncGenerator<{ data: any; event: StreamEvent; id?: string }>
- Defined in client.ts:1031

patchState

patchState(threadIdOrConfig: string | Config, metadata: Metadata): Promise<void>
Patch the metadata of a thread.
Parameters
- threadIdOrConfig: string | Config
  Thread ID or config to patch the state of.
- metadata: Metadata
  Metadata to patch the state with.
Returns Promise<void>
- Defined in client.ts:978

`Protected`prepareFetchOptions

prepareFetchOptions(
    path: string,
    options?: RequestInit & {
        json?: unknown;
        params?: Record<string, unknown>;
        timeoutMs?: null | number;
        withResponse?: boolean;
    },
): [url: URL, init: RequestInit]
Parameters
- path: string
- Optionaloptions: RequestInit & {
      json?: unknown;
      params?: Record<string, unknown>;
      timeoutMs?: null | number;
      withResponse?: boolean;
  }
Returns [url: URL, init: RequestInit]
Inherited from BaseClient.prepareFetchOptions
- Defined in client.ts:233

search

search<ValuesType = TStateType>(
    query?: {
        ids?: string[];
        limit?: number;
        metadata?: Metadata;
        offset?: number;
        select?: ThreadSelectField[];
        sortBy?: ThreadSortBy;
        sortOrder?: SortOrder;
        status?: ThreadStatus;
    },
): Promise<Thread<ValuesType>[]>
List threads
Type Parameters
- ValuesType = TStateType
Parameters
- Optionalquery: {
      ids?: string[];
      limit?: number;
      metadata?: Metadata;
      offset?: number;
      select?: ThreadSelectField[];
      sortBy?: ThreadSortBy;
      sortOrder?: SortOrder;
      status?: ThreadStatus;
  }
  Query options
  - Optionalids?: string[]
    Filter by specific thread IDs.
  - Optionallimit?: number
    Maximum number of threads to return. Defaults to 10
  - Optionalmetadata?: Metadata
    Metadata to filter threads by.
  - Optionaloffset?: number
    Offset to start from.
  - Optionalselect?: ThreadSelectField[]
  - OptionalsortBy?: ThreadSortBy
    Sort by.
  - OptionalsortOrder?: SortOrder
    Sort order. Must be one of 'asc' or 'desc'.
  - Optionalstatus?: ThreadStatus
    Thread status to filter on.
Returns Promise<Thread<ValuesType>[]>
List of threads
- Defined in client.ts:838

update

update(
    threadId: string,
    payload?: {
        metadata?: Metadata;
        ttl?: number | { strategy?: "delete"; ttl: number };
    },
): Promise<Thread<DefaultValues>>
Update a thread.
Parameters
- threadId: string
  ID of the thread.
- Optionalpayload: { metadata?: Metadata; ttl?: number | { strategy?: "delete"; ttl: number } }
  Payload for updating the thread.
  - Optionalmetadata?: Metadata
    Metadata for the thread.
  - Optionalttl?: number | { strategy?: "delete"; ttl: number }
    Optional time-to-live in minutes for the thread. If a number is provided, it is treated as minutes and defaults to strategy "delete". You may also provide an object { ttl: number, strategy?: "delete" }.
Returns Promise<Thread<DefaultValues>>
The updated thread.
- Defined in client.ts:795

updateState

updateState<ValuesType = TUpdateType>(
    threadId: string,
    options: {
        asNode?: string;
        checkpoint?: Checkpoint;
        checkpointId?: string;
        values: ValuesType;
    },
): Promise<Pick<Config, "configurable">>
Add state to a thread.
Type Parameters
- ValuesType = TUpdateType
Parameters
- threadId: string
  The ID of the thread.
- options: {
      asNode?: string;
      checkpoint?: Checkpoint;
      checkpointId?: string;
      values: ValuesType;
  }
Returns Promise<Pick<Config, "configurable">>
- Defined in client.ts:949

Class ThreadsClient<TStateType, TUpdateType>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ThreadsClient<TStateType, TUpdateType>

Properties

ProtectedapiUrl

ProtectedasyncCaller

ProtecteddefaultHeaders

Protected OptionalonRequest

ProtectedtimeoutMs

Methods

copy

Parameters

Returns Promise<Thread<TStateType>>

count

Type Parameters

Parameters

Optionalmetadata?: Metadata

Optionalstatus?: ThreadStatus

Optionalvalues?: ValuesType

Returns Promise<number>

create

Parameters

OptionalgraphId?: string

OptionalifExists?: OnConflictBehavior

Default

Optionalmetadata?: Metadata

Optionalsupersteps?: { updates: { asNode: string; command?: Command; values: unknown }[] }[]

OptionalthreadId?: string

Optionalttl?: number | { strategy?: "delete"; ttl: number }

Returns Promise<Thread<TStateType>>

delete

Parameters

Returns Promise<void>

Protectedfetch

Type Parameters

Parameters

Returns Promise<[T, Response]>

Type Parameters

Parameters

Returns Promise<T>

get

Type Parameters

Parameters

Returns Promise<Thread<ValuesType>>

getHistory

Type Parameters

Parameters

Returns Promise<ThreadState<ValuesType>[]>

getState

Type Parameters

Parameters

Returns Promise<ThreadState<ValuesType>>

joinStream

Parameters

Returns AsyncGenerator<{ data: any; event: StreamEvent; id?: string }>

patchState

Parameters

Returns Promise<void>

ProtectedprepareFetchOptions

Parameters

Returns [url: URL, init: RequestInit]

search

Type Parameters

Parameters

Optionalids?: string[]

Optionallimit?: number

Optionalmetadata?: Metadata

Optionaloffset?: number

Optionalselect?: ThreadSelectField[]

OptionalsortBy?: ThreadSortBy

OptionalsortOrder?: SortOrder

`Protected`apiUrl

`Protected`asyncCaller

`Protected`defaultHeaders

`Protected` `Optional`onRequest

`Protected`timeoutMs

`Optional`metadata?: Metadata

`Optional`status?: ThreadStatus

`Optional`values?: ValuesType

`Optional`graphId?: string

`Optional`ifExists?: OnConflictBehavior

`Optional`metadata?: Metadata

`Optional`supersteps?: { updates: { asNode: string; command?: Command; values: unknown }[] }[]

`Optional`threadId?: string

`Optional`ttl?: number | { strategy?: "delete"; ttl: number }

`Protected`fetch

`Protected`prepareFetchOptions

`Optional`ids?: string[]

`Optional`limit?: number

`Optional`metadata?: Metadata

`Optional`offset?: number

`Optional`select?: ThreadSelectField[]

`Optional`sortBy?: ThreadSortBy

`Optional`sortOrder?: SortOrder

`Optional`status?: ThreadStatus

`Optional`metadata?: Metadata

`Optional`ttl?: number | { strategy?: "delete"; ttl: number }