GOgooddata
Document Takeaway

(EXPERIMENTAL) Generate a document 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.

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

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Path parameters

workspace_idstring required

Request body

agentIdstring

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

maxCharactersinteger

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

Response

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.

generatedAtstring date-time required
noDataboolean required

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

takeawaystring required

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

Changes

No recorded changes to this operation across all 1 revision of this API.