types

package
v1.3.2 Latest Latest
Warning

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

 Go to latest Published: Feb 21, 2024 License: Apache-2.0 Imports: 4 Imported by: 1

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 information about the API Schema for the Action Group

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
}

String OpenAPI Payload

type APISchemaMemberS3 

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

The identifier for the S3 resource.

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

This exception is thrown when a request is denied per 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
}

Type of Executors for an Action Group

The following types satisfy this interface: 

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.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 ActionGroupExecutorMemberLambda 

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

ARN of a Lambda.

type ActionGroupSignature 

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

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 {

	// Identifier for a resource.
	//
	// This member is required.
	ActionGroupId *string

	// Name for a resource.
	//
	// This member is required.
	ActionGroupName *string

	// State of the action group
	//
	// This member is required.
	ActionGroupState ActionGroupState

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Description of the Resource.
	Description *string
	// contains filtered or unexported fields
}

ActionGroup Summary

type Agent 

type Agent struct {

	// Arn representation of the Agent.
	//
	// This member is required.
	AgentArn *string

	// Identifier for a resource.
	//
	// This member is required.
	AgentId *string

	// Name for a resource.
	//
	// This member is required.
	AgentName *string

	// ARN of a IAM role.
	//
	// This member is required.
	AgentResourceRoleArn *string

	// Schema Type for Action APIs.
	//
	// This member is required.
	AgentStatus AgentStatus

	// Draft Agent Version.
	//
	// This member is required.
	AgentVersion *string

	// Time Stamp.
	//
	// This member is required.
	CreatedAt *time.Time

	// Max Session Time.
	//
	// This member is required.
	IdleSessionTTLInSeconds *int32

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Client specified token used for idempotency checks
	ClientToken *string

	// A KMS key ARN
	CustomerEncryptionKeyArn *string

	// Description of the Resource.
	Description *string

	// Failure Reasons for Error.
	FailureReasons []string

	// ARN or name of a Bedrock model.
	FoundationModel *string

	// Instruction for the agent.
	Instruction *string

	// Time Stamp.
	PreparedAt *time.Time

	// Configuration for prompt override.
	PromptOverrideConfiguration *PromptOverrideConfiguration

	// The recommended actions users can take to resolve an error in failureReasons.
	RecommendedActions []string
	// contains filtered or unexported fields
}

Contains the information of an agent

type AgentActionGroup 

type AgentActionGroup struct {

	// Identifier for a resource.
	//
	// This member is required.
	ActionGroupId *string

	// Name for a resource.
	//
	// This member is required.
	ActionGroupName *string

	// State of the action group
	//
	// This member is required.
	ActionGroupState ActionGroupState

	// Identifier for a resource.
	//
	// This member is required.
	AgentId *string

	// Agent Version.
	//
	// This member is required.
	AgentVersion *string

	// Time Stamp.
	//
	// This member is required.
	CreatedAt *time.Time

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Type of Executors for an Action Group
	ActionGroupExecutor ActionGroupExecutor

	// Contains information about the API Schema for the Action Group
	ApiSchema APISchema

	// Client specified token used for idempotency checks
	ClientToken *string

	// Description of the Resource.
	Description *string

	// Action Group Signature for a BuiltIn Action
	ParentActionSignature ActionGroupSignature
	// contains filtered or unexported fields
}

Contains the information of an Agent Action Group

type AgentAlias 

type AgentAlias struct {

	// Arn representation of the Agent Alias.
	//
	// This member is required.
	AgentAliasArn *string

	// Id for an Agent Alias generated at the server side.
	//
	// This member is required.
	AgentAliasId *string

	// Name for a resource.
	//
	// This member is required.
	AgentAliasName *string

	// The statuses an Agent Alias can be in.
	//
	// This member is required.
	AgentAliasStatus AgentAliasStatus

	// Identifier for a resource.
	//
	// This member is required.
	AgentId *string

	// Time Stamp.
	//
	// This member is required.
	CreatedAt *time.Time

	// Routing configuration for an Agent alias.
	//
	// This member is required.
	RoutingConfiguration []AgentAliasRoutingConfigurationListItem

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The list of history events for an alias for an Agent.
	AgentAliasHistoryEvents []AgentAliasHistoryEvent

	// Client specified token used for idempotency checks
	ClientToken *string

	// Description of the Resource.
	Description *string
	// contains filtered or unexported fields
}

