@aws-sdk/client-bedrock-agent 3.685.0 → 3.687.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/README.md +8 -0
  2. package/dist-cjs/index.js +516 -49
  3. package/dist-es/BedrockAgent.js +2 -0
  4. package/dist-es/commands/CreatePromptCommand.js +1 -1
  5. package/dist-es/commands/CreatePromptVersionCommand.js +1 -1
  6. package/dist-es/commands/GetAgentVersionCommand.js +1 -1
  7. package/dist-es/commands/GetPromptCommand.js +1 -1
  8. package/dist-es/commands/UpdatePromptCommand.js +1 -1
  9. package/dist-es/commands/ValidateFlowDefinitionCommand.js +23 -0
  10. package/dist-es/commands/index.js +1 -0
  11. package/dist-es/models/index.js +1 -0
  12. package/dist-es/models/models_0.js +239 -41
  13. package/dist-es/models/models_1.js +69 -0
  14. package/dist-es/protocols/Aws_restJson1.js +141 -5
  15. package/dist-types/BedrockAgent.d.ts +7 -0
  16. package/dist-types/BedrockAgentClient.d.ts +3 -2
  17. package/dist-types/commands/CreateFlowCommand.d.ts +102 -2
  18. package/dist-types/commands/CreateFlowVersionCommand.d.ts +51 -1
  19. package/dist-types/commands/CreatePromptCommand.d.ts +97 -3
  20. package/dist-types/commands/CreatePromptVersionCommand.d.ts +49 -2
  21. package/dist-types/commands/DeleteAgentVersionCommand.d.ts +1 -1
  22. package/dist-types/commands/DeletePromptCommand.d.ts +1 -1
  23. package/dist-types/commands/GetAgentVersionCommand.d.ts +1 -1
  24. package/dist-types/commands/GetFlowCommand.d.ts +137 -1
  25. package/dist-types/commands/GetFlowVersionCommand.d.ts +51 -1
  26. package/dist-types/commands/GetPromptCommand.d.ts +49 -2
  27. package/dist-types/commands/ListAgentKnowledgeBasesCommand.d.ts +1 -1
  28. package/dist-types/commands/ListAgentVersionsCommand.d.ts +1 -1
  29. package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +1 -1
  30. package/dist-types/commands/ListPromptsCommand.d.ts +1 -1
  31. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  32. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  33. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  34. package/dist-types/commands/UpdateAgentKnowledgeBaseCommand.d.ts +1 -1
  35. package/dist-types/commands/UpdateFlowCommand.d.ts +102 -2
  36. package/dist-types/commands/UpdateKnowledgeBaseCommand.d.ts +1 -1
  37. package/dist-types/commands/UpdatePromptCommand.d.ts +97 -3
  38. package/dist-types/commands/ValidateFlowDefinitionCommand.d.ts +335 -0
  39. package/dist-types/commands/index.d.ts +1 -0
  40. package/dist-types/models/index.d.ts +1 -0
  41. package/dist-types/models/models_0.d.ts +2060 -1356
  42. package/dist-types/models/models_1.d.ts +974 -0
  43. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  44. package/dist-types/ts3.4/BedrockAgent.d.ts +17 -0
  45. package/dist-types/ts3.4/BedrockAgentClient.d.ts +8 -2
  46. package/dist-types/ts3.4/commands/CreatePromptCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/CreatePromptVersionCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/DeleteAgentVersionCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/DeletePromptCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/GetAgentVersionCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/GetPromptCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/ListAgentKnowledgeBasesCommand.d.ts +1 -1
  53. package/dist-types/ts3.4/commands/ListAgentVersionsCommand.d.ts +1 -1
  54. package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +1 -1
  55. package/dist-types/ts3.4/commands/ListPromptsCommand.d.ts +1 -1
  56. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  58. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  59. package/dist-types/ts3.4/commands/UpdateAgentKnowledgeBaseCommand.d.ts +1 -1
  60. package/dist-types/ts3.4/commands/UpdateKnowledgeBaseCommand.d.ts +1 -1
  61. package/dist-types/ts3.4/commands/UpdatePromptCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/ValidateFlowDefinitionCommand.d.ts +51 -0
  63. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  64. package/dist-types/ts3.4/models/index.d.ts +1 -0
  65. package/dist-types/ts3.4/models/models_0.d.ts +1109 -229
  66. package/dist-types/ts3.4/models/models_1.d.ts +287 -0
  67. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  68. package/package.json +35 -35
@@ -788,7 +788,7 @@ export declare const AgentStatus: {
788
788
  */
789
789
  export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus];
790
790
  /**
791
- * <p>Details about the guardrail associated with an agent.</p>
791
+ * <p>Details about a guardrail associated with a resource.</p>
792
792
  * @public
793
793
  */
794
794
  export interface GuardrailConfiguration {
@@ -3423,6 +3423,11 @@ export interface KnowledgeBaseFlowNodeConfiguration {
3423
3423
  * @public
3424
3424
  */
3425
3425
  modelId?: string;
3426
+ /**
3427
+ * <p>Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.</p>
3428
+ * @public
3429
+ */
3430
+ guardrailConfiguration?: GuardrailConfiguration;
3426
3431
  }
3427
3432
  /**
3428
3433
  * <p>Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html">Node types in Amazon Bedrock works</a> in the Amazon Bedrock User Guide.</p>
@@ -3524,6 +3529,296 @@ export interface PromptInputVariable {
3524
3529
  */
3525
3530
  name?: string;
3526
3531
  }
3532
+ /**
3533
+ * <p>Contains the content for the message you pass to, or receive from a model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html">Create a prompt using Prompt management</a>.</p>
3534
+ * @public
3535
+ */
3536
+ export type ContentBlock = ContentBlock.TextMember | ContentBlock.$UnknownMember;
3537
+ /**
3538
+ * @public
3539
+ */
3540
+ export declare namespace ContentBlock {
3541
+ /**
3542
+ * <p>The text in the message.</p>
3543
+ * @public
3544
+ */
3545
+ interface TextMember {
3546
+ text: string;
3547
+ $unknown?: never;
3548
+ }
3549
+ /**
3550
+ * @public
3551
+ */
3552
+ interface $UnknownMember {
3553
+ text?: never;
3554
+ $unknown: [string, any];
3555
+ }
3556
+ interface Visitor<T> {
3557
+ text: (value: string) => T;
3558
+ _: (name: string, value: any) => T;
3559
+ }
3560
+ const visit: <T>(value: ContentBlock, visitor: Visitor<T>) => T;
3561
+ }
3562
+ /**
3563
+ * @public
3564
+ * @enum
3565
+ */
3566
+ export declare const ConversationRole: {
3567
+ readonly ASSISTANT: "assistant";
3568
+ readonly USER: "user";
3569
+ };
3570
+ /**
3571
+ * @public
3572
+ */
3573
+ export type ConversationRole = (typeof ConversationRole)[keyof typeof ConversationRole];
3574
+ /**
3575
+ * <p>A message input or response from a model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html">Create a prompt using Prompt management</a>.</p>
3576
+ * @public
3577
+ */
3578
+ export interface Message {
3579
+ /**
3580
+ * <p>The role that the message belongs to.</p>
3581
+ * @public
3582
+ */
3583
+ role: ConversationRole | undefined;
3584
+ /**
3585
+ * <p>The content in the message.</p>
3586
+ * @public
3587
+ */
3588
+ content: ContentBlock[] | undefined;
3589
+ }
3590
+ /**
3591
+ * <p>Contains a system prompt to provide context to the model or to describe how it should behave. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html">Create a prompt using Prompt management</a>.</p>
3592
+ * @public
3593
+ */
3594
+ export type SystemContentBlock = SystemContentBlock.TextMember | SystemContentBlock.$UnknownMember;
3595
+ /**
3596
+ * @public
3597
+ */
3598
+ export declare namespace SystemContentBlock {
3599
+ /**
3600
+ * <p>The text in the system prompt.</p>
3601
+ * @public
3602
+ */
3603
+ interface TextMember {
3604
+ text: string;
3605
+ $unknown?: never;
3606
+ }
3607
+ /**
3608
+ * @public
3609
+ */
3610
+ interface $UnknownMember {
3611
+ text?: never;
3612
+ $unknown: [string, any];
3613
+ }
3614
+ interface Visitor<T> {
3615
+ text: (value: string) => T;
3616
+ _: (name: string, value: any) => T;
3617
+ }
3618
+ const visit: <T>(value: SystemContentBlock, visitor: Visitor<T>) => T;
3619
+ }
3620
+ /**
3621
+ * <p>Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html">Use a tool to complete an Amazon Bedrock model response</a>.</p>
3622
+ * @public
3623
+ */
3624
+ export interface AnyToolChoice {
3625
+ }
3626
+ /**
3627
+ * <p>Defines tools. The model automatically decides whether to call a tool or to generate text instead. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html">Use a tool to complete an Amazon Bedrock model response</a>.</p>
3628
+ * @public
3629
+ */
3630
+ export interface AutoToolChoice {
3631
+ }
3632
+ /**
3633
+ * <p>Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html">Use a tool to complete an Amazon Bedrock model response</a>.</p>
3634
+ * @public
3635
+ */
3636
+ export interface SpecificToolChoice {
3637
+ /**
3638
+ * <p>The name of the tool.</p>
3639
+ * @public
3640
+ */
3641
+ name: string | undefined;
3642
+ }
3643
+ /**
3644
+ * <p>Defines which tools the model should request when invoked. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html">Use a tool to complete an Amazon Bedrock model response</a>.</p>
3645
+ * @public
3646
+ */
3647
+ export type ToolChoice = ToolChoice.AnyMember | ToolChoice.AutoMember | ToolChoice.ToolMember | ToolChoice.$UnknownMember;
3648
+ /**
3649
+ * @public
3650
+ */
3651
+ export declare namespace ToolChoice {
3652
+ /**
3653
+ * <p>Defines tools. The model automatically decides whether to call a tool or to generate text instead.</p>
3654
+ * @public
3655
+ */
3656
+ interface AutoMember {
3657
+ auto: AutoToolChoice;
3658
+ any?: never;
3659
+ tool?: never;
3660
+ $unknown?: never;
3661
+ }
3662
+ /**
3663
+ * <p>Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response.</p>
3664
+ * @public
3665
+ */
3666
+ interface AnyMember {
3667
+ auto?: never;
3668
+ any: AnyToolChoice;
3669
+ tool?: never;
3670
+ $unknown?: never;
3671
+ }
3672
+ /**
3673
+ * <p>Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response.</p>
3674
+ * @public
3675
+ */
3676
+ interface ToolMember {
3677
+ auto?: never;
3678
+ any?: never;
3679
+ tool: SpecificToolChoice;
3680
+ $unknown?: never;
3681
+ }
3682
+ /**
3683
+ * @public
3684
+ */
3685
+ interface $UnknownMember {
3686
+ auto?: never;
3687
+ any?: never;
3688
+ tool?: never;
3689
+ $unknown: [string, any];
3690
+ }
3691
+ interface Visitor<T> {
3692
+ auto: (value: AutoToolChoice) => T;
3693
+ any: (value: AnyToolChoice) => T;
3694
+ tool: (value: SpecificToolChoice) => T;
3695
+ _: (name: string, value: any) => T;
3696
+ }
3697
+ const visit: <T>(value: ToolChoice, visitor: Visitor<T>) => T;
3698
+ }
3699
+ /**
3700
+ * <p>The input schema for the tool. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html">Use a tool to complete an Amazon Bedrock model response</a>.</p>
3701
+ * @public
3702
+ */
3703
+ export type ToolInputSchema = ToolInputSchema.JsonMember | ToolInputSchema.$UnknownMember;
3704
+ /**
3705
+ * @public
3706
+ */
3707
+ export declare namespace ToolInputSchema {
3708
+ /**
3709
+ * <p>A JSON object defining the input schema for the tool.</p>
3710
+ * @public
3711
+ */
3712
+ interface JsonMember {
3713
+ json: __DocumentType;
3714
+ $unknown?: never;
3715
+ }
3716
+ /**
3717
+ * @public
3718
+ */
3719
+ interface $UnknownMember {
3720
+ json?: never;
3721
+ $unknown: [string, any];
3722
+ }
3723
+ interface Visitor<T> {
3724
+ json: (value: __DocumentType) => T;
3725
+ _: (name: string, value: any) => T;
3726
+ }
3727
+ const visit: <T>(value: ToolInputSchema, visitor: Visitor<T>) => T;
3728
+ }
3729
+ /**
3730
+ * <p>Contains a specification for a tool. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html">Use a tool to complete an Amazon Bedrock model response</a>.</p>
3731
+ * @public
3732
+ */
3733
+ export interface ToolSpecification {
3734
+ /**
3735
+ * <p>The name of the tool.</p>
3736
+ * @public
3737
+ */
3738
+ name: string | undefined;
3739
+ /**
3740
+ * <p>The description of the tool.</p>
3741
+ * @public
3742
+ */
3743
+ description?: string;
3744
+ /**
3745
+ * <p>The input schema for the tool.</p>
3746
+ * @public
3747
+ */
3748
+ inputSchema: ToolInputSchema | undefined;
3749
+ }
3750
+ /**
3751
+ * <p>Contains configurations for a tool that a model can use when generating a response. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html">Use a tool to complete an Amazon Bedrock model response</a>.</p>
3752
+ * @public
3753
+ */
3754
+ export type Tool = Tool.ToolSpecMember | Tool.$UnknownMember;
3755
+ /**
3756
+ * @public
3757
+ */
3758
+ export declare namespace Tool {
3759
+ /**
3760
+ * <p>The specification for the tool.</p>
3761
+ * @public
3762
+ */
3763
+ interface ToolSpecMember {
3764
+ toolSpec: ToolSpecification;
3765
+ $unknown?: never;
3766
+ }
3767
+ /**
3768
+ * @public
3769
+ */
3770
+ interface $UnknownMember {
3771
+ toolSpec?: never;
3772
+ $unknown: [string, any];
3773
+ }
3774
+ interface Visitor<T> {
3775
+ toolSpec: (value: ToolSpecification) => T;
3776
+ _: (name: string, value: any) => T;
3777
+ }
3778
+ const visit: <T>(value: Tool, visitor: Visitor<T>) => T;
3779
+ }
3780
+ /**
3781
+ * <p>Configuration information for the tools that the model can use when generating a response. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html">Use a tool to complete an Amazon Bedrock model response</a>.</p>
3782
+ * @public
3783
+ */
3784
+ export interface ToolConfiguration {
3785
+ /**
3786
+ * <p>An array of tools to pass to a model.</p>
3787
+ * @public
3788
+ */
3789
+ tools: Tool[] | undefined;
3790
+ /**
3791
+ * <p>Defines which tools the model should request when invoked.</p>
3792
+ * @public
3793
+ */
3794
+ toolChoice?: ToolChoice;
3795
+ }
3796
+ /**
3797
+ * <p>Contains configurations to use a prompt in a conversational format. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html">Create a prompt using Prompt management</a>.</p>
3798
+ * @public
3799
+ */
3800
+ export interface ChatPromptTemplateConfiguration {
3801
+ /**
3802
+ * <p>Contains messages in the chat for the prompt.</p>
3803
+ * @public
3804
+ */
3805
+ messages: Message[] | undefined;
3806
+ /**
3807
+ * <p>Contains system prompts to provide context to the model or to describe how it should behave.</p>
3808
+ * @public
3809
+ */
3810
+ system?: SystemContentBlock[];
3811
+ /**
3812
+ * <p>An array of the variables in the prompt template.</p>
3813
+ * @public
3814
+ */
3815
+ inputVariables?: PromptInputVariable[];
3816
+ /**
3817
+ * <p>Configuration information for the tools that the model can use when generating a response.</p>
3818
+ * @public
3819
+ */
3820
+ toolConfiguration?: ToolConfiguration;
3821
+ }
3527
3822
  /**
3528
3823
  * <p>Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in <code>\{\{variable\}\}</code>.</p>
3529
3824
  * @public
@@ -3541,10 +3836,10 @@ export interface TextPromptTemplateConfiguration {
3541
3836
  inputVariables?: PromptInputVariable[];
3542
3837
  }
3543
3838
  /**
3544
- * <p>Contains the message for a prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html">Prompt management in Amazon Bedrock</a>.</p>
3839
+ * <p>Contains the message for a prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html">Construct and store reusable prompts with Prompt management in Amazon Bedrock</a>.</p>
3545
3840
  * @public
3546
3841
  */
3547
- export type PromptTemplateConfiguration = PromptTemplateConfiguration.TextMember | PromptTemplateConfiguration.$UnknownMember;
3842
+ export type PromptTemplateConfiguration = PromptTemplateConfiguration.ChatMember | PromptTemplateConfiguration.TextMember | PromptTemplateConfiguration.$UnknownMember;
3548
3843
  /**
3549
3844
  * @public
3550
3845
  */
