Lime Web Components API Documentation - v6.24.0
    Preparing search index...

    Interface AIContextContributionAlpha

    Represents context information that a provider contributes to the AI chat.

    Each contribution is additive - all providers' contributions are collected into an array when the AI chat gathers context.

    interface AIContextContribution {
        data?: Record<string, JsonValue>;
        purpose?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    data? purpose?

    Properties

    data?: Record<string, JsonValue>

    Structured data about the current state.

    This data will be serialized and included in the AI prompt context. Keep the data focused and relevant to avoid filling the context window with noise.

    data: {
        currentObject: {
            limetype: 'deal',
            id: 123,
            descriptive: 'Acme Corp - Enterprise License'
        },
        availableRelations: ['company', 'person', 'activity']
    }
    purpose?: string

    Describes the purpose of this component and what it shows.

    Use this to help the AI understand what the component is for, how users interact with it, and what the data represents. This is typically hardcoded by component developers.

    Do NOT use this to restate structured data in natural language. The AI can read the data directly.

    // Good: explains what the component is and does
    purpose: 'Shows a single aggregated value from a filter. ' +
             'Clicking navigates to the explorer with that filter applied.'

    // Good: explains how to interpret the data
    purpose: 'Displays deals in a pipeline view grouped by stage. ' +
             'Users drag deals between columns to change their stage.'

    // Bad: restates structured data
    purpose: 'The user is viewing deal 123.'  // Use data instead

    Settings

    Member Visibility

    On This Page

    Properties