types

package
v1.29.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 27, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APISchema 

type APISchema interface {
	// contains filtered or unexported methods
}

Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

The following types satisfy this interface: 

APISchemaMemberPayload
APISchemaMemberS3
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.APISchema
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.APISchemaMemberPayload:
		_ = v.Value // Value is string

	case *types.APISchemaMemberS3:
		_ = v.Value // Value is types.S3Identifier

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type APISchemaMemberPayload 

type APISchemaMemberPayload struct {
	Value string
	// contains filtered or unexported fields
}

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

type APISchemaMemberS3 

type APISchemaMemberS3 struct {
	Value S3Identifier
	// contains filtered or unexported fields
}

Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request is denied because of missing access permissions.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type ActionGroupExecutor 

type ActionGroupExecutor interface {
	// contains filtered or unexported methods
}

Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

The following types satisfy this interface: 

ActionGroupExecutorMemberCustomControl
ActionGroupExecutorMemberLambda
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.ActionGroupExecutor
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ActionGroupExecutorMemberCustomControl:
		_ = v.Value // Value is types.CustomControlMethod

	case *types.ActionGroupExecutorMemberLambda:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ActionGroupExecutorMemberCustomControl added in v1.7.0 

type ActionGroupExecutorMemberCustomControl struct {
	Value CustomControlMethod
	// contains filtered or unexported fields
}

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

type ActionGroupExecutorMemberLambda 

type ActionGroupExecutorMemberLambda struct {
	Value string
	// contains filtered or unexported fields
}

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

type ActionGroupSignature 

type ActionGroupSignature string
const (
	ActionGroupSignatureAmazonUserinput       ActionGroupSignature = "AMAZON.UserInput"
	ActionGroupSignatureAmazonCodeinterpreter ActionGroupSignature = "AMAZON.CodeInterpreter"
)

Enum values for ActionGroupSignature

func (ActionGroupSignature) Values 

func (ActionGroupSignature) Values() []ActionGroupSignature

Values returns all known values for ActionGroupSignature. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ActionGroupState 

type ActionGroupState string
const (
	ActionGroupStateEnabled  ActionGroupState = "ENABLED"
	ActionGroupStateDisabled ActionGroupState = "DISABLED"
)

Enum values for ActionGroupState

func (ActionGroupState) Values 

func (ActionGroupState) Values() []ActionGroupState

Values returns all known values for ActionGroupState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ActionGroupSummary 

type ActionGroupSummary struct {

	// The unique identifier of the action group.
	//
	// This member is required.
	ActionGroupId *string

	// The name of the action group.
	//
	// This member is required.
	ActionGroupName *string

	// Specifies whether the action group is available for the agent to invoke or not
	// when sending an [InvokeAgent]request.
	//
	// [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
	//
	// This member is required.
	ActionGroupState ActionGroupState

	// The time at which the action group was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The description of the action group.
	Description *string
	// contains filtered or unexported fields
}

Contains details about an action group.

type Agent 

type Agent struct {

	// The Amazon Resource Name (ARN) of the agent.
	//
	// This member is required.
	AgentArn *string

	// The unique identifier of the agent.
	//
	// This member is required.
	AgentId *string

	// The name of the agent.
	//
	// This member is required.
	AgentName *string

	// The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API
	// operations on the agent.
	//
	// This member is required.
	AgentResourceRoleArn *string

	// The status of the agent and whether it is ready for use. The following statuses
	// are possible:
	//
	//   - CREATING – The agent is being created.
	//
	//   - PREPARING – The agent is being prepared.
	//
	//   - PREPARED – The agent is prepared and ready to be invoked.
	//
	//   - NOT_PREPARED – The agent has been created but not yet prepared.
	//
	//   - FAILED – The agent API operation failed.
	//
	//   - UPDATING – The agent is being updated.
	//
	//   - DELETING – The agent is being deleted.
	//
	// This member is required.
	AgentStatus AgentStatus

	// The version of the agent.
	//
	// This member is required.
	AgentVersion *string

	// The time at which the agent was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The number of seconds for which Amazon Bedrock keeps information about a user's
	// conversation with the agent.
	//
	// A user interaction remains active for the amount of time specified. If no
	// conversation occurs during this time, the session expires and Amazon Bedrock
	// deletes any data provided before the timeout.
	//
	// This member is required.
	IdleSessionTTLInSeconds *int32

	// The time at which the agent was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// A unique, case-sensitive identifier to ensure that the API request completes no
	// more than one time. If this token matches a previous request, Amazon Bedrock
	// ignores the request, but does not return an error. For more information, see [Ensuring idempotency].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientToken *string

	//  Contains custom orchestration configurations for the agent.
	CustomOrchestration *CustomOrchestration

	// The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
	CustomerEncryptionKeyArn *string

	// The description of the agent.
	Description *string

	// Contains reasons that the agent-related API that you invoked failed.
	FailureReasons []string

	// The foundation model used for orchestration by the agent.
	FoundationModel *string

	// Details about the guardrail associated with the agent.
	GuardrailConfiguration *GuardrailConfiguration

	// Instructions that tell the agent what it should do and how it should interact
	// with users.
	Instruction *string

	// Contains memory configuration for the agent.
	MemoryConfiguration *MemoryConfiguration

	//  Specifies the orchestration strategy for the agent.
	OrchestrationType OrchestrationType

	// The time at which the agent was last prepared.
	PreparedAt *time.Time

	// Contains configurations to override prompt templates in different parts of an
	// agent sequence. For more information, see [Advanced prompts].
	//
	// [Advanced prompts]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
	PromptOverrideConfiguration *PromptOverrideConfiguration

	// Contains recommended actions to take for the agent-related API that you invoked
	// to succeed.
	RecommendedActions []string
	// contains filtered or unexported fields
}

Contains details about an agent.

type AgentActionGroup 

type AgentActionGroup struct {

	// The unique identifier of the action group.
	//
	// This member is required.
	ActionGroupId *string

	// The name of the action group.
	//
	// This member is required.
	ActionGroupName *string

	// Specifies whether the action group is available for the agent to invoke or not
	// when sending an [InvokeAgent]request.
	//
	// [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
	//
	// This member is required.
	ActionGroupState ActionGroupState

	// The unique identifier of the agent to which the action group belongs.
	//
	// This member is required.
	AgentId *string

	// The version of the agent to which the action group belongs.
	//
	// This member is required.
	AgentVersion *string

	// The time at which the action group was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The time at which the action group was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The Amazon Resource Name (ARN) of the Lambda function containing the business
	// logic that is carried out upon invoking the action or the custom control method
	// for handling the information elicited from the user.
	ActionGroupExecutor ActionGroupExecutor

	// Contains either details about the S3 object containing the OpenAPI schema for
	// the action group or the JSON or YAML-formatted payload defining the schema. For
	// more information, see [Action group OpenAPI schemas].
	//
	// [Action group OpenAPI schemas]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html
	ApiSchema APISchema

	// A unique, case-sensitive identifier to ensure that the API request completes no
	// more than one time. If this token matches a previous request, Amazon Bedrock
	// ignores the request, but does not return an error. For more information, see [Ensuring idempotency].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientToken *string

	// The description of the action group.
	Description *string

	// Defines functions that each define parameters that the agent needs to invoke
	// from the user. Each function represents an action in an action group.
	FunctionSchema FunctionSchema

	// If this field is set as AMAZON.UserInput , the agent can request the user for
	// additional information when trying to complete a task. The description ,
	// apiSchema , and actionGroupExecutor fields must be blank for this action group.
	//
	// During orchestration, if the agent determines that it needs to invoke an API in
	// an action group, but doesn't have enough information to complete the API
	// request, it will invoke this action group instead and return an [Observation]reprompting the
	// user for more information.
	//
	// [Observation]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html
	ParentActionSignature ActionGroupSignature
	// contains filtered or unexported fields
}

Contains details about an action group.

type AgentAlias 

type AgentAlias struct {

	// The Amazon Resource Name (ARN) of the alias of the agent.
	//
	// This member is required.
	AgentAliasArn *string

	// The unique identifier of the alias of the agent.
	//
	// This member is required.
	AgentAliasId *string

	// The name of the alias of the agent.
	//
	// This member is required.
	AgentAliasName *string

	// The status of the alias of the agent and whether it is ready for use. The
	// following statuses are possible:
	//
	//   - CREATING – The agent alias is being created.
	//
	//   - PREPARED – The agent alias is finished being created or updated and is
	//   ready to be invoked.
	//
	//   - FAILED – The agent alias API operation failed.
	//
	//   - UPDATING – The agent alias is being updated.
	//
	//   - DELETING – The agent alias is being deleted.
	//
	// This member is required.
	AgentAliasStatus AgentAliasStatus

	// The unique identifier of the agent.
	//
	// This member is required.
	AgentId *string

	// The time at which the alias of the agent was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// Contains details about the routing configuration of the alias.
	//
	// This member is required.
	RoutingConfiguration []AgentAliasRoutingConfigurationListItem

	// The time at which the alias was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Contains details about the history of the alias.
	AgentAliasHistoryEvents []AgentAliasHistoryEvent

	// A unique, case-sensitive identifier to ensure that the API request completes no
	// more than one time. If this token matches a previous request, Amazon Bedrock
	// ignores the request, but does not return an error. For more information, see [Ensuring idempotency].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientToken *string

	// The description of the alias of the agent.
	Description *string

	// Information on the failure of Provisioned Throughput assigned to an agent alias.
	FailureReasons []string
	// contains filtered or unexported fields
}

Contains details about an alias of an agent.

type AgentAliasHistoryEvent 

type AgentAliasHistoryEvent struct {

	// The date that the alias stopped being associated to the version in the
	// routingConfiguration object
	EndDate *time.Time

	// Contains details about the version of the agent with which the alias is
	// associated.
	RoutingConfiguration []AgentAliasRoutingConfigurationListItem

	// The date that the alias began being associated to the version in the
	// routingConfiguration object.
	StartDate *time.Time
	// contains filtered or unexported fields
}

Contains details about the history of the alias.

type AgentAliasRoutingConfigurationListItem 

type AgentAliasRoutingConfigurationListItem struct {

	// The version of the agent with which the alias is associated.
	AgentVersion *string

	// Information on the Provisioned Throughput assigned to an agent alias.
	ProvisionedThroughput *string
	// contains filtered or unexported fields
}

Contains details about the routing configuration of the alias.

type AgentAliasStatus 

type AgentAliasStatus string
const (
	AgentAliasStatusCreating AgentAliasStatus = "CREATING"
	AgentAliasStatusPrepared AgentAliasStatus = "PREPARED"
	AgentAliasStatusFailed   AgentAliasStatus = "FAILED"
	AgentAliasStatusUpdating AgentAliasStatus = "UPDATING"
	AgentAliasStatusDeleting AgentAliasStatus = "DELETING"
)

Enum values for AgentAliasStatus

func (AgentAliasStatus) Values 

func (AgentAliasStatus) Values() []AgentAliasStatus

Values returns all known values for AgentAliasStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AgentAliasSummary 

type AgentAliasSummary struct {

	// Contains details about
	//
	// This member is required.
	AgentAliasId *string

	// The name of the alias.
	//
	// This member is required.
	AgentAliasName *string

	// The status of the alias.
	//
	// This member is required.
	AgentAliasStatus AgentAliasStatus

	// The time at which the alias of the agent was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The time at which the alias was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The description of the alias.
	Description *string

	// Contains details about the version of the agent with which the alias is
	// associated.
	RoutingConfiguration []AgentAliasRoutingConfigurationListItem
	// contains filtered or unexported fields
}

Contains details about an alias of an agent.

type AgentFlowNodeConfiguration added in v1.15.0 

type AgentFlowNodeConfiguration struct {

	// The Amazon Resource Name (ARN) of the alias of the agent to invoke.
	//
	// This member is required.
	AgentAliasArn *string
	// contains filtered or unexported fields
}

Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in Amazon Bedrock worksin the Amazon Bedrock User Guide.

type AgentKnowledgeBase 