@@ -3555,6 +3850,16 @@ export declare namespace PromptTemplateConfiguration {
3555
3850
  */
3556
3851
  interface TextMember {
3557
3852
  text: TextPromptTemplateConfiguration;
3853
+ chat?: never;
3854
+ $unknown?: never;
3855
+ }
3856
+ /**
3857
+ * <p>Contains configurations to use the prompt in a conversational format.</p>
3858
+ * @public
3859
+ */
3860
+ interface ChatMember {
3861
+ text?: never;
3862
+ chat: ChatPromptTemplateConfiguration;
3558
3863
  $unknown?: never;
3559
3864
  }
3560
3865
  /**
@@ -3562,10 +3867,12 @@ export declare namespace PromptTemplateConfiguration {
3562
3867
  */
3563
3868
  interface $UnknownMember {
3564
3869
  text?: never;
3870
+ chat?: never;
3565
3871
  $unknown: [string, any];
3566
3872
  }
3567
3873
  interface Visitor<T> {
3568
3874
  text: (value: TextPromptTemplateConfiguration) => T;
3875
+ chat: (value: ChatPromptTemplateConfiguration) => T;
3569
3876
  _: (name: string, value: any) => T;
3570
3877
  }
3571
3878
  const visit: <T>(value: PromptTemplateConfiguration, visitor: Visitor<T>) => T;
@@ -3575,6 +3882,7 @@ export declare namespace PromptTemplateConfiguration {
3575
3882
  * @enum
3576
3883
  */
3577
3884
  export declare const PromptTemplateType: {
3885
+ readonly CHAT: "CHAT";
3578
3886
  readonly TEXT: "TEXT";
3579
3887
  };
3580
3888
  /**
@@ -3607,7 +3915,7 @@ export interface PromptFlowNodeInlineConfiguration {
3607
3915
  */
3608
3916
  inferenceConfiguration?: PromptInferenceConfiguration;
3609
3917
  /**
3610
- * <p>Contains model-specific inference configurations that aren't in the <code>inferenceConfiguration</code> field. To see model-specific inference parameters, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference request parameters and response fields for foundation models</a>.</p>
3918
+ * <p>Additional fields to be included in the model request for the Prompt node.</p>
3611
3919
  * @public
3612
3920
  */
3613
3921
  additionalModelRequestFields?: __DocumentType;
@@ -3675,6 +3983,11 @@ export interface PromptFlowNodeConfiguration {
3675
3983
  * @public
3676
3984
  */
3677
3985
  sourceConfiguration: PromptFlowNodeSourceConfiguration | undefined;
3986
+ /**
3987
+ * <p>Contains configurations for a guardrail to apply to the prompt in this node and the response generated from it.</p>
3988
+ * @public
3989
+ */
3990
+ guardrailConfiguration?: GuardrailConfiguration;
3678
3991
  }
3679
3992
  /**
3680
3993
  * <p>Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.</p>
@@ -4926,1433 +5239,1845 @@ export interface GetFlowRequest {
4926
5239
  flowIdentifier: string | undefined;
4927
5240
  }
4928
5241
  /**
4929
- * @public
4930
- * @enum
4931
- */
4932
- export declare const FlowValidationSeverity: {
4933
- readonly ERROR: "Error";
4934
- readonly WARNING: "Warning";
4935
- };
4936
- /**
5242
+ * <p>Details about a cyclic connection detected in the flow.</p>
4937
5243
  * @public
4938
5244
  */
4939
- export type FlowValidationSeverity = (typeof FlowValidationSeverity)[keyof typeof FlowValidationSeverity];
5245
+ export interface CyclicConnectionFlowValidationDetails {
5246
+ /**
5247
+ * <p>The name of the connection that causes the cycle in the flow.</p>
5248
+ * @public
5249
+ */
5250
+ connection: string | undefined;
5251
+ }
4940
5252
  /**
4941
- * <p>Contains information about validation of the flow.</p>
4942
- * <p>This data type is used in the following API operations:</p>
4943
- * <ul>
4944
- * <li>
4945
- * <p>
4946
- * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html#API_agent_GetFlow_ResponseSyntax">GetFlow response</a>
4947
- * </p>
4948
- * </li>
4949
- * <li>
4950
- * <p>
4951
- * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlowVersion.html#API_agent_GetFlowVersion_ResponseSyntax">GetFlowVersion response</a>
4952
- * </p>
4953
- * </li>
4954
- * </ul>
5253
+ * <p>Details about duplicate condition expressions found in a condition node.</p>
4955
5254
  * @public
4956
5255
  */
4957
- export interface FlowValidation {
5256
+ export interface DuplicateConditionExpressionFlowValidationDetails {
4958
5257
  /**
4959
- * <p>A message describing the validation error.</p>
5258
+ * <p>The name of the node containing the duplicate condition expressions.</p>
4960
5259
  * @public
4961
5260
  */
4962
- message: string | undefined;
5261
+ node: string | undefined;
4963
5262
  /**
4964
- * <p>The severity of the issue described in the message.</p>
5263
+ * <p>The duplicated condition expression.</p>
4965
5264
  * @public
4966
5265
  */
4967
- severity: FlowValidationSeverity | undefined;
5266
+ expression: string | undefined;
4968
5267
  }
4969
5268
  /**
5269
+ * <p>Details about duplicate connections found between two nodes in the flow.</p>
4970
5270
  * @public
4971
5271
  */
4972
- export interface GetFlowResponse {
5272
+ export interface DuplicateConnectionsFlowValidationDetails {
4973
5273
  /**
4974
- * <p>The name of the flow.</p>
5274
+ * <p>The name of the source node where the duplicate connection starts.</p>
4975
5275
  * @public
4976
5276
  */
4977
- name: string | undefined;
5277
+ source: string | undefined;
4978
5278
  /**
4979
- * <p>The description of the flow.</p>
5279
+ * <p>The name of the target node where the duplicate connection ends.</p>
4980
5280
  * @public
4981
5281
  */
4982
- description?: string;
5282
+ target: string | undefined;
5283
+ }
5284
+ /**
5285
+ * <p>Details about incompatible data types in a connection between nodes.</p>
5286
+ * @public
5287
+ */
5288
+ export interface IncompatibleConnectionDataTypeFlowValidationDetails {
4983
5289
  /**
4984
- * <p>The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service row for flows</a> in the Amazon Bedrock User Guide.</p>
5290
+ * <p>The name of the connection with incompatible data types.</p>
4985
5291
  * @public
4986
5292
  */
4987
- executionRoleArn: string | undefined;
4988
- /**
4989
- * <p>The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.</p>
4990
- * @public
4991
- */
4992
- customerEncryptionKeyArn?: string;
4993
- /**
4994
- * <p>The unique identifier of the flow.</p>
4995
- * @public
4996
- */
4997
- id: string | undefined;
4998
- /**
4999
- * <p>The Amazon Resource Name (ARN) of the flow.</p>
5000
- * @public
5001
- */
5002
- arn: string | undefined;
5003
- /**
5004
- * <p>The status of the flow. The following statuses are possible:</p>
5005
- * <ul>
5006
- * <li>
5007
- * <p>NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the <code>DRAFT</code> version won't contain the latest changes for testing. Send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html">PrepareFlow</a> request to package the latest changes into the <code>DRAFT</code> version.</p>
5008
- * </li>
5009
- * <li>
5010
- * <p>Preparing – The flow is being prepared so that the <code>DRAFT</code> version contains the latest changes for testing.</p>
5011
- * </li>
5012
- * <li>
5013
- * <p>Prepared – The flow is prepared and the <code>DRAFT</code> version contains the latest changes for testing.</p>
5014
- * </li>
5015
- * <li>
5016
- * <p>Failed – The last API operation that you invoked on the flow failed. Send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html">GetFlow</a> request and check the error message in the <code>validations</code> field.</p>
5017
- * </li>
5018
- * </ul>
5019
- * @public
5020
- */
5021
- status: FlowStatus | undefined;
5022
- /**
5023
- * <p>The time at which the flow was created.</p>
5024
- * @public
5025
- */
5026
- createdAt: Date | undefined;
5027
- /**
5028
- * <p>The time at which the flow was last updated.</p>
5029
- * @public
5030
- */
5031
- updatedAt: Date | undefined;
5293
+ connection: string | undefined;
5294
+ }
5295
+ /**
5296
+ * <p>Details about a malformed condition expression in a node.</p>
5297
+ * @public
5298
+ */
5299
+ export interface MalformedConditionExpressionFlowValidationDetails {
5032
5300
  /**
5033
- * <p>The version of the flow for which information was retrieved.</p>
5301
+ * <p>The name of the node containing the malformed condition expression.</p>
5034
5302
  * @public
5035
5303
  */
5036
- version: string | undefined;
5304
+ node: string | undefined;
5037
5305
  /**
5038
- * <p>The definition of the nodes and connections between the nodes in the flow.</p>
5306
+ * <p>The name of the malformed condition.</p>
5039
5307
  * @public
5040
5308
  */
5041
- definition?: FlowDefinition;
5309
+ condition: string | undefined;
5042
5310
  /**
5043
- * <p>A list of validation error messages related to the last failed operation on the flow.</p>
5311
+ * <p>The error message describing why the condition expression is malformed.</p>
5044
5312
  * @public
5045
5313
  */
5046
- validations?: FlowValidation[];
5314
+ cause: string | undefined;
5047
5315
  }
5048
5316
  /**
5317
+ * <p>Details about a malformed input expression in a node.</p>
5049
5318
  * @public
5050
5319
  */
5051
- export interface ListFlowsRequest {
5320
+ export interface MalformedNodeInputExpressionFlowValidationDetails {
5052
5321
  /**
5053
- * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
5322
+ * <p>The name of the node containing the malformed input expression.</p>
5054
5323
  * @public
5055
5324
  */
5056
- maxResults?: number;
5325
+ node: string | undefined;
5057
5326
  /**
5058
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
5327
+ * <p>The name of the input with the malformed expression.</p>
5059
5328
  * @public
5060
5329
  */
5061
- nextToken?: string;
5330
+ input: string | undefined;
5331
+ /**
5332
+ * <p>The error message describing why the input expression is malformed.</p>
5333
+ * @public
5334
+ */
5335
+ cause: string | undefined;
5062
5336
  }
5063
5337
  /**
5064
- * <p>Contains the definition of a flow.</p>
5338
+ * <p>Details about mismatched input data types in a node.</p>
5065
5339
  * @public
5066
5340
  */
5067
- export interface FlowSummary {
5068
- /**
5069
- * <p>The name of the flow.</p>
5070
- * @public
5071
- */
5072
- name: string | undefined;
5073
- /**
5074
- * <p>A description of the flow.</p>
5075
- * @public
5076
- */
5077
- description?: string;
5341
+ export interface MismatchedNodeInputTypeFlowValidationDetails {
5078
5342
  /**
5079
- * <p>The unique identifier of the flow.</p>
5343
+ * <p>The name of the node containing the input with the mismatched data type.</p>
5080
5344
  * @public
5081
5345
  */
5082
- id: string | undefined;
5346
+ node: string | undefined;
5083
5347
  /**
5084
- * <p>The Amazon Resource Name (ARN) of the flow.</p>
5348
+ * <p>The name of the input with the mismatched data type.</p>
5085
5349
  * @public
5086
5350
  */
5087
- arn: string | undefined;
5351
+ input: string | undefined;
5088
5352
  /**
5089
- * <p>The status of the flow. The following statuses are possible:</p>
5090
- * <ul>
5091
- * <li>
5092
- * <p>NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the <code>DRAFT</code> version won't contain the latest changes for testing. Send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html">PrepareFlow</a> request to package the latest changes into the <code>DRAFT</code> version.</p>
5093
- * </li>
5094
- * <li>
5095
- * <p>Preparing – The flow is being prepared so that the <code>DRAFT</code> version contains the latest changes for testing.</p>
5096
- * </li>
5097
- * <li>
5098
- * <p>Prepared – The flow is prepared and the <code>DRAFT</code> version contains the latest changes for testing.</p>
5099
- * </li>
5100
- * <li>
5101
- * <p>Failed – The last API operation that you invoked on the flow failed. Send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html">GetFlow</a> request and check the error message in the <code>validations</code> field.</p>
5102
- * </li>
5103
- * </ul>
5353
+ * <p>The expected data type for the node input.</p>
5104
5354
  * @public
5105
5355
  */
5106
- status: FlowStatus | undefined;
5356
+ expectedType: FlowNodeIODataType | undefined;
5357
+ }
5358
+ /**
5359
+ * <p>Details about mismatched output data types in a node.</p>
5360
+ * @public
5361
+ */
5362
+ export interface MismatchedNodeOutputTypeFlowValidationDetails {
5107
5363
  /**
5108
- * <p>The time at which the flow was created.</p>
5364
+ * <p>The name of the node containing the output with the mismatched data type.</p>
5109
5365
  * @public
5110
5366
  */
5111
- createdAt: Date | undefined;
5367
+ node: string | undefined;
5112
5368
  /**
5113
- * <p>The time at which the flow was last updated.</p>
5369
+ * <p>The name of the output with the mismatched data type.</p>
5114
5370
  * @public
5115
5371
  */
5116
- updatedAt: Date | undefined;
5372
+ output: string | undefined;
5117
5373
  /**
5118
- * <p>The latest version of the flow.</p>
5374
+ * <p>The expected data type for the node output.</p>
5119
5375
  * @public
5120
5376
  */
5121
- version: string | undefined;
5377
+ expectedType: FlowNodeIODataType | undefined;
5122
5378
  }
5123
5379
  /**
5380
+ * <p>Details about a connection missing required configuration.</p>
5124
5381
  * @public
5125
5382
  */
5126
- export interface ListFlowsResponse {
5127
- /**
5128
- * <p>A list, each member of which contains information about a flow.</p>
5129
- * @public
5130
- */
5131
- flowSummaries: FlowSummary[] | undefined;
5383
+ export interface MissingConnectionConfigurationFlowValidationDetails {
5132
5384
  /**
5133
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
5385
+ * <p>The name of the connection missing configuration.</p>
5134
5386
  * @public
5135
5387
  */
5136
- nextToken?: string;
5388
+ connection: string | undefined;
5137
5389
  }
5138
5390
  /**
5391
+ * <p>Details about a missing default condition in a conditional node.</p>
5139
5392
  * @public
5140
5393
  */
5141
- export interface PrepareFlowRequest {
5394
+ export interface MissingDefaultConditionFlowValidationDetails {
5142
5395
  /**
5143
- * <p>The unique identifier of the flow.</p>
5396
+ * <p>The name of the node missing the default condition.</p>
5144
5397
  * @public
5145
5398
  */
5146
- flowIdentifier: string | undefined;
5399
+ node: string | undefined;
5147
5400
  }
5148
5401
  /**
5402
+ * <p>Details about missing ending nodes (such as FlowOutputNode) in the flow.</p>
5149
5403
  * @public
5150
5404
  */
5151
- export interface PrepareFlowResponse {
5152
- /**
5153
- * <p>The unique identifier of the flow.</p>
5154
- * @public
5155
- */
5156
- id: string | undefined;
5157
- /**
5158
- * <p>The status of the flow. When you submit this request, the status will be <code>NotPrepared</code>. If preparation succeeds, the status becomes <code>Prepared</code>. If it fails, the status becomes <code>FAILED</code>.</p>
5159
- * @public
5160
- */
5161
- status: FlowStatus | undefined;
5405
+ export interface MissingEndingNodesFlowValidationDetails {
5162
5406
  }
5163
5407
  /**
5408
+ * <p>Details about a node missing required configuration.</p>
5164
5409
  * @public
5165
5410
  */
5166
- export interface UpdateFlowRequest {
5411
+ export interface MissingNodeConfigurationFlowValidationDetails {
5167
5412
  /**
5168
- * <p>A name for the flow.</p>
5169
- * @public
5170
- */
5171
- name: string | undefined;
5172
- /**
5173
- * <p>A description for the flow.</p>
5174
- * @public
5175
- */
5176
- description?: string;
5177
- /**
5178
- * <p>The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
5179
- * @public
5180
- */
5181
- executionRoleArn: string | undefined;
5182
- /**
5183
- * <p>The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.</p>
5413
+ * <p>The name of the node missing configuration.</p>
5184
5414
  * @public
5185
5415
  */
5186
- customerEncryptionKeyArn?: string;
5416
+ node: string | undefined;
5417
+ }
5418
+ /**
5419
+ * <p>Details about a missing required input in a node.</p>
5420
+ * @public
5421
+ */
5422
+ export interface MissingNodeInputFlowValidationDetails {
5187
5423
  /**
5188
- * <p>A definition of the nodes and the connections between the nodes in the flow.</p>
5424
+ * <p>The name of the node missing the required input.</p>
5189
5425
  * @public
5190
5426
  */
5191
- definition?: FlowDefinition;
5427
+ node: string | undefined;
5192
5428
  /**
5193
- * <p>The unique identifier of the flow.</p>
5429
+ * <p>The name of the missing input.</p>
5194
5430
  * @public
5195
5431
  */
5196
- flowIdentifier: string | undefined;
5432
+ input: string | undefined;
5197
5433
  }
5198
5434
  /**
5435
+ * <p>Details about a missing required output in a node.</p>
5199
5436
  * @public
5200
5437
  */
5201
- export interface UpdateFlowResponse {
5202
- /**
5203
- * <p>The name of the flow.</p>
5204
- * @public
5205
- */
5206
- name: string | undefined;
5438
+ export interface MissingNodeOutputFlowValidationDetails {
5207
5439
  /**
5208
- * <p>The description of the flow.</p>
5440
+ * <p>The name of the node missing the required output.</p>
5209
5441
  * @public
5210
5442
  */
5211
- description?: string;
5443
+ node: string | undefined;
5212
5444
  /**
5213
- * <p>The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
5445
+ * <p>The name of the missing output.</p>
5214
5446
  * @public
5215
5447
  */
5216
- executionRoleArn: string | undefined;
5448
+ output: string | undefined;
5449
+ }
5450
+ /**
5451
+ * <p>Details about missing starting nodes (such as FlowInputNode) in the flow.</p>
5452
+ * @public
5453
+ */
5454
+ export interface MissingStartingNodesFlowValidationDetails {
5455
+ }
5456
+ /**
5457
+ * <p>Details about multiple connections to a single node input.</p>
5458
+ * @public
5459
+ */
5460
+ export interface MultipleNodeInputConnectionsFlowValidationDetails {
5217
5461
  /**
5218
- * <p>The Amazon Resource Name (ARN) of the KMS key that the flow was encrypted with.</p>
5462
+ * <p>The name of the node containing the input with multiple connections.</p>
5219
5463
  * @public
5220
5464
  */
5221
- customerEncryptionKeyArn?: string;
5465
+ node: string | undefined;
5222
5466
  /**
5223
- * <p>The unique identifier of the flow.</p>
5467
+ * <p>The name of the input with multiple connections to it.</p>
5224
5468
  * @public
5225
5469
  */
5226
- id: string | undefined;
5470
+ input: string | undefined;
5471
+ }
5472
+ /**
5473
+ * <p>Details about an unfulfilled node input with no valid connections.</p>
5474
+ * @public
5475
+ */
5476
+ export interface UnfulfilledNodeInputFlowValidationDetails {
5227
5477
  /**
5228
- * <p>The Amazon Resource Name (ARN) of the flow.</p>
5478
+ * <p>The name of the node containing the unfulfilled input.</p>
5229
5479
  * @public
5230
5480
  */
5231
- arn: string | undefined;
5481
+ node: string | undefined;
5232
5482
  /**
5233
- * <p>The status of the flow. When you submit this request, the status will be <code>NotPrepared</code>. If updating fails, the status becomes <code>Failed</code>.</p>
5483
+ * <p>The name of the unfulfilled input. An input is unfulfilled if there are no data connections to it.</p>
5234
5484
  * @public
5235
5485
  */
5236
- status: FlowStatus | undefined;
5486
+ input: string | undefined;
5487
+ }
5488
+ /**
5489
+ * <p>Details about an unknown condition for a connection.</p>
5490
+ * @public
5491
+ */
5492
+ export interface UnknownConnectionConditionFlowValidationDetails {
5237
5493
  /**
5238
- * <p>The time at which the flow was created.</p>
5494
+ * <p>The name of the connection with the unknown condition.</p>
5239
5495
  * @public
5240
5496
  */
5241
- createdAt: Date | undefined;
5497
+ connection: string | undefined;
5498
+ }
5499
+ /**
5500
+ * <p>Details about an unknown source node for a connection.</p>
5501
+ * @public
5502
+ */
5503
+ export interface UnknownConnectionSourceFlowValidationDetails {
5242
5504
  /**
5243
- * <p>The time at which the flow was last updated.</p>
5505
+ * <p>The name of the connection with the unknown source.</p>
5244
5506
  * @public
5245
5507
  */
5246
- updatedAt: Date | undefined;
5508
+ connection: string | undefined;
5509
+ }
5510
+ /**
5511
+ * <p>Details about an unknown source output for a connection.</p>
5512
+ * @public
5513
+ */
5514
+ export interface UnknownConnectionSourceOutputFlowValidationDetails {
5247
5515
  /**
5248
- * <p>The version of the flow. When you update a flow, the version updated is the <code>DRAFT</code> version.</p>
5516
+ * <p>The name of the connection with the unknown source output.</p>
5249
5517
  * @public
5250
5518
  */
5251
- version: string | undefined;
5519
+ connection: string | undefined;
5520
+ }
5521
+ /**
5522
+ * <p>Details about an unknown target node for a connection.</p>
5523
+ * @public
5524
+ */
5525
+ export interface UnknownConnectionTargetFlowValidationDetails {
5252
5526
  /**
5253
- * <p>A definition of the nodes and the connections between nodes in the flow.</p>
5527
+ * <p>The name of the connection with the unknown target.</p>
5254
5528
  * @public
5255
5529
  */
5256
- definition?: FlowDefinition;
5530
+ connection: string | undefined;
5257
5531
  }
5258
5532
  /**
5533
+ * <p>Details about an unknown target input for a connection.</p>
5259
5534
  * @public
5260
5535
  */
5261
- export interface GetIngestionJobRequest {
5536
+ export interface UnknownConnectionTargetInputFlowValidationDetails {
5262
5537
  /**
5263
- * <p>The unique identifier of the knowledge base for the data ingestion job you want to get information on.</p>
5538
+ * <p>The name of the connection with the unknown target input.</p>
5264
5539
  * @public
5265
5540
  */
5266
- knowledgeBaseId: string | undefined;
5541
+ connection: string | undefined;
5542
+ }
5543
+ /**
5544
+ * <p>Details about an unreachable node in the flow. A node is unreachable when there are no paths to it from any starting node.</p>
5545
+ * @public
5546
+ */
5547
+ export interface UnreachableNodeFlowValidationDetails {
5267
5548
  /**
5268
- * <p>The unique identifier of the data source for the data ingestion job you want to get information on.</p>
5549
+ * <p>The name of the unreachable node.</p>
5269
5550
  * @public
5270
5551
  */
5271
- dataSourceId: string | undefined;
5552
+ node: string | undefined;
5553
+ }
5554
+ /**
5555
+ * <p>Details about unsatisfied conditions for a connection. A condition is unsatisfied if it can never be true, for example two branches of condition node cannot be simultaneously true.</p>
5556
+ * @public
5557
+ */
5558
+ export interface UnsatisfiedConnectionConditionsFlowValidationDetails {
5272
5559
  /**
5273
- * <p>The unique identifier of the data ingestion job you want to get information on.</p>
5560
+ * <p>The name of the connection with unsatisfied conditions.</p>
5274
5561
  * @public
5275
5562
  */
5276
- ingestionJobId: string | undefined;
5563
+ connection: string | undefined;
5277
5564
  }
5278
5565
  /**
5279
- * <p>Contains the statistics for the data ingestion job.</p>
5566
+ * <p>Details about an unspecified validation that doesn't fit other categories.</p>
5280
5567
  * @public
5281
5568
  */
5282
- export interface IngestionJobStatistics {
5569
+ export interface UnspecifiedFlowValidationDetails {
5570
+ }
5571
+ /**
5572
+ * <p>A union type containing various possible validation issues in the flow.</p>
5573
+ * @public
5574
+ */
5575
+ export type FlowValidationDetails = FlowValidationDetails.CyclicConnectionMember | FlowValidationDetails.DuplicateConditionExpressionMember | FlowValidationDetails.DuplicateConnectionsMember | FlowValidationDetails.IncompatibleConnectionDataTypeMember | FlowValidationDetails.MalformedConditionExpressionMember | FlowValidationDetails.MalformedNodeInputExpressionMember | FlowValidationDetails.MismatchedNodeInputTypeMember | FlowValidationDetails.MismatchedNodeOutputTypeMember | FlowValidationDetails.MissingConnectionConfigurationMember | FlowValidationDetails.MissingDefaultConditionMember | FlowValidationDetails.MissingEndingNodesMember | FlowValidationDetails.MissingNodeConfigurationMember | FlowValidationDetails.MissingNodeInputMember | FlowValidationDetails.MissingNodeOutputMember | FlowValidationDetails.MissingStartingNodesMember | FlowValidationDetails.MultipleNodeInputConnectionsMember | FlowValidationDetails.UnfulfilledNodeInputMember | FlowValidationDetails.UnknownConnectionConditionMember | FlowValidationDetails.UnknownConnectionSourceMember | FlowValidationDetails.UnknownConnectionSourceOutputMember | FlowValidationDetails.UnknownConnectionTargetMember | FlowValidationDetails.UnknownConnectionTargetInputMember | FlowValidationDetails.UnreachableNodeMember | FlowValidationDetails.UnsatisfiedConnectionConditionsMember | FlowValidationDetails.UnspecifiedMember | FlowValidationDetails.$UnknownMember;
5576
+ /**
5577
+ * @public
5578
+ */
5579
+ export declare namespace FlowValidationDetails {
5283
5580
  /**
5284
- * <p>The total number of source documents that were scanned. Includes new, updated, and unchanged documents.</p>
5581
+ * <p>Details about a cyclic connection in the flow.</p>
5285
5582
  * @public
5286
5583
  */
5287
- numberOfDocumentsScanned?: number;
5584
+ interface CyclicConnectionMember {
5585
+ cyclicConnection: CyclicConnectionFlowValidationDetails;
5586
+ duplicateConnections?: never;
5587
+ duplicateConditionExpression?: never;
5588
+ unreachableNode?: never;
5589
+ unknownConnectionSource?: never;
5590
+ unknownConnectionSourceOutput?: never;
5591
+ unknownConnectionTarget?: never;
5592
+ unknownConnectionTargetInput?: never;
5593
+ unknownConnectionCondition?: never;
5594
+ malformedConditionExpression?: never;
5595
+ malformedNodeInputExpression?: never;
5596
+ mismatchedNodeInputType?: never;
5597
+ mismatchedNodeOutputType?: never;
5598
+ incompatibleConnectionDataType?: never;
5599
+ missingConnectionConfiguration?: never;
5600
+ missingDefaultCondition?: never;
5601
+ missingEndingNodes?: never;
5602
+ missingNodeConfiguration?: never;
5603
+ missingNodeInput?: never;
5604
+ missingNodeOutput?: never;
5605
+ missingStartingNodes?: never;
5606
+ multipleNodeInputConnections?: never;
5607
+ unfulfilledNodeInput?: never;
5608
+ unsatisfiedConnectionConditions?: never;
5609
+ unspecified?: never;
5610
+ $unknown?: never;
5611
+ }
5288
5612
  /**
5289
- * <p>The total number of metadata files that were scanned. Includes new, updated, and unchanged files.</p>
5290
- * @public
5291
- */
5292
- numberOfMetadataDocumentsScanned?: number;
5613
+ * <p>Details about duplicate connections between nodes.</p>
5614
+ * @public
5615
+ */
5616
+ interface DuplicateConnectionsMember {
5617
+ cyclicConnection?: never;
5618
+ duplicateConnections: DuplicateConnectionsFlowValidationDetails;
5619
+ duplicateConditionExpression?: never;
5620
+ unreachableNode?: never;
5621
+ unknownConnectionSource?: never;
5622
+ unknownConnectionSourceOutput?: never;
5623
+ unknownConnectionTarget?: never;
5624
+ unknownConnectionTargetInput?: never;
5625
+ unknownConnectionCondition?: never;
5626
+ malformedConditionExpression?: never;
5627
+ malformedNodeInputExpression?: never;
5628
+ mismatchedNodeInputType?: never;
5629
+ mismatchedNodeOutputType?: never;
5630
+ incompatibleConnectionDataType?: never;
5631
+ missingConnectionConfiguration?: never;
5632
+ missingDefaultCondition?: never;
5633
+ missingEndingNodes?: never;
5634
+ missingNodeConfiguration?: never;
5635
+ missingNodeInput?: never;
5636
+ missingNodeOutput?: never;
5637
+ missingStartingNodes?: never;
5638
+ multipleNodeInputConnections?: never;
5639
+ unfulfilledNodeInput?: never;
5640
+ unsatisfiedConnectionConditions?: never;
5641
+ unspecified?: never;
5642
+ $unknown?: never;
5643
+ }
5293
5644
  /**
5294
- * <p>The number of new source documents in the data source that were successfully indexed.</p>
5295
- * @public
5296
- */
5297
- numberOfNewDocumentsIndexed?: number;
5645
+ * <p>Details about duplicate condition expressions in a node.</p>
5646
+ * @public
5647
+ */
5648
+ interface DuplicateConditionExpressionMember {
5649
+ cyclicConnection?: never;
5650
+ duplicateConnections?: never;
5651
+ duplicateConditionExpression: DuplicateConditionExpressionFlowValidationDetails;
5652
+ unreachableNode?: never;
5653
+ unknownConnectionSource?: never;
5654
+ unknownConnectionSourceOutput?: never;
5655
+ unknownConnectionTarget?: never;
5656
+ unknownConnectionTargetInput?: never;
5657
+ unknownConnectionCondition?: never;
5658
+ malformedConditionExpression?: never;
5659
+ malformedNodeInputExpression?: never;
5660
+ mismatchedNodeInputType?: never;
5661
+ mismatchedNodeOutputType?: never;
5662
+ incompatibleConnectionDataType?: never;
5663
+ missingConnectionConfiguration?: never;
5664
+ missingDefaultCondition?: never;
5665
+ missingEndingNodes?: never;
5666
+ missingNodeConfiguration?: never;
5667
+ missingNodeInput?: never;
5668
+ missingNodeOutput?: never;
5669
+ missingStartingNodes?: never;
5670
+ multipleNodeInputConnections?: never;
5671
+ unfulfilledNodeInput?: never;
5672
+ unsatisfiedConnectionConditions?: never;
5673
+ unspecified?: never;
5674
+ $unknown?: never;
5675
+ }
5298
5676
  /**
5299
- * <p>The number of modified source documents in the data source that were successfully indexed.</p>
5300
- * @public
5301
- */
5302
- numberOfModifiedDocumentsIndexed?: number;
5677
+ * <p>Details about an unreachable node in the flow.</p>
5678
+ * @public
5679
+ */
5680
+ interface UnreachableNodeMember {
5681
+ cyclicConnection?: never;
5682
+ duplicateConnections?: never;
5683
+ duplicateConditionExpression?: never;
5684
+ unreachableNode: UnreachableNodeFlowValidationDetails;
5685
+ unknownConnectionSource?: never;
5686
+ unknownConnectionSourceOutput?: never;
5687
+ unknownConnectionTarget?: never;
5688
+ unknownConnectionTargetInput?: never;
5689
+ unknownConnectionCondition?: never;
5690
+ malformedConditionExpression?: never;
5691
+ malformedNodeInputExpression?: never;
5692
+ mismatchedNodeInputType?: never;
5693
+ mismatchedNodeOutputType?: never;
5694
+ incompatibleConnectionDataType?: never;
5695
+ missingConnectionConfiguration?: never;
5696
+ missingDefaultCondition?: never;
5697
+ missingEndingNodes?: never;
5698
+ missingNodeConfiguration?: never;
5699
+ missingNodeInput?: never;
5700
+ missingNodeOutput?: never;
5701
+ missingStartingNodes?: never;
5702
+ multipleNodeInputConnections?: never;
5703
+ unfulfilledNodeInput?: never;
5704
+ unsatisfiedConnectionConditions?: never;
5705
+ unspecified?: never;
5706
+ $unknown?: never;
5707
+ }
5303
5708
  /**
5304
- * <p>The number of metadata files that were updated or deleted.</p>
5305
- * @public
5306
- */
5307
- numberOfMetadataDocumentsModified?: number;
5308
- /**
5309
- * <p>The number of source documents that were deleted.</p>
5310
- * @public
5311
- */
5312
- numberOfDocumentsDeleted?: number;
5313
- /**
5314
- * <p>The number of source documents that failed to be ingested.</p>
5315
- * @public
5316
- */
5317
- numberOfDocumentsFailed?: number;
5318
- }
5319
- /**
5320
- * @public
5321
- * @enum
5322
- */
5323
- export declare const IngestionJobStatus: {
5324
- readonly COMPLETE: "COMPLETE";
5325
- readonly FAILED: "FAILED";
5326
- readonly IN_PROGRESS: "IN_PROGRESS";
5327
- readonly STARTING: "STARTING";
5328
- readonly STOPPED: "STOPPED";
5329
- readonly STOPPING: "STOPPING";
5330
- };
5331
- /**
5332
- * @public
5333
- */
5334
- export type IngestionJobStatus = (typeof IngestionJobStatus)[keyof typeof IngestionJobStatus];
5335
- /**
5336
- * <p>Contains details about a data ingestion job. Data sources are ingested into a knowledge base so that Large Language Models (LLMs) can use your data.</p>
5337
- * <p>This data type is used in the following API operations:</p>
5338
- * <ul>
5339
- * <li>
5340
- * <p>
5341
- * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_StartIngestionJob.html#API_agent_StartIngestionJob_ResponseSyntax">StartIngestionJob response</a>
5342
- * </p>
5343
- * </li>
5344
- * <li>
5345
- * <p>
5346
- * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetIngestionJob.html#API_agent_GetIngestionJob_ResponseSyntax">GetIngestionJob response</a>
5347
- * </p>
5348
- * </li>
5349
- * <li>
5350
- * <p>
5351
- * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax">ListIngestionJob response</a>
5352
- * </p>
5353
- * </li>
5354
- * </ul>
5355
- * @public
5356
- */
5357
- export interface IngestionJob {
5358
- /**
5359
- * <p>The unique identifier of the knowledge for the data ingestion job.</p>
5360
- * @public
5361
- */
5362
- knowledgeBaseId: string | undefined;
5363
- /**
5364
- * <p>The unique identifier of the data source for the data ingestion job.</p>
5365
- * @public
5366
- */
5367
- dataSourceId: string | undefined;
5368
- /**
5369
- * <p>The unique identifier of the data ingestion job.</p>
5370
- * @public
5371
- */
5372
- ingestionJobId: string | undefined;
5373
- /**
5374
- * <p>The description of the data ingestion job.</p>
5375
- * @public
5376
- */
5377
- description?: string;
5378
- /**
5379
- * <p>The status of the data ingestion job.</p>
5380
- * @public
5381
- */
5382
- status: IngestionJobStatus | undefined;
5383
- /**
5384
- * <p>Contains statistics about the data ingestion job.</p>
5385
- * @public
5386
- */
5387
- statistics?: IngestionJobStatistics;
5388
- /**
5389
- * <p>A list of reasons that the data ingestion job failed.</p>
5390
- * @public
5391
- */
5392
- failureReasons?: string[];
5393
- /**
5394
- * <p>The time the data ingestion job started.</p>
5395
- * <p>If you stop a data ingestion job, the <code>startedAt</code> time is the time the job was started before the job was stopped.</p>
5396
- * @public
5397
- */
5398
- startedAt: Date | undefined;
5399
- /**
5400
- * <p>The time the data ingestion job was last updated.</p>
5401
- * <p>If you stop a data ingestion job, the <code>updatedAt</code> time is the time the job was stopped.</p>
5402
- * @public
5403
- */
5404
- updatedAt: Date | undefined;
5405
- }
5406
- /**
5407
- * @public
5408
- */
5409
- export interface GetIngestionJobResponse {
5410
- /**
5411
- * <p>Contains details about the data ingestion job.</p>
5412
- * @public
5413
- */
5414
- ingestionJob: IngestionJob | undefined;
5415
- }
5416
- /**
5417
- * @public
5418
- * @enum
5419
- */
5420
- export declare const IngestionJobFilterAttribute: {
5421
- readonly STATUS: "STATUS";
5422
- };
5423
- /**
5424
- * @public
5425
- */
5426
- export type IngestionJobFilterAttribute = (typeof IngestionJobFilterAttribute)[keyof typeof IngestionJobFilterAttribute];
5427
- /**
5428
- * @public
5429
- * @enum
5430
- */
5431
- export declare const IngestionJobFilterOperator: {
5432
- readonly EQ: "EQ";
5433
- };
5434
- /**
5435
- * @public
5436
- */
5437
- export type IngestionJobFilterOperator = (typeof IngestionJobFilterOperator)[keyof typeof IngestionJobFilterOperator];
5438
- /**
5439
- * <p>The definition of a filter to filter the data.</p>
5440
- * @public
5441
- */
5442
- export interface IngestionJobFilter {
5443
- /**
5444
- * <p>The name of field or attribute to apply the filter.</p>
5445
- * @public
5446
- */
5447
- attribute: IngestionJobFilterAttribute | undefined;
5448
- /**
5449
- * <p>The operation to apply to the field or attribute.</p>
5450
- * @public
5451
- */
5452
- operator: IngestionJobFilterOperator | undefined;
5453
- /**
5454
- * <p>A list of values that belong to the field or attribute.</p>
5455
- * @public
5456
- */
5457
- values: string[] | undefined;
5458
- }
5459
- /**
5460
- * @public
5461
- * @enum
5462
- */
5463
- export declare const IngestionJobSortByAttribute: {
5464
- readonly STARTED_AT: "STARTED_AT";
5465
- readonly STATUS: "STATUS";
5466
- };
5467
- /**
5468
- * @public
5469
- */
5470
- export type IngestionJobSortByAttribute = (typeof IngestionJobSortByAttribute)[keyof typeof IngestionJobSortByAttribute];
5471
- /**
5472
- * @public
5473
- * @enum
5474
- */
5475
- export declare const SortOrder: {
5476
- readonly ASCENDING: "ASCENDING";
5477
- readonly DESCENDING: "DESCENDING";
5478
- };
5479
- /**
5480
- * @public
5481
- */
5482
- export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
5483
- /**
5484
- * <p>The parameters of sorting the data.</p>
5485
- * @public
5486
- */
5487
- export interface IngestionJobSortBy {
5488
- /**
5489
- * <p>The name of field or attribute to apply sorting of data.</p>
5490
- * @public
5491
- */
5492
- attribute: IngestionJobSortByAttribute | undefined;
5493
- /**
5494
- * <p>The order for sorting the data.</p>
5495
- * @public
5496
- */
5497
- order: SortOrder | undefined;
5498
- }
5499
- /**
5500
- * @public
5501
- */
5502
- export interface ListIngestionJobsRequest {
5503
- /**
5504
- * <p>The unique identifier of the knowledge base for the list of data ingestion jobs.</p>
5505
- * @public
5506
- */
5507
- knowledgeBaseId: string | undefined;
5508
- /**
5509
- * <p>The unique identifier of the data source for the list of data ingestion jobs.</p>
5510
- * @public
5511
- */
5512
- dataSourceId: string | undefined;
5513
- /**
5514
- * <p>Contains information about the filters for filtering the data.</p>
5515
- * @public
5516
- */
5517
- filters?: IngestionJobFilter[];
5518
- /**
5519
- * <p>Contains details about how to sort the data.</p>
5520
- * @public
5521
- */
5522
- sortBy?: IngestionJobSortBy;
5523
- /**
5524
- * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
5525
- * @public
5526
- */
5527
- maxResults?: number;
5528
- /**
5529
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
5530
- * @public
5531
- */
5532
- nextToken?: string;
5533
- }
5534
- /**
5535
- * <p>Contains details about a data ingestion job.</p>
5536
- * @public
5537
- */
5538
- export interface IngestionJobSummary {
5539
- /**
5540
- * <p>The unique identifier of the knowledge base for the data ingestion job.</p>
5541
- * @public
5542
- */
5543
- knowledgeBaseId: string | undefined;
5544
- /**
5545
- * <p>The unique identifier of the data source for the data ingestion job.</p>
5546
- * @public
5547
- */
5548
- dataSourceId: string | undefined;
5549
- /**
5550
- * <p>The unique identifier of the data ingestion job.</p>
5551
- * @public
5552
- */
5553
- ingestionJobId: string | undefined;
5554
- /**
5555
- * <p>The description of the data ingestion job.</p>
5556
- * @public
5557
- */
5558
- description?: string;
5709
+ * <p>Details about an unknown source node for a connection.</p>
5710
+ * @public
5711
+ */
5712
+ interface UnknownConnectionSourceMember {
5713
+ cyclicConnection?: never;
5714
+ duplicateConnections?: never;
5715
+ duplicateConditionExpression?: never;
5716
+ unreachableNode?: never;
5717
+ unknownConnectionSource: UnknownConnectionSourceFlowValidationDetails;
5718
+ unknownConnectionSourceOutput?: never;
5719
+ unknownConnectionTarget?: never;
5720
+ unknownConnectionTargetInput?: never;
5721
+ unknownConnectionCondition?: never;
5722
+ malformedConditionExpression?: never;
5723
+ malformedNodeInputExpression?: never;
5724
+ mismatchedNodeInputType?: never;
5725
+ mismatchedNodeOutputType?: never;
5726
+ incompatibleConnectionDataType?: never;
5727
+ missingConnectionConfiguration?: never;
5728
+ missingDefaultCondition?: never;
5729
+ missingEndingNodes?: never;
5730
+ missingNodeConfiguration?: never;
5731
+ missingNodeInput?: never;
5732
+ missingNodeOutput?: never;
5733
+ missingStartingNodes?: never;
5734
+ multipleNodeInputConnections?: never;
5735
+ unfulfilledNodeInput?: never;
5736
+ unsatisfiedConnectionConditions?: never;
5737
+ unspecified?: never;
5738
+ $unknown?: never;
5739
+ }
5559
5740
  /**
5560
- * <p>The status of the data ingestion job.</p>
5561
- * @public
5562
- */
5563
- status: IngestionJobStatus | undefined;
5741
+ * <p>Details about an unknown source output for a connection.</p>
5742
+ * @public
5743
+ */
5744
+ interface UnknownConnectionSourceOutputMember {
5745
+ cyclicConnection?: never;
5746
+ duplicateConnections?: never;
5747
+ duplicateConditionExpression?: never;
5748
+ unreachableNode?: never;
5749
+ unknownConnectionSource?: never;
5750
+ unknownConnectionSourceOutput: UnknownConnectionSourceOutputFlowValidationDetails;
5751
+ unknownConnectionTarget?: never;
5752
+ unknownConnectionTargetInput?: never;
5753
+ unknownConnectionCondition?: never;
5754
+ malformedConditionExpression?: never;
5755
+ malformedNodeInputExpression?: never;
5756
+ mismatchedNodeInputType?: never;
5757
+ mismatchedNodeOutputType?: never;
5758
+ incompatibleConnectionDataType?: never;
5759
+ missingConnectionConfiguration?: never;
5760
+ missingDefaultCondition?: never;
5761
+ missingEndingNodes?: never;
5762
+ missingNodeConfiguration?: never;
5763
+ missingNodeInput?: never;
5764
+ missingNodeOutput?: never;
5765
+ missingStartingNodes?: never;
5766
+ multipleNodeInputConnections?: never;
5767
+ unfulfilledNodeInput?: never;
5768
+ unsatisfiedConnectionConditions?: never;
5769
+ unspecified?: never;
5770
+ $unknown?: never;
5771
+ }
5564
5772
  /**
5565
- * <p>The time the data ingestion job started.</p>
5566
- * @public
5567
- */
5568
- startedAt: Date | undefined;
5773
+ * <p>Details about an unknown target node for a connection.</p>
5774
+ * @public
5775
+ */
5776
+ interface UnknownConnectionTargetMember {
5777
+ cyclicConnection?: never;
5778
+ duplicateConnections?: never;
5779
+ duplicateConditionExpression?: never;
5780
+ unreachableNode?: never;
5781
+ unknownConnectionSource?: never;
5782
+ unknownConnectionSourceOutput?: never;
5783
+ unknownConnectionTarget: UnknownConnectionTargetFlowValidationDetails;
5784
+ unknownConnectionTargetInput?: never;
5785
+ unknownConnectionCondition?: never;
5786
+ malformedConditionExpression?: never;
5787
+ malformedNodeInputExpression?: never;
5788
+ mismatchedNodeInputType?: never;
5789
+ mismatchedNodeOutputType?: never;
5790
+ incompatibleConnectionDataType?: never;
5791
+ missingConnectionConfiguration?: never;
5792
+ missingDefaultCondition?: never;
5793
+ missingEndingNodes?: never;
5794
+ missingNodeConfiguration?: never;
5795
+ missingNodeInput?: never;
5796
+ missingNodeOutput?: never;
5797
+ missingStartingNodes?: never;
5798
+ multipleNodeInputConnections?: never;
5799
+ unfulfilledNodeInput?: never;
5800
+ unsatisfiedConnectionConditions?: never;
5801
+ unspecified?: never;
5802
+ $unknown?: never;
5803
+ }
5569
5804
  /**
5570
- * <p>The time the data ingestion job was last updated.</p>
5571
- * @public
5572
- */
5573
- updatedAt: Date | undefined;
5805
+ * <p>Details about an unknown target input for a connection.</p>
5806
+ * @public
5807
+ */
5808
+ interface UnknownConnectionTargetInputMember {
5809
+ cyclicConnection?: never;
5810
+ duplicateConnections?: never;
5811
+ duplicateConditionExpression?: never;
5812
+ unreachableNode?: never;
5813
+ unknownConnectionSource?: never;
5814
+ unknownConnectionSourceOutput?: never;
5815
+ unknownConnectionTarget?: never;
5816
+ unknownConnectionTargetInput: UnknownConnectionTargetInputFlowValidationDetails;
5817
+ unknownConnectionCondition?: never;
5818
+ malformedConditionExpression?: never;
5819
+ malformedNodeInputExpression?: never;
5820
+ mismatchedNodeInputType?: never;
5821
+ mismatchedNodeOutputType?: never;
5822
+ incompatibleConnectionDataType?: never;
5823
+ missingConnectionConfiguration?: never;
5824
+ missingDefaultCondition?: never;
5825
+ missingEndingNodes?: never;
5826
+ missingNodeConfiguration?: never;
5827
+ missingNodeInput?: never;
5828
+ missingNodeOutput?: never;
5829
+ missingStartingNodes?: never;
5830
+ multipleNodeInputConnections?: never;
5831
+ unfulfilledNodeInput?: never;
5832
+ unsatisfiedConnectionConditions?: never;
5833
+ unspecified?: never;
5834
+ $unknown?: never;
5835
+ }
5574
5836
  /**
5575
- * <p>Contains statistics for the data ingestion job.</p>
5576
- * @public
5577
- */
5578
- statistics?: IngestionJobStatistics;
5579
- }
5580
- /**
5581
- * @public
5582
- */
5583
- export interface ListIngestionJobsResponse {
5837
+ * <p>Details about an unknown condition for a connection.</p>
5838
+ * @public
5839
+ */
5840
+ interface UnknownConnectionConditionMember {
5841
+ cyclicConnection?: never;
5842
+ duplicateConnections?: never;
5843
+ duplicateConditionExpression?: never;
5844
+ unreachableNode?: never;
5845
+ unknownConnectionSource?: never;
5846
+ unknownConnectionSourceOutput?: never;
5847
+ unknownConnectionTarget?: never;
5848
+ unknownConnectionTargetInput?: never;
5849
+ unknownConnectionCondition: UnknownConnectionConditionFlowValidationDetails;
5850
+ malformedConditionExpression?: never;
5851
+ malformedNodeInputExpression?: never;
5852
+ mismatchedNodeInputType?: never;
5853
+ mismatchedNodeOutputType?: never;
5854
+ incompatibleConnectionDataType?: never;
5855
+ missingConnectionConfiguration?: never;
5856
+ missingDefaultCondition?: never;
5857
+ missingEndingNodes?: never;
5858
+ missingNodeConfiguration?: never;
5859
+ missingNodeInput?: never;
5860
+ missingNodeOutput?: never;
5861
+ missingStartingNodes?: never;
5862
+ multipleNodeInputConnections?: never;
5863
+ unfulfilledNodeInput?: never;
5864
+ unsatisfiedConnectionConditions?: never;
5865
+ unspecified?: never;
5866
+ $unknown?: never;
5867
+ }
5584
5868
  /**
5585
- * <p>A list of data ingestion jobs with information about each job.</p>
5586
- * @public
5587
- */
5588
- ingestionJobSummaries: IngestionJobSummary[] | undefined;
5869
+ * <p>Details about a malformed condition expression in a node.</p>
5870
+ * @public
5871
+ */
5872
+ interface MalformedConditionExpressionMember {
5873
+ cyclicConnection?: never;
5874
+ duplicateConnections?: never;
5875
+ duplicateConditionExpression?: never;
5876
+ unreachableNode?: never;
5877
+ unknownConnectionSource?: never;
5878
+ unknownConnectionSourceOutput?: never;
5879
+ unknownConnectionTarget?: never;
5880
+ unknownConnectionTargetInput?: never;
5881
+ unknownConnectionCondition?: never;
5882
+ malformedConditionExpression: MalformedConditionExpressionFlowValidationDetails;
5883
+ malformedNodeInputExpression?: never;
5884
+ mismatchedNodeInputType?: never;
5885
+ mismatchedNodeOutputType?: never;
5886
+ incompatibleConnectionDataType?: never;
5887
+ missingConnectionConfiguration?: never;
5888
+ missingDefaultCondition?: never;
5889
+ missingEndingNodes?: never;
5890
+ missingNodeConfiguration?: never;
5891
+ missingNodeInput?: never;
5892
+ missingNodeOutput?: never;
5893
+ missingStartingNodes?: never;
5894
+ multipleNodeInputConnections?: never;
5895
+ unfulfilledNodeInput?: never;
5896
+ unsatisfiedConnectionConditions?: never;
5897
+ unspecified?: never;
5898
+ $unknown?: never;
5899
+ }
5589
5900
  /**
5590
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
5591
- * @public
5592
- */
5593
- nextToken?: string;
5594
- }
5595
- /**
5596
- * @public
5597
- */
5598
- export interface StartIngestionJobRequest {
5901
+ * <p>Details about a malformed input expression in a node.</p>
5902
+ * @public
5903
+ */
5904
+ interface MalformedNodeInputExpressionMember {
5905
+ cyclicConnection?: never;
5906
+ duplicateConnections?: never;
5907
+ duplicateConditionExpression?: never;
5908
+ unreachableNode?: never;
5909
+ unknownConnectionSource?: never;
5910
+ unknownConnectionSourceOutput?: never;
5911
+ unknownConnectionTarget?: never;
5912
+ unknownConnectionTargetInput?: never;
5913
+ unknownConnectionCondition?: never;
5914
+ malformedConditionExpression?: never;
5915
+ malformedNodeInputExpression: MalformedNodeInputExpressionFlowValidationDetails;
5916
+ mismatchedNodeInputType?: never;
5917
+ mismatchedNodeOutputType?: never;
5918
+ incompatibleConnectionDataType?: never;
5919
+ missingConnectionConfiguration?: never;
5920
+ missingDefaultCondition?: never;
5921
+ missingEndingNodes?: never;
5922
+ missingNodeConfiguration?: never;
5923
+ missingNodeInput?: never;
5924
+ missingNodeOutput?: never;
5925
+ missingStartingNodes?: never;
5926
+ multipleNodeInputConnections?: never;
5927
+ unfulfilledNodeInput?: never;
5928
+ unsatisfiedConnectionConditions?: never;
5929
+ unspecified?: never;
5930
+ $unknown?: never;
5931
+ }
5599
5932
  /**
5600
- * <p>The unique identifier of the knowledge base for the data ingestion job.</p>
5601
- * @public
5602
- */
5603
- knowledgeBaseId: string | undefined;
5933
+ * <p>Details about mismatched input data types in a node.</p>
5934
+ * @public
5935
+ */
5936
+ interface MismatchedNodeInputTypeMember {
5937
+ cyclicConnection?: never;
5938
+ duplicateConnections?: never;
5939
+ duplicateConditionExpression?: never;
5940
+ unreachableNode?: never;
5941
+ unknownConnectionSource?: never;
5942
+ unknownConnectionSourceOutput?: never;
5943
+ unknownConnectionTarget?: never;
5944
+ unknownConnectionTargetInput?: never;
5945
+ unknownConnectionCondition?: never;
5946
+ malformedConditionExpression?: never;
5947
+ malformedNodeInputExpression?: never;
5948
+ mismatchedNodeInputType: MismatchedNodeInputTypeFlowValidationDetails;
5949
+ mismatchedNodeOutputType?: never;
5950
+ incompatibleConnectionDataType?: never;
5951
+ missingConnectionConfiguration?: never;
5952
+ missingDefaultCondition?: never;
5953
+ missingEndingNodes?: never;
5954
+ missingNodeConfiguration?: never;
5955
+ missingNodeInput?: never;
5956
+ missingNodeOutput?: never;
5957
+ missingStartingNodes?: never;
5958
+ multipleNodeInputConnections?: never;
5959
+ unfulfilledNodeInput?: never;
5960
+ unsatisfiedConnectionConditions?: never;
5961
+ unspecified?: never;
5962
+ $unknown?: never;
5963
+ }
5604
5964
  /**
5605
- * <p>The unique identifier of the data source you want to ingest into your knowledge base.</p>
5606
- * @public
5607
- */
5608
- dataSourceId: string | undefined;
5965
+ * <p>Details about mismatched output data types in a node.</p>
5966
+ * @public
5967
+ */
5968
+ interface MismatchedNodeOutputTypeMember {
5969
+ cyclicConnection?: never;
5970
+ duplicateConnections?: never;
5971
+ duplicateConditionExpression?: never;
5972
+ unreachableNode?: never;
5973
+ unknownConnectionSource?: never;
5974
+ unknownConnectionSourceOutput?: never;
5975
+ unknownConnectionTarget?: never;
5976
+ unknownConnectionTargetInput?: never;
5977
+ unknownConnectionCondition?: never;
5978
+ malformedConditionExpression?: never;
5979
+ malformedNodeInputExpression?: never;
5980
+ mismatchedNodeInputType?: never;
5981
+ mismatchedNodeOutputType: MismatchedNodeOutputTypeFlowValidationDetails;
5982
+ incompatibleConnectionDataType?: never;
5983
+ missingConnectionConfiguration?: never;
5984
+ missingDefaultCondition?: never;
5985
+ missingEndingNodes?: never;
5986
+ missingNodeConfiguration?: never;
5987
+ missingNodeInput?: never;
5988
+ missingNodeOutput?: never;
5989
+ missingStartingNodes?: never;
5990
+ multipleNodeInputConnections?: never;
5991
+ unfulfilledNodeInput?: never;
5992
+ unsatisfiedConnectionConditions?: never;
5993
+ unspecified?: never;
5994
+ $unknown?: never;
5995
+ }
5609
5996
  /**
5610
- * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
5611
- * Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
5612
- * @public
5613
- */
5614
- clientToken?: string;
5997
+ * <p>Details about incompatible data types in a connection.</p>
5998
+ * @public
5999
+ */
6000
+ interface IncompatibleConnectionDataTypeMember {
6001
+ cyclicConnection?: never;
6002
+ duplicateConnections?: never;
6003
+ duplicateConditionExpression?: never;
6004
+ unreachableNode?: never;
6005
+ unknownConnectionSource?: never;
6006
+ unknownConnectionSourceOutput?: never;
6007
+ unknownConnectionTarget?: never;
6008
+ unknownConnectionTargetInput?: never;
6009
+ unknownConnectionCondition?: never;
6010
+ malformedConditionExpression?: never;
6011
+ malformedNodeInputExpression?: never;
6012
+ mismatchedNodeInputType?: never;
6013
+ mismatchedNodeOutputType?: never;
6014
+ incompatibleConnectionDataType: IncompatibleConnectionDataTypeFlowValidationDetails;
6015
+ missingConnectionConfiguration?: never;
6016
+ missingDefaultCondition?: never;
6017
+ missingEndingNodes?: never;
6018
+ missingNodeConfiguration?: never;
6019
+ missingNodeInput?: never;
6020
+ missingNodeOutput?: never;
6021
+ missingStartingNodes?: never;
6022
+ multipleNodeInputConnections?: never;
6023
+ unfulfilledNodeInput?: never;
6024
+ unsatisfiedConnectionConditions?: never;
6025
+ unspecified?: never;
6026
+ $unknown?: never;
6027
+ }
5615
6028
  /**
5616
- * <p>A description of the data ingestion job.</p>
5617
- * @public
5618
- */
5619
- description?: string;
5620
- }
5621
- /**
5622
- * @public
5623
- */
5624
- export interface StartIngestionJobResponse {
6029
+ * <p>Details about missing configuration for a connection.</p>
6030
+ * @public
6031
+ */
6032
+ interface MissingConnectionConfigurationMember {
6033
+ cyclicConnection?: never;
6034
+ duplicateConnections?: never;
6035
+ duplicateConditionExpression?: never;
6036
+ unreachableNode?: never;
6037
+ unknownConnectionSource?: never;
6038
+ unknownConnectionSourceOutput?: never;
6039
+ unknownConnectionTarget?: never;
6040
+ unknownConnectionTargetInput?: never;
6041
+ unknownConnectionCondition?: never;
6042
+ malformedConditionExpression?: never;
6043
+ malformedNodeInputExpression?: never;
6044
+ mismatchedNodeInputType?: never;
6045
+ mismatchedNodeOutputType?: never;
6046
+ incompatibleConnectionDataType?: never;
6047
+ missingConnectionConfiguration: MissingConnectionConfigurationFlowValidationDetails;
6048
+ missingDefaultCondition?: never;
6049
+ missingEndingNodes?: never;
6050
+ missingNodeConfiguration?: never;
6051
+ missingNodeInput?: never;
6052
+ missingNodeOutput?: never;
6053
+ missingStartingNodes?: never;
6054
+ multipleNodeInputConnections?: never;
6055
+ unfulfilledNodeInput?: never;
6056
+ unsatisfiedConnectionConditions?: never;
6057
+ unspecified?: never;
6058
+ $unknown?: never;
6059
+ }
5625
6060
  /**
5626
- * <p>Contains information about the data ingestion job.</p>
5627
- * @public
5628
- */
5629
- ingestionJob: IngestionJob | undefined;
5630
- }
5631
- /**
5632
- * @public
5633
- */
5634
- export interface StopIngestionJobRequest {
6061
+ * <p>Details about a missing default condition in a conditional node.</p>
6062
+ * @public
6063
+ */
6064
+ interface MissingDefaultConditionMember {
6065
+ cyclicConnection?: never;
6066
+ duplicateConnections?: never;
6067
+ duplicateConditionExpression?: never;
6068
+ unreachableNode?: never;
6069
+ unknownConnectionSource?: never;
6070
+ unknownConnectionSourceOutput?: never;
6071
+ unknownConnectionTarget?: never;
6072
+ unknownConnectionTargetInput?: never;
6073
+ unknownConnectionCondition?: never;
6074
+ malformedConditionExpression?: never;
6075
+ malformedNodeInputExpression?: never;
6076
+ mismatchedNodeInputType?: never;
6077
+ mismatchedNodeOutputType?: never;
6078
+ incompatibleConnectionDataType?: never;
6079
+ missingConnectionConfiguration?: never;
6080
+ missingDefaultCondition: MissingDefaultConditionFlowValidationDetails;
6081
+ missingEndingNodes?: never;
6082
+ missingNodeConfiguration?: never;
6083
+ missingNodeInput?: never;
6084
+ missingNodeOutput?: never;
6085
+ missingStartingNodes?: never;
6086
+ multipleNodeInputConnections?: never;
6087
+ unfulfilledNodeInput?: never;
6088
+ unsatisfiedConnectionConditions?: never;
6089
+ unspecified?: never;
6090
+ $unknown?: never;
6091
+ }
5635
6092
  /**
5636
- * <p>The unique identifier of the knowledge base for the data ingestion job you want to stop.</p>
5637
- * @public
5638
- */
5639
- knowledgeBaseId: string | undefined;
6093
+ * <p>Details about missing ending nodes in the flow.</p>
6094
+ * @public
6095
+ */
6096
+ interface MissingEndingNodesMember {
6097
+ cyclicConnection?: never;
6098
+ duplicateConnections?: never;
6099
+ duplicateConditionExpression?: never;
6100
+ unreachableNode?: never;
6101
+ unknownConnectionSource?: never;
6102
+ unknownConnectionSourceOutput?: never;
6103
+ unknownConnectionTarget?: never;
6104
+ unknownConnectionTargetInput?: never;
6105
+ unknownConnectionCondition?: never;
6106
+ malformedConditionExpression?: never;
6107
+ malformedNodeInputExpression?: never;
6108
+ mismatchedNodeInputType?: never;
6109
+ mismatchedNodeOutputType?: never;
6110
+ incompatibleConnectionDataType?: never;
6111
+ missingConnectionConfiguration?: never;
6112
+ missingDefaultCondition?: never;
6113
+ missingEndingNodes: MissingEndingNodesFlowValidationDetails;
6114
+ missingNodeConfiguration?: never;
6115
+ missingNodeInput?: never;
6116
+ missingNodeOutput?: never;
6117
+ missingStartingNodes?: never;
6118
+ multipleNodeInputConnections?: never;
6119
+ unfulfilledNodeInput?: never;
6120
+ unsatisfiedConnectionConditions?: never;
6121
+ unspecified?: never;
6122
+ $unknown?: never;
6123
+ }
5640
6124
  /**
5641
- * <p>The unique identifier of the data source for the data ingestion job you want to stop.</p>
5642
- * @public
5643
- */
5644
- dataSourceId: string | undefined;
6125
+ * <p>Details about missing configuration for a node.</p>
6126
+ * @public
6127
+ */
6128
+ interface MissingNodeConfigurationMember {
6129
+ cyclicConnection?: never;
6130
+ duplicateConnections?: never;
6131
+ duplicateConditionExpression?: never;
6132
+ unreachableNode?: never;
6133
+ unknownConnectionSource?: never;
6134
+ unknownConnectionSourceOutput?: never;
6135
+ unknownConnectionTarget?: never;
6136
+ unknownConnectionTargetInput?: never;
6137
+ unknownConnectionCondition?: never;
6138
+ malformedConditionExpression?: never;
6139
+ malformedNodeInputExpression?: never;
6140
+ mismatchedNodeInputType?: never;
6141
+ mismatchedNodeOutputType?: never;
6142
+ incompatibleConnectionDataType?: never;
6143
+ missingConnectionConfiguration?: never;
6144
+ missingDefaultCondition?: never;
6145
+ missingEndingNodes?: never;
6146
+ missingNodeConfiguration: MissingNodeConfigurationFlowValidationDetails;
6147
+ missingNodeInput?: never;
6148
+ missingNodeOutput?: never;
6149
+ missingStartingNodes?: never;
6150
+ multipleNodeInputConnections?: never;
6151
+ unfulfilledNodeInput?: never;
6152
+ unsatisfiedConnectionConditions?: never;
6153
+ unspecified?: never;
6154
+ $unknown?: never;
6155
+ }
5645
6156
  /**
5646
- * <p>The unique identifier of the data ingestion job you want to stop.</p>
5647
- * @public
5648
- */
5649
- ingestionJobId: string | undefined;
5650
- }
5651
- /**
5652
- * @public
5653
- */
5654
- export interface StopIngestionJobResponse {
6157
+ * <p>Details about a missing required input in a node.</p>
6158
+ * @public
6159
+ */
6160
+ interface MissingNodeInputMember {
6161
+ cyclicConnection?: never;
6162
+ duplicateConnections?: never;
6163
+ duplicateConditionExpression?: never;
6164
+ unreachableNode?: never;
6165
+ unknownConnectionSource?: never;
6166
+ unknownConnectionSourceOutput?: never;
6167
+ unknownConnectionTarget?: never;
6168
+ unknownConnectionTargetInput?: never;
6169
+ unknownConnectionCondition?: never;
6170
+ malformedConditionExpression?: never;
6171
+ malformedNodeInputExpression?: never;
6172
+ mismatchedNodeInputType?: never;
6173
+ mismatchedNodeOutputType?: never;
6174
+ incompatibleConnectionDataType?: never;
6175
+ missingConnectionConfiguration?: never;
6176
+ missingDefaultCondition?: never;
6177
+ missingEndingNodes?: never;
6178
+ missingNodeConfiguration?: never;
6179
+ missingNodeInput: MissingNodeInputFlowValidationDetails;
6180
+ missingNodeOutput?: never;
6181
+ missingStartingNodes?: never;
6182
+ multipleNodeInputConnections?: never;
6183
+ unfulfilledNodeInput?: never;
6184
+ unsatisfiedConnectionConditions?: never;
6185
+ unspecified?: never;
6186
+ $unknown?: never;
6187
+ }
5655
6188
  /**
5656
- * <p>Contains information about the stopped data ingestion job.</p>
5657
- * @public
5658
- */
5659
- ingestionJob: IngestionJob | undefined;
5660
- }
5661
- /**
5662
- * @public
5663
- */
5664
- export interface AssociateAgentKnowledgeBaseRequest {
6189
+ * <p>Details about a missing required output in a node.</p>
6190
+ * @public
6191
+ */
6192
+ interface MissingNodeOutputMember {
6193
+ cyclicConnection?: never;
6194
+ duplicateConnections?: never;
6195
+ duplicateConditionExpression?: never;
6196
+ unreachableNode?: never;
6197
+ unknownConnectionSource?: never;
6198
+ unknownConnectionSourceOutput?: never;
6199
+ unknownConnectionTarget?: never;
6200
+ unknownConnectionTargetInput?: never;
6201
+ unknownConnectionCondition?: never;
6202
+ malformedConditionExpression?: never;
6203
+ malformedNodeInputExpression?: never;
6204
+ mismatchedNodeInputType?: never;
6205
+ mismatchedNodeOutputType?: never;
6206
+ incompatibleConnectionDataType?: never;
6207
+ missingConnectionConfiguration?: never;
6208
+ missingDefaultCondition?: never;
6209
+ missingEndingNodes?: never;
6210
+ missingNodeConfiguration?: never;
6211
+ missingNodeInput?: never;
6212
+ missingNodeOutput: MissingNodeOutputFlowValidationDetails;
6213
+ missingStartingNodes?: never;
6214
+ multipleNodeInputConnections?: never;
6215
+ unfulfilledNodeInput?: never;
6216
+ unsatisfiedConnectionConditions?: never;
6217
+ unspecified?: never;
6218
+ $unknown?: never;
6219
+ }
5665
6220
  /**
5666
- * <p>The unique identifier of the agent with which you want to associate the knowledge base.</p>
5667
- * @public
5668
- */
5669
- agentId: string | undefined;
6221
+ * <p>Details about missing starting nodes in the flow.</p>
6222
+ * @public
6223
+ */
6224
+ interface MissingStartingNodesMember {
6225
+ cyclicConnection?: never;
6226
+ duplicateConnections?: never;
6227
+ duplicateConditionExpression?: never;
6228
+ unreachableNode?: never;
6229
+ unknownConnectionSource?: never;
6230
+ unknownConnectionSourceOutput?: never;
6231
+ unknownConnectionTarget?: never;
6232
+ unknownConnectionTargetInput?: never;
6233
+ unknownConnectionCondition?: never;
6234
+ malformedConditionExpression?: never;
6235
+ malformedNodeInputExpression?: never;
6236
+ mismatchedNodeInputType?: never;
6237
+ mismatchedNodeOutputType?: never;
6238
+ incompatibleConnectionDataType?: never;
6239
+ missingConnectionConfiguration?: never;
6240
+ missingDefaultCondition?: never;
6241
+ missingEndingNodes?: never;
6242
+ missingNodeConfiguration?: never;
6243
+ missingNodeInput?: never;
6244
+ missingNodeOutput?: never;
6245
+ missingStartingNodes: MissingStartingNodesFlowValidationDetails;
6246
+ multipleNodeInputConnections?: never;
6247
+ unfulfilledNodeInput?: never;
6248
+ unsatisfiedConnectionConditions?: never;
6249
+ unspecified?: never;
6250
+ $unknown?: never;
6251
+ }
5670
6252
  /**
5671
- * <p>The version of the agent with which you want to associate the knowledge base.</p>
5672
- * @public
5673
- */
5674
- agentVersion: string | undefined;
6253
+ * <p>Details about multiple connections to a single node input.</p>
6254
+ * @public
6255
+ */
6256
+ interface MultipleNodeInputConnectionsMember {
6257
+ cyclicConnection?: never;
6258
+ duplicateConnections?: never;
6259
+ duplicateConditionExpression?: never;
6260
+ unreachableNode?: never;
6261
+ unknownConnectionSource?: never;
6262
+ unknownConnectionSourceOutput?: never;
6263
+ unknownConnectionTarget?: never;
6264
+ unknownConnectionTargetInput?: never;
6265
+ unknownConnectionCondition?: never;
6266
+ malformedConditionExpression?: never;
6267
+ malformedNodeInputExpression?: never;
6268
+ mismatchedNodeInputType?: never;
6269
+ mismatchedNodeOutputType?: never;
6270
+ incompatibleConnectionDataType?: never;
6271
+ missingConnectionConfiguration?: never;
6272
+ missingDefaultCondition?: never;
6273
+ missingEndingNodes?: never;
6274
+ missingNodeConfiguration?: never;
6275
+ missingNodeInput?: never;
6276
+ missingNodeOutput?: never;
6277
+ missingStartingNodes?: never;
6278
+ multipleNodeInputConnections: MultipleNodeInputConnectionsFlowValidationDetails;
6279
+ unfulfilledNodeInput?: never;
6280
+ unsatisfiedConnectionConditions?: never;
6281
+ unspecified?: never;
6282
+ $unknown?: never;
6283
+ }
5675
6284
  /**
5676
- * <p>The unique identifier of the knowledge base to associate with the agent.</p>
5677
- * @public
5678
- */
5679
- knowledgeBaseId: string | undefined;
6285
+ * <p>Details about an unfulfilled node input with no valid connections.</p>
6286
+ * @public
6287
+ */
6288
+ interface UnfulfilledNodeInputMember {
6289
+ cyclicConnection?: never;
6290
+ duplicateConnections?: never;
6291
+ duplicateConditionExpression?: never;
6292
+ unreachableNode?: never;
6293
+ unknownConnectionSource?: never;
6294
+ unknownConnectionSourceOutput?: never;
6295
+ unknownConnectionTarget?: never;
6296
+ unknownConnectionTargetInput?: never;
6297
+ unknownConnectionCondition?: never;
6298
+ malformedConditionExpression?: never;
6299
+ malformedNodeInputExpression?: never;
6300
+ mismatchedNodeInputType?: never;
6301
+ mismatchedNodeOutputType?: never;
6302
+ incompatibleConnectionDataType?: never;
6303
+ missingConnectionConfiguration?: never;
6304
+ missingDefaultCondition?: never;
6305
+ missingEndingNodes?: never;
6306
+ missingNodeConfiguration?: never;
6307
+ missingNodeInput?: never;
6308
+ missingNodeOutput?: never;
6309
+ missingStartingNodes?: never;
6310
+ multipleNodeInputConnections?: never;
6311
+ unfulfilledNodeInput: UnfulfilledNodeInputFlowValidationDetails;
6312
+ unsatisfiedConnectionConditions?: never;
6313
+ unspecified?: never;
6314
+ $unknown?: never;
6315
+ }
5680
6316
  /**
5681
- * <p>A description of what the agent should use the knowledge base for.</p>
5682
- * @public
5683
- */
5684
- description: string | undefined;
6317
+ * <p>Details about unsatisfied conditions for a connection.</p>
6318
+ * @public
6319
+ */
6320
+ interface UnsatisfiedConnectionConditionsMember {
6321
+ cyclicConnection?: never;
6322
+ duplicateConnections?: never;
6323
+ duplicateConditionExpression?: never;
6324
+ unreachableNode?: never;
6325
+ unknownConnectionSource?: never;
6326
+ unknownConnectionSourceOutput?: never;
6327
+ unknownConnectionTarget?: never;
6328
+ unknownConnectionTargetInput?: never;
6329
+ unknownConnectionCondition?: never;
6330
+ malformedConditionExpression?: never;
6331
+ malformedNodeInputExpression?: never;
6332
+ mismatchedNodeInputType?: never;
6333
+ mismatchedNodeOutputType?: never;
6334
+ incompatibleConnectionDataType?: never;
6335
+ missingConnectionConfiguration?: never;
6336
+ missingDefaultCondition?: never;
6337
+ missingEndingNodes?: never;
6338
+ missingNodeConfiguration?: never;
6339
+ missingNodeInput?: never;
6340
+ missingNodeOutput?: never;
6341
+ missingStartingNodes?: never;
6342
+ multipleNodeInputConnections?: never;
6343
+ unfulfilledNodeInput?: never;
6344
+ unsatisfiedConnectionConditions: UnsatisfiedConnectionConditionsFlowValidationDetails;
6345
+ unspecified?: never;
6346
+ $unknown?: never;
6347
+ }
6348
+ /**
6349
+ * <p>Details about an unspecified validation.</p>
6350
+ * @public
6351
+ */
6352
+ interface UnspecifiedMember {
6353
+ cyclicConnection?: never;
6354
+ duplicateConnections?: never;
6355
+ duplicateConditionExpression?: never;
6356
+ unreachableNode?: never;
6357
+ unknownConnectionSource?: never;
6358
+ unknownConnectionSourceOutput?: never;
6359
+ unknownConnectionTarget?: never;
6360
+ unknownConnectionTargetInput?: never;
6361
+ unknownConnectionCondition?: never;
6362
+ malformedConditionExpression?: never;
6363
+ malformedNodeInputExpression?: never;
6364
+ mismatchedNodeInputType?: never;
6365
+ mismatchedNodeOutputType?: never;
6366
+ incompatibleConnectionDataType?: never;
6367
+ missingConnectionConfiguration?: never;
6368
+ missingDefaultCondition?: never;
6369
+ missingEndingNodes?: never;
6370
+ missingNodeConfiguration?: never;
6371
+ missingNodeInput?: never;
6372
+ missingNodeOutput?: never;
6373
+ missingStartingNodes?: never;
6374
+ multipleNodeInputConnections?: never;
6375
+ unfulfilledNodeInput?: never;
6376
+ unsatisfiedConnectionConditions?: never;
6377
+ unspecified: UnspecifiedFlowValidationDetails;
6378
+ $unknown?: never;
6379
+ }
5685
6380
  /**
5686
- * <p>Specifies whether to use the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
5687
6381
  * @public
5688
6382
  */
5689
- knowledgeBaseState?: KnowledgeBaseState;
6383
+ interface $UnknownMember {
6384
+ cyclicConnection?: never;
6385
+ duplicateConnections?: never;
6386
+ duplicateConditionExpression?: never;
6387
+ unreachableNode?: never;
6388
+ unknownConnectionSource?: never;
6389
+ unknownConnectionSourceOutput?: never;
6390
+ unknownConnectionTarget?: never;
6391
+ unknownConnectionTargetInput?: never;
6392
+ unknownConnectionCondition?: never;
6393
+ malformedConditionExpression?: never;
6394
+ malformedNodeInputExpression?: never;
6395
+ mismatchedNodeInputType?: never;
6396
+ mismatchedNodeOutputType?: never;
6397
+ incompatibleConnectionDataType?: never;
6398
+ missingConnectionConfiguration?: never;
6399
+ missingDefaultCondition?: never;
6400
+ missingEndingNodes?: never;
6401
+ missingNodeConfiguration?: never;
6402
+ missingNodeInput?: never;
6403
+ missingNodeOutput?: never;
6404
+ missingStartingNodes?: never;
6405
+ multipleNodeInputConnections?: never;
6406
+ unfulfilledNodeInput?: never;
6407
+ unsatisfiedConnectionConditions?: never;
6408
+ unspecified?: never;
6409
+ $unknown: [string, any];
6410
+ }
6411
+ interface Visitor<T> {
6412
+ cyclicConnection: (value: CyclicConnectionFlowValidationDetails) => T;
6413
+ duplicateConnections: (value: DuplicateConnectionsFlowValidationDetails) => T;
6414
+ duplicateConditionExpression: (value: DuplicateConditionExpressionFlowValidationDetails) => T;
6415
+ unreachableNode: (value: UnreachableNodeFlowValidationDetails) => T;
6416
+ unknownConnectionSource: (value: UnknownConnectionSourceFlowValidationDetails) => T;
6417
+ unknownConnectionSourceOutput: (value: UnknownConnectionSourceOutputFlowValidationDetails) => T;
6418
+ unknownConnectionTarget: (value: UnknownConnectionTargetFlowValidationDetails) => T;
6419
+ unknownConnectionTargetInput: (value: UnknownConnectionTargetInputFlowValidationDetails) => T;
6420
+ unknownConnectionCondition: (value: UnknownConnectionConditionFlowValidationDetails) => T;
6421
+ malformedConditionExpression: (value: MalformedConditionExpressionFlowValidationDetails) => T;
6422
+ malformedNodeInputExpression: (value: MalformedNodeInputExpressionFlowValidationDetails) => T;
6423
+ mismatchedNodeInputType: (value: MismatchedNodeInputTypeFlowValidationDetails) => T;
6424
+ mismatchedNodeOutputType: (value: MismatchedNodeOutputTypeFlowValidationDetails) => T;
6425
+ incompatibleConnectionDataType: (value: IncompatibleConnectionDataTypeFlowValidationDetails) => T;
6426
+ missingConnectionConfiguration: (value: MissingConnectionConfigurationFlowValidationDetails) => T;
6427
+ missingDefaultCondition: (value: MissingDefaultConditionFlowValidationDetails) => T;
6428
+ missingEndingNodes: (value: MissingEndingNodesFlowValidationDetails) => T;
6429
+ missingNodeConfiguration: (value: MissingNodeConfigurationFlowValidationDetails) => T;
6430
+ missingNodeInput: (value: MissingNodeInputFlowValidationDetails) => T;
6431
+ missingNodeOutput: (value: MissingNodeOutputFlowValidationDetails) => T;
6432
+ missingStartingNodes: (value: MissingStartingNodesFlowValidationDetails) => T;
6433
+ multipleNodeInputConnections: (value: MultipleNodeInputConnectionsFlowValidationDetails) => T;
6434
+ unfulfilledNodeInput: (value: UnfulfilledNodeInputFlowValidationDetails) => T;
6435
+ unsatisfiedConnectionConditions: (value: UnsatisfiedConnectionConditionsFlowValidationDetails) => T;
6436
+ unspecified: (value: UnspecifiedFlowValidationDetails) => T;
6437
+ _: (name: string, value: any) => T;
6438
+ }
6439
+ const visit: <T>(value: FlowValidationDetails, visitor: Visitor<T>) => T;
5690
6440
  }
5691
6441
  /**
5692
6442
  * @public
6443
+ * @enum
5693
6444
  */
5694
- export interface AssociateAgentKnowledgeBaseResponse {
5695
- /**
5696
- * <p>Contains details about the knowledge base that has been associated with the agent.</p>
5697
- * @public
5698
- */
5699
- agentKnowledgeBase: AgentKnowledgeBase | undefined;
5700
- }
6445
+ export declare const FlowValidationSeverity: {
6446
+ readonly ERROR: "Error";
6447
+ readonly WARNING: "Warning";
6448
+ };
6449
+ /**
6450
+ * @public
6451
+ */
6452
+ export type FlowValidationSeverity = (typeof FlowValidationSeverity)[keyof typeof FlowValidationSeverity];
5701
6453
  /**
5702
6454
  * @public
5703
6455
  * @enum
5704
6456
  */
5705
- export declare const KnowledgeBaseType: {
5706
- readonly VECTOR: "VECTOR";
6457
+ export declare const FlowValidationType: {
6458
+ readonly CYCLIC_CONNECTION: "CyclicConnection";
6459
+ readonly DUPLICATE_CONDITION_EXPRESSION: "DuplicateConditionExpression";
6460
+ readonly DUPLICATE_CONNECTIONS: "DuplicateConnections";
6461
+ readonly INCOMPATIBLE_CONNECTION_DATA_TYPE: "IncompatibleConnectionDataType";
6462
+ readonly MALFORMED_CONDITION_EXPRESSION: "MalformedConditionExpression";
6463
+ readonly MALFORMED_NODE_INPUT_EXPRESSION: "MalformedNodeInputExpression";
6464
+ readonly MISMATCHED_NODE_INPUT_TYPE: "MismatchedNodeInputType";
6465
+ readonly MISMATCHED_NODE_OUTPUT_TYPE: "MismatchedNodeOutputType";
6466
+ readonly MISSING_CONNECTION_CONFIGURATION: "MissingConnectionConfiguration";
6467
+ readonly MISSING_DEFAULT_CONDITION: "MissingDefaultCondition";
6468
+ readonly MISSING_ENDING_NODES: "MissingEndingNodes";
6469
+ readonly MISSING_NODE_CONFIGURATION: "MissingNodeConfiguration";
6470
+ readonly MISSING_NODE_INPUT: "MissingNodeInput";
6471
+ readonly MISSING_NODE_OUTPUT: "MissingNodeOutput";
6472
+ readonly MISSING_STARTING_NODES: "MissingStartingNodes";
6473
+ readonly MULTIPLE_NODE_INPUT_CONNECTIONS: "MultipleNodeInputConnections";
6474
+ readonly UNFULFILLED_NODE_INPUT: "UnfulfilledNodeInput";
6475
+ readonly UNKNOWN_CONNECTION_CONDITION: "UnknownConnectionCondition";
6476
+ readonly UNKNOWN_CONNECTION_SOURCE: "UnknownConnectionSource";
6477
+ readonly UNKNOWN_CONNECTION_SOURCE_OUTPUT: "UnknownConnectionSourceOutput";
6478
+ readonly UNKNOWN_CONNECTION_TARGET: "UnknownConnectionTarget";
6479
+ readonly UNKNOWN_CONNECTION_TARGET_INPUT: "UnknownConnectionTargetInput";
6480
+ readonly UNREACHABLE_NODE: "UnreachableNode";
6481
+ readonly UNSATISFIED_CONNECTION_CONDITIONS: "UnsatisfiedConnectionConditions";
6482
+ readonly UNSPECIFIED: "Unspecified";
5707
6483
  };
5708
6484
  /**
5709
6485
  * @public
5710
6486
  */
5711
- export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType];
6487
+ export type FlowValidationType = (typeof FlowValidationType)[keyof typeof FlowValidationType];
5712
6488
  /**
5713
- * <p>The vector configuration details for the Bedrock embeddings model.</p>
6489
+ * <p>Contains information about validation of the flow.</p>
6490
+ * <p>This data type is used in the following API operations:</p>
6491
+ * <ul>
6492
+ * <li>
6493
+ * <p>
6494
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html#API_agent_GetFlow_ResponseSyntax">GetFlow response</a>
6495
+ * </p>
6496
+ * </li>
6497
+ * <li>
6498
+ * <p>
6499
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlowVersion.html#API_agent_GetFlowVersion_ResponseSyntax">GetFlowVersion response</a>
6500
+ * </p>
6501
+ * </li>
6502
+ * </ul>
5714
6503
  * @public
5715
6504
  */
5716
- export interface BedrockEmbeddingModelConfiguration {
6505
+ export interface FlowValidation {
5717
6506
  /**
5718
- * <p>The dimensions details for the vector configuration used on the Bedrock embeddings model.</p>
6507
+ * <p>A message describing the validation error.</p>
5719
6508
  * @public
5720
6509
  */
5721
- dimensions?: number;
5722
- }
5723
- /**
5724
- * <p>The configuration details for the embeddings model.</p>
5725
- * @public
5726
- */
5727
- export interface EmbeddingModelConfiguration {
6510
+ message: string | undefined;
5728
6511
  /**
5729
- * <p>The vector configuration details on the Bedrock embeddings model.</p>
6512
+ * <p>The severity of the issue described in the message.</p>
5730
6513
  * @public
5731
6514
  */
5732
- bedrockEmbeddingModelConfiguration?: BedrockEmbeddingModelConfiguration;
5733
- }
5734
- /**
5735
- * <p>Contains details about the model used to create vector embeddings for the knowledge base.</p>
5736
- * @public
5737
- */
5738
- export interface VectorKnowledgeBaseConfiguration {
6515
+ severity: FlowValidationSeverity | undefined;
5739
6516
  /**
5740
- * <p>The Amazon Resource Name (ARN) of the model or inference profile used to create vector embeddings for the knowledge base.</p>
6517
+ * <p>Specific details about the validation issue encountered in the flow.</p>
5741
6518
  * @public
5742
6519
  */
5743
- embeddingModelArn: string | undefined;
6520
+ details?: FlowValidationDetails;
5744
6521
  /**
5745
- * <p>The embeddings model configuration details for the vector model used in Knowledge Base.</p>
6522
+ * <p>The type of validation issue encountered in the flow.</p>
5746
6523
  * @public
5747
6524
  */
5748
- embeddingModelConfiguration?: EmbeddingModelConfiguration;
6525
+ type?: FlowValidationType;
5749
6526
  }
5750
6527
  /**
5751
- * <p>Contains details about the vector embeddings configuration of the knowledge base.</p>
5752
6528
  * @public
5753
6529
  */
5754
- export interface KnowledgeBaseConfiguration {
6530
+ export interface GetFlowResponse {
5755
6531
  /**
5756
- * <p>The type of data that the data source is converted into for the knowledge base.</p>
6532
+ * <p>The name of the flow.</p>
5757
6533
  * @public
5758
6534
  */
5759
- type: KnowledgeBaseType | undefined;
6535
+ name: string | undefined;
5760
6536
  /**
5761
- * <p>Contains details about the model that's used to convert the data source into vector embeddings.</p>
6537
+ * <p>The description of the flow.</p>
5762
6538
  * @public
5763
6539
  */
5764
- vectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration;
5765
- }
5766
- /**
5767
- * <p>Contains the names of the fields to which to map information about the vector store.</p>
5768
- * @public
5769
- */
5770
- export interface MongoDbAtlasFieldMapping {
6540
+ description?: string;
5771
6541
  /**
5772
- * <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
6542
+ * <p>The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service row for flows</a> in the Amazon Bedrock User Guide.</p>
5773
6543
  * @public
5774
6544
  */
5775
- vectorField: string | undefined;
6545
+ executionRoleArn: string | undefined;
5776
6546
  /**
5777
- * <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
6547
+ * <p>The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.</p>
5778
6548
  * @public
5779
6549
  */
5780
- textField: string | undefined;
6550
+ customerEncryptionKeyArn?: string;
5781
6551
  /**
5782
- * <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
6552
+ * <p>The unique identifier of the flow.</p>
5783
6553
  * @public
5784
6554
  */
5785
- metadataField: string | undefined;
5786
- }
5787
- /**
5788
- * <p>Contains details about the storage configuration of the knowledge base in MongoDB Atlas. </p>
5789
- * @public
5790
- */
5791
- export interface MongoDbAtlasConfiguration {
6555
+ id: string | undefined;
5792
6556
  /**
5793
- * <p>The endpoint URL of your MongoDB Atlas cluster for your knowledge base.</p>
6557
+ * <p>The Amazon Resource Name (ARN) of the flow.</p>
5794
6558
  * @public
5795
6559
  */
5796
- endpoint: string | undefined;
6560
+ arn: string | undefined;
5797
6561
  /**
5798
- * <p>The database name in your MongoDB Atlas cluster for your knowledge base.</p>
6562
+ * <p>The status of the flow. The following statuses are possible:</p>
6563
+ * <ul>
6564
+ * <li>
6565
+ * <p>NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the <code>DRAFT</code> version won't contain the latest changes for testing. Send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html">PrepareFlow</a> request to package the latest changes into the <code>DRAFT</code> version.</p>
6566
+ * </li>
6567
+ * <li>
6568
+ * <p>Preparing – The flow is being prepared so that the <code>DRAFT</code> version contains the latest changes for testing.</p>
6569
+ * </li>
6570
+ * <li>
6571
+ * <p>Prepared – The flow is prepared and the <code>DRAFT</code> version contains the latest changes for testing.</p>
6572
+ * </li>
6573
+ * <li>
6574
+ * <p>Failed – The last API operation that you invoked on the flow failed. Send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html">GetFlow</a> request and check the error message in the <code>validations</code> field.</p>
6575
+ * </li>
6576
+ * </ul>
5799
6577
  * @public
5800
6578
  */
5801
- databaseName: string | undefined;
6579
+ status: FlowStatus | undefined;
5802
6580
  /**
5803
- * <p>The collection name of the knowledge base in MongoDB Atlas.</p>
6581
+ * <p>The time at which the flow was created.</p>
5804
6582
  * @public
5805
6583
  */
5806
- collectionName: string | undefined;
6584
+ createdAt: Date | undefined;
5807
6585
  /**
5808
- * <p>The name of the MongoDB Atlas vector search index.</p>
6586
+ * <p>The time at which the flow was last updated.</p>
5809
6587
  * @public
5810
6588
  */
5811
- vectorIndexName: string | undefined;
6589
+ updatedAt: Date | undefined;
5812
6590
  /**
5813
- * <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.</p>
6591
+ * <p>The version of the flow for which information was retrieved.</p>
5814
6592
  * @public
5815
6593
  */
5816
- credentialsSecretArn: string | undefined;
6594
+ version: string | undefined;
5817
6595
  /**
5818
- * <p>Contains the names of the fields to which to map information about the vector store.</p>
6596
+ * <p>The definition of the nodes and connections between the nodes in the flow.</p>
5819
6597
  * @public
5820
6598
  */
5821
- fieldMapping: MongoDbAtlasFieldMapping | undefined;
6599
+ definition?: FlowDefinition;
5822
6600
  /**
5823
- * <p>The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.</p>
6601
+ * <p>A list of validation error messages related to the last failed operation on the flow.</p>
5824
6602
  * @public
5825
6603
  */
5826
- endpointServiceName?: string;
6604
+ validations?: FlowValidation[];
5827
6605
  }
5828
6606
  /**
5829
- * <p>Contains the names of the fields to which to map information about the vector store.</p>
5830
6607
  * @public
5831
6608
  */
5832
- export interface OpenSearchServerlessFieldMapping {
5833
- /**
5834
- * <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
5835
- * @public
5836
- */
5837
- vectorField: string | undefined;
6609
+ export interface ListFlowsRequest {
5838
6610
  /**
5839
- * <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
6611
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
5840
6612
  * @public
5841
6613
  */
5842
- textField: string | undefined;
6614
+ maxResults?: number;
5843
6615
  /**
5844
- * <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
6616
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
5845
6617
  * @public
5846
6618
  */
5847
- metadataField: string | undefined;
6619
+ nextToken?: string;
5848
6620
  }
5849
6621
  /**
5850
- * <p>Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html">Create a vector index in Amazon OpenSearch Service</a>.</p>
6622
+ * <p>Contains the definition of a flow.</p>
5851
6623
  * @public
5852
6624
  */
5853
- export interface OpenSearchServerlessConfiguration {
5854
- /**
5855
- * <p>The Amazon Resource Name (ARN) of the OpenSearch Service vector store.</p>
5856
- * @public
5857
- */
5858
- collectionArn: string | undefined;
6625
+ export interface FlowSummary {
5859
6626
  /**
5860
- * <p>The name of the vector store.</p>
6627
+ * <p>The name of the flow.</p>
5861
6628
  * @public
5862
6629
  */
5863
- vectorIndexName: string | undefined;
6630
+ name: string | undefined;
5864
6631
  /**
5865
- * <p>Contains the names of the fields to which to map information about the vector store.</p>
6632
+ * <p>A description of the flow.</p>
5866
6633
  * @public
5867
6634
  */
5868
- fieldMapping: OpenSearchServerlessFieldMapping | undefined;
5869
- }
5870
- /**
5871
- * <p>Contains the names of the fields to which to map information about the vector store.</p>
5872
- * @public
5873
- */
5874
- export interface PineconeFieldMapping {
6635
+ description?: string;
5875
6636
  /**
5876
- * <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
6637
+ * <p>The unique identifier of the flow.</p>
5877
6638
  * @public
5878
6639
  */
5879
- textField: string | undefined;
6640
+ id: string | undefined;
5880
6641
  /**
5881
- * <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
6642
+ * <p>The Amazon Resource Name (ARN) of the flow.</p>
5882
6643
  * @public
5883
6644
  */
5884
- metadataField: string | undefined;
5885
- }
5886
- /**
5887
- * <p>Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html">Create a vector index in Pinecone</a>.</p>
5888
- * @public
5889
- */
5890
- export interface PineconeConfiguration {
6645
+ arn: string | undefined;
5891
6646
  /**
5892
- * <p>The endpoint URL for your index management page.</p>
6647
+ * <p>The status of the flow. The following statuses are possible:</p>
6648
+ * <ul>
6649
+ * <li>
6650
+ * <p>NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the <code>DRAFT</code> version won't contain the latest changes for testing. Send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html">PrepareFlow</a> request to package the latest changes into the <code>DRAFT</code> version.</p>
6651
+ * </li>
6652
+ * <li>
6653
+ * <p>Preparing – The flow is being prepared so that the <code>DRAFT</code> version contains the latest changes for testing.</p>
6654
+ * </li>
6655
+ * <li>
6656
+ * <p>Prepared – The flow is prepared and the <code>DRAFT</code> version contains the latest changes for testing.</p>
6657
+ * </li>
6658
+ * <li>
6659
+ * <p>Failed – The last API operation that you invoked on the flow failed. Send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html">GetFlow</a> request and check the error message in the <code>validations</code> field.</p>
6660
+ * </li>
6661
+ * </ul>
5893
6662
  * @public
5894
6663
  */
5895
- connectionString: string | undefined;
6664
+ status: FlowStatus | undefined;
5896
6665
  /**
5897
- * <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.</p>
6666
+ * <p>The time at which the flow was created.</p>
5898
6667
  * @public
5899
6668
  */
5900
- credentialsSecretArn: string | undefined;
6669
+ createdAt: Date | undefined;
5901
6670
  /**
5902
- * <p>The namespace to be used to write new data to your database.</p>
6671
+ * <p>The time at which the flow was last updated.</p>
5903
6672
  * @public
5904
6673
  */
5905
- namespace?: string;
6674
+ updatedAt: Date | undefined;
5906
6675
  /**
5907
- * <p>Contains the names of the fields to which to map information about the vector store.</p>
6676
+ * <p>The latest version of the flow.</p>
5908
6677
  * @public
5909
6678
  */
5910
- fieldMapping: PineconeFieldMapping | undefined;
6679
+ version: string | undefined;
5911
6680
  }
5912
6681
  /**
5913
- * <p>Contains the names of the fields to which to map information about the vector store.</p>
5914
6682
  * @public
5915
6683
  */
5916
- export interface RdsFieldMapping {
6684
+ export interface ListFlowsResponse {
5917
6685
  /**
5918
- * <p>The name of the field in which Amazon Bedrock stores the ID for each entry.</p>
6686
+ * <p>A list, each member of which contains information about a flow.</p>
5919
6687
  * @public
5920
6688
  */
5921
- primaryKeyField: string | undefined;
6689
+ flowSummaries: FlowSummary[] | undefined;
5922
6690
  /**
5923
- * <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
6691
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
6692
+ * @public
6693
+ */
6694
+ nextToken?: string;
6695
+ }
6696
+ /**
6697
+ * @public
6698
+ */
6699
+ export interface PrepareFlowRequest {
6700
+ /**
6701
+ * <p>The unique identifier of the flow.</p>
5924
6702
  * @public
5925
6703
  */
5926
- vectorField: string | undefined;
6704
+ flowIdentifier: string | undefined;
6705
+ }
6706
+ /**
6707
+ * @public
6708
+ */
6709
+ export interface PrepareFlowResponse {
5927
6710
  /**
5928
- * <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
6711
+ * <p>The unique identifier of the flow.</p>
5929
6712
  * @public
5930
6713
  */
5931
- textField: string | undefined;
6714
+ id: string | undefined;
5932
6715
  /**
5933
- * <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
6716
+ * <p>The status of the flow. When you submit this request, the status will be <code>NotPrepared</code>. If preparation succeeds, the status becomes <code>Prepared</code>. If it fails, the status becomes <code>FAILED</code>.</p>
5934
6717
  * @public
5935
6718
  */
5936
- metadataField: string | undefined;
6719
+ status: FlowStatus | undefined;
5937
6720
  }
5938
6721
  /**
5939
- * <p>Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html">Create a vector index in Amazon RDS</a>.</p>
5940
6722
  * @public
5941
6723
  */
5942
- export interface RdsConfiguration {
6724
+ export interface UpdateFlowRequest {
5943
6725
  /**
5944
- * <p>The Amazon Resource Name (ARN) of the vector store.</p>
6726
+ * <p>A name for the flow.</p>
5945
6727
  * @public
5946
6728
  */
5947
- resourceArn: string | undefined;
6729
+ name: string | undefined;
5948
6730
  /**
5949
- * <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.</p>
6731
+ * <p>A description for the flow.</p>
5950
6732
  * @public
5951
6733
  */
5952
- credentialsSecretArn: string | undefined;
6734
+ description?: string;
5953
6735
  /**
5954
- * <p>The name of your Amazon RDS database.</p>
6736
+ * <p>The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
5955
6737
  * @public
5956
6738
  */
5957
- databaseName: string | undefined;
6739
+ executionRoleArn: string | undefined;
5958
6740
  /**
5959
- * <p>The name of the table in the database.</p>
6741
+ * <p>The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.</p>
5960
6742
  * @public
5961
6743
  */
5962
- tableName: string | undefined;
6744
+ customerEncryptionKeyArn?: string;
5963
6745
  /**
5964
- * <p>Contains the names of the fields to which to map information about the vector store.</p>
6746
+ * <p>A definition of the nodes and the connections between the nodes in the flow.</p>
5965
6747
  * @public
5966
6748
  */
5967
- fieldMapping: RdsFieldMapping | undefined;
6749
+ definition?: FlowDefinition;
6750
+ /**
6751
+ * <p>The unique identifier of the flow.</p>
6752
+ * @public
6753
+ */
6754
+ flowIdentifier: string | undefined;
5968
6755
  }
5969
6756
  /**
5970
- * <p>Contains the names of the fields to which to map information about the vector store.</p>
5971
6757
  * @public
5972
6758
  */
5973
- export interface RedisEnterpriseCloudFieldMapping {
6759
+ export interface UpdateFlowResponse {
5974
6760
  /**
5975
- * <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
6761
+ * <p>The name of the flow.</p>
5976
6762
  * @public
5977
6763
  */
5978
- vectorField: string | undefined;
6764
+ name: string | undefined;
5979
6765
  /**
5980
- * <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
6766
+ * <p>The description of the flow.</p>
5981
6767
  * @public
5982
6768
  */
5983
- textField: string | undefined;
6769
+ description?: string;
5984
6770
  /**
5985
- * <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
6771
+ * <p>The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
5986
6772
  * @public
5987
6773
  */
5988
- metadataField: string | undefined;
5989
- }
5990
- /**
5991
- * <p>Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html">Create a vector index in Redis Enterprise Cloud</a>.</p>
5992
- * @public
5993
- */
5994
- export interface RedisEnterpriseCloudConfiguration {
6774
+ executionRoleArn: string | undefined;
5995
6775
  /**
5996
- * <p>The endpoint URL of the Redis Enterprise Cloud database.</p>
6776
+ * <p>The Amazon Resource Name (ARN) of the KMS key that the flow was encrypted with.</p>
5997
6777
  * @public
5998
6778
  */
5999
- endpoint: string | undefined;
6779
+ customerEncryptionKeyArn?: string;
6000
6780
  /**
6001
- * <p>The name of the vector index.</p>
6781
+ * <p>The unique identifier of the flow.</p>
6002
6782
  * @public
6003
6783
  */
6004
- vectorIndexName: string | undefined;
6784
+ id: string | undefined;
6005
6785
  /**
6006
- * <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.</p>
6786
+ * <p>The Amazon Resource Name (ARN) of the flow.</p>
6007
6787
  * @public
6008
6788
  */
6009
- credentialsSecretArn: string | undefined;
6789
+ arn: string | undefined;
6010
6790
  /**
6011
- * <p>Contains the names of the fields to which to map information about the vector store.</p>
6791
+ * <p>The status of the flow. When you submit this request, the status will be <code>NotPrepared</code>. If updating fails, the status becomes <code>Failed</code>.</p>
6012
6792
  * @public
6013
6793
  */
6014
- fieldMapping: RedisEnterpriseCloudFieldMapping | undefined;
6015
- }
6016
- /**
6017
- * @public
6018
- * @enum
6019
- */
6020
- export declare const KnowledgeBaseStorageType: {
6021
- readonly MONGO_DB_ATLAS: "MONGO_DB_ATLAS";
6022
- readonly OPENSEARCH_SERVERLESS: "OPENSEARCH_SERVERLESS";
6023
- readonly PINECONE: "PINECONE";
6024
- readonly RDS: "RDS";
6025
- readonly REDIS_ENTERPRISE_CLOUD: "REDIS_ENTERPRISE_CLOUD";
6026
- };
6027
- /**
6028
- * @public
6029
- */
6030
- export type KnowledgeBaseStorageType = (typeof KnowledgeBaseStorageType)[keyof typeof KnowledgeBaseStorageType];
6031
- /**
6032
- * <p>Contains the storage configuration of the knowledge base.</p>
6033
- * @public
6034
- */
6035
- export interface StorageConfiguration {
6794
+ status: FlowStatus | undefined;
6036
6795
  /**
6037
- * <p>The vector store service in which the knowledge base is stored.</p>
6796
+ * <p>The time at which the flow was created.</p>
6038
6797
  * @public
6039
6798
  */
6040
- type: KnowledgeBaseStorageType | undefined;
6799
+ createdAt: Date | undefined;
6041
6800
  /**
6042
- * <p>Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.</p>
6801
+ * <p>The time at which the flow was last updated.</p>
6043
6802
  * @public
6044
6803
  */
6045
- opensearchServerlessConfiguration?: OpenSearchServerlessConfiguration;
6804
+ updatedAt: Date | undefined;
6046
6805
  /**
6047
- * <p>Contains the storage configuration of the knowledge base in Pinecone.</p>
6806
+ * <p>The version of the flow. When you update a flow, the version updated is the <code>DRAFT</code> version.</p>
6048
6807
  * @public
6049
6808
  */
6050
- pineconeConfiguration?: PineconeConfiguration;
6809
+ version: string | undefined;
6051
6810
  /**
6052
- * <p>Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.</p>
6811
+ * <p>A definition of the nodes and the connections between nodes in the flow.</p>
6053
6812
  * @public
6054
6813
  */
6055
- redisEnterpriseCloudConfiguration?: RedisEnterpriseCloudConfiguration;
6814
+ definition?: FlowDefinition;
6815
+ }
6816
+ /**
6817
+ * @public
6818
+ */
6819
+ export interface GetIngestionJobRequest {
6056
6820
  /**
6057
- * <p>Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html">Create a vector index in Amazon RDS</a>.</p>
6821
+ * <p>The unique identifier of the knowledge base for the data ingestion job you want to get information on.</p>
6058
6822
  * @public
6059
6823
  */
6060
- rdsConfiguration?: RdsConfiguration;
6824
+ knowledgeBaseId: string | undefined;
6061
6825
  /**
6062
- * <p>Contains the storage configuration of the knowledge base in MongoDB Atlas.</p>
6826
+ * <p>The unique identifier of the data source for the data ingestion job you want to get information on.</p>
6063
6827
  * @public
6064
6828
  */
6065
- mongoDbAtlasConfiguration?: MongoDbAtlasConfiguration;
6829
+ dataSourceId: string | undefined;
6830
+ /**
6831
+ * <p>The unique identifier of the data ingestion job you want to get information on.</p>
6832
+ * @public
6833
+ */
6834
+ ingestionJobId: string | undefined;
6066
6835
  }
6067
6836
  /**
6837
+ * <p>Contains the statistics for the data ingestion job.</p>
6068
6838
  * @public
6069
6839
  */
6070
- export interface CreateKnowledgeBaseRequest {
6840
+ export interface IngestionJobStatistics {
6071
6841
  /**
6072
- * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
6073
- * Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
6842
+ * <p>The total number of source documents that were scanned. Includes new, updated, and unchanged documents.</p>
6074
6843
  * @public
6075
6844
  */
6076
- clientToken?: string;
6845
+ numberOfDocumentsScanned?: number;
6077
6846
  /**
6078
- * <p>A name for the knowledge base.</p>
6847
+ * <p>The total number of metadata files that were scanned. Includes new, updated, and unchanged files.</p>
6079
6848
  * @public
6080
6849
  */
6081
- name: string | undefined;
6850
+ numberOfMetadataDocumentsScanned?: number;
6082
6851
  /**
6083
- * <p>A description of the knowledge base.</p>
6852
+ * <p>The number of new source documents in the data source that were successfully indexed.</p>
6084
6853
  * @public
6085
6854
  */
6086
- description?: string;
6855
+ numberOfNewDocumentsIndexed?: number;
6087
6856
  /**
6088
- * <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
6857
+ * <p>The number of modified source documents in the data source that were successfully indexed.</p>
6089
6858
  * @public
6090
6859
  */
6091
- roleArn: string | undefined;
6860
+ numberOfModifiedDocumentsIndexed?: number;
6092
6861
  /**
6093
- * <p>Contains details about the embeddings model used for the knowledge base.</p>
6862
+ * <p>The number of metadata files that were updated or deleted.</p>
6094
6863
  * @public
6095
6864
  */
6096
- knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
6865
+ numberOfMetadataDocumentsModified?: number;
6097
6866
  /**
6098
- * <p>Contains details about the configuration of the vector database used for the knowledge base.</p>
6867
+ * <p>The number of source documents that were deleted.</p>
6099
6868
  * @public
6100
6869
  */
6101
- storageConfiguration: StorageConfiguration | undefined;
6870
+ numberOfDocumentsDeleted?: number;
6102
6871
  /**
6103
- * <p>Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.</p>
6872
+ * <p>The number of source documents that failed to be ingested.</p>
6104
6873
  * @public
6105
6874
  */
6106
- tags?: Record<string, string>;
6875
+ numberOfDocumentsFailed?: number;
6107
6876
  }
6108
6877
  /**
6109
6878
  * @public
6110
6879
  * @enum
6111
6880
  */
6112
- export declare const KnowledgeBaseStatus: {
6113
- readonly ACTIVE: "ACTIVE";
6114
- readonly CREATING: "CREATING";
6115
- readonly DELETE_UNSUCCESSFUL: "DELETE_UNSUCCESSFUL";
6116
- readonly DELETING: "DELETING";
6881
+ export declare const IngestionJobStatus: {
6882
+ readonly COMPLETE: "COMPLETE";
6117
6883
  readonly FAILED: "FAILED";
6118
- readonly UPDATING: "UPDATING";
6884
+ readonly IN_PROGRESS: "IN_PROGRESS";
6885
+ readonly STARTING: "STARTING";
6886
+ readonly STOPPED: "STOPPED";
6887
+ readonly STOPPING: "STOPPING";
6119
6888
  };
6120
6889
  /**
6121
6890
  * @public
6122
6891
  */
6123
- export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof KnowledgeBaseStatus];
6892
+ export type IngestionJobStatus = (typeof IngestionJobStatus)[keyof typeof IngestionJobStatus];
6124
6893
  /**
6125
- * <p>Contains information about a knowledge base.</p>
6894
+ * <p>Contains details about a data ingestion job. Data sources are ingested into a knowledge base so that Large Language Models (LLMs) can use your data.</p>
6895
+ * <p>This data type is used in the following API operations:</p>
6896
+ * <ul>
6897
+ * <li>
6898
+ * <p>
6899
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_StartIngestionJob.html#API_agent_StartIngestionJob_ResponseSyntax">StartIngestionJob response</a>
6900
+ * </p>
6901
+ * </li>
6902
+ * <li>
6903
+ * <p>
6904
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetIngestionJob.html#API_agent_GetIngestionJob_ResponseSyntax">GetIngestionJob response</a>
6905
+ * </p>
6906
+ * </li>
6907
+ * <li>
6908
+ * <p>
6909
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax">ListIngestionJob response</a>
6910
+ * </p>
6911
+ * </li>
6912
+ * </ul>
6126
6913
  * @public
6127
6914
  */
6128
- export interface KnowledgeBase {
6129
- /**
6130
- * <p>The unique identifier of the knowledge base.</p>
6131
- * @public
6132
- */
6133
- knowledgeBaseId: string | undefined;
6134
- /**
6135
- * <p>The name of the knowledge base.</p>
6136
- * @public
6137
- */
6138
- name: string | undefined;
6139
- /**
6140
- * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
6141
- * @public
6142
- */
6143
- knowledgeBaseArn: string | undefined;
6144
- /**
6145
- * <p>The description of the knowledge base.</p>
6146
- * @public
6147
- */
6148
- description?: string;
6149
- /**
6150
- * <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
6151
- * @public
6152
- */
6153
- roleArn: string | undefined;
6154
- /**
6155
- * <p>Contains details about the embeddings configuration of the knowledge base.</p>
6156
- * @public
6157
- */
6158
- knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
6915
+ export interface IngestionJob {
6159
6916
  /**
6160
- * <p>Contains details about the storage configuration of the knowledge base.</p>
6917
+ * <p>The unique identifier of the knowledge for the data ingestion job.</p>
6161
6918
  * @public
6162
6919
  */
6163
- storageConfiguration: StorageConfiguration | undefined;
6164
- /**
6165
- * <p>The status of the knowledge base. The following statuses are possible:</p>
6166
- * <ul>
6167
- * <li>
6168
- * <p>CREATING – The knowledge base is being created.</p>
6169
- * </li>
6170
- * <li>
6171
- * <p>ACTIVE – The knowledge base is ready to be queried.</p>
6172
- * </li>
6173
- * <li>
6174
- * <p>DELETING – The knowledge base is being deleted.</p>
6175
- * </li>
6176
- * <li>
6177
- * <p>UPDATING – The knowledge base is being updated.</p>
6178
- * </li>
6179
- * <li>
6180
- * <p>FAILED – The knowledge base API operation failed.</p>
6181
- * </li>
6182
- * </ul>
6920
+ knowledgeBaseId: string | undefined;
6921
+ /**
6922
+ * <p>The unique identifier of the data source for the data ingestion job.</p>
6183
6923
  * @public
6184
6924
  */
6185
- status: KnowledgeBaseStatus | undefined;
6925
+ dataSourceId: string | undefined;
6186
6926
  /**
6187
- * <p>The time the knowledge base was created.</p>
6927
+ * <p>The unique identifier of the data ingestion job.</p>
6188
6928
  * @public
6189
6929
  */
6190
- createdAt: Date | undefined;
6930
+ ingestionJobId: string | undefined;
6191
6931
  /**
6192
- * <p>The time the knowledge base was last updated.</p>
6932
+ * <p>The description of the data ingestion job.</p>
6193
6933
  * @public
6194
6934
  */
6195
- updatedAt: Date | undefined;
6935
+ description?: string;
6196
6936
  /**
6197
- * <p>A list of reasons that the API operation on the knowledge base failed.</p>
6937
+ * <p>The status of the data ingestion job.</p>
6198
6938
  * @public
6199
6939
  */
6200
- failureReasons?: string[];
6201
- }
6202
- /**
6203
- * @public
6204
- */
6205
- export interface CreateKnowledgeBaseResponse {
6940
+ status: IngestionJobStatus | undefined;
6206
6941
  /**
6207
- * <p>Contains details about the knowledge base.</p>
6942
+ * <p>Contains statistics about the data ingestion job.</p>
6208
6943
  * @public
6209
6944
  */
6210
- knowledgeBase: KnowledgeBase | undefined;
6211
- }
6212
- /**
6213
- * @public
6214
- */
6215
- export interface DeleteKnowledgeBaseRequest {
6945
+ statistics?: IngestionJobStatistics;
6216
6946
  /**
6217
- * <p>The unique identifier of the knowledge base to delete.</p>
6947
+ * <p>A list of reasons that the data ingestion job failed.</p>
6218
6948
  * @public
6219
6949
  */
6220
- knowledgeBaseId: string | undefined;
6221
- }
6222
- /**
6223
- * @public
6224
- */
6225
- export interface DeleteKnowledgeBaseResponse {
6950
+ failureReasons?: string[];
6226
6951
  /**
6227
- * <p>The unique identifier of the knowledge base that was deleted.</p>
6952
+ * <p>The time the data ingestion job started.</p>
6953
+ * <p>If you stop a data ingestion job, the <code>startedAt</code> time is the time the job was started before the job was stopped.</p>
6228
6954
  * @public
6229
6955
  */
6230
- knowledgeBaseId: string | undefined;
6956
+ startedAt: Date | undefined;
6231
6957
  /**
6232
- * <p>The status of the knowledge base and whether it has been successfully deleted.</p>
6958
+ * <p>The time the data ingestion job was last updated.</p>
6959
+ * <p>If you stop a data ingestion job, the <code>updatedAt</code> time is the time the job was stopped.</p>
6233
6960
  * @public
6234
6961
  */
6235
- status: KnowledgeBaseStatus | undefined;
6962
+ updatedAt: Date | undefined;
6236
6963
  }
6237
6964
  /**
6238
6965
  * @public
6239
6966
  */
6240
- export interface DisassociateAgentKnowledgeBaseRequest {
6241
- /**
6242
- * <p>The unique identifier of the agent from which to disassociate the knowledge base.</p>
6243
- * @public
6244
- */
6245
- agentId: string | undefined;
6246
- /**
6247
- * <p>The version of the agent from which to disassociate the knowledge base.</p>
6248
- * @public
6249
- */
6250
- agentVersion: string | undefined;
6967
+ export interface GetIngestionJobResponse {
6251
6968
  /**
6252
- * <p>The unique identifier of the knowledge base to disassociate.</p>
6969
+ * <p>Contains details about the data ingestion job.</p>
6253
6970
  * @public
6254
6971
  */
6255
- knowledgeBaseId: string | undefined;
6972
+ ingestionJob: IngestionJob | undefined;
6256
6973
  }
6257
6974
  /**
6258
6975
  * @public
6976
+ * @enum
6259
6977
  */
6260
- export interface DisassociateAgentKnowledgeBaseResponse {
6261
- }
6978
+ export declare const IngestionJobFilterAttribute: {
6979
+ readonly STATUS: "STATUS";
6980
+ };
6262
6981
  /**
6263
6982
  * @public
6264
6983
  */
6265
- export interface GetAgentKnowledgeBaseRequest {
6984
+ export type IngestionJobFilterAttribute = (typeof IngestionJobFilterAttribute)[keyof typeof IngestionJobFilterAttribute];
6985
+ /**
6986
+ * @public
6987
+ * @enum
6988
+ */
6989
+ export declare const IngestionJobFilterOperator: {
6990
+ readonly EQ: "EQ";
6991
+ };
6992
+ /**
6993
+ * @public
6994
+ */
6995
+ export type IngestionJobFilterOperator = (typeof IngestionJobFilterOperator)[keyof typeof IngestionJobFilterOperator];
6996
+ /**
6997
+ * <p>The definition of a filter to filter the data.</p>
6998
+ * @public
6999
+ */
7000
+ export interface IngestionJobFilter {
6266
7001
  /**
6267
- * <p>The unique identifier of the agent with which the knowledge base is associated.</p>
7002
+ * <p>The name of field or attribute to apply the filter.</p>
6268
7003
  * @public
6269
7004
  */
6270
- agentId: string | undefined;
7005
+ attribute: IngestionJobFilterAttribute | undefined;
6271
7006
  /**
6272
- * <p>The version of the agent with which the knowledge base is associated.</p>
7007
+ * <p>The operation to apply to the field or attribute.</p>
6273
7008
  * @public
6274
7009
  */
6275
- agentVersion: string | undefined;
7010
+ operator: IngestionJobFilterOperator | undefined;
6276
7011
  /**
6277
- * <p>The unique identifier of the knowledge base associated with the agent.</p>
7012
+ * <p>A list of values that belong to the field or attribute.</p>
6278
7013
  * @public
6279
7014
  */
6280
- knowledgeBaseId: string | undefined;
7015
+ values: string[] | undefined;
6281
7016
  }
6282
7017
  /**
6283
7018
  * @public
7019
+ * @enum
6284
7020
  */
6285
- export interface GetAgentKnowledgeBaseResponse {
6286
- /**
6287
- * <p>Contains details about a knowledge base attached to an agent.</p>
6288
- * @public
6289
- */
6290
- agentKnowledgeBase: AgentKnowledgeBase | undefined;
6291
- }
7021
+ export declare const IngestionJobSortByAttribute: {
7022
+ readonly STARTED_AT: "STARTED_AT";
7023
+ readonly STATUS: "STATUS";
7024
+ };
6292
7025
  /**
6293
7026
  * @public
6294
7027
  */
6295
- export interface GetKnowledgeBaseRequest {
6296
- /**
6297
- * <p>The unique identifier of the knowledge base you want to get information on.</p>
6298
- * @public
6299
- */
6300
- knowledgeBaseId: string | undefined;
6301
- }
7028
+ export type IngestionJobSortByAttribute = (typeof IngestionJobSortByAttribute)[keyof typeof IngestionJobSortByAttribute];
6302
7029
  /**
6303
7030
  * @public
7031
+ * @enum
6304
7032
  */
6305
- export interface GetKnowledgeBaseResponse {
6306
- /**
6307
- * <p>Contains details about the knowledge base.</p>
6308
- * @public
6309
- */
6310
- knowledgeBase: KnowledgeBase | undefined;
6311
- }
7033
+ export declare const SortOrder: {
7034
+ readonly ASCENDING: "ASCENDING";
7035
+ readonly DESCENDING: "DESCENDING";
7036
+ };
7037
+ /**
7038
+ * @public
7039
+ */
7040
+ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
6312
7041
  /**
7042
+ * <p>The parameters of sorting the data.</p>
6313
7043
  * @public
6314
7044
  */
6315
- export interface ListAgentKnowledgeBasesRequest {
7045
+ export interface IngestionJobSortBy {
6316
7046
  /**
6317
- * <p>The unique identifier of the agent for which to return information about knowledge bases associated with it.</p>
7047
+ * <p>The name of field or attribute to apply sorting of data.</p>
6318
7048
  * @public
6319
7049
  */
6320
- agentId: string | undefined;
7050
+ attribute: IngestionJobSortByAttribute | undefined;
6321
7051
  /**
6322
- * <p>The version of the agent for which to return information about knowledge bases associated with it.</p>
7052
+ * <p>The order for sorting the data.</p>
6323
7053
  * @public
6324
7054
  */
6325
- agentVersion: string | undefined;
7055
+ order: SortOrder | undefined;
7056
+ }
7057
+ /**
7058
+ * @public
7059
+ */
7060
+ export interface ListIngestionJobsRequest {
6326
7061
  /**
6327
- * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
7062
+ * <p>The unique identifier of the knowledge base for the list of data ingestion jobs.</p>
6328
7063
  * @public
6329
7064
  */
6330
- maxResults?: number;
7065
+ knowledgeBaseId: string | undefined;
6331
7066
  /**
6332
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
7067
+ * <p>The unique identifier of the data source for the list of data ingestion jobs.</p>
6333
7068
  * @public
6334
7069
  */
6335
- nextToken?: string;
6336
- }
6337
- /**
6338
- * @public
6339
- */
6340
- export interface ListAgentKnowledgeBasesResponse {
7070
+ dataSourceId: string | undefined;
6341
7071
  /**
6342
- * <p>A list of objects, each of which contains information about a knowledge base associated with the agent.</p>
7072
+ * <p>Contains information about the filters for filtering the data.</p>
6343
7073
  * @public
6344
7074
  */
6345
- agentKnowledgeBaseSummaries: AgentKnowledgeBaseSummary[] | undefined;
7075
+ filters?: IngestionJobFilter[];
6346
7076
  /**
6347
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
7077
+ * <p>Contains details about how to sort the data.</p>
6348
7078
  * @public
6349
7079
  */
6350
- nextToken?: string;
6351
- }
6352
- /**
6353
- * @public
6354
- */
6355
- export interface ListKnowledgeBasesRequest {
7080
+ sortBy?: IngestionJobSortBy;
6356
7081
  /**
6357
7082
  * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
6358
7083
  * @public
@@ -6365,45 +7090,60 @@ export interface ListKnowledgeBasesRequest {
6365
7090
  nextToken?: string;
6366
7091
  }
6367
7092
  /**
6368
- * <p>Contains details about a knowledge base.</p>
7093
+ * <p>Contains details about a data ingestion job.</p>
6369
7094
  * @public
6370
7095
  */
6371
- export interface KnowledgeBaseSummary {
7096
+ export interface IngestionJobSummary {
6372
7097
  /**
6373
- * <p>The unique identifier of the knowledge base.</p>
7098
+ * <p>The unique identifier of the knowledge base for the data ingestion job.</p>
6374
7099
  * @public
6375
7100
  */
6376
7101
  knowledgeBaseId: string | undefined;
6377
7102
  /**
6378
- * <p>The name of the knowledge base.</p>
7103
+ * <p>The unique identifier of the data source for the data ingestion job.</p>
6379
7104
  * @public
6380
7105
  */
6381
- name: string | undefined;
7106
+ dataSourceId: string | undefined;
6382
7107
  /**
6383
- * <p>The description of the knowledge base.</p>
7108
+ * <p>The unique identifier of the data ingestion job.</p>
7109
+ * @public
7110
+ */
7111
+ ingestionJobId: string | undefined;
7112
+ /**
7113
+ * <p>The description of the data ingestion job.</p>
6384
7114
  * @public
6385
7115
  */
6386
7116
  description?: string;
6387
7117
  /**
6388
- * <p>The status of the knowledge base.</p>
7118
+ * <p>The status of the data ingestion job.</p>
6389
7119
  * @public
6390
7120
  */
6391
- status: KnowledgeBaseStatus | undefined;
7121
+ status: IngestionJobStatus | undefined;
6392
7122
  /**
6393
- * <p>The time the knowledge base was last updated.</p>
7123
+ * <p>The time the data ingestion job started.</p>
7124
+ * @public
7125
+ */
7126
+ startedAt: Date | undefined;
7127
+ /**
7128
+ * <p>The time the data ingestion job was last updated.</p>
6394
7129
  * @public
6395
7130
  */
6396
7131
  updatedAt: Date | undefined;
7132
+ /**
7133
+ * <p>Contains statistics for the data ingestion job.</p>
7134
+ * @public
7135
+ */
7136
+ statistics?: IngestionJobStatistics;
6397
7137
  }
6398
7138
  /**
6399
7139
  * @public
6400
7140
  */
6401
- export interface ListKnowledgeBasesResponse {
7141
+ export interface ListIngestionJobsResponse {
6402
7142
  /**
6403
- * <p>A list of knowledge bases with information about each knowledge base.</p>
7143
+ * <p>A list of data ingestion jobs with information about each job.</p>
6404
7144
  * @public
6405
7145
  */
6406
- knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
7146
+ ingestionJobSummaries: IngestionJobSummary[] | undefined;
6407
7147
  /**
6408
7148
  * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
6409
7149
  * @public
@@ -6413,755 +7153,719 @@ export interface ListKnowledgeBasesResponse {
6413
7153
  /**
6414
7154
  * @public
6415
7155
  */
6416
- export interface UpdateAgentKnowledgeBaseRequest {
7156
+ export interface StartIngestionJobRequest {
6417
7157
  /**
6418
- * <p>The unique identifier of the agent associated with the knowledge base that you want to update.</p>
7158
+ * <p>The unique identifier of the knowledge base for the data ingestion job.</p>
6419
7159
  * @public
6420
7160
  */
6421
- agentId: string | undefined;
7161
+ knowledgeBaseId: string | undefined;
6422
7162
  /**
6423
- * <p>The version of the agent associated with the knowledge base that you want to update.</p>
7163
+ * <p>The unique identifier of the data source you want to ingest into your knowledge base.</p>
6424
7164
  * @public
6425
7165
  */
6426
- agentVersion: string | undefined;
7166
+ dataSourceId: string | undefined;
6427
7167
  /**
6428
- * <p>The unique identifier of the knowledge base that has been associated with an agent.</p>
7168
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
7169
+ * Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
6429
7170
  * @public
6430
7171
  */
6431
- knowledgeBaseId: string | undefined;
7172
+ clientToken?: string;
6432
7173
  /**
6433
- * <p>Specifies a new description for the knowledge base associated with an agent.</p>
7174
+ * <p>A description of the data ingestion job.</p>
6434
7175
  * @public
6435
7176
  */
6436
7177
  description?: string;
6437
- /**
6438
- * <p>Specifies whether the agent uses the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
6439
- * @public
6440
- */
6441
- knowledgeBaseState?: KnowledgeBaseState;
6442
7178
  }
6443
7179
  /**
6444
7180
  * @public
6445
7181
  */
6446
- export interface UpdateAgentKnowledgeBaseResponse {
7182
+ export interface StartIngestionJobResponse {
6447
7183
  /**
6448
- * <p>Contains details about the knowledge base that has been associated with an agent.</p>
7184
+ * <p>Contains information about the data ingestion job.</p>
6449
7185
  * @public
6450
7186
  */
6451
- agentKnowledgeBase: AgentKnowledgeBase | undefined;
7187
+ ingestionJob: IngestionJob | undefined;
6452
7188
  }
6453
7189
  /**
6454
7190
  * @public
6455
7191
  */
6456
- export interface UpdateKnowledgeBaseRequest {
7192
+ export interface StopIngestionJobRequest {
6457
7193
  /**
6458
- * <p>The unique identifier of the knowledge base to update.</p>
7194
+ * <p>The unique identifier of the knowledge base for the data ingestion job you want to stop.</p>
6459
7195
  * @public
6460
7196
  */
6461
7197
  knowledgeBaseId: string | undefined;
6462
7198
  /**
6463
- * <p>Specifies a new name for the knowledge base.</p>
6464
- * @public
6465
- */
6466
- name: string | undefined;
6467
- /**
6468
- * <p>Specifies a new description for the knowledge base.</p>
6469
- * @public
6470
- */
6471
- description?: string;
6472
- /**
6473
- * <p>Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
6474
- * @public
6475
- */
6476
- roleArn: string | undefined;
6477
- /**
6478
- * <p>Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.</p>
6479
- * @public
6480
- */
6481
- knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
6482
- /**
6483
- * <p>Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.</p>
7199
+ * <p>The unique identifier of the data source for the data ingestion job you want to stop.</p>
6484
7200
  * @public
6485
7201
  */
6486
- storageConfiguration: StorageConfiguration | undefined;
6487
- }
6488
- /**
6489
- * @public
6490
- */
6491
- export interface UpdateKnowledgeBaseResponse {
7202
+ dataSourceId: string | undefined;
6492
7203
  /**
6493
- * <p>Contains details about the knowledge base.</p>
7204
+ * <p>The unique identifier of the data ingestion job you want to stop.</p>
6494
7205
  * @public
6495
7206
  */
6496
- knowledgeBase: KnowledgeBase | undefined;
7207
+ ingestionJobId: string | undefined;
6497
7208
  }
6498
7209
  /**
6499
- * <p>Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html">Create a prompt using Prompt management</a>.</p>
6500
7210
  * @public
6501
7211
  */
6502
- export interface PromptMetadataEntry {
6503
- /**
6504
- * <p>The key of a metadata tag for a prompt variant.</p>
6505
- * @public
6506
- */
6507
- key: string | undefined;
7212
+ export interface StopIngestionJobResponse {
6508
7213
  /**
6509
- * <p>The value of a metadata tag for a prompt variant.</p>
7214
+ * <p>Contains information about the stopped data ingestion job.</p>
6510
7215
  * @public
6511
7216
  */
6512
- value: string | undefined;
7217
+ ingestionJob: IngestionJob | undefined;
6513
7218
  }
6514
7219
  /**
6515
- * <p>Contains details about a variant of the prompt.</p>
6516
7220
  * @public
6517
7221
  */
6518
- export interface PromptVariant {
6519
- /**
6520
- * <p>The name of the prompt variant.</p>
6521
- * @public
6522
- */
6523
- name: string | undefined;
6524
- /**
6525
- * <p>The type of prompt template to use.</p>
6526
- * @public
6527
- */
6528
- templateType: PromptTemplateType | undefined;
7222
+ export interface AssociateAgentKnowledgeBaseRequest {
6529
7223
  /**
6530
- * <p>Contains configurations for the prompt template.</p>
7224
+ * <p>The unique identifier of the agent with which you want to associate the knowledge base.</p>
6531
7225
  * @public
6532
7226
  */
6533
- templateConfiguration: PromptTemplateConfiguration | undefined;
7227
+ agentId: string | undefined;
6534
7228
  /**
6535
- * <p>The unique identifier of the model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> with which to run inference on the prompt.</p>
7229
+ * <p>The version of the agent with which you want to associate the knowledge base.</p>
6536
7230
  * @public
6537
7231
  */
6538
- modelId?: string;
7232
+ agentVersion: string | undefined;
6539
7233
  /**
6540
- * <p>Contains inference configurations for the prompt variant.</p>
7234
+ * <p>The unique identifier of the knowledge base to associate with the agent.</p>
6541
7235
  * @public
6542
7236
  */
6543
- inferenceConfiguration?: PromptInferenceConfiguration;
7237
+ knowledgeBaseId: string | undefined;
6544
7238
  /**
6545
- * <p>An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html">Create a prompt using Prompt management</a>.</p>
7239
+ * <p>A description of what the agent should use the knowledge base for.</p>
6546
7240
  * @public
6547
7241
  */
6548
- metadata?: PromptMetadataEntry[];
7242
+ description: string | undefined;
6549
7243
  /**
6550
- * <p>Contains model-specific inference configurations that aren't in the <code>inferenceConfiguration</code> field. To see model-specific inference parameters, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference request parameters and response fields for foundation models</a>.</p>
7244
+ * <p>Specifies whether to use the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
6551
7245
  * @public
6552
7246
  */
6553
- additionalModelRequestFields?: __DocumentType;
7247
+ knowledgeBaseState?: KnowledgeBaseState;
6554
7248
  }
6555
7249
  /**
6556
7250
  * @public
6557
7251
  */
6558
- export interface CreatePromptRequest {
7252
+ export interface AssociateAgentKnowledgeBaseResponse {
6559
7253
  /**
6560
- * <p>A name for the prompt.</p>
7254
+ * <p>Contains details about the knowledge base that has been associated with the agent.</p>
6561
7255
  * @public
6562
7256
  */
6563
- name: string | undefined;
7257
+ agentKnowledgeBase: AgentKnowledgeBase | undefined;
7258
+ }
7259
+ /**
7260
+ * @public
7261
+ * @enum
7262
+ */
7263
+ export declare const KnowledgeBaseType: {
7264
+ readonly VECTOR: "VECTOR";
7265
+ };
7266
+ /**
7267
+ * @public
7268
+ */
7269
+ export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType];
7270
+ /**
7271
+ * <p>The vector configuration details for the Bedrock embeddings model.</p>
7272
+ * @public
7273
+ */
7274
+ export interface BedrockEmbeddingModelConfiguration {
6564
7275
  /**
6565
- * <p>A description for the prompt.</p>
7276
+ * <p>The dimensions details for the vector configuration used on the Bedrock embeddings model.</p>
6566
7277
  * @public
6567
7278
  */
6568
- description?: string;
7279
+ dimensions?: number;
7280
+ }
7281
+ /**
7282
+ * <p>The configuration details for the embeddings model.</p>
7283
+ * @public
7284
+ */
7285
+ export interface EmbeddingModelConfiguration {
6569
7286
  /**
6570
- * <p>The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.</p>
7287
+ * <p>The vector configuration details on the Bedrock embeddings model.</p>
6571
7288
  * @public
6572
7289
  */
6573
- customerEncryptionKeyArn?: string;
7290
+ bedrockEmbeddingModelConfiguration?: BedrockEmbeddingModelConfiguration;
7291
+ }
7292
+ /**
7293
+ * <p>Contains details about the model used to create vector embeddings for the knowledge base.</p>
7294
+ * @public
7295
+ */
7296
+ export interface VectorKnowledgeBaseConfiguration {
6574
7297
  /**
6575
- * <p>The name of the default variant for the prompt. This value must match the <code>name</code> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.</p>
7298
+ * <p>The Amazon Resource Name (ARN) of the model or inference profile used to create vector embeddings for the knowledge base.</p>
6576
7299
  * @public
6577
7300
  */
6578
- defaultVariant?: string;
7301
+ embeddingModelArn: string | undefined;
6579
7302
  /**
6580
- * <p>A list of objects, each containing details about a variant of the prompt.</p>
7303
+ * <p>The embeddings model configuration details for the vector model used in Knowledge Base.</p>
6581
7304
  * @public
6582
7305
  */
6583
- variants?: PromptVariant[];
7306
+ embeddingModelConfiguration?: EmbeddingModelConfiguration;
7307
+ }
7308
+ /**
7309
+ * <p>Contains details about the vector embeddings configuration of the knowledge base.</p>
7310
+ * @public
7311
+ */
7312
+ export interface KnowledgeBaseConfiguration {
6584
7313
  /**
6585
- * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
6586
- * Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
7314
+ * <p>The type of data that the data source is converted into for the knowledge base.</p>
6587
7315
  * @public
6588
7316
  */
6589
- clientToken?: string;
7317
+ type: KnowledgeBaseType | undefined;
6590
7318
  /**
6591
- * <p>Any tags that you want to attach to the prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging resources in Amazon Bedrock</a>.</p>
7319
+ * <p>Contains details about the model that's used to convert the data source into vector embeddings.</p>
6592
7320
  * @public
6593
7321
  */
6594
- tags?: Record<string, string>;
7322
+ vectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration;
6595
7323
  }
6596
7324
  /**
7325
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
6597
7326
  * @public
6598
7327
  */
6599
- export interface CreatePromptResponse {
7328
+ export interface MongoDbAtlasFieldMapping {
6600
7329
  /**
6601
- * <p>The name of the prompt.</p>
7330
+ * <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
6602
7331
  * @public
6603
7332
  */
6604
- name: string | undefined;
7333
+ vectorField: string | undefined;
6605
7334
  /**
6606
- * <p>The description of the prompt.</p>
7335
+ * <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
6607
7336
  * @public
6608
7337
  */
6609
- description?: string;
7338
+ textField: string | undefined;
6610
7339
  /**
6611
- * <p>The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.</p>
7340
+ * <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
6612
7341
  * @public
6613
7342
  */
6614
- customerEncryptionKeyArn?: string;
7343
+ metadataField: string | undefined;
7344
+ }
7345
+ /**
7346
+ * <p>Contains details about the storage configuration of the knowledge base in MongoDB Atlas. </p>
7347
+ * @public
7348
+ */
7349
+ export interface MongoDbAtlasConfiguration {
6615
7350
  /**
6616
- * <p>The name of the default variant for your prompt.</p>
7351
+ * <p>The endpoint URL of your MongoDB Atlas cluster for your knowledge base.</p>
6617
7352
  * @public
6618
7353
  */
6619
- defaultVariant?: string;
7354
+ endpoint: string | undefined;
6620
7355
  /**
6621
- * <p>A list of objects, each containing details about a variant of the prompt.</p>
7356
+ * <p>The database name in your MongoDB Atlas cluster for your knowledge base.</p>
6622
7357
  * @public
6623
7358
  */
6624
- variants?: PromptVariant[];
7359
+ databaseName: string | undefined;
6625
7360
  /**
6626
- * <p>The unique identifier of the prompt.</p>
7361
+ * <p>The collection name of the knowledge base in MongoDB Atlas.</p>
6627
7362
  * @public
6628
7363
  */
6629
- id: string | undefined;
7364
+ collectionName: string | undefined;
6630
7365
  /**
6631
- * <p>The Amazon Resource Name (ARN) of the prompt.</p>
7366
+ * <p>The name of the MongoDB Atlas vector search index.</p>
6632
7367
  * @public
6633
7368
  */
6634
- arn: string | undefined;
7369
+ vectorIndexName: string | undefined;
6635
7370
  /**
6636
- * <p>The version of the prompt. When you create a prompt, the version created is the <code>DRAFT</code> version.</p>
7371
+ * <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.</p>
6637
7372
  * @public
6638
7373
  */
6639
- version: string | undefined;
7374
+ credentialsSecretArn: string | undefined;
6640
7375
  /**
6641
- * <p>The time at which the prompt was created.</p>
7376
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
6642
7377
  * @public
6643
7378
  */
6644
- createdAt: Date | undefined;
7379
+ fieldMapping: MongoDbAtlasFieldMapping | undefined;
6645
7380
  /**
6646
- * <p>The time at which the prompt was last updated.</p>
7381
+ * <p>The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.</p>
6647
7382
  * @public
6648
7383
  */
6649
- updatedAt: Date | undefined;
7384
+ endpointServiceName?: string;
6650
7385
  }
6651
7386
  /**
7387
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
6652
7388
  * @public
6653
7389
  */
6654
- export interface CreatePromptVersionRequest {
6655
- /**
6656
- * <p>The unique identifier of the prompt that you want to create a version of.</p>
6657
- * @public
6658
- */
6659
- promptIdentifier: string | undefined;
7390
+ export interface OpenSearchServerlessFieldMapping {
6660
7391
  /**
6661
- * <p>A description for the version of the prompt.</p>
7392
+ * <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
6662
7393
  * @public
6663
7394
  */
6664
- description?: string;
7395
+ vectorField: string | undefined;
6665
7396
  /**
6666
- * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
6667
- * Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
7397
+ * <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
6668
7398
  * @public
6669
7399
  */
6670
- clientToken?: string;
7400
+ textField: string | undefined;
6671
7401
  /**
6672
- * <p>Any tags that you want to attach to the version of the prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging resources in Amazon Bedrock</a>.</p>
7402
+ * <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
6673
7403
  * @public
6674
7404
  */
6675
- tags?: Record<string, string>;
7405
+ metadataField: string | undefined;
6676
7406
  }
6677
7407
  /**
7408
+ * <p>Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html">Create a vector index in Amazon OpenSearch Service</a>.</p>
6678
7409
  * @public
6679
7410
  */
6680
- export interface CreatePromptVersionResponse {
6681
- /**
6682
- * <p>The name of the prompt.</p>
6683
- * @public
6684
- */
6685
- name: string | undefined;
6686
- /**
6687
- * <p>A description for the version.</p>
6688
- * @public
6689
- */
6690
- description?: string;
6691
- /**
6692
- * <p>The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.</p>
6693
- * @public
6694
- */
6695
- customerEncryptionKeyArn?: string;
6696
- /**
6697
- * <p>The name of the default variant for the prompt. This value must match the <code>name</code> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.</p>
6698
- * @public
6699
- */
6700
- defaultVariant?: string;
6701
- /**
6702
- * <p>A list of objects, each containing details about a variant of the prompt.</p>
6703
- * @public
6704
- */
6705
- variants?: PromptVariant[];
7411
+ export interface OpenSearchServerlessConfiguration {
6706
7412
  /**
6707
- * <p>The unique identifier of the prompt.</p>
7413
+ * <p>The Amazon Resource Name (ARN) of the OpenSearch Service vector store.</p>
6708
7414
  * @public
6709
7415
  */
6710
- id: string | undefined;
7416
+ collectionArn: string | undefined;
6711
7417
  /**
6712
- * <p>The Amazon Resource Name (ARN) of the version of the prompt.</p>
7418
+ * <p>The name of the vector store.</p>
6713
7419
  * @public
6714
7420
  */
6715
- arn: string | undefined;
7421
+ vectorIndexName: string | undefined;
6716
7422
  /**
6717
- * <p>The version of the prompt that was created. Versions are numbered incrementally, starting from 1.</p>
7423
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
6718
7424
  * @public
6719
7425
  */
6720
- version: string | undefined;
7426
+ fieldMapping: OpenSearchServerlessFieldMapping | undefined;
7427
+ }
7428
+ /**
7429
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
7430
+ * @public
7431
+ */
7432
+ export interface PineconeFieldMapping {
6721
7433
  /**
6722
- * <p>The time at which the prompt was created.</p>
7434
+ * <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
6723
7435
  * @public
6724
7436
  */
6725
- createdAt: Date | undefined;
7437
+ textField: string | undefined;
6726
7438
  /**
6727
- * <p>The time at which the prompt was last updated.</p>
7439
+ * <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
6728
7440
  * @public
6729
7441
  */
6730
- updatedAt: Date | undefined;
7442
+ metadataField: string | undefined;
6731
7443
  }
6732
7444
  /**
7445
+ * <p>Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html">Create a vector index in Pinecone</a>.</p>
6733
7446
  * @public
6734
7447
  */
6735
- export interface DeletePromptRequest {
7448
+ export interface PineconeConfiguration {
6736
7449
  /**
6737
- * <p>The unique identifier of the prompt.</p>
7450
+ * <p>The endpoint URL for your index management page.</p>
6738
7451
  * @public
6739
7452
  */
6740
- promptIdentifier: string | undefined;
7453
+ connectionString: string | undefined;
6741
7454
  /**
6742
- * <p>The version of the prompt to delete. To delete the prompt, omit this field.</p>
7455
+ * <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.</p>
6743
7456
  * @public
6744
7457
  */
6745
- promptVersion?: string;
6746
- }
6747
- /**
6748
- * @public
6749
- */
6750
- export interface DeletePromptResponse {
7458
+ credentialsSecretArn: string | undefined;
6751
7459
  /**
6752
- * <p>The unique identifier of the prompt that was deleted.</p>
7460
+ * <p>The namespace to be used to write new data to your database.</p>
6753
7461
  * @public
6754
7462
  */
6755
- id: string | undefined;
7463
+ namespace?: string;
6756
7464
  /**
6757
- * <p>The version of the prompt that was deleted.</p>
7465
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
6758
7466
  * @public
6759
7467
  */
6760
- version?: string;
7468
+ fieldMapping: PineconeFieldMapping | undefined;
6761
7469
  }
6762
7470
  /**
7471
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
6763
7472
  * @public
6764
7473
  */
6765
- export interface GetPromptRequest {
7474
+ export interface RdsFieldMapping {
6766
7475
  /**
6767
- * <p>The unique identifier of the prompt.</p>
7476
+ * <p>The name of the field in which Amazon Bedrock stores the ID for each entry.</p>
6768
7477
  * @public
6769
7478
  */
6770
- promptIdentifier: string | undefined;
7479
+ primaryKeyField: string | undefined;
6771
7480
  /**
6772
- * <p>The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.</p>
7481
+ * <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
6773
7482
  * @public
6774
7483
  */
6775
- promptVersion?: string;
6776
- }
6777
- /**
6778
- * @public
6779
- */
6780
- export interface GetPromptResponse {
7484
+ vectorField: string | undefined;
6781
7485
  /**
6782
- * <p>The name of the prompt.</p>
7486
+ * <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
6783
7487
  * @public
6784
7488
  */
6785
- name: string | undefined;
7489
+ textField: string | undefined;
6786
7490
  /**
6787
- * <p>The descriptino of the prompt.</p>
7491
+ * <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
6788
7492
  * @public
6789
7493
  */
6790
- description?: string;
7494
+ metadataField: string | undefined;
7495
+ }
7496
+ /**
7497
+ * <p>Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html">Create a vector index in Amazon RDS</a>.</p>
7498
+ * @public
7499
+ */
7500
+ export interface RdsConfiguration {
6791
7501
  /**
6792
- * <p>The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.</p>
7502
+ * <p>The Amazon Resource Name (ARN) of the vector store.</p>
6793
7503
  * @public
6794
7504
  */
6795
- customerEncryptionKeyArn?: string;
7505
+ resourceArn: string | undefined;
6796
7506
  /**
6797
- * <p>The name of the default variant for the prompt. This value must match the <code>name</code> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.</p>
7507
+ * <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.</p>
6798
7508
  * @public
6799
7509
  */
6800
- defaultVariant?: string;
7510
+ credentialsSecretArn: string | undefined;
6801
7511
  /**
6802
- * <p>A list of objects, each containing details about a variant of the prompt.</p>
7512
+ * <p>The name of your Amazon RDS database.</p>
6803
7513
  * @public
6804
7514
  */
6805
- variants?: PromptVariant[];
7515
+ databaseName: string | undefined;
6806
7516
  /**
6807
- * <p>The unique identifier of the prompt.</p>
7517
+ * <p>The name of the table in the database.</p>
6808
7518
  * @public
6809
7519
  */
6810
- id: string | undefined;
7520
+ tableName: string | undefined;
6811
7521
  /**
6812
- * <p>The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).</p>
7522
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
6813
7523
  * @public
6814
7524
  */
6815
- arn: string | undefined;
7525
+ fieldMapping: RdsFieldMapping | undefined;
7526
+ }
7527
+ /**
7528
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
7529
+ * @public
7530
+ */
7531
+ export interface RedisEnterpriseCloudFieldMapping {
6816
7532
  /**
6817
- * <p>The version of the prompt.</p>
7533
+ * <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
6818
7534
  * @public
6819
7535
  */
6820
- version: string | undefined;
7536
+ vectorField: string | undefined;
6821
7537
  /**
6822
- * <p>The time at which the prompt was created.</p>
7538
+ * <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
6823
7539
  * @public
6824
7540
  */
6825
- createdAt: Date | undefined;
7541
+ textField: string | undefined;
6826
7542
  /**
6827
- * <p>The time at which the prompt was last updated.</p>
7543
+ * <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
6828
7544
  * @public
6829
7545
  */
6830
- updatedAt: Date | undefined;
7546
+ metadataField: string | undefined;
6831
7547
  }
6832
7548
  /**
7549
+ * <p>Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html">Create a vector index in Redis Enterprise Cloud</a>.</p>
6833
7550
  * @public
6834
7551
  */
6835
- export interface ListPromptsRequest {
7552
+ export interface RedisEnterpriseCloudConfiguration {
7553
+ /**
7554
+ * <p>The endpoint URL of the Redis Enterprise Cloud database.</p>
7555
+ * @public
7556
+ */
7557
+ endpoint: string | undefined;
6836
7558
  /**
6837
- * <p>The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.</p>
7559
+ * <p>The name of the vector index.</p>
6838
7560
  * @public
6839
7561
  */
6840
- promptIdentifier?: string;
7562
+ vectorIndexName: string | undefined;
6841
7563
  /**
6842
- * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
7564
+ * <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.</p>
6843
7565
  * @public
6844
7566
  */
6845
- maxResults?: number;
7567
+ credentialsSecretArn: string | undefined;
6846
7568
  /**
6847
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
7569
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
6848
7570
  * @public
6849
7571
  */
6850
- nextToken?: string;
7572
+ fieldMapping: RedisEnterpriseCloudFieldMapping | undefined;
6851
7573
  }
6852
7574
  /**
6853
- * <p>Contains information about a prompt in your Prompt management tool.</p>
6854
- * <p>This data type is used in the following API operations:</p>
6855
- * <ul>
6856
- * <li>
6857
- * <p>
6858
- * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListPrompts.html#API_agent_ListPrompts_ResponseSyntax">ListPrompts response</a>
6859
- * </p>
6860
- * </li>
6861
- * </ul>
6862
7575
  * @public
7576
+ * @enum
6863
7577
  */
6864
- export interface PromptSummary {
6865
- /**
6866
- * <p>The name of the prompt.</p>
6867
- * @public
6868
- */
6869
- name: string | undefined;
7578
+ export declare const KnowledgeBaseStorageType: {
7579
+ readonly MONGO_DB_ATLAS: "MONGO_DB_ATLAS";
7580
+ readonly OPENSEARCH_SERVERLESS: "OPENSEARCH_SERVERLESS";
7581
+ readonly PINECONE: "PINECONE";
7582
+ readonly RDS: "RDS";
7583
+ readonly REDIS_ENTERPRISE_CLOUD: "REDIS_ENTERPRISE_CLOUD";
7584
+ };
7585
+ /**
7586
+ * @public
7587
+ */
7588
+ export type KnowledgeBaseStorageType = (typeof KnowledgeBaseStorageType)[keyof typeof KnowledgeBaseStorageType];
7589
+ /**
7590
+ * <p>Contains the storage configuration of the knowledge base.</p>
7591
+ * @public
7592
+ */
7593
+ export interface StorageConfiguration {
6870
7594
  /**
6871
- * <p>The description of the prompt.</p>
7595
+ * <p>The vector store service in which the knowledge base is stored.</p>
6872
7596
  * @public
6873
7597
  */
6874
- description?: string;
7598
+ type: KnowledgeBaseStorageType | undefined;
6875
7599
  /**
6876
- * <p>The unique identifier of the prompt.</p>
7600
+ * <p>Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.</p>
6877
7601
  * @public
6878
7602
  */
6879
- id: string | undefined;
7603
+ opensearchServerlessConfiguration?: OpenSearchServerlessConfiguration;
6880
7604
  /**
6881
- * <p>The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).</p>
7605
+ * <p>Contains the storage configuration of the knowledge base in Pinecone.</p>
6882
7606
  * @public
6883
7607
  */
6884
- arn: string | undefined;
7608
+ pineconeConfiguration?: PineconeConfiguration;
6885
7609
  /**
6886
- * <p>The version of the prompt that this summary applies to.</p>
7610
+ * <p>Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.</p>
6887
7611
  * @public
6888
7612
  */
6889
- version: string | undefined;
7613
+ redisEnterpriseCloudConfiguration?: RedisEnterpriseCloudConfiguration;
6890
7614
  /**
6891
- * <p>The time at which the prompt was created.</p>
7615
+ * <p>Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html">Create a vector index in Amazon RDS</a>.</p>
6892
7616
  * @public
6893
7617
  */
6894
- createdAt: Date | undefined;
7618
+ rdsConfiguration?: RdsConfiguration;
6895
7619
  /**
6896
- * <p>The time at which the prompt was last updated.</p>
7620
+ * <p>Contains the storage configuration of the knowledge base in MongoDB Atlas.</p>
6897
7621
  * @public
6898
7622
  */
6899
- updatedAt: Date | undefined;
7623
+ mongoDbAtlasConfiguration?: MongoDbAtlasConfiguration;
6900
7624
  }
6901
7625
  /**
6902
7626
  * @public
6903
7627
  */
6904
- export interface ListPromptsResponse {
6905
- /**
6906
- * <p>A list, each member of which contains information about a prompt using Prompt management.</p>
6907
- * @public
6908
- */
6909
- promptSummaries: PromptSummary[] | undefined;
7628
+ export interface CreateKnowledgeBaseRequest {
6910
7629
  /**
6911
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
7630
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
7631
+ * Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
6912
7632
  * @public
6913
7633
  */
6914
- nextToken?: string;
6915
- }
6916
- /**
6917
- * @public
6918
- */
6919
- export interface UpdatePromptRequest {
7634
+ clientToken?: string;
6920
7635
  /**
6921
- * <p>A name for the prompt.</p>
7636
+ * <p>A name for the knowledge base.</p>
6922
7637
  * @public
6923
7638
  */
6924
7639
  name: string | undefined;
6925
7640
  /**
6926
- * <p>A description for the prompt.</p>
7641
+ * <p>A description of the knowledge base.</p>
6927
7642
  * @public
6928
7643
  */
6929
7644
  description?: string;
6930
7645
  /**
6931
- * <p>The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.</p>
7646
+ * <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
6932
7647
  * @public
6933
7648
  */
6934
- customerEncryptionKeyArn?: string;
7649
+ roleArn: string | undefined;
6935
7650
  /**
6936
- * <p>The name of the default variant for the prompt. This value must match the <code>name</code> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.</p>
7651
+ * <p>Contains details about the embeddings model used for the knowledge base.</p>
6937
7652
  * @public
6938
7653
  */
6939
- defaultVariant?: string;
7654
+ knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
6940
7655
  /**
6941
- * <p>A list of objects, each containing details about a variant of the prompt.</p>
7656
+ * <p>Contains details about the configuration of the vector database used for the knowledge base.</p>
6942
7657
  * @public
6943
7658
  */
6944
- variants?: PromptVariant[];
7659
+ storageConfiguration: StorageConfiguration | undefined;
6945
7660
  /**
6946
- * <p>The unique identifier of the prompt.</p>
7661
+ * <p>Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.</p>
6947
7662
  * @public
6948
7663
  */
6949
- promptIdentifier: string | undefined;
7664
+ tags?: Record<string, string>;
6950
7665
  }
6951
7666
  /**
7667
+ * @public
7668
+ * @enum
7669
+ */
7670
+ export declare const KnowledgeBaseStatus: {
7671
+ readonly ACTIVE: "ACTIVE";
7672
+ readonly CREATING: "CREATING";
7673
+ readonly DELETE_UNSUCCESSFUL: "DELETE_UNSUCCESSFUL";
7674
+ readonly DELETING: "DELETING";
7675
+ readonly FAILED: "FAILED";
7676
+ readonly UPDATING: "UPDATING";
7677
+ };
7678
+ /**
7679
+ * @public
7680
+ */
7681
+ export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof KnowledgeBaseStatus];
7682
+ /**
7683
+ * <p>Contains information about a knowledge base.</p>
6952
7684
  * @public
6953
7685
  */
6954
- export interface UpdatePromptResponse {
7686
+ export interface KnowledgeBase {
6955
7687
  /**
6956
- * <p>The name of the prompt.</p>
7688
+ * <p>The unique identifier of the knowledge base.</p>
6957
7689
  * @public
6958
7690
  */
6959
- name: string | undefined;
7691
+ knowledgeBaseId: string | undefined;
6960
7692
  /**
6961
- * <p>The description of the prompt.</p>
7693
+ * <p>The name of the knowledge base.</p>
6962
7694
  * @public
6963
7695
  */
6964
- description?: string;
7696
+ name: string | undefined;
6965
7697
  /**
6966
- * <p>The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.</p>
7698
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
6967
7699
  * @public
6968
7700
  */
6969
- customerEncryptionKeyArn?: string;
7701
+ knowledgeBaseArn: string | undefined;
6970
7702
  /**
6971
- * <p>The name of the default variant for the prompt. This value must match the <code>name</code> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.</p>
7703
+ * <p>The description of the knowledge base.</p>
6972
7704
  * @public
6973
7705
  */
6974
- defaultVariant?: string;
7706
+ description?: string;
6975
7707
  /**
6976
- * <p>A list of objects, each containing details about a variant of the prompt.</p>
7708
+ * <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
6977
7709
  * @public
6978
7710
  */
6979
- variants?: PromptVariant[];
7711
+ roleArn: string | undefined;
6980
7712
  /**
6981
- * <p>The unique identifier of the prompt.</p>
7713
+ * <p>Contains details about the embeddings configuration of the knowledge base.</p>
6982
7714
  * @public
6983
7715
  */
6984
- id: string | undefined;
7716
+ knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
6985
7717
  /**
6986
- * <p>The Amazon Resource Name (ARN) of the prompt.</p>
7718
+ * <p>Contains details about the storage configuration of the knowledge base.</p>
6987
7719
  * @public
6988
7720
  */
6989
- arn: string | undefined;
7721
+ storageConfiguration: StorageConfiguration | undefined;
6990
7722
  /**
6991
- * <p>The version of the prompt. When you update a prompt, the version updated is the <code>DRAFT</code> version.</p>
7723
+ * <p>The status of the knowledge base. The following statuses are possible:</p>
7724
+ * <ul>
7725
+ * <li>
7726
+ * <p>CREATING – The knowledge base is being created.</p>
7727
+ * </li>
7728
+ * <li>
7729
+ * <p>ACTIVE – The knowledge base is ready to be queried.</p>
7730
+ * </li>
7731
+ * <li>
7732
+ * <p>DELETING – The knowledge base is being deleted.</p>
7733
+ * </li>
7734
+ * <li>
7735
+ * <p>UPDATING – The knowledge base is being updated.</p>
7736
+ * </li>
7737
+ * <li>
7738
+ * <p>FAILED – The knowledge base API operation failed.</p>
7739
+ * </li>
7740
+ * </ul>
6992
7741
  * @public
6993
7742
  */
6994
- version: string | undefined;
7743
+ status: KnowledgeBaseStatus | undefined;
6995
7744
  /**
6996
- * <p>The time at which the prompt was created.</p>
7745
+ * <p>The time the knowledge base was created.</p>
6997
7746
  * @public
6998
7747
  */
6999
7748
  createdAt: Date | undefined;
7000
7749
  /**
7001
- * <p>The time at which the prompt was last updated.</p>
7750
+ * <p>The time the knowledge base was last updated.</p>
7002
7751
  * @public
7003
7752
  */
7004
7753
  updatedAt: Date | undefined;
7005
- }
7006
- /**
7007
- * @public
7008
- */
7009
- export interface ListTagsForResourceRequest {
7010
7754
  /**
7011
- * <p>The Amazon Resource Name (ARN) of the resource for which to list tags.</p>
7755
+ * <p>A list of reasons that the API operation on the knowledge base failed.</p>
7012
7756
  * @public
7013
7757
  */
7014
- resourceArn: string | undefined;
7758
+ failureReasons?: string[];
7015
7759
  }
7016
7760
  /**
7017
7761
  * @public
7018
7762
  */
7019
- export interface ListTagsForResourceResponse {
7763
+ export interface CreateKnowledgeBaseResponse {
7020
7764
  /**
7021
- * <p>The key-value pairs for the tags associated with the resource.</p>
7765
+ * <p>Contains details about the knowledge base.</p>
7022
7766
  * @public
7023
7767
  */
7024
- tags?: Record<string, string>;
7768
+ knowledgeBase: KnowledgeBase | undefined;
7025
7769
  }
7026
7770
  /**
7027
7771
  * @public
7028
7772
  */
7029
- export interface TagResourceRequest {
7030
- /**
7031
- * <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
7032
- * @public
7033
- */
7034
- resourceArn: string | undefined;
7773
+ export interface DeleteKnowledgeBaseRequest {
7035
7774
  /**
7036
- * <p>An object containing key-value pairs that define the tags to attach to the resource.</p>
7775
+ * <p>The unique identifier of the knowledge base to delete.</p>
7037
7776
  * @public
7038
7777
  */
7039
- tags: Record<string, string> | undefined;
7040
- }
7041
- /**
7042
- * @public
7043
- */
7044
- export interface TagResourceResponse {
7778
+ knowledgeBaseId: string | undefined;
7045
7779
  }
7046
7780
  /**
7047
7781
  * @public
7048
7782
  */
7049
- export interface UntagResourceRequest {
7783
+ export interface DeleteKnowledgeBaseResponse {
7050
7784
  /**
7051
- * <p>The Amazon Resource Name (ARN) of the resource from which to remove tags.</p>
7785
+ * <p>The unique identifier of the knowledge base that was deleted.</p>
7052
7786
  * @public
7053
7787
  */
7054
- resourceArn: string | undefined;
7788
+ knowledgeBaseId: string | undefined;
7055
7789
  /**
7056
- * <p>A list of keys of the tags to remove from the resource.</p>
7790
+ * <p>The status of the knowledge base and whether it has been successfully deleted.</p>
7057
7791
  * @public
7058
7792
  */
7059
- tagKeys: string[] | undefined;
7060
- }
7061
- /**
7062
- * @public
7063
- */
7064
- export interface UntagResourceResponse {
7793
+ status: KnowledgeBaseStatus | undefined;
7065
7794
  }
7066
7795
  /**
7067
7796
  * @public
7068
7797
  */
7069
- export interface DeleteAgentVersionRequest {
7798
+ export interface DisassociateAgentKnowledgeBaseRequest {
7070
7799
  /**
7071
- * <p>The unique identifier of the agent that the version belongs to.</p>
7800
+ * <p>The unique identifier of the agent from which to disassociate the knowledge base.</p>
7072
7801
  * @public
7073
7802
  */
7074
7803
  agentId: string | undefined;
7075
7804
  /**
7076
- * <p>The version of the agent to delete.</p>
7805
+ * <p>The version of the agent from which to disassociate the knowledge base.</p>
7077
7806
  * @public
7078
7807
  */
7079
7808
  agentVersion: string | undefined;
7080
7809
  /**
7081
- * <p>By default, this value is <code>false</code> and deletion is stopped if the resource is in use. If you set it to <code>true</code>, the resource will be deleted even if the resource is in use.</p>
7810
+ * <p>The unique identifier of the knowledge base to disassociate.</p>
7082
7811
  * @public
7083
7812
  */
7084
- skipResourceInUseCheck?: boolean;
7813
+ knowledgeBaseId: string | undefined;
7085
7814
  }
7086
7815
  /**
7087
7816
  * @public
7088
7817
  */
7089
- export interface DeleteAgentVersionResponse {
7090
- /**
7091
- * <p>The unique identifier of the agent that the version belongs to.</p>
7092
- * @public
7093
- */
7094
- agentId: string | undefined;
7095
- /**
7096
- * <p>The version that was deleted.</p>
7097
- * @public
7098
- */
7099
- agentVersion: string | undefined;
7100
- /**
7101
- * <p>The status of the agent version.</p>
7102
- * @public
7103
- */
7104
- agentStatus: AgentStatus | undefined;
7818
+ export interface DisassociateAgentKnowledgeBaseResponse {
7105
7819
  }
7106
7820
  /**
7107
7821
  * @public
7108
7822
  */
7109
- export interface GetAgentVersionRequest {
7823
+ export interface GetAgentKnowledgeBaseRequest {
7110
7824
  /**
7111
- * <p>The unique identifier of the agent.</p>
7825
+ * <p>The unique identifier of the agent with which the knowledge base is associated.</p>
7112
7826
  * @public
7113
7827
  */
7114
7828
  agentId: string | undefined;
7115
7829
  /**
7116
- * <p>The version of the agent.</p>
7830
+ * <p>The version of the agent with which the knowledge base is associated.</p>
7117
7831
  * @public
7118
7832
  */
7119
7833
  agentVersion: string | undefined;
7834
+ /**
7835
+ * <p>The unique identifier of the knowledge base associated with the agent.</p>
7836
+ * @public
7837
+ */
7838
+ knowledgeBaseId: string | undefined;
7120
7839
  }
7121
7840
  /**
7122
7841
  * @public
7123
7842
  */
7124
- export interface GetAgentVersionResponse {
7843
+ export interface GetAgentKnowledgeBaseResponse {
7125
7844
  /**
7126
- * <p>Contains details about the version of the agent.</p>
7845
+ * <p>Contains details about a knowledge base attached to an agent.</p>
7127
7846
  * @public
7128
7847
  */
7129
- agentVersion: AgentVersion | undefined;
7848
+ agentKnowledgeBase: AgentKnowledgeBase | undefined;
7130
7849
  }
7131
7850
  /**
7132
7851
  * @public
7133
7852
  */
7134
- export interface ListAgentVersionsRequest {
7135
- /**
7136
- * <p>The unique identifier of the agent.</p>
7137
- * @public
7138
- */
7139
- agentId: string | undefined;
7140
- /**
7141
- * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
7142
- * @public
7143
- */
7144
- maxResults?: number;
7853
+ export interface GetKnowledgeBaseRequest {
7145
7854
  /**
7146
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
7855
+ * <p>The unique identifier of the knowledge base you want to get information on.</p>
7147
7856
  * @public
7148
7857
  */
7149
- nextToken?: string;
7858
+ knowledgeBaseId: string | undefined;
7150
7859
  }
7151
7860
  /**
7152
7861
  * @public
7153
7862
  */
7154
- export interface ListAgentVersionsResponse {
7155
- /**
7156
- * <p>A list of objects, each of which contains information about a version of the agent.</p>
7157
- * @public
7158
- */
7159
- agentVersionSummaries: AgentVersionSummary[] | undefined;
7863
+ export interface GetKnowledgeBaseResponse {
7160
7864
  /**
7161
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
7865
+ * <p>Contains details about the knowledge base.</p>
7162
7866
  * @public
7163
7867
  */
7164
- nextToken?: string;
7868
+ knowledgeBase: KnowledgeBase | undefined;
7165
7869
  }
7166
7870
  /**
7167
7871
  * @internal
@@ -7314,100 +8018,100 @@ export declare const ConditionFlowNodeConfigurationFilterSensitiveLog: (obj: Con
7314
8018
  /**
7315
8019
  * @internal
7316
8020
  */
7317
- export declare const TextPromptTemplateConfigurationFilterSensitiveLog: (obj: TextPromptTemplateConfiguration) => any;
8021
+ export declare const ContentBlockFilterSensitiveLog: (obj: ContentBlock) => any;
7318
8022
  /**
7319
8023
  * @internal
7320
8024
  */
7321
- export declare const PromptTemplateConfigurationFilterSensitiveLog: (obj: PromptTemplateConfiguration) => any;
8025
+ export declare const MessageFilterSensitiveLog: (obj: Message) => any;
7322
8026
  /**
7323
8027
  * @internal
7324
8028
  */
7325
- export declare const PromptFlowNodeInlineConfigurationFilterSensitiveLog: (obj: PromptFlowNodeInlineConfiguration) => any;
8029
+ export declare const SystemContentBlockFilterSensitiveLog: (obj: SystemContentBlock) => any;
7326
8030
  /**
7327
8031
  * @internal
7328
8032
  */
7329
- export declare const PromptFlowNodeSourceConfigurationFilterSensitiveLog: (obj: PromptFlowNodeSourceConfiguration) => any;
8033
+ export declare const ToolChoiceFilterSensitiveLog: (obj: ToolChoice) => any;
7330
8034
  /**
7331
8035
  * @internal
7332
8036
  */
7333
- export declare const PromptFlowNodeConfigurationFilterSensitiveLog: (obj: PromptFlowNodeConfiguration) => any;
8037
+ export declare const ToolConfigurationFilterSensitiveLog: (obj: ToolConfiguration) => any;
7334
8038
  /**
7335
8039
  * @internal
7336
8040
  */
7337
- export declare const FlowNodeConfigurationFilterSensitiveLog: (obj: FlowNodeConfiguration) => any;
8041
+ export declare const ChatPromptTemplateConfigurationFilterSensitiveLog: (obj: ChatPromptTemplateConfiguration) => any;
7338
8042
  /**
7339
8043
  * @internal
7340
8044
  */
7341
- export declare const FlowNodeInputFilterSensitiveLog: (obj: FlowNodeInput) => any;
8045
+ export declare const TextPromptTemplateConfigurationFilterSensitiveLog: (obj: TextPromptTemplateConfiguration) => any;
7342
8046
  /**
7343
8047
  * @internal
7344
8048
  */
7345
- export declare const FlowNodeFilterSensitiveLog: (obj: FlowNode) => any;
8049
+ export declare const PromptTemplateConfigurationFilterSensitiveLog: (obj: PromptTemplateConfiguration) => any;
7346
8050
  /**
7347
8051
  * @internal
7348
8052
  */
7349
- export declare const FlowDefinitionFilterSensitiveLog: (obj: FlowDefinition) => any;
8053
+ export declare const PromptFlowNodeInlineConfigurationFilterSensitiveLog: (obj: PromptFlowNodeInlineConfiguration) => any;
7350
8054
  /**
7351
8055
  * @internal
7352
8056
  */
7353
- export declare const CreateFlowRequestFilterSensitiveLog: (obj: CreateFlowRequest) => any;
8057
+ export declare const PromptFlowNodeSourceConfigurationFilterSensitiveLog: (obj: PromptFlowNodeSourceConfiguration) => any;
7354
8058
  /**
7355
8059
  * @internal
7356
8060
  */
7357
- export declare const CreateFlowResponseFilterSensitiveLog: (obj: CreateFlowResponse) => any;
8061
+ export declare const PromptFlowNodeConfigurationFilterSensitiveLog: (obj: PromptFlowNodeConfiguration) => any;
7358
8062
  /**
7359
8063
  * @internal
7360
8064
  */
7361
- export declare const CreateFlowVersionResponseFilterSensitiveLog: (obj: CreateFlowVersionResponse) => any;
8065
+ export declare const FlowNodeConfigurationFilterSensitiveLog: (obj: FlowNodeConfiguration) => any;
7362
8066
  /**
7363
8067
  * @internal
7364
8068
  */
7365
- export declare const GetFlowVersionResponseFilterSensitiveLog: (obj: GetFlowVersionResponse) => any;
8069
+ export declare const FlowNodeInputFilterSensitiveLog: (obj: FlowNodeInput) => any;
7366
8070
  /**
7367
8071
  * @internal
7368
8072
  */
7369
- export declare const GetFlowResponseFilterSensitiveLog: (obj: GetFlowResponse) => any;
8073
+ export declare const FlowNodeFilterSensitiveLog: (obj: FlowNode) => any;
7370
8074
  /**
7371
8075
  * @internal
7372
8076
  */
7373
- export declare const UpdateFlowRequestFilterSensitiveLog: (obj: UpdateFlowRequest) => any;
8077
+ export declare const FlowDefinitionFilterSensitiveLog: (obj: FlowDefinition) => any;
7374
8078
  /**
7375
8079
  * @internal
7376
8080
  */
7377
- export declare const UpdateFlowResponseFilterSensitiveLog: (obj: UpdateFlowResponse) => any;
8081
+ export declare const CreateFlowRequestFilterSensitiveLog: (obj: CreateFlowRequest) => any;
7378
8082
  /**
7379
8083
  * @internal
7380
8084
  */
7381
- export declare const PromptMetadataEntryFilterSensitiveLog: (obj: PromptMetadataEntry) => any;
8085
+ export declare const CreateFlowResponseFilterSensitiveLog: (obj: CreateFlowResponse) => any;
7382
8086
  /**
7383
8087
  * @internal
7384
8088
  */
7385
- export declare const PromptVariantFilterSensitiveLog: (obj: PromptVariant) => any;
8089
+ export declare const CreateFlowVersionResponseFilterSensitiveLog: (obj: CreateFlowVersionResponse) => any;
7386
8090
  /**
7387
8091
  * @internal
7388
8092
  */
7389
- export declare const CreatePromptRequestFilterSensitiveLog: (obj: CreatePromptRequest) => any;
8093
+ export declare const GetFlowVersionResponseFilterSensitiveLog: (obj: GetFlowVersionResponse) => any;
7390
8094
  /**
7391
8095
  * @internal
7392
8096
  */
7393
- export declare const CreatePromptResponseFilterSensitiveLog: (obj: CreatePromptResponse) => any;
8097
+ export declare const DuplicateConditionExpressionFlowValidationDetailsFilterSensitiveLog: (obj: DuplicateConditionExpressionFlowValidationDetails) => any;
7394
8098
  /**
7395
8099
  * @internal
7396
8100
  */
7397
- export declare const CreatePromptVersionResponseFilterSensitiveLog: (obj: CreatePromptVersionResponse) => any;
8101
+ export declare const FlowValidationDetailsFilterSensitiveLog: (obj: FlowValidationDetails) => any;
7398
8102
  /**
7399
8103
  * @internal
7400
8104
  */
7401
- export declare const GetPromptResponseFilterSensitiveLog: (obj: GetPromptResponse) => any;
8105
+ export declare const FlowValidationFilterSensitiveLog: (obj: FlowValidation) => any;
7402
8106
  /**
7403
8107
  * @internal
7404
8108
  */
7405
- export declare const UpdatePromptRequestFilterSensitiveLog: (obj: UpdatePromptRequest) => any;
8109
+ export declare const GetFlowResponseFilterSensitiveLog: (obj: GetFlowResponse) => any;
7406
8110
  /**
7407
8111
  * @internal
7408
8112
  */
7409
- export declare const UpdatePromptResponseFilterSensitiveLog: (obj: UpdatePromptResponse) => any;
8113
+ export declare const UpdateFlowRequestFilterSensitiveLog: (obj: UpdateFlowRequest) => any;
7410
8114
  /**
7411
8115
  * @internal
7412
8116
  */
7413
- export declare const GetAgentVersionResponseFilterSensitiveLog: (obj: GetAgentVersionResponse) => any;
8117
+ export declare const UpdateFlowResponseFilterSensitiveLog: (obj: UpdateFlowResponse) => any;