Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reports
Publisher Documents
Reporting
Export & Automations
AI Lake
AI Assistant
    Conversations
    Dashboard Summary
    Document Takeaway
      (EXPERIMENTAL) Generate a document takeawaypost
    Knowledge
    Knowledge Recommendations
    Memory Items
    LLM Providers
    Observability
    AI Search Data
Agents
Other
Schemas
powered by Zudoku
OpenAPI definition

Document Takeaway

Endpoint:/

Write a short takeaway for a slot of a document from the data of its visualizations, in the voice of an AI Hub agent.

(EXPERIMENTAL) Generate a document takeaway

POST
/api/v1/ai/workspaces/{workspace_id}/takeaway

Note: This API is an experimental and is going to change. Please, use it accordingly. Writes a short takeaway for one slot of a document, based on the data of the given visualizations. The text is written as the given AI Hub agent, or as the user's default agent. Without either agent, the request fails. When no visualization has data, the response sets noData, carries no text and no model is called.

(EXPERIMENTAL) Generate a document takeaway › path Parameters

  • workspace_idstring · required

(EXPERIMENTAL) Generate a document takeaway › Request Body

  • dataobject · required
  • agentId

    The AI Hub agent that writes the takeaway. Omit it to use the user's default agent.

  • instructionsobject
  • maxCharacters

    Upper limit for the length of the takeaway, in characters.

(EXPERIMENTAL) Generate a document takeaway › Responses

Successful Response

  • agentIdstring · required

    The AI Hub agent that the takeaway is written as.

  • contextOmittedstring[] · required

    The context parts that did not fully load because a lookup failed or timed out, wholly or partly. The takeaway uses what did load. A part that configuration switches off is never listed.

    Enum values:
    memory
    knowledge
  • generatedAtstring · date-time · required
  • noDataboolean · required

    true when no visualization has data for the filters. Then no text is written and nothing is charged.

  • takeawayrequired

    The takeaway text. It is null when noData is true.

POST /api/v1/ai/workspaces/{workspace_id}/takeaway
Dashboard SummaryKnowledge