🌍 Configuração da variável de ambiente
Visão geral
Nullcore fornece uma grande variedade de variáveis de ambiente que permitem personalizar e configurar vários aspectos do aplicativo. Esta página serve como uma referência abrangente para todos os disponíveis Variáveis de ambiente, fornecendo seus tipos, valores padrão e descrições. À medida que novas variáveis são introduzidas, esta página será atualizada para refletir as opções de configuração crescentes.
Esta página está atualizada com a versão aberta da Webuiv0.6.19, mas ainda é um trabalho em andamento para incluir posteriormente descrições mais precisas, listando opções disponíveis para variáveis de ambiente, padrões e melhorando as descrições.
Nota importante emPersistentConfig
Variáveis de ambiente
Ao iniciar o Nullcore pela primeira vez, todas as variáveis de ambiente são tratadas igualmente e podem ser usadas para configurar o aplicativo. No entanto, para variáveis ambientais marcadas comoPersistentConfig
, seus valores são persistidos e armazenados internamente.
Após o lançamento inicial, se você reiniciar o contêiner,PersistentConfig
As variáveis de ambiente não usarão mais os valores de variáveis de ambiente externo. Em vez disso, eles usarão os valores armazenados internamente.
Por outro lado, as variáveis de ambiente regulares continuarão sendo atualizadas e aplicadas em cada reinicialização subsequente.
Você pode atualizar os valores dePersistentConfig
Variáveis de ambiente diretamente de dentro do Webui aberto, e essas alterações serão armazenadas internamente. Isso permite gerenciar essas definições de configuração independentemente das variáveis de ambiente externo.
Observe issoPersistentConfig
As variáveis de ambiente são claramente marcadas como tal na documentação abaixo, para que você possa estar ciente de como elas se comportarão.
Para desativarPersistentConfig
e tem webui aberto tratando todas as variáveis igualmente, você pode definirENABLE_PERSISTENT_CONFIG
paraFalse
Aplicativo/back -end
As seguintes variáveis de ambiente são usadas porbackend/open_webui/config.py
Para fornecer startup aberto webui
configuração. Observe que algumas variáveis podem ter diferentes valores padrão, dependendo de
Se você está executando o Nullcore diretamente ou via Docker. Para mais informações sobre o registro
variáveis de ambiente, veja nossodocumentação de registro
Em geral
WEBUI_URL
- Tipo:
str
- Padrão:
http://localhost:3000
- Descrição: Especifica o URL onde sua instalação aberta do WebUI é acessível. Necessário para suporte ao mecanismo de pesquisa e OAuth/SSO.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Essa variável deve ser definida antes de começar a usar OAuth/SSO para autenticação. Como essa é uma variável de ambiente de configuração persistente, você só pode alterá -la através de uma das seguintes opções:
- Desativar temporariamente a configuração persistente usando
ENABLE_PERSISTENT_CONFIG
- Mudando
WEBUI_URL
No painel de administração> Configurações e alteração de "Webui URL".
A falha em definir Webui_URL antes de usar o OAuth/SSO resultará em falta de login.
ENABLE_SIGNUP
- Tipo:
bool
- Padrão:
True
- Descrição: Alterna a criação da conta de usuário.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_SIGNUP_PASSWORD_CONFIRMATION
- Tipo:
bool
- Padrão:
False
- Descrição: Se definido como true, um campo "Confirmar senha" é adicionado à página de inscrição para ajudar os usuários a evitar erros de digitação ao criar sua senha.
ENABLE_LOGIN_FORM
- Tipo:
bool
- Padrão:
True
- Descrição: alterna o email, senha, login e "ou" (somente quando quando
ENABLE_OAUTH_SIGNUP
está definido como true) elementos. - Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Isso deveriaapenasjá será definido comoFalse
quandoEnable_oauth_signuptambém está sendo usado e definido paraTrue
. Não fazer isso resultará na incapacidade de fazer o login.
DEFAULT_LOCALE
- Tipo:
str
- Padrão:
en
- Descrição: Define o local padrão para o aplicativo.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
DEFAULT_MODELS
- Tipo:
str
- Padrão: String vazio (''), desde
None
- Descrição: Define um modelo de idioma padrão.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
DEFAULT_USER_ROLE
- Tipo:
str
- Opções:
pending
- Os novos usuários estão pendentes até que suas contas sejam ativadas manualmente por um administrador.user
- Os novos usuários são ativados automaticamente com permissões de usuário regulares.admin
- Os novos usuários são ativados automaticamente com as permissões de administrador.
- Padrão:
pending
- Descrição: Define a função padrão atribuída a novos usuários.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
PENDING_USER_OVERLAY_TITLE
- Tipo:
str
- Padrão: String vazia ('')
- Descrição: Define um título personalizado para a sobreposição do usuário pendente.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
PENDING_USER_OVERLAY_CONTENT
- Tipo:
str
- Padrão: String vazia ('')
- Descrição: Define um conteúdo de texto personalizado para a sobreposição do usuário pendente.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_CHANNELS
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa o suporte ao canal.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
WEBHOOK_URL
- Tipo:
str
- Descrição: define um webhook para integração com equipes Discord/Slack/Microsoft.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_ADMIN_EXPORT
- Tipo:
bool
- Padrão:
True
- Descrição: controla se os administradores podem exportar dados, bate -papos e o banco de dados no painel de administração. As exportações de banco de dados funcionam apenas para bancos de dados SQLite por enquanto.
ENABLE_ADMIN_CHAT_ACCESS
- Tipo:
bool
- Padrão:
True
- Descrição: permite que os usuários do administrador acessem diretamente os bate -papos de outros usuários. Quando desativado, os administradores não podem mais acessar os bate -papos do usuário no painel de administração. Se você desativar isso, considere desativar
ENABLE_ADMIN_EXPORT
Além disso, se você estiver usando o SQLite, pois as exportações também contêm bate -papos de usuário.
BYPASS_ADMIN_ACCESS_CONTROL
- Tipo:
bool
- Padrão:
True
- Descrição: Quando desativado, os usuários administrativos são tratados como usuários regulares para acesso à área de trabalho (modelos, conhecimento, prompts e ferramentas) e só veem itens que eles têmpermissão explícita para acessaratravés do sistema de controle de acesso existente. Isso também se aplica à visibilidade dos modelos no seletor de modelos - os administradores serão tratados como usuários regulares: modelos básicos e modelos personalizados que eles não têmpermissão explícita para acessar, estará escondido. Se definido como
True
(Padrão), os administradores têm acesso atodos os itens criadosna área do espaço de trabalho e em todos os modelos no seletor de modelos,Independentemente das permissões de acesso
ENABLE_USER_WEBHOOKS
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa os webhooks do usuário.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RESPONSE_WATERMARK
- Tipo:
str
- Padrão: String vazia ('')
- Descrição: Define um texto personalizado que será incluído quando você copiar uma mensagem no bate -papo. Por exemplo
"This text is AI generated"
-> Adicionará "Este texto é gerado ai" a todas as mensagens, quando copiado. - Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
THREAD_POOL_SIZE
- Tipo:
int
- Padrão:
0
- Descrição: Define o tamanho do pool de threads para chamadas de bloqueio de FASTAPI/Anyio. Por padrão (quando definido como
0
) Uso FASTAPI/ANDIO40
tópicos. Em caso de grandes casos e muitos usuários simultâneos, pode ser necessário aumentarTHREAD_POOL_SIZE
para evitar bloquear.
MODELS_CACHE_TTL
- Tipo:
int
- Padrão:
1
- Descrição: Define o tempo de cache em segundos para respostas da lista de modelos dos pontos de extremidade do OpenAI e Ollama. Isso reduz as chamadas da API em cache na lista de modelos disponíveis para a duração especificada. Defina para esvaziar a string para desativar completamente o cache.
Isso armazena em cache as listas de modelo externo recuperadas dos pontos de extremidade da API compatível com o OpenAI e o Ollama (não abrem as configurações de modelo interno da Webui). Valores mais altos melhoram o desempenho, reduzindo solicitações redundantes de API a fornecedores externos, mas podem atrasar a visibilidade de modelos recém -adicionados ou removidos nesses pontos de extremidade. Um valor de 0 desativa o cache e força as novas chamadas da API a cada vez. Em cenários de alto tráfego, aumentar esse valor (por exemplo, para 300 segundos) pode reduzir significativamente a carga em pontos de extremidade externa da API, enquanto ainda fornece dados de modelo razoavelmente novos.
SHOW_ADMIN_DETAILS
- Tipo:
bool
- Padrão:
True
- Descrição: alterna se deve mostrar detalhes do usuário do administrador na interface.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ADMIN_EMAIL
- Tipo:
str
- Descrição: define o email do administrador mostrado por
SHOW_ADMIN_DETAILS
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENV
- Tipo:
str
- Opções:
dev
- Ativa a documentação da API FASTAPI sobre/docs
prod
- configura automaticamente várias variáveis de ambiente
- Padrão:
- Back -end Padrão
dev
- Docker Padrão
prod
- Back -end Padrão
- Descrição: Configuração do ambiente.
ENABLE_PERSISTENT_CONFIG
- Tipo:
bool
- Padrão:
True
- Descrição: se definido como
False
, todosPersistentConfig
As variáveis são tratadas como variáveis regulares.
CUSTOM_NAME
- Tipo:
str
- Descrição: Conjuntos
WEBUI_NAME
mas pesquisasapi.nullcore.compara metadados.
WEBUI_NAME
- Tipo:
str
- Padrão:
Nullcore
- Descrição: define o nome principal da webui. Anexos
(Nullcore)
se substituído.
PORT
- Tipo:
int
- Padrão:
8080
- Descrição: Define a porta para executar o Nullcore de.
Se você está executando o aplicativo via python e usando oopen-webui serve
comando, você não pode definir a porta usando oPORT
configuração. Em vez disso, você deve especificá-lo diretamente como um argumento da linha de comando usando o--port
bandeira. Por exemplo:
Aberto-webui serve-port 9999
Isso vai executar o webui aberto na porta9999
. OPORT
A variável de ambiente é desconsiderada neste modo.
ENABLE_REALTIME_CHAT_SAVE
- Tipo:
bool
- Padrão:
False
- Descrição: Quando ativado, o sistema salva cada parte dos dados de bate -papo transmitidos no banco de dados em tempo real para garantir a máxima persistência de dados. Esse recurso fornece uma recuperação robusta de dados e permite rastreamento preciso da sessão. No entanto, a troca é o aumento da latência, pois a economia no banco de dados apresenta um atraso. Desativar esse recurso pode melhorar o desempenho e reduzir os atrasos, mas arrisca a perda de dados potencial no caso de uma falha ou falha do sistema. Use com base nos requisitos do seu aplicativo e nas trocas aceitáveis.
CHAT_RESPONSE_STREAM_DELTA_CHUNK_SIZE
- Tipo:
int
- Padrão:
1
- Descrição: Define um valor mínimo em todo o sistema para o número de tokens em lote antes de enviá-los ao cliente durante uma resposta de streaming. Isso permite que um administrador aplique um nível de linha de base de desempenho e estabilidade em todo o sistema, impedindo tamanhos de pedaços excessivamente pequenos que podem causar alta carga de CPU. O tamanho final do pedaço usado para uma resposta será o maior valor definido nessa variável global, os parâmetros avançados do modelo ou as configurações por bate-papo. O padrão é 1, que não aplica lotes mínimos em nível global.
Recomenda-se definir isso como um valor de um dígito único ou baixo de dois dígitos se você executar o Nullcore com alta concorrência, muitos usuários e modelos de streaming muito rápido.
BYPASS_MODEL_ACCESS_CONTROL
- Tipo:
bool
- Padrão:
False
- Descrição: ignora o controle de acesso ao modelo. Quando definido como
true
, todos os usuários (e administradores) terão acesso a todos os modelos, independentemente da configuração de privacidade do modelo (privado, público, compartilhado com certos grupos). Isso é útil para instalações menores ou individuais de webui aberto, onde as restrições de acesso ao modelo podem não ser necessárias.
WEBUI_BUILD_HASH
- Tipo:
str
- Padrão:
dev-build
- Descrição: Usado para identificar o git sha da construção para lançamentos.
WEBUI_BANNERS
- Tipo:
list
dedict
- Padrão:
[]
- Descrição: Lista de banners para mostrar aos usuários. O formato para banners é:
[[{"eu ia" "corda", Assim, "tipo" "String [informações, sucesso, aviso, erro]", Assim, "título" "corda", Assim, "contente" "corda", Assim, "Dispensável" falso, Assim, "Timestamp" 1000
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Ao definir essa variável de ambiente em um.env
Arquivo, não deixe de escapar das citações envolvendo todo o valor em citações duplas e usando citações escapadas (\"
) para as citações internas. Exemplo:
Webui_banners = "[{\" id \ ": \" 1 \ ", \" type \ ": \" Warning \ ", \" title \ ": \" Suas mensagens são armazenadas. \ ", \" Content \ ": \" LLMs são propensos a alucinações, fontes de verificação. \ ", \" Dispensável \ ": true, \" Timestamp \ ": 1000}]"
USE_CUDA_DOCKER
- Tipo:
bool
- Padrão:
False
- Descrição: constrói a imagem do Docker com o suporte da NVIDIA CUDA. Ativa a aceleração da GPU para sussurros e incorporações locais.
EXTERNAL_PWA_MANIFEST_URL
- Tipo:
str
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Quando definido como um URL totalmente qualificado (por exemplo,,https: //path/to/manifest.webmanifest), as solicitações enviadas para /manifest.json usarão o arquivo de manifesto externo. Quando não estiver definido, o arquivo manifest.json padrão será usado.
ENABLE_TITLE_GENERATION
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa a geração do título de bate -papo.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LICENSE_KEY
- Tipo:
str
- Padrão:
None
- Descrição: Especifica a chave de licença a ser usada (somente para usuários corporativos).
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
SSL_ASSERT_FINGERPRINT
- Tipo:
str
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Especifica o SSL afirmam a impressão digital a ser usada.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
DEFAULT_PROMPT_SUGGESTIONS
- Tipo:
list
dedict
- Padrão:
[]
(o que significa usar as sugestões de prompt padrão interno) - Descrição: Lista de sugestões rápidas. O formato para sugestões imediatas são:
[[{"título" [["Título Parte 1", Assim, "Título Parte 2", Assim, "contente" "incitar"
Cliente aiohttp
AIOHTTP_CLIENT_TIMEOUT
- Tipo:
int
- Padrão:
300
- Descrição: Especifica a duração do tempo limite em segundos para o cliente AIOHTTP. Isso afeta as coisas como conexões com os terminais de Ollama e Openai.
Esta é a quantidade máxima de tempo em que o cliente aguardará uma resposta antes de chegar a um tempo.
Se definido como uma string vazia (''), o tempo limite será definido comoNone
, desativando efetivamente o tempo limite e
permitindo que o cliente espere indefinidamente.
AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST
- Tipo:
int
- Padrão:
10
- Descrição: define o tempo limite em segundos para buscar a lista de modelos. Isso pode ser útil nos casos em que a latência da rede requer uma duração de tempo limite mais longa para recuperar com sucesso a lista de modelos.
O aiohttp_client_timeout_model_list está definido como 10 segundos por padrão para ajudar a garantir que todas as conexões necessárias estejam disponíveis ao abrir a interface do usuário da web. Essa duração permite tempo suficiente para recuperar a lista de modelos, mesmo em casos de maior latência na rede. Você pode diminuir esse valor se o tempo limite mais rápido for preferido, mas lembre -se de que isso pode levar a que algumas conexões sejam descartadas, dependendo das condições da sua rede.
AIOHTTP_CLIENT_TIMEOUT_OPENAI_MODEL_LIST
- Tipo:
int
- Descrição: define o tempo limite em segundos para buscar a lista de modelos. Isso pode ser útil nos casos em que a latência da rede requer uma duração de tempo limite mais longa para recuperar com sucesso a lista de modelos.
Diretórios
DATA_DIR
- Tipo:
str
- Padrão:
./data
- Descrição: Especifica o diretório base para armazenamento de dados, incluindo uploads, cache, banco de dados vetorial, etc.
FONTS_DIR
- Tipo:
str
- Descrição: Especifica o diretório para fontes.
FRONTEND_BUILD_DIR
- Tipo:
str
- Padrão:
../build
- Descrição: Especifica a localização dos arquivos de front -end construídos.
STATIC_DIR
- Tipo:
str
- Padrão:
./static
- Descrição: Especifica o diretório para arquivos estáticos, como o Favicon.
Ollama
ENABLE_OLLAMA_API
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa o uso de APIs Ollama.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OLLAMA_BASE_URL
OLLAMA_API_BASE_URL
está preterido)
- Tipo:
str
- Padrão:
http://localhost:11434
- Docker Padrão:
- Se
K8S_FLAG
está definido:http://ollama-service.open-webui.svc.cluster.local:11434
- Se
USE_OLLAMA_DOCKER=True
http://localhost:11434
- Outro
http://host.docker.internal:11434
- Se
- Descrição: Configura o URL de back -end do ollama.
OLLAMA_BASE_URLS
- Tipo:
str
- Descrição: Configure os hosts de back-end da OLLama equilibrado, separados por
;
. VerOLLAMA_BASE_URL
. Tem precedênciaOLLAMA_BASE_URL
- Exemplo:
http://host-one:11434;http://host-two:11434
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USE_OLLAMA_DOCKER
- Tipo:
bool
- Padrão:
False
- Descrição: constrói a imagem do Docker com uma instância do Ollama.
K8S_FLAG
- Tipo:
bool
- Padrão:
False
- Descrição: Se definido, assume a implantação e conjuntos de gráficos de helmo
OLLAMA_BASE_URL
parahttp://ollama-service.open-webui.svc.cluster.local:11434
Openai
ENABLE_OPENAI_API
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa o uso de APIs OpenAI.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OPENAI_API_BASE_URL
- Tipo:
str
- Padrão:
https://api.openai.com/v1
- Descrição: configura o URL da API Base OpenAI.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OPENAI_API_BASE_URLS
- Tipo:
str
- Descrição: Suporta URLs de API de base do OpenAi equilibrado, separados por semicolon.
- Exemplo:
http://host-one:11434;http://host-two:11434
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OPENAI_API_KEY
- Tipo:
str
- Descrição: Define a chave da API OpenAI.
- Exemplo:
sk-124781258123
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OPENAI_API_KEYS
- Tipo:
str
- Descrição: suporta várias teclas de API OpenAI, separadas por semicolon.
- Exemplo:
sk-124781258123;sk-4389759834759834
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Tarefas
TASK_MODEL
- Tipo:
str
- Descrição: o modelo padrão a ser usado para tarefas como título e geração de consulta de pesquisa na web Ao usar os modelos Ollama.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
TASK_MODEL_EXTERNAL
- Tipo:
str
- Descrição: o modelo padrão a ser usado para tarefas como título e geração de consulta de pesquisa na web Ao usar pontos de extremidade compatíveis com o OpenAI.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
TITLE_GENERATION_PROMPT_TEMPLATE
- Tipo:
str
- Descrição: Prompt para usar ao gerar títulos de bate -papo.
- Padrão: o valor de
DEFAULT_TITLE_GENERATION_PROMPT_TEMPLATE
variável de ambiente.
DEFAULT_TITLE_GENERATION_PROMPT_TEMPLATE
### Tarefa:
Gere um título conciso de 3-5 palavras com um emoji resumindo o histórico de bate-papo.
Diretrizes ###:
- O título deve representar claramente o tema principal ou o assunto da conversa.
- Use emojis que melhore a compreensão do tópico, mas evite aspas ou formatação especial.
- Escreva o título no idioma principal do bate -papo; Padrão para o inglês se multilíngue.
- priorizar a precisão sobre a criatividade excessiva; Mantenha -o claro e simples.
### Saída:
Formato json: {"title": "Seu título conciso aqui"}
### Exemplos:
- {"Title": "📉 Trends do mercado de ações"},
- {"title": "🍪 Receita de chocolate perfeita"},
- {"Title": "Evolution of Music Streaming"},
- {"Title": "Tips de produtividade do trabalho remoto"},
- {"title": "Inteligência artificial em saúde"},
- {"Title": "🎮 Video Game Development Insights"}
Histórico de bate -papo:
<chat_history>
{{MESSAGES:END:2}}
</chat_history>
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_FOLLOW_UP_GENERATION
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa a geração de acompanhamento.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
FOLLOW_UP_GENERATION_PROMPT_TEMPLATE
- Tipo:
str
- Descrição: Prompt to Use para gerar várias questões de acompanhamento relevantes.
- Padrão: o valor de
DEFAULT_FOLLOW_UP_GENERATION_PROMPT_TEMPLATE
variável de ambiente.
DEFAULT_FOLLOW_UP_GENERATION_PROMPT_TEMPLATE
### Tarefa:
Sugira 3-5 perguntas relevantes ou solicita que o usuário possa perguntar naturalmente a seguir nesta conversa como um usuário ** **, com base no histórico de bate-papo, para ajudar a continuar ou aprofundar a discussão.
Diretrizes ###:
- Escreva todas as perguntas de acompanhamento do ponto de vista do usuário, direcionado ao assistente.
- Faça perguntas concisas, claras e diretamente relacionadas aos tópicos discutidos.
- sugere apenas os acompanhamentos que fazem sentido, dado o conteúdo do bate-papo, e não repita o que já estava coberto.
- Se a conversa for muito curta ou não, sugira acompanhamentos mais gerais (mas relevantes) que o usuário possa perguntar.
- Use o idioma principal da conversa; Padrão para o inglês se multilíngue.
- A resposta deve ser uma matriz JSON de cordas, sem texto ou formatação extra.
### Saída:
Formato json: {"siga_ups": ["Pergunta 1?", "Pergunta 2?", "Pergunta 3?"]}
Histórico de bate -papo:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>"
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
- Tipo:
str
- Descrição: Prompt to Use ao chamar ferramentas.
- Padrão: o valor de
DEFAULT_TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
variável de ambiente.
DEFAULT_TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
Ferramentas disponíveis: {{Tools}}
Sua tarefa é escolher e retornar a (s) ferramenta (s) correta (s) da lista de ferramentas disponíveis com base na consulta. Siga estas diretrizes:
- Retorne apenas o objeto JSON, sem nenhum texto ou explicação adicional.
- Se nenhuma ferramenta corresponder à consulta, retorne uma matriz vazia:
{
"Tool_calls": []
- Se uma ou mais ferramentas corresponderem à consulta, construa uma resposta JSON contendo uma matriz "Tool_Calls" com objetos que incluem:
- "Nome": o nome da ferramenta.
- "Parâmetros": um dicionário de parâmetros necessários e seus valores correspondentes.
O formato para a resposta JSON é estritamente:
{
"Tool_calls": [
{"name": "toolName1", "parameters": {"key1": "value1"}},
{"name": "toolName2", "parameters": {"key2": "value2"}}
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Execução de código
ENABLE_CODE_EXECUTION
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa a execução do código.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CODE_EXECUTION_ENGINE
- Tipo:
str
- Padrão:
pyodide
- Descrição: Especifica o mecanismo de execução do código para usar.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CODE_EXECUTION_JUPYTER_URL
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o URL do Jupyter para usar para execução de código.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CODE_EXECUTION_JUPYTER_AUTH
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o método de autenticação Jupyter a ser usado para execução de código.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CODE_EXECUTION_JUPYTER_AUTH_TOKEN
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o token de autenticação Jupyter para usar para execução de código.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CODE_EXECUTION_JUPYTER_AUTH_PASSWORD
- Tipo:
str
- Padrão:
None
- Descrição: Especifica a senha de autenticação Jupyter a ser usada para execução de código.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CODE_EXECUTION_JUPYTER_TIMEOUT
- Tipo:
str
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Especifica o tempo limite para a execução do código Jupyter.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Interpretador de código
ENABLE_CODE_INTERPRETER
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa o intérprete de código.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CODE_INTERPRETER_ENGINE
- Tipo:
str
- Padrão:
pyodide
- Descrição: Especifica o mecanismo de intérprete de código a ser usado.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CODE_INTERPRETER_BLACKLISTED_MODULES
- Tipo:
str
(Lista separada por vírgula de nomes de módulos) - Padrão: Nenhum
- Descrição: Especifica uma lista separada por vírgula dos módulos Python que estão na lista negra e não podem ser importados ou usados dentro do intérprete de código. Isso aumenta a segurança, impedindo o acesso a funcionalidades potencialmente sensíveis ou no nível do sistema.
CODE_INTERPRETER_PROMPT_TEMPLATE
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o modelo de prompt para usar para o intérprete de código.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CODE_INTERPRETER_JUPYTER_URL
- Tipo:
str
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Especifica o URL do Jupyter para usar para o intérprete de código.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CODE_INTERPRETER_JUPYTER_AUTH
- Tipo:
str
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Especifica o método de autenticação Jupyter a ser usado para o intérprete de código.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CODE_INTERPRETER_JUPYTER_AUTH_TOKEN
- Tipo:
str
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Especifica o token de autenticação Jupyter para usar para o intérprete de código.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD
- Tipo:
str
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Especifica a senha de autenticação Jupyter a ser usada para o intérprete de código.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CODE_INTERPRETER_JUPYTER_TIMEOUT
- Tipo:
str
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Especifica o tempo limite para o intérprete de código Jupyter.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Conexões diretas (servidores de ferramentas OpenApi/MCPO)
ENABLE_DIRECT_CONNECTIONS
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa conexões diretas.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AutoComplete
ENABLE_AUTOCOMPLETE_GENERATION
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa a geração de preenchimento automático.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Ao ativarENABLE_AUTOCOMPLETE_GENERATION
, verifique se você também configuraAUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH
eAUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
de acordo.
AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH
- Tipo:
int
- Padrão:
-1
- Descrição: Define o comprimento máximo de entrada para a geração de preenchimento automático.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
- Tipo:
str
- Padrão: o valor do
DEFAULT_AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
variável de ambiente.
DEFAULT_AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
### Tarefa:
Você é um sistema de conclusão automática. Continue o texto em `<ext>` com base no tipo de conclusão ** ** em `<type>` e no idioma fornecido.
### ** Instruções **:
1. Analise `<ext>` para contexto e significado.
2. Use `<type>` para orientar sua saída:
- ** Geral **: Forneça uma continuação natural e concisa.
- ** Consulta de pesquisa **: Complete como se estivesse gerando uma consulta de pesquisa realista.
3. Comece como se você estivesse diretamente `<ext>`. Faça ** NÃO ** Repita, parafrasee ou responda como um modelo. Simplesmente complete o texto.
4. Verifique se a continuação:
- flui naturalmente de `<ext>`.
- Evita repetições, superexplicação ou idéias não relacionadas.
5. Se não tiver certeza, retorne: `{" text ":" "}`.
### ** Regras de saída **:
- Responda apenas no formato JSON: `{" text ":" <your_completion> "}`.
### ** Exemplos **:
#### Exemplo 1:
Entrada:
<type>General</type>
<text>The sun was setting over the horizon, painting the sky</text>
Saída:
{ "text": "with vibrant shades of orange and pink." }
#### Exemplo 2:
Entrada:
<type>Search Query</type>
<text>Top-rated restaurants in</text>
Saída:
{ "text": "New York City for Italian cuisine." }
----
### Contexto:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>
<type>{{TYPE}}</type>
<text>{{PROMPT}}</text>
#### Saída:
- Descrição: Define o modelo de prompt para geração de preenchimento automático.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Modelo de Arena de Avaliação
ENABLE_EVALUATION_ARENA_MODELS
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa os modelos de Arena de avaliação.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_MESSAGE_RATING
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa o recurso de classificação da mensagem.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_COMMUNITY_SHARING
- Tipo:
bool
- Padrão:
True
- Descrição: controla se os usuários são mostrados o compartilhamento no botão da comunidade.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Geração de tags
ENABLE_TAGS_GENERATION
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa a geração de tags.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
TAGS_GENERATION_PROMPT_TEMPLATE
- Tipo:
str
- Padrão: o valor de
DEFAULT_TAGS_GENERATION_PROMPT_TEMPLATE
variável de ambiente.
DEFAULT_TAGS_GENERATION_PROMPT_TEMPLATE
### Tarefa:
Gere 1-3 tags amplas categorizando os principais temas do histórico de bate-papo, juntamente com 1-3 tags subtópicas mais específicas.
Diretrizes ###:
- Comece com domínios de alto nível (por exemplo, ciência, tecnologia, filosofia, artes, política, negócios, saúde, esportes, entretenimento, educação)
- Considere incluir subcampos/subdomínios relevantes se estiverem fortemente representados ao longo da conversa
- Se o conteúdo for muito curto (menos de 3 mensagens) ou muito diversificado, use apenas ["general"]
- Use o idioma principal do bate -papo; padrão para o inglês se multilíngue
- Priorizar a precisão sobre a especificidade
### Saída:
Formato json: {"tags": ["tag1", "tag2", "tag3"]}
Histórico de bate -papo:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>
- Descrição: Define o modelo de prompt para geração de tags.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Restrições de terminal de chave da API
ENABLE_API_KEY
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa a autenticação da chave da API.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_API_KEY_ENDPOINT_RESTRICTIONS
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa as restrições de endpoint da chave da API para maior segurança e configuração.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
API_KEY_ALLOWED_ENDPOINTS
- Tipo:
str
- Descrição: Especifica uma lista separada por vírgula dos pontos de extremidade da API permitidos quando as restrições de terminais da chave da API estiverem ativadas.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
O valor deAPI_KEY_ALLOWED_ENDPOINTS
deve ser uma lista separada por vírgula de URLs de endpoint, como/api/v1/messages, /api/v1/channels
JWT_EXPIRES_IN
- Tipo:
str
- Padrão:
-1
- Descrição: define o tempo de expiração do JWT em segundos. Unidades de tempo válidas:
s
, Assim,m
, Assim,h
, Assim,d
, Assim,w
ou-1
sem expiração. - Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ContextoJWT_EXPIRES_IN
para-1
Desative a expiração do JWT, tornando os tokens emitidos válidos para sempre.Isso é extremamente perigoso na produçãoe expõe seu sistema a riscos graves de segurança se os tokens forem vazados ou comprometidos.
Sempre defina um tempo de validade razoável (por exemplo,,3600s
, Assim,1h
, etc.) na produção para limitar a vida útil dos tokens de autenticação.Nunca use-1
em um ambiente de produção.
Se você já foi implantado comJWT_EXPIRES_IN=-1
, você pode girar ou alterar seuWEBUI_SECRET_KEY
para invalidar imediatamente todos os tokens existentes.
Variáveis de segurança
ENABLE_FORWARD_USER_INFO_HEADERS
- tipo:
bool
- Padrão:
False
- Descrição: Encaminhe as informações do usuário (nome, ID, email, função e ID de bate-papo) como cabeçudos X para o OpenAI API e Ollama API.
Se ativado, os seguintes cabeçalhos são encaminhados:
X-nullcore-User-Name
X-nullcore-User-Id
X-nullcore-User-Email
X-nullcore-User-Role
X-nullcore-Chat-Id
ENABLE_WEB_LOADER_SSL_VERIFICATION
- Tipo:
bool
- Padrão:
True
- Descrição: Introdução SSL Verificação para RAG em sites.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
WEBUI_SESSION_COOKIE_SAME_SITE
- Tipo:
str
- Opções:
lax
- Define oSameSite
atribuir a LAX, permitindo que os cookies de sessão sejam enviados com Solicitações iniciadas por sites de terceiros.strict
- Define oSameSite
atributo a bloqueios rigorosos e bloqueadores de serem enviados com solicitações iniciadas por sites de terceiros.none
- Define oSameSite
atribuir a nenhum, permitindo que os cookies de sessão sejam enviados com Solicitações iniciadas por sites de terceiros, mas apenas sobre HTTPs.
- Padrão:
lax
- Descrição: define o
SameSite
atributo para cookies de sessão.
QuandoENABLE_OAUTH_SIGNUP
está ativado, configuraçãoWEBUI_SESSION_COOKIE_SAME_SITE
parastrict
pode causar falhas de login. Isso ocorre porque o Nullcore usa um cookie de sessão para validar o retorno de chamada do provedor OAuth, o que ajuda a evitar ataques de CSRF.
No entanto, astrict
O cookie da sessão não é enviado com a solicitação de retorno de chamada, levando a possíveis problemas de login. Se você tiver esse problema, use o padrãolax
valor em vez disso.
WEBUI_SESSION_COOKIE_SECURE
- Tipo:
bool
- Padrão:
False
- Descrição: define o
Secure
atributo para cookies de sessão se definido comoTrue
WEBUI_AUTH_COOKIE_SAME_SITE
- Tipo:
str
- Opções:
lax
- Define oSameSite
atributo a LAX, permitindo que os cookies de autores sejam enviados com Solicitações iniciadas por sites de terceiros.strict
- Define oSameSite
atributo a rigorosamente bloqueando os cookies de autores de serem enviados com solicitações iniciadas por sites de terceiros.none
- Define oSameSite
atribuir a ninguém, permitindo que os cookies de autores sejam enviados com Solicitações iniciadas por sites de terceiros, mas apenas sobre HTTPs.
- Padrão:
lax
- Descrição: define o
SameSite
atributo para biscoitos auth.
Se o valor não estiver definido,WEBUI_SESSION_COOKIE_SAME_SITE
será usado como um retorno.
WEBUI_AUTH_COOKIE_SECURE
- Tipo:
bool
- Padrão:
False
- Descrição: define o
Secure
atributo para cookies de autores se definido comoTrue
Se o valor não estiver definido,WEBUI_SESSION_COOKIE_SECURE
será usado como um retorno.
WEBUI_AUTH
- Tipo:
bool
- Padrão:
True
- Descrição: Esta configuração permite ou desativa a autenticação.
Se definido comoFalse
, a autenticação será desativada para sua instância aberta da Webui. No entanto, é
importante observar que desligar a autenticação só é possível para novas instalações sem
quaisquer usuários existentes. Se já houver usuários registrados, você não pode desativar a autenticação
diretamente. Certifique -se de que nenhum usuário esteja presente no banco de dados se você pretende desligarWEBUI_AUTH
WEBUI_SECRET_KEY
- Tipo:
str
- Padrão:
t0p-s3cr3t
- Docker Padrão: gerado aleatoriamente na primeira partida
- Descrição: substitui a sequência gerada aleatoriamente usada para o JSON Web Token.
Ao implantar Webui aberto em um cluster de vários nó/trabalhador com um balanceador de carga, você deve garantir que o valor Webui_Secret_Key seja o mesmo em todas as instâncias para permitir que os usuários continuem trabalhando se um nó for reciclado ou sua sessão for transferida para um nó diferente. Sem ele, eles precisarão fazer login novamente sempre que as alterações subjacentes do nó.
ENABLE_VERSION_UPDATE_CHECK
- Tipo:
bool
- Padrão:
True
- Descrição: Quando ativado, o aplicativo faz verificações automáticas de atualização e notifica sobre as atualizações da versão.
SeOFFLINE_MODE
está ativado, issoENABLE_VERSION_UPDATE_CHECK
Flag está sempre definido comofalse
automaticamente.
OFFLINE_MODE
- Tipo:
bool
- Padrão:
False
- Descrição: desativa as conexões de rede do Nullcore para verificações de atualização e downloads automáticos de modelos.
Desativado quando ativado:
- Verificações de atualização de versão automática (consulte o sinalizador
ENABLE_VERSION_UPDATE_CHECK
- Downloads de modelos de incorporação do HUGGING FACE HUB
- Se você não baixou um modelo de incorporação antes de ativar
OFFLINE_MODE
Qualquer pano, pesquisa da web e funcionalidade de análise de documentos pode não funcionar corretamente
- Se você não baixou um modelo de incorporação antes de ativar
- Atualizar notificações na interface do usuário (veja a bandeira
ENABLE_VERSION_UPDATE_CHECK
Ainda funcional:
- Conexões API externas LLM (OpenAI, etc.)
- Provedores de autenticação OAuth
- Pesquisa na Web e RAG com APIs externas
Leia mais sobreoffline mode
nestaguia
RESET_CONFIG_ON_START
- Tipo:
bool
- Padrão:
False
- Descrição: Redefina o
config.json
arquivo na inicialização.
SAFE_MODE
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa o modo de segurança, que desativa recursos potencialmente inseguros, desativando todas as funções.
CORS_ALLOW_ORIGIN
- Tipo:
str
- Padrão:
*
- Descrição: Define as origens permitidas para compartilhamento de recursos de origem cruzada (CORS).
CORS_ALLOW_CUSTOM_SCHEME
- Tipo
str
- Padrão:
""
(string vazia) - Descrição: Define uma lista de esquemas mais permitidos para compartilhamento de recursos de origem cruzada (CORS). Permite especificar esquemas de URL personalizados adicionais, além do padrão
http
ehttps
, que são permitidos como origens válidas para compartilhamento de recursos cruzados (CORS).
Isso é particularmente útil para cenários como:
- Integração com aplicativos de desktop que usam protocolos personalizados (por exemplo,,
app://
, Assim,custom-app-scheme://
- Ambientes de desenvolvimento local ou configurações de teste que podem empregar esquemas não padrão (por exemplo,,
file://
se aplicável, ouelectron://
Forneça uma lista semicolon-separada de nomes de esquemas sem o://
. Por exemplo:app;file;electron;my-custom-scheme
Quando configurados, esses esquemas personalizados serão validados ao ladohttp
ehttps
Para quaisquer origens especificadas emCORS_ALLOW_ORIGIN
RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE
- Tipo:
bool
- Padrão:
False
- Descrição: determina se deve permitir modelos personalizados definidos no hub em seus próprios arquivos de modelagem.
RAG_RERANKING_MODEL_TRUST_REMOTE_CODE
- Tipo:
bool
- Padrão:
False
- Descrição: determina se deve permitir modelos personalizados definidos no hub por conta própria. Modelagem de arquivos para reranger.
RAG_EMBEDDING_MODEL_AUTO_UPDATE
- Tipo:
bool
- Padrão:
True
- Descrição: alterna a atualização automática do modelo de transformador de sentença.
RAG_RERANKING_MODEL_AUTO_UPDATE
- Tipo:
bool
- Padrão:
True
- Descrição: Alterna a atualização automática do modelo de reranização.
Banco de dados vetorial
VECTOR_DB
- Tipo:
str
- Opções:
chroma
, Assim,elasticsearch
, Assim,milvus
, Assim,opensearch
, Assim,pgvector
, Assim,qdrant
, Assim,pinecone
, Assim,s3vector
, Assim,oracle23ai
- Padrão:
chroma
- Descrição: Especifica qual sistema de banco de dados vetorial a ser usado. Essa configuração determina qual sistema de armazenamento vetorial será usado para gerenciar incorporações.
Chromadb
CHROMA_TENANT
- Tipo:
str
- Padrão: o valor de
chromadb.DEFAULT_TENANT
(uma constante nochromadb
módulo) - Descrição: Define o inquilino para o Chromadb usar para incorporação de rag.
CHROMA_DATABASE
- Tipo:
str
- Padrão: o valor de
chromadb.DEFAULT_DATABASE
(uma constante nochromadb
módulo) - Descrição: Define o banco de dados no inquilino Chromadb a ser usado para incorporação de rag.
CHROMA_HTTP_HOST
- Tipo:
str
- Descrição: Especifica o nome do host de um servidor Chromadb remoto. Usa uma instância local do Chromadb, se não estiver definida.
CHROMA_HTTP_PORT
- Tipo:
int
- Padrão:
8000
- Descrição: Especifica a porta de um servidor Chromadb remoto.
CHROMA_HTTP_HEADERS
- Tipo:
str
- Descrição: Uma lista separada por vírgula dos cabeçalhos HTTP para incluir a cada solicitação do Chromadb.
- Exemplo:
Authorization=Bearer heuhagfuahefj,User-Agent=nullcore
CHROMA_HTTP_SSL
- Tipo:
bool
- Padrão:
False
- Descrição: controla se o SSL é ou não usado para conexões do servidor Chromadb.
CHROMA_CLIENT_AUTH_PROVIDER
- Tipo:
str
- Descrição: Especifica um provedor de autenticação para o servidor Chromadb remoto.
- Exemplo:
chromadb.auth.basic_authn.BasicAuthClientProvider
CHROMA_CLIENT_AUTH_CREDENTIALS
- Tipo:
str
- Descrição: Especifica credenciais de autenticação para o servidor Chromadb remoto.
- Exemplo:
username:password
Elasticsearch
ELASTICSEARCH_API_KEY
- Tipo:
str
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Especifica a chave da API Elasticsearch.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ELASTICSEARCH_CA_CERTS
- Tipo:
str
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Especifica o caminho para os certificados da CA para o Elasticsearch.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ELASTICSEARCH_CLOUD_ID
- Tipo:
str
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Especifica o ID do Elasticsearch Cloud.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ELASTICSEARCH_INDEX_PREFIX
- Tipo:
str
- Padrão:
open_webui_collections
- Descrição: Especifica o prefixo para o Elasticsearch Index.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ELASTICSEARCH_PASSWORD
- Tipo:
str
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Especifica a senha do Elasticsearch.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ELASTICSEARCH_URL
- Tipo:
str
- Padrão:
https://localhost:9200
- Descrição: Especifica o URL para a instância do Elasticsearch.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ELASTICSEARCH_USERNAME
- Tipo:
str
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Especifica o nome de usuário para o Elasticsearch.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Milvus
MILVUS_URI
- Tipo:
str
- Padrão:
${DATA_DIR}/vector_db/milvus.db
- Descrição: Especifica o URI para conectar -se ao banco de dados do Vector Milvus. Isso pode apontar para um servidor Milvus local ou remoto com base na configuração de implantação.
MILVUS_DB
- Tipo:
str
- Padrão:
default
- Descrição: Especifica o banco de dados para conectar -se a uma instância do MILVUS.
MILVUS_TOKEN
- Tipo:
str
- Padrão:
None
- Descrição: Especifica um token de conexão opcional para Milvus.
MILVUS_INDEX_TYPE
- Tipo:
str
- Padrão:
HNSW
- Opções:
AUTOINDEX
, Assim,FLAT
, Assim,IVF_FLAT
, Assim,HNSW
- Descrição: Especifica o tipo de índice a ser usado ao criar uma nova coleção no Milvus.
AUTOINDEX
é geralmente recomendado para Milvus independente.HNSW
Pode oferecer melhor desempenho, mas normalmente requer uma configuração de Milvus em cluster. - Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
MILVUS_METRIC_TYPE
- Tipo:
str
- Padrão:
COSINE
- Opções:
COSINE
, Assim,IP
, Assim,L2
- Descrição: Especifica o tipo métrico para pesquisa de similaridade vetorial em Milvus.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
MILVUS_HNSW_M
- Tipo:
int
- Padrão:
16
- Descrição: Especifica o
M
Parâmetro para o tipo de índice HNSW em Milvus. Isso influencia o número de links bidirecionais criados para cada novo elemento durante a construção. Somente aplicável seMILVUS_INDEX_TYPE
éHNSW
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
MILVUS_HNSW_EFCONSTRUCTION
- Tipo:
int
- Padrão:
100
- Descrição: Especifica o
efConstruction
Parâmetro para o tipo de índice HNSW em Milvus. Isso influencia o tamanho da lista dinâmica dos vizinhos mais próximos durante a construção de índices. Somente aplicável seMILVUS_INDEX_TYPE
éHNSW
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
MILVUS_IVF_FLAT_NLIST
- Tipo:
int
- Padrão:
128
- Descrição: Especifica o
nlist
Parâmetro para o tipo de índice ivf_flat no milvus. Este é o número de unidades de cluster. Somente aplicável seMILVUS_INDEX_TYPE
éIVF_FLAT
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OpenSearch
OPENSEARCH_CERT_VERIFY
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa a verificação do Certificado OpenEarch.
OPENSEARCH_PASSWORD
- Tipo:
str
- Padrão:
None
- Descrição: Define a senha para o OpenSearch.
OPENSEARCH_SSL
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa o SSL para o OpenSearch.
OPENSEARCH_URI
- Tipo:
str
- Padrão:
https://localhost:9200
- Descrição: Define o URI para o OpenSearch.
OPENSEARCH_USERNAME
- Tipo:
str
- Padrão:
None
- Descrição: Define o nome de usuário para o OpenSearch.
PGVECTOR
PGVECTOR_DB_URL
- Tipo:
str
- Padrão: o valor do
DATABASE_URL
variável de ambiente - Descrição: Define o URL do banco de dados para armazenamento de modelo.
PGVECTOR_INITIALIZE_MAX_VECTOR_LENGTH
- Tipo:
str
- Padrão:
1536
- Descrição: Especifica o comprimento máximo do vetor para a inicialização do PGVector.
QDRANT
QDRANT_API_KEY
- Tipo:
str
- Descrição: Define a tecla API para QDRANT.
QDRANT_URI
- Tipo:
str
- Descrição: define o URI para QDRANT.
QDRANT_ON_DISK
- Tipo:
bool
- Padrão:
False
- Descrição: Ativar o uso do Memmap (também conhecido como armazenamento no disco)
QDRANT_PREFER_GRPC
- Tipo:
bool
- Padrão:
False
- Descrição: Use a interface GPRC sempre que possível.
Se definido comoTrue
, eQDRANT_URI
aponta para um servidor auto-hospedado com TLS ativado e certificado assinado por uma CA privada, defina a variável de ambienteGRPC_DEFAULT_SSL_ROOTS_FILE_PATH
ao caminho do seu arquivo de certificados CA codificados por PEM. Veja oGRPC Core DocsPara mais informações.
QDRANT_GRPC_PORT
- Tipo:
int
- Padrão:
6334
- Descrição: Define o número da porta GRPC para QDRANT.
QDRANT_TIMEOUT
- Tipo:
int
- Padrão:
5
- Descrição: Define o tempo limite em segundos para todas as solicitações feitas para o servidor QDRANT, ajudando a impedir que as consultas de longa data parassem o aplicativo.
QDRANT_HNSW_M
- Tipo:
int
- Padrão:
16
- Descrição: Controla a construção do índice HNSW (Hierárquica Small World World). No modo padrão, isso define o
m
parâmetro. No modo multi-literário, esse valor é usado para opayload_m
parâmetro para construir índices na carga útil, como o globalm
está desativado para desempenho, seguindo as melhores práticas QDRANT.
ENABLE_QDRANT_MULTITENANCY_MODE
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa o padrão de multitenância para gerenciamento de coleções de QDRANT, que reduz significativamente o uso de RAM e a sobrecarga computacional, consolidando estruturas de dados vetoriais semelhantes. Recomende ativar
Isso desconectará todas as coleções QDRANT criadas no padrão anterior, que não é multitenância. Vá paraAdmin Settings
Documents
Reindex Knowledge Base
para migrar conhecimentos existentes.
As coleções QDRANT criadas no padrão anterior ainda consumirão recursos.
Atualmente, não há botão na interface do usuário para redefinir apenas o DB do vetor. Se você deseja migrar o conhecimento para a multitenância:
- Remova todas as coleções com o
open_webui-knowledge
prefixo (ouopen_webui
Prefixo para remover todas as coleções relacionadas ao Nullcore) usando o cliente QDrant nativo - Vá para
Admin Settings
Documents
Reindex Knowledge Base
Para migrar a base de conhecimento existente
Reindex Knowledge Base
só migrará a base de conhecimento
Se você decidir usar o padrão de multitenância como padrão e não precisar migrar conhecimento antigo, vá paraAdmin Settings
Documents
para redefinir o vetor e o conhecimento, que excluirá todas as coleções com oopen_webui
prefixo e todo o conhecimento armazenado.
QDRANT_COLLECTION_PREFIX
- Tipo:
str
- Padrão:
open-webui
- Descrição: Define o prefixo para nomes de coleções QDRANT. Útil para nomes de espaço ou isolamento de coleções, especialmente no modo de multitenância. Alterar esse valor fará com que o aplicativo use um conjunto diferente de coleções no QDRANT. As coleções existentes com um prefixo diferente não serão afetadas.
Pinecone
Ao usar o Pinecone como o Vector Store, as seguintes variáveis de ambiente são usadas para controlar seu comportamento. Certifique -se de definir essas variáveis em seu.env
ambiente de arquivo ou implantação.
PINECONE_API_KEY
- Tipo:
str
- Padrão:
None
- Descrição: Define a chave da API usada para autenticar com o serviço Pinecone.
PINECONE_ENVIRONMENT
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o ambiente Pinecone para conectar -se (por exemplo,,
us-west1-gcp
, Assim,gcp-starter
, etc.).
PINECONE_INDEX_NAME
- Tipo:
str
- Padrão:
open-webui-index
- Descrição: Define o nome do índice Pinecone que será usado para armazenar e consultar incorporações de vetor.
PINECONE_DIMENSION
- Tipo:
int
- Padrão:
1536
- Descrição: A dimensionalidade das incorporações do vetor. Deve corresponder à dimensão esperada pelo índice (geralmente 768, 1024, 1536 ou 3072 com base no modelo usado).
PINECONE_METRIC
- Tipo:
str
- Padrão:
cosine
- Opções:
cosine
, Assim,dotproduct
, Assim,euclidean
- Descrição: Especifica a métrica de similaridade a ser usada para comparações de vetores no índice Pinecone.
PINECONE_CLOUD
- Tipo:
str
- Padrão:
aws
- Opções:
aws
, Assim,gcp
, Assim,azure
- Descrição: Especifica o provedor de nuvem em que o índice Pinecone está hospedado.
Oracle 23ai Vector Search (Oracle23ai)
ORACLE_DB_USE_WALLET
- Tipo
bool
- Padrão
false
- Descrição: Determina o método de conexão com o banco de dados Oracle.
- Definido como
false
Para conexões diretas (por exemplo, para o Oracle Database 23ai Free ou DBCS Instâncias) usando o nome do host, porta e serviço emORACLE_DB_DSN
- Definido como
true
Para conexões baseadas em carteira (por exemplo, para o Oracle Autonomous Database (ADW/ATP)). Quandotrue
, Assim,ORACLE_WALLET_DIR
eORACLE_WALLET_PASSWORD
também deve ser configurado.
- Definido como
ORACLE_DB_USER
- Tipo
str
- Padrão
DEMOUSER
- Descrição: Especifica o nome de usuário usado para conectar -se ao banco de dados Oracle.
ORACLE_DB_PASSWORD
- Tipo
str
- Padrão
Welcome123456
- Descrição: Especifica a senha para o
ORACLE_DB_USER
ORACLE_DB_DSN
- Tipo
str
- Padrão
localhost:1521/FREEPDB1
- Descrição: Define o nome da fonte de dados para a conexão do banco de dados Oracle.
- Se
ORACLE_DB_USE_WALLET
éfalse
, isso deve estar no formatohostname:port/service_name
(por exemplo,localhost:1521/FREEPDB1
- Se
ORACLE_DB_USE_WALLET
étrue
, este pode ser um alias do TNS (por exemplo,,medium
para ADW/ATP) ou uma sequência de conexão completa.
- Se
ORACLE_WALLET_DIR
- Tipo
str
- Padrão: String vazia ('')
- DescriçãoExigido quando
ORACLE_DB_USE_WALLET
étrue
. Especifica o caminho absoluto para o diretório que contém os arquivos da carteira Oracle Cloud (por exemplo,,cwallet.sso
, Assim,sqlnet.ora
, Assim,tnsnames.ora
ORACLE_WALLET_PASSWORD
- Tipo
str
- Padrão: String vazia ('')
- DescriçãoExigido quando
ORACLE_DB_USE_WALLET
étrue
. Especifica a senha da carteira Oracle Cloud.
ORACLE_VECTOR_LENGTH
- Tipo
int
- Padrão
768
- Descrição: Define a dimensão ou comprimento esperado das incorporações de vetor armazenadas no banco de dados Oracle. Isso deve corresponder ao modelo de incorporação usado.
ORACLE_DB_POOL_MIN
- Tipo
int
- Padrão
2
- Descrição: O número mínimo de conexões a serem mantidas no pool de conexões do Oracle Database.
ORACLE_DB_POOL_MAX
- Tipo
int
- Padrão
10
- Descrição: O número máximo de conexões permitidas no pool de conexões do Oracle Database.
ORACLE_DB_POOL_INCREMENT
- Tipo
int
- Padrão
1
- Descrição: O número de conexões para criar quando o pool precisa crescer.
S3 Vector Bucket
Ao usar o S3 Vector Bucket como loja vetorial, as seguintes variáveis de ambiente são usadas para controlar seu comportamento. Certifique -se de definir essas variáveis em seu.env
ambiente de arquivo ou implantação.
Nota: Esta configuração pressupõe que as credenciais da AWS estarão disponíveis para o seu ambiente aberto da Webui. Isso pode ser através de variáveis de ambiente comoAWS_ACCESS_KEY_ID
eAWS_SECRET_ACCESS_KEY
, ou por meio de permissões de papel do IAM.
S3_VECTOR_BUCKET_NAME
- Tipo:
str
- Descrição: Especifica o nome do balde de vetor S3 para armazenar vetores.
S3_VECTOR_REGION
- Tipo:
str
- Descrição: Especifica a região da AWS onde o balde de vetor S3 está hospedado.
Mecanismo de extração de conteúdo de pano
CONTENT_EXTRACTION_ENGINE
- Tipo:
str
- Opções:
- Deixe vazio para usar o padrão
external
- Use carregador externotika
- Use um servidor Apache Tika localdocling
- Use Docling Enginedocument_intelligence
- Use o mecanismo de inteligência de documentosmistral_ocr
- Use Mistral OCR Engine
- Descrição: Define o mecanismo de extração de conteúdo para usar para ingestão de documentos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
MISTRAL_OCR_API_KEY
- Tipo:
str
- Padrão:
None
- Descrição: Especifica a tecla API MISTRAL OCR a ser usada.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
EXTERNAL_DOCUMENT_LOADER_URL
- Tipo:
str
- Padrão:
None
- Descrição: Define o URL para o serviço de carregador de documentos externos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
EXTERNAL_DOCUMENT_LOADER_API_KEY
- Tipo:
str
- Padrão:
None
- Descrição: Define a tecla API para autenticar com o serviço de carregador de documentos externos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
TIKA_SERVER_URL
- Tipo:
str
- Padrão:
http://localhost:9998
- Descrição: Defina o URL para o servidor Apache Tika.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
DOCLING_SERVER_URL
- Tipo:
str
- Padrão:
http://docling:5001
- Descrição: Especifica o URL para o servidor de documentos. Requer documentos da versão 1.0.0 ou posterior.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
DOCLING_OCR_ENGINE
- Tipo:
str
- Padrão:
tesseract
- Descrição: Especifica o mecanismo OCR usado pela documentação.
Os valores suportados incluem:tesseract
(padrão),easyocr
, Assim,ocrmac
, Assim,rapidocr
, etesserocr
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
DOCLING_OCR_LANG
- Tipo:
str
- Padrão:
eng,fra,deu,spa
(Ao usar o padrãotesseract
motor) - Descrição: Especifica o (s) idioma (s) OCR a ser usado com o configurado
DOCLING_OCR_ENGINE
O formato e os códigos de linguagem disponíveis dependem do mecanismo OCR selecionado. - Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Geração Aumentada Recuperação (RAG)
RAG_EMBEDDING_ENGINE
- Tipo:
str
- Opções:
- Deixe vazio para
Default (SentenceTransformers)
- usa o Sendencetransformers para incorporações. ollama
- Usa a API Ollama para incorporações.openai
- usa a API OpenAI para incorporações.
- Deixe vazio para
- Descrição: seleciona um mecanismo de incorporação para usar para RAG.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_EMBEDDING_MODEL
- Tipo:
str
- Padrão:
sentence-transformers/all-MiniLM-L6-v2
- Descrição: Define um modelo para incorporação. Localmente, um modelo de transformador de frase é usado.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_RAG_HYBRID_SEARCH
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa o uso de pesquisa de conjunto com
BM25
ChromaDB
, com reranger usandosentence_transformers
modelos. - Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_TOP_K
- Tipo:
int
- Padrão:
3
- Descrição: Define o número padrão de resultados a serem considerados para a incorporação ao usar RAG.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_TOP_K_RERANKER
- Tipo:
int
- Padrão:
3
- Descrição: Define o número padrão de resultados a serem considerados para o Reranker ao usar o RAG.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_RELEVANCE_THRESHOLD
- Tipo:
float
- Padrão:
0.0
- Descrição: Define o limite de relevância a ser considerado para documentos quando usado com reranger.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_HYBRID_BM25_WEIGHT
- Tipo:
float
- Padrão:
0.5
- Descrição: define o peso dado à pesquisa de palavras -chave (BM25) durante a pesquisa híbrida. 1 significa apenas uma palavra -chave serach, 0 significa apenas pesquisa vetorial.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_TEMPLATE
- Tipo:
str
- Padrão: o valor de
DEFAULT_RAG_TEMPLATE
variável de ambiente.
DEFAULT_RAG_TEMPLATE
### Tarefa:
Responda à consulta do usuário usando o contexto fornecido, incorporando citações embutidas no formato [id] ** somente quando a tag <OrceM> inclui um atributo de identificação explícito ** (por exemplo, <fonte de origem = "1">).
Diretrizes ###:
- Se você não sabe a resposta, afirme claramente isso.
- Se incerto, peça esclarecimento ao usuário.
- Responda no mesmo idioma que a consulta do usuário.
- Se o contexto for ilegível ou de baixa qualidade, informe o usuário e forneça a melhor resposta possível.
- Se a resposta não estiver presente no contexto, mas você possui o conhecimento, explique isso ao usuário e forneça a resposta usando seu próprio entendimento.
- ** Inclua apenas citações embutidas usando [ID] (por exemplo, [1], [2]) quando a tag <OrceM> inclui um atributo de identificação. **
- Não cite se a tag <Orper> não contiver um atributo de ID.
- Não use tags XML em sua resposta.
- Verifique se as citações são concisas e diretamente relacionadas às informações fornecidas.
### Exemplo de citação:
Se o usuário perguntar sobre um tópico específico e as informações são encontradas em uma fonte com um atributo de identificação fornecido, a resposta deve incluir a citação como no exemplo a seguir:
* "De acordo com o estudo, o método proposto aumenta a eficiência em 20% [1]".
### Saída:
Forneça uma resposta clara e direta à consulta do usuário, incluindo citações embutidas no formato [id] somente quando a tag <Oprom> com o atributo ID estiver presente no contexto.
<context>
{{CONTEXT}}
</context>
<user_query>
{{QUERY}}
</user_query>
- Descrição: modelo a ser usado ao injetar documentos de pano na conclusão do bate -papo
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_TEXT_SPLITTER
- Tipo:
str
- Opções:
character
token
- Padrão:
character
- Descrição: Define o divisor de texto para modelos de pano.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
TIKTOKEN_CACHE_DIR
- Tipo:
str
- Padrão:
{CACHE_DIR}/tiktoken
- Descrição: Define o diretório para o cache Tiktoken.
TIKTOKEN_ENCODING_NAME
- Tipo:
str
- Padrão:
cl100k_base
- Descrição: Define o nome da codificação para Tiktoken.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CHUNK_SIZE
- Tipo:
int
- Padrão:
1000
- Descrição: Define o tamanho do documento para incorporação.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
CHUNK_OVERLAP
- Tipo:
int
- Padrão:
100
- Descrição: Especifica quanta sobreposição deve haver entre pedaços.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
PDF_EXTRACT_IMAGES
- Tipo:
bool
- Padrão:
False
- Descrição: Extrai imagens de PDFs usando OCR ao carregar documentos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_FILE_MAX_SIZE
- Tipo:
int
- Descrição: Define o tamanho máximo de um arquivo em megabytes que podem ser carregados para ingestão de documentos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_FILE_MAX_COUNT
- Tipo:
int
- Descrição: Define o número máximo de arquivos que podem ser carregados de uma só vez para ingestão de documentos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Ao configurarRAG_FILE_MAX_SIZE
eRAG_FILE_MAX_COUNT
, verifique se os valores são razoáveis para evitar uploads excessivos de arquivos e possíveis problemas de desempenho.
RAG_ALLOWED_FILE_EXTENSIONS
- Tipo:
list
destr
- Padrão:
[]
(o que significa que todos os tipos de arquivo suportados são permitidos) - Descrição: Especifica quais extensões de arquivo são permitidas para upload.
[["PDF, docx, txt"
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_RERANKING_MODEL
- Tipo:
str
- Descrição: Define um modelo para os resultados de reranger. Localmente, um modelo de transformador de frase é usado.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_OPENAI_API_BASE_URL
- Tipo:
str
- Padrão:
${OPENAI_API_BASE_URL}
- Descrição: Define o URL da API base do OpenAI para usar para incorporação de trapos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_OPENAI_API_KEY
- Tipo:
str
- Padrão:
${OPENAI_API_KEY}
- Descrição: Define a chave da API OpenAI a ser usada para incorporação de trapos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_EMBEDDING_OPENAI_BATCH_SIZE
- Tipo:
int
- Padrão:
1
- Descrição: Define o tamanho do lote para o OpenAi incorporando.
RAG_EMBEDDING_BATCH_SIZE
- Tipo:
int
- Padrão:
1
- Descrição: Define o tamanho do lote para incorporação em modelos RAG (Gerador de Recuperação Urbmentado).
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_OLLAMA_API_KEY
- Tipo:
str
- Descrição: Define a chave da API para a API Ollama usada nos modelos RAG.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_OLLAMA_BASE_URL
- Tipo:
str
- Descrição: Define o URL base para a API Ollama usada em modelos RAG.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_RETRIEVAL_QUERY_GENERATION
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa a geração de consultas de recuperação.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
QUERY_GENERATION_PROMPT_TEMPLATE
- Tipo:
str
- Padrão: o valor de
DEFAULT_QUERY_GENERATION_PROMPT_TEMPLATE
variável de ambiente.
DEFAULT_QUERY_GENERATION_PROMPT_TEMPLATE
### Tarefa:
Analise o histórico de bate -papo para determinar a necessidade de gerar consultas de pesquisa, no idioma especificado. Por padrão, ** priorize a geração de 1-3 consultas de pesquisa amplas e relevantes **, a menos que seja absolutamente certo que nenhuma informação adicional seja necessária. O objetivo é recuperar informações abrangentes, atualizadas e valiosas, mesmo com incerteza mínima. Se nenhuma pesquisa for inequivocamente necessária, retorne uma lista vazia.
Diretrizes ###:
- Responda ** exclusivamente ** com um objeto JSON. Qualquer forma de comentário extra, explicação ou texto adicional é estritamente proibido.
- Ao gerar consultas de pesquisa, responda no formato: {"Queries": ["Query1", "Query2"]}, garantindo que cada consulta seja distinta, concisa e relevante para o tópico.
- se e somente se estiver totalmente certo de que nenhum resultado útil possa ser recuperado por uma pesquisa, retorne: {"consultas": []}.
- Err do lado de sugerir consultas de pesquisa se houver ** alguma chance ** Eles podem fornecer informações úteis ou atualizadas.
- Seja conciso e focado na composição de consultas de pesquisa de alta qualidade, evitando elaboração, comentário ou suposições desnecessárias.
- A data de hoje é: {{current_date}}.
- Sempre priorize o fornecimento de consultas acionáveis e amplas que maximizam a cobertura informativa.
### Saída:
Retornar estritamente no formato JSON:
{
"Consultas": ["Query1", "Query2"]
Histórico de bate -papo:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>
- Descrição: Define o modelo de prompt para geração de consulta.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
BYPASS_EMBEDDING_AND_RETRIEVAL
- Tipo:
bool
- Padrão:
False
- Descrição: ignora o processo de incorporação e recuperação.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
DOCUMENT_INTELLIGENCE_ENDPOINT
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o terminal para a inteligência do documento.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
DOCUMENT_INTELLIGENCE_KEY
- Tipo:
str
- Padrão:
None
- Descrição: Especifica a chave para a inteligência do documento.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_RAG_LOCAL_WEB_FETCH
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa a busca local da Web para RAG.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_EMBEDDING_CONTENT_PREFIX
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o prefixo para o conteúdo de incorporação de RAG.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_EMBEDDING_PREFIX_FIELD_NAME
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o nome do campo para o prefixo de incorporação de RAG.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_EMBEDDING_QUERY_PREFIX
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o prefixo para a consulta de incorporação de RAG.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
RAG_FULL_CONTEXT
- Tipo:
bool
- Padrão:
False
- Descrição: Especifica se deve usar o contexto completo para RAG.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Google Drive
ENABLE_GOOGLE_DRIVE_INTEGRATION
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa a integração do Google Drive. Se definido como true, e
GOOGLE_DRIVE_CLIENT_ID
GOOGLE_DRIVE_API_KEY
estão configurados, o Google Drive aparecerá como uma opção de upload na interface do usuário de bate -papo. - Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Ao ativarGOOGLE_DRIVE_INTEGRATION
, verifique se você configurouGOOGLE_DRIVE_CLIENT_ID
eGOOGLE_DRIVE_API_KEY
Corretamente, e revisou as diretrizes dos Termos de Serviço e Uso do Google.
GOOGLE_DRIVE_CLIENT_ID
- Tipo:
str
- Descrição: Define o ID do cliente para o Google Drive (o cliente deve ser configurado com a API de unidade e a API do selecionador ativada).
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
GOOGLE_DRIVE_API_KEY
- Tipo:
str
- Descrição: Define a tecla API para a integração do Google Drive.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OneDrive
ENABLE_ONEDRIVE_INTEGRATION
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa a integração do OneDrive.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ONEDRIVE_CLIENT_ID
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o ID do cliente para a integração OneDrive.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ONEDRIVE_SHAREPOINT_URL
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o URL do site do SharePoint para integração OneDrive, p.https://companyname.sharepoint.com
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ONEDRIVE_SHAREPOINT_TENANT_ID
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o ID do inquilino do SharePoint para a integração do OneDrive.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Pesquisa na web
ENABLE_WEB_SEARCH
- Tipo:
bool
- Padrão:
False
- Descrição: Ativar alternância de pesquisa na web.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_SEARCH_QUERY_GENERATION
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa a geração de consultas de pesquisa.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
WEB_SEARCH_TRUST_ENV
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa o proxy definido por
http_proxy
ehttps_proxy
Durante a busca de conteúdo de pesquisa na web. - Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
WEB_SEARCH_RESULT_COUNT
- Tipo:
int
- Padrão:
3
- Descrição: Número máximo de resultados de pesquisa para rastejar.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
WEB_LOADER_CONCURRENT_REQUESTS
- Tipo:
int
- Padrão:
10
- Descrição: Especifica o número de solicitações simultâneas usadas pelo carregador da Web para buscar conteúdo nas páginas da Web retornadas pelos resultados da pesquisa. Isso afeta diretamente quantas páginas podem ser rastejadas simultaneamente.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Essa variável de ambiente foi nomeada anteriormente "web_search_concurrent_requests". Se você estava usando o nome antigo, atualize suas configurações para usar "web_loader_concurrent_requests", pois o nome da variável antigo agora está obsoleto e não será reconhecido. Essa renomeação esclarece sua função, pois controla especificamente a simultaneidade da webcarregadorComponente que busca conteúdo dos resultados da pesquisa, não a consulta inicial do mecanismo de pesquisa.
WEB_SEARCH_ENGINE
- Tipo:
str
- Opções:
searxng
- usa oSearxngmecanismo de pesquisa.google_pse
- usa oMecanismo de pesquisa programável do Googlebrave
- usa oBrave Search Enginekagi
- usa oKagimecanismo de pesquisa.mojeek
- usa oMojeekmecanismo de pesquisa.bocha
- usa o mecanismo de pesquisa da Bocha.serpstack
- usa oSerpstackmecanismo de pesquisa.serper
- usa oSerepermecanismo de pesquisa.serply
- usa oSerplicomecanismo de pesquisa.searchapi
- usa oSearchapimecanismo de pesquisa.serpapi
- usa oSerpapimecanismo de pesquisa.duckduckgo
- usa oDuckduckgomecanismo de pesquisa.tavily
- usa oTavilymecanismo de pesquisa.jina
- usa oJinamecanismo de pesquisa.bing
- usa oBingmecanismo de pesquisa.exa
- usa oExamecanismo de pesquisa.perplexity
- usa oPerplexidade aimecanismo de pesquisa.sougou
- usa oSougoumecanismo de pesquisa.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL
- Tipo:
bool
- Padrão:
False
- Descrição: ignora o processo de incorporação e recuperação de pesquisa da Web.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
SEARXNG_QUERY_URL
- Tipo:
str
- Descrição: oAPI de pesquisa searxngURL que suporta saída JSON.
<query>
é substituído por a consulta de pesquisa. Exemplo:http://searxng.local/search?q=<query>
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
GOOGLE_PSE_API_KEY
- Tipo:
str
- Descrição: Define a tecla API para o serviço de mecanismo de pesquisa programável do Google (PSE).
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
GOOGLE_PSE_ENGINE_ID
- Tipo:
str
- Descrição: O ID do mecanismo para o serviço PSE (Google Programmable Search Engine (PSE).
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
BRAVE_SEARCH_API_KEY
- Tipo:
str
- Descrição: Define a tecla API para a API de pesquisa corajosa.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
KAGI_SEARCH_API_KEY
- Tipo:
str
- Descrição: Define a chave da API para a API de pesquisa KAGI.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
MOJEEK_SEARCH_API_KEY
- Tipo:
str
- Descrição: Define a tecla API para a API de pesquisa de mojeek.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
SERPSTACK_API_KEY
- Tipo:
str
- Descrição: Define a tecla API para a API de pesquisa de serpstack.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
SERPSTACK_HTTPS
- Tipo:
bool
- Padrão:
True
- Descrição: configura o uso de https para solicitações de serpstack. As solicitações de nível gratuitas são restritas apenas a HTTP.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
SERPER_API_KEY
- Tipo:
str
- Descrição: Define a tecla API para a API de pesquisa de Sereper.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
SERPLY_API_KEY
- Tipo:
str
- Descrição: Define a tecla API para a API de pesquisa serplica.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
SEARCHAPI_API_KEY
- Tipo:
str
- Descrição: Define a tecla API para pesquisa.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
SEARCHAPI_ENGINE
- Tipo:
str
- Descrição: define o mecanismo de pesquisa.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
TAVILY_API_KEY
- Tipo:
str
- Descrição: Define a tecla API para a API de pesquisa de Tavily.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
JINA_API_KEY
- Tipo:
str
- Descrição: define a chave da API para Jina.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
BING_SEARCH_V7_ENDPOINT
- Tipo:
str
- Descrição: Define o terminal da API de pesquisa do Bing.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
BING_SEARCH_V7_SUBSCRIPTION_KEY
- Tipo:
str
- Padrão:
https://api.bing.microsoft.com/v7.0/search
- Descrição: Define a chave de assinatura para a API de pesquisa do Bing.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
BOCHA_SEARCH_API_KEY
- Tipo:
str
- Padrão:
None
- Descrição: Define a tecla API para a API de pesquisa da Bocha.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
EXA_API_KEY
- Tipo:
str
- Padrão:
None
- Descrição: Define a tecla API para API de pesquisa exA.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
SERPAPI_API_KEY
- Tipo:
str
- Padrão:
None
- Descrição: Define a tecla API para Serpapi.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
SERPAPI_ENGINE
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o mecanismo de pesquisa a ser usado para Serpapi.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
SOUGOU_API_SID
- Tipo:
str
- Padrão:
None
- Descrição: define a API SOGOU SID.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
SOUGOU_API_SK
- Tipo:
str
- Padrão:
None
- Descrição: Define a API SOGOU SK.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
TAVILY_EXTRACT_DEPTH
- Tipo:
str
- Padrão:
basic
- Descrição: Especifica a profundidade do extrato para os resultados da pesquisa de Tavily.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Configuração do carregador da web
WEB_LOADER_ENGINE
- Tipo:
str
- Padrão:
safe_web
- Descrição: Especifica o carregador a ser usado para recuperar e processar o conteúdo da Web.
- Opções:
requests
- usa o módulo de solicitações com manipulação de erros aprimorada.playwright
- usa dramaturgo para renderização e interação mais avançadas da Web.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Ao usarplaywright
, você tem duas opções:
- Se
PLAYWRIGHT_WS_URI
não está definido, dramaturgo com dependências de cromo será instalado automaticamente no contêiner aberto webui no lançamento. - Se
PLAYWRIGHT_WS_URI
está definido, o Nullcore se conectará a uma instância do navegador remoto em vez de instalar dependências localmente.
PLAYWRIGHT_WS_URL
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o URI WebSocket de uma instância do navegador de dramaturgo remoto. Quando definido, o Nullcore usará este navegador remoto em vez de instalar dependências do navegador localmente. Isso é particularmente útil em ambientes de contêiner, onde você deseja manter as preocupações de navegador leves e separadas do WebUI. Exemplo:
ws://playwright:3000
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Usando um navegador de dramaturgo remoto viaPLAYWRIGHT_WS_URL
pode ser benéfico para:
- Reduzindo o tamanho do contêiner aberto webui
- Usando um navegador diferente diferente do cromo padrão
- Conectando-se a um navegador não imutável (GUI)
FIRECRAWL_API_BASE_URL
- Tipo:
str
- Padrão:
https://api.firecrawl.dev
- Descrição: Define o URL base da API Firecrawl.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
FIRECRAWL_API_KEY
- Tipo:
str
- Padrão:
None
- Descrição: Define a chave da API para a API Firecrawl.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
PERPLEXITY_API_KEY
- Tipo:
str
- Padrão:
None
- Descrição: Define a chave da API para API Perplexity.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
PLAYWRIGHT_TIMEOUT
- Tipo:
int
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Especifica o tempo limite para solicitações de dramaturgo.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Carregador do youtube
YOUTUBE_LOADER_PROXY_URL
- Tipo:
str
- Descrição: Define o URL proxy para o carregador do YouTube.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
YOUTUBE_LOADER_LANGUAGE
- Tipo:
str
- Padrão:
en
- Descrição: Lista de códigos de idioma separada por vírgula para tentar buscar transcrições de vídeo do YouTube, em ordem prioritária.
- Exemplo: se definido como
es,de
, As transcrições espanholas serão tentadas primeiro, depois o alemão se o espanhol não estivesse disponível e, finalmente, inglês. Nota: Se nenhum dos idiomas especificados estiver disponível een
Não estava na sua lista, o sistema tentará automaticamente o inglês como fallback final. - Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Áudio
Sussurro de fala para texto (local)
WHISPER_MODEL
- Tipo:
str
- Padrão:
base
- Descrição: Define o modelo Whisper a ser usado para o texto. O back -end usado é mais rápido, que é com quantização para
int8
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
WHISPER_MODEL_DIR
- Tipo:
str
- Padrão:
${DATA_DIR}/cache/whisper/models
- Descrição: Especifica o diretório para armazenar arquivos de modelo Whisper.
WHISPER_VAD_FILTER
- Tipo:
bool
- Padrão:
False
- Descrição: Especifica se a aplicação de um filtro de detecção de atividade de voz (VAD) para sussurrar fala para texto.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
WHISPER_MODEL_AUTO_UPDATE
- Tipo:
bool
- Padrão:
False
- Descrição: Alterna a atualização automática do modelo de sussurro.
WHISPER_LANGUAGE
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o Whisper ISO 639-1 Language Usa para STT (ISO 639-2 para havaiano e cantonês). Whisper prevê o idioma por padrão.
Fala para texto (OpenAI)
AUDIO_STT_ENGINE
- Tipo:
str
- Opções:
- Deixe vazio para usar o mecanismo de sussurros locais embutidos para o texto.
openai
-Usa o mecanismo OpenAi para o texto para texto.deepgram
-usa o mecanismo Deepgram para o texto para texto.azure
Usa o motor do Azure para o texto para texto.
- Descrição: Especifica o mecanismo de fala para texto a ser usado.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUDIO_STT_MODEL
- Tipo:
str
- Padrão:
whisper-1
- Descrição: Especifica o modelo de fala para texto a ser usado para pontos de extremidade compatíveis com o OpenAI.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUDIO_STT_OPENAI_API_BASE_URL
- Tipo:
str
- Padrão:
${OPENAI_API_BASE_URL}
- Descrição: Define o URL base compatível com o OpenAI para usar para o texto.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUDIO_STT_OPENAI_API_KEY
- Tipo:
str
- Padrão:
${OPENAI_API_KEY}
- Descrição: Define a chave da API do OpenAI a ser usada para texto para texto.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Fala para texto (Azure)
AUDIO_STT_AZURE_API_KEY
- Tipo:
str
- Padrão:
None
- Descrição: Especifica a chave da API do Azure a ser usada para texto para texto.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUDIO_STT_AZURE_REGION
- Tipo:
str
- Padrão:
None
- Descrição: Especifica a região do Azure a ser usada para o texto a texto.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUDIO_STT_AZURE_LOCALES
- Tipo:
str
- Padrão:
None
- Descrição: Especifica os locais a serem usados para o Azure Spean-Text.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Fala para texto (Deepgram)
DEEPGRAM_API_KEY
- Tipo:
str
- Padrão:
None
- Descrição: Especifica a chave API Deepgram a ser usada para o texto em texto.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Texto para fala
AUDIO_TTS_API_KEY
- Tipo:
str
- Descrição: Define a tecla API para falar em fala.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUDIO_TTS_ENGINE
- Tipo:
str
- Opções:
- Deixe vazio para usar o mecanismo webapi embutido para falar em fala.
azure
-Usa o motor do Azure para falar em fala.elevenlabs
-usa o motor Elevenlabs para falar em fala em falaopenai
-Usa o mecanismo OpenAI para fala em fala.transformers
-usa o Sendencetransformers para o texto em fala.
- Descrição: Especifica o mecanismo de texto em fala a ser usado.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUDIO_TTS_MODEL
- Tipo:
str
- Padrão:
tts-1
- Descrição: Especifica o modelo de texto em fala do OpenAI a ser usado.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUDIO_TTS_VOICE
- Tipo:
str
- Padrão:
alloy
- Descrição: Define a voz de texto em fala do OpenAI para usar.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUDIO_TTS_SPLIT_ON
- Tipo:
str
- Padrão:
punctuation
- Descrição: Define a divisão de texto em fala do OpenAI para uso.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Azure Texto-fala
AUDIO_TTS_AZURE_SPEECH_REGION
- Tipo:
str
- Descrição: define a região para o texto do Azure para a fala.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT
- Tipo:
str
- Descrição: Define o formato de saída para o texto do Azure para a fala.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OpeniAI Text-to-fala
AUDIO_TTS_OPENAI_API_BASE_URL
- Tipo:
str
- Padrão:
${OPENAI_API_BASE_URL}
- Descrição: Define o URL de base compatível com o OpenAI para usar para falar o texto em fala.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUDIO_TTS_OPENAI_API_KEY
- Tipo:
str
- Padrão:
${OPENAI_API_KEY}
- Descrição: Define a tecla API a ser usada para falar em fala.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Geração de imagens
IMAGE_GENERATION_ENGINE
- Tipo:
str
- Opções:
openai
- Usa o OpenAI Dall-E para geração de imagens.comfyui
- Usa o mecanismo conformável para geração de imagens.automatic1111
- Usa o motor1111111111 para geração de imagens.gemini
- usa Gêmeos para geração de imagens.
- Padrão:
openai
- Descrição: Especifica o mecanismo a ser usado para geração de imagens.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_IMAGE_GENERATION
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa os recursos de geração de imagens.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_IMAGE_PROMPT_GENERATION
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa a geração de prompt de imagem.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o modelo a ser usado para gerar prompts de imagem.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
DEFAULT_IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE
### Tarefa:
Gere um prompt detalhado para a tarefa de geração de imagens AM com base no idioma e no contexto fornecidos. Descreva a imagem como se você estivesse explicando para alguém que não pode vê -la. Inclua detalhes relevantes, cores, formas e quaisquer outros elementos importantes.
Diretrizes ###:
- Seja descritivo e detalhado, com foco nos aspectos mais importantes da imagem.
- Evite fazer suposições ou adicionar informações não presentes na imagem.
- Use o idioma principal do bate -papo; Padrão para o inglês se multilíngue.
- Se a imagem for muito complexa, concentre -se nos elementos mais proeminentes.
### Saída:
Retornar estritamente no formato JSON:
{
"Prompt": "Sua descrição detalhada aqui".
Histórico de bate -papo:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>
IMAGE_SIZE
- Tipo:
str
- Padrão:
512x512
- Descrição: Define o tamanho da imagem padrão a ser gerado.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
IMAGE_STEPS
- Tipo:
int
- Padrão:
50
- Descrição: Define as etapas de iteração padrão para a geração de imagens. Usado para conforfyui e automático1111.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
IMAGE_GENERATION_MODEL
- Tipo:
str
- Descrição: Modelo padrão a ser usado para geração de imagens
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Automatic1111
AUTOMATIC1111_BASE_URL
- Tipo:
str
- Descrição: Especifica o URL para a API de difusão estável do Automatic1111.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUTOMATIC1111_API_AUTH
- Tipo:
str
- Descrição: Define a autenticação Automatic1111 API.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUTOMATIC1111_CFG_SCALE
- Tipo:
float
- Descrição: Define a escala para a inferência Automatic1111.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUTOMATIC1111_SAMPLER
- Tipo:
str
- Descrição: Define o amostrador para inferência automática111111.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
AUTOMATIC1111_SCHEDULER
- Tipo:
str
- Descrição: Define o agendador para a inferência Automatic1111.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Comfyui
COMFYUI_BASE_URL
- Tipo:
str
- Descrição: Especifica o URL para a API de geração de imagem confortável.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
COMFYUI_API_KEY
- Tipo:
str
- Descrição: Define a tecla API para conformyui.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
COMFYUI_WORKFLOW
- Tipo:
str
- Padrão:
{
"3": {
"Entradas": {
"semente": 0,
"Etapas": 20,
"CFG": 8,
"sampler_name": "euler",
"Agendador": "Normal",
"Denoise": 1,
"modelo": [
"4",
0
"positivo": [
"6",
0
"negativo": [
"7",
0
"Latent_image": [
"5",
0
"Class_type": "Ksampler",
"_meta": {
"Title": "Ksampler"
"4": {
"Entradas": {
"CKPT_NAME": "Model.Safetetensors"
"Class_type": "CheckPointLoaderSIMPLE",
"_meta": {
"Title": "Carreging Checkpoint"
"5": {
"Entradas": {
"Largura": 512,
"Altura": 512,
"Batch_size": 1
"Class_type": "EmpurtyTentImage",
"_meta": {
"Title": "Imagem latente vazia"
"6": {
"Entradas": {
"Texto": "Prompt",
"Clip": [
"4",
1
"class_type": "cliptextencode",
"_meta": {
"Title": "Clip Text Encode (Prompt)"
"7": {
"Entradas": {
"texto": "",
"Clip": [
"4",
1
"class_type": "cliptextencode",
"_meta": {
"Title": "Clip Text Encode (Prompt)"
"8": {
"Entradas": {
"Amostras": [
"3",
0
"VAE": [
"4",
2
"Class_type": "VAEDECODE",
"_meta": {
"Título": "Vae decodifica"
"9": {
"Entradas": {
"FILENAME_PREFIX": "Comfyui",
"Imagens": [
"8",
0
"Class_type": "SaveImage",
"_meta": {
"Título": "Salvar imagem"
- Descrição: Define o fluxo de trabalho confortável.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Gêmeos
GEMINI_API_BASE_URL
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o URL da API de Gêmeos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
GEMINI_API_KEY
- Tipo:
str
- Padrão:
None
- Descrição: Define a tecla API Gemini.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
IMAGES_GEMINI_API_BASE_URL
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o URL da API de geração de imagem de Gêmeos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
IMAGES_GEMINI_API_KEY
- Tipo:
str
- Padrão:
None
- Descrição: Define a tecla API Gemini para geração de imagens.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Openai Dall-e
IMAGES_OPENAI_API_BASE_URL
- Tipo:
str
- Padrão:
${OPENAI_API_BASE_URL}
- Descrição: Define o URL base compatível com o OpenAI para usar para a geração de imagens Dall-E.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
IMAGES_OPENAI_API_KEY
- Tipo:
str
- Padrão:
${OPENAI_API_KEY}
- Descrição: Define a chave da API a ser usada para a geração de imagens Dall-E.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Oauth
Você só pode configurar um provedor de OAuth por vez. Você não pode ter dois ou mais provedores de OAuth configurados simultaneamente.
ENABLE_OAUTH_SIGNUP
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa a criação da conta ao se inscrever via OAuth. Distinto de
ENABLE_SIGNUP
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_LOGIN_FORM
deve ser definido comoFalse
quandoENABLE_OAUTH_SIGNUP
está definido comoTrue
. Não fazer isso resultará na incapacidade de fazer o login.
ENABLE_OAUTH_PERSISTENT_CONFIG
- Tipo:
bool
- Padrão:
True
- Descrição: Controla se as configurações relacionadas ao OAuth são persistidas no banco de dados após o primeiro lançamento.
Por padrão, as configurações do OAuth são armazenadas no banco de dados e gerenciadas através do painel de administração após a configuração inicial. Defina esta variável paraFalse
Para forçar a abertura de webui asempreLeia as configurações do OAuth das variáveis de ambiente em cada reinicialização. Isso é ideal para ambientes usando gitops ou infraestrutura imutável, onde a configuração é gerenciada exclusivamente por meio de arquivos externos (por exemplo, Docker Compose, Kubernetes Configmaps).
OAUTH_SUB_CLAIM
- Tipo:
str
- Padrão:
None
- Descrição: substitui a reivindicação padrão usada para identificar o ID exclusivo de um usuário (
sub
) da resposta de informações do usuário do OAuth/OIDC. Por padrão, o Nullcore tenta inferir isso na configuração do provedor. Essa variável permite especificar explicitamente qual reivindicação usar. Por exemplo, se o seu provedor de identidade usar 'funcionário_id' como o identificador exclusivo, você definiria essa variável como 'funcionário_id'. - Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OAUTH_MERGE_ACCOUNTS_BY_EMAIL
- Tipo:
bool
- Padrão:
False
- Descrição: Se ativado, mescla contas do OAuth com contas existentes usando o mesmo email endereço. Isso é considerado inseguro, pois nem todos os provedores da OAuth verificarão endereços de email e podem levar a possíveis aquisições de conta.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OAUTH_UPDATE_PICTURE_ON_LOGIN
- Tipo:
bool
- Padrão:
False
- Descrição: Se ativado, atualiza a imagem do perfil de usuário local com a imagem fornecida pelo OAuth no login.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Se a reivindicação de imagem do OAuth estiver desativada, configurandoOAUTH_PICTURE_CLAIM
para''
(string vazia) e, em seguida, definir esta variável comotrue
não atualizará as imagens do perfil do usuário.
WEBUI_AUTH_TRUSTED_EMAIL_HEADER
- Tipo:
str
- Descrição: Define o cabeçalho de solicitação confiável para autenticação. VerSSO Docs
WEBUI_AUTH_TRUSTED_NAME_HEADER
- Tipo:
str
- Descrição: define o cabeçalho de solicitação confiável para o nome de usuário de qualquer pessoa que se registre no
WEBUI_AUTH_TRUSTED_EMAIL_HEADER
cabeçalho. VerSSO Docs
WEBUI_AUTH_TRUSTED_GROUPS_HEADER
- Tipo:
str
- Descrição: Define o cabeçalho da solicitação confiável que contém uma lista de associações de grupo separada por vírgula para o usuário ao usar a autenticação de cabeçalho confiável. VerSSO Docs
Verhttps://support.google.com/cloud/answer/6158849?hl=en
Você também deve definirOPENID_PROVIDER_URL
ou de outra forma o logout pode não funcionar.
GOOGLE_CLIENT_ID
- Tipo:
str
- Descrição: Define o ID do cliente para o Google OAuth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
GOOGLE_CLIENT_SECRET
- Tipo:
str
- Descrição: Define o segredo do cliente para o Google OAuth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
GOOGLE_OAUTH_SCOPE
- Tipo:
str
- Padrão:
openid email profile
- Descrição: Define o escopo da autenticação do Google OAuth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
GOOGLE_REDIRECT_URI
- Tipo:
str
- Padrão:
<backend>/oauth/google/callback
- Descrição: Define o URI de redirecionamento para o Google OAuth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Microsoft
Verhttps://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app
Você também deve definirOPENID_PROVIDER_URL
ou de outra forma o logout pode não funcionar.
MICROSOFT_CLIENT_ID
- Tipo:
str
- Descrição: Define o ID do cliente para Microsoft OAuth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
MICROSOFT_CLIENT_SECRET
- Tipo:
str
- Descrição: Define o segredo do cliente para Microsoft OAuth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
MICROSOFT_CLIENT_TENANT_ID
- Tipo:
str
- Descrição: Define o ID do inquilino para Microsoft OAuth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
MICROSOFT_OAUTH_SCOPE
- Tipo:
str
- Padrão:
openid email profile
- Descrição: Define o escopo da autenticação Microsoft OAuth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
MICROSOFT_REDIRECT_URI
- Tipo:
str
- Padrão:
<backend>/oauth/microsoft/callback
- Descrição: Define o URI de redirecionamento para Microsoft OAuth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Github
Verhttps://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps
Você também deve definirOPENID_PROVIDER_URL
ou de outra forma o logout pode não funcionar.
GITHUB_CLIENT_ID
- Tipo:
str
- Descrição: Define o ID do cliente para Github Oauth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
GITHUB_CLIENT_SECRET
- Tipo:
str
- Descrição: Define o segredo do cliente para Github Oauth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
GITHUB_CLIENT_SCOPE
- Tipo:
str
- Padrão:
user:email
- Descrição: Especifica o escopo da autenticação Github Oauth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
GITHUB_CLIENT_REDIRECT_URI
- Tipo:
str
- Padrão:
<backend>/oauth/github/callback
- Descrição: Define o URI de redirecionamento para Github Oauth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OpenID (OIDC)
OAUTH_CLIENT_ID
- Tipo:
str
- Descrição: Define o ID do cliente para OIDC.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OAUTH_CLIENT_SECRET
- Tipo:
str
- Descrição: Define o segredo do cliente para OIDC.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OPENID_PROVIDER_URL
- Tipo:
str
- Descrição: caminho para o
.well-known/openid-configuration
endpoint - Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
A variável de ambienteOPENID_PROVIDER_URL
Deve ser configurado, caso contrário, a funcionalidade de logout não funcionará para a maioria dos fornecedores.
Mesmo ao usar a Microsoft, Github ou outros provedores, você deve definir oOPENID_PROVIDER_URL
variável de ambiente.
OPENID_REDIRECT_URI
- Tipo:
str
- Padrão:
<backend>/oauth/oidc/callback
- Descrição: define o URI de redirecionamento para OIDC
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OAUTH_SCOPES
- Tipo:
str
- Padrão:
openid email profile
- Descrição: Define o escopo para a autenticação OIDC.
openid
eemail
são necessários. - Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OAUTH_CODE_CHALLENGE_METHOD
- Tipo:
str
- Padrão: String vazio (''), desde
None
é definido como padrão. - Descrição: Especifica o método do desafio do código para a autenticação OAuth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OAUTH_PROVIDER_NAME
- Tipo:
str
- Padrão:
SSO
- Descrição: Define o nome do provedor OIDC.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OAUTH_USERNAME_CLAIM
- Tipo:
str
- Padrão:
name
- Descrição: Defina o nome de usuário reivindicação para o OpenID.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OAUTH_EMAIL_CLAIM
- Tipo:
str
- Padrão:
email
- Descrição: Defina a reivindicação de email para OpenID.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OAUTH_PICTURE_CLAIM
- Tipo:
str
- Padrão:
picture
- Descrição: Defina a reivindicação da imagem (avatar) para o OpenID.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
SeOAUTH_PICTURE_CLAIM
está definido como''
(String vazia), então a reivindicação de imagem do OAuth está desativada e as imagens do perfil do usuário não serão salvas.
OAUTH_GROUP_CLAIM
- Tipo:
str
- Padrão:
groups
- Descrição: Especifica a reivindicação do grupo para a autenticação OAuth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_OAUTH_ROLE_MANAGEMENT
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa o gerenciamento de função para a delegação do OAuth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_OAUTH_GROUP_MANAGEMENT
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa o gerenciamento do grupo OAuth.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OAUTH_ROLES_CLAIM
- Tipo:
str
- Padrão:
roles
- Descrição: Define as funções afirmam procurar no token OIDC.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OAUTH_ALLOWED_ROLES
- Tipo:
str
- Padrão:
user,admin
- Descrição: Define as funções que são permitidas acesso à plataforma.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OAUTH_ADMIN_ROLES
- Tipo:
str
- Padrão:
admin
- Descrição: Define as funções consideradas administradores.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
OAUTH_ALLOWED_DOMAINS
- Tipo:
str
- Padrão:
*
- Descrição: Especifica os domínios permitidos para a autenticação OAuth. (por exemplo, "exemplo1.com, exemplo2.com").
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP
ENABLE_LDAP
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa a autenticação LDAP.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_SERVER_LABEL
- Tipo:
str
- Descrição: Define o rótulo do servidor LDAP.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_SERVER_HOST
- Tipo:
str
- Padrão:
localhost
- Descrição: Define o nome do host do servidor LDAP.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_SERVER_PORT
- Tipo:
int
- Padrão:
389
- Descrição: define o número da porta do servidor LDAP.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_ATTRIBUTE_FOR_MAIL
- Tipo:
str
- Descrição: Define o atributo a ser usado como e -mail para autenticação LDAP.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_ATTRIBUTE_FOR_USERNAME
- Tipo:
str
- Descrição: Define o atributo a ser usado como um nome de usuário para a autenticação LDAP.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_APP_DN
- Tipo:
str
- Descrição: Define o nome distinto para o aplicativo LDAP.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_APP_PASSWORD
- Tipo:
str
- Descrição: define a senha para o aplicativo LDAP.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_SEARCH_BASE
- Tipo:
str
- Descrição: Define a base para pesquisar a autenticação LDAP.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_SEARCH_FILTER
- Tipo:
str
- Padrão:
None
- Descrição: Define um único filtro a ser usado para pesquisa LDAP. Alternativa a
LDAP_SEARCH_FILTERS
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_SEARCH_FILTERS
- Tipo:
str
- Descrição: Define o filtro a ser usado para pesquisa LDAP.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_USE_TLS
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa o TLS para a conexão LDAP.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_CA_CERT_FILE
- Tipo:
str
- Descrição: Define o caminho para o arquivo de certificado LDAP CA.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_VALIDATE_CERT
- Tipo:
bool
- Descrição: Defina se deve validar o certificado LDAP CA.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_CIPHERS
- Tipo:
str
- Padrão:
ALL
- Descrição: define as cifras a serem usadas para a conexão LDAP.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_LDAP_GROUP_MANAGEMENT
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa o recurso de gerenciamento de grupo.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
ENABLE_LDAP_GROUP_CREATION
- Tipo:
bool
- Padrão:
False
- Descrição: Se um grupo do LDAP não existir no Nullcore, ele será criado automaticamente.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
LDAP_ATTRIBUTE_FOR_GROUPS
- Tipo:
str
- Padrão:
memberOf
- Descrição: Especifica o atributo LDAP que contém as associações de grupo do usuário.
memberOf
é um atributo padrão para esse fim em ambientes do Active Directory. - Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Scim
SCIM_ENABLED
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa o suporte do SCIM 2.0 (Sistema para gerenciamento de identidade entre domínios) para provisionamento automatizado de usuários e grupos de provedores de identidade como OKTA, Azure AD e Google Workspace.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
SCIM_TOKEN
- Tipo:
str
- Padrão:
""
- Descrição: define o token do portador para autenticação SCIM. Este token deve ser fornecido pelos provedores de identidade ao fazer solicitações de API SCIM. Gerar um token aleatório seguro (por exemplo, usando
openssl rand -base64 32
) e configure -o no Webui aberto e no seu provedor de identidade. - Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Permissões de usuário
Permissões de bate -papo
USER_PERMISSIONS_CHAT_CONTROLS
- Tipo:
bool
- Padrão:
True
- Descrição: atua como uma chave mestre para ativar ou desativar o botão "controles" e painel principal na interface de bate -papo.Se isso estiver definido como falso, os usuários não verão o botão de controles e as permissões granulares abaixo não terão efeito
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_CHAT_VALVES
- Tipo:
bool
- Padrão:
True
- Descrição: Quando
USER_PERMISSIONS_CHAT_CONTROLS
está ativado, essa configuração controla especificamente a visibilidade da seção "Válvulas" no painel de controles de bate -papo.
USER_PERMISSIONS_CHAT_SYSTEM_PROMPT
- Tipo:
bool
- Padrão:
True
- Descrição: Quando
USER_PERMISSIONS_CHAT_CONTROLS
está ativado, essa configuração controla especificamente a visibilidade da seção personalizável "System Prompt" no painel controlos de bate -papo, pastas e configurações do usuário.
USER_PERMISSIONS_CHAT_PARAMS
- Tipo:
bool
- Padrão:
True
- Descrição: Quando
USER_PERMISSIONS_CHAT_CONTROLS
está ativado, essa configuração controla especificamente a visibilidade da seção "Parâmetros avançados" no painel de controles de bate -papo.
USER_PERMISSIONS_CHAT_FILE_UPLOAD
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa a permissão do usuário para fazer upload de arquivos para bate -papos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_CHAT_DELETE
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa a permissão do usuário para excluir bate -papos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_CHAT_EDIT
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa a permissão do usuário para editar bate -papos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_CHAT_STT
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa a permissão do usuário para usar o texto em texto em bate-papos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_CHAT_TTS
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa a permissão do usuário para usar o texto em fala em bate-papos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_CHAT_CALL
- Tipo:
str
- Padrão:
True
- Descrição: Ativa ou desativa a permissão do usuário para fazer chamadas nos bate -papos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_CHAT_MULTIPLE_MODELS
- Tipo:
str
- Padrão:
True
- Descrição: Ativa ou desativa a permissão do usuário para usar vários modelos em bate -papos.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_CHAT_TEMPORARY
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa ou desativa a permissão do usuário para criar bate -papos temporários.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_CHAT_TEMPORARY_ENFORCED
- Tipo:
str
- Padrão:
False
- Descrição: Ativa ou desativa os bate -papos temporários forçados para os usuários.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Características de características
USER_PERMISSIONS_FEATURES_DIRECT_TOOL_SERVERS
- Tipo:
str
- Padrão:
False
- Descrição: Ativa ou desativa a permissão do usuário para acessar servidores de ferramentas diretas.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_FEATURES_WEB_SEARCH
- Tipo:
str
- Padrão:
True
- Descrição: Ativa ou desativa a permissão do usuário para usar o recurso de pesquisa da Web.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_FEATURES_IMAGE_GENERATION
- Tipo:
str
- Padrão:
True
- Descrição: Ativa ou desativa a permissão do usuário para usar o recurso de geração de imagens.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_FEATURES_CODE_INTERPRETER
- Tipo:
str
- Padrão:
True
- Descrição: Ativa ou desativa a permissão do usuário para usar o recurso de intérprete de código.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Permissões de espaço de trabalho
USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa a permissão do usuário para acessar os modelos de espaço de trabalho.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa a permissão do usuário para acessar o conhecimento do espaço de trabalho.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa a permissão do usuário para acessar os prompts da área de trabalho.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa a permissão do usuário para acessar as ferramentas da área de trabalho.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_WORKSPACE_MODELS_ALLOW_PUBLIC_SHARING
- Tipo:
str
- Padrão:
False
- Descrição: Ativa ou desativa o compartilhamento público de modelos de espaço de trabalho.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ALLOW_PUBLIC_SHARING
- Tipo:
str
- Padrão:
False
- Descrição: Ativa ou desativa o compartilhamento público do conhecimento do espaço de trabalho.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_WORKSPACE_PROMPTS_ALLOW_PUBLIC_SHARING
- Tipo:
str
- Padrão:
False
- Descrição: Ativa ou desativa o compartilhamento público de avisos de espaço de trabalho.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
USER_PERMISSIONS_WORKSPACE_TOOLS_ALLOW_PUBLIC_SHARING
- Tipo:
str
- Padrão:
False
- Descrição: Ativa ou desativa o compartilhamento público de ferramentas de espaço de trabalho.
- Persistência: esta variável de ambiente é uma
PersistentConfig
variável.
Variáveis de ambiente misc
Essas variáveis não são específicas para abrir o WebUI, mas ainda podem ser valiosas em certos contextos.
Armazenamento em nuvem
STORAGE_PROVIDER
- Tipo:
str
- Opções:
s3
- usa a biblioteca do cliente S3 e variáveis de ambiente relacionadas mencionadas emAmazon S3 Storagegcs
- usa a biblioteca do cliente GCS e as variáveis de ambiente relacionadas mencionadas emGoogle Cloud Storageazure
- usa a biblioteca do cliente do Azure e as variáveis de ambiente relacionadas mencionadas emMicrosoft Azure Storage
- Padrão: String vazio (''), que padroniza para
local
- Descrição: define o provedor de armazenamento.
Amazon S3 Storage
S3_ACCESS_KEY_ID
- Tipo:
str
- Descrição: Define o ID da chave de acesso para armazenamento S3.
S3_ADDRESSING_STYLE
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o estilo de endereçamento a ser usado para o armazenamento S3 (por exemplo, 'caminho', 'virtual').
S3_BUCKET_NAME
- Tipo:
str
- Descrição: Define o nome do balde para o armazenamento S3.
S3_ENDPOINT_URL
- Tipo:
str
- Descrição: Define o URL do terminal para o armazenamento S3.
Se o terminal for um provedor compatível com S3 como o Minio que usa um certificado TLS assinado por uma CA privada, defina a variável de ambienteAWS_CA_BUNDLE
ao caminho do seu arquivo de certificados CA codificados por PEM. Veja oAmazon SDK DocsPara mais informações.
S3_KEY_PREFIX
- Tipo:
str
- Descrição: Define o prefixo da chave para um objeto S3.
S3_REGION_NAME
- Tipo:
str
- Descrição: Define o nome da região para armazenamento S3.
S3_SECRET_ACCESS_KEY
- Tipo:
str
- Descrição: Define a chave de acesso secreto para o armazenamento S3.
S3_USE_ACCELERATE_ENDPOINT
- Tipo:
str
- Padrão:
False
- Descrição: Especifica se deve usar o terminal acelerado para o armazenamento S3.
S3_ENABLE_TAGGING
- Tipo:
str
- Padrão:
False
- Descrição: Ativa a marcação de objetos S3 após o uploads para melhor organização, pesquisa e integração com as políticas de gerenciamento de arquivos. Sempre definido como
False
Ao usar o CloudFlare R2, como R2 não suporta a marcação de objetos.
Google Cloud Storage
GOOGLE_APPLICATION_CREDENTIALS_JSON
- Tipo:
str
- Descrição: Conteúdo do arquivo JSON do Google Application Credenciais.
- Opcional - se não for fornecido, as credenciais serão retiradas do meio ambiente. Credenciais do usuário se são executadas localmente e Google Metadata Server se executar em um mecanismo do Google Compute.
- Um arquivo pode ser gerado para uma conta de serviço após issoguia.
GCS_BUCKET_NAME
- Tipo:
str
- Descrição: Define o nome do balde para o Google Cloud Storage. Bucket já deve existir.
Microsoft Azure Storage
AZURE_STORAGE_ENDPOINT
- Tipo:
str
- Descrição: Define o URL do ponto de extremidade para armazenamento do Azure.
AZURE_STORAGE_CONTAINER_NAME
- Tipo:
str
- Descrição: Define o nome do contêiner para armazenamento do Azure.
AZURE_STORAGE_KEY
- Tipo:
str
- Descrição: Defina a chave de acesso para armazenamento do Azure.
- Opcional - se não for fornecido, as credenciais serão retiradas do meio ambiente. Credenciais do usuário se executadas localmente e gerenciam identidade se executadas nos serviços do Azure.
Configuração do Opentelemetria
ENABLE_OTEL
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa o OpenElemetria para observabilidade. Quando ativados, rastrear, métricas e dados de registro podem ser coletados e exportados para um terminal de OTLP.
ENABLE_OTEL_METRICS
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa a coleta e exportação de métricas de OpenMetry. Esta variável funciona em conjunto com
ENABLE_OTEL
ENABLE_OTEL_LOGS
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desabilita a exportação de registro de OpenElemetria. Quando ativado, os logs do aplicativo são enviados para o terminal OTLP configurado. Esta variável funciona em conjunto com
ENABLE_OTEL
OTEL_EXPORTER_OTLP_ENDPOINT
- Tipo:
str
- Padrão:
http://localhost:4317
- Descrição: Especifica o ponto de extremidade padrão OTLP (protocolo Opentelemetril) para exportar traços, métricas e logs. Isso pode ser substituído para métricas se
OTEL_METRICS_EXPORTER_OTLP_ENDPOINT
está definido e para toras seOTEL_LOGS_EXPORTER_OTLP_ENDPOINT
está definido.
OTEL_METRICS_EXPORTER_OTLP_ENDPOINT
- Tipo:
str
- Padrão: valor de
OTEL_EXPORTER_OTLP_ENDPOINT
- Descrição: Especifica o terminal de OTLP dedicado para exportar métricas de Opentelemetria. Se não estiver definido, ele padrão é o valor de
OTEL_EXPORTER_OTLP_ENDPOINT
. Isso é útil quando pontos de extremidade separados para traços e métricas são usados.
OTEL_LOGS_EXPORTER_OTLP_ENDPOINT
- Tipo:
str
- Padrão: valor de
OTEL_EXPORTER_OTLP_ENDPOINT
- Descrição: Especifica o endpoint de OTLP dedicado para exportar logs Opentelemetria. Se não estiver definido, ele padrão é o valor de
OTEL_EXPORTER_OTLP_ENDPOINT
. Isso é útil quando pontos de extremidade separados para logs, traços e métricas são usados.
OTEL_EXPORTER_OTLP_INSECURE
- Tipo:
bool
- Padrão:
False
- Descrição: se definido como
True
, o exportador OTLP usará uma conexão insegura (por exemplo, HTTP para GRPC) para traços. Para métricas, seu comportamento é governado porOTEL_METRICS_EXPORTER_OTLP_INSECURE
e para toras porOTEL_LOGS_EXPORTER_OTLP_INSECURE
OTEL_METRICS_EXPORTER_OTLP_INSECURE
- Tipo:
bool
- Padrão: valor de
OTEL_EXPORTER_OTLP_INSECURE
- Descrição: se definido como
True
, o exportador OTLP usará uma conexão insegura para métricas. Se não for especificado, ele usa o valor deOTEL_EXPORTER_OTLP_INSECURE
OTEL_LOGS_EXPORTER_OTLP_INSECURE
- Tipo:
bool
- Padrão: valor de
OTEL_EXPORTER_OTLP_INSECURE
- Descrição: se definido como
True
, o exportador OTLP usará uma conexão insegura para logs. Se não for especificado, ele usa o valor deOTEL_EXPORTER_OTLP_INSECURE
OTEL_SERVICE_NAME
- Tipo:
str
- Padrão:
open-webui
- Descrição: Define o nome do serviço que será relatado como seu coletor Opentelemetria ou plataforma de observabilidade. Isso ajuda a identificar sua instância aberta da Webui.
OTEL_RESOURCE_ATTRIBUTES
- Tipo:
str
- Padrão: String vazia ('')
- Descrição: Permite definir atributos de recursos adicionais a serem anexados a todos os dados de telemetria, em um vírgula separado
key1=val1,key2=val2
formatar.
OTEL_TRACES_SAMPLER
- Tipo:
str
- Opções:
parentbased_always_on
, Assim,always_on
, Assim,always_off
, Assim,parentbased_always_off
, etc. - Padrão:
parentbased_always_on
- Descrição: Configura a estratégia de amostragem para traços de OpenElemetria. Isso determina quais traços são coletados e exportados para reduzir o volume de dados.
OTEL_BASIC_AUTH_USERNAME
- Tipo:
str
- Padrão: String vazia ('')
- Descrição: Define o nome de usuário para autenticação básica com o endpoint OTLP padrão. Isso se aplica a traços e, por padrão, a métricas e logs, a menos que seja substituído por suas variáveis de autenticação específicas.
OTEL_BASIC_AUTH_PASSWORD
- Tipo:
str
- Padrão: String vazia ('')
- Descrição: Define a senha para autenticação básica com o terminal OTLP padrão. Isso se aplica a traços e, por padrão, a métricas e logs, a menos que seja substituído por suas variáveis de autenticação específicas.
OTEL_METRICS_BASIC_AUTH_USERNAME
- Tipo:
str
- Padrão: valor de
OTEL_BASIC_AUTH_USERNAME
- Descrição: Define o nome de usuário para autenticação básica especificamente para o terminal de métricas OTLP. Se não for especificado, ele usa o valor de
OTEL_BASIC_AUTH_USERNAME
OTEL_METRICS_BASIC_AUTH_PASSWORD
- Tipo:
str
- Padrão: valor de
OTEL_BASIC_AUTH_PASSWORD
- Descrição: Defina a senha para autenticação básica especificamente para o terminal de métricas OTLP. Se não for especificado, ele usa o valor de
OTEL_BASIC_AUTH_PASSWORD
OTEL_LOGS_BASIC_AUTH_USERNAME
- Tipo:
str
- Padrão: valor de
OTEL_BASIC_AUTH_USERNAME
- Descrição: Define o nome de usuário para autenticação básica especificamente para o ponto final do OTLP Logs. Se não for especificado, ele usa o valor de
OTEL_BASIC_AUTH_USERNAME
OTEL_LOGS_BASIC_AUTH_PASSWORD
- Tipo:
str
- Padrão: valor de
OTEL_BASIC_AUTH_PASSWORD
- Descrição: Define a senha para autenticação básica especificamente para o ponto final do OTLP Logs. Se não for especificado, ele usa o valor de
OTEL_BASIC_AUTH_PASSWORD
OTEL_OTLP_SPAN_EXPORTER
- Tipo:
str
- Opções:
grpc
, Assim,http
- Padrão:
grpc
- Descrição: Especifica o protocolo padrão para a exportação de rastreios de OpenElemetria (GRPC ou HTTP). Isso pode ser substituído para métricas se
OTEL_METRICS_OTLP_SPAN_EXPORTER
está definido e para toras seOTEL_LOGS_OTLP_SPAN_EXPORTER
está definido.
OTEL_METRICS_OTLP_SPAN_EXPORTER
- Tipo:
str
- Opções:
grpc
, Assim,http
- Padrão: valor de
OTEL_OTLP_SPAN_EXPORTER
- Descrição: Especifica o protocolo para a exportação de métricas de Opentelemetria (GRPC ou HTTP). Se não for especificado, ele usa o valor de
OTEL_OTLP_SPAN_EXPORTER
OTEL_LOGS_OTLP_SPAN_EXPORTER
- Tipo:
str
- Opções:
grpc
, Assim,http
- Padrão: valor de
OTEL_OTLP_SPAN_EXPORTER
- Descrição: Especifica o protocolo para exportar logs OpenteleMetria (GRPC ou HTTP). Se não for especificado, ele usa o valor de
OTEL_OTLP_SPAN_EXPORTER
Pool de banco de dados
DATABASE_URL
- Tipo:
str
- Padrão:
sqlite:///${DATA_DIR}/webui.db
- Descrição: Especifica o URL do banco de dados para se conectar.
Suporta SQLite, Postgres e Sqlite criptografado via SQLCipher. Alterar o URL não migra dados entre bancos de dados. A documentação sobre o esquema de URL está disponívelaqui
Se a senha do seu banco de dados contiver caracteres especiais, verifique se eles são codificados por URL corretamente. Por exemplo, uma senha comop@ssword
deve ser codificado comop%40ssword
Para sqlite criptografado, consulte a seção "Sqlite com criptografia SQLCIPHER" abaixo para obter detalhes de configuração.
Sqlite criptografado com sqlcipher
Para segurança aprimorada, o Nullcore suporta a criptografia AT-REST para seu banco de dados SQLite primário usando o SQLCIPHER. Isso é recomendado para implantações que lidam com dados confidenciais, onde o uso de um banco de dados maior, como o PostgreSQL, não é necessário.
Para ativar a criptografia, você deve configurar duas variáveis de ambiente:
- Definir
DATABASE_TYPE="sqlite+sqlcipher"
- Definir
DATABASE_PASSWORD="your-secure-password"
Quando estes são definidos e um completoDATABASE_URL
énãoExplicitamente definido, o Nullcore criará automaticamente e usará um arquivo de banco de dados criptografado em./data/webui.db
- O
DATABASE_PASSWORD
Variável de ambiente éobrigatórioAo usarsqlite+sqlcipher
- O
DATABASE_TYPE
A Variable informa ao Nullcore qual lógica de conexão usar. Configurando -o parasqlite+sqlcipher
Ativa o recurso de criptografia.
Verifique se a senha do banco de dados é mantida segura, pois é necessária para descriptografar e acessar todos os dados do aplicativo.
DATABASE_SCHEMA
- Tipo:
str
- Padrão:
None
- Descrição: Especifica o esquema do banco de dados para se conectar.
DATABASE_POOL_SIZE
- Tipo:
int
- Padrão:
None
- Descrição: Especifica a estratégia de pool e o tamanho do pool de banco de dados. Por padrão, o SQLalChemy escolherá automaticamente a estratégia de agrupamento adequada para a conexão de banco de dados selecionada. Um valor de
0
desativa o agrupamento. Um valor maior0
definirá a estratégia de agrupamento paraQueuePool
e o tamanho da piscina de acordo.
DATABASE_POOL_MAX_OVERFLOW
- Tipo:
int
- Padrão:
0
- Descrição: Especifica o pool de banco de dados MAX Overflow.
Mais informações sobre essa configuração podem ser encontradasaqui
DATABASE_POOL_TIMEOUT
- Tipo:
int
- Padrão:
30
- Descrição: Especifica o tempo limite do pool de banco de dados em segundos para obter uma conexão.
Mais informações sobre essa configuração podem ser encontradasaqui
DATABASE_POOL_RECYCLE
- Tipo:
int
- Padrão:
3600
- Descrição: Especifica o tempo de reciclagem do pool de banco de dados em segundos.
Mais informações sobre essa configuração podem ser encontradasaqui
DATABASE_ENABLE_SQLITE_WAL
- Tipo:
bool
- Padrão:
False
- Descrição: Ativa ou desativa o modo SQLITE WAL (Write-Ahead Logging). Quando ativado, as transações SQLite podem ser gerenciadas com mais eficiência, permitindo vários leitores e um escritor simultaneamente, o que pode melhorar o desempenho do banco de dados, especialmente sob alta concorrência.Essa configuração se aplica apenas aos bancos de dados SQLite.
DATABASE_DEDUPLICATE_INTERVAL
- Tipo:
float
- Padrão:
0.0
- Descrição: Define um intervalo de tempo em segundos durante os quais certas operações de gravação de banco de dados (por exemplo, atualizando o usuário
last_active_at
Timestamp) será desduplicado. Se uma operação de gravação for tentada dentro desse intervalo para a mesma entidade, ela será ignorada. Um valor de0.0
desativa a desduplicação. Habilitar isso pode reduzir os conflitos de gravação e melhorar o desempenho, mas pode resultar em menor precisão em tempo real para os campos afetados.
Redis
REDIS_URL
- Tipo:
str
- Descrição: Especifica o URL da instância do Redis ou do host de cluster para armazenar o estado do aplicativo.
- Exemplos:
redis://localhost:6379/0
rediss://:password@localhost:6379/0
(com senha e TLS)rediss://redis-cluster.redis.svc.cluster.local:6379/0 ?ssl_cert_reqs=required&ssl_certfile=/tls/redis/tls.crt &ssl_keyfile=/tls/redis/tls.key&ssl_ca_certs=/tls/redis/ca.crt
(com MTLS)
Ao implantar o Webui aberto em um cluster de vários nó/trabalhador com um balanceador de carga, você deve garantir que o valor Redis_URL esteja definido. Sem ele, questões de sessão, persistência e consistência no estado do aplicativo ocorrerão, pois os trabalhadores não poderão se comunicar.
REDIS_SENTINEL_HOSTS
- Tipo:
str
- Descrição: Lista separada por vírgula de Redis Sentinels para o estado do aplicativo. Se especificado, o "nome do host" em
REDIS_URL
será interpretado como o nome do serviço Sentinel.
REDIS_SENTINEL_PORT
- Tipo:
int
- Padrão:
26379
- Descrição: Porta Sentinel para o App State Redis.
REDIS_CLUSTER
- Tipo:
bool
- Padrão:
False
- Descrição: Conecte -se a um cluster Redis em vez de uma única instância ou usando o Redis Sentinels. Se
True
, Assim,REDIS_URL
também deve ser definido.
Esta opção não tem efeito seREDIS_SENTINEL_HOSTS
é definido.
REDIS_KEY_PREFIX
- Tipo:
str
- Padrão:
open-webui
- Descrição: Personaliza o prefixo Redis Key usado para armazenar valores de configuração. Isso permite que várias instâncias abertas da Webui compartilhem a mesma instância Redis sem conflitos importantes. Ao operar no modo Redis Cluster, o prefixo é formatado como
{prefix}:
(por exemplo,{open-webui}:config:*
) ativar operações de várias teclas nas teclas de configuração no mesmo slot de hash.
ENABLE_WEBSOCKET_SUPPORT
- Tipo:
bool
- Padrão:
True
- Descrição: Ativa o suporte do WebSocket no Nullcore.
Ao implantar o Webui aberto em um cluster de vários nó/trabalhador com um balanceador de carga, você deve garantir que o valor atability_webocket_support seja definido. Sem ele, a consistência do WebSocket e os problemas de persistência ocorrerão.
WEBSOCKET_MANAGER
- Tipo:
str
- Padrão:
redis
- Descrição: Especifica o WebSocket Manager para usar (neste caso, Redis).
Ao implantar o Nullcore em um cluster de vários nó/trabalhador com um balanceador de carga, você deve garantir que o valor WebSocket_Manager esteja definido e um banco de dados NOSQL de valor-chave como Redis seja usado. Sem ele, a consistência do WebSocket e os problemas de persistência ocorrerão.
WEBSOCKET_REDIS_URL
- Tipo:
str
- Padrão:
${REDIS_URL}
- Descrição: Especifica o URL da instância do Redis ou do host de cluster para a WebSocket Communication. É distinto de
REDIS_URL
E na prática, é recomendável definir ambos.
Ao implantar o Nullcore em um cluster de vários nó/trabalhador com um balanceador de carga, você deve garantir que o valor websocket_redis_url seja definido e um banco de dados NOSQL de valor-chave como Redis é usado. Sem ele, a consistência do WebSocket e os problemas de persistência ocorrerão.
WEBSOCKET_SENTINEL_HOSTS
- Tipo:
str
- Descrição: Lista separada por vírgula de Redis Sentinels para WebSocket. Se especificado, o "nome do host" em
WEBSOCKET_REDIS_URL
será interpretado como o nome do serviço Sentinel.
WEBSOCKET_SENTINEL_PORT
- Tipo:
int
- Padrão:
26379
- Descrição: Porta Sentinel para WebSocket Redis.
WEBSOCKET_REDIS_CLUSTER
- Tipo:
bool
- Padrão:
${REDIS_CLUSTER}
- Descrição: Especifica que o WebSocket deve se comunicar com um cluster Redis em vez de uma única instância ou usar o Redis Sentinels. Se
True
, Assim,WEBSOCKET_REDIS_URL
e/ouREDIS_URL
também deve ser definido.
Esta opção não tem efeito seWEBSOCKET_SENTINEL_HOSTS
é definido.
Configurações de Uvicorn
UVICORN_WORKERS
- Tipo:
int
- Padrão:
1
- Descrição: Controla o número de processos do trabalhador que o Uvicorn gera para lidar com solicitações. Cada trabalhador executa sua própria instância do aplicativo em um processo separado.
Ao implantar em ambientes orquestrados como Kubernetes ou usar gráficos de helmo, é recomendável manter o Uvicorn_workers definido como 1. As plataformas de orquestração de contêineres já fornecem seus próprios mecanismos de escala por meio de replicação de pods e o uso de múltiplos trabalhadores dentro dos contêineres podem levar a problemas de alocação de recursos e estratégias de escala horizontal complicados.
Se você usar o Uvicorn_workers, também precisará garantir que as variáveis de ambiente relacionadas para configurações de múltiplas instâncias escaláveis sejam definidas de acordo.
Configurações de proxy
O Nullcore suporta o uso de proxies para recuperações HTTP e HTTPS. Para especificar configurações de proxy, Nullcore usa as seguintes variáveis de ambiente:
http_proxy
- Tipo:
str
- Descrição: Define o URL para o proxy HTTP.
https_proxy
- Tipo:
str
- Descrição: Define o URL para o proxy HTTPS.
no_proxy
- Tipo:
str
- Descrição: lista as extensões de domínio (ou endereços IP) para os quais o proxy não deve ser usado, separado por vírgulas. Por exemplo, definir no_proxy como '.mit.edu' garante que o proxy seja ignorou ao acessar documentos do MIT.
Instale os pacotes Python necessários
O Nullcore fornece variáveis de ambiente para personalizar o processo de instalação do PIP. Abaixo estão as variáveis de ambiente usadas pelo Nullcore para ajustar o comportamento da instalação do pacote:
PIP_OPTIONS
- Tipo:
str
- Descrição: Especifica opções adicionais de linha de comando que o PIP deve usar ao instalar pacotes. Por exemplo, você pode incluir sinalizadores como
--upgrade
, Assim,--user
, ou--no-cache-dir
Para controlar o processo de instalação.
PIP_PACKAGE_INDEX_OPTIONS
- Tipo:
str
- Descrição: Define o comportamento do índice de pacote personalizado para PIP. Isso pode incluir a especificação de URLs de índice adicionais ou alternativos (por exemplo,,
--extra-index-url
), credenciais de autenticação ou outros parâmetros para gerenciar como os pacotes são recuperados de diferentes locais.