Interfazhost

AiService

IA de la instancia (ctx.services.ai). Permiso AI_GENERATE (o bloque ai del manifest); si falta, AI_PERMISSION_DENIED. La politica (activada, funciones, cuotas, guardarrailes, clave del proveedor) la decide el administrador en /admin/ai; la extension no maneja claves. Limite: 5 generaciones (generate/chat/json) por invocacion. Los errores son Error con .code (AiError). No hay streaming: el puente es peticion/respuesta firmada y el sandbox no admite iteradores asincronos del host; usa maxTokens.

Firma

host · Interfaz

export interface AiService {
    generate(input: AiGenerateInput): Promise<AiResult>;
    generate(system: string, prompt: string, extra?: { response_format?: { type: "json_object" | "text"; }; feature?: AiFeature; maxTokens?: number; temperature?: number; }): Promise<string>;
    chat(input: AiChatInput): Promise<AiResult>;
    json<T = unknown>(input: string | (Partial<AiChatInput> & { prompt?: string; }), schema: JsonSchema, options?: Pick<AiCommonInput, "feature" | "system" | "maxTokens" | "temperature" | "parts"> & { retries?: 0 | 1 | 2; }): Promise<AiJsonResult<T>>;
    status(feature?: AiFeature): Promise<AiStatus>;
    isAvailable(feature?: AiFeature): Promise<boolean>;
}

Miembros (6)

Miembros
Nombre	Tipo	Descripción
generate	`generate(input: AiGenerateInput): Promise<AiResult>`	Genera texto. Firma nueva `generate({ prompt, system?, feature?, maxTokens?, temperature?, responseFormat? }) -> AiResult`. Firma ANTIGUA `generate(system, prompt, extra?) -> string` (sigue funcionando; `extra.response_format.type = "json_object"` pide JSON). js `const r = await ctx.services.ai.generate({ prompt: "Hola", feature: "other" }); const legacyText = await ctx.services.ai.generate("Eres breve.", "Hola");`
generate	`generate(system: string, prompt: string, extra?: { response_format?: { type: "json_object" \| "text"; }; feature?: AiFeature; maxTokens?: number; temperature?: number; }): Promise<string>`	Sin descripción.
chat	`chat(input: AiChatInput): Promise<AiResult>`	Conversacion con varios mensajes. js `const r = await ctx.services.ai.chat({ messages: [{ role: "user", content: "Hola" }], feature: "smart-reply" });`
json	`json<T = unknown>(input: string \| (Partial<AiChatInput> & { prompt?: string; }), schema: JsonSchema, options?: Pick<AiCommonInput, "feature" \| "system" \| "maxTokens" \| "temperature" \| "parts"> & { retries?: 0 \| 1 \| 2; }): Promise<AiJsonResult<T>>`	Salida estructurada: la instancia valida contra `schema` (y reintenta hasta `retries`, max 2); si no cumple lanza `schema_validation_failed`. `input` es el prompt o `{ prompt \| messages, system?, feature? }`. js `const r = await ctx.services.ai.json("Extrae el importe de: " + ctx.args.text, { type: "object", required: ["amount"], properties: { amount: { type: "number" } } }, { feature: "other", retries: 1 });`
status	`status(feature?: AiFeature): Promise<AiStatus>`	Estado de la IA (no consume cuota de generacion; 20 consultas por invocacion). js `const st = await ctx.services.ai.status("composer");`
isAvailable	`isAvailable(feature?: AiFeature): Promise<boolean>`	`true` si se puede generar para esa funcion ahora (nunca lanza). Util para degradar con `ai.required: false`. js `const showButton = await ctx.services.ai.isAvailable("translate");`

Ejemplos

module.exports.summarize = async (ctx) => {
  const ai = ctx.services.ai;
  if (!(await ai.isAvailable("summarize"))) return { text: "", degraded: true };
  const r = await ai.generate({ prompt: String(ctx.args.text), system: "Resume en una frase.", feature: "summarize", maxTokens: 200 });
  return { text: r.text };
};

HandlerServices

Referencia a

Fuente: bloomx-extensions/_shared/sdk/ctx.d.ts:274 · ctx.d.ts

Interfazhost

AiService

Firma

host · Interfaz

