Module: Aws::BedrockAgent::Types

Defined in:

lib/aws-sdk-bedrockagent/types.rb

Defined Under Namespace

Classes: APISchema, AccessDeniedException, ActionGroupExecutor, ActionGroupSummary, Agent, AgentActionGroup, AgentAlias, AgentAliasHistoryEvent, AgentAliasRoutingConfigurationListItem, AgentAliasSummary, AgentFlowNodeConfiguration, AgentKnowledgeBase, AgentKnowledgeBaseSummary, AgentSummary, AgentVersion, AgentVersionSummary, AssociateAgentKnowledgeBaseRequest, AssociateAgentKnowledgeBaseResponse, BedrockEmbeddingModelConfiguration, BedrockFoundationModelConfiguration, ChunkingConfiguration, CollectorFlowNodeConfiguration, ConditionFlowNodeConfiguration, ConflictException, ConfluenceCrawlerConfiguration, ConfluenceDataSourceConfiguration, ConfluenceSourceConfiguration, CrawlFilterConfiguration, CreateAgentActionGroupRequest, CreateAgentActionGroupResponse, CreateAgentAliasRequest, CreateAgentAliasResponse, CreateAgentRequest, CreateAgentResponse, CreateDataSourceRequest, CreateDataSourceResponse, CreateFlowAliasRequest, CreateFlowAliasResponse, CreateFlowRequest, CreateFlowResponse, CreateFlowVersionRequest, CreateFlowVersionResponse, CreateKnowledgeBaseRequest, CreateKnowledgeBaseResponse, CreatePromptRequest, CreatePromptResponse, CreatePromptVersionRequest, CreatePromptVersionResponse, CustomTransformationConfiguration, DataSource, DataSourceConfiguration, DataSourceSummary, DeleteAgentActionGroupRequest, DeleteAgentActionGroupResponse, DeleteAgentAliasRequest, DeleteAgentAliasResponse, DeleteAgentRequest, DeleteAgentResponse, DeleteAgentVersionRequest, DeleteAgentVersionResponse, DeleteDataSourceRequest, DeleteDataSourceResponse, DeleteFlowAliasRequest, DeleteFlowAliasResponse, DeleteFlowRequest, DeleteFlowResponse, DeleteFlowVersionRequest, DeleteFlowVersionResponse, DeleteKnowledgeBaseRequest, DeleteKnowledgeBaseResponse, DeletePromptRequest, DeletePromptResponse, DisassociateAgentKnowledgeBaseRequest, DisassociateAgentKnowledgeBaseResponse, EmbeddingModelConfiguration, FixedSizeChunkingConfiguration, FlowAliasRoutingConfigurationListItem, FlowAliasSummary, FlowCondition, FlowConditionalConnectionConfiguration, FlowConnection, FlowConnectionConfiguration, FlowDataConnectionConfiguration, FlowDefinition, FlowNode, FlowNodeConfiguration, FlowNodeInput, FlowNodeOutput, FlowSummary, FlowValidation, FlowVersionSummary, Function, FunctionSchema, GetAgentActionGroupRequest, GetAgentActionGroupResponse, GetAgentAliasRequest, GetAgentAliasResponse, GetAgentKnowledgeBaseRequest, GetAgentKnowledgeBaseResponse, GetAgentRequest, GetAgentResponse, GetAgentVersionRequest, GetAgentVersionResponse, GetDataSourceRequest, GetDataSourceResponse, GetFlowAliasRequest, GetFlowAliasResponse, GetFlowRequest, GetFlowResponse, GetFlowVersionRequest, GetFlowVersionResponse, GetIngestionJobRequest, GetIngestionJobResponse, GetKnowledgeBaseRequest, GetKnowledgeBaseResponse, GetPromptRequest, GetPromptResponse, GuardrailConfiguration, HierarchicalChunkingConfiguration, HierarchicalChunkingLevelConfiguration, InferenceConfiguration, IngestionJob, IngestionJobFilter, IngestionJobSortBy, IngestionJobStatistics, IngestionJobSummary, InputFlowNodeConfiguration, IntermediateStorage, InternalServerException, IteratorFlowNodeConfiguration, KnowledgeBase, KnowledgeBaseConfiguration, KnowledgeBaseFlowNodeConfiguration, KnowledgeBaseSummary, LambdaFunctionFlowNodeConfiguration, LexFlowNodeConfiguration, ListAgentActionGroupsRequest, ListAgentActionGroupsResponse, ListAgentAliasesRequest, ListAgentAliasesResponse, ListAgentKnowledgeBasesRequest, ListAgentKnowledgeBasesResponse, ListAgentVersionsRequest, ListAgentVersionsResponse, ListAgentsRequest, ListAgentsResponse, ListDataSourcesRequest, ListDataSourcesResponse, ListFlowAliasesRequest, ListFlowAliasesResponse, ListFlowVersionsRequest, ListFlowVersionsResponse, ListFlowsRequest, ListFlowsResponse, ListIngestionJobsRequest, ListIngestionJobsResponse, ListKnowledgeBasesRequest, ListKnowledgeBasesResponse, ListPromptsRequest, ListPromptsResponse, ListTagsForResourceRequest, ListTagsForResourceResponse, MemoryConfiguration, MongoDbAtlasConfiguration, MongoDbAtlasFieldMapping, OpenSearchServerlessConfiguration, OpenSearchServerlessFieldMapping, OutputFlowNodeConfiguration, ParameterDetail, ParsingConfiguration, ParsingPrompt, PatternObjectFilter, PatternObjectFilterConfiguration, PineconeConfiguration, PineconeFieldMapping, PrepareAgentRequest, PrepareAgentResponse, PrepareFlowRequest, PrepareFlowResponse, PromptConfiguration, PromptFlowNodeConfiguration, PromptFlowNodeInlineConfiguration, PromptFlowNodeResourceConfiguration, PromptFlowNodeSourceConfiguration, PromptInferenceConfiguration, PromptInputVariable, PromptMetadataEntry, PromptModelInferenceConfiguration, PromptOverrideConfiguration, PromptSummary, PromptTemplateConfiguration, PromptVariant, RdsConfiguration, RdsFieldMapping, RedisEnterpriseCloudConfiguration, RedisEnterpriseCloudFieldMapping, ResourceNotFoundException, RetrievalFlowNodeConfiguration, RetrievalFlowNodeS3Configuration, RetrievalFlowNodeServiceConfiguration, S3DataSourceConfiguration, S3Identifier, S3Location, SalesforceCrawlerConfiguration, SalesforceDataSourceConfiguration, SalesforceSourceConfiguration, SeedUrl, SemanticChunkingConfiguration, ServerSideEncryptionConfiguration, ServiceQuotaExceededException, SharePointCrawlerConfiguration, SharePointDataSourceConfiguration, SharePointSourceConfiguration, StartIngestionJobRequest, StartIngestionJobResponse, StorageConfiguration, StorageFlowNodeConfiguration, StorageFlowNodeS3Configuration, StorageFlowNodeServiceConfiguration, TagResourceRequest, TagResourceResponse, TextPromptTemplateConfiguration, ThrottlingException, Transformation, TransformationFunction, TransformationLambdaConfiguration, UntagResourceRequest, UntagResourceResponse, UpdateAgentActionGroupRequest, UpdateAgentActionGroupResponse, UpdateAgentAliasRequest, UpdateAgentAliasResponse, UpdateAgentKnowledgeBaseRequest, UpdateAgentKnowledgeBaseResponse, UpdateAgentRequest, UpdateAgentResponse, UpdateDataSourceRequest, UpdateDataSourceResponse, UpdateFlowAliasRequest, UpdateFlowAliasResponse, UpdateFlowRequest, UpdateFlowResponse, UpdateKnowledgeBaseRequest, UpdateKnowledgeBaseResponse, UpdatePromptRequest, UpdatePromptResponse, UrlConfiguration, ValidationException, ValidationExceptionField, VectorIngestionConfiguration, VectorKnowledgeBaseConfiguration, WebCrawlerConfiguration, WebCrawlerLimits, WebDataSourceConfiguration, WebSourceConfiguration

