Summarize activity

Módulo Settings

POST/aurora/summarizeaurora.summarize

Summarizes a record's activity, a project's week or gate readiness, citing the items each point comes from. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad home.dashboard.read.
Alcances de OAuth: home.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: AuroraSummarizeRequest

aurora.summarize: AuroraSummarizeRequest
Campo	Tipo	Obligatorio	Descripción
kind	"record_activity" \| "project_week" \| "gate_readiness"	Sí	What to summarize.
subject_collection	string	Sí	Collection of the record or project summarized.Restricciones: pattern ^[a-z][a-z0-9-]*$
subject_id	string (uuid)	Sí	Identifier of the record or project summarized.
items	array of object	Sí	Activity and records to summarize, read with the caller's permissions.

{
  "kind": "project_week",
  "subject_collection": "projects",
  "subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "items": [
    {
      "collection": "activity-events",
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
    }
  ]
}

Respuesta 200: AuroraResult

aurora.summarize: AuroraResult
Campo	Tipo	Obligatorio	Descripción
outcome	"answer" \| "no_answer" \| "failed"	Sí	answer, no_answer (the data does not support an answer; `missing` says why) or failed (the model call failed and was logged).
ai_generated	true	Sí	Always true: the content is AI-generated and is labeled so (EU AI Act Article 50).
request_id	string (uuid) \| null	Sí	Identifier of the logged AI request; null when no model was called.
model	string \| null	Sí	Model that answered.Restricciones: length 1 to 100
missing	string \| null	Sí	What the data lacks, for no_answer.Restricciones: length 1 to 500
failure_code	string \| null	Sí	Why the request failed.Restricciones: length 1 to 64
answer	object	No	The feature's answer for outcome answer, shaped per operation; null otherwise.
suggestions	array of AuroraProposal	Sí	Changes stored for confirmation.

{
  "outcome": "answer",
  "ai_generated": true,
  "request_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "model": "claude-sonnet-5-5",
  "missing": "No budget lines exist yet.",
  "failure_code": "model_error",
  "answer": {
    "text": "One permit is blocked: Fire Marshal Permit.",
    "citations": []
  },
  "suggestions": [
    {
      "suggestion_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "operation_id": "savedViews.create",
      "summary": "Save the view Blocked Miami Permits."
    }
  ]
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/aurora/summarize" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"kind":"project_week","subject_collection":"projects","subject_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","items":[{"collection":"activity-events","id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}]}'

const { data } = await xos.aurora.summarize({
    "kind": "project_week",
    "subject_collection": "projects",
    "subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "items": [
      {
        "collection": "activity-events",
        "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
      }
    ]
  });

response = xos.aurora.summarize({"kind": "project_week", "subject_collection": "projects", "subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "items": [{"collection": "activity-events", "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}]})

xos aurora summarize --data '{"kind":"project_week","subject_collection":"projects","subject_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","items":[{"collection":"activity-events","id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}]}'