Member Junction
    Preparing search index...

    Interface GetExamplesParams

    Parameters for retrieving examples in a specific context

    interface GetExamplesParams {
        agentId: string;
        companyId?: string;
        contextUser: UserInfo;
        currentInput?: string;
        maxExamples: number;
        observability?: NotesObservabilityOptions;
        primaryScopeEntityId?: string;
        primaryScopeRecordId?: string;
        rerankerConfig?: RerankerConfiguration;
        secondaryScopeConfig?: SecondaryScopeConfig;
        secondaryScopes?: Record<string, SecondaryScopeValue>;
        SharedOnly?: boolean;
        strategy: "Recent" | "Semantic" | "Rated";
        userId?: string;
    }
    Index

    Properties

    agentId companyId? contextUser currentInput? maxExamples observability? primaryScopeEntityId? primaryScopeRecordId? rerankerConfig? secondaryScopeConfig? secondaryScopes? SharedOnly? strategy userId?

    Properties

    agentId: string
    companyId?: string
    contextUser: UserInfo
    currentInput?: string
    maxExamples: number
    observability?: NotesObservabilityOptions

    Optional observability context for tracing the examples rerank, as for notes.

    primaryScopeEntityId?: string

    Primary scope entity ID for multi-tenant filtering (FK to Entity table).

    primaryScopeRecordId?: string

    Primary scope record ID for multi-tenant filtering.

    rerankerConfig?: RerankerConfiguration

    Optional reranker configuration. Examples are reranked only when it is enabled and its rerankExamples flag is true.

    secondaryScopeConfig?: SecondaryScopeConfig

    Optional secondary scope configuration from the agent. Defines per-dimension inheritance modes and validation rules.

    secondaryScopes?: Record<string, SecondaryScopeValue>

    Arbitrary secondary scope dimensions for multi-tenant filtering.

    SharedOnly?: boolean

    Inject only shared examples (no UserID). See GetNotesParams.SharedOnly.

    strategy: "Recent" | "Semantic" | "Rated"
    userId?: string

    Settings

    Member Visibility

    On This Page

    Properties