f8d8ff4599* reorg pt 1 * nav reorg pt 2 * update sidebar ad * resolve comments and combine app pages * playground and voice mode rewrite * fix link * add separate bundle pages * add new pages to sidebar * working on bundles * moving content to new bundle pages * move some sidebar items * fix build * nav labels * small edits * Working on helpers * core components work * wrapping up some more agent duplication * aligning file management * webhooks and file management * data components * address vector store and some legacy components * finish logic params * some work on processors * remove unneeded pages and tidy some llm info * progress on bundles pt 1 * bundles pt 2 * bundles pt 3 * finish looking at integrations * it is done * fix errors * coderabbit and typos * coderabbit pt 2 * resolving mcs pt 1 * separate agents and mcp * still working on some memory stuff * finish message history alignment * incorporate PR 9138 * missed a link * file management ui * align w ui pr * Apply suggestions from code review * memory edits after discussion
82 lines
No EOL
5.4 KiB
Text
82 lines
No EOL
5.4 KiB
Text
---
|
|
title: OpenAI
|
|
slug: /bundles-openai
|
|
---
|
|
|
|
import Icon from "@site/src/components/icon";
|
|
|
|
[Bundles](/components-bundle-components) contain custom components that support specific third-party integrations with Langflow.
|
|
|
|
This page describes the components that are available in the **OpenAI** bundle.
|
|
|
|
For more information about OpenAI features and functionality used by OpenAI components, see the [OpenAI documentation](https://platform.openai.com/docs/overview).
|
|
|
|
## OpenAI text generation
|
|
|
|
The **OpenAI** component generates text using [OpenAI's language models](https://platform.openai.com/docs/models).
|
|
|
|
It provides access to the same OpenAI models that are available in the core **Language Model** component, but the **OpenAI** component provides additional parameters for customizing the request to the OpenAI API.
|
|
|
|
It can output either a **Model Response** ([`Message`](/data-types#message)) or a **Language Model** ([`LanguageModel`](/data-types#languagemodel)).
|
|
|
|
Use the **Language Model** output when you want to use a specific OpenAI model configuration as the LLM for another LLM-driven component, such as a **Language Model** or **Smart Function** component.
|
|
|
|
For more information, see [**Language Model** components](/components-models).
|
|
|
|
### OpenAI text generation parameters
|
|
|
|
Many **OpenAI** component input parameters are hidden by default in the visual editor.
|
|
You can toggle parameters through the <Icon name="SlidersHorizontal" aria-hidden="true"/> **Controls** in the [component's header menu](/concepts-components#component-menus).
|
|
|
|
| Name | Type | Description |
|
|
|------|------|-------------|
|
|
| api_key | SecretString | Input parameter. Your OpenAI API Key. |
|
|
| model | String | Input parameter. The name of the OpenAI model to use. Options include "gpt-3.5-turbo" and "gpt-4". |
|
|
| max_tokens | Integer | Input parameter. The maximum number of tokens to generate. Set to 0 for unlimited tokens. |
|
|
| temperature | Float | Input parameter. Controls randomness in the output. Range: [0.0, 1.0]. Default: 0.7. |
|
|
| top_p | Float | Input parameter. Controls the nucleus sampling. Range: [0.0, 1.0]. Default: 1.0. |
|
|
| frequency_penalty | Float | Input parameter. Controls the frequency penalty. Range: [0.0, 2.0]. Default: 0.0. |
|
|
| presence_penalty | Float | Input parameter. Controls the presence penalty. Range: [0.0, 2.0]. Default: 0.0. |
|
|
|
|
## OpenAI Embeddings
|
|
|
|
The **OpenAI Embeddings** component uses [OpenAI embedding models](https://platform.openai.com/docs/guides/embeddings) for embedding generation.
|
|
|
|
It provides access to the same OpenAI models that are available in the core **Embedding Model** component, but the **OpenAI Embeddings** component provides additional parameters for customizing the request to the OpenAI embedding API.
|
|
|
|
For more information about using embedding model components in flows, see [**Embedding Model** components](/components-embedding-models).
|
|
|
|
### OpenAI Embeddings parameters
|
|
|
|
Many **OpenAI Embeddings** component input parameters are hidden by default in the visual editor.
|
|
You can toggle parameters through the <Icon name="SlidersHorizontal" aria-hidden="true"/> **Controls** in the [component's header menu](/concepts-components#component-menus).
|
|
|
|
| Name | Type | Description |
|
|
|------|------|-------------|
|
|
| OpenAI API Key | String | Input parameter. The API key to use for accessing the OpenAI API. |
|
|
| Default Headers | Dict | Input parameter. The default headers for the HTTP requests. |
|
|
| Default Query | NestedDict | Input parameter. The default query parameters for the HTTP requests. |
|
|
| Allowed Special | List | Input parameter. The special tokens allowed for processing. Default: `[]`. |
|
|
| Disallowed Special | List | Input parameter. The special tokens disallowed for processing. Default: `["all"]`. |
|
|
| Chunk Size | Integer | Input parameter. The chunk size for processing. Default: `1000`. |
|
|
| Client | Any | Input parameter. The HTTP client for making requests. |
|
|
| Deployment | String | Input parameter. The deployment name for the model. Default: `text-embedding-3-small`. |
|
|
| Embedding Context Length | Integer | Input parameter. The length of embedding context. Default: `8191`. |
|
|
| Max Retries | Integer | Input parameter. The maximum number of retries for failed requests. Default: `6`. |
|
|
| Model | String | Input parameter. The name of the model to use. Default: `text-embedding-3-small`. |
|
|
| Model Kwargs | NestedDict | Input parameter. Additional keyword arguments for the model. |
|
|
| OpenAI API Base | String | Input parameter. The base URL of the OpenAI API. |
|
|
| OpenAI API Type | String | Input parameter. The type of the OpenAI API. |
|
|
| OpenAI API Version | String | Input parameter. The version of the OpenAI API. |
|
|
| OpenAI Organization | String | Input parameter. The organization associated with the API key. |
|
|
| OpenAI Proxy | String | Input parameter. The proxy server for the requests. |
|
|
| Request Timeout | Float | Input parameter. The timeout for the HTTP requests. |
|
|
| Show Progress Bar | Boolean | Input parameter. Whether to show a progress bar for processing. Default: `False`. |
|
|
| Skip Empty | Boolean | Input parameter. Whether to skip empty inputs. Default: `False`. |
|
|
| TikToken Enable | Boolean | Input parameter. Whether to enable TikToken. Default: `True`. |
|
|
| TikToken Model Name | String | Input parameter. The name of the TikToken model. |
|
|
|
|
## See also
|
|
|
|
* [**Agent** component](/components-agents)
|
|
* [LangChain **OpenAI Tools Agent** component](/bundles-langchain#openai-tools-agent) |