Generate Summary With Overrides

Return a generative AI summarization of the specified session using the supplied prompt summary profile that specifies both prompting instructions and session context configuration.

Use the GET version of this endpoint when generating a summary with an existing prompt profile as-is. Use this POST version when you'd like to provide an ad-hoc prompt or a profile configuration, or when you need to override specific prompt profile parameters for a single request. When overrides are provided, non-array fields replace the profile values and array fields are additive. See Merging Examples for details.

See the Generate Summary Overview section of the Introduction for detailed guidance on generating session summaries.

This functionality is a part of Anywhere: Activation. To learn more about Fullstory Anywhere, please visit this page.

Responses

200

Text based output of the Generative AI response based on the specified Profile.

Merging Examples

The following examples illustrate how override values are merged with the existing prompt profile configuration.

Example: Replacing a value

When a non-empty override is provided for a non-array field, it replaces the profile value.

Prompt Profile:

{
    "llm": {
        "pre_prompt": "Provide a summary for this session"
    }
}

Override in request body:

{
    "llm": {
        "pre_prompt": "Provide a summary for this session for a customer support agent"
    }
}

Result: The pre_prompt is replaced with the override value:

{
    "llm": {
        "pre_prompt": "Provide a summary for this session for a customer support agent"
    }
}

Example: Appending to an array

When an override is provided for an array field, the override values are appended to the profile's existing list.

Prompt Profile:

{
    "events": {
        "include_types": ["navigate", "click"]
    }
}

Override in request body:

{
    "events": {
        "include_types": ["Added to Cart"]
    }
}

Result: The override values are appended to the existing list:

{
    "events": {
        "include_types": ["navigate", "click", "Added to Cart"]
    }
}