Instance Attribute Summary

• #agent ⇒ Types::AgentFlowNodeConfiguration

  Contains configurations for an agent node in your flow.

• #collector ⇒ Types::CollectorFlowNodeConfiguration

  Contains configurations for a collector node in your flow.

• #condition ⇒ Types::ConditionFlowNodeConfiguration

  Contains configurations for a Condition node in your flow.

• #conditional ⇒ Types::FlowConditionalConnectionConfiguration

  The configuration of a connection originating from a Condition node.

• #custom_control ⇒ String

  To return the action group invocation results directly in the ‘InvokeAgent` response, specify `RETURN_CONTROL`.

• #data ⇒ Types::FlowDataConnectionConfiguration

  The configuration of a connection originating from a node that isn’t a Condition node.

• #functions ⇒ Array<Types::Function>

  A list of functions that each define an action in the action group.

• #inline ⇒ Types::PromptFlowNodeInlineConfiguration

  Contains configurations for a prompt that is defined inline.

• #input ⇒ Types::InputFlowNodeConfiguration

  Contains configurations for an input flow node in your flow.

• #iterator ⇒ Types::IteratorFlowNodeConfiguration

  Contains configurations for an iterator node in your flow.

• #knowledge_base ⇒ Types::KnowledgeBaseFlowNodeConfiguration

  Contains configurations for a knowledge base node in your flow.

• #lambda ⇒ String

  The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

• #lambda_function ⇒ Types::LambdaFunctionFlowNodeConfiguration

  Contains configurations for a Lambda function node in your flow.

• #lex ⇒ Types::LexFlowNodeConfiguration

  Contains configurations for a Lex node in your flow.

• #output ⇒ Types::OutputFlowNodeConfiguration

  Contains configurations for an output flow node in your flow.

• #payload ⇒ String

  The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.

• #prompt ⇒ Types::PromptFlowNodeConfiguration

  Contains configurations for a prompt node in your flow.

• #resource ⇒ Types::PromptFlowNodeResourceConfiguration

  Contains configurations for a prompt from Prompt management.

• #retrieval ⇒ Types::RetrievalFlowNodeConfiguration

  Contains configurations for a Retrieval node in your flow.

• #s3 ⇒ Types::StorageFlowNodeS3Configuration

  Contains configurations for the Amazon S3 location in which to store the input into the node.

• #storage ⇒ Types::StorageFlowNodeConfiguration

  Contains configurations for a Storage node in your flow.

• #text ⇒ Types::TextPromptTemplateConfiguration

  Contains configurations for the text in a message for a prompt.

Instance Attribute Details

#agent ⇒ Types::AgentFlowNodeConfiguration

Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.

Returns:

• (Types::AgentFlowNodeConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3188

class FlowNodeConfiguration < Struct.new(
  :agent,
  :collector,
  :condition,
  :input,
  :iterator,
  :knowledge_base,
  :lambda_function,
  :lex,
  :output,
  :prompt,
  :retrieval,
  :storage,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Agent < FlowNodeConfiguration; end
  class Collector < FlowNodeConfiguration; end
  class Condition < FlowNodeConfiguration; end
  class Input < FlowNodeConfiguration; end
  class Iterator < FlowNodeConfiguration; end
  class KnowledgeBase < FlowNodeConfiguration; end
  class LambdaFunction < FlowNodeConfiguration; end
  class Lex < FlowNodeConfiguration; end
  class Output < FlowNodeConfiguration; end
  class Prompt < FlowNodeConfiguration; end
  class Retrieval < FlowNodeConfiguration; end
  class Storage < FlowNodeConfiguration; end
  class Unknown < FlowNodeConfiguration; end
end

#collector ⇒ Types::CollectorFlowNodeConfiguration

Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.

Returns:

• (Types::CollectorFlowNodeConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3188

class FlowNodeConfiguration < Struct.new(
  :agent,
  :collector,
  :condition,
  :input,
  :iterator,
  :knowledge_base,
  :lambda_function,
  :lex,
  :output,
  :prompt,
  :retrieval,
  :storage,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Agent < FlowNodeConfiguration; end
  class Collector < FlowNodeConfiguration; end
  class Condition < FlowNodeConfiguration; end
  class Input < FlowNodeConfiguration; end
  class Iterator < FlowNodeConfiguration; end
  class KnowledgeBase < FlowNodeConfiguration; end
  class LambdaFunction < FlowNodeConfiguration; end
  class Lex < FlowNodeConfiguration; end
  class Output < FlowNodeConfiguration; end
  class Prompt < FlowNodeConfiguration; end
  class Retrieval < FlowNodeConfiguration; end
  class Storage < FlowNodeConfiguration; end
  class Unknown < FlowNodeConfiguration; end
end

#condition ⇒ Types::ConditionFlowNodeConfiguration

Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.

Returns:

• (Types::ConditionFlowNodeConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3188

class FlowNodeConfiguration < Struct.new(
  :agent,
  :collector,
  :condition,
  :input,
  :iterator,
  :knowledge_base,
  :lambda_function,
  :lex,
  :output,
  :prompt,
  :retrieval,
  :storage,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Agent < FlowNodeConfiguration; end
  class Collector < FlowNodeConfiguration; end
  class Condition < FlowNodeConfiguration; end
  class Input < FlowNodeConfiguration; end
  class Iterator < FlowNodeConfiguration; end
  class KnowledgeBase < FlowNodeConfiguration; end
  class LambdaFunction < FlowNodeConfiguration; end
  class Lex < FlowNodeConfiguration; end
  class Output < FlowNodeConfiguration; end
  class Prompt < FlowNodeConfiguration; end
  class Retrieval < FlowNodeConfiguration; end
  class Storage < FlowNodeConfiguration; end
  class Unknown < FlowNodeConfiguration; end
end

#conditional ⇒ Types::FlowConditionalConnectionConfiguration

The configuration of a connection originating from a Condition node.

Returns:

• (Types::FlowConditionalConnectionConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3012

class FlowConnectionConfiguration < Struct.new(
  :conditional,
  :data,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Conditional < FlowConnectionConfiguration; end
  class Data < FlowConnectionConfiguration; end
  class Unknown < FlowConnectionConfiguration; end
end

#custom_control ⇒ String

To return the action group invocation results directly in the ‘InvokeAgent` response, specify `RETURN_CONTROL`.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 95

