openai 7.13.0 → 7.15.0

package/src/resources/beta/agents/sessions/artifacts.ts

@@ -0,0 +1,239 @@
+// File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import { APIPromise } from '../../../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../../../core/pagination';
+import { buildHeaders } from '../../../../internal/headers';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+export class Artifacts extends APIResource {
+  /**
+   * Retrieves immutable metadata for one durable session artifact. See
+   * [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
+   *
+   * @example
+   * ```ts
+   * const sessionArtifact =
+   *   await client.beta.agents.sessions.artifacts.retrieve(
+   *     'artifact_id',
+   *     { session_id: 'session_id' },
+   *   );
+   * ```
+   */
+  retrieve(
+    artifactID: string,
+    params: ArtifactRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<SessionArtifact> {
+    const { session_id } = params;
+    return this._client.get(path`/agents/sessions/${session_id}/artifacts/${artifactID}`, {
+      ...options,
+      headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
+      __security: { bearerAuth: true },
+    });
+  }
+
+  /**
+   * Lists immutable artifacts published by completed hosted session turns. See
+   * [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const sessionArtifact of client.beta.agents.sessions.artifacts.list(
+   *   'session_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    sessionID: string,
+    query: ArtifactListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SessionArtifactsPage, SessionArtifact> {
+    return this._client.getAPIList(
+      path`/agents/sessions/${sessionID}/artifacts`,
+      CursorPage<SessionArtifact>,
+      {
+        query,
+        ...options,
+        headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
+        __security: { bearerAuth: true },
+      },
+    );
+  }
+
+  /**
+   * Deletes an immutable session artifact without deleting its live environment file
+   * or original Files API object. See
+   * [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
+   *
+   * @example
+   * ```ts
+   * const sessionArtifactDeleted =
+   *   await client.beta.agents.sessions.artifacts.delete(
+   *     'artifact_id',
+   *     { session_id: 'session_id' },
+   *   );
+   * ```
+   */
+  delete(
+    artifactID: string,
+    params: ArtifactDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<SessionArtifactDeleted> {
+    const { session_id } = params;
+    return this._client.delete(path`/agents/sessions/${session_id}/artifacts/${artifactID}`, {
+      ...options,
+      headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
+      __security: { bearerAuth: true },
+    });
+  }
+
+  /**
+   * Downloads immutable session artifact bytes after the execution environment
+   * expires. See
+   * [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.beta.agents.sessions.artifacts.content(
+   *     'artifact_id',
+   *     { session_id: 'session_id' },
+   *   );
+   *
+   * const content = await response.blob();
+   * console.log(content);
+   * ```
+   */
+  content(artifactID: string, params: ArtifactContentParams, options?: RequestOptions): APIPromise<Response> {
+    const { session_id } = params;
+    return this._client.get(path`/agents/sessions/${session_id}/artifacts/${artifactID}/content`, {
+      ...options,
+      headers: buildHeaders([
+        { 'OpenAI-Beta': 'agents=v1', Accept: 'application/octet-stream' },
+        options?.headers,
+      ]),
+      __security: { bearerAuth: true },
+      __binaryResponse: true,
+    });
+  }
+}
+
+export type SessionArtifactsPage = CursorPage<SessionArtifact>;
+
+/**
+ * An immutable file published by a completed hosted session turn.
+ */
+export interface SessionArtifact {
+  /**
+   * The immutable artifact ID.
+   */
+  id: string;
+
+  /**
+   * The Unix timestamp, in seconds, when the artifact was published.
+   */
+  created_at: number;
+
+  /**
+   * The ID of the environment that produced the artifact.
+   */
+  environment_id: string;
+
+  /**
+   * The object type. Always `agent.session.artifact`.
+   */
+  object: 'agent.session.artifact';
+
+  /**
+   * The original absolute file path in the execution environment.
+   */
+  path: string;
+
+  /**
+   * The ID of the session that owns the artifact.
+   */
+  session_id: string;
+
+  /**
+   * The immutable artifact size in bytes.
+   */
+  size_bytes: number;
+
+  /**
+   * The ID of the completed turn that published the artifact.
+   */
+  turn_id: string;
+}
+
+/**
+ * Confirmation that an immutable session artifact was deleted.
+ */
+export interface SessionArtifactDeleted {
+  /**
+   * The ID of the deleted session artifact.
+   */
+  id: string;
+
+  /**
+   * Whether the session artifact was deleted. Always `true`.
+   */
+  deleted: boolean;
+
+  /**
+   * The object type. Always `agent.session.artifact.deleted`.
+   */
+  object: 'agent.session.artifact.deleted';
+}
+
+export interface ArtifactRetrieveParams {
+  /**
+   * The ID of the session that owns the artifact.
+   */
+  session_id: string;
+}
+
+export interface ArtifactListParams extends CursorPageParams {
+  /**
+   * Restrict the listing to artifacts produced by this environment.
+   */
+  environment_id?: string | null;
+
+  /**
+   * Sort by creation time and ID. Defaults to descending.
+   *
+   * - `asc` - Returns resources in ascending order.
+   * - `desc` - Returns resources in descending order.
+   */
+  order?: 'asc' | 'desc';
+}
+
+export interface ArtifactDeleteParams {
+  /**
+   * The ID of the session that owns the artifact.
+   */
+  session_id: string;
+}
+
+export interface ArtifactContentParams {
+  /**
+   * The ID of the session that owns the artifact.
+   */
+  session_id: string;
+}
+
+export declare namespace Artifacts {
+  export {
+    type SessionArtifact as SessionArtifact,
+    type SessionArtifactDeleted as SessionArtifactDeleted,
+    type SessionArtifactsPage as SessionArtifactsPage,
+    type ArtifactRetrieveParams as ArtifactRetrieveParams,
+    type ArtifactListParams as ArtifactListParams,
+    type ArtifactDeleteParams as ArtifactDeleteParams,
+    type ArtifactContentParams as ArtifactContentParams,
+  };
+}

package/src/resources/beta/agents/sessions/events.ts

@@ -0,0 +1,91 @@
+// File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as AgentsAPI from '../agents';
+import { APIPromise } from '../../../../core/api-promise';
+import { Stream } from '../../../../core/streaming';
+import { buildHeaders } from '../../../../internal/headers';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+export class Events extends APIResource {
+  /**
+   * Submits message, cancellation, or tool-result events to a managed agent session.
+   * See
+   * [session events](https://developers.openai.com/api/docs/guides/agents-api/sessions/events).
+   *
+   * @example
+   * ```ts
+   * await client.beta.agents.sessions.events.create(
+   *   'session_id',
+   *   {
+   *     events: [
+   *       {
+   *         input: [
+   *           {
+   *             content: [{ text: 'text', type: 'input_text' }],
+   *             role: 'user',
+   *           },
+   *         ],
+   *         type: 'agent.session.input.message',
+   *       },
+   *     ],
+   *   },
+   * );
+   * ```
+   */
+  create(sessionID: string, params: EventCreateParams, options?: RequestOptions): APIPromise<void> {
+    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    return this._client.post(path`/agents/sessions/${sessionID}/events`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          'OpenAI-Beta': 'agents=v1',
+          Accept: '*/*',
+          ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+        },
+        options?.headers,
+      ]),
+      __security: { bearerAuth: true },
+    });
+  }
+
+  /**
+   * Streams live events for an agent session. See
+   * [session events](https://developers.openai.com/api/docs/guides/agents-api/sessions/events).
+   *
+   * @example
+   * ```ts
+   * const agentSessionEvent =
+   *   await client.beta.agents.sessions.events.stream(
+   *     'session_id',
+   *   );
+   * ```
+   */
+  stream(sessionID: string, options?: RequestOptions): APIPromise<Stream<AgentsAPI.AgentSessionEvent>> {
+    return this._client.get(path`/agents/sessions/${sessionID}/events`, {
+      ...options,
+      headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1', Accept: 'text/event-stream' }, options?.headers]),
+      stream: true,
+      __security: { bearerAuth: true },
+    }) as APIPromise<Stream<AgentsAPI.AgentSessionEvent>>;
+  }
+}
+
+export interface EventCreateParams {
+  /**
+   * Body param: The input events to submit to the session.
+   */
+  events: Array<AgentsAPI.AgentSessionInputParam>;
+
+  /**
+   * Header param: An optional client-generated key that makes retries of submitted
+   * messages idempotent.
+   */
+  'Idempotency-Key'?: string;
+}
+
+export declare namespace Events {
+  export { type EventCreateParams as EventCreateParams };
+}

