chore(api): openapi updates for conversations

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 118
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-65d42621b731238ad4e59a35a705fc0608b17f53a14d047e66ce480c793da26b.yml
-openapi_spec_hash: d7ca86b2507600cbd5ed197cf31263c2
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-937fcfac8cbab692796cd9822b37e48a311e2220a8b103106ded0ee92a0b9484.yml
+openapi_spec_hash: 74a0c58b5b8c4e06792d79b685e02a01
 config_hash: 666d6bb4b564f0d9d431124b5d1a0665

MIGRATION.md

@@ -133,6 +133,7 @@ client.example.list(undefined, { headers: { ... } });
 - `client.batches.list()`
 - `client.responses.retrieve()`
 - `client.responses.inputItems.list()`
+- `client.conversations.create()`
 - `client.conversations.items.list()`
 - `client.evals.list()`
 - `client.evals.runs.list()`

src/resources/conversations/conversations.ts

@@ -24,19 +24,22 @@ export class Conversations extends APIResource {
   /**
    * Create a conversation.
    */
-  create(body: ConversationCreateParams, options?: RequestOptions): APIPromise<Conversation> {
+  create(
+    body: ConversationCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Conversation> {
     return this._client.post('/conversations', { body, ...options });
   }
 
   /**
-   * Get a conversation with the given ID.
+   * Get a conversation
    */
   retrieve(conversationID: string, options?: RequestOptions): APIPromise<Conversation> {
     return this._client.get(path`/conversations/${conversationID}`, options);
   }
 
   /**
-   * Update a conversation's metadata with the given ID.
+   * Update a conversation
    */
   update(
     conversationID: string,
@@ -47,7 +50,7 @@ export class Conversations extends APIResource {
   }
 
   /**
-   * Delete a conversation with the given ID.
+   * Delete a conversation. Items in the conversation will not be deleted.
    */
   delete(conversationID: string, options?: RequestOptions): APIPromise<ConversationDeletedResource> {
     return this._client.delete(path`/conversations/${conversationID}`, options);
@@ -233,11 +236,12 @@ export interface ConversationUpdateParams {
   /**
    * Set of 16 key-value pairs that can be attached to an object. This can be useful
    * for storing additional information about the object in a structured format, and
-   * querying for objects via API or the dashboard. Keys are strings with a maximum
-   * length of 64 characters. Values are strings with a maximum length of 512
-   * characters.
+   * querying for objects via API or the dashboard.
+   *
+   * Keys are strings with a maximum length of 64 characters. Values are strings with
+   * a maximum length of 512 characters.
    */
-  metadata: { [key: string]: string };
+  metadata: Shared.Metadata | null;
 }
 
 Conversations.Items = Items;

tests/api-resources/conversations/conversations.test.ts

@@ -9,7 +9,7 @@ const client = new OpenAI({
 
 describe('resource conversations', () => {
   test('create', async () => {
-    const responsePromise = client.conversations.create({});
+    const responsePromise = client.conversations.create();
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
     const response = await responsePromise;
@@ -19,6 +19,16 @@ describe('resource conversations', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
+  test('create: request options and params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      client.conversations.create(
+        { items: [{ content: 'string', role: 'user', type: 'message' }], metadata: { foo: 'string' } },
+        { path: '/_stainless_unknown_path' },
+      ),
+    ).rejects.toThrow(OpenAI.NotFoundError);
+  });
+
   test('retrieve', async () => {
     const responsePromise = client.conversations.retrieve('conv_123');
     const rawResponse = await responsePromise.asResponse();