- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateAIAgentVersionCommand
Creates and Amazon Q in Connect AI Agent version.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QConnectClient, CreateAIAgentVersionCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, CreateAIAgentVersionCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // CreateAIAgentVersionRequest
assistantId: "STRING_VALUE", // required
aiAgentId: "STRING_VALUE", // required
modifiedTime: new Date("TIMESTAMP"),
clientToken: "STRING_VALUE",
};
const command = new CreateAIAgentVersionCommand(input);
const response = await client.send(command);
// { // CreateAIAgentVersionResponse
// 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>",
// ],
// tagCondition: "<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: "<TagCondition>",
// andConditions: [
// "<TagCondition>",
// ],
// orConditions: [
// {// Union: only one key present
// andConditions: [
// "<TagCondition>",
// ],
// tagCondition: "<TagCondition>",
// },
// ],
// },
// maxResults: Number("int"),
// overrideKnowledgeBaseSearchType: "STRING_VALUE",
// },
// },
// },
// ],
// locale: "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: "<TagCondition>",
// andConditions: [
// "<TagCondition>",
// ],
// orConditions: [
// {// Union: only one key present
// andConditions: "<AndConditions>",
// tagCondition: "<TagCondition>",
// },
// ],
// },
// maxResults: Number("int"),
// overrideKnowledgeBaseSearchType: "STRING_VALUE",
// },
// },
// },
// ],
// },
// },
// modifiedTime: new Date("TIMESTAMP"),
// description: "STRING_VALUE",
// visibilityStatus: "STRING_VALUE", // required
// tags: { // Tags
// "<keys>": "STRING_VALUE",
// },
// origin: "STRING_VALUE",
// status: "STRING_VALUE",
// },
// versionNumber: Number("long"),
// };
CreateAIAgentVersionCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
aiAgentId Required | string | undefined | The identifier of the Amazon Q in Connect AI Agent. |
assistantId Required | string | undefined | The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. |
clientToken | string | undefined | A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs .. |
modifiedTime | Date | undefined | The modification time of the AI Agent should be tracked for version creation. This field should be specified to avoid version creation when simultaneous update to the underlying AI Agent are possible. The value should be the modifiedTime returned from the request to create or update an AI Agent so that version creation can fail if an update to the AI Agent post the specified modification time has been made. |
CreateAIAgentVersionCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
aiAgent | AIAgentData | undefined | The data of the AI Agent version. |
versionNumber | number | undefined | The version number of the AI Agent version. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
ConflictException | client | The request could not be processed because of conflict in the current state of the resource. For example, if you're using a |
ResourceNotFoundException | client | The specified resource does not exist. |
ServiceQuotaExceededException | client | 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. |
ThrottlingException | client | The throttling limit has been exceeded. |
ValidationException | client | The input fails to satisfy the constraints specified by a service. |
QConnectServiceException | Base exception class for all service exceptions from QConnect service. |