@adobe/genstudio-extensibility-sdk/dist/esm/types/generationContext/GenerationContext.d.ts

GenStudio Extensibility SDK

import { Channel } from "../channel/Channel";
import { Experience } from "../experience/Experience";
/** Generation Context */
export type Brand = {
    id: string;
    name?: string;
};
export type Persona = {
    id: string;
    name?: string;
};
export type Product = {
    id: string;
    name?: string;
};
export type Claim = {
    id: string;
    description: string;
};
export declare enum AdditionalContextTypes {
    Claims = "claims"
}
export type AdditionalContextValues<T> = T[];
export type AdditionalContext<T> = {
    extensionId: string;
    additionalContextType: AdditionalContextTypes;
    additionalContextValues: AdditionalContextValues<T>;
};
export type SectionGenerationContext = {
    id: string;
    additionalContexts?: AdditionalContext<any>[];
    product?: Product;
};
export type GenerationContext = {
    id: string;
    userPrompt: string;
    /**
     * @deprecated Use {@link Experience.channels} instead
     */
    channel?: Channel;
    locale?: string;
    brand?: Brand;
    product?: Product;
    persona?: Persona;
    additionalContexts?: AdditionalContext<any>[];
    sections?: SectionGenerationContext[] | undefined;
    sourceExperience?: Experience;
};