aimanagertoolkit 0.1.3

A toolkit for working with OpenAI and Azure OpenAI API

AiManagerToolkit 🤖

AiManagerToolkit es una librería Python diseñada para simplificar la interacción con la API de Azure OpenAI. Esta herramienta proporciona una forma flexible y eficiente de gestionar conversaciones con modelos de lenguaje, integrar herramientas personalizadas, generar respuestas estructuradas, y manejar funcionalidades de voz y texto, ideal para desarrolladores que buscan aprovechar la potencia de la inteligencia artificial en sus aplicaciones.

Características ✨

• Soporte para Azure OpenAI: Fácil integración con la plataforma de Azure.
• Herramientas Personalizadas: Define y registra herramientas para mejorar las interacciones con el modelo.
• Salidas Estructuradas: Genera respuestas en formato JSON basadas en esquemas definidos.
• Chat Sincrónico y Streaming: Manejo de conversaciones tanto en modo sincrónico como en streaming.
• Embeddings: Generación y manejo de embeddings de texto.
• Speech to Text (STT): Transcripción y traducción de audio a texto.
• Text to Speech (TTS): Generación de audio a partir de texto.
• Logging Configurable: Sistema de logging integrado para monitorear y depurar las interacciones.
• Manejo Avanzado de Mensajes: Nueva clase Message para una gestión eficiente de conversaciones y tipos de contenido.

Instalación 🚀

Puedes instalar AiManagerToolkit desde PyPI utilizando pip:

pip install AiManagerToolkit

Uso Básico 💻

1. Configuración Inicial 🛠️

Configura la conexión a la API de Azure OpenAI utilizando variables de entorno o parámetros en el código.

Configuración utilizando .env 🌐

Crea un archivo .env en el directorio raíz de tu proyecto con las credenciales necesarias:

AZURE_OPENAI_DEPLOYMENT=gpt-4o
AZURE_OPENAI_ENDPOINT=https://tu-endpoint.azure.com/
AZURE_OPENAI_API_KEY=tu-clave-api
AZURE_OPENAI_API_VERSION=2024-06-01
AZURE_OPENAI_EMBEDDINGS_MODEL=text-embedding-3-small

Configuración en el Código 🔧

Puedes pasar la configuración directamente en tu código:

from AiManagerToolkit import AzureAiToolkit

azure_ai = AzureAiToolkit(
    model="gpt-4o",
    azure_endpoint="https://tu-endpoint.azure.com/",
    api_key="tu-clave-api",
    temperature=0.7
)

2. Ejemplo de Uso de Chat 🔄

from AiManagerToolkit import AzureAiToolkit

azure_ai = AzureAiToolkit()

messages = [{"role": "user", "content": "¿Cuál es el estado de mi pedido?"}]
response = azure_ai.chat(messages)
print(response.choices[0].message.content)

3. Generación de Embeddings 📊

embedding = azure_ai.embeddings("Texto para generar embedding")
print(embedding.data[0].embedding)

4. Transcripción de Audio 🎙️

transcription = azure_ai.transcribe("ruta/al/archivo/audio.mp3")
print(transcription)

5. Generación de Voz 🔊

azure_ai.speech("Texto para convertir en voz", output_file_path="salida.mp3")

6. Cálculo de Similitud Coseno 📐

vector1 = [1, 2, 3]
vector2 = [4, 5, 6]
similarity = azure_ai.cosine_similarity(vector1, vector2)
print(f"Similitud coseno: {similarity}")

7. Manejo Avanzado de Mensajes 💬

from AiManagerToolkit import Message, SystemMessage, UserMessage

# Iniciar una conversación
conversation = Message(SystemMessage("Eres un asistente útil."))

# Añadir mensajes a la conversación
conversation.add_message(UserMessage("Hola, ¿cómo estás?"))
conversation.add_message("¿Puedes ayudarme con una tarea?")

# Obtener la conversación completa
full_conversation = conversation.get_full_conversation()

Contribuciones 👥

¡Las contribuciones son bienvenidas! Si deseas contribuir al proyecto, sigue estos pasos:

1. Realiza un fork del repositorio.
2. Crea una nueva rama (git checkout -b feature/mi-nueva-funcionalidad).
3. Realiza tus cambios y haz commit (git commit -am 'Añadir nueva funcionalidad').
4. Haz push a la rama (git push origin feature/mi-nueva-funcionalidad).
5. Crea un nuevo Pull Request.

Roadmap 🛤️

• Mejoras en la documentación con ejemplos avanzados.
• Añadir más tests unitarios y de integración.
• Soporte para operaciones avanzadas con Azure OpenAI.
• Integración con más servicios de Azure AI.

Licencia 📄

Este proyecto está licenciado bajo la Licencia MIT - consulta el archivo LICENSE para más detalles.

---

¡Gracias por usar AiManagerToolkit! Si tienes alguna pregunta o sugerencia, no dudes en abrir un issue en el repositorio. 😊