Contains the information of an agent alias

type AgentAliasHistoryEvent 

type AgentAliasHistoryEvent struct {

	// Time Stamp.
	EndDate *time.Time

	// Routing configuration for an Agent alias.
	RoutingConfiguration []AgentAliasRoutingConfigurationListItem

	// Time Stamp.
	StartDate *time.Time
	// contains filtered or unexported fields
}

History event for an alias for an Agent.

type AgentAliasRoutingConfigurationListItem 

type AgentAliasRoutingConfigurationListItem struct {

	// Agent Version.
	//
	// This member is required.
	AgentVersion *string
	// contains filtered or unexported fields
}

Details about the routing configuration for an Agent 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 {

	// Id for an Agent Alias generated at the server side.
	//
	// This member is required.
	AgentAliasId *string

	// Name for a resource.
	//
	// This member is required.
	AgentAliasName *string

	// The statuses an Agent Alias can be in.
	//
	// This member is required.
	AgentAliasStatus AgentAliasStatus

	// Time Stamp.
	//
	// This member is required.
	CreatedAt *time.Time

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Description of the Resource.
	Description *string

	// Routing configuration for an Agent alias.
	RoutingConfiguration []AgentAliasRoutingConfigurationListItem
	// contains filtered or unexported fields
}

Summary of an alias for an Agent.

type AgentKnowledgeBase 

