Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(deps): update dependency openai to v4.73.1 #216

Merged
merged 1 commit into from
Dec 2, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 27, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
openai 4.72.0 -> 4.73.1 age adoption passing confidence

Release Notes

openai/openai-node (openai)

v4.73.1

Compare Source

Full Changelog: v4.73.0...v4.73.1

Documentation
  • readme: mention .withResponse() for streaming request ID (#​1202) (b6800d4)

v4.73.0

Compare Source

Full Changelog: v4.72.0...v4.73.0

Features
  • api: add gpt-4o-2024-11-20 model (#​1201) (0feeafd)
  • bump model in all example snippets to gpt-4o (6961c37)
Bug Fixes
Chores
Documentation

Configuration

📅 Schedule: Branch creation - "* 0-4 * * 3" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Copy link

bedrock debug - [puLL-Merge] - openai/[email protected]

Here's my review of the pull request:

Description

This PR updates the OpenAI Node.js library from version 4.72.0 to 4.73.0. It includes several changes to the API, documentation updates, and internal improvements.

Changes

Changes

  1. Version Update:

    • Updated version from 4.72.0 to 4.73.0 in multiple files.
  2. README.md:

    • Changed title to "OpenAI TypeScript and JavaScript API Library".
    • Updated installation instructions, including JSR (JavaScript Registry) support.
    • Updated code examples to use the 'gpt-4o' model instead of 'gpt-3.5-turbo' or 'gpt-4'.
    • Added information about JSR usage.
  3. API Changes:

    • Added new model 'gpt-4o-2024-11-20' in chat.ts.
    • Updated voice options in ChatCompletionAudioParam.
    • Increased maximum file size for Batch API from 100 MB to 200 MB.
  4. Documentation:

    • Updated CHANGELOG.md with details of the new release.
    • Improved JSR documentation.
  5. Internal Changes:

    • Removed unused devDependency 'ts-morph'.
    • Updated spec URL in .stats.yml.
    • Simplified import/export statements in index.ts.
  6. Test Updates:

    • Updated various test files to reflect API changes and simplify test cases.
sequenceDiagram
    participant User
    participant Library
    participant OpenAI_API

    User->>Library: Import OpenAI
    Library->>User: Provide updated API interface
    User->>Library: Create client with API key
    Library->>OpenAI_API: Authenticate
    User->>Library: Make API call (e.g., chat completion)
    Library->>OpenAI_API: Send request with updated model (gpt-4o)
    OpenAI_API->>Library: Return response
    Library->>User: Provide formatted response
Loading
graph TD
    A[OpenAI Node.js Library] --> B[Version Update]
    A --> C[API Changes]
    A --> D[Documentation Updates]
    A --> E[Internal Improvements]
    C --> F[New Model: gpt-4o-2024-11-20]
    C --> G[Updated Voice Options]
    C --> H[Increased Batch API File Size]
    D --> I[README Updates]
    D --> J[CHANGELOG Update]
    D --> K[JSR Documentation]
    E --> L[Dependency Cleanup]
    E --> M[Code Refactoring]
Loading

Possible Issues

  • The change from 'gpt-3.5-turbo' to 'gpt-4o' in examples might lead to increased costs for users who copy-paste the code without noticing the model change.

Security Hotspots

None identified.

Copy link

anthropic debug - [puLL-Merge] - openai/[email protected]

Description

This PR updates the OpenAI Node.js library from version 4.72.0 to 4.73.0. It includes several feature additions, bug fixes, and documentation improvements.

Changes

Changes

  1. package.json and related files:

    • Version bump to 4.73.0
    • Removed unused devDependency ts-morph
  2. README.md:

    • Updated title to "OpenAI TypeScript and JavaScript API Library"
    • Added installation instructions for JSR
    • Updated model references from gpt-3.5-turbo to gpt-4o
    • Improved documentation for various features and usage examples
  3. src/index.ts:

    • Refactored exports to use named exports instead of destructuring
  4. src/resources/chat/chat.ts:

    • Added new model gpt-4o-2024-11-20
  5. src/resources/chat/completions.ts:

    • Updated documentation for voice options in ChatCompletionAudioParam
  6. src/resources/files.ts:

    • Updated file size limit for Batch API from 100 MB to 200 MB
  7. src/resources/batches.ts:

    • Updated file size limit for input_file_id from 100 MB to 200 MB
  8. Various test files:

    • Updated test cases to reflect API changes and new model versions
sequenceDiagram
    participant Client
    participant OpenAI
    participant Chat
    participant Completions
    participant Files

    Client->>OpenAI: Create client
    Client->>Chat: Create chat completion
    Chat-->>OpenAI: Use gpt-4o model
    OpenAI-->>Client: Return chat completion
    Client->>Completions: Stream completion
    Completions-->>OpenAI: Use gpt-4o model
    OpenAI-->>Client: Stream response
    Client->>Files: Upload file
    Files-->>OpenAI: Handle up to 200MB file
    OpenAI-->>Client: Confirm upload
Loading
graph TD
    A[OpenAI Client] --> B[Chat]
    A --> C[Completions]
    A --> D[Embeddings]
    A --> E[Files]
    A --> F[Images]
    A --> G[Audio]
    A --> H[Moderations]
    A --> I[Models]
    A --> J[FineTuning]
    A --> K[Beta]
    A --> L[Batches]
    A --> M[Uploads]
Loading

Possible Issues

  • Changing the default model in examples from gpt-3.5-turbo to gpt-4o might lead to increased API costs for users who copy-paste the examples without modification.

Security Hotspots

No significant security issues were identified in this update.

Copy link

openai debug - [puLL-Merge] - openai/[email protected]

Description

This pull request updates the OpenAI Node API library from version 4.72.0 to 4.73.0. The changes include enhancements, bug fixes, and updates to both code and documentation. The major additions include the introduction of the gpt-4o-2024-11-20 model, improvements in the file batch size limit, and several documentation enhancements and corrections.

Possible Issues

  • Removal of ts-morph Dependency: The ts-morph library has been removed from devDependencies in package.json. If this library was being used elsewhere or is required in the future, issues may arise unless adequately tested.

Security Hotspots

None identified.

Changes

Changes

  • .release-please-manifest.json:

    • Updated version from 4.72.0 to 4.73.0.
  • .stats.yml:

    • Updated the OpenAPI specification URL.
  • CHANGELOG.md:

    • Added details for version 4.73.0.
  • README.md:

    • Updated title to "OpenAI TypeScript and JavaScript API Library".
    • Better documented the installation process and usage examples.
    • Changed model in examples to gpt-4o.
  • jsr.json:

    • Updated version from 4.72.0 to 4.73.0.
  • package.json:

    • Updated version from 4.72.0 to 4.73.0.
    • Removed ts-morph from devDependencies.
  • scripts/build:

    • Typographical correction in a comment.
  • src/index.ts:

    • Adjusted export positions for error and upload handling.
  • src/resources/batches.ts:

    • Increased the maximum allowed size for .jsonl files from 100 MB to 200 MB.
  • src/resources/chat/chat.ts:

    • Added gpt-4o-2024-11-20 model to the list of chat models.
  • tests/api-resources/various.test.ts:

    • Reduced redundancy by minimizing arrays of repetitive elements to a single element across multiple test files, thus streamlining the test cases.

This pull request comprehensively updates the library with both functionality improvements and documentation enhancements. The reduced redundancy in the test cases should improve maintainability and test performance. Ensure thorough testing, especially for any dependencies that were removed or modified.

sequenceDiagram
    participant Developer
    participant GitHubRepo
    participant CI System

    Developer->>GitHubRepo: Push changes (includes new model, updated specs, doc fixes)
    GitHubRepo->>CI System: Trigger CI pipeline
    CI System->>GitHubRepo: Fetch new changes
    CI System->>CI System: Run Tests and Build
    CI System-->>GitHubRepo: Update build status (pass/fail)
    GitHubRepo-->>Developer: Notify build result
Loading
C4Diagram
boundary(openai_node_lib) {
    component(versioning) {
        component(.release-please-manifest.json)
        component(jsr.json)
        component(package.json)
    }
    component(documentation) {
        component(README.md)
        component(CHANGELOG.md)
    }
    component(scripts) {
        component(scripts/build)
    }
    component(src) {
        component(index.ts)
        component(resources) {
            component(batches.ts)
            component(chat)
        }
    }
    component(tests) {
        component(api-resources) {
            component(audio/transcriptions.test.ts)
            component(beta/assistants.test.ts)
            component(beta/threads/messages.test.ts)
            component(beta/threads/runs/runs.test.ts)
            component(beta/threads/threads.test.ts)
            component(chat/completions.test.ts)
            component(fine-tuning/jobs/jobs.test.ts)
            component(uploads/uploads.test.ts)
        }
    }
}

Rel(documentation, versioning, "Mentions version updates")
Rel(documentation, src, "References usage examples and changes")
Rel(tests, src, "Tests the functionalities of sources")
Loading

@renovate renovate bot changed the title fix(deps): update dependency openai to v4.73.0 fix(deps): update dependency openai to v4.73.1 Nov 29, 2024
@renovate renovate bot force-pushed the renovate/openai-4.x-lockfile branch from bbf9da8 to a2cdd40 Compare November 29, 2024 19:12
@renovate renovate bot force-pushed the renovate/openai-4.x-lockfile branch from a2cdd40 to 709192f Compare December 1, 2024 06:20
Copy link

github-actions bot commented Dec 1, 2024

anthropic debug - [puLL-Merge] - openai/[email protected]

Description

This PR updates the OpenAI Node.js library from version 4.72.0 to 4.73.1. It includes various changes to the codebase, including updates to the API, documentation improvements, and minor bug fixes.

Changes

Changes

  1. Version Update:

    • Updated version from 4.72.0 to 4.73.1 in multiple files.
  2. README.md:

    • Updated title to "OpenAI TypeScript and JavaScript API Library".
    • Added information about installation from JSR (JavaScript Runtime).
    • Updated model references from 'gpt-3.5-turbo' to 'gpt-4o' in examples.
    • Added information about accessing Request ID using .withResponse() method.
    • Updated supported runtime information.
  3. CHANGELOG.md:

    • Added entries for versions 4.73.1 and 4.73.0.
  4. API Updates:

    • Added new model 'gpt-4o-2024-11-20' to ChatModel type.
    • Updated voice description in ChatCompletionAudioParam.
    • Increased max file size for Batch API from 100 MB to 200 MB.
  5. Code Refactoring:

    • Removed destructuring in favor of re-exports in index.ts.
    • Simplified some test cases by reducing redundant examples.
  6. Dependencies:

    • Removed 'ts-morph' from devDependencies.
  7. Documentation:

    • Various improvements and corrections in inline comments and examples.
  8. Test Updates:

    • Modified several test cases to use simplified data structures.
sequenceDiagram
    participant User
    participant OpenAI
    participant API
    User->>OpenAI: Import OpenAI from 'openai'
    User->>OpenAI: Create client with API key
    User->>OpenAI: Make API call (e.g., chat.completions.create)
    OpenAI->>API: Send request to OpenAI API
    API->>OpenAI: Return response
    OpenAI->>User: Return processed response
    Note over User,OpenAI: New: Access Request ID using .withResponse()
Loading

Possible Issues

  • The change from 'gpt-3.5-turbo' to 'gpt-4o' in examples might lead to increased costs for users who copy-paste the examples without noticing the model change.

Security Hotspots

No significant security issues were identified in this change.

Copy link

github-actions bot commented Dec 1, 2024

openai debug - [puLL-Merge] - openai/[email protected]

Description

This PR updates the OpenAI Node library to version 4.73.1. The main changes include:

  1. Bumping the version number across various configuration files.
  2. Updating documentation to reflect new features and changes.
  3. Adjusting code examples to use the newer gpt-4o model.
  4. Refactoring code to remove redundant or duplicate entries, particularly in tests.
  5. Increasing the file size limit for certain API endpoints from 100 MB to 200 MB.
Changes

Changes

  • .release-please-manifest.json, jsr.json, package.json, src/version.ts

    • Version bumped from 4.72.0 to 4.73.1
  • .stats.yml

    • Updated openapi_spec_url to new specification: openai-aa9b01fc0c17eb0cbc200533fc20d6a49c5e764ceaf8049e08b294532be6e9ff.yml
  • CHANGELOG.md

    • Added entries for version 4.73.1 including features, bug fixes, and documentation updates.
  • README.md

    • Changed library title to "OpenAI TypeScript and JavaScript API Library."
    • Updated installation instructions from JSR.
    • Updated example code snippets to use the gpt-4o model.
    • Added details on accessing request ID using .withResponse() method.
  • scripts/build

    • Minor comment fix.
  • src/index.ts

    • Moved export statements for errors and utilities to the end of the file for better organization.
  • src/resources/batches.ts, src/resources/files.ts

    • Increased max file size for batch API from 100 MB to 200 MB.
  • src/resources/chat/chat.ts, src/resources/chat/completions.ts

    • Added support for gpt-4o-2024-11-20 model.
    • Updated supported voices to reflect recommended types only.
  • Test Files (tests/api-resources/)

    • Simplified test cases by removing redundant entries in arrays.
sequenceDiagram
    participant User
    participant README.md
    participant API
    participant TestFiles
    
    User->>README.md: Update usage instructions
    User->>API: Bump version and add features
    User->>TestFiles: Simplify and update tests
    API->>README.md: Reflect new model and methods
    README.md->>API: Ensure doc accuracy
    TestFiles->>API: Validate features
Loading

Possible Issues

Security Hotspots

Overall, this PR looks solid with improvements in documentation, code examples, and internal configurations. The changes made are well-scoped and maintain backward compatibility. No significant security risks were identified.

Copy link

github-actions bot commented Dec 1, 2024

bedrock debug - [puLL-Merge] - openai/[email protected]

Description

This PR updates the OpenAI Node.js library from version 4.72.0 to 4.73.1. It includes various changes to the API, documentation updates, and internal improvements.

Changes

Changes

  1. package.json and jsr.json:

    • Version bump from 4.72.0 to 4.73.1
    • Removed ts-morph from devDependencies
  2. CHANGELOG.md:

    • Added entries for versions 4.73.1 and 4.73.0
    • New features, bug fixes, and documentation updates
  3. README.md:

    • Updated title to "OpenAI TypeScript and JavaScript API Library"
    • Added instructions for JSR installation
    • Updated example code to use gpt-4o model
    • Various documentation improvements and corrections
  4. src/index.ts:

    • Refactored exports to use named exports instead of destructuring
  5. src/resources/chat/chat.ts:

    • Added new model gpt-4o-2024-11-20
  6. src/resources/chat/completions.ts:

    • Updated voice description for chat completion audio params
  7. src/resources/files.ts:

    • Updated file size limit for Batch API from 100 MB to 200 MB
  8. Various test files:

    • Updated test cases to reflect API changes and simplify test data
sequenceDiagram
    participant Dev as Developer
    participant NPM as NPM Registry
    participant Lib as OpenAI Library
    participant API as OpenAI API

    Dev->>NPM: Update to [email protected]
    NPM-->>Dev: Deliver updated package
    Dev->>Lib: Import OpenAI
    Lib->>API: Use updated models (e.g., gpt-4o-2024-11-20)
    API-->>Lib: Respond with new capabilities
    Lib-->>Dev: Provide updated functionality
Loading

Possible Issues

  • The removal of ts-morph from devDependencies might affect some development scripts or tools that were using it.

Security Hotspots

No significant security issues were identified in this change.

@thypon thypon merged commit fa5b81d into main Dec 2, 2024
8 checks passed
@thypon thypon deleted the renovate/openai-4.x-lockfile branch December 2, 2024 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant