Skip to main content
Version: v2

Create Profile​

Create the summarization Profile that specifies both prompting instructions and session context configuration.

Request Body required
    slice object optional
    mode remove earliest or latest events as defined optional

    Possible values: [UNSPECIFIED, FIRST, LAST, TIMESTAMP]

    Default value: FIRST

    event_limit int32 optional
    duration_limit_ms int64 optional
    start_timestamp date-time optional

    If specified, the event limit and duration limit will be applied to the time beginning at this timestamp.

    context object optional
    include string[] optional

    Controls the session context elements to include, takes precedence over individual inclusion fields. Can be 'user', 'org', 'location', 'device'. If not specified and not excluded, all context elements are included.

    exclude string[] optional

    Controls the session context elements to exclude, takes precedence over individual exclusion fields. Can be 'user', 'org', 'location', 'device'. If not specified and not excluded, all context elements are included.

    exclude_org_context boolean optional
    exclude_user_context boolean optional
    exclude_location boolean optional
    exclude_device boolean optional
    exclude_descriptions boolean optional
    events object optional
    exclude_types string[] optional
    include_types string[] optional
    exclude_defined_events boolean optional
    exclude_api_events boolean optional
    exclude_event_timestamps boolean optional
    exclude_selectors boolean optional
    include_selector_tags boolean optional
    trim_to_last_n_selectors int32 optional
    include_tab_index boolean optional
    cache object optional
    enable_event_cache boolean optional
    llm object optional

    Configuration used to select the LLM model and related prompt and inference options.

    pre_prompt string optional

    Text to be included in the Generative AI prompt before including the contextual representation of the requested session.

    post_prompt string optional

    Text to be included in the Generative AI prompt before including the contextual representation of the requested session.

    output_schema Optional JSON Schema to define output optional

    JSON schema to provide to Generative AI for formatting of result and to be used to validate the proper output format. (legacy string based)

    model string optional

    Possible values: [GEMINI_2_FLASH, GEMINI_2_FLASH_LITE]

    Default value: GEMINI_2_FLASH_LITE

    Generative AI large language model to use.

    temperature float optional

    Controls the randomness of text generated by a large language model.

    response_schema object optional

    JSON schema for generating structured response. enforced at LLM, highly reliable

    type we want this client facing message to be as close as possible to json schema https://json-schema.org/ we will add new fields as needed optional

    Possible values: [OPENAPI_TYPE_UNSPECIFIED, STRING, NUMBER, INTEGER, BOOLEAN, ARRAY, OBJECT]

    Default value: OPENAPI_TYPE_UNSPECIFIED

    title string optional
    description string optional
    items object optional
    0 optional
    1 optional
    2 optional
    3 optional
    4 optional
    5 optional
    6 optional
    7 optional
    8 optional
    9 optional
    10 optional
    11 optional
    12 optional
    13 optional
    14 optional
    15 optional
    16 optional
    17 optional
    18 optional
    19 optional
    20 optional
    21 optional
    22 optional
    23 optional
    24 optional
    properties object optional
    property name* object optional
    0 optional
    1 optional
    2 optional
    3 optional
    4 optional
    5 optional
    6 optional
    7 optional
    8 optional
    9 optional
    10 optional
    11 optional
    12 optional
    13 optional
    14 optional
    15 optional
    16 optional
    17 optional
    18 optional
    19 optional
    20 optional
    21 optional
    22 optional
    23 optional
    24 optional
    required string[] optional
    nullable boolean optional
    enum string[] optional
    name string optional

    The display name of the profile.

Responses
200

A successful response.

{}
Loading...