type AgentKnowledgeBase struct {

	// Identifier for a resource.
	//
	// This member is required.
	AgentId *string

	// Agent Version.
	//
	// This member is required.
	AgentVersion *string

	// Time Stamp.
	//
	// This member is required.
	CreatedAt *time.Time

	// Description of the Resource.
	//
	// This member is required.
	Description *string

	// Identifier for a resource.
	//
	// This member is required.
	KnowledgeBaseId *string

	// State of the knowledge base; whether it is enabled or disabled
	//
	// This member is required.
	KnowledgeBaseState KnowledgeBaseState

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Contains the information of an Agent Knowledge Base.

type AgentKnowledgeBaseSummary 

type AgentKnowledgeBaseSummary struct {

	// Identifier for a resource.
	//
	// This member is required.
	KnowledgeBaseId *string

	// State of the knowledge base; whether it is enabled or disabled
	//
	// This member is required.
	KnowledgeBaseState KnowledgeBaseState

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Description of the Resource.
	Description *string
	// contains filtered or unexported fields
}

Agent Knowledge Base Summary

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 {

	// Identifier for a resource.
	//
	// This member is required.
	AgentId *string

	// Name for a resource.
	//
	// This member is required.
	AgentName *string

	// Schema Type for Action APIs.
	//
	// This member is required.
	AgentStatus AgentStatus

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Description of the Resource.
	Description *string

	// Agent Version.
	LatestAgentVersion *string
	// contains filtered or unexported fields
}

Summary of Agent.

type AgentVersion 

type AgentVersion struct {

	// Arn representation of the Agent.
	//
	// This member is required.
	AgentArn *string

	// Identifier for a resource.
	//
	// This member is required.
	AgentId *string

	// Name for a resource.
	//
	// This member is required.
	AgentName *string

	// ARN of a IAM role.
	//
	// This member is required.
	AgentResourceRoleArn *string

	// Schema Type for Action APIs.
	//
	// This member is required.
	AgentStatus AgentStatus

	// Time Stamp.
	//
	// This member is required.
	CreatedAt *time.Time

	// Max Session Time.
	//
	// This member is required.
	IdleSessionTTLInSeconds *int32

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Numerical Agent Version.
	//
	// This member is required.
	Version *string

	// A KMS key ARN
	CustomerEncryptionKeyArn *string

	// Description of the Resource.
	Description *string

	// Failure Reasons for Error.
	FailureReasons []string

	// ARN or name of a Bedrock model.
	FoundationModel *string

	// Instruction for the agent.
	Instruction *string

	// Configuration for prompt override.
	PromptOverrideConfiguration *PromptOverrideConfiguration

	// The recommended actions users can take to resolve an error in failureReasons.
	RecommendedActions []string
	// contains filtered or unexported fields
}

Contains the information of an agent version.

type AgentVersionSummary 

type AgentVersionSummary struct {

	// Name for a resource.
	//
	// This member is required.
	AgentName *string

	// Schema Type for Action APIs.
	//
	// This member is required.
	AgentStatus AgentStatus

	// Agent Version.
	//
	// This member is required.
	AgentVersion *string

	// Time Stamp.
	//
	// This member is required.
	CreatedAt *time.Time

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Description of the Resource.
	Description *string
	// contains filtered or unexported fields
}

Summary of agent version.

type ChunkingConfiguration 

type ChunkingConfiguration struct {

	// The type of chunking strategy
	//
	// This member is required.
	ChunkingStrategy ChunkingStrategy

	// Configures fixed size chunking strategy
	FixedSizeChunkingConfiguration *FixedSizeChunkingConfiguration
	// contains filtered or unexported fields
}

Configures chunking strategy

type ChunkingStrategy 

type ChunkingStrategy string
const (
	ChunkingStrategyFixedSize ChunkingStrategy = "FIXED_SIZE"
	ChunkingStrategyNone      ChunkingStrategy = "NONE"
)

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 ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

This exception is thrown when there is 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 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 DataSource 

type DataSource struct {

	// Time Stamp.
	//
	// This member is required.
	CreatedAt *time.Time

	// Specifies a raw data source location to ingest.
	//
	// This member is required.
	DataSourceConfiguration *DataSourceConfiguration

	// Identifier for a resource.
	//
	// This member is required.
	DataSourceId *string

	// Identifier for a resource.
	//
	// This member is required.
	KnowledgeBaseId *string

	// Name for a resource.
	//
	// This member is required.
	Name *string

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

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Description of the Resource.
	Description *string

	// Server-side encryption configuration.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

	// Configures ingestion for a vector knowledge base
	VectorIngestionConfiguration *VectorIngestionConfiguration
	// contains filtered or unexported fields
}

Contains the information of a data source.

type DataSourceConfiguration 

type DataSourceConfiguration struct {

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

	// Configures an S3 data source location.
	S3Configuration *S3DataSourceConfiguration
	// contains filtered or unexported fields
}

Specifies a raw data source location to ingest.

type DataSourceStatus 

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

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 {

	// Identifier for a resource.
	//
	// This member is required.
	DataSourceId *string

	// Identifier for a resource.
	//
	// This member is required.
	KnowledgeBaseId *string

	// Name for a resource.
	//
	// This member is required.
	Name *string

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

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Description of the Resource.
	Description *string
	// contains filtered or unexported fields
}

Summary information of a data source.

type DataSourceType 

type DataSourceType string
const (
	DataSourceTypeS3 DataSourceType = "S3"
)

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 FixedSizeChunkingConfiguration 

type FixedSizeChunkingConfiguration struct {

	// The maximum number of tokens per chunk.
	//
	// This member is required.
	MaxTokens *int32

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

Configures fixed size chunking strategy

type InferenceConfiguration 

type InferenceConfiguration struct {

	// Maximum length of output
	MaximumLength *int32

	// List of stop sequences
	StopSequences []string

	// Controls randomness, higher values increase diversity
	Temperature *float32

	// Sample from the k most likely next tokens
	TopK *int32

	// Cumulative probability cutoff for token selection
	TopP *float32
	// contains filtered or unexported fields
}

Configuration for inference in prompt configuration

type IngestionJob 

type IngestionJob struct {

	// Identifier for a resource.
	//
	// This member is required.
	DataSourceId *string

	// Identifier for a resource.
	//
	// This member is required.
	IngestionJobId *string

	// Identifier for a resource.
	//
	// This member is required.
	KnowledgeBaseId *string

	// Time Stamp.
	//
	// This member is required.
	StartedAt *time.Time

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

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Description of the Resource.
	Description *string

	// Failure Reasons for Error.
	FailureReasons []string

	// The document level statistics of an ingestion job
	Statistics *IngestionJobStatistics
	// contains filtered or unexported fields
}

Contains the information of an ingestion job.

type IngestionJobFilter 

type IngestionJobFilter struct {

	// The name of the field to filter ingestion jobs.
	//
	// This member is required.
	Attribute IngestionJobFilterAttribute

	// The operator used to filter ingestion jobs.
	//
	// This member is required.
	Operator IngestionJobFilterOperator

	// The list of values used to filter ingestion jobs.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Filters the response returned by ListIngestionJobs operation.

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 the field to sort ingestion jobs.
	//
	// This member is required.
	Attribute IngestionJobSortByAttribute

	// Order to sort results by.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Sorts the response returned by ListIngestionJobs operation.

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 {

	// Number of deleted documents
	NumberOfDocumentsDeleted int64

	// Number of failed documents
	NumberOfDocumentsFailed int64

	// Number of scanned documents
	NumberOfDocumentsScanned int64

	// Number of modified documents indexed
	NumberOfModifiedDocumentsIndexed int64

	// Number of indexed documents
	NumberOfNewDocumentsIndexed int64
	// contains filtered or unexported fields
}

The document level statistics of an ingestion job

type IngestionJobStatus 

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

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 {

	// Identifier for a resource.
	//
	// This member is required.
	DataSourceId *string

	// Identifier for a resource.
	//
	// This member is required.
	IngestionJobId *string

	// Identifier for a resource.
	//
	// This member is required.
	KnowledgeBaseId *string

	// Time Stamp.
	//
	// This member is required.
	StartedAt *time.Time

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

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Description of the Resource.
	Description *string

	// The document level statistics of an ingestion job
	Statistics *IngestionJobStatistics
	// contains filtered or unexported fields
}

Summary information of an ingestion job.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

This exception is thrown if there was an unexpected error during processing of 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 KnowledgeBase 

type KnowledgeBase struct {

	// Time Stamp.
	//
	// This member is required.
	CreatedAt *time.Time

	// ARN of a KnowledgeBase
	//
	// This member is required.
	KnowledgeBaseArn *string

	// Configures a bedrock knowledge base.
	//
	// This member is required.
	KnowledgeBaseConfiguration *KnowledgeBaseConfiguration

	// Identifier for a resource.
	//
	// This member is required.
	KnowledgeBaseId *string

	// Name for a resource.
	//
	// This member is required.
	Name *string

	// ARN of a IAM role.
	//
	// This member is required.
	RoleArn *string

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

	// Configures the physical storage of ingested data in a knowledge base.
	//
	// This member is required.
	StorageConfiguration *StorageConfiguration

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Description of the Resource.
	Description *string

	// Failure Reasons for Error.
	FailureReasons []string
	// contains filtered or unexported fields
}

Contains the information of a knowledge base.

type KnowledgeBaseConfiguration 

type KnowledgeBaseConfiguration struct {

	// The type of a knowledge base.
	//
	// This member is required.
	Type KnowledgeBaseType

	// Configurations for a vector knowledge base.
	VectorKnowledgeBaseConfiguration *VectorKnowledgeBaseConfiguration
	// contains filtered or unexported fields
}

Configures a bedrock knowledge base.

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"
)

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"
)

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 {

	// Identifier for a resource.
	//
	// This member is required.
	KnowledgeBaseId *string

	// Name for a resource.
	//
	// This member is required.
	Name *string

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

	// Time Stamp.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Description of the Resource.
	Description *string
	// contains filtered or unexported fields
}

Summary information of 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 OpenSearchServerlessConfiguration 

type OpenSearchServerlessConfiguration struct {

	// Arn of an OpenSearch Serverless collection.
	//
	// This member is required.
	CollectionArn *string

	// A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names
	//
	// This member is required.
	FieldMapping *OpenSearchServerlessFieldMapping

	// Arn of an OpenSearch Serverless index.
	//
	// This member is required.
	VectorIndexName *string
	// contains filtered or unexported fields
}

Contains the configurations to use OpenSearch Serverless to store knowledge base data.

type OpenSearchServerlessFieldMapping 

type OpenSearchServerlessFieldMapping struct {

	// Name of the field
	//
	// This member is required.
	MetadataField *string

	// Name of the field
	//
	// This member is required.
	TextField *string

	// Name of the field
	//
	// This member is required.
	VectorField *string
	// contains filtered or unexported fields
}

A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names

type PineconeConfiguration 

type PineconeConfiguration struct {

	// Pinecone connection string
	//
	// This member is required.
	ConnectionString *string

	// Arn of a SecretsManager Secret.
	//
	// This member is required.
	CredentialsSecretArn *string

	// A mapping of Bedrock Knowledge Base fields to Pinecone field names
	//
	// This member is required.
	FieldMapping *PineconeFieldMapping

	// Pinecone namespace
	Namespace *string
	// contains filtered or unexported fields
}

Contains the configurations to use Pinecone to store knowledge base data.

type PineconeFieldMapping 

type PineconeFieldMapping struct {

	// Name of the field
	//
	// This member is required.
	MetadataField *string

	// Name of the field
	//
	// This member is required.
	TextField *string
	// contains filtered or unexported fields
}

A mapping of Bedrock Knowledge Base fields to Pinecone field names

type PromptConfiguration 

type PromptConfiguration struct {

	// Base Prompt Template.
	BasePromptTemplate *string

	// Configuration for inference in prompt configuration
	InferenceConfiguration *InferenceConfiguration

	// Creation Mode for Prompt Configuration.
	ParserMode CreationMode

	// Creation Mode for Prompt Configuration.
	PromptCreationMode CreationMode

	// Prompt State.
	PromptState PromptState

	// Prompt Type.
	PromptType PromptType
	// contains filtered or unexported fields
}

BasePromptConfiguration per Prompt Type.

type PromptOverrideConfiguration 

type PromptOverrideConfiguration struct {

	// List of BasePromptConfiguration
	//
	// This member is required.
	PromptConfigurations []PromptConfiguration

	// ARN of a Lambda.
	OverrideLambda *string
	// contains filtered or unexported fields
}

Configuration for prompt override.

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 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 RdsConfiguration added in v1.2.0 

type RdsConfiguration struct {

	// Arn of a SecretsManager Secret.
	//
	// This member is required.
	CredentialsSecretArn *string

	// Name of the database within RDS
	//
	// This member is required.
	DatabaseName *string

	// A mapping of Bedrock Knowledge Base fields to RDS column names
	//
	// This member is required.
	FieldMapping *RdsFieldMapping

	// Arn of a RDS Resource.
	//
	// This member is required.
	ResourceArn *string

	// Name of the table within RDS
	//
	// This member is required.
	TableName *string
	// contains filtered or unexported fields
}

Contains the configurations to use RDS to store knowledge base data.

type RdsFieldMapping added in v1.2.0 

type RdsFieldMapping struct {

	// Name of the column
	//
	// This member is required.
	MetadataField *string

	// Name of the column
	//
	// This member is required.
	PrimaryKeyField *string

	// Name of the column
	//
	// This member is required.
	TextField *string

	// Name of the column
	//
	// This member is required.
	VectorField *string
	// contains filtered or unexported fields
}

A mapping of Bedrock Knowledge Base fields to RDS column names

type RedisEnterpriseCloudConfiguration 

type RedisEnterpriseCloudConfiguration struct {

	// Arn of a SecretsManager Secret.
	//
	// This member is required.
	CredentialsSecretArn *string

	// Redis enterprise cloud endpoint
	//
	// This member is required.
	Endpoint *string

	// A mapping of Bedrock Knowledge Base fields to Redis Cloud field names
	//
	// This member is required.
	FieldMapping *RedisEnterpriseCloudFieldMapping

	// Name of a redis enterprise cloud index
	//
	// This member is required.
	VectorIndexName *string
	// contains filtered or unexported fields
}

Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.

type RedisEnterpriseCloudFieldMapping 

type RedisEnterpriseCloudFieldMapping struct {

	// Name of the field
	//
	// This member is required.
	MetadataField *string

	// Name of the field
	//
	// This member is required.
	TextField *string

	// Name of the field
	//
	// This member is required.
	VectorField *string
	// contains filtered or unexported fields
}

A mapping of Bedrock Knowledge Base fields to Redis Cloud field names

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

This exception is thrown when a resource referenced by the operation does not exist

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 S3DataSourceConfiguration 

type S3DataSourceConfiguration struct {

	// A S3 bucket ARN
	//
	// This member is required.
	BucketArn *string

	// A list of S3 prefixes.
	InclusionPrefixes []string
	// contains filtered or unexported fields
}

Configures an S3 data source location.

type S3Identifier 

type S3Identifier struct {

	// A bucket in S3.
	S3BucketName *string

	// A object key in S3.
	S3ObjectKey *string
	// contains filtered or unexported fields
}

The identifier for the S3 resource.

type ServerSideEncryptionConfiguration 

type ServerSideEncryptionConfiguration struct {

	// A KMS key ARN
	KmsKeyArn *string
	// contains filtered or unexported fields
}

Server-side encryption configuration.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

This exception is thrown when a request is made beyond the service quota

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 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 StorageConfiguration 

type StorageConfiguration struct {

	// The storage type of a knowledge base.
	//
	// This member is required.
	Type KnowledgeBaseStorageType

	// Contains the configurations to use OpenSearch Serverless to store knowledge
	// base data.
	OpensearchServerlessConfiguration *OpenSearchServerlessConfiguration

	// Contains the configurations to use Pinecone to store knowledge base data.
	PineconeConfiguration *PineconeConfiguration

	// Contains the configurations to use RDS to store knowledge base data.
	RdsConfiguration *RdsConfiguration

	// Contains the configurations to use Redis Enterprise Cloud to store knowledge
	// base data.
	RedisEnterpriseCloudConfiguration *RedisEnterpriseCloudConfiguration
	// contains filtered or unexported fields
}

Configures the physical storage of ingested data in a knowledge base.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

This exception is thrown when the number of requests exceeds the limit

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 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 ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	FieldList []ValidationExceptionField
	// contains filtered or unexported fields
}

This exception is thrown when the request's input validation fails

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 {

	// Non Blank String
	//
	// This member is required.
	Message *string

	// Non Blank String
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Stores information about a field passed inside a request that resulted in an exception

type VectorIngestionConfiguration 

type VectorIngestionConfiguration struct {

	// Configures chunking strategy
	ChunkingConfiguration *ChunkingConfiguration
	// contains filtered or unexported fields
}

Configures ingestion for a vector knowledge base

type VectorKnowledgeBaseConfiguration 

type VectorKnowledgeBaseConfiguration struct {

	// Arn of a Bedrock model.
	//
	// This member is required.
	EmbeddingModelArn *string
	// contains filtered or unexported fields
}

Configurations for a vector knowledge base.

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.