Skip to main content

Ejecutar con el SDK de Ruby

Usa la gema oficial fetch_hive cuando quieras enviar un mensaje a un agente desde Ruby. El SDK envuelve el endpoint público POST /v1/agent/invoke, maneja la autenticación, admite streaming mediante un bloque y acepta entradas multimodales.

Instalación

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

Autenticación

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

Ejemplo básico

Envía un mensaje a un agente y lee la respuesta final:
Consulta el formato de respuesta sin streaming.

Referencia del método

El SDK inyecta streaming: false para invoke_agent. Para hacer streaming, usa invoke_agent_stream (abajo).

Manejo de la respuesta

Streaming

Usa invoke_agent_stream para recibir Server-Sent Events a medida que llegan. El método entrega cada hash de evento analizado al bloque:
El stream genera los mismos tipos de eventos documentados en Invocar Agente → Respuesta: summary (cuando se dispara el resumen automático), reasoning, response, tool, un evento final usage, o un evento error si el proveedor falla a mitad del stream. Si omites el bloque, el método devuelve un Enumerator que puedes pasar por ahí:

Conversaciones de múltiples turnos

Hilos persistentes

Pasa cualquier cadena como thread_id y Fetch Hive creará el hilo en la primera llamada y lo reanudará en llamadas posteriores con el mismo valor:

Historial sin estado

Administra el estado tú mismo pasando los turnos previos en messages. Fetch Hive usa el historial proporcionado como contexto pero no lo persiste:

Entradas multimodales

Adjunta imágenes al mensaje actual con attachments:
Las URLs deben comenzar con https://.

Configuración

Errores

Las respuestas no 2xx lanzan un RuntimeError con el código de estado y el cuerpo. Rescátalas si necesitas manejar fallas:
Consulta Errores y límites de tasa para conocer el significado de los códigos de estado.

Enlaces

Próximos pasos