类 AssistantsClient

继承关系

  • BaseClient
    • AssistantsClient

构造函数

构造函数

属性

apiUrl asyncCaller defaultHeaders onRequest? timeoutMs

方法

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

构造函数

构造函数

属性

受保护 apiUrl

apiUrl: string

受保护 asyncCaller

asyncCaller: AsyncCaller

受保护 defaultHeadersdefaultHeaders

defaultHeaders: Record<string, HeaderValue>

受保护的 可选的 onRequest

onRequest?: RequestHook

受保护 timeoutMs

timeoutMs: undefined | number

方法

创建

  • create(payload): Promise<Assistant>

  • 创建一个新助手。

    参数

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

      用于创建助手的载荷。

      • 可选的 assistantId?: string
      • 可选的 config?: Config
      • 可选 description?: string
      • graphId: string
      • 可选的 ifExists?: OnConflictBehavior
      • 可选的 metadata?: Metadata
      • 可选 name?: string

    返回 Promise<Assistant>

    创建的助手。

删除

  • delete(assistantId): Promise<void>

  • 删除助手。

    参数

    • assistantId: string

      助手的ID。

    返回 Promise<void>

受保护 获取

  • fetch<T>(path, options): Promise<[T, Response]>

  • 类型参数

    • T

    参数

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

    返回 Promise<[T, Response]>

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

  • 类型参数

    • T

    参数

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

    返回 Promise<T>

获取

  • get(assistantId): Promise<Assistant>

  • 通过 ID 获取助手。

    参数

    • assistantId: string

      助手的 ID。

    返回 Promise<Assistant>

    Assistant

getGraph

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

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

    参数

    • assistantId: string

      助手的 ID。

    • 可选 options: {
          xray?: number | boolean;
      }
      • 可选的 xray?: number | boolean

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

    返回 Promise<AssistantGraph>

    序列化的图

getSchemas

  • getSchemas(assistantId): Promise<GraphSchema>

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

    参数

    • assistantId: string

      助手的 ID。

    返回 Promise<GraphSchema>

    图模式

getSubgraphs

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

  • 通过 ID 获取助手的 schema。

    参数

    • assistantId: string

      要获取其 schema 的助手的 ID。

    • 可选 options: {
          namespace?: string;
          recurse?: boolean;
      }

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

      • 可选的 namespace?: string
      • 可选的 recurse?: boolean

    返回 Promise<Subgraphs>

    助手的子图。

getVersions

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

  • 列出助手的全部版本。

    参数

    • assistantId: string

      助手的ID。

    • 可选的 payload: {
          limit?: number;
          metadata?: Metadata;
          offset?: number;
      }
      • 可选 limit?: number
      • 可选的 metadata?: Metadata
      • 可选 offset?: number

    返回 Promise<AssistantVersion[]>

    助手版本列表。

受保护的 prepareFetchOptions

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

  • 参数

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

    返回 [url: URL, init: RequestInit]

search

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

  • 列出助手。

    参数

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

      查询选项。

      • 可选的 graphId?: string
      • 可选 limit?: number
      • 可选的 metadata?: Metadata
      • 可选 offset?: number
      • 可选的 sortBy?: AssistantSortBy
      • 可选的 sortOrder?: SortOrder

    返回 Promise<Assistant[]>

    助手列表。

setLatest

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

  • 更改助手的版本。

    参数

    • assistantId: string

      助手的ID。

    • version: number

      要更改为的版本。

    返回 Promise<Assistant>

    更新后的助手。

update

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

  • 更新助手。

    参数

    • assistantId: string

      助手的ID。

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

      用于更新助手的载荷。

      • 可选的 config?: Config
      • 可选 description?: string
      • 可选的 graphId?: string
      • 可选的 metadata?: Metadata
      • 可选 name?: string

    返回 Promise<Assistant>

    更新后的助手。

设置

成员可见性

主题

本页内容

constructorapiUrlasyncCallerdefaultHeadersonRequesttimeoutMscreatedeletefetchgetgetGraphgetSchemasgetSubgraphsgetVersionsprepareFetchOptionssearchsetLatestupdate