[Azure OpenAI] Make credentials optional when env variables are set (#3418)

* Make Azure OpenAI credentials optional when env variables are set

* Add documentation for env vars
This commit is contained in:
Jérémy JOURDIN 2024-11-01 23:09:13 +01:00 committed by GitHub
parent a159da5bfe
commit 012eabc996
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 72 additions and 3 deletions

View File

@ -6,6 +6,12 @@ import { getBaseClasses, getCredentialData, getCredentialParam } from '../../../
import { ChatOpenAI } from '../ChatOpenAI/FlowiseChatOpenAI'
import { getModels, MODEL_TYPE } from '../../../src/modelLoader'
const serverCredentialsExists =
!!process.env.AZURE_OPENAI_API_KEY &&
!!process.env.AZURE_OPENAI_API_INSTANCE_NAME &&
!!process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME &&
!!process.env.AZURE_OPENAI_API_VERSION
class AzureChatOpenAI_ChatModels implements INode {
label: string
name: string
@ -31,7 +37,8 @@ class AzureChatOpenAI_ChatModels implements INode {
label: 'Connect Credential',
name: 'credential',
type: 'credential',
credentialNames: ['azureOpenAIApi']
credentialNames: ['azureOpenAIApi'],
optional: serverCredentialsExists
}
this.inputs = [
{

View File

@ -0,0 +1,16 @@
# Azure OpenAI Chat Model
Azure OpenAI Chat Model integration for Flowise
## 🌱 Env Variables
| Variable | Description | Type | Default |
| ---------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------ | ----------------------------------- |
| AZURE_OPENAI_API_KEY | Default `credential.azureOpenAIApiKey` for Azure OpenAI Model | String | |
| AZURE_OPENAI_API_INSTANCE_NAME | Default `credential.azureOpenAIApiInstanceName` for Azure OpenAI Model | String | |
| AZURE_OPENAI_API_DEPLOYMENT_NAME | Default `credential.azureOpenAIApiDeploymentName` for Azure OpenAI Model | String | |
| AZURE_OPENAI_API_VERSION | Default `credential.azureOpenAIApiVersion` for Azure OpenAI Model | String | |
## License
Source code in this repository is made available under the [Apache License Version 2.0](https://github.com/FlowiseAI/Flowise/blob/master/LICENSE.md).

View File

@ -2,6 +2,12 @@ import { AzureOpenAIInput, OpenAIEmbeddings, OpenAIEmbeddingsParams } from '@lan
import { ICommonObject, INode, INodeData, INodeParams } from '../../../src/Interface'
import { getBaseClasses, getCredentialData, getCredentialParam } from '../../../src/utils'
const serverCredentialsExists =
!!process.env.AZURE_OPENAI_API_KEY &&
!!process.env.AZURE_OPENAI_API_INSTANCE_NAME &&
(!!process.env.AZURE_OPENAI_API_EMBEDDINGS_DEPLOYMENT_NAME || !!process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME) &&
!!process.env.AZURE_OPENAI_API_VERSION
class AzureOpenAIEmbedding_Embeddings implements INode {
label: string
name: string
@ -27,7 +33,8 @@ class AzureOpenAIEmbedding_Embeddings implements INode {
label: 'Connect Credential',
name: 'credential',
type: 'credential',
credentialNames: ['azureOpenAIApi']
credentialNames: ['azureOpenAIApi'],
optional: serverCredentialsExists
}
this.inputs = [
{

View File

@ -0,0 +1,16 @@
# Azure OpenAI Embedding Model
Azure OpenAI Embedding Model integration for Flowise
## 🌱 Env Variables
| Variable | Description | Type | Default |
| ---------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------ | ----------------------------------- |
| AZURE_OPENAI_API_KEY | Default `credential.azureOpenAIApiKey` for Azure OpenAI Model | String | |
| AZURE_OPENAI_API_INSTANCE_NAME | Default `credential.azureOpenAIApiInstanceName` for Azure OpenAI Model | String | |
| AZURE_OPENAI_API_EMBEDDINGS_DEPLOYMENT_NAME | Default `credential.azureOpenAIApiDeploymentName` for Azure OpenAI Model | String | |
| AZURE_OPENAI_API_VERSION | Default `credential.azureOpenAIApiVersion` for Azure OpenAI Model | String | |
## License
Source code in this repository is made available under the [Apache License Version 2.0](https://github.com/FlowiseAI/Flowise/blob/master/LICENSE.md).

View File

@ -5,6 +5,12 @@ import { ICommonObject, INode, INodeData, INodeOptionsValue, INodeParams } from
import { getBaseClasses, getCredentialData, getCredentialParam } from '../../../src/utils'
import { getModels, MODEL_TYPE } from '../../../src/modelLoader'
const serverCredentialsExists =
!!process.env.AZURE_OPENAI_API_KEY &&
!!process.env.AZURE_OPENAI_API_INSTANCE_NAME &&
!!process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME &&
!!process.env.AZURE_OPENAI_API_VERSION
class AzureOpenAI_LLMs implements INode {
label: string
name: string
@ -30,7 +36,8 @@ class AzureOpenAI_LLMs implements INode {
label: 'Connect Credential',
name: 'credential',
type: 'credential',
credentialNames: ['azureOpenAIApi']
credentialNames: ['azureOpenAIApi'],
optional: serverCredentialsExists
}
this.inputs = [
{

View File

@ -0,0 +1,16 @@
# Azure OpenAI LLM
Azure OpenAI LLM integration for Flowise
## 🌱 Env Variables
| Variable | Description | Type | Default |
| ---------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------ | ----------------------------------- |
| AZURE_OPENAI_API_KEY | Default `credential.azureOpenAIApiKey` for Azure OpenAI LLM | String | |
| AZURE_OPENAI_API_INSTANCE_NAME | Default `credential.azureOpenAIApiInstanceName` for Azure OpenAI LLM | String | |
| AZURE_OPENAI_API_DEPLOYMENT_NAME | Default `credential.azureOpenAIApiDeploymentName` for Azure OpenAI LLM | String | |
| AZURE_OPENAI_API_VERSION | Default `credential.azureOpenAIApiVersion` for Azure OpenAI LLM | String | |
## License
Source code in this repository is made available under the [Apache License Version 2.0](https://github.com/FlowiseAI/Flowise/blob/master/LICENSE.md).