Skip to main content

Ejecutar con el SDK de Ruby

Usa la gema oficial fetch_hive cuando quieras invocar un deployment de prompt desde Ruby. El SDK envuelve el endpoint público POST /v1/prompt/invoke con ayudantes idiomáticos, maneja la autenticación y analiza las respuestas en streaming convirtiéndolas en hashes producidos.

Instalación

Agrega a tu Gemfile:
Luego ejecuta:
O instálala directamente:
La gema usa faraday por debajo y admite Ruby 3.0+.

Autenticación

Configura la variable de entorno FETCH_HIVE_API_KEY con tu clave de API del workspace (el cliente la lee automáticamente):
O pasa la clave explícitamente:
Consulta API Keys para saber cómo crear y rotar claves.

Ejemplo básico

Invoca un deployment de prompt y lee la respuesta final:
invoke_prompt se bloquea hasta que el prompt se completa y devuelve el cuerpo JSON analizado como un hash. Consulta la forma de respuesta sin streaming.

Referencia del método

El SDK inyecta streaming: false para invoke_prompt. Para transmitir, usa invoke_prompt_stream (a continuación).

Manejo de la respuesta

Streaming

Usa invoke_prompt_stream para recibir Server-Sent Events a medida que llegan. El método produce cada hash de evento analizado al bloque:
La transmisión produce los mismos tipos de evento documentados en Invoke Prompt → Response: reasoning, response, un evento usage final o un evento error si el proveedor falla durante la transmisión. Si omites el bloque, el método devuelve un Enumerator que puedes pasar:

Configuración

Errores

Las respuestas distintas a 2xx lanzan un RuntimeError con el código de estado y el cuerpo. Rescátalas si necesitas manejar fallos:
Consulta Errors and Rate Limits para el significado de los códigos de estado.

Enlaces

Siguientes pasos