package/src/resources/beta/agents/sessions/index.ts

@@ -0,0 +1,24 @@
+// File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
+
+export {
+  Artifacts,
+  type SessionArtifact,
+  type SessionArtifactDeleted,
+  type ArtifactRetrieveParams,
+  type ArtifactListParams,
+  type ArtifactDeleteParams,
+  type ArtifactContentParams,
+  type SessionArtifactsPage,
+} from './artifacts';
+export { Events, type EventCreateParams } from './events';
+export { Items, type ItemListParams } from './items';
+export {
+  Sessions,
+  type SessionCreateParams,
+  type SessionCreateParamsNonStreaming,
+  type SessionCreateParamsStreaming,
+  type SessionUpdateParams,
+  type SessionListParams,
+} from './sessions';
+export { Subagents, type SubagentRetrieveParams, type SubagentListParams } from './subagents/index';
+export { Turns, type Turn, type TurnRetrieveParams, type TurnListParams, type TurnsPage } from './turns';

package/src/resources/beta/agents/sessions/items.ts

@@ -0,0 +1,59 @@
+// File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as AgentsAPI from '../agents';
+import { AgentSessionItemsPage } from '../agents';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../../../core/pagination';
+import { buildHeaders } from '../../../../internal/headers';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+export class Items extends APIResource {
+  /**
+   * Lists items produced by the session's root agent, including its interactions
+   * with subagents. Each subagent has its own item history. See
+   * [inspecting agent output](https://developers.openai.com/api/docs/guides/agents-api/observability).
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const agentSessionItem of client.beta.agents.sessions.items.list(
+   *   'session_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    sessionID: string,
+    query: ItemListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AgentSessionItemsPage, AgentsAPI.AgentSessionItem> {
+    return this._client.getAPIList(
+      path`/agents/sessions/${sessionID}/items`,
+      CursorPage<AgentsAPI.AgentSessionItem>,
+      {
+        query,
+        ...options,
+        headers: buildHeaders([{ 'OpenAI-Beta': 'agents=v1' }, options?.headers]),
+        __security: { bearerAuth: true },
+      },
+    );
+  }
+}
+
+export interface ItemListParams extends CursorPageParams {
+  /**
+   * The order in which resources are returned. Defaults to `desc`.
+   *
+   * - `asc` - Returns resources in ascending order.
+   * - `desc` - Returns resources in descending order.
+   */
+  order?: 'asc' | 'desc';
+}
+
+export declare namespace Items {
+  export { type ItemListParams as ItemListParams };
+}
+
+export { type AgentSessionItemsPage };