@salesforce/agents
    Preparing search index...

    Type Alias AgentJobSpecCreateConfig

    The parameters used to generate an agent spec.

    type AgentJobSpecCreateConfig = {
        agentType: AgentType;
        companyDescription: string;
        companyName: string;
        companyWebsite?: string;
        groundingContext?: string;
        maxNumOfTopics?: number;
        promptTemplateName?: string;
        role: string;
    }
    Index

    Properties

    agentType companyDescription companyName companyWebsite? groundingContext? maxNumOfTopics? promptTemplateName? role

    Properties

    agentType: AgentType

    Internal type is copilots; used by customers' employees. Customer type is agents; used by customers' customers.

    companyDescription: string
    companyName: string
    companyWebsite?: string
    groundingContext?: string

    Context info to be used in customized prompt template

    maxNumOfTopics?: number

    The maximum number of topics to create in the spec. Default is 10.

    promptTemplateName?: string

    Developer name of the prompt template.

    role: string

    Settings

    Member Visibility

    On This Page

    Properties