interface OrchestrationAIAgentConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.Wisdom.CfnAIAgent.OrchestrationAIAgentConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awswisdom#CfnAIAgent_OrchestrationAIAgentConfigurationProperty
Java	software.amazon.awscdk.services.wisdom.CfnAIAgent.OrchestrationAIAgentConfigurationProperty
Python	aws_cdk.aws_wisdom.CfnAIAgent.OrchestrationAIAgentConfigurationProperty
TypeScript	aws-cdk-lib » aws_wisdom » CfnAIAgent » OrchestrationAIAgentConfigurationProperty

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orchestrationaiagentconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wisdom as wisdom } from 'aws-cdk-lib';

declare const annotations: any;
declare const inputSchema: any;
declare const outputSchema: any;
const orchestrationAIAgentConfigurationProperty: wisdom.CfnAIAgent.OrchestrationAIAgentConfigurationProperty = {
  orchestrationAiPromptId: 'orchestrationAiPromptId',

  // the properties below are optional
  connectInstanceArn: 'connectInstanceArn',
  locale: 'locale',
  orchestrationAiGuardrailId: 'orchestrationAiGuardrailId',
  toolConfigurations: [{
    toolName: 'toolName',
    toolType: 'toolType',

    // the properties below are optional
    annotations: annotations,
    description: 'description',
    inputSchema: inputSchema,
    instruction: {
      examples: ['examples'],
      instruction: 'instruction',
    },
    outputFilters: [{
      jsonPath: 'jsonPath',

      // the properties below are optional
      outputConfiguration: {
        outputVariableNameOverride: 'outputVariableNameOverride',
        sessionDataNamespace: 'sessionDataNamespace',
      },
    }],
    outputSchema: outputSchema,
    overrideInputValues: [{
      jsonPath: 'jsonPath',
      value: {
        constant: {
          type: 'type',
          value: 'value',
        },
      },
    }],
    title: 'title',
    toolId: 'toolId',
    userInteractionConfiguration: {
      isUserConfirmationRequired: false,
    },
  }],
};

Properties

Name	Type	Description
orchestrationAiPromptId	string
connectInstanceArn?	string
locale?	string
orchestrationAiGuardrailId?	string
toolConfigurations?	IResolvable | (IResolvable | ToolConfigurationProperty)[]

---

orchestrationAiPromptId

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orchestrationaiagentconfiguration.html#cfn-wisdom-aiagent-orchestrationaiagentconfiguration-orchestrationaipromptid

---

connectInstanceArn?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orchestrationaiagentconfiguration.html#cfn-wisdom-aiagent-orchestrationaiagentconfiguration-connectinstancearn

---

locale?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orchestrationaiagentconfiguration.html#cfn-wisdom-aiagent-orchestrationaiagentconfiguration-locale

---

orchestrationAiGuardrailId?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orchestrationaiagentconfiguration.html#cfn-wisdom-aiagent-orchestrationaiagentconfiguration-orchestrationaiguardrailid

---

toolConfigurations?

Type: IResolvable | (IResolvable | ToolConfigurationProperty)[] (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orchestrationaiagentconfiguration.html#cfn-wisdom-aiagent-orchestrationaiagentconfiguration-toolconfigurations