Skip to content

Incomplete typescript types - 'AzureOpenAI' object #1644

@brandonpham13

Description

@brandonpham13

Confirm this is a Node library issue and not an underlying OpenAI API issue

  • This is an issue with the Node library

Describe the bug

Our security system detected undocumented properties and methods for the provided TS object structure of the AzureOpenAI type (which is an extension of the OpenAI type). What exists in development is different than what exists at runtime. Discovered errors in 72 of the properties. These properties are expected to be documented properly within the SDK, should be properly typed out in the Typescript metadata.

List of type issues

  • OpenAIObject.logger.log
  • OpenAIObject.logger.dir
  • OpenAIObject.logger.time
  • OpenAIObject.logger.timeEnd
  • OpenAIObject.logger.timeLog
  • OpenAIObject.logger.trace
  • OpenAIObject.logger.assert
  • OpenAIObject.logger.clear
  • OpenAIObject.logger.count
  • OpenAIObject.logger.countReset
  • OpenAIObject.logger.group
  • OpenAIObject.logger.groupEnd
  • OpenAIObject.logger.table
  • OpenAIObject.logger.dirxml
  • OpenAIObject.logger.groupCollapsed
  • OpenAIObject.logger.Console
  • OpenAIObject.logger.profile
  • OpenAIObject.logger.profileEnd
  • OpenAIObject.logger.timeStamp
  • OpenAIObject.logger.context
  • OpenAIObject.logger.createTask
  • OpenAIObject.completions._client
  • OpenAIObject.chat.completions.messages._client
  • OpenAIObject.chat.completions._client
  • OpenAIObject.chat._client
  • OpenAIObject.embeddings._client
  • OpenAIObject.files._client
  • OpenAIObject.images._client
  • OpenAIObject.audio.transcriptions._client
  • OpenAIObject.audio.translations._client
  • OpenAIObject.audio.speech._client
  • OpenAIObject.audio._client
  • OpenAIObject.moderations._client
  • OpenAIObject.models._client
  • OpenAIObject.fineTuning.methods._client
  • OpenAIObject.fineTuning.jobs.checkpoints._client
  • OpenAIObject.fineTuning.jobs._client
  • OpenAIObject.fineTuning.checkpoints.permissions_client
  • OpenAIObject.fineTuning.checkpoints._client
  • OpenAIObject.fineTuning.alpha.graders._client
  • OpenAIObject.fineTuning.alpha._client
  • OpenAIObject.fineTuning.jobs._client
  • OpenAIObject.fineTuning._client
  • OpenAIObject.graders.graderModels._client
  • OpenAIObject.graders._client
  • OpenAIObject.vectorStores.files._client
  • OpenAIObject.vectorStores.fileBatches._client
  • OpenAIObject.vectorStores._client
  • OpenAIObject.beta.realtime.sessions._client
  • OpenAIObject.beta.realtime.transcriptionSessions._client
  • OpenAIObject.beta.realtime._client
  • OpenAIObject.beta.assistants._client
  • OpenAIObject.beta.threads.runs.steps._client
  • OpenAIObject.beta.threads.runs._client
  • OpenAIObject.beta.threads.messages._client
  • OpenAIObject.beta.threads._client
  • OpenAIObject.beta._client
  • OpenAIObject.batches._client
  • OpenAIObject.uploads.parts._client
  • OpenAIObject.uploads._client
  • OpenAIObject.responses.inputItems._client
  • OpenAIObject.responses._client
  • OpenAIObject.conversations.items._client
  • OpenAIObject.conversations._client
  • OpenAIObject.evals.runs.outputItems._client
  • OpenAIObject.evals.runs._client
  • OpenAIObject.evals._client
  • OpenAIObject.containers.files.content._client
  • OpenAIObject.containers._client
  • OpenAIObject.fetch
  • OpenAIObject._options
  • OpenAIObject._azureADTokenProvider

To Reproduce

  1. Add breakpoint where AzureOpenAI object is defined
  2. Compare debugger value against type definition
  3. Observe that the type definition does not match against actual object props

*Can use Typia's validateEquals method to automate comparison/validation of types

Code snippets

OS

Windows

Node version

Node v22.19.0

Library version

v5.20.1

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions