@tambo-ai/typescript-sdk 0.80.0 → 0.83.0

package/src/resources/threads/runs.ts

@@ -0,0 +1,354 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as RunsAPI from './runs';
+import * as ThreadsAPI from './threads';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Runs extends APIResource {
+  /**
+   * Creates a new thread and immediately starts a streaming run. Returns an SSE
+   * stream of AG-UI events.
+   *
+   * @example
+   * ```ts
+   * await client.threads.runs.create({
+   *   message: {
+   *     content: [{ text: 'Hello, world!', type: 'text' }],
+   *     role: 'user',
+   *   },
+   * });
+   * ```
+   */
+  create(body: RunCreateParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/v1/threads/runs', {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Explicitly cancel a running run. Note: closing the SSE connection also cancels
+   * the run.
+   *
+   * @example
+   * ```ts
+   * const run = await client.threads.runs.delete(
+   *   'run_xyz789abc',
+   *   { threadId: 'thr_abc123xyz' },
+   * );
+   * ```
+   */
+  delete(runID: string, params: RunDeleteParams, options?: RequestOptions): APIPromise<RunDeleteResponse> {
+    const { threadId } = params;
+    return this._client.delete(path`/v1/threads/${threadId}/runs/${runID}`, options);
+  }
+
+  /**
+   * Starts a streaming run on an existing thread. Returns an SSE stream of AG-UI
+   * events.
+   *
+   * @example
+   * ```ts
+   * await client.threads.runs.run('thr_abc123xyz', {
+   *   message: {
+   *     content: [{ text: 'Hello, world!', type: 'text' }],
+   *     role: 'user',
+   *   },
+   * });
+   * ```
+   */
+  run(threadID: string, body: RunRunParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/v1/threads/${threadID}/runs`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface InputMessage {
+  /**
+   * Content blocks (text, resource, or tool_result)
+   */
+  content: Array<ThreadsAPI.TextContent | ThreadsAPI.ResourceContent | ThreadsAPI.ToolResultContent>;
+
+  /**
+   * Message role - must be 'user' for input messages
+   */
+  role: 'user';
+
+  /**
+   * Additional metadata to attach to the message
+   */
+  metadata?: unknown;
+}
+
+export interface RunDeleteResponse {
+  /**
+   * The run ID that was cancelled
+   */
+  runId: string;
+
+  /**
+   * New status after cancellation (always 'cancelled')
+   */
+  status: 'cancelled';
+}
+
+export interface RunCreateParams {
+  /**
+   * The user's message
+   */
+  message: InputMessage;
+
+  /**
+   * Available UI components the model can render
+   */
+  availableComponents?: Array<RunCreateParams.AvailableComponent>;
+
+  /**
+   * Maximum tokens to generate
+   */
+  maxTokens?: number;
+
+  /**
+   * Override the default model
+   */
+  model?: string;
+
+  /**
+   * ID of the previous run. Required when continuing a thread that already has
+   * messages.
+   */
+  previousRunId?: string;
+
+  /**
+   * Metadata for the run
+   */
+  runMetadata?: unknown;
+
+  /**
+   * Temperature for generation (0-2)
+   */
+  temperature?: number;
+
+  /**
+   * Thread configuration
+   */
+  thread?: RunCreateParams.Thread;
+
+  /**
+   * Metadata for the thread
+   */
+  threadMetadata?: unknown;
+
+  /**
+   * How the model should use tools
+   */
+  toolChoice?: 'auto' | 'required' | 'none' | RunCreateParams.Name;
+
+  /**
+   * Client-side tools the model can call
+   */
+  tools?: Array<RunCreateParams.Tool>;
+}
+
+export namespace RunCreateParams {
+  export interface AvailableComponent {
+    /**
+     * Description of what this component displays
+     */
+    description: string;
+
+    /**
+     * Component name (e.g., 'StockChart')
+     */
+    name: string;
+
+    /**
+     * JSON Schema for component props
+     */
+    propsSchema: unknown;
+
+    /**
+     * Optional JSON Schema for component state
+     */
+    stateSchema?: unknown;
+  }
+
+  /**
+   * Thread configuration
+   */
+  export interface Thread {
+    /**
+     * Optional context key for thread organization
+     */
+    contextKey?: string;
+
+    /**
+     * Initial messages to seed the thread with
+     */
+    initialMessages?: Array<RunsAPI.InputMessage>;
+
+    /**
+     * Additional metadata to attach to the thread
+     */
+    metadata?: unknown;
+  }
+
+  export interface Name {
+    name?: string;
+  }
+
+  export interface Tool {
+    /**
+     * Description of what the tool does
+     */
+    description: string;
+
+    /**
+     * JSON Schema for the tool's input parameters
+     */
+    inputSchema: unknown;
+
+    /**
+     * Unique tool name (a-z, A-Z, 0-9, \_, -)
+     */
+    name: string;
+
+    /**
+     * Optional JSON Schema for structured output
+     */
+    outputSchema?: unknown;
+
+    /**
+     * Enable strict schema validation (OpenAI feature)
+     */
+    strict?: boolean;
+  }
+}
+
+export interface RunDeleteParams {
+  /**
+   * Thread ID
+   */
+  threadId: string;
+}
+
+export interface RunRunParams {
+  /**
+   * The user's message
+   */
+  message: InputMessage;
+
+  /**
+   * Available UI components the model can render
+   */
+  availableComponents?: Array<RunRunParams.AvailableComponent>;
+
+  /**
+   * Maximum tokens to generate
+   */
+  maxTokens?: number;
+
+  /**
+   * Override the default model
+   */
+  model?: string;
+
+  /**
+   * ID of the previous run. Required when continuing a thread that already has
+   * messages.
+   */
+  previousRunId?: string;
+
+  /**
+   * Metadata for the run
+   */
+  runMetadata?: unknown;
+
+  /**
+   * Temperature for generation (0-2)
+   */
+  temperature?: number;
+
+  /**
+   * How the model should use tools
+   */
+  toolChoice?: 'auto' | 'required' | 'none' | RunRunParams.Name;
+
+  /**
+   * Client-side tools the model can call
+   */
+  tools?: Array<RunRunParams.Tool>;
+}
+
+export namespace RunRunParams {
+  export interface AvailableComponent {
+    /**
+     * Description of what this component displays
+     */
+    description: string;
+
+    /**
+     * Component name (e.g., 'StockChart')
+     */
+    name: string;
+
+    /**
+     * JSON Schema for component props
+     */
+    propsSchema: unknown;
+
+    /**
+     * Optional JSON Schema for component state
+     */
+    stateSchema?: unknown;
+  }
+
+  export interface Name {
+    name?: string;
+  }
+
+  export interface Tool {
+    /**
+     * Description of what the tool does
+     */
+    description: string;
+
+    /**
+     * JSON Schema for the tool's input parameters
+     */
+    inputSchema: unknown;
+
+    /**
+     * Unique tool name (a-z, A-Z, 0-9, \_, -)
+     */
+    name: string;
+
+    /**
+     * Optional JSON Schema for structured output
+     */
+    outputSchema?: unknown;
+
+    /**
+     * Enable strict schema validation (OpenAI feature)
+     */
+    strict?: boolean;
+  }
+}
+
+export declare namespace Runs {
+  export {
+    type InputMessage as InputMessage,
+    type RunDeleteResponse as RunDeleteResponse,
+    type RunCreateParams as RunCreateParams,
+    type RunDeleteParams as RunDeleteParams,
+    type RunRunParams as RunRunParams,
+  };
+}