Merge pull request #475 from openai/release-please--branches--master-…

…-changes--next--components--openai

release: 4.17.1

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.17.0"
+  ".": "4.17.1"
 }

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 4.17.1 (2023-11-09)
+
+Full Changelog: [v4.17.0...v4.17.1](https://github.com/openai/openai-node/compare/v4.17.0...v4.17.1)
+
+### Refactors
+
+* **client:** deprecate files.retrieveContent in favour of files.content ([#474](https://github.com/openai/openai-node/issues/474)) ([7c7bfc2](https://github.com/openai/openai-node/commit/7c7bfc2fad5a786c9172110e90c9566a943e49f9))
+
 ## 4.17.0 (2023-11-08)
 
 Full Changelog: [v4.16.2...v4.17.0](https://github.com/openai/openai-node/compare/v4.16.2...v4.17.0)

README.md

@@ -21,7 +21,7 @@ You can import in Deno via:
 <!-- x-release-please-start-version -->
 
 ```ts
-import OpenAI from 'https://deno.land/x/[email protected].0/mod.ts';
+import OpenAI from 'https://deno.land/x/[email protected].1/mod.ts';
 ```
 
 <!-- x-release-please-end -->

api.md

@@ -82,6 +82,7 @@ Methods:
 - <code title="get /files/{file_id}">client.files.<a href="./src/resources/files.ts">retrieve</a>(fileId) -> FileObject</code>
 - <code title="get /files">client.files.<a href="./src/resources/files.ts">list</a>({ ...params }) -> FileObjectsPage</code>
 - <code title="delete /files/{file_id}">client.files.<a href="./src/resources/files.ts">del</a>(fileId) -> FileDeleted</code>
+- <code title="get /files/{file_id}/content">client.files.<a href="./src/resources/files.ts">content</a>(fileId) -> Response</code>
 - <code title="get /files/{file_id}/content">client.files.<a href="./src/resources/files.ts">retrieveContent</a>(fileId) -> string</code>
 - <code>client.files.<a href="./src/resources/files.ts">waitForProcessing</a>(id, { pollInterval = 5000, maxWait = 30 _ 60 _ 1000 }) -> Promise&lt;FileObject&gt;</code>
 

build-deno

@@ -15,7 +15,7 @@ This is a build produced from https://github.com/openai/openai-node – please g
 Usage:
 
 \`\`\`ts
-import OpenAI from "$(echo 'https://deno.land/x/openai@v4.16.2/mod.ts' | sed -E s/@\.+\\//@"$PACKAGE_VERSION"\\//)";
+import OpenAI from "$(echo 'https://deno.land/x/openai@v4.17.0/mod.ts' | sed -E s/@\.+\\//@"$PACKAGE_VERSION"\\//)";
 
 const client = new OpenAI();
 \`\`\`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.17.0",
+  "version": "4.17.1",
   "description": "Client library for the OpenAI API",
   "author": "OpenAI <[email protected]>",
   "types": "dist/index.d.ts",

src/resources/files.ts

@@ -3,6 +3,7 @@
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
 import { isRequestOptions } from 'openai/core';
+import { type Response } from 'openai/_shims/index';
 import { sleep } from 'openai/core';
 import { APIConnectionTimeoutError } from 'openai/error';
 import * as FilesAPI from 'openai/resources/files';
@@ -58,6 +59,15 @@ export class Files extends APIResource {
   /**
    * Returns the contents of the specified file.
    */
+  content(fileId: string, options?: Core.RequestOptions): Core.APIPromise<Response> {
+    return this.get(`/files/${fileId}/content`, { ...options, __binaryResponse: true });
+  }
+
+  /**
+   * Returns the contents of the specified file.
+   *
+   * @deprecated The `.content()` method should be used instead
+   */
   retrieveContent(fileId: string, options?: Core.RequestOptions): Core.APIPromise<string> {
     return this.get(`/files/${fileId}/content`, {
       ...options,

src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.17.0'; // x-release-please-version
+export const VERSION = '4.17.1'; // x-release-please-version

tests/api-resources/files.test.ts

@@ -91,6 +91,13 @@ describe('resource files', () => {
     );
   });
 
+  test('content: request options instead of 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(openai.files.content('string', { path: '/_stainless_unknown_path' })).rejects.toThrow(
+      OpenAI.NotFoundError,
+    );
+  });
+
   test('retrieveContent', async () => {
     const responsePromise = openai.files.retrieveContent('string');
     const rawResponse = await responsePromise.asResponse();