class ActionGroupExecutor < Struct.new(
  :custom_control,
  :lambda,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class CustomControl < ActionGroupExecutor; end
  class Lambda < ActionGroupExecutor; end
  class Unknown < ActionGroupExecutor; end
end

#data ⇒ Types::FlowDataConnectionConfiguration

The configuration of a connection originating from a node that isn’t a Condition node.

Returns:

• (Types::FlowDataConnectionConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3012

class FlowConnectionConfiguration < Struct.new(
  :conditional,
  :data,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Conditional < FlowConnectionConfiguration; end
  class Data < FlowConnectionConfiguration; end
  class Unknown < FlowConnectionConfiguration; end
end

#functions ⇒ Array<Types::Function>

A list of functions that each define an action in the action group.

Returns:

• (Array<Types::Function>)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3503

class FunctionSchema < Struct.new(
  :functions,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Functions < FunctionSchema; end
  class Unknown < FunctionSchema; end
end

#inline ⇒ Types::PromptFlowNodeInlineConfiguration

Contains configurations for a prompt that is defined inline

Returns:

• (Types::PromptFlowNodeInlineConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 5958

class PromptFlowNodeSourceConfiguration < Struct.new(
  :inline,
  :resource,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Inline < PromptFlowNodeSourceConfiguration; end
  class Resource < PromptFlowNodeSourceConfiguration; end
  class Unknown < PromptFlowNodeSourceConfiguration; end
end

#input ⇒ Types::InputFlowNodeConfiguration

Contains configurations for an input flow node in your flow. The first node in the flow. ‘inputs` can’t be specified for this node.

Returns:

• (Types::InputFlowNodeConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3188

class FlowNodeConfiguration < Struct.new(
  :agent,
  :collector,
  :condition,
  :input,
  :iterator,
  :knowledge_base,
  :lambda_function,
  :lex,
  :output,
  :prompt,
  :retrieval,
  :storage,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Agent < FlowNodeConfiguration; end
  class Collector < FlowNodeConfiguration; end
  class Condition < FlowNodeConfiguration; end
  class Input < FlowNodeConfiguration; end
  class Iterator < FlowNodeConfiguration; end
  class KnowledgeBase < FlowNodeConfiguration; end
  class LambdaFunction < FlowNodeConfiguration; end
  class Lex < FlowNodeConfiguration; end
  class Output < FlowNodeConfiguration; end
  class Prompt < FlowNodeConfiguration; end
  class Retrieval < FlowNodeConfiguration; end
  class Storage < FlowNodeConfiguration; end
  class Unknown < FlowNodeConfiguration; end
end

#iterator ⇒ Types::IteratorFlowNodeConfiguration

Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.

The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.

Returns:

• (Types::IteratorFlowNodeConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3188

class FlowNodeConfiguration < Struct.new(
  :agent,
  :collector,
  :condition,
  :input,
  :iterator,
  :knowledge_base,
  :lambda_function,
  :lex,
  :output,
  :prompt,
  :retrieval,
  :storage,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Agent < FlowNodeConfiguration; end
  class Collector < FlowNodeConfiguration; end
  class Condition < FlowNodeConfiguration; end
  class Input < FlowNodeConfiguration; end
  class Iterator < FlowNodeConfiguration; end
  class KnowledgeBase < FlowNodeConfiguration; end
  class LambdaFunction < FlowNodeConfiguration; end
  class Lex < FlowNodeConfiguration; end
  class Output < FlowNodeConfiguration; end
  class Prompt < FlowNodeConfiguration; end
  class Retrieval < FlowNodeConfiguration; end
  class Storage < FlowNodeConfiguration; end
  class Unknown < FlowNodeConfiguration; end
end

#knowledge_base ⇒ Types::KnowledgeBaseFlowNodeConfiguration

Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.

Returns:

• (Types::KnowledgeBaseFlowNodeConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3188

class FlowNodeConfiguration < Struct.new(
  :agent,
  :collector,
  :condition,
  :input,
  :iterator,
  :knowledge_base,
  :lambda_function,
  :lex,
  :output,
  :prompt,
  :retrieval,
  :storage,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Agent < FlowNodeConfiguration; end
  class Collector < FlowNodeConfiguration; end
  class Condition < FlowNodeConfiguration; end
  class Input < FlowNodeConfiguration; end
  class Iterator < FlowNodeConfiguration; end
  class KnowledgeBase < FlowNodeConfiguration; end
  class LambdaFunction < FlowNodeConfiguration; end
  class Lex < FlowNodeConfiguration; end
  class Output < FlowNodeConfiguration; end
  class Prompt < FlowNodeConfiguration; end
  class Retrieval < FlowNodeConfiguration; end
  class Storage < FlowNodeConfiguration; end
  class Unknown < FlowNodeConfiguration; end
end

#lambda ⇒ String

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 95

class ActionGroupExecutor < Struct.new(
  :custom_control,
  :lambda,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class CustomControl < ActionGroupExecutor; end
  class Lambda < ActionGroupExecutor; end
  class Unknown < ActionGroupExecutor; end
end

#lambda_function ⇒ Types::LambdaFunctionFlowNodeConfiguration

Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.

Returns:

• (Types::LambdaFunctionFlowNodeConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3188

class FlowNodeConfiguration < Struct.new(
  :agent,
  :collector,
  :condition,
  :input,
  :iterator,
  :knowledge_base,
  :lambda_function,
  :lex,
  :output,
  :prompt,
  :retrieval,
  :storage,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Agent < FlowNodeConfiguration; end
  class Collector < FlowNodeConfiguration; end
  class Condition < FlowNodeConfiguration; end
  class Input < FlowNodeConfiguration; end
  class Iterator < FlowNodeConfiguration; end
  class KnowledgeBase < FlowNodeConfiguration; end
  class LambdaFunction < FlowNodeConfiguration; end
  class Lex < FlowNodeConfiguration; end
  class Output < FlowNodeConfiguration; end
  class Prompt < FlowNodeConfiguration; end
  class Retrieval < FlowNodeConfiguration; end
  class Storage < FlowNodeConfiguration; end
  class Unknown < FlowNodeConfiguration; end
end

#lex ⇒ Types::LexFlowNodeConfiguration

Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.

Returns:

• (Types::LexFlowNodeConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3188

class FlowNodeConfiguration < Struct.new(
  :agent,
  :collector,
  :condition,
  :input,
  :iterator,
  :knowledge_base,
  :lambda_function,
  :lex,
  :output,
  :prompt,
  :retrieval,
  :storage,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Agent < FlowNodeConfiguration; end
  class Collector < FlowNodeConfiguration; end
  class Condition < FlowNodeConfiguration; end
  class Input < FlowNodeConfiguration; end
  class Iterator < FlowNodeConfiguration; end
  class KnowledgeBase < FlowNodeConfiguration; end
  class LambdaFunction < FlowNodeConfiguration; end
  class Lex < FlowNodeConfiguration; end
  class Output < FlowNodeConfiguration; end
  class Prompt < FlowNodeConfiguration; end
  class Retrieval < FlowNodeConfiguration; end
  class Storage < FlowNodeConfiguration; end
  class Unknown < FlowNodeConfiguration; end
end

#output ⇒ Types::OutputFlowNodeConfiguration

Contains configurations for an output flow node in your flow. The last node in the flow. ‘outputs` can’t be specified for this node.

Returns:

• (Types::OutputFlowNodeConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3188

class FlowNodeConfiguration < Struct.new(
  :agent,
  :collector,
  :condition,
  :input,
  :iterator,
  :knowledge_base,
  :lambda_function,
  :lex,
  :output,
  :prompt,
  :retrieval,
  :storage,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Agent < FlowNodeConfiguration; end
  class Collector < FlowNodeConfiguration; end
  class Condition < FlowNodeConfiguration; end
  class Input < FlowNodeConfiguration; end
  class Iterator < FlowNodeConfiguration; end
  class KnowledgeBase < FlowNodeConfiguration; end
  class LambdaFunction < FlowNodeConfiguration; end
  class Lex < FlowNodeConfiguration; end
  class Output < FlowNodeConfiguration; end
  class Prompt < FlowNodeConfiguration; end
  class Retrieval < FlowNodeConfiguration; end
  class Storage < FlowNodeConfiguration; end
  class Unknown < FlowNodeConfiguration; end
end

#payload ⇒ String

The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see [Action group OpenAPI schemas].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 49

class APISchema < Struct.new(
  :payload,
  :s3,
  :unknown)
  SENSITIVE = [:payload]
  include Aws::Structure
  include Aws::Structure::Union

  class Payload < APISchema; end
  class S3 < APISchema; end
  class Unknown < APISchema; end
end

#prompt ⇒ Types::PromptFlowNodeConfiguration

Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.

Returns:

• (Types::PromptFlowNodeConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3188

class FlowNodeConfiguration < Struct.new(
  :agent,
  :collector,
  :condition,
  :input,
  :iterator,
  :knowledge_base,
  :lambda_function,
  :lex,
  :output,
  :prompt,
  :retrieval,
  :storage,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Agent < FlowNodeConfiguration; end
  class Collector < FlowNodeConfiguration; end
  class Condition < FlowNodeConfiguration; end
  class Input < FlowNodeConfiguration; end
  class Iterator < FlowNodeConfiguration; end
  class KnowledgeBase < FlowNodeConfiguration; end
  class LambdaFunction < FlowNodeConfiguration; end
  class Lex < FlowNodeConfiguration; end
  class Output < FlowNodeConfiguration; end
  class Prompt < FlowNodeConfiguration; end
  class Retrieval < FlowNodeConfiguration; end
  class Storage < FlowNodeConfiguration; end
  class Unknown < FlowNodeConfiguration; end
end

#resource ⇒ Types::PromptFlowNodeResourceConfiguration

Contains configurations for a prompt from Prompt management.

Returns:

• (Types::PromptFlowNodeResourceConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 5958

class PromptFlowNodeSourceConfiguration < Struct.new(
  :inline,
  :resource,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Inline < PromptFlowNodeSourceConfiguration; end
  class Resource < PromptFlowNodeSourceConfiguration; end
  class Unknown < PromptFlowNodeSourceConfiguration; end
end

#retrieval ⇒ Types::RetrievalFlowNodeConfiguration

Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.

Returns:

• (Types::RetrievalFlowNodeConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3188

class FlowNodeConfiguration < Struct.new(
  :agent,
  :collector,
  :condition,
  :input,
  :iterator,
  :knowledge_base,
  :lambda_function,
  :lex,
  :output,
  :prompt,
  :retrieval,
  :storage,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Agent < FlowNodeConfiguration; end
  class Collector < FlowNodeConfiguration; end
  class Condition < FlowNodeConfiguration; end
  class Input < FlowNodeConfiguration; end
  class Iterator < FlowNodeConfiguration; end
  class KnowledgeBase < FlowNodeConfiguration; end
  class LambdaFunction < FlowNodeConfiguration; end
  class Lex < FlowNodeConfiguration; end
  class Output < FlowNodeConfiguration; end
  class Prompt < FlowNodeConfiguration; end
  class Retrieval < FlowNodeConfiguration; end
  class Storage < FlowNodeConfiguration; end
  class Unknown < FlowNodeConfiguration; end
end

#s3 ⇒ Types::StorageFlowNodeS3Configuration

Contains configurations for the Amazon S3 location in which to store the input into the node.

Returns:

• (Types::StorageFlowNodeS3Configuration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 49

class APISchema < Struct.new(
  :payload,
  :s3,
  :unknown)
  SENSITIVE = [:payload]
  include Aws::Structure
  include Aws::Structure::Union

  class Payload < APISchema; end
  class S3 < APISchema; end
  class Unknown < APISchema; end
end

#storage ⇒ Types::StorageFlowNodeConfiguration

Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.

Returns:

• (Types::StorageFlowNodeConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 3188

class FlowNodeConfiguration < Struct.new(
  :agent,
  :collector,
  :condition,
  :input,
  :iterator,
  :knowledge_base,
  :lambda_function,
  :lex,
  :output,
  :prompt,
  :retrieval,
  :storage,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Agent < FlowNodeConfiguration; end
  class Collector < FlowNodeConfiguration; end
  class Condition < FlowNodeConfiguration; end
  class Input < FlowNodeConfiguration; end
  class Iterator < FlowNodeConfiguration; end
  class KnowledgeBase < FlowNodeConfiguration; end
  class LambdaFunction < FlowNodeConfiguration; end
  class Lex < FlowNodeConfiguration; end
  class Output < FlowNodeConfiguration; end
  class Prompt < FlowNodeConfiguration; end
  class Retrieval < FlowNodeConfiguration; end
  class Storage < FlowNodeConfiguration; end
  class Unknown < FlowNodeConfiguration; end
end

#text ⇒ Types::TextPromptTemplateConfiguration

Contains configurations for the text in a message for a prompt.

Returns:

• (Types::TextPromptTemplateConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 5983

class PromptInferenceConfiguration < Struct.new(
  :text,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Text < PromptInferenceConfiguration; end
  class Unknown < PromptInferenceConfiguration; end
end