open assistant api
1.0.0
Uma API de assistente inteligente da IA
Inglês | 简体中文 | 日本語
A API de assistente aberto é uma API de assistente inteligente de IA auto-hospedada e de código aberto, compatível com a interface oficial do OpenAI. Ele pode ser usado diretamente com o cliente oficial do Openai para criar aplicativos LLM.
Ele suporta uma API para integração com modelos mais comerciais e privados.
Ele suporta R2R Rag Engine。
Abaixo está um exemplo de uso da biblioteca oficial do Openai Python openai :
import openai
client = openai . OpenAI (
base_url = "http://127.0.0.1:8086/api/v1" ,
api_key = "xxx"
)
assistant = client . beta . assistants . create (
name = "demo" ,
instructions = "You are a helpful assistant." ,
model = "gpt-4-1106-preview"
)| Recurso | API de assistente aberto | API Assistente do Openai |
|---|---|---|
| Estratégia do ecossistema | Código aberto | Fonte fechada |
| Motor de pano | Suporte R2R | Suportado |
| Pesquisa na Internet | Suportado | Não suportado |
| Funções personalizadas | Suportado | Suportado |
| Ferramenta embutida | Extensível | Não extensível |
| Interpretador de código | Em desenvolvimento | Suportado |
| Multimodal | Suportado | Suportado |
| Suporte LLM | Suporta mais LLMS | Apenas Gpt |
| Saída de streaming de mensagens | Suportes | Suportado |
| Implantação local | Suportado | Não suportado |
A maneira mais fácil de iniciar a API do Assistant Open é executar o arquivo Docker-Compose.YML. Verifique se o Docker e o Docker Compose estão instalados em sua máquina antes de funcionar.
Vá para o diretório raiz do projeto, abra docker-compose.yml , preencha a chave de pesquisa do OpenAi API_KEY e Bing (opcional).
# openai api_key (supports OneAPI api_key)
OPENAI_API_KEY= < openai_api_key >
# bing search key (optional)
BING_SUBSCRIPTION_KEY= < bing_subscription_key >Recomenda -se configurar o mecanismo R2R RAG para substituir a implementação padrão do RAG para fornecer melhores recursos de pano. Você pode aprender e usar o R2R através do repositório R2R GitHub.
# RAG config
# FILE_SERVICE_MODULE=app.services.file.impl.oss_file.OSSFileService
FILE_SERVICE_MODULE=app.services.file.impl.r2r_file.R2RFileService
R2R_BASE_URL=http:// < r2r_api_address >
R2R_USERNAME= < r2r_username >
R2R_PASSWORD= < r2r_password >docker compose up -dURL base da API: http://127.0.0.1:8086/api/v1
Endereço de documentação da interface: http://127.0.0.1:8086/docs
Neste exemplo, um assistente de IA é criado e executado usando a biblioteca de clientes oficial do Openai. Se você precisar explorar outros métodos de uso, como saída de streaming, ferramentas (web_search, recuperação, função) etc., você pode encontrar o código correspondente no diretório Exemplos. Antes de executar, você precisa executar pip install openai para instalar a biblioteca Python openai .
# !pip install openai
export PYTHONPATH= $( pwd )
python examples/run_assistant.py O isolamento simples do usuário é fornecido com base em tokens para atender aos requisitos de implantação de SaaS. Pode ser ativado configurando APP_AUTH_ENABLE .
Authorization: Bearer *** no cabeçalho para autenticação.APP_AUTH_ADMIN_TOKEN e padroniza para "admin".De acordo com a especificação OpenAPI/Swagger, permite a integração de várias ferramentas no assistente, capacitando e aprimorando sua capacidade de se conectar com o mundo externo.
Junte -se ao Slack Channel para ver novos lançamentos, discutir questões e participar de interações da comunidade.
Junte -se ao canal Discord para interagir com outros membros da comunidade.
Junte -se ao grupo WeChat:
Nós nos referimos principalmente e confiamos nos seguintes projetos:
Leia nosso documento de contribuição para aprender a contribuir.
Este repositório segue a licença de código aberto do MIT. Para mais informações, consulte o arquivo de licença.