export interface AiService {
    generate(input: AiGenerateInput): Promise<AiResult>;
    generate(system: string, prompt: string, extra?: { response_format?: { type: "json_object" | "text"; }; feature?: AiFeature; maxTokens?: number; temperature?: number; }): Promise<string>;
    chat(input: AiChatInput): Promise<AiResult>;
    json<T = unknown>(input: string | (Partial<AiChatInput> & { prompt?: string; }), schema: JsonSchema, options?: Pick<AiCommonInput, "feature" | "system" | "maxTokens" | "temperature" | "parts"> & { retries?: 0 | 1 | 2; }): Promise<AiJsonResult<T>>;
    status(feature?: AiFeature): Promise<AiStatus>;
    isAvailable(feature?: AiFeature): Promise<boolean>;
}

Miembros (6)

Miembros
Nombre	Tipo	Descripción
generate	`generate(input: AiGenerateInput): Promise<AiResult>`	Genera texto. Firma nueva `generate({ prompt, system?, feature?, maxTokens?, temperature?, responseFormat? }) -> AiResult`. Firma ANTIGUA `generate(system, prompt, extra?) -> string` (sigue funcionando; `extra.response_format.type = "json_object"` pide JSON). js `const r = await ctx.services.ai.generate({ prompt: "Hola", feature: "other" }); const legacyText = await ctx.services.ai.generate("Eres breve.", "Hola");`
generate	`generate(system: string, prompt: string, extra?: { response_format?: { type: "json_object" \| "text"; }; feature?: AiFeature; maxTokens?: number; temperature?: number; }): Promise<string>`	Sin descripción.
chat	`chat(input: AiChatInput): Promise<AiResult>`	Conversacion con varios mensajes. js `const r = await ctx.services.ai.chat({ messages: [{ role: "user", content: "Hola" }], feature: "smart-reply" });`
json	`json<T = unknown>(input: string \| (Partial<AiChatInput> & { prompt?: string; }), schema: JsonSchema, options?: Pick<AiCommonInput, "feature" \| "system" \| "maxTokens" \| "temperature" \| "parts"> & { retries?: 0 \| 1 \| 2; }): Promise<AiJsonResult<T>>`	Salida estructurada: la instancia valida contra `schema` (y reintenta hasta `retries`, max 2); si no cumple lanza `schema_validation_failed`. `input` es el prompt o `{ prompt \| messages, system?, feature? }`. js `const r = await ctx.services.ai.json("Extrae el importe de: " + ctx.args.text, { type: "object", required: ["amount"], properties: { amount: { type: "number" } } }, { feature: "other", retries: 1 });`
status	`status(feature?: AiFeature): Promise<AiStatus>`	Estado de la IA (no consume cuota de generacion; 20 consultas por invocacion). js `const st = await ctx.services.ai.status("composer");`
isAvailable	`isAvailable(feature?: AiFeature): Promise<boolean>`	`true` si se puede generar para esa funcion ahora (nunca lanza). Util para degradar con `ai.required: false`. js `const showButton = await ctx.services.ai.isAvailable("translate");`

Ejemplos

module.exports.summarize = async (ctx) => {
  const ai = ctx.services.ai;
  if (!(await ai.isAvailable("summarize"))) return { text: "", degraded: true };
  const r = await ai.generate({ prompt: String(ctx.args.text), system: "Resume en una frase.", feature: "summarize", maxTokens: 200 });
  return { text: r.text };
};

HandlerServices

Referencia a

Fuente: bloomx-extensions/_shared/sdk/ctx.d.ts:274 · ctx.d.ts

Estructura

Texto

Acciones

Entradas y formularios

Datos

Navegación

Estado y avisos

Superpuestos

Gráficos

Lógica

AiService

Firma

Miembros (6)

Ejemplos

Referencia a

Estructura

Texto

Acciones

Entradas y formularios

Datos

Navegación

Estado y avisos

Superpuestos

Gráficos

Lógica

AiService

Firma

Miembros (6)

Ejemplos

Referencia a

Firma

Miembros (6)

Ejemplos

Usado en / Referenciado por

Referencia a

Firma

Miembros (6)

Ejemplos

Usado en / Referenciado por

Referencia a