Inicio Rápido de API Compatible con OpenAI

Prerrequisitos y configuración del entorno

Necesitas una clave API y la URL base correcta para conectar tu cliente. Regístrate con Google o correo electrónico en la página Obtener clave API para recibir tu credencial inmediatamente. La prueba te da $0.50 durante siete días y puedes recargar con USDT o USDC mediante criptomonedas. Mantén tu clave segura y verifica que coincida con la configuración de tu cuenta.

Asegúrate de que tu entorno soporte solicitudes HTTP estándar. Nuestro servicio se ejecuta en un único modelo uncensored, por lo que no necesitas gestionar múltiples puntos finales de modelos. Establece tu URL base en HTTPS://api.openaiapicompatibility.com/v1 antes de realizar cualquier llamada. Esto asegura que todas las solicitudes se enruten correctamente a nuestros servidores de inferencia ajustados.

Instalación del SDK oficial de OpenAI

Usa los SDK oficiales para mantener la compatibilidad con los flujos de trabajo existentes de OpenAI. Las bibliotecas de Python y Node.js funcionan directamente con nuestro punto de conexión porque seguimos el esquema de API estándar. Instala el paquete en el directorio de tu proyecto usando tu administrador de paquetes preferido. Este enfoque evita la necesidad de código personalizado para el cliente HTTP.

Admitimos parámetros estándar como temperature, top_p y secuencias de parada. El SDK maneja automáticamente la serialización JSON y los encabezados de solicitud. Puedes cambiar la URL base en la configuración del cliente para apuntar a nuestros servidores. Esto te permite cambiar entre proveedores sin modificar la lógica de tu aplicación.

Configurando la URL base y la clave API

Establece la URL base y la clave de la API en tu objeto de configuración del cliente. La URL base es HTTPS://api.openaiapicompatibility.com/v1. Pasa tu clave de API en el encabezado Authorization como un token Bearer. Esta configuración asegura que tus solicitudes estén autenticadas y enrutadas al servicio correcto.

Copycurl https://api.openaiapicompatibility.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all python packages for data science"}]
  }'

Verifica tu conexión llamando al endpoint GET /v1/models. Esto devuelve una lista de modelos disponibles, incluido el identificador del modelo uncensored. Utiliza este paso para confirmar que tu acceso a la red y las credenciales son correctos antes de enviar prompts complejos.

Realizando tu primera completación de chat

Envía una solicitud POST a /v1/chat/completions con tus mensajes de prompt. Define el modelo como uncensored para acceder al motor de inferencia sin filtros. Incluye tu instrucción del sistema para establecer el comportamiento y añade mensajes del usuario para el contenido que deseas generar.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.openaiapicompatibility.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

La respuesta contiene el texto generado y las estadísticas de uso de tokens. Puedes ajustar parámetros como la temperatura para controlar la creatividad. El modelo no rechaza temas adultos legales o controversiales, lo que lo hace adecuado para diversos casos de uso. Consulta el objeto de respuesta para el campo content y acceder a la salida.

Respuestas en streaming con SSE

Habilita el streaming estableciendo el parámetro stream en true en tu solicitud. Esto envía respuestas parciales como Eventos Enviados por el Servidor (SSE). Mejora la experiencia del usuario mostrando el texto a medida que se genera.

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

Cada fragmento contiene un delta de la respuesta. Acumula estos deltas para reconstruir el texto completo. El fragmento final incluye el uso total de tokens para la solicitud. Este método funciona con cualquier cliente o biblioteca SSE estándar. Reduce la latencia percibida para la generación de contenido extenso.

Manejo de modo JSON y llamadas a funciones

Usa el modo JSON estableciendo response_format a json_object. Esto obliga al modelo a generar JSON válido en lugar de texto libre. Es útil para la extracción de datos estructurados o respuestas de API. Combina esto con la llamada de funciones para escenarios de uso de herramientas.

Define tus herramientas en el array tools. Especifica el nombre de la función, la descripción y los parámetros. El modelo devolverá los detalles de la llamada a la función en la respuesta. Luego puedes ejecutar la función y enviar el resultado de vuelta al modelo. Esto habilita flujos de trabajo complejos de múltiples pasos con el modelo uncensored.

Node.js

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.openaiapicompatibility.com/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);