Type Alias AgentCreateResponse

AgentCreateResponse: {
    agentDefinition: {
        agentDescription: string;
        sampleUtterances: string[];
        topics: [
            {
                actions: [
                    {
                        actionDescription: string;
                        actionName: string;
                        exampleOutput: string;
                        inputs: [
                            {
                                inputDataType: string;
                                inputDescription: string;
                                inputName: string;
                            },
                        ];
                        outputs: [
                            {
                                outputDataType: string;
                                outputDescription: string;
                                outputName: string;
                            },
                        ];
                    },
                ];
                classificationDescription: string;
                instructions: string[];
                scope: string;
                topic: string;
            },
        ];
    };
    agentId?: { botId: string; botVersionId: string; plannerId: string };
    errorMessage?: string;
    isSuccess: boolean;
}

Type declaration

  • agentDefinition: {
        agentDescription: string;
        sampleUtterances: string[];
        topics: [
            {
                actions: [
                    {
                        actionDescription: string;
                        actionName: string;
                        exampleOutput: string;
                        inputs: [
                            {
                                inputDataType: string;
                                inputDescription: string;
                                inputName: string;
                            },
                        ];
                        outputs: [
                            {
                                outputDataType: string;
                                outputDescription: string;
                                outputName: string;
                            },
                        ];
                    },
                ];
                classificationDescription: string;
                instructions: string[];
                scope: string;
                topic: string;
            },
        ];
    }
  • OptionalagentId?: { botId: string; botVersionId: string; plannerId: string }

    If the agent was created with saveAgent=true, these are the IDs that make up an agent; Bot, BotVersion, and GenAiPlanner metadata.

  • OptionalerrorMessage?: string
  • isSuccess: boolean