# @langchain/openai

> JavaScript/TypeScript package

📖 [View in docs](https://reference.langchain.com/javascript/langchain-openai)

## Classes

- [`AzureChatOpenAI`](https://reference.langchain.com/javascript/langchain-openai/AzureChatOpenAI)
- [`AzureChatOpenAICompletions`](https://reference.langchain.com/javascript/langchain-openai/AzureChatOpenAICompletions)
- [`AzureChatOpenAIResponses`](https://reference.langchain.com/javascript/langchain-openai/AzureChatOpenAIResponses)
- [`AzureOpenAI`](https://reference.langchain.com/javascript/langchain-openai/AzureOpenAI)
- [`AzureOpenAIEmbeddings`](https://reference.langchain.com/javascript/langchain-openai/AzureOpenAIEmbeddings)
- [`ChatOpenAI`](https://reference.langchain.com/javascript/langchain-openai/ChatOpenAI)
- [`DallEAPIWrapper`](https://reference.langchain.com/javascript/langchain-openai/DallEAPIWrapper)
- [`OpenAI`](https://reference.langchain.com/javascript/langchain-openai/OpenAI)
- [`OpenAIEmbeddings`](https://reference.langchain.com/javascript/langchain-openai/OpenAIEmbeddings)

## Functions

- [`convertOpenAICompletionsStream()`](https://reference.langchain.com/javascript/langchain-openai/convertOpenAICompletionsStream)
- [`convertOpenAIResponsesStream()`](https://reference.langchain.com/javascript/langchain-openai/convertOpenAIResponsesStream)
- [`convertPromptToOpenAI()`](https://reference.langchain.com/javascript/langchain-openai/convertPromptToOpenAI)
- [`customTool()`](https://reference.langchain.com/javascript/langchain-openai/customTool)
- [`getEndpoint()`](https://reference.langchain.com/javascript/langchain-openai/getEndpoint)
- [`getFormattedEnv()`](https://reference.langchain.com/javascript/langchain-openai/getFormattedEnv)
- [`getHeadersWithUserAgent()`](https://reference.langchain.com/javascript/langchain-openai/getHeadersWithUserAgent)
- [`isHeaders()`](https://reference.langchain.com/javascript/langchain-openai/isHeaders)
- [`messageToOpenAIRole()`](https://reference.langchain.com/javascript/langchain-openai/messageToOpenAIRole)
- [`normalizeHeaders()`](https://reference.langchain.com/javascript/langchain-openai/normalizeHeaders)
- [`wrapOpenAIClientError()`](https://reference.langchain.com/javascript/langchain-openai/wrapOpenAIClientError)

## Interfaces

- [`ApplyPatchOptions`](https://reference.langchain.com/javascript/langchain-openai/ApplyPatchOptions)
- [`AzureChatOpenAIFields`](https://reference.langchain.com/javascript/langchain-openai/AzureChatOpenAIFields)
- [`AzureOpenAIChatInput`](https://reference.langchain.com/javascript/langchain-openai/AzureOpenAIChatInput)
- [`AzureOpenAIInput`](https://reference.langchain.com/javascript/langchain-openai/AzureOpenAIInput)
- [`BaseChatOpenAICallOptions`](https://reference.langchain.com/javascript/langchain-openai/BaseChatOpenAICallOptions)
- [`BaseChatOpenAIFields`](https://reference.langchain.com/javascript/langchain-openai/BaseChatOpenAIFields)
- [`ChatOpenAICompletionsCallOptions`](https://reference.langchain.com/javascript/langchain-openai/ChatOpenAICompletionsCallOptions)
- [`ChatOpenAIFields`](https://reference.langchain.com/javascript/langchain-openai/ChatOpenAIFields)
- [`ChatOpenAIResponsesCallOptions`](https://reference.langchain.com/javascript/langchain-openai/ChatOpenAIResponsesCallOptions)
- [`CodeInterpreterAutoContainer`](https://reference.langchain.com/javascript/langchain-openai/CodeInterpreterAutoContainer)
- [`CodeInterpreterOptions`](https://reference.langchain.com/javascript/langchain-openai/CodeInterpreterOptions)
- [`ComputerUseInput`](https://reference.langchain.com/javascript/langchain-openai/ComputerUseInput)
- [`ComputerUseOptions`](https://reference.langchain.com/javascript/langchain-openai/ComputerUseOptions)
- [`ConvertOpenAICompletionsStreamOptions`](https://reference.langchain.com/javascript/langchain-openai/ConvertOpenAICompletionsStreamOptions)
- [`ConvertOpenAIResponsesStreamOptions`](https://reference.langchain.com/javascript/langchain-openai/ConvertOpenAIResponsesStreamOptions)
- [`DallEAPIWrapperParams`](https://reference.langchain.com/javascript/langchain-openai/DallEAPIWrapperParams)
- [`FileSearchComparisonFilter`](https://reference.langchain.com/javascript/langchain-openai/FileSearchComparisonFilter)
- [`FileSearchCompoundFilter`](https://reference.langchain.com/javascript/langchain-openai/FileSearchCompoundFilter)
- [`FileSearchHybridSearchWeights`](https://reference.langchain.com/javascript/langchain-openai/FileSearchHybridSearchWeights)
- [`FileSearchOptions`](https://reference.langchain.com/javascript/langchain-openai/FileSearchOptions)
- [`FileSearchRankingOptions`](https://reference.langchain.com/javascript/langchain-openai/FileSearchRankingOptions)
- [`ImageGenerationInputMask`](https://reference.langchain.com/javascript/langchain-openai/ImageGenerationInputMask)
- [`ImageGenerationOptions`](https://reference.langchain.com/javascript/langchain-openai/ImageGenerationOptions)
- [`LocalShellOptions`](https://reference.langchain.com/javascript/langchain-openai/LocalShellOptions)
- [`McpApprovalFilter`](https://reference.langchain.com/javascript/langchain-openai/McpApprovalFilter)
- [`McpConnectorOptions`](https://reference.langchain.com/javascript/langchain-openai/McpConnectorOptions)
- [`McpRemoteServerOptions`](https://reference.langchain.com/javascript/langchain-openai/McpRemoteServerOptions)
- [`McpToolFilter`](https://reference.langchain.com/javascript/langchain-openai/McpToolFilter)
- [`OpenAIBaseInput`](https://reference.langchain.com/javascript/langchain-openai/OpenAIBaseInput)
- [`OpenAICallOptions`](https://reference.langchain.com/javascript/langchain-openai/OpenAICallOptions)
- [`OpenAIChatInput`](https://reference.langchain.com/javascript/langchain-openai/OpenAIChatInput)
- [`OpenAIEmbeddingsParams`](https://reference.langchain.com/javascript/langchain-openai/OpenAIEmbeddingsParams)
- [`OpenAIEndpointConfig`](https://reference.langchain.com/javascript/langchain-openai/OpenAIEndpointConfig)
- [`OpenAIInput`](https://reference.langchain.com/javascript/langchain-openai/OpenAIInput)
- [`ShellOptions`](https://reference.langchain.com/javascript/langchain-openai/ShellOptions)
- [`ShellResult`](https://reference.langchain.com/javascript/langchain-openai/ShellResult)
- [`ToolSearchOptions`](https://reference.langchain.com/javascript/langchain-openai/ToolSearchOptions)
- [`WebSearchFilters`](https://reference.langchain.com/javascript/langchain-openai/WebSearchFilters)
- [`WebSearchOptions`](https://reference.langchain.com/javascript/langchain-openai/WebSearchOptions)

## Types

- [`ApplyPatchCreateFileOperation`](https://reference.langchain.com/javascript/langchain-openai/ApplyPatchCreateFileOperation)
- [`ApplyPatchDeleteFileOperation`](https://reference.langchain.com/javascript/langchain-openai/ApplyPatchDeleteFileOperation)
- [`ApplyPatchOperation`](https://reference.langchain.com/javascript/langchain-openai/ApplyPatchOperation)
- [`ApplyPatchTool`](https://reference.langchain.com/javascript/langchain-openai/ApplyPatchTool)
- [`ApplyPatchUpdateFileOperation`](https://reference.langchain.com/javascript/langchain-openai/ApplyPatchUpdateFileOperation)
- [`ChatOpenAICallOptions`](https://reference.langchain.com/javascript/langchain-openai/ChatOpenAICallOptions)
- [`ChatOpenAIReasoningSummary`](https://reference.langchain.com/javascript/langchain-openai/ChatOpenAIReasoningSummary)
- [`ChatOpenAIResponseFormat`](https://reference.langchain.com/javascript/langchain-openai/ChatOpenAIResponseFormat)
- [`CodeInterpreterMemoryLimit`](https://reference.langchain.com/javascript/langchain-openai/CodeInterpreterMemoryLimit)
- [`CodeInterpreterTool`](https://reference.langchain.com/javascript/langchain-openai/CodeInterpreterTool)
- [`ComputerUseAction`](https://reference.langchain.com/javascript/langchain-openai/ComputerUseAction)
- [`ComputerUseClickAction`](https://reference.langchain.com/javascript/langchain-openai/ComputerUseClickAction)
- [`ComputerUseDoubleClickAction`](https://reference.langchain.com/javascript/langchain-openai/ComputerUseDoubleClickAction)
- [`ComputerUseDragAction`](https://reference.langchain.com/javascript/langchain-openai/ComputerUseDragAction)
- [`ComputerUseEnvironment`](https://reference.langchain.com/javascript/langchain-openai/ComputerUseEnvironment)
- [`ComputerUseKeypressAction`](https://reference.langchain.com/javascript/langchain-openai/ComputerUseKeypressAction)
- [`ComputerUseMoveAction`](https://reference.langchain.com/javascript/langchain-openai/ComputerUseMoveAction)
- [`ComputerUseScreenshotAction`](https://reference.langchain.com/javascript/langchain-openai/ComputerUseScreenshotAction)
- [`ComputerUseScrollAction`](https://reference.langchain.com/javascript/langchain-openai/ComputerUseScrollAction)
- [`ComputerUseTool`](https://reference.langchain.com/javascript/langchain-openai/ComputerUseTool)
- [`ComputerUseTypeAction`](https://reference.langchain.com/javascript/langchain-openai/ComputerUseTypeAction)
- [`ComputerUseWaitAction`](https://reference.langchain.com/javascript/langchain-openai/ComputerUseWaitAction)
- [`FileSearchComparisonType`](https://reference.langchain.com/javascript/langchain-openai/FileSearchComparisonType)
- [`FileSearchFilter`](https://reference.langchain.com/javascript/langchain-openai/FileSearchFilter)
- [`FileSearchTool`](https://reference.langchain.com/javascript/langchain-openai/FileSearchTool)
- [`HeadersLike`](https://reference.langchain.com/javascript/langchain-openai/HeadersLike)
- [`ImageGenerationTool`](https://reference.langchain.com/javascript/langchain-openai/ImageGenerationTool)
- [`LocalShellAction`](https://reference.langchain.com/javascript/langchain-openai/LocalShellAction)
- [`LocalShellTool`](https://reference.langchain.com/javascript/langchain-openai/LocalShellTool)
- [`McpConnectorId`](https://reference.langchain.com/javascript/langchain-openai/McpConnectorId)
- [`McpTool`](https://reference.langchain.com/javascript/langchain-openai/McpTool)
- [`OpenAIApiKey`](https://reference.langchain.com/javascript/langchain-openai/OpenAIApiKey)
- [`OpenAICacheRetentionParam`](https://reference.langchain.com/javascript/langchain-openai/OpenAICacheRetentionParam)
- [`OpenAIChatModelId`](https://reference.langchain.com/javascript/langchain-openai/OpenAIChatModelId)
- [`OpenAICoreRequestOptions`](https://reference.langchain.com/javascript/langchain-openai/OpenAICoreRequestOptions)
- [`OpenAIEmbeddingModelId`](https://reference.langchain.com/javascript/langchain-openai/OpenAIEmbeddingModelId)
- [`OpenAIImageModelId`](https://reference.langchain.com/javascript/langchain-openai/OpenAIImageModelId)
- [`OpenAIVerbosityParam`](https://reference.langchain.com/javascript/langchain-openai/OpenAIVerbosityParam)
- [`ResponseFormatConfiguration`](https://reference.langchain.com/javascript/langchain-openai/ResponseFormatConfiguration)
- [`ResponsesCreate`](https://reference.langchain.com/javascript/langchain-openai/ResponsesCreate)
- [`ResponsesCreateInvoke`](https://reference.langchain.com/javascript/langchain-openai/ResponsesCreateInvoke)
- [`ResponsesInputItem`](https://reference.langchain.com/javascript/langchain-openai/ResponsesInputItem)
- [`ResponsesParse`](https://reference.langchain.com/javascript/langchain-openai/ResponsesParse)
- [`ResponsesParseInvoke`](https://reference.langchain.com/javascript/langchain-openai/ResponsesParseInvoke)
- [`ShellAction`](https://reference.langchain.com/javascript/langchain-openai/ShellAction)
- [`ShellCallOutcome`](https://reference.langchain.com/javascript/langchain-openai/ShellCallOutcome)
- [`ShellCommandOutput`](https://reference.langchain.com/javascript/langchain-openai/ShellCommandOutput)
- [`ShellTool`](https://reference.langchain.com/javascript/langchain-openai/ShellTool)
- [`ToolSearchTool`](https://reference.langchain.com/javascript/langchain-openai/ToolSearchTool)
- [`WebSearchTool`](https://reference.langchain.com/javascript/langchain-openai/WebSearchTool)