feat(api): adding support for /v1/conversations to the API

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 111
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-7ef7a457c3bf05364e66e48c9ca34f31bfef1f6c9b7c15b1812346105e0abb16.yml
-openapi_spec_hash: a2b1f5d8fbb62175c93b0ebea9f10063
-config_hash: 4870312b04f48fd717ea4151053e7fb9
+configured_endpoints: 119
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-4bcdfe525558e67a09b32dec7a573e87b94bab47db3951eb4a86a4dafb60296c.yml
+openapi_spec_hash: 49e7e46bfe9f61b7b7a60e36840c0cd7
+config_hash: e4514526ae01126a61f9b6c14a351737

MIGRATION.md

@@ -73,6 +73,8 @@ client.parents.children.retrieve('c_456', { parent_id: 'p_123' });
 - `client.beta.threads.messages.retrieve()`
 - `client.beta.threads.messages.update()`
 - `client.beta.threads.messages.delete()`
+- `client.conversations.items.retrieve()`
+- `client.conversations.items.delete()`
 - `client.evals.runs.retrieve()`
 - `client.evals.runs.delete()`
 - `client.evals.runs.cancel()`
@@ -111,7 +113,9 @@ client.example.list(undefined, { headers: { ... } });
 + client.example.list({}, { headers: { ... } });
 ```
 
-This affects the following methods:
+<details>
+
+<summary>This affects the following methods</summary>
 
 - `client.chat.completions.list()`
 - `client.chat.completions.messages.list()`
@@ -129,6 +133,7 @@ This affects the following methods:
 - `client.batches.list()`
 - `client.responses.retrieve()`
 - `client.responses.inputItems.list()`
+- `client.conversations.items.list()`
 - `client.evals.list()`
 - `client.evals.runs.list()`
 - `client.containers.list()`

api.md

@@ -670,6 +670,7 @@ Types:
 - <code><a href="./src/resources/responses/responses.ts">ResponseContent</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseContentPartAddedEvent</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseContentPartDoneEvent</a></code>
+- <code><a href="./src/resources/responses/responses.ts">ResponseConversationParam</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseCreatedEvent</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseCustomToolCall</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseCustomToolCallInputDeltaEvent</a></code>
@@ -769,6 +770,49 @@ Methods:
 
 - <code title="get /responses/{response_id}/input_items">client.responses.inputItems.<a href="./src/resources/responses/input-items.ts">list</a>(responseID, { ...params }) -> ResponseItemsPage</code>
 
+# Conversations
+
+Types:
+
+- <code><a href="./src/resources/conversations/conversations.ts">ComputerScreenshotContent</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">ContainerFileCitationBody</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">Conversation</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">ConversationDeleted</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">ConversationDeletedResource</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">FileCitationBody</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">InputFileContent</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">InputImageContent</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">InputTextContent</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">LobProb</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">Message</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">OutputTextContent</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">RefusalContent</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">SummaryTextContent</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">TextContent</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">TopLogProb</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">URLCitationBody</a></code>
+
+Methods:
+
+- <code title="post /conversations">client.conversations.<a href="./src/resources/conversations/conversations.ts">create</a>({ ...params }) -> Conversation</code>
+- <code title="get /conversations/{conversation_id}">client.conversations.<a href="./src/resources/conversations/conversations.ts">retrieve</a>(conversationID) -> Conversation</code>
+- <code title="post /conversations/{conversation_id}">client.conversations.<a href="./src/resources/conversations/conversations.ts">update</a>(conversationID, { ...params }) -> Conversation</code>
+- <code title="delete /conversations/{conversation_id}">client.conversations.<a href="./src/resources/conversations/conversations.ts">delete</a>(conversationID) -> ConversationDeletedResource</code>
+
+## Items
+
+Types:
+
+- <code><a href="./src/resources/conversations/items.ts">ConversationItem</a></code>
+- <code><a href="./src/resources/conversations/items.ts">ConversationItemList</a></code>
+
+Methods:
+
+- <code title="post /conversations/{conversation_id}/items">client.conversations.items.<a href="./src/resources/conversations/items.ts">create</a>(conversationID, { ...params }) -> ConversationItemList</code>
+- <code title="get /conversations/{conversation_id}/items/{item_id}">client.conversations.items.<a href="./src/resources/conversations/items.ts">retrieve</a>(itemID, { ...params }) -> ConversationItem</code>
+- <code title="get /conversations/{conversation_id}/items">client.conversations.items.<a href="./src/resources/conversations/items.ts">list</a>(conversationID, { ...params }) -> ConversationItemsPage</code>
+- <code title="delete /conversations/{conversation_id}/items/{item_id}">client.conversations.items.<a href="./src/resources/conversations/items.ts">delete</a>(itemID, { ...params }) -> Conversation</code>
+
 # Evals
 
 Types:

scripts/detect-breaking-changes

@@ -44,6 +44,8 @@ TEST_PATHS=(
 	tests/api-resources/uploads/parts.test.ts
 	tests/api-resources/responses/responses.test.ts
 	tests/api-resources/responses/input-items.test.ts
+	tests/api-resources/conversations/conversations.test.ts
+	tests/api-resources/conversations/items.test.ts
 	tests/api-resources/evals/evals.test.ts
 	tests/api-resources/evals/runs/runs.test.ts
 	tests/api-resources/evals/runs/output-items.test.ts

src/client.ts

@@ -15,7 +15,14 @@ import * as qs from './internal/qs';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Pagination from './core/pagination';
-import { AbstractPage, type CursorPageParams, CursorPageResponse, PageResponse } from './core/pagination';
+import {
+  AbstractPage,
+  type ConversationCursorPageParams,
+  ConversationCursorPageResponse,
+  type CursorPageParams,
+  CursorPageResponse,
+  PageResponse,
+} from './core/pagination';
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
@@ -97,6 +104,7 @@ import {
   ContainerRetrieveResponse,
   Containers,
 } from './resources/containers/containers';
+import { Conversations } from './resources/conversations/conversations';
 import {
   EvalCreateParams,
   EvalCreateResponse,
@@ -954,6 +962,7 @@ export class OpenAI {
   batches: API.Batches = new API.Batches(this);
   uploads: API.Uploads = new API.Uploads(this);
   responses: API.Responses = new API.Responses(this);
+  conversations: API.Conversations = new API.Conversations(this);
   evals: API.Evals = new API.Evals(this);
   containers: API.Containers = new API.Containers(this);
 }
@@ -974,6 +983,7 @@ OpenAI.Beta = Beta;
 OpenAI.Batches = Batches;
 OpenAI.Uploads = UploadsAPIUploads;
 OpenAI.Responses = Responses;
+OpenAI.Conversations = Conversations;
 OpenAI.Evals = Evals;
 OpenAI.Containers = Containers;
 
@@ -986,6 +996,12 @@ export declare namespace OpenAI {
   export import CursorPage = Pagination.CursorPage;
   export { type CursorPageParams as CursorPageParams, type CursorPageResponse as CursorPageResponse };
 
+  export import ConversationCursorPage = Pagination.ConversationCursorPage;
+  export {
+    type ConversationCursorPageParams as ConversationCursorPageParams,
+    type ConversationCursorPageResponse as ConversationCursorPageResponse,
+  };
+
   export {
     Completions as Completions,
     type Completion as Completion,
@@ -1149,6 +1165,8 @@ export declare namespace OpenAI {
 
   export { Responses as Responses };
 
+  export { Conversations as Conversations };
+
   export {
     Evals as Evals,
     type EvalCustomDataSourceConfig as EvalCustomDataSourceConfig,

src/core/pagination.ts

@@ -202,3 +202,68 @@ export class CursorPage<Item extends { id: string }>
     };
   }
 }
+
+export interface ConversationCursorPageResponse<Item> {
+  data: Array<Item>;
+
+  has_more: boolean;
+
+  last_id: string;
+}
+
+export interface ConversationCursorPageParams {
+  after?: string;
+
+  limit?: number;
+}
+
+export class ConversationCursorPage<Item>
+  extends AbstractPage<Item>
+  implements ConversationCursorPageResponse<Item>
+{
+  data: Array<Item>;
+
+  has_more: boolean;
+
+  last_id: string;
+
+  constructor(
+    client: OpenAI,
+    response: Response,
+    body: ConversationCursorPageResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.data = body.data || [];
+    this.has_more = body.has_more || false;
+    this.last_id = body.last_id || '';
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.data ?? [];
+  }
+
+  override hasNextPage(): boolean {
+    if (this.has_more === false) {
+      return false;
+    }
+
+    return super.hasNextPage();
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const cursor = this.last_id;
+    if (!cursor) {
+      return null;
+    }
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        after: cursor,
+      },
+    };
+  }
+}

src/resources/conversations.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './conversations/index';