import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateAIAgentRequest, CreateAIAgentResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreateAIAgentCommand}. */ export interface CreateAIAgentCommandInput extends CreateAIAgentRequest { } /** * @public * * The output of {@link CreateAIAgentCommand}. */ export interface CreateAIAgentCommandOutput extends CreateAIAgentResponse, __MetadataBearer { } declare const CreateAIAgentCommand_base: { new (input: CreateAIAgentCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateAIAgentCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Creates an Amazon Q in Connect AI Agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { QConnectClient, CreateAIAgentCommand } from "@aws-sdk/client-qconnect"; // ES Modules import * // const { QConnectClient, CreateAIAgentCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import * // import type { QConnectClientConfig } from "@aws-sdk/client-qconnect"; * const config = {}; // type is QConnectClientConfig * const client = new QConnectClient(config); * const input = { // CreateAIAgentRequest * clientToken: "STRING_VALUE", * assistantId: "STRING_VALUE", // required * name: "STRING_VALUE", // required * type: "STRING_VALUE", // required * configuration: { // AIAgentConfiguration Union: only one key present * manualSearchAIAgentConfiguration: { // ManualSearchAIAgentConfiguration * answerGenerationAIPromptId: "STRING_VALUE", * answerGenerationAIGuardrailId: "STRING_VALUE", * associationConfigurations: [ // AssociationConfigurationList * { // AssociationConfiguration * associationId: "STRING_VALUE", * associationType: "STRING_VALUE", * associationConfigurationData: { // AssociationConfigurationData Union: only one key present * knowledgeBaseAssociationConfigurationData: { // KnowledgeBaseAssociationConfigurationData * contentTagFilter: { // TagFilter Union: only one key present * tagCondition: { // TagCondition * key: "STRING_VALUE", // required * value: "STRING_VALUE", * }, * andConditions: [ // AndConditions * { * key: "STRING_VALUE", // required * value: "STRING_VALUE", * }, * ], * orConditions: [ // OrConditions * { // OrCondition Union: only one key present * andConditions: [ * "", * ], * tagCondition: "", * }, * ], * }, * maxResults: Number("int"), * overrideKnowledgeBaseSearchType: "STRING_VALUE", * }, * }, * }, * ], * locale: "STRING_VALUE", * }, * answerRecommendationAIAgentConfiguration: { // AnswerRecommendationAIAgentConfiguration * intentLabelingGenerationAIPromptId: "STRING_VALUE", * queryReformulationAIPromptId: "STRING_VALUE", * answerGenerationAIPromptId: "STRING_VALUE", * answerGenerationAIGuardrailId: "STRING_VALUE", * associationConfigurations: [ * { * associationId: "STRING_VALUE", * associationType: "STRING_VALUE", * associationConfigurationData: {// Union: only one key present * knowledgeBaseAssociationConfigurationData: { * contentTagFilter: {// Union: only one key present * tagCondition: "", * andConditions: [ * "", * ], * orConditions: [ * {// Union: only one key present * andConditions: [ * "", * ], * tagCondition: "", * }, * ], * }, * maxResults: Number("int"), * overrideKnowledgeBaseSearchType: "STRING_VALUE", * }, * }, * }, * ], * locale: "STRING_VALUE", * suggestedMessages: [ // SuggestedMessagesList * "STRING_VALUE", * ], * }, * selfServiceAIAgentConfiguration: { // SelfServiceAIAgentConfiguration * selfServicePreProcessingAIPromptId: "STRING_VALUE", * selfServiceAnswerGenerationAIPromptId: "STRING_VALUE", * selfServiceAIGuardrailId: "STRING_VALUE", * associationConfigurations: [ * { * associationId: "STRING_VALUE", * associationType: "STRING_VALUE", * associationConfigurationData: {// Union: only one key present * knowledgeBaseAssociationConfigurationData: { * contentTagFilter: {// Union: only one key present * tagCondition: "", * andConditions: [ * "", * ], * orConditions: [ * {// Union: only one key present * andConditions: "", * tagCondition: "", * }, * ], * }, * maxResults: Number("int"), * overrideKnowledgeBaseSearchType: "STRING_VALUE", * }, * }, * }, * ], * }, * emailResponseAIAgentConfiguration: { // EmailResponseAIAgentConfiguration * emailResponseAIPromptId: "STRING_VALUE", * emailQueryReformulationAIPromptId: "STRING_VALUE", * locale: "STRING_VALUE", * associationConfigurations: [ * { * associationId: "STRING_VALUE", * associationType: "STRING_VALUE", * associationConfigurationData: {// Union: only one key present * knowledgeBaseAssociationConfigurationData: { * contentTagFilter: {// Union: only one key present * tagCondition: "", * andConditions: "", * orConditions: [ * {// Union: only one key present * andConditions: "", * tagCondition: "", * }, * ], * }, * maxResults: Number("int"), * overrideKnowledgeBaseSearchType: "STRING_VALUE", * }, * }, * }, * ], * }, * emailOverviewAIAgentConfiguration: { // EmailOverviewAIAgentConfiguration * emailOverviewAIPromptId: "STRING_VALUE", * locale: "STRING_VALUE", * }, * emailGenerativeAnswerAIAgentConfiguration: { // EmailGenerativeAnswerAIAgentConfiguration * emailGenerativeAnswerAIPromptId: "STRING_VALUE", * emailQueryReformulationAIPromptId: "STRING_VALUE", * locale: "STRING_VALUE", * associationConfigurations: [ * { * associationId: "STRING_VALUE", * associationType: "STRING_VALUE", * associationConfigurationData: {// Union: only one key present * knowledgeBaseAssociationConfigurationData: { * contentTagFilter: {// Union: only one key present * tagCondition: "", * andConditions: "", * orConditions: [ * {// Union: only one key present * andConditions: "", * tagCondition: "", * }, * ], * }, * maxResults: Number("int"), * overrideKnowledgeBaseSearchType: "STRING_VALUE", * }, * }, * }, * ], * }, * orchestrationAIAgentConfiguration: { // OrchestrationAIAgentConfiguration * orchestrationAIPromptId: "STRING_VALUE", // required * orchestrationAIGuardrailId: "STRING_VALUE", * toolConfigurations: [ // ToolConfigurationList * { // ToolConfiguration * toolName: "STRING_VALUE", // required * toolType: "STRING_VALUE", // required * title: "STRING_VALUE", * toolId: "STRING_VALUE", * description: "STRING_VALUE", * instruction: { // ToolInstruction * instruction: "STRING_VALUE", * examples: [ // ToolExampleList * "STRING_VALUE", * ], * }, * overrideInputValues: [ // ToolOverrideInputValueList * { // ToolOverrideInputValue * jsonPath: "STRING_VALUE", // required * value: { // ToolOverrideInputValueConfiguration Union: only one key present * constant: { // ToolOverrideConstantInputValue * type: "STRING_VALUE", // required * value: "STRING_VALUE", // required * }, * }, * }, * ], * outputFilters: [ // ToolOutputFilterList * { // ToolOutputFilter * jsonPath: "STRING_VALUE", // required * outputConfiguration: { // ToolOutputConfiguration * outputVariableNameOverride: "STRING_VALUE", * sessionDataNamespace: "STRING_VALUE", * }, * }, * ], * inputSchema: "DOCUMENT_VALUE", * outputSchema: "DOCUMENT_VALUE", * annotations: { // Annotation * title: "STRING_VALUE", * destructiveHint: true || false, * }, * userInteractionConfiguration: { // UserInteractionConfiguration * isUserConfirmationRequired: true || false, * }, * }, * ], * connectInstanceArn: "STRING_VALUE", * locale: "STRING_VALUE", * }, * noteTakingAIAgentConfiguration: { // NoteTakingAIAgentConfiguration * noteTakingAIPromptId: "STRING_VALUE", * noteTakingAIGuardrailId: "STRING_VALUE", * locale: "STRING_VALUE", * }, * caseSummarizationAIAgentConfiguration: { // CaseSummarizationAIAgentConfiguration * caseSummarizationAIPromptId: "STRING_VALUE", * caseSummarizationAIGuardrailId: "STRING_VALUE", * locale: "STRING_VALUE", * }, * }, * visibilityStatus: "STRING_VALUE", // required * tags: { // Tags * "": "STRING_VALUE", * }, * description: "STRING_VALUE", * }; * const command = new CreateAIAgentCommand(input); * const response = await client.send(command); * // { // CreateAIAgentResponse * // aiAgent: { // AIAgentData * // assistantId: "STRING_VALUE", // required * // assistantArn: "STRING_VALUE", // required * // aiAgentId: "STRING_VALUE", // required * // aiAgentArn: "STRING_VALUE", // required * // name: "STRING_VALUE", // required * // type: "STRING_VALUE", // required * // configuration: { // AIAgentConfiguration Union: only one key present * // manualSearchAIAgentConfiguration: { // ManualSearchAIAgentConfiguration * // answerGenerationAIPromptId: "STRING_VALUE", * // answerGenerationAIGuardrailId: "STRING_VALUE", * // associationConfigurations: [ // AssociationConfigurationList * // { // AssociationConfiguration * // associationId: "STRING_VALUE", * // associationType: "STRING_VALUE", * // associationConfigurationData: { // AssociationConfigurationData Union: only one key present * // knowledgeBaseAssociationConfigurationData: { // KnowledgeBaseAssociationConfigurationData * // contentTagFilter: { // TagFilter Union: only one key present * // tagCondition: { // TagCondition * // key: "STRING_VALUE", // required * // value: "STRING_VALUE", * // }, * // andConditions: [ // AndConditions * // { * // key: "STRING_VALUE", // required * // value: "STRING_VALUE", * // }, * // ], * // orConditions: [ // OrConditions * // { // OrCondition Union: only one key present * // andConditions: [ * // "", * // ], * // tagCondition: "", * // }, * // ], * // }, * // maxResults: Number("int"), * // overrideKnowledgeBaseSearchType: "STRING_VALUE", * // }, * // }, * // }, * // ], * // locale: "STRING_VALUE", * // }, * // answerRecommendationAIAgentConfiguration: { // AnswerRecommendationAIAgentConfiguration * // intentLabelingGenerationAIPromptId: "STRING_VALUE", * // queryReformulationAIPromptId: "STRING_VALUE", * // answerGenerationAIPromptId: "STRING_VALUE", * // answerGenerationAIGuardrailId: "STRING_VALUE", * // associationConfigurations: [ * // { * // associationId: "STRING_VALUE", * // associationType: "STRING_VALUE", * // associationConfigurationData: {// Union: only one key present * // knowledgeBaseAssociationConfigurationData: { * // contentTagFilter: {// Union: only one key present * // tagCondition: "", * // andConditions: [ * // "", * // ], * // orConditions: [ * // {// Union: only one key present * // andConditions: [ * // "", * // ], * // tagCondition: "", * // }, * // ], * // }, * // maxResults: Number("int"), * // overrideKnowledgeBaseSearchType: "STRING_VALUE", * // }, * // }, * // }, * // ], * // locale: "STRING_VALUE", * // suggestedMessages: [ // SuggestedMessagesList * // "STRING_VALUE", * // ], * // }, * // selfServiceAIAgentConfiguration: { // SelfServiceAIAgentConfiguration * // selfServicePreProcessingAIPromptId: "STRING_VALUE", * // selfServiceAnswerGenerationAIPromptId: "STRING_VALUE", * // selfServiceAIGuardrailId: "STRING_VALUE", * // associationConfigurations: [ * // { * // associationId: "STRING_VALUE", * // associationType: "STRING_VALUE", * // associationConfigurationData: {// Union: only one key present * // knowledgeBaseAssociationConfigurationData: { * // contentTagFilter: {// Union: only one key present * // tagCondition: "", * // andConditions: [ * // "", * // ], * // orConditions: [ * // {// Union: only one key present * // andConditions: "", * // tagCondition: "", * // }, * // ], * // }, * // maxResults: Number("int"), * // overrideKnowledgeBaseSearchType: "STRING_VALUE", * // }, * // }, * // }, * // ], * // }, * // emailResponseAIAgentConfiguration: { // EmailResponseAIAgentConfiguration * // emailResponseAIPromptId: "STRING_VALUE", * // emailQueryReformulationAIPromptId: "STRING_VALUE", * // locale: "STRING_VALUE", * // associationConfigurations: [ * // { * // associationId: "STRING_VALUE", * // associationType: "STRING_VALUE", * // associationConfigurationData: {// Union: only one key present * // knowledgeBaseAssociationConfigurationData: { * // contentTagFilter: {// Union: only one key present * // tagCondition: "", * // andConditions: "", * // orConditions: [ * // {// Union: only one key present * // andConditions: "", * // tagCondition: "", * // }, * // ], * // }, * // maxResults: Number("int"), * // overrideKnowledgeBaseSearchType: "STRING_VALUE", * // }, * // }, * // }, * // ], * // }, * // emailOverviewAIAgentConfiguration: { // EmailOverviewAIAgentConfiguration * // emailOverviewAIPromptId: "STRING_VALUE", * // locale: "STRING_VALUE", * // }, * // emailGenerativeAnswerAIAgentConfiguration: { // EmailGenerativeAnswerAIAgentConfiguration * // emailGenerativeAnswerAIPromptId: "STRING_VALUE", * // emailQueryReformulationAIPromptId: "STRING_VALUE", * // locale: "STRING_VALUE", * // associationConfigurations: [ * // { * // associationId: "STRING_VALUE", * // associationType: "STRING_VALUE", * // associationConfigurationData: {// Union: only one key present * // knowledgeBaseAssociationConfigurationData: { * // contentTagFilter: {// Union: only one key present * // tagCondition: "", * // andConditions: "", * // orConditions: [ * // {// Union: only one key present * // andConditions: "", * // tagCondition: "", * // }, * // ], * // }, * // maxResults: Number("int"), * // overrideKnowledgeBaseSearchType: "STRING_VALUE", * // }, * // }, * // }, * // ], * // }, * // orchestrationAIAgentConfiguration: { // OrchestrationAIAgentConfiguration * // orchestrationAIPromptId: "STRING_VALUE", // required * // orchestrationAIGuardrailId: "STRING_VALUE", * // toolConfigurations: [ // ToolConfigurationList * // { // ToolConfiguration * // toolName: "STRING_VALUE", // required * // toolType: "STRING_VALUE", // required * // title: "STRING_VALUE", * // toolId: "STRING_VALUE", * // description: "STRING_VALUE", * // instruction: { // ToolInstruction * // instruction: "STRING_VALUE", * // examples: [ // ToolExampleList * // "STRING_VALUE", * // ], * // }, * // overrideInputValues: [ // ToolOverrideInputValueList * // { // ToolOverrideInputValue * // jsonPath: "STRING_VALUE", // required * // value: { // ToolOverrideInputValueConfiguration Union: only one key present * // constant: { // ToolOverrideConstantInputValue * // type: "STRING_VALUE", // required * // value: "STRING_VALUE", // required * // }, * // }, * // }, * // ], * // outputFilters: [ // ToolOutputFilterList * // { // ToolOutputFilter * // jsonPath: "STRING_VALUE", // required * // outputConfiguration: { // ToolOutputConfiguration * // outputVariableNameOverride: "STRING_VALUE", * // sessionDataNamespace: "STRING_VALUE", * // }, * // }, * // ], * // inputSchema: "DOCUMENT_VALUE", * // outputSchema: "DOCUMENT_VALUE", * // annotations: { // Annotation * // title: "STRING_VALUE", * // destructiveHint: true || false, * // }, * // userInteractionConfiguration: { // UserInteractionConfiguration * // isUserConfirmationRequired: true || false, * // }, * // }, * // ], * // connectInstanceArn: "STRING_VALUE", * // locale: "STRING_VALUE", * // }, * // noteTakingAIAgentConfiguration: { // NoteTakingAIAgentConfiguration * // noteTakingAIPromptId: "STRING_VALUE", * // noteTakingAIGuardrailId: "STRING_VALUE", * // locale: "STRING_VALUE", * // }, * // caseSummarizationAIAgentConfiguration: { // CaseSummarizationAIAgentConfiguration * // caseSummarizationAIPromptId: "STRING_VALUE", * // caseSummarizationAIGuardrailId: "STRING_VALUE", * // locale: "STRING_VALUE", * // }, * // }, * // modifiedTime: new Date("TIMESTAMP"), * // description: "STRING_VALUE", * // visibilityStatus: "STRING_VALUE", // required * // tags: { // Tags * // "": "STRING_VALUE", * // }, * // origin: "STRING_VALUE", * // status: "STRING_VALUE", * // }, * // }; * * ``` * * @param CreateAIAgentCommandInput - {@link CreateAIAgentCommandInput} * @returns {@link CreateAIAgentCommandOutput} * @see {@link CreateAIAgentCommandInput} for command's `input` shape. * @see {@link CreateAIAgentCommandOutput} for command's `response` shape. * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You do not have sufficient access to perform this action.

* * @throws {@link ConflictException} (client fault) *

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

* * @throws {@link ResourceNotFoundException} (client fault) *

The specified resource does not exist.

* * @throws {@link ServiceQuotaExceededException} (client fault) *

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

* * @throws {@link ThrottlingException} (client fault) *

The throttling limit has been exceeded.

* * @throws {@link UnauthorizedException} (client fault) *

You do not have permission to perform this action.

* * @throws {@link ValidationException} (client fault) *

The input fails to satisfy the constraints specified by a service.

* * @throws {@link QConnectServiceException} *

Base exception class for all service exceptions from QConnect service.

* * * @public */ export declare class CreateAIAgentCommand extends CreateAIAgentCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateAIAgentRequest; output: CreateAIAgentResponse; }; sdk: { input: CreateAIAgentCommandInput; output: CreateAIAgentCommandOutput; }; }; }