Class: Aws::QConnect::Types::OrchestrationAIAgentConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb

Overview

The configuration for AI Agents of type ORCHESTRATION.

See Also:

Constant Summary collapse

SENSITIVE = 
[:input_schemas, :output_schemas]

Instance Attribute Summary collapse

Instance Attribute Details

#connect_instance_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.

Returns:

  • (String) 


8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8474

class OrchestrationAIAgentConfiguration < Struct.new(
  :orchestration_ai_prompt_id,
  :orchestration_ai_guardrail_id,
  :tool_configurations,
  :multi_agent_configurations,
  :connect_instance_arn,
  :locale,
  :input_schemas,
  :output_schemas)
  SENSITIVE = [:input_schemas, :output_schemas]
  include Aws::Structure
end

#input_schemas ⇒ Array<Hash,Array,String,Numeric,Boolean>

The JSON schemas that define the structure of the structured data input accepted by the Orchestration AI Agent. The data in a DATA message sent to the agent is validated against these schemas. You can specify at most one schema.

Returns:

  • (Array<Hash,Array,String,Numeric,Boolean>) 


8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8474

class OrchestrationAIAgentConfiguration < Struct.new(
  :orchestration_ai_prompt_id,
  :orchestration_ai_guardrail_id,
  :tool_configurations,
  :multi_agent_configurations,
  :connect_instance_arn,
  :locale,
  :input_schemas,
  :output_schemas)
  SENSITIVE = [:input_schemas, :output_schemas]
  include Aws::Structure
end

#locale ⇒ String

The locale setting for the Orchestration AI Agent.

Returns:

  • (String) 


8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8474

class OrchestrationAIAgentConfiguration < Struct.new(
  :orchestration_ai_prompt_id,
  :orchestration_ai_guardrail_id,
  :tool_configurations,
  :multi_agent_configurations,
  :connect_instance_arn,
  :locale,
  :input_schemas,
  :output_schemas)
  SENSITIVE = [:input_schemas, :output_schemas]
  include Aws::Structure
end

#multi_agent_configurations ⇒ Array<Types::MultiAgentConfiguration>

The collaborator agents that the Orchestration AI Agent can work with. Each entry defines another agent that the orchestrator either delegates to or hands the conversation off to.

Returns:



8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8474

class OrchestrationAIAgentConfiguration < Struct.new(
  :orchestration_ai_prompt_id,
  :orchestration_ai_guardrail_id,
  :tool_configurations,
  :multi_agent_configurations,
  :connect_instance_arn,
  :locale,
  :input_schemas,
  :output_schemas)
  SENSITIVE = [:input_schemas, :output_schemas]
  include Aws::Structure
end

#orchestration_ai_guardrail_id ⇒ String

The AI Guardrail identifier used by the Orchestration AI Agent.

Returns:

  • (String) 


8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8474

class OrchestrationAIAgentConfiguration < Struct.new(
  :orchestration_ai_prompt_id,
  :orchestration_ai_guardrail_id,
  :tool_configurations,
  :multi_agent_configurations,
  :connect_instance_arn,
  :locale,
  :input_schemas,
  :output_schemas)
  SENSITIVE = [:input_schemas, :output_schemas]
  include Aws::Structure
end

#orchestration_ai_prompt_id ⇒ String

The AI Prompt identifier used by the Orchestration AI Agent.

Returns:

  • (String) 


8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8474

class OrchestrationAIAgentConfiguration < Struct.new(
  :orchestration_ai_prompt_id,
  :orchestration_ai_guardrail_id,
  :tool_configurations,
  :multi_agent_configurations,
  :connect_instance_arn,
  :locale,
  :input_schemas,
  :output_schemas)
  SENSITIVE = [:input_schemas, :output_schemas]
  include Aws::Structure
end

#output_schemas ⇒ Array<Hash,Array,String,Numeric,Boolean>

The JSON schemas that define the structure of the structured output generated by the Orchestration AI Agent. You can specify at most one schema.

Returns:

  • (Array<Hash,Array,String,Numeric,Boolean>) 


8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8474

class OrchestrationAIAgentConfiguration < Struct.new(
  :orchestration_ai_prompt_id,
  :orchestration_ai_guardrail_id,
  :tool_configurations,
  :multi_agent_configurations,
  :connect_instance_arn,
  :locale,
  :input_schemas,
  :output_schemas)
  SENSITIVE = [:input_schemas, :output_schemas]
  include Aws::Structure
end

#tool_configurations ⇒ Array<Types::ToolConfiguration>

The tool configurations used by the Orchestration AI Agent.

Returns:



8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8474

class OrchestrationAIAgentConfiguration < Struct.new(
  :orchestration_ai_prompt_id,
  :orchestration_ai_guardrail_id,
  :tool_configurations,
  :multi_agent_configurations,
  :connect_instance_arn,
  :locale,
  :input_schemas,
  :output_schemas)
  SENSITIVE = [:input_schemas, :output_schemas]
  include Aws::Structure
end