Class AssistantsClient

Hierarchy

  • BaseClient
    • AssistantsClient

Constructors

constructor

Properties

apiUrl asyncCaller defaultHeaders onRequest? timeoutMs

Methods

create delete fetch get getGraph getSchemas getSubgraphs getVersions prepareFetchOptions search setLatest update

Constructors

constructor

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

create

  • create(payload): Promise<Assistant>

  • Create a new assistant.

    Parameters

    • payload: {
          assistantId?: string;
          config?: Config;
          description?: string;
          graphId: string;
          ifExists?: OnConflictBehavior;
          metadata?: Metadata;
          name?: string;
      }

      Payload for creating an assistant.

      • Optional assistantId?: string
      • Optional config?: Config
      • Optional description?: string
      • graphId: string
      • Optional ifExists?: OnConflictBehavior
      • Optional metadata?: Metadata
      • Optional name?: string

    Returns Promise<Assistant>

    The created assistant.

delete

  • delete(assistantId): Promise<void>

  • Delete an assistant.

    Parameters

    • assistantId: string

      ID of the assistant.

    Returns Promise<void>

Protected fetch

  • fetch<T>(path, options): 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]>

  • fetch<T>(path, options?): Promise<T>

  • Type Parameters

    • T

    Parameters

    • path: string
    • Optional options: RequestInit & {
          json?: unknown;
          params?: Record<string, unknown>;
          signal?: AbortSignal;
          timeoutMs?: null | number;
          withResponse?: false;
      }

    Returns Promise<T>

get

  • get(assistantId): Promise<Assistant>

  • Get an assistant by ID.

    Parameters

    • assistantId: string

      The ID of the assistant.

    Returns Promise<Assistant>

    Assistant

getGraph

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

  • Get the JSON representation of the graph assigned to a runnable

    Parameters

    • assistantId: string

      The ID of the assistant.

    • Optional options: {
          xray?: number | boolean;
      }
      • Optional xray?: 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

getSchemas

  • getSchemas(assistantId): 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

getSubgraphs

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

  • Get the schemas of an assistant by ID.

    Parameters

    • assistantId: string

      The ID of the assistant to get the schema of.

    • Optional options: {
          namespace?: string;
          recurse?: boolean;
      }

      Additional options for getting subgraphs, such as namespace or recursion extraction.

      • Optional namespace?: string
      • Optional recurse?: boolean

    Returns Promise<Subgraphs>

    The subgraphs of the assistant.

getVersions

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

  • List all versions of an assistant.

    Parameters

    • assistantId: string

      ID of the assistant.

    • Optional payload: {
          limit?: number;
          metadata?: Metadata;
          offset?: number;
      }
      • Optional limit?: number
      • Optional metadata?: Metadata
      • Optional offset?: number

    Returns Promise<AssistantVersion[]>

    List of assistant versions.

Protected prepareFetchOptions

  • prepareFetchOptions(path, options?): [url: URL, init: RequestInit]

  • Parameters

    • path: string
    • Optional options: RequestInit & {
          json?: unknown;
          params?: Record<string, unknown>;
          timeoutMs?: null | number;
          withResponse?: boolean;
      }

    Returns [url: URL, init: RequestInit]

search

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

  • List assistants.

    Parameters

    • Optional query: {
          graphId?: string;
          limit?: number;
          metadata?: Metadata;
          offset?: number;
          sortBy?: AssistantSortBy;
          sortOrder?: SortOrder;
      }

      Query options.

      • Optional graphId?: string
      • Optional limit?: number
      • Optional metadata?: Metadata
      • Optional offset?: number
      • Optional sortBy?: AssistantSortBy
      • Optional sortOrder?: SortOrder

    Returns Promise<Assistant[]>

    List of assistants.

setLatest

  • setLatest(assistantId, version): 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.

update

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

  • Update an assistant.

    Parameters

    • assistantId: string

      ID of the assistant.

    • payload: {
          config?: Config;
          description?: string;
          graphId?: string;
          metadata?: Metadata;
          name?: string;
      }

      Payload for updating the assistant.

      • Optional config?: Config
      • Optional description?: string
      • Optional graphId?: string
      • Optional metadata?: Metadata
      • Optional name?: string

    Returns Promise<Assistant>

    The updated assistant.

Settings

Member Visibility

Theme

On This Page

constructorapiUrlasyncCallerdefaultHeadersonRequesttimeoutMscreatedeletefetchgetgetGraphgetSchemasgetSubgraphsgetVersionsprepareFetchOptionssearchsetLatestupdate