type AgentKnowledgeBase struct {

	// The unique identifier of the agent with which the knowledge base is associated.
	//
	// This member is required.
	AgentId *string

	// The version of the agent with which the knowledge base is associated.
	//
	// This member is required.
	AgentVersion *string

	// The time at which the association between the agent and the knowledge base was
	// created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The description of the association between the agent and the knowledge base.
	//
	// This member is required.
	Description *string

	// The unique identifier of the association between the agent and the knowledge
	// base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// Specifies whether to use the knowledge base or not when sending an [InvokeAgent] request.
	//
	// [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
	//
	// This member is required.
	KnowledgeBaseState KnowledgeBaseState

	// The time at which the association between the agent and the knowledge base was
	// last updated.
	//
	// This member is required.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Contains details about a knowledge base that is associated with an agent.

type AgentKnowledgeBaseSummary 

type AgentKnowledgeBaseSummary struct {

	// The unique identifier of the knowledge base associated with an agent.
	//
	// This member is required.
	KnowledgeBaseId *string

	// Specifies whether the agent uses the knowledge base or not when sending an [InvokeAgent]
	// request.
	//
	// [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
	//
	// This member is required.
	KnowledgeBaseState KnowledgeBaseState

	// The time at which the knowledge base associated with an agent was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The description of the knowledge base associated with an agent.
	Description *string
	// contains filtered or unexported fields
}

Contains details about a knowledge base associated with an agent.

type AgentStatus 

type AgentStatus string
const (
	AgentStatusCreating    AgentStatus = "CREATING"
	AgentStatusPreparing   AgentStatus = "PREPARING"
	AgentStatusPrepared    AgentStatus = "PREPARED"
	AgentStatusNotPrepared AgentStatus = "NOT_PREPARED"
	AgentStatusDeleting    AgentStatus = "DELETING"
	AgentStatusFailed      AgentStatus = "FAILED"
	AgentStatusVersioning  AgentStatus = "VERSIONING"
	AgentStatusUpdating    AgentStatus = "UPDATING"
)

Enum values for AgentStatus

func (AgentStatus) Values 

func (AgentStatus) Values() []AgentStatus

Values returns all known values for AgentStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AgentSummary 

type AgentSummary struct {

	// The unique identifier of the agent.
	//
	// This member is required.
	AgentId *string

	// The name of the agent.
	//
	// This member is required.
	AgentName *string

	// The status of the agent.
	//
	// This member is required.
	AgentStatus AgentStatus

	// The time at which the agent was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The description of the agent.
	Description *string

	// Details about the guardrail associated with the agent.
	GuardrailConfiguration *GuardrailConfiguration

	// The latest version of the agent.
	LatestAgentVersion *string
	// contains filtered or unexported fields
}

Contains details about an agent.

type AgentVersion 

type AgentVersion struct {

	// The Amazon Resource Name (ARN) of the agent that the version belongs to.
	//
	// This member is required.
	AgentArn *string

	// The unique identifier of the agent that the version belongs to.
	//
	// This member is required.
	AgentId *string

	// The name of the agent that the version belongs to.
	//
	// This member is required.
	AgentName *string

	// The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API
	// operations on the agent.
	//
	// This member is required.
	AgentResourceRoleArn *string

	// The status of the agent that the version belongs to.
	//
	// This member is required.
	AgentStatus AgentStatus

	// The time at which the version was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The number of seconds for which Amazon Bedrock keeps information about a user's
	// conversation with the agent.
	//
	// A user interaction remains active for the amount of time specified. If no
	// conversation occurs during this time, the session expires and Amazon Bedrock
	// deletes any data provided before the timeout.
	//
	// This member is required.
	IdleSessionTTLInSeconds *int32

	// The time at which the version was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The version number.
	//
	// This member is required.
	Version *string

	// The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
	CustomerEncryptionKeyArn *string

	// The description of the version.
	Description *string

	// A list of reasons that the API operation on the version failed.
	FailureReasons []string

	// The foundation model that the version invokes.
	FoundationModel *string

	// Details about the guardrail associated with the agent.
	GuardrailConfiguration *GuardrailConfiguration

	// The instructions provided to the agent.
	Instruction *string

	//  Contains details of the memory configuration on the version of the agent.
	MemoryConfiguration *MemoryConfiguration

	// Contains configurations to override prompt templates in different parts of an
	// agent sequence. For more information, see [Advanced prompts].
	//
	// [Advanced prompts]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
	PromptOverrideConfiguration *PromptOverrideConfiguration

	// A list of recommended actions to take for the failed API operation on the
	// version to succeed.
	RecommendedActions []string
	// contains filtered or unexported fields
}

Contains details about a version of an agent.

type AgentVersionSummary 

type AgentVersionSummary struct {

	// The name of the agent to which the version belongs.
	//
	// This member is required.
	AgentName *string

	// The status of the agent to which the version belongs.
	//
	// This member is required.
	AgentStatus AgentStatus

	// The version of the agent.
	//
	// This member is required.
	AgentVersion *string

	// The time at which the version was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The time at which the version was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The description of the version of the agent.
	Description *string

	// Details about the guardrail associated with the agent.
	GuardrailConfiguration *GuardrailConfiguration
	// contains filtered or unexported fields
}

Contains details about a version of an agent.

type AnyToolChoice added in v1.27.0 

type AnyToolChoice struct {
	// contains filtered or unexported fields
}

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 Use a tool to complete an Amazon Bedrock model response.

type AutoToolChoice added in v1.27.0 

type AutoToolChoice struct {
	// contains filtered or unexported fields
}

Defines tools. The model automatically decides whether to call a tool or to generate text instead. For more information, see Use a tool to complete an Amazon Bedrock model response.

type BedrockEmbeddingModelConfiguration added in v1.12.0 

type BedrockEmbeddingModelConfiguration struct {

	// The dimensions details for the vector configuration used on the Bedrock
	// embeddings model.
	Dimensions *int32

	// The data type for the vectors when using a model to convert text into vector
	// embeddings. The model must support the specified data type for vector
	// embeddings. Floating-point (float32) is the default data type, and is supported
	// by most models for vector embeddings. See [Supported embeddings models]for information on the available
	// models and their vector data types.
	//
	// [Supported embeddings models]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html
	EmbeddingDataType EmbeddingDataType
	// contains filtered or unexported fields
}

The vector configuration details for the Bedrock embeddings model.

type BedrockFoundationModelConfiguration added in v1.15.0 

type BedrockFoundationModelConfiguration struct {

	// The ARN of the foundation model or [inference profile].
	//
	// [inference profile]: https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html
	//
	// This member is required.
	ModelArn *string

	// Instructions for interpreting the contents of a document.
	ParsingPrompt *ParsingPrompt
	// contains filtered or unexported fields
}

Settings for a foundation model or inference profile used to parse documents for a data source.

type ChatPromptTemplateConfiguration added in v1.27.0 

type ChatPromptTemplateConfiguration struct {

	// Contains messages in the chat for the prompt.
	//
	// This member is required.
	Messages []Message

	// An array of the variables in the prompt template.
	InputVariables []PromptInputVariable

	// Contains system prompts to provide context to the model or to describe how it
	// should behave.
	System []SystemContentBlock

	// Configuration information for the tools that the model can use when generating
	// a response.
	ToolConfiguration *ToolConfiguration
	// contains filtered or unexported fields
}

Contains configurations to use a prompt in a conversational format. For more information, see Create a prompt using Prompt management.

type ChunkingConfiguration 

type ChunkingConfiguration struct {

	// Knowledge base can split your source data into chunks. A chunk refers to an
	// excerpt from a data source that is returned when the knowledge base that it
	// belongs to is queried. You have the following options for chunking your data. If
	// you opt for NONE , then you may want to pre-process your files by splitting them
	// up such that each file corresponds to a chunk.
	//
	//   - FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the
	//   approximate size that you set in the fixedSizeChunkingConfiguration .
	//
	//   - HIERARCHICAL – Split documents into layers of chunks where the first layer
	//   contains large chunks, and the second layer contains smaller chunks derived from
	//   the first layer.
	//
	//   - SEMANTIC – Split documents into chunks based on groups of similar content
	//   derived with natural language processing.
	//
	//   - NONE – Amazon Bedrock treats each file as one chunk. If you choose this
	//   option, you may want to pre-process your documents by splitting them into
	//   separate files.
	//
	// This member is required.
	ChunkingStrategy ChunkingStrategy

	// Configurations for when you choose fixed-size chunking. If you set the
	// chunkingStrategy as NONE , exclude this field.
	FixedSizeChunkingConfiguration *FixedSizeChunkingConfiguration

	// Settings for hierarchical document chunking for a data source. Hierarchical
	// chunking splits documents into layers of chunks where the first layer contains
	// large chunks, and the second layer contains smaller chunks derived from the
	// first layer.
	HierarchicalChunkingConfiguration *HierarchicalChunkingConfiguration

	// Settings for semantic document chunking for a data source. Semantic chunking
	// splits a document into into smaller documents based on groups of similar content
	// derived from the text with natural language processing.
	SemanticChunkingConfiguration *SemanticChunkingConfiguration
	// contains filtered or unexported fields
}

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

type ChunkingStrategy 

type ChunkingStrategy string
const (
	ChunkingStrategyFixedSize    ChunkingStrategy = "FIXED_SIZE"
	ChunkingStrategyNone         ChunkingStrategy = "NONE"
	ChunkingStrategyHierarchical ChunkingStrategy = "HIERARCHICAL"
	ChunkingStrategySemantic     ChunkingStrategy = "SEMANTIC"
)

Enum values for ChunkingStrategy

func (ChunkingStrategy) Values 

func (ChunkingStrategy) Values() []ChunkingStrategy

Values returns all known values for ChunkingStrategy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CollectorFlowNodeConfiguration added in v1.15.0 

type CollectorFlowNodeConfiguration struct {
	// contains filtered or unexported fields
}

Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in Amazon Bedrock worksin the Amazon Bedrock User Guide.

type ConditionFlowNodeConfiguration added in v1.15.0 

type ConditionFlowNodeConfiguration struct {

	// An array of conditions. Each member contains the name of a condition and an
	// expression that defines the condition.
	//
	// This member is required.
	Conditions []FlowCondition
	// contains filtered or unexported fields
}

Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in Amazon Bedrock worksin the Amazon Bedrock User Guide.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

There was a conflict performing an operation.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ConfluenceAuthType added in v1.15.0 

type ConfluenceAuthType string
const (
	ConfluenceAuthTypeBasic                   ConfluenceAuthType = "BASIC"
	ConfluenceAuthTypeOauth2ClientCredentials ConfluenceAuthType = "OAUTH2_CLIENT_CREDENTIALS"
)

Enum values for ConfluenceAuthType

func (ConfluenceAuthType) Values added in v1.15.0 

func (ConfluenceAuthType) Values() []ConfluenceAuthType

Values returns all known values for ConfluenceAuthType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConfluenceCrawlerConfiguration added in v1.15.0 

type ConfluenceCrawlerConfiguration struct {

	// The configuration of filtering the Confluence content. For example, configuring
	// regular expression patterns to include or exclude certain content.
	FilterConfiguration *CrawlFilterConfiguration
	// contains filtered or unexported fields
}

The configuration of the Confluence content. For example, configuring specific types of Confluence content.

type ConfluenceDataSourceConfiguration added in v1.15.0 

type ConfluenceDataSourceConfiguration struct {

	// The endpoint information to connect to your Confluence data source.
	//
	// This member is required.
	SourceConfiguration *ConfluenceSourceConfiguration

	// The configuration of the Confluence content. For example, configuring specific
	// types of Confluence content.
	CrawlerConfiguration *ConfluenceCrawlerConfiguration
	// contains filtered or unexported fields
}

The configuration information to connect to Confluence as your data source.

type ConfluenceHostType added in v1.15.0 

type ConfluenceHostType string
const (
	ConfluenceHostTypeSaas ConfluenceHostType = "SAAS"
)

Enum values for ConfluenceHostType

func (ConfluenceHostType) Values added in v1.15.0 

func (ConfluenceHostType) Values() []ConfluenceHostType

Values returns all known values for ConfluenceHostType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConfluenceSourceConfiguration added in v1.15.0 

type ConfluenceSourceConfiguration struct {

	// The supported authentication type to authenticate and connect to your
	// Confluence instance.
	//
	// This member is required.
	AuthType ConfluenceAuthType

	// The Amazon Resource Name of an Secrets Manager secret that stores your
	// authentication credentials for your Confluence instance URL. For more
	// information on the key-value pairs that must be included in your secret,
	// depending on your authentication type, see [Confluence connection configuration].
	//
	// [Confluence connection configuration]: https://docs.aws.amazon.com/bedrock/latest/userguide/confluence-data-source-connector.html#configuration-confluence-connector
	//
	// This member is required.
	CredentialsSecretArn *string

	// The supported host type, whether online/cloud or server/on-premises.
	//
	// This member is required.
	HostType ConfluenceHostType

	// The Confluence host URL or instance URL.
	//
	// This member is required.
	HostUrl *string
	// contains filtered or unexported fields
}

The endpoint information to connect to your Confluence data source.

type ContentBlock added in v1.27.0 

type ContentBlock interface {
	// contains filtered or unexported methods
}

Contains the content for the message you pass to, or receive from a model. For more information, see Create a prompt using Prompt management.

The following types satisfy this interface: 

ContentBlockMemberText
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.ContentBlock
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ContentBlockMemberText:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ContentBlockMemberText added in v1.27.0 

type ContentBlockMemberText struct {
	Value string
	// contains filtered or unexported fields
}

The text in the message.

type ConversationRole added in v1.27.0 

type ConversationRole string
const (
	ConversationRoleUser      ConversationRole = "user"
	ConversationRoleAssistant ConversationRole = "assistant"
)

Enum values for ConversationRole

func (ConversationRole) Values added in v1.27.0 

func (ConversationRole) Values() []ConversationRole

Values returns all known values for ConversationRole. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CrawlFilterConfiguration added in v1.15.0 

type CrawlFilterConfiguration struct {

	// The type of filtering that you want to apply to certain objects or content of
	// the data source. For example, the PATTERN type is regular expression patterns
	// you can apply to filter your content.
	//
	// This member is required.
	Type CrawlFilterConfigurationType

	// The configuration of filtering certain objects or content types of the data
	// source.
	PatternObjectFilter *PatternObjectFilterConfiguration
	// contains filtered or unexported fields
}

The configuration of filtering the data source content. For example, configuring regular expression patterns to include or exclude certain content.

type CrawlFilterConfigurationType added in v1.15.0 

type CrawlFilterConfigurationType string
const (
	CrawlFilterConfigurationTypePattern CrawlFilterConfigurationType = "PATTERN"
)

Enum values for CrawlFilterConfigurationType

func (CrawlFilterConfigurationType) Values added in v1.15.0 

func (CrawlFilterConfigurationType) Values() []CrawlFilterConfigurationType

Values returns all known values for CrawlFilterConfigurationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CreationMode 

type CreationMode string
const (
	CreationModeDefault    CreationMode = "DEFAULT"
	CreationModeOverridden CreationMode = "OVERRIDDEN"
)

Enum values for CreationMode

func (CreationMode) Values 

func (CreationMode) Values() []CreationMode

Values returns all known values for CreationMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CustomControlMethod added in v1.7.0 

type CustomControlMethod string
const (
	CustomControlMethodReturnControl CustomControlMethod = "RETURN_CONTROL"
)

Enum values for CustomControlMethod

func (CustomControlMethod) Values added in v1.7.0 

func (CustomControlMethod) Values() []CustomControlMethod

Values returns all known values for CustomControlMethod. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CustomOrchestration added in v1.28.0 

type CustomOrchestration struct {

	//  The structure of the executor invoking the actions in custom orchestration.
	Executor OrchestrationExecutor
	// contains filtered or unexported fields
}

Details of custom orchestration.

type CustomTransformationConfiguration added in v1.15.0 

type CustomTransformationConfiguration struct {

	// An S3 bucket path for input and output objects.
	//
	// This member is required.
	IntermediateStorage *IntermediateStorage

	// A Lambda function that processes documents.
	//
	// This member is required.
	Transformations []Transformation
	// contains filtered or unexported fields
}

Settings for customizing steps in the data source content ingestion pipeline.

You can configure the data source to process documents with a Lambda function after they are parsed and converted into chunks. When you add a post-chunking transformation, the service stores chunked documents in an S3 bucket and invokes a Lambda function to process them.

To process chunked documents with a Lambda function, define an S3 bucket path for input and output objects, and a transformation that specifies the Lambda function to invoke. You can use the Lambda function to customize how chunks are split, and the metadata for each chunk.

type CyclicConnectionFlowValidationDetails added in v1.27.0 

type CyclicConnectionFlowValidationDetails struct {

	// The name of the connection that causes the cycle in the flow.
	//
	// This member is required.
	Connection *string
	// contains filtered or unexported fields
}

Details about a cyclic connection detected in the flow.

type DataDeletionPolicy added in v1.8.0 

type DataDeletionPolicy string
const (
	DataDeletionPolicyRetain DataDeletionPolicy = "RETAIN"
	DataDeletionPolicyDelete DataDeletionPolicy = "DELETE"
)

Enum values for DataDeletionPolicy

func (DataDeletionPolicy) Values added in v1.8.0 

func (DataDeletionPolicy) Values() []DataDeletionPolicy

Values returns all known values for DataDeletionPolicy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DataSource 

type DataSource struct {

	// The time at which the data source was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The connection configuration for the data source.
	//
	// This member is required.
	DataSourceConfiguration *DataSourceConfiguration

	// The unique identifier of the data source.
	//
	// This member is required.
	DataSourceId *string

	// The unique identifier of the knowledge base to which the data source belongs.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The name of the data source.
	//
	// This member is required.
	Name *string

	// The status of the data source. The following statuses are possible:
	//
	//   - Available – The data source has been created and is ready for ingestion
	//   into the knowledge base.
	//
	//   - Deleting – The data source is being deleted.
	//
	// This member is required.
	Status DataSourceStatus

	// The time at which the data source was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The data deletion policy for the data source.
	DataDeletionPolicy DataDeletionPolicy

	// The description of the data source.
	Description *string

	// The detailed reasons on the failure to delete a data source.
	FailureReasons []string

	// Contains details about the configuration of the server-side encryption.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

	// Contains details about how to ingest the documents in the data source.
	VectorIngestionConfiguration *VectorIngestionConfiguration
	// contains filtered or unexported fields
}

Contains details about a data source.

type DataSourceConfiguration 

type DataSourceConfiguration struct {

	// The type of data source.
	//
	// This member is required.
	Type DataSourceType

	// The configuration information to connect to Confluence as your data source.
	//
	// Confluence data source connector is in preview release and is subject to change.
	ConfluenceConfiguration *ConfluenceDataSourceConfiguration

	// The configuration information to connect to Amazon S3 as your data source.
	S3Configuration *S3DataSourceConfiguration

	// The configuration information to connect to Salesforce as your data source.
	//
	// Salesforce data source connector is in preview release and is subject to change.
	SalesforceConfiguration *SalesforceDataSourceConfiguration

	// The configuration information to connect to SharePoint as your data source.
	//
	// SharePoint data source connector is in preview release and is subject to change.
	SharePointConfiguration *SharePointDataSourceConfiguration

	// The configuration of web URLs to crawl for your data source. You should be
	// authorized to crawl the URLs.
	//
	// Crawling web URLs as your data source is in preview release and is subject to
	// change.
	WebConfiguration *WebDataSourceConfiguration
	// contains filtered or unexported fields
}

The connection configuration for the data source.

type DataSourceStatus 

type DataSourceStatus string
const (
	DataSourceStatusAvailable          DataSourceStatus = "AVAILABLE"
	DataSourceStatusDeleting           DataSourceStatus = "DELETING"
	DataSourceStatusDeleteUnsuccessful DataSourceStatus = "DELETE_UNSUCCESSFUL"
)

Enum values for DataSourceStatus

func (DataSourceStatus) Values 

func (DataSourceStatus) Values() []DataSourceStatus

Values returns all known values for DataSourceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DataSourceSummary 

type DataSourceSummary struct {

	// The unique identifier of the data source.
	//
	// This member is required.
	DataSourceId *string

	// The unique identifier of the knowledge base to which the data source belongs.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The name of the data source.
	//
	// This member is required.
	Name *string

	// The status of the data source.
	//
	// This member is required.
	Status DataSourceStatus

	// The time at which the data source was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The description of the data source.
	Description *string
	// contains filtered or unexported fields
}

Contains details about a data source.

type DataSourceType 

type DataSourceType string
const (
	DataSourceTypeS3         DataSourceType = "S3"
	DataSourceTypeWeb        DataSourceType = "WEB"
	DataSourceTypeConfluence DataSourceType = "CONFLUENCE"
	DataSourceTypeSalesforce DataSourceType = "SALESFORCE"
	DataSourceTypeSharepoint DataSourceType = "SHAREPOINT"
)

Enum values for DataSourceType

func (DataSourceType) Values 

func (DataSourceType) Values() []DataSourceType

Values returns all known values for DataSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DuplicateConditionExpressionFlowValidationDetails added in v1.27.0 

type DuplicateConditionExpressionFlowValidationDetails struct {

	// The duplicated condition expression.
	//
	// This member is required.
	Expression *string

	// The name of the node containing the duplicate condition expressions.
	//
	// This member is required.
	Node *string
	// contains filtered or unexported fields
}

Details about duplicate condition expressions found in a condition node.

type DuplicateConnectionsFlowValidationDetails added in v1.27.0 

type DuplicateConnectionsFlowValidationDetails struct {

	// The name of the source node where the duplicate connection starts.
	//
	// This member is required.
	Source *string

	// The name of the target node where the duplicate connection ends.
	//
	// This member is required.
	Target *string
	// contains filtered or unexported fields
}

Details about duplicate connections found between two nodes in the flow.

type EmbeddingDataType added in v1.29.0 

type EmbeddingDataType string
const (
	EmbeddingDataTypeFloat32 EmbeddingDataType = "FLOAT32"
	EmbeddingDataTypeBinary  EmbeddingDataType = "BINARY"
)

Enum values for EmbeddingDataType

func (EmbeddingDataType) Values added in v1.29.0 

func (EmbeddingDataType) Values() []EmbeddingDataType

Values returns all known values for EmbeddingDataType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EmbeddingModelConfiguration added in v1.12.0 

type EmbeddingModelConfiguration struct {

	// The vector configuration details on the Bedrock embeddings model.
	BedrockEmbeddingModelConfiguration *BedrockEmbeddingModelConfiguration
	// contains filtered or unexported fields
}

The configuration details for the embeddings model.

type FixedSizeChunkingConfiguration 

type FixedSizeChunkingConfiguration struct {

	// The maximum number of tokens to include in a chunk.
	//
	// This member is required.
	MaxTokens *int32

	// The percentage of overlap between adjacent chunks of a data source.
	//
	// This member is required.
	OverlapPercentage *int32
	// contains filtered or unexported fields
}

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.

type FlowAliasRoutingConfigurationListItem added in v1.15.0 

type FlowAliasRoutingConfigurationListItem struct {

	// The version that the alias maps to.
	FlowVersion *string
	// contains filtered or unexported fields
}

Contains information about a version that the alias maps to.

type FlowAliasSummary added in v1.15.0 

type FlowAliasSummary struct {

	// The Amazon Resource Name (ARN) of the alias.
	//
	// This member is required.
	Arn *string

	// The time at which the alias was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The unique identifier of the flow.
	//
	// This member is required.
	FlowId *string

	// The unique identifier of the alias of the flow.
	//
	// This member is required.
	Id *string

	// The name of the alias.
	//
	// This member is required.
	Name *string

	// A list of configurations about the versions that the alias maps to. Currently,
	// you can only specify one.
	//
	// This member is required.
	RoutingConfiguration []FlowAliasRoutingConfigurationListItem

	// The time at which the alias was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// A description of the alias.
	Description *string
	// contains filtered or unexported fields
}

Contains information about an alias of a flow.

This data type is used in the following API operations:

ListFlowAliases response

type FlowCondition added in v1.15.0 

type FlowCondition struct {

	// A name for the condition that you can reference.
	//
	// This member is required.
	Name *string

	// Defines the condition. You must refer to at least one of the inputs in the
	// condition. For more information, expand the Condition node section in [Node types in prompt flows].
	//
	// [Node types in prompt flows]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html#flows-nodes
	Expression *string
	// contains filtered or unexported fields
}

Defines a condition in the condition node.

type FlowConditionalConnectionConfiguration added in v1.15.0 

type FlowConditionalConnectionConfiguration struct {

	// The condition that triggers this connection. For more information about how to
	// write conditions, see the Condition node type in the [Node types]topic in the Amazon
	// Bedrock User Guide.
	//
	// [Node types]: https://docs.aws.amazon.com/bedrock/latest/userguide/node-types.html
	//
	// This member is required.
	Condition *string
	// contains filtered or unexported fields
}

The configuration of a connection between a condition node and another node.

type FlowConnection added in v1.15.0 

type FlowConnection struct {

	// A name for the connection that you can reference.
	//
	// This member is required.
	Name *string

	// The node that the connection starts at.
	//
	// This member is required.
	Source *string

	// The node that the connection ends at.
	//
	// This member is required.
	Target *string

	// Whether the source node that the connection begins from is a condition node (
	// Conditional ) or not ( Data ).
	//
	// This member is required.
	Type FlowConnectionType

	// The configuration of the connection.
	Configuration FlowConnectionConfiguration
	// contains filtered or unexported fields
}

Contains information about a connection between two nodes in the flow.

type FlowConnectionConfiguration added in v1.15.0 

type FlowConnectionConfiguration interface {
	// contains filtered or unexported methods
}

The configuration of the connection.

The following types satisfy this interface: 

FlowConnectionConfigurationMemberConditional
FlowConnectionConfigurationMemberData
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.FlowConnectionConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.FlowConnectionConfigurationMemberConditional:
		_ = v.Value // Value is types.FlowConditionalConnectionConfiguration

	case *types.FlowConnectionConfigurationMemberData:
		_ = v.Value // Value is types.FlowDataConnectionConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type FlowConnectionConfigurationMemberConditional added in v1.15.0 

type FlowConnectionConfigurationMemberConditional struct {
	Value FlowConditionalConnectionConfiguration
	// contains filtered or unexported fields
}

The configuration of a connection originating from a Condition node.

type FlowConnectionConfigurationMemberData added in v1.15.0 

type FlowConnectionConfigurationMemberData struct {
	Value FlowDataConnectionConfiguration
	// contains filtered or unexported fields
}

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

type FlowConnectionType added in v1.15.0 

type FlowConnectionType string
const (
	FlowConnectionTypeData        FlowConnectionType = "Data"
	FlowConnectionTypeConditional FlowConnectionType = "Conditional"
)

Enum values for FlowConnectionType

func (FlowConnectionType) Values added in v1.15.0 

func (FlowConnectionType) Values() []FlowConnectionType

Values returns all known values for FlowConnectionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FlowDataConnectionConfiguration added in v1.15.0 

type FlowDataConnectionConfiguration struct {

	// The name of the output in the source node that the connection begins from.
	//
	// This member is required.
	SourceOutput *string

	// The name of the input in the target node that the connection ends at.
	//
	// This member is required.
	TargetInput *string
	// contains filtered or unexported fields
}

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

type FlowDefinition added in v1.15.0 

type FlowDefinition struct {

	// An array of connection definitions in the flow.
	Connections []FlowConnection

	// An array of node definitions in the flow.
	Nodes []FlowNode
	// contains filtered or unexported fields
}

The definition of the nodes and connections between nodes in the flow.

type FlowNode added in v1.15.0 

type FlowNode struct {

	// A name for the node.
	//
	// This member is required.
	Name *string

	// The type of node. This value must match the name of the key that you provide in
	// the configuration you provide in the FlowNodeConfiguration field.
	//
	// This member is required.
	Type FlowNodeType

	// Contains configurations for the node.
	Configuration FlowNodeConfiguration

	// An array of objects, each of which contains information about an input into the
	// node.
	Inputs []FlowNodeInput

	// A list of objects, each of which contains information about an output from the
	// node.
	Outputs []FlowNodeOutput
	// contains filtered or unexported fields
}

Contains configurations about a node in the flow.

type FlowNodeConfiguration added in v1.15.0 

type FlowNodeConfiguration interface {
	// contains filtered or unexported methods
}

Contains configurations for a node in your flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.

The following types satisfy this interface: 

FlowNodeConfigurationMemberAgent
FlowNodeConfigurationMemberCollector
FlowNodeConfigurationMemberCondition
FlowNodeConfigurationMemberInput
FlowNodeConfigurationMemberIterator
FlowNodeConfigurationMemberKnowledgeBase
FlowNodeConfigurationMemberLambdaFunction
FlowNodeConfigurationMemberLex
FlowNodeConfigurationMemberOutput
FlowNodeConfigurationMemberPrompt
FlowNodeConfigurationMemberRetrieval
FlowNodeConfigurationMemberStorage
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.FlowNodeConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.FlowNodeConfigurationMemberAgent:
		_ = v.Value // Value is types.AgentFlowNodeConfiguration

	case *types.FlowNodeConfigurationMemberCollector:
		_ = v.Value // Value is types.CollectorFlowNodeConfiguration

	case *types.FlowNodeConfigurationMemberCondition:
		_ = v.Value // Value is types.ConditionFlowNodeConfiguration

	case *types.FlowNodeConfigurationMemberInput:
		_ = v.Value // Value is types.InputFlowNodeConfiguration

	case *types.FlowNodeConfigurationMemberIterator:
		_ = v.Value // Value is types.IteratorFlowNodeConfiguration

	case *types.FlowNodeConfigurationMemberKnowledgeBase:
		_ = v.Value // Value is types.KnowledgeBaseFlowNodeConfiguration

	case *types.FlowNodeConfigurationMemberLambdaFunction:
		_ = v.Value // Value is types.LambdaFunctionFlowNodeConfiguration

	case *types.FlowNodeConfigurationMemberLex:
		_ = v.Value // Value is types.LexFlowNodeConfiguration

	case *types.FlowNodeConfigurationMemberOutput:
		_ = v.Value // Value is types.OutputFlowNodeConfiguration

	case *types.FlowNodeConfigurationMemberPrompt:
		_ = v.Value // Value is types.PromptFlowNodeConfiguration

	case *types.FlowNodeConfigurationMemberRetrieval:
		_ = v.Value // Value is types.RetrievalFlowNodeConfiguration

	case *types.FlowNodeConfigurationMemberStorage:
		_ = v.Value // Value is types.StorageFlowNodeConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type FlowNodeConfigurationMemberAgent added in v1.15.0 

type FlowNodeConfigurationMemberAgent struct {
	Value AgentFlowNodeConfiguration
	// contains filtered or unexported fields
}

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

type FlowNodeConfigurationMemberCollector added in v1.15.0 

type FlowNodeConfigurationMemberCollector struct {
	Value CollectorFlowNodeConfiguration
	// contains filtered or unexported fields
}

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

type FlowNodeConfigurationMemberCondition added in v1.15.0 

type FlowNodeConfigurationMemberCondition struct {
	Value ConditionFlowNodeConfiguration
	// contains filtered or unexported fields
}

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

type FlowNodeConfigurationMemberInput added in v1.15.0 

type FlowNodeConfigurationMemberInput struct {
	Value InputFlowNodeConfiguration
	// contains filtered or unexported fields
}

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

type FlowNodeConfigurationMemberIterator added in v1.15.0 

type FlowNodeConfigurationMemberIterator struct {
	Value IteratorFlowNodeConfiguration
	// contains filtered or unexported fields
}

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.

type FlowNodeConfigurationMemberKnowledgeBase added in v1.15.0 

type FlowNodeConfigurationMemberKnowledgeBase struct {
	Value KnowledgeBaseFlowNodeConfiguration
	// contains filtered or unexported fields
}

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

type FlowNodeConfigurationMemberLambdaFunction added in v1.15.0 

type FlowNodeConfigurationMemberLambdaFunction struct {
	Value LambdaFunctionFlowNodeConfiguration
	// contains filtered or unexported fields
}

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

type FlowNodeConfigurationMemberLex added in v1.15.0 

type FlowNodeConfigurationMemberLex struct {
	Value LexFlowNodeConfiguration
	// contains filtered or unexported fields
}

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.

type FlowNodeConfigurationMemberOutput added in v1.15.0 

type FlowNodeConfigurationMemberOutput struct {
	Value OutputFlowNodeConfiguration
	// contains filtered or unexported fields
}

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

type FlowNodeConfigurationMemberPrompt added in v1.15.0 

type FlowNodeConfigurationMemberPrompt struct {
	Value PromptFlowNodeConfiguration
	// contains filtered or unexported fields
}

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.

type FlowNodeConfigurationMemberRetrieval added in v1.15.0 

type FlowNodeConfigurationMemberRetrieval struct {
	Value RetrievalFlowNodeConfiguration
	// contains filtered or unexported fields
}

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

type FlowNodeConfigurationMemberStorage added in v1.15.0 

type FlowNodeConfigurationMemberStorage struct {
	Value StorageFlowNodeConfiguration
	// contains filtered or unexported fields
}

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

type FlowNodeIODataType added in v1.15.0 

type FlowNodeIODataType string
const (
	FlowNodeIODataTypeString  FlowNodeIODataType = "String"
	FlowNodeIODataTypeNumber  FlowNodeIODataType = "Number"
	FlowNodeIODataTypeBoolean FlowNodeIODataType = "Boolean"
	FlowNodeIODataTypeObject  FlowNodeIODataType = "Object"
	FlowNodeIODataTypeArray   FlowNodeIODataType = "Array"
)

Enum values for FlowNodeIODataType

func (FlowNodeIODataType) Values added in v1.15.0 

func (FlowNodeIODataType) Values() []FlowNodeIODataType

Values returns all known values for FlowNodeIODataType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FlowNodeInput added in v1.15.0 

type FlowNodeInput struct {

	// An expression that formats the input for the node. For an explanation of how to
	// create expressions, see [Expressions in Prompt flows in Amazon Bedrock].
	//
	// [Expressions in Prompt flows in Amazon Bedrock]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-expressions.html
	//
	// This member is required.
	Expression *string

	// A name for the input that you can reference.
	//
	// This member is required.
	Name *string

	// The data type of the input. If the input doesn't match this type at runtime, a
	// validation error will be thrown.
	//
	// This member is required.
	Type FlowNodeIODataType
	// contains filtered or unexported fields
}

Contains configurations for an input to a node.

type FlowNodeOutput added in v1.15.0 

type FlowNodeOutput struct {

	// A name for the output that you can reference.
	//
	// This member is required.
	Name *string

	// The data type of the output. If the output doesn't match this type at runtime,
	// a validation error will be thrown.
	//
	// This member is required.
	Type FlowNodeIODataType
	// contains filtered or unexported fields
}

Contains configurations for an output from a node.

type FlowNodeType added in v1.15.0 

type FlowNodeType string
const (
	FlowNodeTypeInput          FlowNodeType = "Input"
	FlowNodeTypeOutput         FlowNodeType = "Output"
	FlowNodeTypeKnowledgeBase  FlowNodeType = "KnowledgeBase"
	FlowNodeTypeCondition      FlowNodeType = "Condition"
	FlowNodeTypeLex            FlowNodeType = "Lex"
	FlowNodeTypePrompt         FlowNodeType = "Prompt"
	FlowNodeTypeLambdaFunction FlowNodeType = "LambdaFunction"
	FlowNodeTypeStorage        FlowNodeType = "Storage"
	FlowNodeTypeAgent          FlowNodeType = "Agent"
	FlowNodeTypeRetrieval      FlowNodeType = "Retrieval"
	FlowNodeTypeIterator       FlowNodeType = "Iterator"
	FlowNodeTypeCollector      FlowNodeType = "Collector"
)

Enum values for FlowNodeType

func (FlowNodeType) Values added in v1.15.0 

func (FlowNodeType) Values() []FlowNodeType

Values returns all known values for FlowNodeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FlowStatus added in v1.15.0 

type FlowStatus string
const (
	FlowStatusFailed      FlowStatus = "Failed"
	FlowStatusPrepared    FlowStatus = "Prepared"
	FlowStatusPreparing   FlowStatus = "Preparing"
	FlowStatusNotPrepared FlowStatus = "NotPrepared"
)

Enum values for FlowStatus

func (FlowStatus) Values added in v1.15.0 

func (FlowStatus) Values() []FlowStatus

Values returns all known values for FlowStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FlowSummary added in v1.15.0 

type FlowSummary struct {

	// The Amazon Resource Name (ARN) of the flow.
	//
	// This member is required.
	Arn *string

	// The time at which the flow was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The unique identifier of the flow.
	//
	// This member is required.
	Id *string

	// The name of the flow.
	//
	// This member is required.
	Name *string

	// The status of the flow. The following statuses are possible:
	//
	//   - 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 DRAFT version won't contain the latest changes for testing. Send a [PrepareFlow]
	//   request to package the latest changes into the DRAFT version.
	//
	//   - Preparing – The flow is being prepared so that the DRAFT version contains
	//   the latest changes for testing.
	//
	//   - Prepared – The flow is prepared and the DRAFT version contains the latest
	//   changes for testing.
	//
	//   - Failed – The last API operation that you invoked on the flow failed. Send a [GetFlow]
	//   request and check the error message in the validations field.
	//
	// [PrepareFlow]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html
	// [GetFlow]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html
	//
	// This member is required.
	Status FlowStatus

	// The time at which the flow was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The latest version of the flow.
	//
	// This member is required.
	Version *string

	// A description of the flow.
	Description *string
	// contains filtered or unexported fields
}

Contains the definition of a flow.

type FlowValidation added in v1.15.0 

type FlowValidation struct {

	// A message describing the validation error.
	//
	// This member is required.
	Message *string

	// The severity of the issue described in the message.
	//
	// This member is required.
	Severity FlowValidationSeverity

	// Specific details about the validation issue encountered in the flow.
	Details FlowValidationDetails

	// The type of validation issue encountered in the flow.
	Type FlowValidationType
	// contains filtered or unexported fields
}

Contains information about validation of the flow.

This data type is used in the following API operations:

GetFlow response

GetFlowVersion response

type FlowValidationDetails added in v1.27.0 

type FlowValidationDetails interface {
	// contains filtered or unexported methods
}

A union type containing various possible validation issues in the flow.

The following types satisfy this interface: 

FlowValidationDetailsMemberCyclicConnection
FlowValidationDetailsMemberDuplicateConditionExpression
FlowValidationDetailsMemberDuplicateConnections
FlowValidationDetailsMemberIncompatibleConnectionDataType
FlowValidationDetailsMemberMalformedConditionExpression
FlowValidationDetailsMemberMalformedNodeInputExpression
FlowValidationDetailsMemberMismatchedNodeInputType
FlowValidationDetailsMemberMismatchedNodeOutputType
FlowValidationDetailsMemberMissingConnectionConfiguration
FlowValidationDetailsMemberMissingDefaultCondition
FlowValidationDetailsMemberMissingEndingNodes
FlowValidationDetailsMemberMissingNodeConfiguration
FlowValidationDetailsMemberMissingNodeInput
FlowValidationDetailsMemberMissingNodeOutput
FlowValidationDetailsMemberMissingStartingNodes
FlowValidationDetailsMemberMultipleNodeInputConnections
FlowValidationDetailsMemberUnfulfilledNodeInput
FlowValidationDetailsMemberUnknownConnectionCondition
FlowValidationDetailsMemberUnknownConnectionSource
FlowValidationDetailsMemberUnknownConnectionSourceOutput
FlowValidationDetailsMemberUnknownConnectionTarget
FlowValidationDetailsMemberUnknownConnectionTargetInput
FlowValidationDetailsMemberUnreachableNode
FlowValidationDetailsMemberUnsatisfiedConnectionConditions
FlowValidationDetailsMemberUnspecified
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.FlowValidationDetails
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.FlowValidationDetailsMemberCyclicConnection:
		_ = v.Value // Value is types.CyclicConnectionFlowValidationDetails

	case *types.FlowValidationDetailsMemberDuplicateConditionExpression:
		_ = v.Value // Value is types.DuplicateConditionExpressionFlowValidationDetails

	case *types.FlowValidationDetailsMemberDuplicateConnections:
		_ = v.Value // Value is types.DuplicateConnectionsFlowValidationDetails

	case *types.FlowValidationDetailsMemberIncompatibleConnectionDataType:
		_ = v.Value // Value is types.IncompatibleConnectionDataTypeFlowValidationDetails

	case *types.FlowValidationDetailsMemberMalformedConditionExpression:
		_ = v.Value // Value is types.MalformedConditionExpressionFlowValidationDetails

	case *types.FlowValidationDetailsMemberMalformedNodeInputExpression:
		_ = v.Value // Value is types.MalformedNodeInputExpressionFlowValidationDetails

	case *types.FlowValidationDetailsMemberMismatchedNodeInputType:
		_ = v.Value // Value is types.MismatchedNodeInputTypeFlowValidationDetails

	case *types.FlowValidationDetailsMemberMismatchedNodeOutputType:
		_ = v.Value // Value is types.MismatchedNodeOutputTypeFlowValidationDetails

	case *types.FlowValidationDetailsMemberMissingConnectionConfiguration:
		_ = v.Value // Value is types.MissingConnectionConfigurationFlowValidationDetails

	case *types.FlowValidationDetailsMemberMissingDefaultCondition:
		_ = v.Value // Value is types.MissingDefaultConditionFlowValidationDetails

	case *types.FlowValidationDetailsMemberMissingEndingNodes:
		_ = v.Value // Value is types.MissingEndingNodesFlowValidationDetails

	case *types.FlowValidationDetailsMemberMissingNodeConfiguration:
		_ = v.Value // Value is types.MissingNodeConfigurationFlowValidationDetails

	case *types.FlowValidationDetailsMemberMissingNodeInput:
		_ = v.Value // Value is types.MissingNodeInputFlowValidationDetails

	case *types.FlowValidationDetailsMemberMissingNodeOutput:
		_ = v.Value // Value is types.MissingNodeOutputFlowValidationDetails

	case *types.FlowValidationDetailsMemberMissingStartingNodes:
		_ = v.Value // Value is types.MissingStartingNodesFlowValidationDetails

	case *types.FlowValidationDetailsMemberMultipleNodeInputConnections:
		_ = v.Value // Value is types.MultipleNodeInputConnectionsFlowValidationDetails

	case *types.FlowValidationDetailsMemberUnfulfilledNodeInput:
		_ = v.Value // Value is types.UnfulfilledNodeInputFlowValidationDetails

	case *types.FlowValidationDetailsMemberUnknownConnectionCondition:
		_ = v.Value // Value is types.UnknownConnectionConditionFlowValidationDetails

	case *types.FlowValidationDetailsMemberUnknownConnectionSource:
		_ = v.Value // Value is types.UnknownConnectionSourceFlowValidationDetails

	case *types.FlowValidationDetailsMemberUnknownConnectionSourceOutput:
		_ = v.Value // Value is types.UnknownConnectionSourceOutputFlowValidationDetails

	case *types.FlowValidationDetailsMemberUnknownConnectionTarget:
		_ = v.Value // Value is types.UnknownConnectionTargetFlowValidationDetails

	case *types.FlowValidationDetailsMemberUnknownConnectionTargetInput:
		_ = v.Value // Value is types.UnknownConnectionTargetInputFlowValidationDetails

	case *types.FlowValidationDetailsMemberUnreachableNode:
		_ = v.Value // Value is types.UnreachableNodeFlowValidationDetails

	case *types.FlowValidationDetailsMemberUnsatisfiedConnectionConditions:
		_ = v.Value // Value is types.UnsatisfiedConnectionConditionsFlowValidationDetails

	case *types.FlowValidationDetailsMemberUnspecified:
		_ = v.Value // Value is types.UnspecifiedFlowValidationDetails

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type FlowValidationDetailsMemberCyclicConnection added in v1.27.0 

type FlowValidationDetailsMemberCyclicConnection struct {
	Value CyclicConnectionFlowValidationDetails
	// contains filtered or unexported fields
}

Details about a cyclic connection in the flow.

type FlowValidationDetailsMemberDuplicateConditionExpression added in v1.27.0 

type FlowValidationDetailsMemberDuplicateConditionExpression struct {
	Value DuplicateConditionExpressionFlowValidationDetails
	// contains filtered or unexported fields
}

Details about duplicate condition expressions in a node.

type FlowValidationDetailsMemberDuplicateConnections added in v1.27.0 

type FlowValidationDetailsMemberDuplicateConnections struct {
	Value DuplicateConnectionsFlowValidationDetails
	// contains filtered or unexported fields
}

Details about duplicate connections between nodes.

type FlowValidationDetailsMemberIncompatibleConnectionDataType added in v1.27.0 

type FlowValidationDetailsMemberIncompatibleConnectionDataType struct {
	Value IncompatibleConnectionDataTypeFlowValidationDetails
	// contains filtered or unexported fields
}

Details about incompatible data types in a connection.

type FlowValidationDetailsMemberMalformedConditionExpression added in v1.27.0 

type FlowValidationDetailsMemberMalformedConditionExpression struct {
	Value MalformedConditionExpressionFlowValidationDetails
	// contains filtered or unexported fields
}

Details about a malformed condition expression in a node.

type FlowValidationDetailsMemberMalformedNodeInputExpression added in v1.27.0 

type FlowValidationDetailsMemberMalformedNodeInputExpression struct {
	Value MalformedNodeInputExpressionFlowValidationDetails
	// contains filtered or unexported fields
}

Details about a malformed input expression in a node.

type FlowValidationDetailsMemberMismatchedNodeInputType added in v1.27.0 

type FlowValidationDetailsMemberMismatchedNodeInputType struct {
	Value MismatchedNodeInputTypeFlowValidationDetails
	// contains filtered or unexported fields
}

Details about mismatched input data types in a node.

type FlowValidationDetailsMemberMismatchedNodeOutputType added in v1.27.0 

type FlowValidationDetailsMemberMismatchedNodeOutputType struct {
	Value MismatchedNodeOutputTypeFlowValidationDetails
	// contains filtered or unexported fields
}

Details about mismatched output data types in a node.

type FlowValidationDetailsMemberMissingConnectionConfiguration added in v1.27.0 

type FlowValidationDetailsMemberMissingConnectionConfiguration struct {
	Value MissingConnectionConfigurationFlowValidationDetails
	// contains filtered or unexported fields
}

Details about missing configuration for a connection.

type FlowValidationDetailsMemberMissingDefaultCondition added in v1.27.0 

type FlowValidationDetailsMemberMissingDefaultCondition struct {
	Value MissingDefaultConditionFlowValidationDetails
	// contains filtered or unexported fields
}

Details about a missing default condition in a conditional node.

type FlowValidationDetailsMemberMissingEndingNodes added in v1.27.0 

type FlowValidationDetailsMemberMissingEndingNodes struct {
	Value MissingEndingNodesFlowValidationDetails
	// contains filtered or unexported fields
}

Details about missing ending nodes in the flow.

type FlowValidationDetailsMemberMissingNodeConfiguration added in v1.27.0 

type FlowValidationDetailsMemberMissingNodeConfiguration struct {
	Value MissingNodeConfigurationFlowValidationDetails
	// contains filtered or unexported fields
}

Details about missing configuration for a node.

type FlowValidationDetailsMemberMissingNodeInput added in v1.27.0 

type FlowValidationDetailsMemberMissingNodeInput struct {
	Value MissingNodeInputFlowValidationDetails
	// contains filtered or unexported fields
}

Details about a missing required input in a node.

type FlowValidationDetailsMemberMissingNodeOutput added in v1.27.0 

type FlowValidationDetailsMemberMissingNodeOutput struct {
	Value MissingNodeOutputFlowValidationDetails
	// contains filtered or unexported fields
}

Details about a missing required output in a node.

type FlowValidationDetailsMemberMissingStartingNodes added in v1.27.0 

type FlowValidationDetailsMemberMissingStartingNodes struct {
	Value MissingStartingNodesFlowValidationDetails
	// contains filtered or unexported fields
}

Details about missing starting nodes in the flow.

type FlowValidationDetailsMemberMultipleNodeInputConnections added in v1.27.0 

type FlowValidationDetailsMemberMultipleNodeInputConnections struct {
	Value MultipleNodeInputConnectionsFlowValidationDetails
	// contains filtered or unexported fields
}

Details about multiple connections to a single node input.

type FlowValidationDetailsMemberUnfulfilledNodeInput added in v1.27.0 

type FlowValidationDetailsMemberUnfulfilledNodeInput struct {
	Value UnfulfilledNodeInputFlowValidationDetails
	// contains filtered or unexported fields
}

Details about an unfulfilled node input with no valid connections.

type FlowValidationDetailsMemberUnknownConnectionCondition added in v1.27.0 

type FlowValidationDetailsMemberUnknownConnectionCondition struct {
	Value UnknownConnectionConditionFlowValidationDetails
	// contains filtered or unexported fields
}

Details about an unknown condition for a connection.

type FlowValidationDetailsMemberUnknownConnectionSource added in v1.27.0 

type FlowValidationDetailsMemberUnknownConnectionSource struct {
	Value UnknownConnectionSourceFlowValidationDetails
	// contains filtered or unexported fields
}

Details about an unknown source node for a connection.

type FlowValidationDetailsMemberUnknownConnectionSourceOutput added in v1.27.0 

type FlowValidationDetailsMemberUnknownConnectionSourceOutput struct {
	Value UnknownConnectionSourceOutputFlowValidationDetails
	// contains filtered or unexported fields
}

Details about an unknown source output for a connection.

type FlowValidationDetailsMemberUnknownConnectionTarget added in v1.27.0 

type FlowValidationDetailsMemberUnknownConnectionTarget struct {
	Value UnknownConnectionTargetFlowValidationDetails
	// contains filtered or unexported fields
}

Details about an unknown target node for a connection.

type FlowValidationDetailsMemberUnknownConnectionTargetInput added in v1.27.0 

type FlowValidationDetailsMemberUnknownConnectionTargetInput struct {
	Value UnknownConnectionTargetInputFlowValidationDetails
	// contains filtered or unexported fields
}

Details about an unknown target input for a connection.

type FlowValidationDetailsMemberUnreachableNode added in v1.27.0 

type FlowValidationDetailsMemberUnreachableNode struct {
	Value UnreachableNodeFlowValidationDetails
	// contains filtered or unexported fields
}

Details about an unreachable node in the flow.

type FlowValidationDetailsMemberUnsatisfiedConnectionConditions added in v1.27.0 

type FlowValidationDetailsMemberUnsatisfiedConnectionConditions struct {
	Value UnsatisfiedConnectionConditionsFlowValidationDetails
	// contains filtered or unexported fields
}

Details about unsatisfied conditions for a connection.

type FlowValidationDetailsMemberUnspecified added in v1.27.0 

type FlowValidationDetailsMemberUnspecified struct {
	Value UnspecifiedFlowValidationDetails
	// contains filtered or unexported fields
}

Details about an unspecified validation.

type FlowValidationSeverity added in v1.15.0 

type FlowValidationSeverity string
const (
	FlowValidationSeverityWarning FlowValidationSeverity = "Warning"
	FlowValidationSeverityError   FlowValidationSeverity = "Error"
)

Enum values for FlowValidationSeverity

func (FlowValidationSeverity) Values added in v1.15.0 

func (FlowValidationSeverity) Values() []FlowValidationSeverity

Values returns all known values for FlowValidationSeverity. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FlowValidationType added in v1.27.0 

type FlowValidationType string
const (
	FlowValidationTypeCyclicConnection                FlowValidationType = "CyclicConnection"
	FlowValidationTypeDuplicateConnections            FlowValidationType = "DuplicateConnections"
	FlowValidationTypeDuplicateConditionExpression    FlowValidationType = "DuplicateConditionExpression"
	FlowValidationTypeUnreachableNode                 FlowValidationType = "UnreachableNode"
	FlowValidationTypeUnknownConnectionSource         FlowValidationType = "UnknownConnectionSource"
	FlowValidationTypeUnknownConnectionSourceOutput   FlowValidationType = "UnknownConnectionSourceOutput"
	FlowValidationTypeUnknownConnectionTarget         FlowValidationType = "UnknownConnectionTarget"
	FlowValidationTypeUnknownConnectionTargetInput    FlowValidationType = "UnknownConnectionTargetInput"
	FlowValidationTypeUnknownConnectionCondition      FlowValidationType = "UnknownConnectionCondition"
	FlowValidationTypeMalformedConditionExpression    FlowValidationType = "MalformedConditionExpression"
	FlowValidationTypeMalformedNodeInputExpression    FlowValidationType = "MalformedNodeInputExpression"
	FlowValidationTypeMismatchedNodeInputType         FlowValidationType = "MismatchedNodeInputType"
	FlowValidationTypeMismatchedNodeOutputType        FlowValidationType = "MismatchedNodeOutputType"
	FlowValidationTypeIncompatibleConnectionDataType  FlowValidationType = "IncompatibleConnectionDataType"
	FlowValidationTypeMissingConnectionConfiguration  FlowValidationType = "MissingConnectionConfiguration"
	FlowValidationTypeMissingDefaultCondition         FlowValidationType = "MissingDefaultCondition"
	FlowValidationTypeMissingEndingNodes              FlowValidationType = "MissingEndingNodes"
	FlowValidationTypeMissingNodeConfiguration        FlowValidationType = "MissingNodeConfiguration"
	FlowValidationTypeMissingNodeInput                FlowValidationType = "MissingNodeInput"
	FlowValidationTypeMissingNodeOutput               FlowValidationType = "MissingNodeOutput"
	FlowValidationTypeMissingStartingNodes            FlowValidationType = "MissingStartingNodes"
	FlowValidationTypeMultipleNodeInputConnections    FlowValidationType = "MultipleNodeInputConnections"
	FlowValidationTypeUnfulfilledNodeInput            FlowValidationType = "UnfulfilledNodeInput"
	FlowValidationTypeUnsatisfiedConnectionConditions FlowValidationType = "UnsatisfiedConnectionConditions"
	FlowValidationTypeUnspecified                     FlowValidationType = "Unspecified"
)

Enum values for FlowValidationType

func (FlowValidationType) Values added in v1.27.0 

func (FlowValidationType) Values() []FlowValidationType

Values returns all known values for FlowValidationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FlowVersionSummary added in v1.15.0 

type FlowVersionSummary struct {

	// The Amazon Resource Name (ARN) of the flow that the version belongs to.
	//
	// This member is required.
	Arn *string

	// The time at the version was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The unique identifier of the flow.
	//
	// This member is required.
	Id *string

	// The status of the flow.
	//
	// This member is required.
	Status FlowStatus

	// The version of the flow.
	//
	// This member is required.
	Version *string
	// contains filtered or unexported fields
}

Contains information about a version of a flow.

This data type is used in the following API operations:

ListFlowVersions response

type Function added in v1.7.0 

type Function struct {

	// A name for the function.
	//
	// This member is required.
	Name *string

	// A description of the function and its purpose.
	Description *string

	// The parameters that the agent elicits from the user to fulfill the function.
	Parameters map[string]ParameterDetail

	// Contains information if user confirmation is required to invoke the function.
	RequireConfirmation RequireConfirmation
	// contains filtered or unexported fields
}

Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.

This data type is used in the following API operations:

CreateAgentActionGroup request

CreateAgentActionGroup response

UpdateAgentActionGroup request

UpdateAgentActionGroup response

GetAgentActionGroup response

type FunctionSchema added in v1.7.0 

type FunctionSchema interface {
	// contains filtered or unexported methods
}

Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

This data type is used in the following API operations:

CreateAgentActionGroup request

CreateAgentActionGroup response

UpdateAgentActionGroup request

UpdateAgentActionGroup response

GetAgentActionGroup response

The following types satisfy this interface: 

FunctionSchemaMemberFunctions
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.FunctionSchema
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.FunctionSchemaMemberFunctions:
		_ = v.Value // Value is []types.Function

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type FunctionSchemaMemberFunctions added in v1.7.0 

type FunctionSchemaMemberFunctions struct {
	Value []Function
	// contains filtered or unexported fields
}

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

type GuardrailConfiguration added in v1.11.0 

type GuardrailConfiguration struct {

	// The unique identifier of the guardrail.
	GuardrailIdentifier *string

	// The version of the guardrail.
	GuardrailVersion *string
	// contains filtered or unexported fields
}

Details about a guardrail associated with a resource.

type HierarchicalChunkingConfiguration added in v1.15.0 

type HierarchicalChunkingConfiguration struct {

	// Token settings for each layer.
	//
	// This member is required.
	LevelConfigurations []HierarchicalChunkingLevelConfiguration

	// The number of tokens to repeat across chunks in the same layer.
	//
	// This member is required.
	OverlapTokens *int32
	// contains filtered or unexported fields
}

Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

You configure the number of tokens to overlap, or repeat across adjacent chunks. For example, if you set overlap tokens to 60, the last 60 tokens in the first chunk are also included at the beginning of the second chunk. For each layer, you must also configure the maximum number of tokens in a chunk.

type HierarchicalChunkingLevelConfiguration added in v1.15.0 

type HierarchicalChunkingLevelConfiguration struct {

	// The maximum number of tokens that a chunk can contain in this layer.
	//
	// This member is required.
	MaxTokens *int32
	// contains filtered or unexported fields
}

Token settings for a layer in a hierarchical chunking configuration.

type IncompatibleConnectionDataTypeFlowValidationDetails added in v1.27.0 

type IncompatibleConnectionDataTypeFlowValidationDetails struct {

	// The name of the connection with incompatible data types.
	//
	// This member is required.
	Connection *string
	// contains filtered or unexported fields
}

Details about incompatible data types in a connection between nodes.

type InferenceConfiguration 

type InferenceConfiguration struct {

	// The maximum number of tokens to allow in the generated response.
	MaximumLength *int32

	// A list of stop sequences. A stop sequence is a sequence of characters that
	// causes the model to stop generating the response.
	StopSequences []string

	// The likelihood of the model selecting higher-probability options while
	// generating a response. A lower value makes the model more likely to choose
	// higher-probability options, while a higher value makes the model more likely to
	// choose lower-probability options.
	Temperature *float32

	// While generating a response, the model determines the probability of the
	// following token at each point of generation. The value that you set for topK is
	// the number of most-likely candidates from which the model chooses the next token
	// in the sequence. For example, if you set topK to 50, the model selects the next
	// token from among the top 50 most likely choices.
	TopK *int32

	// While generating a response, the model determines the probability of the
	// following token at each point of generation. The value that you set for Top P
	// determines the number of most-likely candidates from which the model chooses the
	// next token in the sequence. For example, if you set topP to 80, the model only
	// selects the next token from the top 80% of the probability distribution of next
	// tokens.
	TopP *float32
	// contains filtered or unexported fields
}

Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType . For more information, see Inference parameters for foundation models.

type IngestionJob 

type IngestionJob struct {

	// The unique identifier of the data source for the data ingestion job.
	//
	// This member is required.
	DataSourceId *string

	// The unique identifier of the data ingestion job.
	//
	// This member is required.
	IngestionJobId *string

	// The unique identifier of the knowledge for the data ingestion job.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The time the data ingestion job started.
	//
	// If you stop a data ingestion job, the startedAt time is the time the job was
	// started before the job was stopped.
	//
	// This member is required.
	StartedAt *time.Time

	// The status of the data ingestion job.
	//
	// This member is required.
	Status IngestionJobStatus

	// The time the data ingestion job was last updated.
	//
	// If you stop a data ingestion job, the updatedAt time is the time the job was
	// stopped.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The description of the data ingestion job.
	Description *string

	// A list of reasons that the data ingestion job failed.
	FailureReasons []string

	// Contains statistics about the data ingestion job.
	Statistics *IngestionJobStatistics
	// contains filtered or unexported fields
}

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.

This data type is used in the following API operations:

StartIngestionJob response

GetIngestionJob response

ListIngestionJob response

type IngestionJobFilter 

type IngestionJobFilter struct {

	// The name of field or attribute to apply the filter.
	//
	// This member is required.
	Attribute IngestionJobFilterAttribute

	// The operation to apply to the field or attribute.
	//
	// This member is required.
	Operator IngestionJobFilterOperator

	// A list of values that belong to the field or attribute.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

The definition of a filter to filter the data.

type IngestionJobFilterAttribute 

type IngestionJobFilterAttribute string
const (
	IngestionJobFilterAttributeStatus IngestionJobFilterAttribute = "STATUS"
)

Enum values for IngestionJobFilterAttribute

func (IngestionJobFilterAttribute) Values 

func (IngestionJobFilterAttribute) Values() []IngestionJobFilterAttribute

Values returns all known values for IngestionJobFilterAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IngestionJobFilterOperator 

type IngestionJobFilterOperator string
const (
	IngestionJobFilterOperatorEq IngestionJobFilterOperator = "EQ"
)

Enum values for IngestionJobFilterOperator

func (IngestionJobFilterOperator) Values 

func (IngestionJobFilterOperator) Values() []IngestionJobFilterOperator

Values returns all known values for IngestionJobFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IngestionJobSortBy 

type IngestionJobSortBy struct {

	// The name of field or attribute to apply sorting of data.
	//
	// This member is required.
	Attribute IngestionJobSortByAttribute

	// The order for sorting the data.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

The parameters of sorting the data.

type IngestionJobSortByAttribute 

type IngestionJobSortByAttribute string
const (
	IngestionJobSortByAttributeStatus    IngestionJobSortByAttribute = "STATUS"
	IngestionJobSortByAttributeStartedAt IngestionJobSortByAttribute = "STARTED_AT"
)

Enum values for IngestionJobSortByAttribute

func (IngestionJobSortByAttribute) Values 

func (IngestionJobSortByAttribute) Values() []IngestionJobSortByAttribute

Values returns all known values for IngestionJobSortByAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IngestionJobStatistics 

type IngestionJobStatistics struct {

	// The number of source documents that were deleted.
	NumberOfDocumentsDeleted int64

	// The number of source documents that failed to be ingested.
	NumberOfDocumentsFailed int64

	// The total number of source documents that were scanned. Includes new, updated,
	// and unchanged documents.
	NumberOfDocumentsScanned int64

	// The number of metadata files that were updated or deleted.
	NumberOfMetadataDocumentsModified int64

	// The total number of metadata files that were scanned. Includes new, updated,
	// and unchanged files.
	NumberOfMetadataDocumentsScanned int64

	// The number of modified source documents in the data source that were
	// successfully indexed.
	NumberOfModifiedDocumentsIndexed int64

	// The number of new source documents in the data source that were successfully
	// indexed.
	NumberOfNewDocumentsIndexed int64
	// contains filtered or unexported fields
}

Contains the statistics for the data ingestion job.

type IngestionJobStatus 

type IngestionJobStatus string
const (
	IngestionJobStatusStarting   IngestionJobStatus = "STARTING"
	IngestionJobStatusInProgress IngestionJobStatus = "IN_PROGRESS"
	IngestionJobStatusComplete   IngestionJobStatus = "COMPLETE"
	IngestionJobStatusFailed     IngestionJobStatus = "FAILED"
	IngestionJobStatusStopping   IngestionJobStatus = "STOPPING"
	IngestionJobStatusStopped    IngestionJobStatus = "STOPPED"
)

Enum values for IngestionJobStatus

func (IngestionJobStatus) Values 

func (IngestionJobStatus) Values() []IngestionJobStatus

Values returns all known values for IngestionJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IngestionJobSummary 

type IngestionJobSummary struct {

	// The unique identifier of the data source for the data ingestion job.
	//
	// This member is required.
	DataSourceId *string

	// The unique identifier of the data ingestion job.
	//
	// This member is required.
	IngestionJobId *string

	// The unique identifier of the knowledge base for the data ingestion job.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The time the data ingestion job started.
	//
	// This member is required.
	StartedAt *time.Time

	// The status of the data ingestion job.
	//
	// This member is required.
	Status IngestionJobStatus

	// The time the data ingestion job was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The description of the data ingestion job.
	Description *string

	// Contains statistics for the data ingestion job.
	Statistics *IngestionJobStatistics
	// contains filtered or unexported fields
}

Contains details about a data ingestion job.

type InputFlowNodeConfiguration added in v1.15.0 

type InputFlowNodeConfiguration struct {
	// contains filtered or unexported fields
}

Contains configurations for the input flow node for a flow. This node takes the input from flow invocation and passes it to the next node in the data type that you specify.

type IntermediateStorage added in v1.15.0 

type IntermediateStorage struct {

	// An S3 bucket path.
	//
	// This member is required.
	S3Location *S3Location
	// contains filtered or unexported fields
}

A location for storing content from data sources temporarily as it is processed by custom components in the ingestion pipeline.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An internal server error occurred. Retry your request.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type IteratorFlowNodeConfiguration added in v1.15.0 

type IteratorFlowNodeConfiguration struct {
	// contains filtered or unexported fields
}

Contains configurations for an iterator node in a 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.

type KnowledgeBase 

type KnowledgeBase struct {

	// The time the knowledge base was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// Contains details about the embeddings configuration of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseConfiguration *KnowledgeBaseConfiguration

	// The unique identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The name of the knowledge base.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API
	// operations on the knowledge base.
	//
	// This member is required.
	RoleArn *string

	// The status of the knowledge base. The following statuses are possible:
	//
	//   - CREATING – The knowledge base is being created.
	//
	//   - ACTIVE – The knowledge base is ready to be queried.
	//
	//   - DELETING – The knowledge base is being deleted.
	//
	//   - UPDATING – The knowledge base is being updated.
	//
	//   - FAILED – The knowledge base API operation failed.
	//
	// This member is required.
	Status KnowledgeBaseStatus

	// Contains details about the storage configuration of the knowledge base.
	//
	// This member is required.
	StorageConfiguration *StorageConfiguration

	// The time the knowledge base was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The description of the knowledge base.
	Description *string

	// A list of reasons that the API operation on the knowledge base failed.
	FailureReasons []string
	// contains filtered or unexported fields
}

Contains information about a knowledge base.

type KnowledgeBaseConfiguration 

type KnowledgeBaseConfiguration struct {

	// The type of data that the data source is converted into for the knowledge base.
	//
	// This member is required.
	Type KnowledgeBaseType

	// Contains details about the model that's used to convert the data source into
	// vector embeddings.
	VectorKnowledgeBaseConfiguration *VectorKnowledgeBaseConfiguration
	// contains filtered or unexported fields
}

Contains details about the vector embeddings configuration of the knowledge base.

type KnowledgeBaseFlowNodeConfiguration added in v1.15.0 

type KnowledgeBaseFlowNodeConfiguration struct {

	// The unique identifier of the knowledge base to query.
	//
	// This member is required.
	KnowledgeBaseId *string

	// Contains configurations for a guardrail to apply during query and response
	// generation for the knowledge base in this configuration.
	GuardrailConfiguration *GuardrailConfiguration

	// The unique identifier of the model or [inference profile] to use to generate a response from the
	// query results. Omit this field if you want to return the retrieved results as an
	// array.
	//
	// [inference profile]: https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html
	ModelId *string
	// contains filtered or unexported fields
}

Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in Amazon Bedrock worksin the Amazon Bedrock User Guide.

type KnowledgeBaseState 

type KnowledgeBaseState string
const (
	KnowledgeBaseStateEnabled  KnowledgeBaseState = "ENABLED"
	KnowledgeBaseStateDisabled KnowledgeBaseState = "DISABLED"
)

Enum values for KnowledgeBaseState

func (KnowledgeBaseState) Values 

func (KnowledgeBaseState) Values() []KnowledgeBaseState

Values returns all known values for KnowledgeBaseState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type KnowledgeBaseStatus 

type KnowledgeBaseStatus string
const (
	KnowledgeBaseStatusCreating           KnowledgeBaseStatus = "CREATING"
	KnowledgeBaseStatusActive             KnowledgeBaseStatus = "ACTIVE"
	KnowledgeBaseStatusDeleting           KnowledgeBaseStatus = "DELETING"
	KnowledgeBaseStatusUpdating           KnowledgeBaseStatus = "UPDATING"
	KnowledgeBaseStatusFailed             KnowledgeBaseStatus = "FAILED"
	KnowledgeBaseStatusDeleteUnsuccessful KnowledgeBaseStatus = "DELETE_UNSUCCESSFUL"
)

Enum values for KnowledgeBaseStatus

func (KnowledgeBaseStatus) Values 

func (KnowledgeBaseStatus) Values() []KnowledgeBaseStatus

Values returns all known values for KnowledgeBaseStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type KnowledgeBaseStorageType 

type KnowledgeBaseStorageType string
const (
	KnowledgeBaseStorageTypeOpensearchServerless KnowledgeBaseStorageType = "OPENSEARCH_SERVERLESS"
	KnowledgeBaseStorageTypePinecone             KnowledgeBaseStorageType = "PINECONE"
	KnowledgeBaseStorageTypeRedisEnterpriseCloud KnowledgeBaseStorageType = "REDIS_ENTERPRISE_CLOUD"
	KnowledgeBaseStorageTypeRds                  KnowledgeBaseStorageType = "RDS"
	KnowledgeBaseStorageTypeMongoDbAtlas         KnowledgeBaseStorageType = "MONGO_DB_ATLAS"
)

Enum values for KnowledgeBaseStorageType

func (KnowledgeBaseStorageType) Values 

func (KnowledgeBaseStorageType) Values() []KnowledgeBaseStorageType

Values returns all known values for KnowledgeBaseStorageType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type KnowledgeBaseSummary 

type KnowledgeBaseSummary struct {

	// The unique identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The name of the knowledge base.
	//
	// This member is required.
	Name *string

	// The status of the knowledge base.
	//
	// This member is required.
	Status KnowledgeBaseStatus

	// The time the knowledge base was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The description of the knowledge base.
	Description *string
	// contains filtered or unexported fields
}

Contains details about a knowledge base.

type KnowledgeBaseType 

type KnowledgeBaseType string
const (
	KnowledgeBaseTypeVector KnowledgeBaseType = "VECTOR"
)

Enum values for KnowledgeBaseType

func (KnowledgeBaseType) Values 

func (KnowledgeBaseType) Values() []KnowledgeBaseType

Values returns all known values for KnowledgeBaseType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LambdaFunctionFlowNodeConfiguration added in v1.15.0 

type LambdaFunctionFlowNodeConfiguration struct {

	// The Amazon Resource Name (ARN) of the Lambda function to invoke.
	//
	// This member is required.
	LambdaArn *string
	// contains filtered or unexported fields
}

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 Node types in Amazon Bedrock worksin the Amazon Bedrock User Guide.

type LexFlowNodeConfiguration added in v1.15.0 

type LexFlowNodeConfiguration struct {

	// The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.
	//
	// This member is required.
	BotAliasArn *string

	// The Region to invoke the Amazon Lex bot in.
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.

type MalformedConditionExpressionFlowValidationDetails added in v1.27.0 

type MalformedConditionExpressionFlowValidationDetails struct {

	// The error message describing why the condition expression is malformed.
	//
	// This member is required.
	Cause *string

	// The name of the malformed condition.
	//
	// This member is required.
	Condition *string

	// The name of the node containing the malformed condition expression.
	//
	// This member is required.
	Node *string
	// contains filtered or unexported fields
}

Details about a malformed condition expression in a node.

type MalformedNodeInputExpressionFlowValidationDetails added in v1.27.0 

type MalformedNodeInputExpressionFlowValidationDetails struct {

	// The error message describing why the input expression is malformed.
	//
	// This member is required.
	Cause *string

	// The name of the input with the malformed expression.
	//
	// This member is required.
	Input *string

	// The name of the node containing the malformed input expression.
	//
	// This member is required.
	Node *string
	// contains filtered or unexported fields
}

Details about a malformed input expression in a node.

type MemoryConfiguration added in v1.15.0 

type MemoryConfiguration struct {

	// The type of memory that is stored.
	//
	// This member is required.
	EnabledMemoryTypes []MemoryType

	// The number of days the agent is configured to retain the conversational context.
	StorageDays *int32
	// contains filtered or unexported fields
}

Details of the memory configuration.

type MemoryType added in v1.15.0 

type MemoryType string
const (
	MemoryTypeSessionSummary MemoryType = "SESSION_SUMMARY"
)

Enum values for MemoryType

func (MemoryType) Values added in v1.15.0 

func (MemoryType) Values() []MemoryType

Values returns all known values for MemoryType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Message added in v1.27.0 

type Message struct {

	// The content in the message.
	//
	// This member is required.
	Content []ContentBlock

	// The role that the message belongs to.
	//
	// This member is required.
	Role ConversationRole
	// contains filtered or unexported fields
}

A message input or response from a model. For more information, see Create a prompt using Prompt management.

type MismatchedNodeInputTypeFlowValidationDetails added in v1.27.0 

type MismatchedNodeInputTypeFlowValidationDetails struct {

	// The expected data type for the node input.
	//
	// This member is required.
	ExpectedType FlowNodeIODataType

	// The name of the input with the mismatched data type.
	//
	// This member is required.
	Input *string

	// The name of the node containing the input with the mismatched data type.
	//
	// This member is required.
	Node *string
	// contains filtered or unexported fields
}

Details about mismatched input data types in a node.

type MismatchedNodeOutputTypeFlowValidationDetails added in v1.27.0 

type MismatchedNodeOutputTypeFlowValidationDetails struct {

	// The expected data type for the node output.
	//
	// This member is required.
	ExpectedType FlowNodeIODataType

	// The name of the node containing the output with the mismatched data type.
	//
	// This member is required.
	Node *string

	// The name of the output with the mismatched data type.
	//
	// This member is required.
	Output *string
	// contains filtered or unexported fields
}

Details about mismatched output data types in a node.

type MissingConnectionConfigurationFlowValidationDetails added in v1.27.0 

type MissingConnectionConfigurationFlowValidationDetails struct {

	// The name of the connection missing configuration.
	//
	// This member is required.
	Connection *string
	// contains filtered or unexported fields
}

Details about a connection missing required configuration.

type MissingDefaultConditionFlowValidationDetails added in v1.27.0 

type MissingDefaultConditionFlowValidationDetails struct {

	// The name of the node missing the default condition.
	//
	// This member is required.
	Node *string
	// contains filtered or unexported fields
}

Details about a missing default condition in a conditional node.

type MissingEndingNodesFlowValidationDetails added in v1.27.0 

type MissingEndingNodesFlowValidationDetails struct {
	// contains filtered or unexported fields
}

Details about missing ending nodes (such as FlowOutputNode) in the flow.

type MissingNodeConfigurationFlowValidationDetails added in v1.27.0 

type MissingNodeConfigurationFlowValidationDetails struct {

	// The name of the node missing configuration.
	//
	// This member is required.
	Node *string
	// contains filtered or unexported fields
}

Details about a node missing required configuration.

type MissingNodeInputFlowValidationDetails added in v1.27.0 

type MissingNodeInputFlowValidationDetails struct {

	// The name of the missing input.
	//
	// This member is required.
	Input *string

	// The name of the node missing the required input.
	//
	// This member is required.
	Node *string
	// contains filtered or unexported fields
}

Details about a missing required input in a node.

type MissingNodeOutputFlowValidationDetails added in v1.27.0 

type MissingNodeOutputFlowValidationDetails struct {

	// The name of the node missing the required output.
	//
	// This member is required.
	Node *string

	// The name of the missing output.
	//
	// This member is required.
	Output *string
	// contains filtered or unexported fields
}

Details about a missing required output in a node.

type MissingStartingNodesFlowValidationDetails added in v1.27.0 

type MissingStartingNodesFlowValidationDetails struct {
	// contains filtered or unexported fields
}

Details about missing starting nodes (such as FlowInputNode) in the flow.

type MongoDbAtlasConfiguration added in v1.9.0 

type MongoDbAtlasConfiguration struct {

	// The collection name of the knowledge base in MongoDB Atlas.
	//
	// This member is required.
	CollectionName *string

	// The Amazon Resource Name (ARN) of the secret that you created in Secrets
	// Manager that contains user credentials for your MongoDB Atlas cluster.
	//
	// This member is required.
	CredentialsSecretArn *string

	// The database name in your MongoDB Atlas cluster for your knowledge base.
	//
	// This member is required.
	DatabaseName *string

	// The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
	//
	// This member is required.
	Endpoint *string

	// Contains the names of the fields to which to map information about the vector
	// store.
	//
	// This member is required.
	FieldMapping *MongoDbAtlasFieldMapping

	// The name of the MongoDB Atlas vector search index.
	//
	// This member is required.
	VectorIndexName *string

	// The name of the VPC endpoint service in your account that is connected to your
	// MongoDB Atlas cluster.
	EndpointServiceName *string
	// contains filtered or unexported fields
}

Contains details about the storage configuration of the knowledge base in MongoDB Atlas.

type MongoDbAtlasFieldMapping added in v1.9.0 

type MongoDbAtlasFieldMapping struct {

	// The name of the field in which Amazon Bedrock stores metadata about the vector
	// store.
	//
	// This member is required.
	MetadataField *string

	// 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.
	//
	// This member is required.
	TextField *string

	// The name of the field in which Amazon Bedrock stores the vector embeddings for
	// your data sources.
	//
	// This member is required.
	VectorField *string
	// contains filtered or unexported fields
}

Contains the names of the fields to which to map information about the vector store.

type MultipleNodeInputConnectionsFlowValidationDetails added in v1.27.0 

type MultipleNodeInputConnectionsFlowValidationDetails struct {

	// The name of the input with multiple connections to it.
	//
	// This member is required.
	Input *string

	// The name of the node containing the input with multiple connections.
	//
	// This member is required.
	Node *string
	// contains filtered or unexported fields
}

Details about multiple connections to a single node input.

type OpenSearchServerlessConfiguration 

type OpenSearchServerlessConfiguration struct {

	// The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
	//
	// This member is required.
	CollectionArn *string

	// Contains the names of the fields to which to map information about the vector
	// store.
	//
	// This member is required.
	FieldMapping *OpenSearchServerlessFieldMapping

	// The name of the vector store.
	//
	// This member is required.
	VectorIndexName *string
	// contains filtered or unexported fields
}

Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.

type OpenSearchServerlessFieldMapping 

type OpenSearchServerlessFieldMapping struct {

	// The name of the field in which Amazon Bedrock stores metadata about the vector
	// store.
	//
	// This member is required.
	MetadataField *string

	// 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.
	//
	// This member is required.
	TextField *string

	// The name of the field in which Amazon Bedrock stores the vector embeddings for
	// your data sources.
	//
	// This member is required.
	VectorField *string
	// contains filtered or unexported fields
}

Contains the names of the fields to which to map information about the vector store.

type OrchestrationExecutor added in v1.28.0 

type OrchestrationExecutor interface {
	// contains filtered or unexported methods
}
Contains details about the Lambda function containing the orchestration logic

carried out upon invoking the custom orchestration.

The following types satisfy this interface: 

OrchestrationExecutorMemberLambda
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.OrchestrationExecutor
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.OrchestrationExecutorMemberLambda:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type OrchestrationExecutorMemberLambda added in v1.28.0 

type OrchestrationExecutorMemberLambda struct {
	Value string
	// contains filtered or unexported fields
}
The Amazon Resource Name (ARN) of the Lambda function containing the business

logic that is carried out upon invoking the action.

type OrchestrationType added in v1.28.0 

type OrchestrationType string
const (
	OrchestrationTypeDefault             OrchestrationType = "DEFAULT"
	OrchestrationTypeCustomOrchestration OrchestrationType = "CUSTOM_ORCHESTRATION"
)

Enum values for OrchestrationType

func (OrchestrationType) Values added in v1.28.0 

func (OrchestrationType) Values() []OrchestrationType

Values returns all known values for OrchestrationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OutputFlowNodeConfiguration added in v1.15.0 

type OutputFlowNodeConfiguration struct {
	// contains filtered or unexported fields
}

Contains configurations for an output flow node in the flow. You specify the data type expected for the input into the node in the type field and how to return the final output in the expression field.

type ParameterDetail added in v1.7.0 

type ParameterDetail struct {

	// The data type of the parameter.
	//
	// This member is required.
	Type Type

	// A description of the parameter. Helps the foundation model determine how to
	// elicit the parameters from the user.
	Description *string

	// Whether the parameter is required for the agent to complete the function for
	// action group invocation.
	Required *bool
	// contains filtered or unexported fields
}

Contains details about a parameter in a function for an action group.

This data type is used in the following API operations:

CreateAgentActionGroup request

CreateAgentActionGroup response

UpdateAgentActionGroup request

UpdateAgentActionGroup response

GetAgentActionGroup response

type ParsingConfiguration added in v1.15.0 

type ParsingConfiguration struct {

	// The parsing strategy for the data source.
	//
	// This member is required.
	ParsingStrategy ParsingStrategy

	// Settings for a foundation model used to parse documents for a data source.
	BedrockFoundationModelConfiguration *BedrockFoundationModelConfiguration
	// contains filtered or unexported fields
}

Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.

To use a model to parse PDF documents, set the parsing strategy to BEDROCK_FOUNDATION_MODEL and specify the model or inference profile to use by ARN. You can also override the default parsing prompt with instructions for how to interpret images and tables in your documents. The following models are supported.

  • Anthropic Claude 3 Sonnet - anthropic.claude-3-sonnet-20240229-v1:0

  • Anthropic Claude 3 Haiku - anthropic.claude-3-haiku-20240307-v1:0

You can get the ARN of a model with the ListFoundationModels action. Standard model usage charges apply for the foundation model parsing strategy.

type ParsingPrompt added in v1.15.0 

type ParsingPrompt struct {

	// Instructions for interpreting the contents of a document.
	//
	// This member is required.
	ParsingPromptText *string
	// contains filtered or unexported fields
}

Instructions for interpreting the contents of a document.

type ParsingStrategy added in v1.15.0 

type ParsingStrategy string
const (
	ParsingStrategyBedrockFoundationModel ParsingStrategy = "BEDROCK_FOUNDATION_MODEL"
)

Enum values for ParsingStrategy

func (ParsingStrategy) Values added in v1.15.0 

func (ParsingStrategy) Values() []ParsingStrategy

Values returns all known values for ParsingStrategy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PatternObjectFilter added in v1.15.0 

type PatternObjectFilter struct {

	// The supported object type or content type of the data source.
	//
	// This member is required.
	ObjectType *string

	// A list of one or more exclusion regular expression patterns to exclude certain
	// object types that adhere to the pattern. If you specify an inclusion and
	// exclusion filter/pattern and both match a document, the exclusion filter takes
	// precedence and the document isn’t crawled.
	ExclusionFilters []string

	// A list of one or more inclusion regular expression patterns to include certain
	// object types that adhere to the pattern. If you specify an inclusion and
	// exclusion filter/pattern and both match a document, the exclusion filter takes
	// precedence and the document isn’t crawled.
	InclusionFilters []string
	// contains filtered or unexported fields
}

The specific filters applied to your data source content. You can filter out or include certain content.

type PatternObjectFilterConfiguration added in v1.15.0 

type PatternObjectFilterConfiguration struct {

	// The configuration of specific filters applied to your data source content. You
	// can filter out or include certain content.
	//
	// This member is required.
	Filters []PatternObjectFilter
	// contains filtered or unexported fields
}

The configuration of filtering certain objects or content types of the data source.

type PineconeConfiguration 

type PineconeConfiguration struct {

	// The endpoint URL for your index management page.
	//
	// This member is required.
	ConnectionString *string

	// The Amazon Resource Name (ARN) of the secret that you created in Secrets
	// Manager that is linked to your Pinecone API key.
	//
	// This member is required.
	CredentialsSecretArn *string

	// Contains the names of the fields to which to map information about the vector
	// store.
	//
	// This member is required.
	FieldMapping *PineconeFieldMapping

	// The namespace to be used to write new data to your database.
	Namespace *string
	// contains filtered or unexported fields
}

Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.

type PineconeFieldMapping 

type PineconeFieldMapping struct {

	// The name of the field in which Amazon Bedrock stores metadata about the vector
	// store.
	//
	// This member is required.
	MetadataField *string

	// 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.
	//
	// This member is required.
	TextField *string
	// contains filtered or unexported fields
}

Contains the names of the fields to which to map information about the vector store.

type PromptAgentResource added in v1.27.0 

type PromptAgentResource struct {

	// The ARN of the agent with which to use the prompt.
	//
	// This member is required.
	AgentIdentifier *string
	// contains filtered or unexported fields
}

Contains specifications for an Amazon Bedrock agent with which to use the prompt. For more information, see Create a prompt using Prompt managementand Automate tasks in your application using conversational agents.

type PromptConfiguration 

type PromptConfiguration struct {

	// Defines the prompt template with which to replace the default prompt template.
	// You can use placeholder variables in the base prompt template to customize the
	// prompt. For more information, see [Prompt template placeholder variables]. For more information, see [Configure the prompt templates].
	//
	// [Configure the prompt templates]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html
	// [Prompt template placeholder variables]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html
	BasePromptTemplate *string

	// Contains inference parameters to use when the agent invokes a foundation model
	// in the part of the agent sequence defined by the promptType . For more
	// information, see [Inference parameters for foundation models].
	//
	// [Inference parameters for foundation models]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html
	InferenceConfiguration *InferenceConfiguration

	// Specifies whether to override the default parser Lambda function when parsing
	// the raw foundation model output in the part of the agent sequence defined by the
	// promptType . If you set the field as OVERRIDEN , the overrideLambda field in
	// the [PromptOverrideConfiguration]must be specified with the ARN of a Lambda function.
	//
	// [PromptOverrideConfiguration]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html
	ParserMode CreationMode

	// Specifies whether to override the default prompt template for this promptType .
	// Set this value to OVERRIDDEN to use the prompt that you provide in the
	// basePromptTemplate . If you leave it as DEFAULT , the agent uses a default
	// prompt template.
	PromptCreationMode CreationMode

	// Specifies whether to allow the agent to carry out the step specified in the
	// promptType . If you set this value to DISABLED , the agent skips that step. The
	// default state for each promptType is as follows.
	//
	//   - PRE_PROCESSING – ENABLED
	//
	//   - ORCHESTRATION – ENABLED
	//
	//   - KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
	//
	//   - POST_PROCESSING – DISABLED
	PromptState PromptState

	// The step in the agent sequence that this prompt configuration applies to.
	PromptType PromptType
	// contains filtered or unexported fields
}

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

type PromptFlowNodeConfiguration added in v1.15.0 

type PromptFlowNodeConfiguration struct {

	// Specifies whether the prompt is from Prompt management or defined inline.
	//
	// This member is required.
	SourceConfiguration PromptFlowNodeSourceConfiguration

	// Contains configurations for a guardrail to apply to the prompt in this node and
	// the response generated from it.
	GuardrailConfiguration *GuardrailConfiguration
	// contains filtered or unexported fields
}

Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in Amazon Bedrock worksin the Amazon Bedrock User Guide.

type PromptFlowNodeInlineConfiguration added in v1.15.0 

type PromptFlowNodeInlineConfiguration struct {

	// The unique identifier of the model or [inference profile] to run inference with.
	//
	// [inference profile]: https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html
	//
	// This member is required.
	ModelId *string

	// Contains a prompt and variables in the prompt that can be replaced with values
	// at runtime.
	//
	// This member is required.
	TemplateConfiguration PromptTemplateConfiguration

	// The type of prompt template.
	//
	// This member is required.
	TemplateType PromptTemplateType

	// Additional fields to be included in the model request for the Prompt node.
	AdditionalModelRequestFields document.Interface

	// Contains inference configurations for the prompt.
	InferenceConfiguration PromptInferenceConfiguration
	// contains filtered or unexported fields
}

Contains configurations for a prompt defined inline in the node.

type PromptFlowNodeResourceConfiguration added in v1.15.0 

type PromptFlowNodeResourceConfiguration struct {

	// The Amazon Resource Name (ARN) of the prompt from Prompt management.
	//
	// This member is required.
	PromptArn *string
	// contains filtered or unexported fields
}

Contains configurations for a prompt from Prompt management to use in a node.

type PromptFlowNodeSourceConfiguration added in v1.15.0 

type PromptFlowNodeSourceConfiguration interface {
	// contains filtered or unexported methods
}

Contains configurations for a prompt and whether it is from Prompt management or defined inline.

The following types satisfy this interface: 

PromptFlowNodeSourceConfigurationMemberInline
PromptFlowNodeSourceConfigurationMemberResource
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.PromptFlowNodeSourceConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.PromptFlowNodeSourceConfigurationMemberInline:
		_ = v.Value // Value is types.PromptFlowNodeInlineConfiguration

	case *types.PromptFlowNodeSourceConfigurationMemberResource:
		_ = v.Value // Value is types.PromptFlowNodeResourceConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type PromptFlowNodeSourceConfigurationMemberInline added in v1.15.0 

type PromptFlowNodeSourceConfigurationMemberInline struct {
	Value PromptFlowNodeInlineConfiguration
	// contains filtered or unexported fields
}

Contains configurations for a prompt that is defined inline

type PromptFlowNodeSourceConfigurationMemberResource added in v1.15.0 

type PromptFlowNodeSourceConfigurationMemberResource struct {
	Value PromptFlowNodeResourceConfiguration
	// contains filtered or unexported fields
}

Contains configurations for a prompt from Prompt management.

type PromptGenAiResource added in v1.27.0 

type PromptGenAiResource interface {
	// contains filtered or unexported methods
}

Contains specifications for a generative AI resource with which to use the prompt. For more information, see Create a prompt using Prompt management.

The following types satisfy this interface: 

PromptGenAiResourceMemberAgent
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.PromptGenAiResource
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.PromptGenAiResourceMemberAgent:
		_ = v.Value // Value is types.PromptAgentResource

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type PromptGenAiResourceMemberAgent added in v1.27.0 

type PromptGenAiResourceMemberAgent struct {
	Value PromptAgentResource
	// contains filtered or unexported fields
}

Specifies an Amazon Bedrock agent with which to use the prompt.

type PromptInferenceConfiguration added in v1.15.0 

type PromptInferenceConfiguration interface {
	// contains filtered or unexported methods
}

Contains inference configurations for the prompt.

The following types satisfy this interface: 

PromptInferenceConfigurationMemberText
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.PromptInferenceConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.PromptInferenceConfigurationMemberText:
		_ = v.Value // Value is types.PromptModelInferenceConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type PromptInferenceConfigurationMemberText added in v1.15.0 

type PromptInferenceConfigurationMemberText struct {
	Value PromptModelInferenceConfiguration
	// contains filtered or unexported fields
}

Contains inference configurations for a text prompt.

type PromptInputVariable added in v1.15.0 

type PromptInputVariable struct {

	// The name of the variable.
	Name *string
	// contains filtered or unexported fields
}

Contains information about a variable in the prompt.

type PromptMetadataEntry added in v1.18.0 

type PromptMetadataEntry struct {

	// The key of a metadata tag for a prompt variant.
	//
	// This member is required.
	Key *string

	// The value of a metadata tag for a prompt variant.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management.

type PromptModelInferenceConfiguration added in v1.15.0 

type PromptModelInferenceConfiguration struct {

	// The maximum number of tokens to return in the response.
	MaxTokens *int32

	// A list of strings that define sequences after which the model will stop
	// generating.
	StopSequences []string

	// Controls the randomness of the response. Choose a lower value for more
	// predictable outputs and a higher value for more surprising outputs.
	Temperature *float32

	// The percentage of most-likely candidates that the model considers for the next
	// token.
	TopP *float32
	// contains filtered or unexported fields
}

Contains inference configurations related to model inference for a prompt. For more information, see Inference parameters.

type PromptOverrideConfiguration 

type PromptOverrideConfiguration struct {

	// Contains configurations to override a prompt template in one part of an agent
	// sequence. For more information, see [Advanced prompts].
	//
	// [Advanced prompts]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
	//
	// This member is required.
	PromptConfigurations []PromptConfiguration

	// The ARN of the Lambda function to use when parsing the raw foundation model
	// output in parts of the agent sequence. If you specify this field, at least one
	// of the promptConfigurations must contain a parserMode value that is set to
	// OVERRIDDEN . For more information, see [Parser Lambda function in Amazon Bedrock Agents].
	//
	// [Parser Lambda function in Amazon Bedrock Agents]: https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html
	OverrideLambda *string
	// contains filtered or unexported fields
}

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

type PromptState 

type PromptState string
const (
	PromptStateEnabled  PromptState = "ENABLED"
	PromptStateDisabled PromptState = "DISABLED"
)

Enum values for PromptState

func (PromptState) Values 

func (PromptState) Values() []PromptState

Values returns all known values for PromptState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PromptSummary added in v1.15.0 

type PromptSummary struct {

	// The Amazon Resource Name (ARN) of the prompt or the prompt version (if you
	// specified a version in the request).
	//
	// This member is required.
	Arn *string

	// The time at which the prompt was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The unique identifier of the prompt.
	//
	// This member is required.
	Id *string

	// The name of the prompt.
	//
	// This member is required.
	Name *string

	// The time at which the prompt was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The version of the prompt that this summary applies to.
	//
	// This member is required.
	Version *string

	// The description of the prompt.
	Description *string
	// contains filtered or unexported fields
}

Contains information about a prompt in your Prompt management tool.

This data type is used in the following API operations:

ListPrompts response

type PromptTemplateConfiguration added in v1.15.0 

type PromptTemplateConfiguration interface {
	// contains filtered or unexported methods
}

Contains the message for a prompt. For more information, see Construct and store reusable prompts with Prompt management in Amazon Bedrock.

The following types satisfy this interface: 

PromptTemplateConfigurationMemberChat
PromptTemplateConfigurationMemberText
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.PromptTemplateConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.PromptTemplateConfigurationMemberChat:
		_ = v.Value // Value is types.ChatPromptTemplateConfiguration

	case *types.PromptTemplateConfigurationMemberText:
		_ = v.Value // Value is types.TextPromptTemplateConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type PromptTemplateConfigurationMemberChat added in v1.27.0 

type PromptTemplateConfigurationMemberChat struct {
	Value ChatPromptTemplateConfiguration
	// contains filtered or unexported fields
}

Contains configurations to use the prompt in a conversational format.

type PromptTemplateConfigurationMemberText added in v1.15.0 

type PromptTemplateConfigurationMemberText struct {
	Value TextPromptTemplateConfiguration
	// contains filtered or unexported fields
}

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

type PromptTemplateType added in v1.15.0 

type PromptTemplateType string
const (
	PromptTemplateTypeText PromptTemplateType = "TEXT"
	PromptTemplateTypeChat PromptTemplateType = "CHAT"
)

Enum values for PromptTemplateType

func (PromptTemplateType) Values added in v1.15.0 

func (PromptTemplateType) Values() []PromptTemplateType

Values returns all known values for PromptTemplateType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PromptType 

type PromptType string
const (
	PromptTypePreProcessing                   PromptType = "PRE_PROCESSING"
	PromptTypeOrchestration                   PromptType = "ORCHESTRATION"
	PromptTypePostProcessing                  PromptType = "POST_PROCESSING"
	PromptTypeKnowledgeBaseResponseGeneration PromptType = "KNOWLEDGE_BASE_RESPONSE_GENERATION"
)

Enum values for PromptType

func (PromptType) Values 

func (PromptType) Values() []PromptType

Values returns all known values for PromptType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PromptVariant added in v1.15.0 

type PromptVariant struct {

	// The name of the prompt variant.
	//
	// This member is required.
	Name *string

	// Contains configurations for the prompt template.
	//
	// This member is required.
	TemplateConfiguration PromptTemplateConfiguration

	// The type of prompt template to use.
	//
	// This member is required.
	TemplateType PromptTemplateType

	// Contains model-specific inference configurations that aren't in the
	// inferenceConfiguration field. To see model-specific inference parameters, see [Inference request parameters and response fields for foundation models].
	//
	// [Inference request parameters and response fields for foundation models]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html
	AdditionalModelRequestFields document.Interface

	// Specifies a generative AI resource with which to use the prompt.
	GenAiResource PromptGenAiResource

	// Contains inference configurations for the prompt variant.
	InferenceConfiguration PromptInferenceConfiguration

	// An array of objects, each containing a key-value pair that defines a metadata
	// tag and value to attach to a prompt variant.
	Metadata []PromptMetadataEntry

	// The unique identifier of the model or [inference profile] with which to run inference on the
	// prompt.
	//
	// [inference profile]: https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html
	ModelId *string
	// contains filtered or unexported fields
}

Contains details about a variant of the prompt.

type RdsConfiguration added in v1.2.0 

type RdsConfiguration struct {

	// The Amazon Resource Name (ARN) of the secret that you created in Secrets
	// Manager that is linked to your Amazon RDS database.
	//
	// This member is required.
	CredentialsSecretArn *string

	// The name of your Amazon RDS database.
	//
	// This member is required.
	DatabaseName *string

	// Contains the names of the fields to which to map information about the vector
	// store.
	//
	// This member is required.
	FieldMapping *RdsFieldMapping

	// The Amazon Resource Name (ARN) of the vector store.
	//
	// This member is required.
	ResourceArn *string

	// The name of the table in the database.
	//
	// This member is required.
	TableName *string
	// contains filtered or unexported fields
}

Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.

type RdsFieldMapping added in v1.2.0 

type RdsFieldMapping struct {

	// The name of the field in which Amazon Bedrock stores metadata about the vector
	// store.
	//
	// This member is required.
	MetadataField *string

	// The name of the field in which Amazon Bedrock stores the ID for each entry.
	//
	// This member is required.
	PrimaryKeyField *string

	// 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.
	//
	// This member is required.
	TextField *string

	// The name of the field in which Amazon Bedrock stores the vector embeddings for
	// your data sources.
	//
	// This member is required.
	VectorField *string
	// contains filtered or unexported fields
}

Contains the names of the fields to which to map information about the vector store.

type RedisEnterpriseCloudConfiguration 

type RedisEnterpriseCloudConfiguration struct {

	// The Amazon Resource Name (ARN) of the secret that you created in Secrets
	// Manager that is linked to your Redis Enterprise Cloud database.
	//
	// This member is required.
	CredentialsSecretArn *string

	// The endpoint URL of the Redis Enterprise Cloud database.
	//
	// This member is required.
	Endpoint *string

	// Contains the names of the fields to which to map information about the vector
	// store.
	//
	// This member is required.
	FieldMapping *RedisEnterpriseCloudFieldMapping

	// The name of the vector index.
	//
	// This member is required.
	VectorIndexName *string
	// contains filtered or unexported fields
}

Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.

type RedisEnterpriseCloudFieldMapping 

type RedisEnterpriseCloudFieldMapping struct {

	// The name of the field in which Amazon Bedrock stores metadata about the vector
	// store.
	//
	// This member is required.
	MetadataField *string

	// 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.
	//
	// This member is required.
	TextField *string

	// The name of the field in which Amazon Bedrock stores the vector embeddings for
	// your data sources.
	//
	// This member is required.
	VectorField *string
	// contains filtered or unexported fields
}

Contains the names of the fields to which to map information about the vector store.

type RequireConfirmation added in v1.17.0 

type RequireConfirmation string
const (
	RequireConfirmationEnabled  RequireConfirmation = "ENABLED"
	RequireConfirmationDisabled RequireConfirmation = "DISABLED"
)

Enum values for RequireConfirmation

func (RequireConfirmation) Values added in v1.17.0 

func (RequireConfirmation) Values() []RequireConfirmation

Values returns all known values for RequireConfirmation. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type RetrievalFlowNodeConfiguration added in v1.15.0 

type RetrievalFlowNodeConfiguration struct {

	// Contains configurations for the service to use for retrieving data to return as
	// the output from the node.
	//
	// This member is required.
	ServiceConfiguration RetrievalFlowNodeServiceConfiguration
	// contains filtered or unexported fields
}

Contains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output.

type RetrievalFlowNodeS3Configuration added in v1.15.0 

type RetrievalFlowNodeS3Configuration struct {

	// The name of the Amazon S3 bucket from which to retrieve data.
	//
	// This member is required.
	BucketName *string
	// contains filtered or unexported fields
}

Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.

type RetrievalFlowNodeServiceConfiguration added in v1.15.0 

type RetrievalFlowNodeServiceConfiguration interface {
	// contains filtered or unexported methods
}

Contains configurations for the service to use for retrieving data to return as the output from the node.

The following types satisfy this interface: 

RetrievalFlowNodeServiceConfigurationMemberS3
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.RetrievalFlowNodeServiceConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.RetrievalFlowNodeServiceConfigurationMemberS3:
		_ = v.Value // Value is types.RetrievalFlowNodeS3Configuration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type RetrievalFlowNodeServiceConfigurationMemberS3 added in v1.15.0 

type RetrievalFlowNodeServiceConfigurationMemberS3 struct {
	Value RetrievalFlowNodeS3Configuration
	// contains filtered or unexported fields
}

Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.

type S3DataSourceConfiguration 

type S3DataSourceConfiguration struct {

	// The Amazon Resource Name (ARN) of the S3 bucket that contains your data.
	//
	// This member is required.
	BucketArn *string

	// The account ID for the owner of the S3 bucket.
	BucketOwnerAccountId *string

	// A list of S3 prefixes to include certain files or content. For more
	// information, see [Organizing objects using prefixes].
	//
	// [Organizing objects using prefixes]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html
	InclusionPrefixes []string
	// contains filtered or unexported fields
}

The configuration information to connect to Amazon S3 as your data source.

type S3Identifier 

type S3Identifier struct {

	// The name of the S3 bucket.
	S3BucketName *string

	// The S3 object key for the S3 resource.
	S3ObjectKey *string
	// contains filtered or unexported fields
}

The identifier information for an Amazon S3 bucket.

type S3Location added in v1.15.0 

type S3Location struct {

	// The location's URI. For example, s3://my-bucket/chunk-processor/ .
	//
	// This member is required.
	Uri *string
	// contains filtered or unexported fields
}

An Amazon S3 location.

type SalesforceAuthType added in v1.15.0 

type SalesforceAuthType string
const (
	SalesforceAuthTypeOauth2ClientCredentials SalesforceAuthType = "OAUTH2_CLIENT_CREDENTIALS"
)

Enum values for SalesforceAuthType

func (SalesforceAuthType) Values added in v1.15.0 

func (SalesforceAuthType) Values() []SalesforceAuthType

Values returns all known values for SalesforceAuthType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SalesforceCrawlerConfiguration added in v1.15.0 

type SalesforceCrawlerConfiguration struct {

	// The configuration of filtering the Salesforce content. For example, configuring
	// regular expression patterns to include or exclude certain content.
	FilterConfiguration *CrawlFilterConfiguration
	// contains filtered or unexported fields
}

The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.

type SalesforceDataSourceConfiguration added in v1.15.0 

type SalesforceDataSourceConfiguration struct {

	// The endpoint information to connect to your Salesforce data source.
	//
	// This member is required.
	SourceConfiguration *SalesforceSourceConfiguration

	// The configuration of the Salesforce content. For example, configuring specific
	// types of Salesforce content.
	CrawlerConfiguration *SalesforceCrawlerConfiguration
	// contains filtered or unexported fields
}

The configuration information to connect to Salesforce as your data source.

type SalesforceSourceConfiguration added in v1.15.0 

type SalesforceSourceConfiguration struct {

	// The supported authentication type to authenticate and connect to your
	// Salesforce instance.
	//
	// This member is required.
	AuthType SalesforceAuthType

	// The Amazon Resource Name of an Secrets Manager secret that stores your
	// authentication credentials for your Salesforce instance URL. For more
	// information on the key-value pairs that must be included in your secret,
	// depending on your authentication type, see [Salesforce connection configuration].
	//
	// [Salesforce connection configuration]: https://docs.aws.amazon.com/bedrock/latest/userguide/salesforce-data-source-connector.html#configuration-salesforce-connector
	//
	// This member is required.
	CredentialsSecretArn *string

	// The Salesforce host URL or instance URL.
	//
	// This member is required.
	HostUrl *string
	// contains filtered or unexported fields
}

The endpoint information to connect to your Salesforce data source.

type SeedUrl added in v1.15.0 

type SeedUrl struct {

	// A seed or starting point URL.
	Url *string
	// contains filtered or unexported fields
}

The seed or starting point URL. You should be authorized to crawl the URL.

type SemanticChunkingConfiguration added in v1.15.0 

type SemanticChunkingConfiguration struct {

	// The dissimilarity threshold for splitting chunks.
	//
	// This member is required.
	BreakpointPercentileThreshold *int32

	// The buffer size.
	//
	// This member is required.
	BufferSize *int32

	// The maximum number of tokens that a chunk can contain.
	//
	// This member is required.
	MaxTokens *int32
	// contains filtered or unexported fields
}

Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.

With semantic chunking, each sentence is compared to the next to determine how similar they are. You specify a threshold in the form of a percentile, where adjacent sentences that are less similar than that percentage of sentence pairs are divided into separate chunks. For example, if you set the threshold to 90, then the 10 percent of sentence pairs that are least similar are split. So if you have 101 sentences, 100 sentence pairs are compared, and the 10 with the least similarity are split, creating 11 chunks. These chunks are further split if they exceed the max token size.

You must also specify a buffer size, which determines whether sentences are compared in isolation, or within a moving context window that includes the previous and following sentence. For example, if you set the buffer size to 1 , the embedding for sentence 10 is derived from sentences 9, 10, and 11 combined.

type ServerSideEncryptionConfiguration 

type ServerSideEncryptionConfiguration struct {

	// The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
	KmsKeyArn *string
	// contains filtered or unexported fields
}

Contains the configuration for server-side encryption.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The number of requests exceeds the service quota. Resubmit your request later.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SharePointAuthType added in v1.15.0 

type SharePointAuthType string
const (
	SharePointAuthTypeOauth2ClientCredentials SharePointAuthType = "OAUTH2_CLIENT_CREDENTIALS"
)

Enum values for SharePointAuthType

func (SharePointAuthType) Values added in v1.15.0 

func (SharePointAuthType) Values() []SharePointAuthType

Values returns all known values for SharePointAuthType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SharePointCrawlerConfiguration added in v1.15.0 

type SharePointCrawlerConfiguration struct {

	// The configuration of filtering the SharePoint content. For example, configuring
	// regular expression patterns to include or exclude certain content.
	FilterConfiguration *CrawlFilterConfiguration
	// contains filtered or unexported fields
}

The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.

type SharePointDataSourceConfiguration added in v1.15.0 

type SharePointDataSourceConfiguration struct {

	// The endpoint information to connect to your SharePoint data source.
	//
	// This member is required.
	SourceConfiguration *SharePointSourceConfiguration

	// The configuration of the SharePoint content. For example, configuring specific
	// types of SharePoint content.
	CrawlerConfiguration *SharePointCrawlerConfiguration
	// contains filtered or unexported fields
}

The configuration information to connect to SharePoint as your data source.

type SharePointHostType added in v1.15.0 

type SharePointHostType string
const (
	SharePointHostTypeOnline SharePointHostType = "ONLINE"
)

Enum values for SharePointHostType

func (SharePointHostType) Values added in v1.15.0 

func (SharePointHostType) Values() []SharePointHostType

Values returns all known values for SharePointHostType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SharePointSourceConfiguration added in v1.15.0 

type SharePointSourceConfiguration struct {

	// The supported authentication type to authenticate and connect to your
	// SharePoint site/sites.
	//
	// This member is required.
	AuthType SharePointAuthType

	// The Amazon Resource Name of an Secrets Manager secret that stores your
	// authentication credentials for your SharePoint site/sites. For more information
	// on the key-value pairs that must be included in your secret, depending on your
	// authentication type, see [SharePoint connection configuration].
	//
	// [SharePoint connection configuration]: https://docs.aws.amazon.com/bedrock/latest/userguide/sharepoint-data-source-connector.html#configuration-sharepoint-connector
	//
	// This member is required.
	CredentialsSecretArn *string

	// The domain of your SharePoint instance or site URL/URLs.
	//
	// This member is required.
	Domain *string

	// The supported host type, whether online/cloud or server/on-premises.
	//
	// This member is required.
	HostType SharePointHostType

	// A list of one or more SharePoint site URLs.
	//
	// This member is required.
	SiteUrls []string

	// The identifier of your Microsoft 365 tenant.
	TenantId *string
	// contains filtered or unexported fields
}

The endpoint information to connect to your SharePoint data source.

type SortOrder 

type SortOrder string
const (
	SortOrderAscending  SortOrder = "ASCENDING"
	SortOrderDescending SortOrder = "DESCENDING"
)

Enum values for SortOrder

func (SortOrder) Values 

func (SortOrder) Values() []SortOrder

Values returns all known values for SortOrder. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SpecificToolChoice added in v1.27.0 

type SpecificToolChoice struct {

	// The name of the tool.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

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 Use a tool to complete an Amazon Bedrock model response.

type StepType added in v1.15.0 

type StepType string
const (
	StepTypePostChunking StepType = "POST_CHUNKING"
)

Enum values for StepType

func (StepType) Values added in v1.15.0 

func (StepType) Values() []StepType

Values returns all known values for StepType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StorageConfiguration 

type StorageConfiguration struct {

	// The vector store service in which the knowledge base is stored.
	//
	// This member is required.
	Type KnowledgeBaseStorageType

	// Contains the storage configuration of the knowledge base in MongoDB Atlas.
	MongoDbAtlasConfiguration *MongoDbAtlasConfiguration

	// Contains the storage configuration of the knowledge base in Amazon OpenSearch
	// Service.
	OpensearchServerlessConfiguration *OpenSearchServerlessConfiguration

	// Contains the storage configuration of the knowledge base in Pinecone.
	PineconeConfiguration *PineconeConfiguration

	// Contains details about the storage configuration of the knowledge base in
	// Amazon RDS. For more information, see [Create a vector index in Amazon RDS].
	//
	// [Create a vector index in Amazon RDS]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html
	RdsConfiguration *RdsConfiguration

	// Contains the storage configuration of the knowledge base in Redis Enterprise
	// Cloud.
	RedisEnterpriseCloudConfiguration *RedisEnterpriseCloudConfiguration
	// contains filtered or unexported fields
}

Contains the storage configuration of the knowledge base.

type StorageFlowNodeConfiguration added in v1.15.0 

type StorageFlowNodeConfiguration struct {

	// Contains configurations for the service to use for storing the input into the
	// node.
	//
	// This member is required.
	ServiceConfiguration StorageFlowNodeServiceConfiguration
	// contains filtered or unexported fields
}

Contains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify.

type StorageFlowNodeS3Configuration added in v1.15.0 

type StorageFlowNodeS3Configuration struct {

	// The name of the Amazon S3 bucket in which to store the input into the node.
	//
	// This member is required.
	BucketName *string
	// contains filtered or unexported fields
}

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

type StorageFlowNodeServiceConfiguration added in v1.15.0 

type StorageFlowNodeServiceConfiguration interface {
	// contains filtered or unexported methods
}

Contains configurations for the service to use for storing the input into the node.

The following types satisfy this interface: 

StorageFlowNodeServiceConfigurationMemberS3
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.StorageFlowNodeServiceConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.StorageFlowNodeServiceConfigurationMemberS3:
		_ = v.Value // Value is types.StorageFlowNodeS3Configuration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type StorageFlowNodeServiceConfigurationMemberS3 added in v1.15.0 

type StorageFlowNodeServiceConfigurationMemberS3 struct {
	Value StorageFlowNodeS3Configuration
	// contains filtered or unexported fields
}

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

type SystemContentBlock added in v1.27.0 

type SystemContentBlock interface {
	// contains filtered or unexported methods
}

Contains a system prompt to provide context to the model or to describe how it should behave. For more information, see Create a prompt using Prompt management.

The following types satisfy this interface: 

SystemContentBlockMemberText
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.SystemContentBlock
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SystemContentBlockMemberText:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type SystemContentBlockMemberText added in v1.27.0 

type SystemContentBlockMemberText struct {
	Value string
	// contains filtered or unexported fields
}

The text in the system prompt.

type TextPromptTemplateConfiguration added in v1.15.0 

type TextPromptTemplateConfiguration struct {

	// The message for the prompt.
	//
	// This member is required.
	Text *string

	// An array of the variables in the prompt template.
	InputVariables []PromptInputVariable
	// contains filtered or unexported fields
}

Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in {{variable}} .

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The number of requests exceeds the limit. Resubmit your request later.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type Tool added in v1.27.0 

type Tool interface {
	// contains filtered or unexported methods
}

Contains configurations for a tool that a model can use when generating a response. For more information, see Use a tool to complete an Amazon Bedrock model response.

The following types satisfy this interface: 

ToolMemberToolSpec
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.Tool
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ToolMemberToolSpec:
		_ = v.Value // Value is types.ToolSpecification

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ToolChoice added in v1.27.0 

type ToolChoice interface {
	// contains filtered or unexported methods
}

Defines which tools the model should request when invoked. For more information, see Use a tool to complete an Amazon Bedrock model response.

The following types satisfy this interface: 

ToolChoiceMemberAny
ToolChoiceMemberAuto
ToolChoiceMemberTool
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.ToolChoice
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ToolChoiceMemberAny:
		_ = v.Value // Value is types.AnyToolChoice

	case *types.ToolChoiceMemberAuto:
		_ = v.Value // Value is types.AutoToolChoice

	case *types.ToolChoiceMemberTool:
		_ = v.Value // Value is types.SpecificToolChoice

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ToolChoiceMemberAny added in v1.27.0 

type ToolChoiceMemberAny struct {
	Value AnyToolChoice
	// contains filtered or unexported fields
}

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.

type ToolChoiceMemberAuto added in v1.27.0 

type ToolChoiceMemberAuto struct {
	Value AutoToolChoice
	// contains filtered or unexported fields
}

Defines tools. The model automatically decides whether to call a tool or to generate text instead.

type ToolChoiceMemberTool added in v1.27.0 

type ToolChoiceMemberTool struct {
	Value SpecificToolChoice
	// contains filtered or unexported fields
}

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.

type ToolConfiguration added in v1.27.0 

type ToolConfiguration struct {

	// An array of tools to pass to a model.
	//
	// This member is required.
	Tools []Tool

	// Defines which tools the model should request when invoked.
	ToolChoice ToolChoice
	// contains filtered or unexported fields
}

Configuration information for the tools that the model can use when generating a response. For more information, see Use a tool to complete an Amazon Bedrock model response.

type ToolInputSchema added in v1.27.0 

type ToolInputSchema interface {
	// contains filtered or unexported methods
}

The input schema for the tool. For more information, see Use a tool to complete an Amazon Bedrock model response.

The following types satisfy this interface: 

ToolInputSchemaMemberJson
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/bedrockagent/types"
)

func main() {
	var union types.ToolInputSchema
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ToolInputSchemaMemberJson:
		_ = v.Value // Value is document.Interface

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ToolInputSchemaMemberJson added in v1.27.0 

type ToolInputSchemaMemberJson struct {
	Value document.Interface
	// contains filtered or unexported fields
}

A JSON object defining the input schema for the tool.

type ToolMemberToolSpec added in v1.27.0 

type ToolMemberToolSpec struct {
	Value ToolSpecification
	// contains filtered or unexported fields
}

The specification for the tool.

type ToolSpecification added in v1.27.0 

type ToolSpecification struct {

	// The input schema for the tool.
	//
	// This member is required.
	InputSchema ToolInputSchema

	// The name of the tool.
	//
	// This member is required.
	Name *string

	// The description of the tool.
	Description *string
	// contains filtered or unexported fields
}

Contains a specification for a tool. For more information, see Use a tool to complete an Amazon Bedrock model response.

type Transformation added in v1.15.0 

type Transformation struct {

	// When the service applies the transformation.
	//
	// This member is required.
	StepToApply StepType

	// A Lambda function that processes documents.
	//
	// This member is required.
	TransformationFunction *TransformationFunction
	// contains filtered or unexported fields
}

A custom processing step for documents moving through a data source ingestion pipeline. To process documents after they have been converted into chunks, set the step to apply to POST_CHUNKING .

type TransformationFunction added in v1.15.0 

type TransformationFunction struct {

	// The Lambda function.
	//
	// This member is required.
	TransformationLambdaConfiguration *TransformationLambdaConfiguration
	// contains filtered or unexported fields
}

A Lambda function that processes documents.

type TransformationLambdaConfiguration added in v1.15.0 

type TransformationLambdaConfiguration struct {

	// The function's ARN identifier.
	//
	// This member is required.
	LambdaArn *string
	// contains filtered or unexported fields
}

A Lambda function that processes documents.

type Type added in v1.7.0 

type Type string
const (
	TypeString  Type = "string"
	TypeNumber  Type = "number"
	TypeInteger Type = "integer"
	TypeBoolean Type = "boolean"
	TypeArray   Type = "array"
)

Enum values for Type

func (Type) Values added in v1.7.0 

func (Type) Values() []Type

Values returns all known values for Type. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UnfulfilledNodeInputFlowValidationDetails added in v1.27.0 

type UnfulfilledNodeInputFlowValidationDetails struct {

	// The name of the unfulfilled input. An input is unfulfilled if there are no data
	// connections to it.
	//
	// This member is required.
	Input *string

	// The name of the node containing the unfulfilled input.
	//
	// This member is required.
	Node *string
	// contains filtered or unexported fields
}

Details about an unfulfilled node input with no valid connections.

type UnknownConnectionConditionFlowValidationDetails added in v1.27.0 

type UnknownConnectionConditionFlowValidationDetails struct {

	// The name of the connection with the unknown condition.
	//
	// This member is required.
	Connection *string
	// contains filtered or unexported fields
}

Details about an unknown condition for a connection.

type UnknownConnectionSourceFlowValidationDetails added in v1.27.0 

type UnknownConnectionSourceFlowValidationDetails struct {

	// The name of the connection with the unknown source.
	//
	// This member is required.
	Connection *string
	// contains filtered or unexported fields
}

Details about an unknown source node for a connection.

type UnknownConnectionSourceOutputFlowValidationDetails added in v1.27.0 

type UnknownConnectionSourceOutputFlowValidationDetails struct {

	// The name of the connection with the unknown source output.
	//
	// This member is required.
	Connection *string
	// contains filtered or unexported fields
}

Details about an unknown source output for a connection.

type UnknownConnectionTargetFlowValidationDetails added in v1.27.0 

type UnknownConnectionTargetFlowValidationDetails struct {

	// The name of the connection with the unknown target.
	//
	// This member is required.
	Connection *string
	// contains filtered or unexported fields
}

Details about an unknown target node for a connection.

type UnknownConnectionTargetInputFlowValidationDetails added in v1.27.0 

type UnknownConnectionTargetInputFlowValidationDetails struct {

	// The name of the connection with the unknown target input.
	//
	// This member is required.
	Connection *string
	// contains filtered or unexported fields
}

Details about an unknown target input for a connection.

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UnreachableNodeFlowValidationDetails added in v1.27.0 

type UnreachableNodeFlowValidationDetails struct {

	// The name of the unreachable node.
	//
	// This member is required.
	Node *string
	// contains filtered or unexported fields
}

Details about an unreachable node in the flow. A node is unreachable when there are no paths to it from any starting node.

type UnsatisfiedConnectionConditionsFlowValidationDetails added in v1.27.0 

type UnsatisfiedConnectionConditionsFlowValidationDetails struct {

	// The name of the connection with unsatisfied conditions.
	//
	// This member is required.
	Connection *string
	// contains filtered or unexported fields
}

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.

type UnspecifiedFlowValidationDetails added in v1.27.0 

type UnspecifiedFlowValidationDetails struct {
	// contains filtered or unexported fields
}

Details about an unspecified validation that doesn't fit other categories.

type UrlConfiguration added in v1.15.0 

type UrlConfiguration struct {

	// One or more seed or starting point URLs.
	SeedUrls []SeedUrl
	// contains filtered or unexported fields
}

The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	FieldList []ValidationExceptionField
	// contains filtered or unexported fields
}

Input validation failed. Check your request parameters and retry the request.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField 

type ValidationExceptionField struct {

	// A message describing why this field failed validation.
	//
	// This member is required.
	Message *string

	// The name of the field.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Stores information about a field passed inside a request that resulted in an validation error.

type VectorIngestionConfiguration 

type VectorIngestionConfiguration struct {

	// Details about how to chunk the documents in the data source. A chunk refers to
	// an excerpt from a data source that is returned when the knowledge base that it
	// belongs to is queried.
	ChunkingConfiguration *ChunkingConfiguration

	// A custom document transformer for parsed data source documents.
	CustomTransformationConfiguration *CustomTransformationConfiguration

	// A custom parser for data source documents.
	ParsingConfiguration *ParsingConfiguration
	// contains filtered or unexported fields
}

Contains details about how to ingest the documents in a data source.

type VectorKnowledgeBaseConfiguration 

type VectorKnowledgeBaseConfiguration struct {

	// The Amazon Resource Name (ARN) of the model or inference profile used to create
	// vector embeddings for the knowledge base.
	//
	// This member is required.
	EmbeddingModelArn *string

	// The embeddings model configuration details for the vector model used in
	// Knowledge Base.
	EmbeddingModelConfiguration *EmbeddingModelConfiguration
	// contains filtered or unexported fields
}

Contains details about the model used to create vector embeddings for the knowledge base.

type WebCrawlerConfiguration added in v1.15.0 

type WebCrawlerConfiguration struct {

	// The configuration of crawl limits for the web URLs.
	CrawlerLimits *WebCrawlerLimits

	// A list of one or more exclusion regular expression patterns to exclude certain
	// URLs. If you specify an inclusion and exclusion filter/pattern and both match a
	// URL, the exclusion filter takes precedence and the web content of the URL isn’t
	// crawled.
	ExclusionFilters []string

	// A list of one or more inclusion regular expression patterns to include certain
	// URLs. If you specify an inclusion and exclusion filter/pattern and both match a
	// URL, the exclusion filter takes precedence and the web content of the URL isn’t
	// crawled.
	InclusionFilters []string

	// The scope of what is crawled for your URLs.
	//
	// You can choose to crawl only web pages that belong to the same host or primary
	// domain. For example, only web pages that contain the seed URL
	// "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains.
	// You can choose to include sub domains in addition to the host or primary domain.
	// For example, web pages that contain "aws.amazon.com" can also include sub domain
	// "docs.aws.amazon.com".
	Scope WebScopeType
	// contains filtered or unexported fields
}

The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.

type WebCrawlerLimits added in v1.15.0 

type WebCrawlerLimits struct {

	// The max rate at which pages are crawled, up to 300 per minute per host.
	RateLimit *int32
	// contains filtered or unexported fields
}

The rate limits for the URLs that you want to crawl. You should be authorized to crawl the URLs.

type WebDataSourceConfiguration added in v1.15.0 

type WebDataSourceConfiguration struct {

	// The source configuration details for the web data source.
	//
	// This member is required.
	SourceConfiguration *WebSourceConfiguration

	// The Web Crawler configuration details for the web data source.
	CrawlerConfiguration *WebCrawlerConfiguration
	// contains filtered or unexported fields
}

The configuration details for the web data source.

type WebScopeType added in v1.15.0 

type WebScopeType string
const (
	WebScopeTypeHostOnly   WebScopeType = "HOST_ONLY"
	WebScopeTypeSubdomains WebScopeType = "SUBDOMAINS"
)

Enum values for WebScopeType

func (WebScopeType) Values added in v1.15.0 

func (WebScopeType) Values() []WebScopeType

Values returns all known values for WebScopeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WebSourceConfiguration added in v1.15.0 

type WebSourceConfiguration struct {

	// The configuration of the URL/URLs.
	//
	// This member is required.
	UrlConfiguration *UrlConfiguration
	// contains filtered or unexported fields
}

The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.