Class AssistantsClient

Hierarchy

BaseClient
- AssistantsClient

Index

Constructors

constructor

new AssistantsClient(config?: ClientConfig): AssistantsClient
Parameters
- Optionalconfig: ClientConfig
Returns AssistantsClient
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

count

count(query?: { graphId?: string; metadata?: Metadata }): Promise<number>
Count assistants matching filters.
Parameters
- Optionalquery: { graphId?: string; metadata?: Metadata }
  - OptionalgraphId?: string
    Optional graph id to filter by.
  - Optionalmetadata?: Metadata
    Metadata to filter by. Exact match for each key/value.
Returns Promise<number>
Number of assistants matching the criteria.
- Defined in client.ts:637

create

create(
    payload: {
        assistantId?: string;
        config?: Config;
        context?: unknown;
        description?: string;
        graphId: string;
        ifExists?: OnConflictBehavior;
        metadata?: Metadata;
        name?: string;
    },
): Promise<Assistant>
Create a new assistant.
Parameters
- payload: {
      assistantId?: string;
      config?: Config;
      context?: unknown;
      description?: string;
      graphId: string;
      ifExists?: OnConflictBehavior;
      metadata?: Metadata;
      name?: string;
  }
  Payload for creating an assistant.
Returns Promise<Assistant>
The created assistant.
- Defined in client.ts:536

delete

delete(assistantId: string): Promise<void>
Delete an assistant.
Parameters
- assistantId: string
  ID of the assistant.
Returns Promise<void>
- Defined in client.ts:596

`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(assistantId: string): Promise<Assistant>
Get an assistant by ID.
Parameters
- assistantId: string
  The ID of the assistant.
Returns Promise<Assistant>
Assistant
- Defined in client.ts:478

getGraph

getGraph(
assistantId: string,
options?: { xray?: number | boolean },
): Promise<AssistantGraph>
Get the JSON representation of the graph assigned to a runnable
Parameters
- assistantId: string
  The ID of the assistant.
- Optionaloptions: { xray?: number | boolean }
  - Optionalxray?: number | boolean
    Whether to include subgraphs in the serialized graph representation. If an integer value is provided, only subgraphs with a depth less than or equal to the value will be included.
Returns Promise<AssistantGraph>
Serialized graph
- Defined in client.ts:488

getSchemas

getSchemas(assistantId: string): Promise<GraphSchema>
Get the state and config schema of the graph assigned to a runnable
Parameters
- assistantId: string
  The ID of the assistant.
Returns Promise<GraphSchema>
Graph schema
- Defined in client.ts:502

getSubgraphs

getSubgraphs(
assistantId: string,
options?: { namespace?: string; recurse?: boolean },
): Promise<Subgraphs>
Get the schemas of an assistant by ID.
Parameters
- assistantId: string
  The ID of the assistant to get the schema of.
- Optionaloptions: { namespace?: string; recurse?: boolean }
  Additional options for getting subgraphs, such as namespace or recursion extraction.
Returns Promise<Subgraphs>
The subgraphs of the assistant.
- Defined in client.ts:513

getVersions

getVersions(
assistantId: string,
payload?: { limit?: number; metadata?: Metadata; offset?: number },
): Promise<AssistantVersion[]>
List all versions of an assistant.
Parameters
- assistantId: string
  ID of the assistant.
- Optionalpayload: { limit?: number; metadata?: Metadata; offset?: number }
Returns Promise<AssistantVersion[]>
List of assistant versions.
- Defined in client.ts:656

`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(
    query?: {
        graphId?: string;
        limit?: number;
        metadata?: Metadata;
        offset?: number;
        select?: AssistantSelectField[];
        sortBy?: AssistantSortBy;
        sortOrder?: SortOrder;
    },
): Promise<Assistant[]>
List assistants.
Parameters
- Optionalquery: {
      graphId?: string;
      limit?: number;
      metadata?: Metadata;
      offset?: number;
      select?: AssistantSelectField[];
      sortBy?: AssistantSortBy;
      sortOrder?: SortOrder;
  }
  Query options.
Returns Promise<Assistant[]>
List of assistants.
- Defined in client.ts:607

setLatest

setLatest(assistantId: string, version: number): Promise<Assistant>
Change the version of an assistant.
Parameters
- assistantId: string
  ID of the assistant.
- version: number
  The version to change to.
Returns Promise<Assistant>
The updated assistant.
- Defined in client.ts:684

update

update(
    assistantId: string,
    payload: {
        config?: Config;
        context?: unknown;
        description?: string;
        graphId?: string;
        metadata?: Metadata;
        name?: string;
    },
): Promise<Assistant>
Update an assistant.
Parameters
- assistantId: string
  ID of the assistant.
- payload: {
      config?: Config;
      context?: unknown;
      description?: string;
      graphId?: string;
      metadata?: Metadata;
      name?: string;
  }
  Payload for updating the assistant.
Returns Promise<Assistant>
The updated assistant.
- Defined in client.ts:567

Class AssistantsClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AssistantsClient

Properties

ProtectedapiUrl

ProtectedasyncCaller

ProtecteddefaultHeaders

Protected OptionalonRequest

ProtectedtimeoutMs

Methods

count

Parameters

OptionalgraphId?: string

Optionalmetadata?: Metadata

Returns Promise<number>

create

Parameters

Returns Promise<Assistant>

delete

Parameters

Returns Promise<void>

Protectedfetch

Type Parameters

Parameters

Returns Promise<[T, Response]>

Type Parameters

Parameters

Returns Promise<T>

get

Parameters

Returns Promise<Assistant>

getGraph

Parameters

Optionalxray?: number | boolean

Returns Promise<AssistantGraph>

getSchemas

Parameters

Returns Promise<GraphSchema>

getSubgraphs

Parameters

Returns Promise<Subgraphs>

getVersions

Parameters

Returns Promise<AssistantVersion[]>

ProtectedprepareFetchOptions

Parameters

Returns [url: URL, init: RequestInit]

search

Parameters

Returns Promise<Assistant[]>

setLatest

Parameters

Returns Promise<Assistant>

update

Parameters

Returns Promise<Assistant>

Settings

On This Page

`Protected`apiUrl

`Protected`asyncCaller

`Protected`defaultHeaders

`Protected` `Optional`onRequest

`Protected`timeoutMs

`Optional`graphId?: string

`Optional`metadata?: Metadata

`Protected`fetch

`Optional`xray?: number | boolean

`Protected`prepareFetchOptions