Descarga open assistant api - Descargar código fuente de open assistant api

open assistant api

Otro código fuente

1.0.0

Descargar

API asistente abierto

Una API de asistente inteligente de IA de AI listos para usar

Inglés | 简体中文 | 日本語

Introducción

Open Assistant API es una API asistente inteligente de IA de código abierto y de código abierto, compatible con la interfaz oficial de OpenAI. Se puede utilizar directamente con el cliente Operai oficial para construir aplicaciones LLM.

Admite una API para la integración con más modelos comerciales y privados.

Admite el motor R2R RAG。

Uso

A continuación se muestra un ejemplo de uso de la biblioteca oficial 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"
)

Por qué elegir Open Assistant API

Característica	API asistente abierto	API asistente de Operai
Estrategia del ecosistema	Código abierto	Código cerrado
Motor de trapo	Apoyo R2R	Compatible
Búsqueda en Internet	Compatible	No compatible
Funciones personalizadas	Compatible	Compatible
Herramienta incorporada	Extensible	No extensible
Intérprete de código	En desarrollo	Compatible
Multimodal	Compatible	Compatible
Soporte de LLM	Admite más LLMS	Solo GPT
Salida de transmisión de mensajes	Soporte	Compatible
Despliegue local	Compatible	No compatible

Soporte de LLM : en comparación con la versión oficial de OpenAI, se pueden soportar más modelos integrándose con una API.
Herramienta : Actualmente admite la búsqueda en línea; puede ampliar fácilmente más herramientas.
Rag Engine : Los tipos de archivos compatibles actualmente son TXT, HTML, Markdown, PDF, DOCX, PPTX, XLSX, PNG, MP3, MP4, etc. Proporcionamos una implementación preliminar.
Salida de transmisión de mensajes : Soporte de salida de transmisión de mensajes para una experiencia de usuario más suave.
Estrategia del ecosistema : código abierto, puede implementar el servicio localmente y expandir las características existentes.

Comienzo rápido

La forma más fácil de iniciar la API de asistente abierto es ejecutar el archivo Docker-Compose.yml. Asegúrese de que Docker y Docker Compose estén instalados en su máquina antes de ejecutar.

Configuración

Vaya al directorio de Project Root, abra docker-compose.yml , complete la tecla de búsqueda Operai API_Key y 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 >

Se recomienda configurar el motor R2R RAG para reemplazar la implementación predeterminada de RAG para proporcionar mejores capacidades de RAG. Puede aprender y usar R2R a través del repositorio 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 >

Correr

Ejecutar con Docker Compose:

docker compose up -d

API de acceso

URL base API: http://127.0.0.1:8086/api/v1

Dirección de documentación de la interfaz: http://127.0.0.1:8086/docs

Ejemplo de uso completo

En este ejemplo, se crea y se ejecuta un asistente de IA utilizando la biblioteca oficial de clientes Operai. Si necesita explorar otros métodos de uso, como la transmisión de salida, herramientas (web_search, recuperación, función), etc., puede encontrar el código correspondiente en el directorio de ejemplos. Antes de ejecutar, debe ejecutar pip install openai para instalar la biblioteca Python openai .

 # !pip install openai
export PYTHONPATH= $( pwd )
python examples/run_assistant.py

Permisos

El aislamiento simple del usuario se proporciona en función de los tokens para cumplir con los requisitos de implementación de SaaS. Se puede habilitar configurando APP_AUTH_ENABLE .

El método de autenticación es el token de portador. Puede incluir Authorization: Bearer *** en el encabezado para la autenticación.
La gestión del token se describe en la sección token de la documentación de la API. Las API relevantes deben autenticarse con un token de administrador, que está configurado como APP_AUTH_ADMIN_TOKEN y predeterminado a "Admin".
Al crear un token, debe proporcionar la URL base y la clave API del modelo grande. El asistente creado utilizará la configuración correspondiente para acceder al modelo grande.

Herramientas

Según la especificación de OpenApi/Swagger, permite la integración de varias herramientas en el asistente, empoderando y mejorando su capacidad para conectarse con el mundo externo.

Facilita la conexión de su aplicación con otros sistemas o servicios, permitiendo la interacción con el entorno externo, como la ejecución del código o el acceso a fuentes de información propietaria.
Durante el uso, primero debe crear herramientas, y luego puede integrarlas con el asistente. Consulte los casos de prueba para obtener más detalles. Asistente con la acción
Si necesita usar herramientas con información de autenticación, simplemente agregue la información de autenticación en tiempo de ejecución. El formato de parámetro específico se puede encontrar en la documentación de la API. Consulte los casos de prueba para obtener más detalles. Ejecutar con la acción de autenticación

Comunidad y apoyo

Únase al canal Slack para ver nuevos lanzamientos, discutir temas y participar en las interacciones comunitarias.
Únase al canal Discord para interactuar con otros miembros de la comunidad.
Únete al grupo WeChat: