bedrockagentruntime

package
v1.0.3 Latest Latest
Warning

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

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

Documentation

Overview

Package bedrockagentruntime provides the client and types for making API requests to Agents for Amazon Bedrock Runtime.

Contains APIs related to model invocation and querying of knowledge bases.

See https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26 for more information on this service.

See bedrockagentruntime package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/bedrockagentruntime/

Using the Client

To contact Agents for Amazon Bedrock Runtime with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Agents for Amazon Bedrock Runtime client BedrockAgentRuntime for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/bedrockagentruntime/#New

Index

Constants

View Source 
const (
	// CreationModeDefault is a CreationMode enum value
	CreationModeDefault = "DEFAULT"

	// CreationModeOverridden is a CreationMode enum value
	CreationModeOverridden = "OVERRIDDEN"
)
View Source 
const (
	// ExternalSourceTypeS3 is a ExternalSourceType enum value
	ExternalSourceTypeS3 = "S3"

	// ExternalSourceTypeByteContent is a ExternalSourceType enum value
	ExternalSourceTypeByteContent = "BYTE_CONTENT"
)
View Source 
const (
	// GuadrailActionIntervened is a GuadrailAction enum value
	GuadrailActionIntervened = "INTERVENED"

	// GuadrailActionNone is a GuadrailAction enum value
	GuadrailActionNone = "NONE"
)
View Source 
const (
	// GuardrailActionIntervened is a GuardrailAction enum value
	GuardrailActionIntervened = "INTERVENED"

	// GuardrailActionNone is a GuardrailAction enum value
	GuardrailActionNone = "NONE"
)
View Source 
const (
	// GuardrailContentFilterConfidenceNone is a GuardrailContentFilterConfidence enum value
	GuardrailContentFilterConfidenceNone = "NONE"

	// GuardrailContentFilterConfidenceLow is a GuardrailContentFilterConfidence enum value
	GuardrailContentFilterConfidenceLow = "LOW"

	// GuardrailContentFilterConfidenceMedium is a GuardrailContentFilterConfidence enum value
	GuardrailContentFilterConfidenceMedium = "MEDIUM"

	// GuardrailContentFilterConfidenceHigh is a GuardrailContentFilterConfidence enum value
	GuardrailContentFilterConfidenceHigh = "HIGH"
)
View Source 
const (
	// GuardrailContentFilterTypeInsults is a GuardrailContentFilterType enum value
	GuardrailContentFilterTypeInsults = "INSULTS"

	// GuardrailContentFilterTypeHate is a GuardrailContentFilterType enum value
	GuardrailContentFilterTypeHate = "HATE"

	// GuardrailContentFilterTypeSexual is a GuardrailContentFilterType enum value
	GuardrailContentFilterTypeSexual = "SEXUAL"

	// GuardrailContentFilterTypeViolence is a GuardrailContentFilterType enum value
	GuardrailContentFilterTypeViolence = "VIOLENCE"

	// GuardrailContentFilterTypeMisconduct is a GuardrailContentFilterType enum value
	GuardrailContentFilterTypeMisconduct = "MISCONDUCT"

	// GuardrailContentFilterTypePromptAttack is a GuardrailContentFilterType enum value
	GuardrailContentFilterTypePromptAttack = "PROMPT_ATTACK"
)
View Source 
const (
	// GuardrailPiiEntityTypeAddress is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeAddress = "ADDRESS"

	// GuardrailPiiEntityTypeAge is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeAge = "AGE"

	// GuardrailPiiEntityTypeAwsAccessKey is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeAwsAccessKey = "AWS_ACCESS_KEY"

	// GuardrailPiiEntityTypeAwsSecretKey is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeAwsSecretKey = "AWS_SECRET_KEY"

	// GuardrailPiiEntityTypeCaHealthNumber is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeCaHealthNumber = "CA_HEALTH_NUMBER"

	// GuardrailPiiEntityTypeCaSocialInsuranceNumber is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeCaSocialInsuranceNumber = "CA_SOCIAL_INSURANCE_NUMBER"

	// GuardrailPiiEntityTypeCreditDebitCardCvv is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeCreditDebitCardCvv = "CREDIT_DEBIT_CARD_CVV"

	// GuardrailPiiEntityTypeCreditDebitCardExpiry is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeCreditDebitCardExpiry = "CREDIT_DEBIT_CARD_EXPIRY"

	// GuardrailPiiEntityTypeCreditDebitCardNumber is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeCreditDebitCardNumber = "CREDIT_DEBIT_CARD_NUMBER"

	// GuardrailPiiEntityTypeDriverId is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeDriverId = "DRIVER_ID"

	// GuardrailPiiEntityTypeEmail is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeEmail = "EMAIL"

	// GuardrailPiiEntityTypeInternationalBankAccountNumber is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeInternationalBankAccountNumber = "INTERNATIONAL_BANK_ACCOUNT_NUMBER"

	// GuardrailPiiEntityTypeIpAddress is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeIpAddress = "IP_ADDRESS"

	// GuardrailPiiEntityTypeLicensePlate is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeLicensePlate = "LICENSE_PLATE"

	// GuardrailPiiEntityTypeMacAddress is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeMacAddress = "MAC_ADDRESS"

	// GuardrailPiiEntityTypeName is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeName = "NAME"

	// GuardrailPiiEntityTypePassword is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypePassword = "PASSWORD"

	// GuardrailPiiEntityTypePhone is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypePhone = "PHONE"

	// GuardrailPiiEntityTypePin is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypePin = "PIN"

	// GuardrailPiiEntityTypeSwiftCode is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeSwiftCode = "SWIFT_CODE"

	// GuardrailPiiEntityTypeUkNationalHealthServiceNumber is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeUkNationalHealthServiceNumber = "UK_NATIONAL_HEALTH_SERVICE_NUMBER"

	// GuardrailPiiEntityTypeUkNationalInsuranceNumber is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeUkNationalInsuranceNumber = "UK_NATIONAL_INSURANCE_NUMBER"

	// GuardrailPiiEntityTypeUkUniqueTaxpayerReferenceNumber is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeUkUniqueTaxpayerReferenceNumber = "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"

	// GuardrailPiiEntityTypeUrl is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeUrl = "URL"

	// GuardrailPiiEntityTypeUsername is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeUsername = "USERNAME"

	// GuardrailPiiEntityTypeUsBankAccountNumber is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeUsBankAccountNumber = "US_BANK_ACCOUNT_NUMBER"

	// GuardrailPiiEntityTypeUsBankRoutingNumber is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeUsBankRoutingNumber = "US_BANK_ROUTING_NUMBER"

	// GuardrailPiiEntityTypeUsIndividualTaxIdentificationNumber is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeUsIndividualTaxIdentificationNumber = "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"

	// GuardrailPiiEntityTypeUsPassportNumber is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeUsPassportNumber = "US_PASSPORT_NUMBER"

	// GuardrailPiiEntityTypeUsSocialSecurityNumber is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeUsSocialSecurityNumber = "US_SOCIAL_SECURITY_NUMBER"

	// GuardrailPiiEntityTypeVehicleIdentificationNumber is a GuardrailPiiEntityType enum value
	GuardrailPiiEntityTypeVehicleIdentificationNumber = "VEHICLE_IDENTIFICATION_NUMBER"
)
View Source 
const (
	// GuardrailSensitiveInformationPolicyActionBlocked is a GuardrailSensitiveInformationPolicyAction enum value
	GuardrailSensitiveInformationPolicyActionBlocked = "BLOCKED"

	// GuardrailSensitiveInformationPolicyActionAnonymized is a GuardrailSensitiveInformationPolicyAction enum value
	GuardrailSensitiveInformationPolicyActionAnonymized = "ANONYMIZED"
)
View Source 
const (
	// InvocationTypeActionGroup is a InvocationType enum value
	InvocationTypeActionGroup = "ACTION_GROUP"

	// InvocationTypeKnowledgeBase is a InvocationType enum value
	InvocationTypeKnowledgeBase = "KNOWLEDGE_BASE"

	// InvocationTypeFinish is a InvocationType enum value
	InvocationTypeFinish = "FINISH"
)
View Source 
const (
	// PromptTypePreProcessing is a PromptType enum value
	PromptTypePreProcessing = "PRE_PROCESSING"

	// PromptTypeOrchestration is a PromptType enum value
	PromptTypeOrchestration = "ORCHESTRATION"

	// PromptTypeKnowledgeBaseResponseGeneration is a PromptType enum value
	PromptTypeKnowledgeBaseResponseGeneration = "KNOWLEDGE_BASE_RESPONSE_GENERATION"

	// PromptTypePostProcessing is a PromptType enum value
	PromptTypePostProcessing = "POST_PROCESSING"
)
View Source 
const (
	// ResponseStateFailure is a ResponseState enum value
	ResponseStateFailure = "FAILURE"

	// ResponseStateReprompt is a ResponseState enum value
	ResponseStateReprompt = "REPROMPT"
)
View Source 
const (
	// RetrieveAndGenerateTypeKnowledgeBase is a RetrieveAndGenerateType enum value
	RetrieveAndGenerateTypeKnowledgeBase = "KNOWLEDGE_BASE"

	// RetrieveAndGenerateTypeExternalSources is a RetrieveAndGenerateType enum value
	RetrieveAndGenerateTypeExternalSources = "EXTERNAL_SOURCES"
)
View Source 
const (
	// SearchTypeHybrid is a SearchType enum value
	SearchTypeHybrid = "HYBRID"

	// SearchTypeSemantic is a SearchType enum value
	SearchTypeSemantic = "SEMANTIC"
)
View Source 
const (
	// SourceActionGroup is a Source enum value
	SourceActionGroup = "ACTION_GROUP"

	// SourceKnowledgeBase is a Source enum value
	SourceKnowledgeBase = "KNOWLEDGE_BASE"

	// SourceParser is a Source enum value
	SourceParser = "PARSER"
)
View Source 
const (
	// TypeActionGroup is a Type enum value
	TypeActionGroup = "ACTION_GROUP"

	// TypeKnowledgeBase is a Type enum value
	TypeKnowledgeBase = "KNOWLEDGE_BASE"

	// TypeFinish is a Type enum value
	TypeFinish = "FINISH"

	// TypeAskUser is a Type enum value
	TypeAskUser = "ASK_USER"

	// TypeReprompt is a Type enum value
	TypeReprompt = "REPROMPT"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// The request is denied because of missing access permissions. Check your permissions
	// and retry your request.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeBadGatewayException for service response error code
	// "BadGatewayException".
	//
	// There was an issue with a dependency due to a server issue. Retry your request.
	ErrCodeBadGatewayException = "BadGatewayException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// There was a conflict performing an operation. Resolve the conflict and retry
	// your request.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeDependencyFailedException for service response error code
	// "DependencyFailedException".
	//
	// There was an issue with a dependency. Check the resource configurations and
	// retry the request.
	ErrCodeDependencyFailedException = "DependencyFailedException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An internal server error occurred. Retry your request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource Amazon Resource Name (ARN) was not found. Check the
	// Amazon Resource Name (ARN) and try your request again.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The number of requests exceeds the service quota. Resubmit your request later.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The number of requests exceeds the limit. Resubmit your request later.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// Input validation failed. Check your request parameters and retry the request.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "Bedrock Agent Runtime" // Name of service.
	EndpointsID = "bedrock-agent-runtime" // ID to lookup a service endpoint with.
	ServiceID   = "Bedrock Agent Runtime" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// GuardrailContentPolicyActionBlocked is a GuardrailContentPolicyAction enum value
	GuardrailContentPolicyActionBlocked = "BLOCKED"
)
View Source 
const (
	// GuardrailManagedWordTypeProfanity is a GuardrailManagedWordType enum value
	GuardrailManagedWordTypeProfanity = "PROFANITY"
)
View Source 
const (
	// GuardrailTopicPolicyActionBlocked is a GuardrailTopicPolicyAction enum value
	GuardrailTopicPolicyActionBlocked = "BLOCKED"
)
View Source 
const (
	// GuardrailTopicTypeDeny is a GuardrailTopicType enum value
	GuardrailTopicTypeDeny = "DENY"
)
View Source 
const (
	// GuardrailWordPolicyActionBlocked is a GuardrailWordPolicyAction enum value
	GuardrailWordPolicyActionBlocked = "BLOCKED"
)
View Source 
const (
	// RetrievalResultLocationTypeS3 is a RetrievalResultLocationType enum value
	RetrievalResultLocationTypeS3 = "S3"
)

Variables

This section is empty.

Functions

func CreationMode_Values 

func CreationMode_Values() []string

CreationMode_Values returns all elements of the CreationMode enum

func ExternalSourceType_Values 

func ExternalSourceType_Values() []string

ExternalSourceType_Values returns all elements of the ExternalSourceType enum

func GuadrailAction_Values 

func GuadrailAction_Values() []string

GuadrailAction_Values returns all elements of the GuadrailAction enum

func GuardrailAction_Values 

func GuardrailAction_Values() []string

GuardrailAction_Values returns all elements of the GuardrailAction enum

func GuardrailContentFilterConfidence_Values 

func GuardrailContentFilterConfidence_Values() []string

GuardrailContentFilterConfidence_Values returns all elements of the GuardrailContentFilterConfidence enum

func GuardrailContentFilterType_Values 

func GuardrailContentFilterType_Values() []string

GuardrailContentFilterType_Values returns all elements of the GuardrailContentFilterType enum

func GuardrailContentPolicyAction_Values 

func GuardrailContentPolicyAction_Values() []string

GuardrailContentPolicyAction_Values returns all elements of the GuardrailContentPolicyAction enum

func GuardrailManagedWordType_Values 

func GuardrailManagedWordType_Values() []string

GuardrailManagedWordType_Values returns all elements of the GuardrailManagedWordType enum

func GuardrailPiiEntityType_Values 

func GuardrailPiiEntityType_Values() []string

GuardrailPiiEntityType_Values returns all elements of the GuardrailPiiEntityType enum

func GuardrailSensitiveInformationPolicyAction_Values 

func GuardrailSensitiveInformationPolicyAction_Values() []string

GuardrailSensitiveInformationPolicyAction_Values returns all elements of the GuardrailSensitiveInformationPolicyAction enum

func GuardrailTopicPolicyAction_Values 

func GuardrailTopicPolicyAction_Values() []string

GuardrailTopicPolicyAction_Values returns all elements of the GuardrailTopicPolicyAction enum

func GuardrailTopicType_Values 

func GuardrailTopicType_Values() []string

GuardrailTopicType_Values returns all elements of the GuardrailTopicType enum

func GuardrailWordPolicyAction_Values 

func GuardrailWordPolicyAction_Values() []string

GuardrailWordPolicyAction_Values returns all elements of the GuardrailWordPolicyAction enum

func InvocationType_Values 

func InvocationType_Values() []string

InvocationType_Values returns all elements of the InvocationType enum

func PromptType_Values 

func PromptType_Values() []string

PromptType_Values returns all elements of the PromptType enum

func ResponseState_Values 

func ResponseState_Values() []string

ResponseState_Values returns all elements of the ResponseState enum

func RetrievalResultLocationType_Values 

func RetrievalResultLocationType_Values() []string

RetrievalResultLocationType_Values returns all elements of the RetrievalResultLocationType enum

func RetrieveAndGenerateType_Values 

func RetrieveAndGenerateType_Values() []string

RetrieveAndGenerateType_Values returns all elements of the RetrieveAndGenerateType enum

func SearchType_Values 

func SearchType_Values() []string

SearchType_Values returns all elements of the SearchType enum

func Source_Values 

func Source_Values() []string

Source_Values returns all elements of the Source enum

func Type_Values 

func Type_Values() []string

Type_Values returns all elements of the Type enum

Types

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request is denied because of missing access permissions. Check your permissions and retry your request.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) MarshalEvent 

func (s *AccessDeniedException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) UnmarshalEvent 

func (s *AccessDeniedException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the AccessDeniedException value. This method is only used internally within the SDK's EventStream handling.

type ActionGroupInvocationInput_ 

type ActionGroupInvocationInput_ struct {

	// The name of the action group.
	//
	// ActionGroupName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ActionGroupInvocationInput_'s
	// String and GoString methods.
	ActionGroupName *string `locationName:"actionGroupName" type:"string" sensitive:"true"`

	// The path to the API to call, based off the action group.
	//
	// ApiPath is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ActionGroupInvocationInput_'s
	// String and GoString methods.
	ApiPath *string `locationName:"apiPath" type:"string" sensitive:"true"`

	// The function in the action group to call.
	//
	// Function is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ActionGroupInvocationInput_'s
	// String and GoString methods.
	Function *string `locationName:"function" type:"string" sensitive:"true"`

	// The parameters in the Lambda input event.
	Parameters []*Parameter `locationName:"parameters" type:"list"`

	// The parameters in the request body for the Lambda input event.
	RequestBody *RequestBody `locationName:"requestBody" type:"structure"`

	// The API method being used, based off the action group.
	//
	// Verb is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ActionGroupInvocationInput_'s
	// String and GoString methods.
	Verb *string `locationName:"verb" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in OrchestrationTrace (https://docs.aws.amazon.com/bedrock/latest/userguide/trace-orchestration.html) in the Amazon Bedrock User Guide.

func (ActionGroupInvocationInput_) GoString 

func (s ActionGroupInvocationInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionGroupInvocationInput_) SetActionGroupName 

func (s *ActionGroupInvocationInput_) SetActionGroupName(v string) *ActionGroupInvocationInput_

SetActionGroupName sets the ActionGroupName field's value.

func (*ActionGroupInvocationInput_) SetApiPath 

func (s *ActionGroupInvocationInput_) SetApiPath(v string) *ActionGroupInvocationInput_

SetApiPath sets the ApiPath field's value.

func (*ActionGroupInvocationInput_) SetFunction 

func (s *ActionGroupInvocationInput_) SetFunction(v string) *ActionGroupInvocationInput_

SetFunction sets the Function field's value.

func (*ActionGroupInvocationInput_) SetParameters 

func (s *ActionGroupInvocationInput_) SetParameters(v []*Parameter) *ActionGroupInvocationInput_

SetParameters sets the Parameters field's value.

func (*ActionGroupInvocationInput_) SetRequestBody 

func (s *ActionGroupInvocationInput_) SetRequestBody(v *RequestBody) *ActionGroupInvocationInput_

SetRequestBody sets the RequestBody field's value.

func (*ActionGroupInvocationInput_) SetVerb 

func (s *ActionGroupInvocationInput_) SetVerb(v string) *ActionGroupInvocationInput_

SetVerb sets the Verb field's value.

func (ActionGroupInvocationInput_) String 

func (s ActionGroupInvocationInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActionGroupInvocationOutput_ 

type ActionGroupInvocationOutput_ struct {

	// The JSON-formatted string returned by the API invoked by the action group.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ActionGroupInvocationOutput_'s
	// String and GoString methods.
	Text *string `locationName:"text" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains the JSON-formatted string returned by the API invoked by the action group.

func (ActionGroupInvocationOutput_) GoString 

func (s ActionGroupInvocationOutput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionGroupInvocationOutput_) SetText 

func (s *ActionGroupInvocationOutput_) SetText(v string) *ActionGroupInvocationOutput_

SetText sets the Text field's value.

func (ActionGroupInvocationOutput_) String 

func (s ActionGroupInvocationOutput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApiInvocationInput_ 

type ApiInvocationInput_ struct {

	// The action group that the API operation belongs to.
	//
	// ActionGroup is a required field
	ActionGroup *string `locationName:"actionGroup" type:"string" required:"true"`

	// The path to the API operation.
	//
	// ApiPath is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ApiInvocationInput_'s
	// String and GoString methods.
	ApiPath *string `locationName:"apiPath" type:"string" sensitive:"true"`

	// The HTTP method of the API operation.
	HttpMethod *string `locationName:"httpMethod" type:"string"`

	// The parameters to provide for the API request, as the agent elicited from
	// the user.
	Parameters []*ApiParameter `locationName:"parameters" type:"list"`

	// The request body to provide for the API request, as the agent elicited from
	// the user.
	RequestBody *ApiRequestBody `locationName:"requestBody" type:"structure"`
	// contains filtered or unexported fields
}

Contains information about the API operation that the agent predicts should be called.

This data type is used in the following API operations:

func (ApiInvocationInput_) GoString 

func (s ApiInvocationInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApiInvocationInput_) SetActionGroup 

func (s *ApiInvocationInput_) SetActionGroup(v string) *ApiInvocationInput_

SetActionGroup sets the ActionGroup field's value.

func (*ApiInvocationInput_) SetApiPath 

func (s *ApiInvocationInput_) SetApiPath(v string) *ApiInvocationInput_

SetApiPath sets the ApiPath field's value.

func (*ApiInvocationInput_) SetHttpMethod 

func (s *ApiInvocationInput_) SetHttpMethod(v string) *ApiInvocationInput_

SetHttpMethod sets the HttpMethod field's value.

func (*ApiInvocationInput_) SetParameters 

func (s *ApiInvocationInput_) SetParameters(v []*ApiParameter) *ApiInvocationInput_

SetParameters sets the Parameters field's value.

func (*ApiInvocationInput_) SetRequestBody 

func (s *ApiInvocationInput_) SetRequestBody(v *ApiRequestBody) *ApiInvocationInput_

SetRequestBody sets the RequestBody field's value.

func (ApiInvocationInput_) String 

func (s ApiInvocationInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApiParameter 

type ApiParameter struct {

	// The name of the parameter.
	Name *string `locationName:"name" type:"string"`

	// The data type for the parameter.
	Type *string `locationName:"type" type:"string"`

	// The value of the parameter.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

Information about a parameter to provide to the API request.

This data type is used in the following API operations:

func (ApiParameter) GoString 

func (s ApiParameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApiParameter) SetName 

func (s *ApiParameter) SetName(v string) *ApiParameter

SetName sets the Name field's value.

func (*ApiParameter) SetType 

func (s *ApiParameter) SetType(v string) *ApiParameter

SetType sets the Type field's value.

func (*ApiParameter) SetValue 

func (s *ApiParameter) SetValue(v string) *ApiParameter

SetValue sets the Value field's value.

func (ApiParameter) String 

func (s ApiParameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApiRequestBody 

type ApiRequestBody struct {

	// The content of the request body. The key of the object in this field is a
	// media type defining the format of the request body.
	Content map[string]*PropertyParameters `locationName:"content" type:"map"`
	// contains filtered or unexported fields
}

The request body to provide for the API request, as the agent elicited from the user.

This data type is used in the following API operations:

func (ApiRequestBody) GoString 

func (s ApiRequestBody) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApiRequestBody) SetContent 

func (s *ApiRequestBody) SetContent(v map[string]*PropertyParameters) *ApiRequestBody

SetContent sets the Content field's value.

func (ApiRequestBody) String 

func (s ApiRequestBody) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApiResult 

type ApiResult struct {

	// The action group that the API operation belongs to.
	//
	// ActionGroup is a required field
	ActionGroup *string `locationName:"actionGroup" type:"string" required:"true"`

	// The path to the API operation.
	//
	// ApiPath is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ApiResult's
	// String and GoString methods.
	ApiPath *string `locationName:"apiPath" type:"string" sensitive:"true"`

	// The HTTP method for the API operation.
	HttpMethod *string `locationName:"httpMethod" type:"string"`

	// http status code from API execution response (for example: 200, 400, 500).
	HttpStatusCode *int64 `locationName:"httpStatusCode" type:"integer"`

	// The response body from the API operation. The key of the object is the content
	// type (currently, only TEXT is supported). The response may be returned directly
	// or from the Lambda function.
	ResponseBody map[string]*ContentBody `locationName:"responseBody" type:"map"`

	// Controls the final response state returned to end user when API/Function
	// execution failed. When this state is FAILURE, the request would fail with
	// dependency failure exception. When this state is REPROMPT, the API/function
	// response will be sent to model for re-prompt
	ResponseState *string `locationName:"responseState" type:"string" enum:"ResponseState"`
	// contains filtered or unexported fields
}

Contains information about the API operation that was called from the action group and the response body that was returned.

This data type is used in the following API operations:

func (ApiResult) GoString 

func (s ApiResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApiResult) SetActionGroup 

func (s *ApiResult) SetActionGroup(v string) *ApiResult

SetActionGroup sets the ActionGroup field's value.

func (*ApiResult) SetApiPath 

func (s *ApiResult) SetApiPath(v string) *ApiResult

SetApiPath sets the ApiPath field's value.

func (*ApiResult) SetHttpMethod 

func (s *ApiResult) SetHttpMethod(v string) *ApiResult

SetHttpMethod sets the HttpMethod field's value.

func (*ApiResult) SetHttpStatusCode 

func (s *ApiResult) SetHttpStatusCode(v int64) *ApiResult

SetHttpStatusCode sets the HttpStatusCode field's value.

func (*ApiResult) SetResponseBody 

func (s *ApiResult) SetResponseBody(v map[string]*ContentBody) *ApiResult

SetResponseBody sets the ResponseBody field's value.

func (*ApiResult) SetResponseState 

func (s *ApiResult) SetResponseState(v string) *ApiResult

SetResponseState sets the ResponseState field's value.

func (ApiResult) String 

func (s ApiResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApiResult) Validate 

func (s *ApiResult) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Attribution 

type Attribution struct {

	// A list of citations and related information for a part of an agent response.
	Citations []*Citation `locationName:"citations" type:"list"`
	// contains filtered or unexported fields
}

Contains citations for a part of an agent response.

func (Attribution) GoString 

func (s Attribution) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Attribution) SetCitations 

func (s *Attribution) SetCitations(v []*Citation) *Attribution

SetCitations sets the Citations field's value.

func (Attribution) String 

func (s Attribution) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BadGatewayException 

type BadGatewayException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The name of the dependency that caused the issue, such as Amazon Bedrock,
	// Lambda, or STS.
	ResourceName *string `locationName:"resourceName" type:"string"`
	// contains filtered or unexported fields
}

There was an issue with a dependency due to a server issue. Retry your request.

func (*BadGatewayException) Code 

func (s *BadGatewayException) Code() string

Code returns the exception type name.

func (*BadGatewayException) Error 

func (s *BadGatewayException) Error() string

func (BadGatewayException) GoString 

func (s BadGatewayException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadGatewayException) MarshalEvent 

func (s *BadGatewayException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*BadGatewayException) Message 

func (s *BadGatewayException) Message() string

Message returns the exception's message.

func (*BadGatewayException) OrigErr 

func (s *BadGatewayException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadGatewayException) RequestID 

func (s *BadGatewayException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadGatewayException) StatusCode 

func (s *BadGatewayException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadGatewayException) String 

func (s BadGatewayException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadGatewayException) UnmarshalEvent 

func (s *BadGatewayException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the BadGatewayException value. This method is only used internally within the SDK's EventStream handling.

type BedrockAgentRuntime 

type BedrockAgentRuntime struct {
	*client.Client
}

BedrockAgentRuntime provides the API operation methods for making requests to Agents for Amazon Bedrock Runtime. See this package's package overview docs for details on the service.

BedrockAgentRuntime methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *BedrockAgentRuntime

New creates a new instance of the BedrockAgentRuntime client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a BedrockAgentRuntime client from just a session.
svc := bedrockagentruntime.New(mySession)

// Create a BedrockAgentRuntime client with additional configuration
svc := bedrockagentruntime.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*BedrockAgentRuntime) InvokeAgent 

func (c *BedrockAgentRuntime) InvokeAgent(input *InvokeAgentInput) (*InvokeAgentOutput, error)

InvokeAgent API operation for Agents for Amazon Bedrock Runtime.

The CLI doesn't support InvokeAgent.

Sends a prompt for the agent to process and respond to. Note the following fields for the request:

  • To continue the same conversation with an agent, use the same sessionId value in the request.

  • To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events).

  • End a conversation by setting endSession to true.

  • In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.

The response is returned in the bytes field of the chunk object.

  • The attribution object contains citations for parts of the response.

  • If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.

  • If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.

  • Errors are also surfaced in the response.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock Runtime's API operation InvokeAgent for usage and error information.

Returned Error Types:

  • ConflictException There was a conflict performing an operation. Resolve the conflict and retry your request.

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

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • DependencyFailedException There was an issue with a dependency. Check the resource configurations and retry the request.

  • BadGatewayException There was an issue with a dependency due to a server issue. Retry your request.

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions. Check your permissions and retry your request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InvokeAgent

func (*BedrockAgentRuntime) InvokeAgentRequest 

func (c *BedrockAgentRuntime) InvokeAgentRequest(input *InvokeAgentInput) (req *request.Request, output *InvokeAgentOutput)

InvokeAgentRequest generates a "aws/request.Request" representing the client's request for the InvokeAgent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See InvokeAgent for more information on using the InvokeAgent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the InvokeAgentRequest method.
req, resp := client.InvokeAgentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InvokeAgent

func (*BedrockAgentRuntime) InvokeAgentWithContext 

func (c *BedrockAgentRuntime) InvokeAgentWithContext(ctx aws.Context, input *InvokeAgentInput, opts ...request.Option) (*InvokeAgentOutput, error)

InvokeAgentWithContext is the same as InvokeAgent with the addition of the ability to pass a context and additional request options.

See InvokeAgent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgentRuntime) Retrieve 

func (c *BedrockAgentRuntime) Retrieve(input *RetrieveInput) (*RetrieveOutput, error)

Retrieve API operation for Agents for Amazon Bedrock Runtime.

Queries a knowledge base and retrieves information from it.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock Runtime's API operation Retrieve for usage and error information.

Returned Error Types:

  • ConflictException There was a conflict performing an operation. Resolve the conflict and retry your request.

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

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • DependencyFailedException There was an issue with a dependency. Check the resource configurations and retry the request.

  • BadGatewayException There was an issue with a dependency due to a server issue. Retry your request.

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions. Check your permissions and retry your request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Retrieve

func (*BedrockAgentRuntime) RetrieveAndGenerate 

func (c *BedrockAgentRuntime) RetrieveAndGenerate(input *RetrieveAndGenerateInput) (*RetrieveAndGenerateOutput, error)

RetrieveAndGenerate API operation for Agents for Amazon Bedrock Runtime.

Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources that are relevant to the query.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock Runtime's API operation RetrieveAndGenerate for usage and error information.

Returned Error Types:

  • ConflictException There was a conflict performing an operation. Resolve the conflict and retry your request.

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

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • DependencyFailedException There was an issue with a dependency. Check the resource configurations and retry the request.

  • BadGatewayException There was an issue with a dependency due to a server issue. Retry your request.

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions. Check your permissions and retry your request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerate

func (*BedrockAgentRuntime) RetrieveAndGenerateRequest 

func (c *BedrockAgentRuntime) RetrieveAndGenerateRequest(input *RetrieveAndGenerateInput) (req *request.Request, output *RetrieveAndGenerateOutput)

RetrieveAndGenerateRequest generates a "aws/request.Request" representing the client's request for the RetrieveAndGenerate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RetrieveAndGenerate for more information on using the RetrieveAndGenerate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RetrieveAndGenerateRequest method.
req, resp := client.RetrieveAndGenerateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerate

func (*BedrockAgentRuntime) RetrieveAndGenerateWithContext 

func (c *BedrockAgentRuntime) RetrieveAndGenerateWithContext(ctx aws.Context, input *RetrieveAndGenerateInput, opts ...request.Option) (*RetrieveAndGenerateOutput, error)

RetrieveAndGenerateWithContext is the same as RetrieveAndGenerate with the addition of the ability to pass a context and additional request options.

See RetrieveAndGenerate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgentRuntime) RetrievePages 

func (c *BedrockAgentRuntime) RetrievePages(input *RetrieveInput, fn func(*RetrieveOutput, bool) bool) error

RetrievePages iterates over the pages of a Retrieve operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See Retrieve method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a Retrieve operation.
pageNum := 0
err := client.RetrievePages(params,
    func(page *bedrockagentruntime.RetrieveOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BedrockAgentRuntime) RetrievePagesWithContext 

func (c *BedrockAgentRuntime) RetrievePagesWithContext(ctx aws.Context, input *RetrieveInput, fn func(*RetrieveOutput, bool) bool, opts ...request.Option) error

RetrievePagesWithContext same as RetrievePages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgentRuntime) RetrieveRequest 

func (c *BedrockAgentRuntime) RetrieveRequest(input *RetrieveInput) (req *request.Request, output *RetrieveOutput)

RetrieveRequest generates a "aws/request.Request" representing the client's request for the Retrieve operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See Retrieve for more information on using the Retrieve API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RetrieveRequest method.
req, resp := client.RetrieveRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Retrieve

func (*BedrockAgentRuntime) RetrieveWithContext 

func (c *BedrockAgentRuntime) RetrieveWithContext(ctx aws.Context, input *RetrieveInput, opts ...request.Option) (*RetrieveOutput, error)

RetrieveWithContext is the same as Retrieve with the addition of the ability to pass a context and additional request options.

See Retrieve for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ByteContentDoc 

type ByteContentDoc struct {

	// The MIME type of the document contained in the wrapper object.
	//
	// ContentType is a required field
	ContentType *string `locationName:"contentType" type:"string" required:"true"`

	// The byte value of the file to upload, encoded as a Base-64 string.
	//
	// Data is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ByteContentDoc's
	// String and GoString methods.
	//
	// Data is automatically base64 encoded/decoded by the SDK.
	//
	// Data is a required field
	Data []byte `locationName:"data" min:"1" type:"blob" required:"true" sensitive:"true"`

	// The file name of the document contained in the wrapper object.
	//
	// Identifier is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ByteContentDoc's
	// String and GoString methods.
	//
	// Identifier is a required field
	Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

This property contains the document to chat with, along with its attributes.

func (ByteContentDoc) GoString 

func (s ByteContentDoc) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ByteContentDoc) SetContentType 

func (s *ByteContentDoc) SetContentType(v string) *ByteContentDoc

SetContentType sets the ContentType field's value.

func (*ByteContentDoc) SetData 

func (s *ByteContentDoc) SetData(v []byte) *ByteContentDoc

SetData sets the Data field's value.

func (*ByteContentDoc) SetIdentifier 

func (s *ByteContentDoc) SetIdentifier(v string) *ByteContentDoc

SetIdentifier sets the Identifier field's value.

func (ByteContentDoc) String 

func (s ByteContentDoc) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ByteContentDoc) Validate 

func (s *ByteContentDoc) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Citation 

type Citation struct {

	// Contains the generated response and metadata
	GeneratedResponsePart *GeneratedResponsePart `locationName:"generatedResponsePart" type:"structure"`

	// Contains metadata about the sources cited for the generated response.
	RetrievedReferences []*RetrievedReference `locationName:"retrievedReferences" type:"list"`
	// contains filtered or unexported fields
}

An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.

This data type is used in the following API operations:

func (Citation) GoString 

func (s Citation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Citation) SetGeneratedResponsePart 

func (s *Citation) SetGeneratedResponsePart(v *GeneratedResponsePart) *Citation

SetGeneratedResponsePart sets the GeneratedResponsePart field's value.

func (*Citation) SetRetrievedReferences 

func (s *Citation) SetRetrievedReferences(v []*RetrievedReference) *Citation

SetRetrievedReferences sets the RetrievedReferences field's value.

func (Citation) String 

func (s Citation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

There was a conflict performing an operation. Resolve the conflict and retry your request.

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) MarshalEvent 

func (s *ConflictException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) UnmarshalEvent 

func (s *ConflictException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ConflictException value. This method is only used internally within the SDK's EventStream handling.

type ContentBody 

type ContentBody struct {

	// The body of the API response.
	Body *string `locationName:"body" type:"string"`
	// contains filtered or unexported fields
}

Contains the body of the API response.

This data type is used in the following API operations:

func (ContentBody) GoString 

func (s ContentBody) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContentBody) SetBody 

func (s *ContentBody) SetBody(v string) *ContentBody

SetBody sets the Body field's value.

func (ContentBody) String 

func (s ContentBody) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DependencyFailedException 

type DependencyFailedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The name of the dependency that caused the issue, such as Amazon Bedrock,
	// Lambda, or STS.
	ResourceName *string `locationName:"resourceName" type:"string"`
	// contains filtered or unexported fields
}

There was an issue with a dependency. Check the resource configurations and retry the request.

func (*DependencyFailedException) Code 

func (s *DependencyFailedException) Code() string

Code returns the exception type name.

func (*DependencyFailedException) Error 

func (s *DependencyFailedException) Error() string

func (DependencyFailedException) GoString 

func (s DependencyFailedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DependencyFailedException) MarshalEvent 

func (s *DependencyFailedException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*DependencyFailedException) Message 

func (s *DependencyFailedException) Message() string

Message returns the exception's message.

func (*DependencyFailedException) OrigErr 

func (s *DependencyFailedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DependencyFailedException) RequestID 

func (s *DependencyFailedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DependencyFailedException) StatusCode 

func (s *DependencyFailedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DependencyFailedException) String 

func (s DependencyFailedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DependencyFailedException) UnmarshalEvent 

func (s *DependencyFailedException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the DependencyFailedException value. This method is only used internally within the SDK's EventStream handling.

type ExternalSource 

type ExternalSource struct {

	// The identifier, contentType, and data of the external source wrapper object.
	ByteContent *ByteContentDoc `locationName:"byteContent" type:"structure"`

	// The S3 location of the external source wrapper object.
	S3Location *S3ObjectDoc `locationName:"s3Location" type:"structure"`

	// The source type of the external source wrapper object.
	//
	// SourceType is a required field
	SourceType *string `locationName:"sourceType" type:"string" required:"true" enum:"ExternalSourceType"`
	// contains filtered or unexported fields
}

The unique external source of the content contained in the wrapper object.

func (ExternalSource) GoString 

func (s ExternalSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExternalSource) SetByteContent 

func (s *ExternalSource) SetByteContent(v *ByteContentDoc) *ExternalSource

SetByteContent sets the ByteContent field's value.

func (*ExternalSource) SetS3Location 

func (s *ExternalSource) SetS3Location(v *S3ObjectDoc) *ExternalSource

SetS3Location sets the S3Location field's value.

func (*ExternalSource) SetSourceType 

func (s *ExternalSource) SetSourceType(v string) *ExternalSource

SetSourceType sets the SourceType field's value.

func (ExternalSource) String 

func (s ExternalSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExternalSource) Validate 

func (s *ExternalSource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExternalSourcesGenerationConfiguration 

type ExternalSourcesGenerationConfiguration struct {

	// The configuration details for the guardrail.
	GuardrailConfiguration *GuardrailConfiguration `locationName:"guardrailConfiguration" type:"structure"`

	// Configuration settings for inference when using RetrieveAndGenerate to generate
	// responses while using an external source.
	InferenceConfig *InferenceConfig `locationName:"inferenceConfig" type:"structure"`

	// Contain the textPromptTemplate string for the external source wrapper object.
	PromptTemplate *PromptTemplate `locationName:"promptTemplate" type:"structure"`
	// contains filtered or unexported fields
}

Contains the generation configuration of the external source wrapper object.

func (ExternalSourcesGenerationConfiguration) GoString 

func (s ExternalSourcesGenerationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExternalSourcesGenerationConfiguration) SetGuardrailConfiguration 

func (s *ExternalSourcesGenerationConfiguration) SetGuardrailConfiguration(v *GuardrailConfiguration) *ExternalSourcesGenerationConfiguration

SetGuardrailConfiguration sets the GuardrailConfiguration field's value.

func (*ExternalSourcesGenerationConfiguration) SetInferenceConfig 

func (s *ExternalSourcesGenerationConfiguration) SetInferenceConfig(v *InferenceConfig) *ExternalSourcesGenerationConfiguration

SetInferenceConfig sets the InferenceConfig field's value.

func (*ExternalSourcesGenerationConfiguration) SetPromptTemplate 

func (s *ExternalSourcesGenerationConfiguration) SetPromptTemplate(v *PromptTemplate) *ExternalSourcesGenerationConfiguration

SetPromptTemplate sets the PromptTemplate field's value.

func (ExternalSourcesGenerationConfiguration) String 

func (s ExternalSourcesGenerationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExternalSourcesGenerationConfiguration) Validate 

func (s *ExternalSourcesGenerationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExternalSourcesRetrieveAndGenerateConfiguration 

type ExternalSourcesRetrieveAndGenerateConfiguration struct {

	// The prompt used with the external source wrapper object with the retrieveAndGenerate
	// function.
	GenerationConfiguration *ExternalSourcesGenerationConfiguration `locationName:"generationConfiguration" type:"structure"`

	// The modelArn used with the external source wrapper object in the retrieveAndGenerate
	// function.
	//
	// ModelArn is a required field
	ModelArn *string `locationName:"modelArn" min:"20" type:"string" required:"true"`

	// The document used with the external source wrapper object in the retrieveAndGenerate
	// function.
	//
	// Sources is a required field
	Sources []*ExternalSource `locationName:"sources" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The configurations of the external source wrapper object in the retrieveAndGenerate function.

func (ExternalSourcesRetrieveAndGenerateConfiguration) GoString 

func (s ExternalSourcesRetrieveAndGenerateConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExternalSourcesRetrieveAndGenerateConfiguration) SetGenerationConfiguration 

func (s *ExternalSourcesRetrieveAndGenerateConfiguration) SetGenerationConfiguration(v *ExternalSourcesGenerationConfiguration) *ExternalSourcesRetrieveAndGenerateConfiguration

SetGenerationConfiguration sets the GenerationConfiguration field's value.

func (*ExternalSourcesRetrieveAndGenerateConfiguration) SetModelArn 

func (s *ExternalSourcesRetrieveAndGenerateConfiguration) SetModelArn(v string) *ExternalSourcesRetrieveAndGenerateConfiguration

SetModelArn sets the ModelArn field's value.

func (*ExternalSourcesRetrieveAndGenerateConfiguration) SetSources 

func (s *ExternalSourcesRetrieveAndGenerateConfiguration) SetSources(v []*ExternalSource) *ExternalSourcesRetrieveAndGenerateConfiguration

SetSources sets the Sources field's value.

func (ExternalSourcesRetrieveAndGenerateConfiguration) String 

func (s ExternalSourcesRetrieveAndGenerateConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExternalSourcesRetrieveAndGenerateConfiguration) Validate 

func (s *ExternalSourcesRetrieveAndGenerateConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FailureTrace 

type FailureTrace struct {

	// The reason the interaction failed.
	//
	// FailureReason is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by FailureTrace's
	// String and GoString methods.
	FailureReason *string `locationName:"failureReason" type:"string" sensitive:"true"`

	// The unique identifier of the trace.
	TraceId *string `locationName:"traceId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Contains information about the failure of the interaction.

func (FailureTrace) GoString 

func (s FailureTrace) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailureTrace) SetFailureReason 

func (s *FailureTrace) SetFailureReason(v string) *FailureTrace

SetFailureReason sets the FailureReason field's value.

func (*FailureTrace) SetTraceId 

func (s *FailureTrace) SetTraceId(v string) *FailureTrace

SetTraceId sets the TraceId field's value.

func (FailureTrace) String 

func (s FailureTrace) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FinalResponse 

type FinalResponse struct {

	// The text in the response to the user.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by FinalResponse's
	// String and GoString methods.
	Text *string `locationName:"text" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains details about the response to the user.

func (FinalResponse) GoString 

func (s FinalResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FinalResponse) SetText 

func (s *FinalResponse) SetText(v string) *FinalResponse

SetText sets the Text field's value.

func (FinalResponse) String 

func (s FinalResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FunctionInvocationInput_ 

type FunctionInvocationInput_ struct {

	// The action group that the function belongs to.
	//
	// ActionGroup is a required field
	ActionGroup *string `locationName:"actionGroup" type:"string" required:"true"`

	// The name of the function.
	Function *string `locationName:"function" type:"string"`

	// A list of parameters of the function.
	Parameters []*FunctionParameter `locationName:"parameters" type:"list"`
	// contains filtered or unexported fields
}

Contains information about the function that the agent predicts should be called.

This data type is used in the following API operations:

func (FunctionInvocationInput_) GoString 

func (s FunctionInvocationInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FunctionInvocationInput_) SetActionGroup 

func (s *FunctionInvocationInput_) SetActionGroup(v string) *FunctionInvocationInput_

SetActionGroup sets the ActionGroup field's value.

func (*FunctionInvocationInput_) SetFunction 

func (s *FunctionInvocationInput_) SetFunction(v string) *FunctionInvocationInput_

SetFunction sets the Function field's value.

func (*FunctionInvocationInput_) SetParameters 

func (s *FunctionInvocationInput_) SetParameters(v []*FunctionParameter) *FunctionInvocationInput_

SetParameters sets the Parameters field's value.

func (FunctionInvocationInput_) String 

func (s FunctionInvocationInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FunctionParameter 

type FunctionParameter struct {

	// The name of the parameter.
	Name *string `locationName:"name" type:"string"`

	// The data type of the parameter.
	Type *string `locationName:"type" type:"string"`

	// The value of the parameter.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

Contains information about a parameter of the function.

This data type is used in the following API operations:

func (FunctionParameter) GoString 

func (s FunctionParameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FunctionParameter) SetName 

func (s *FunctionParameter) SetName(v string) *FunctionParameter

SetName sets the Name field's value.

func (*FunctionParameter) SetType 

func (s *FunctionParameter) SetType(v string) *FunctionParameter

SetType sets the Type field's value.

func (*FunctionParameter) SetValue 

func (s *FunctionParameter) SetValue(v string) *FunctionParameter

SetValue sets the Value field's value.

func (FunctionParameter) String 

func (s FunctionParameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FunctionResult 

type FunctionResult struct {

	// The action group that the function belongs to.
	//
	// ActionGroup is a required field
	ActionGroup *string `locationName:"actionGroup" type:"string" required:"true"`

	// The name of the function that was called.
	Function *string `locationName:"function" type:"string"`

	// The response from the function call using the parameters. The key of the
	// object is the content type (currently, only TEXT is supported). The response
	// may be returned directly or from the Lambda function.
	ResponseBody map[string]*ContentBody `locationName:"responseBody" type:"map"`

	// Controls the final response state returned to end user when API/Function
	// execution failed. When this state is FAILURE, the request would fail with
	// dependency failure exception. When this state is REPROMPT, the API/function
	// response will be sent to model for re-prompt
	ResponseState *string `locationName:"responseState" type:"string" enum:"ResponseState"`
	// contains filtered or unexported fields
}

Contains information about the function that was called from the action group and the response that was returned.

This data type is used in the following API operations:

func (FunctionResult) GoString 

func (s FunctionResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FunctionResult) SetActionGroup 

func (s *FunctionResult) SetActionGroup(v string) *FunctionResult

SetActionGroup sets the ActionGroup field's value.

func (*FunctionResult) SetFunction 

func (s *FunctionResult) SetFunction(v string) *FunctionResult

SetFunction sets the Function field's value.

func (*FunctionResult) SetResponseBody 

func (s *FunctionResult) SetResponseBody(v map[string]*ContentBody) *FunctionResult

SetResponseBody sets the ResponseBody field's value.

func (*FunctionResult) SetResponseState 

func (s *FunctionResult) SetResponseState(v string) *FunctionResult

SetResponseState sets the ResponseState field's value.

func (FunctionResult) String 

func (s FunctionResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FunctionResult) Validate 

func (s *FunctionResult) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GeneratedResponsePart 

type GeneratedResponsePart struct {

	// Contains metadata about a textual part of the generated response that is
	// accompanied by a citation.
	//
	// TextResponsePart is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GeneratedResponsePart's
	// String and GoString methods.
	TextResponsePart *TextResponsePart `locationName:"textResponsePart" type:"structure" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains metadata about a part of the generated response that is accompanied by a citation.

This data type is used in the following API operations:

func (GeneratedResponsePart) GoString 

func (s GeneratedResponsePart) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GeneratedResponsePart) SetTextResponsePart 

func (s *GeneratedResponsePart) SetTextResponsePart(v *TextResponsePart) *GeneratedResponsePart

SetTextResponsePart sets the TextResponsePart field's value.

func (GeneratedResponsePart) String 

func (s GeneratedResponsePart) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GenerationConfiguration 

type GenerationConfiguration struct {

	// The configuration details for the guardrail.
	GuardrailConfiguration *GuardrailConfiguration `locationName:"guardrailConfiguration" type:"structure"`

	// Configuration settings for inference when using RetrieveAndGenerate to generate
	// responses while using a knowledge base as a source.
	InferenceConfig *InferenceConfig `locationName:"inferenceConfig" type:"structure"`

	// Contains the template for the prompt that's sent to the model for response
	// generation.
	PromptTemplate *PromptTemplate `locationName:"promptTemplate" type:"structure"`
	// contains filtered or unexported fields
}

Contains configurations for response generation based on the knowledge base query results.

This data type is used in the following API operations:

func (GenerationConfiguration) GoString 

func (s GenerationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GenerationConfiguration) SetGuardrailConfiguration 

func (s *GenerationConfiguration) SetGuardrailConfiguration(v *GuardrailConfiguration) *GenerationConfiguration

SetGuardrailConfiguration sets the GuardrailConfiguration field's value.

func (*GenerationConfiguration) SetInferenceConfig 

func (s *GenerationConfiguration) SetInferenceConfig(v *InferenceConfig) *GenerationConfiguration

SetInferenceConfig sets the InferenceConfig field's value.

func (*GenerationConfiguration) SetPromptTemplate 

func (s *GenerationConfiguration) SetPromptTemplate(v *PromptTemplate) *GenerationConfiguration

SetPromptTemplate sets the PromptTemplate field's value.

func (GenerationConfiguration) String 

func (s GenerationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GenerationConfiguration) Validate 

func (s *GenerationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GuardrailAssessment 

type GuardrailAssessment struct {

	// Content policy details of the Guardrail.
	//
	// ContentPolicy is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GuardrailAssessment's
	// String and GoString methods.
	ContentPolicy *GuardrailContentPolicyAssessment `locationName:"contentPolicy" type:"structure" sensitive:"true"`

	// Sensitive Information policy details of Guardrail.
	//
	// SensitiveInformationPolicy is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GuardrailAssessment's
	// String and GoString methods.
	SensitiveInformationPolicy *GuardrailSensitiveInformationPolicyAssessment `locationName:"sensitiveInformationPolicy" type:"structure" sensitive:"true"`

	// Topic policy details of the Guardrail.
	//
	// TopicPolicy is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GuardrailAssessment's
	// String and GoString methods.
	TopicPolicy *GuardrailTopicPolicyAssessment `locationName:"topicPolicy" type:"structure" sensitive:"true"`

	// Word policy details of the Guardrail.
	//
	// WordPolicy is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GuardrailAssessment's
	// String and GoString methods.
	WordPolicy *GuardrailWordPolicyAssessment `locationName:"wordPolicy" type:"structure" sensitive:"true"`
	// contains filtered or unexported fields
}

Assessment details of the content analyzed by Guardrails.

func (GuardrailAssessment) GoString 

func (s GuardrailAssessment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailAssessment) SetContentPolicy 

func (s *GuardrailAssessment) SetContentPolicy(v *GuardrailContentPolicyAssessment) *GuardrailAssessment

SetContentPolicy sets the ContentPolicy field's value.

func (*GuardrailAssessment) SetSensitiveInformationPolicy 

func (s *GuardrailAssessment) SetSensitiveInformationPolicy(v *GuardrailSensitiveInformationPolicyAssessment) *GuardrailAssessment

SetSensitiveInformationPolicy sets the SensitiveInformationPolicy field's value.

func (*GuardrailAssessment) SetTopicPolicy 

func (s *GuardrailAssessment) SetTopicPolicy(v *GuardrailTopicPolicyAssessment) *GuardrailAssessment

SetTopicPolicy sets the TopicPolicy field's value.

func (*GuardrailAssessment) SetWordPolicy 

func (s *GuardrailAssessment) SetWordPolicy(v *GuardrailWordPolicyAssessment) *GuardrailAssessment

SetWordPolicy sets the WordPolicy field's value.

func (GuardrailAssessment) String 

func (s GuardrailAssessment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GuardrailConfiguration 

type GuardrailConfiguration struct {

	// The unique identifier for the guardrail.
	//
	// GuardrailId is a required field
	GuardrailId *string `locationName:"guardrailId" type:"string" required:"true"`

	// The version of the guardrail.
	//
	// GuardrailVersion is a required field
	GuardrailVersion *string `locationName:"guardrailVersion" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The configuration details for the guardrail.

func (GuardrailConfiguration) GoString 

func (s GuardrailConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailConfiguration) SetGuardrailId 

func (s *GuardrailConfiguration) SetGuardrailId(v string) *GuardrailConfiguration

SetGuardrailId sets the GuardrailId field's value.

func (*GuardrailConfiguration) SetGuardrailVersion 

func (s *GuardrailConfiguration) SetGuardrailVersion(v string) *GuardrailConfiguration

SetGuardrailVersion sets the GuardrailVersion field's value.

func (GuardrailConfiguration) String 

func (s GuardrailConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailConfiguration) Validate 

func (s *GuardrailConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GuardrailContentFilter 

type GuardrailContentFilter struct {

	// The action placed on the content by the Guardrail filter.
	Action *string `locationName:"action" type:"string" enum:"GuardrailContentPolicyAction"`

	// The confidence level regarding the content detected in the filter by the
	// Guardrail.
	Confidence *string `locationName:"confidence" type:"string" enum:"GuardrailContentFilterConfidence"`

	// The type of content detected in the filter by the Guardrail.
	Type *string `locationName:"type" type:"string" enum:"GuardrailContentFilterType"`
	// contains filtered or unexported fields
}

Details of the content filter used in the Guardrail.

func (GuardrailContentFilter) GoString 

func (s GuardrailContentFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailContentFilter) SetAction 

func (s *GuardrailContentFilter) SetAction(v string) *GuardrailContentFilter

SetAction sets the Action field's value.

func (*GuardrailContentFilter) SetConfidence 

func (s *GuardrailContentFilter) SetConfidence(v string) *GuardrailContentFilter

SetConfidence sets the Confidence field's value.

func (*GuardrailContentFilter) SetType 

func (s *GuardrailContentFilter) SetType(v string) *GuardrailContentFilter

SetType sets the Type field's value.

func (GuardrailContentFilter) String 

func (s GuardrailContentFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GuardrailContentPolicyAssessment 

type GuardrailContentPolicyAssessment struct {

	// The filter details of the policy assessment used in the Guardrails filter.
	//
	// Filters is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GuardrailContentPolicyAssessment's
	// String and GoString methods.
	Filters []*GuardrailContentFilter `locationName:"filters" type:"list" sensitive:"true"`
	// contains filtered or unexported fields
}

The details of the policy assessment in the Guardrails filter.

func (GuardrailContentPolicyAssessment) GoString 

func (s GuardrailContentPolicyAssessment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailContentPolicyAssessment) SetFilters 

func (s *GuardrailContentPolicyAssessment) SetFilters(v []*GuardrailContentFilter) *GuardrailContentPolicyAssessment

SetFilters sets the Filters field's value.

func (GuardrailContentPolicyAssessment) String 

func (s GuardrailContentPolicyAssessment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GuardrailCustomWord 

type GuardrailCustomWord struct {

	// The action details for the custom word filter in the Guardrail.
	Action *string `locationName:"action" type:"string" enum:"GuardrailWordPolicyAction"`

	// The match details for the custom word filter in the Guardrail.
	Match *string `locationName:"match" type:"string"`
	// contains filtered or unexported fields
}

The custom word details for the filter in the Guardrail.

func (GuardrailCustomWord) GoString 

func (s GuardrailCustomWord) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailCustomWord) SetAction 

func (s *GuardrailCustomWord) SetAction(v string) *GuardrailCustomWord

SetAction sets the Action field's value.

func (*GuardrailCustomWord) SetMatch 

func (s *GuardrailCustomWord) SetMatch(v string) *GuardrailCustomWord

SetMatch sets the Match field's value.

func (GuardrailCustomWord) String 

func (s GuardrailCustomWord) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GuardrailManagedWord 

type GuardrailManagedWord struct {

	// The action details for the managed word filter in the Guardrail.
	Action *string `locationName:"action" type:"string" enum:"GuardrailWordPolicyAction"`

	// The match details for the managed word filter in the Guardrail.
	Match *string `locationName:"match" type:"string"`

	// The type details for the managed word filter in the Guardrail.
	Type *string `locationName:"type" type:"string" enum:"GuardrailManagedWordType"`
	// contains filtered or unexported fields
}

The managed word details for the filter in the Guardrail.

func (GuardrailManagedWord) GoString 

func (s GuardrailManagedWord) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailManagedWord) SetAction 

func (s *GuardrailManagedWord) SetAction(v string) *GuardrailManagedWord

SetAction sets the Action field's value.

func (*GuardrailManagedWord) SetMatch 

func (s *GuardrailManagedWord) SetMatch(v string) *GuardrailManagedWord

SetMatch sets the Match field's value.

func (*GuardrailManagedWord) SetType 

func (s *GuardrailManagedWord) SetType(v string) *GuardrailManagedWord

SetType sets the Type field's value.

func (GuardrailManagedWord) String 

func (s GuardrailManagedWord) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GuardrailPiiEntityFilter 

type GuardrailPiiEntityFilter struct {

	// The action of the Guardrail filter to identify and remove PII.
	Action *string `locationName:"action" type:"string" enum:"GuardrailSensitiveInformationPolicyAction"`

	// The match to settings in the Guardrail filter to identify and remove PII.
	Match *string `locationName:"match" type:"string"`

	// The type of PII the Guardrail filter has identified and removed.
	Type *string `locationName:"type" type:"string" enum:"GuardrailPiiEntityType"`
	// contains filtered or unexported fields
}

The Guardrail filter to identify and remove personally identifiable information (PII).

func (GuardrailPiiEntityFilter) GoString 

func (s GuardrailPiiEntityFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailPiiEntityFilter) SetAction 

func (s *GuardrailPiiEntityFilter) SetAction(v string) *GuardrailPiiEntityFilter

SetAction sets the Action field's value.

func (*GuardrailPiiEntityFilter) SetMatch 

func (s *GuardrailPiiEntityFilter) SetMatch(v string) *GuardrailPiiEntityFilter

SetMatch sets the Match field's value.

func (*GuardrailPiiEntityFilter) SetType 

func (s *GuardrailPiiEntityFilter) SetType(v string) *GuardrailPiiEntityFilter

SetType sets the Type field's value.

func (GuardrailPiiEntityFilter) String 

func (s GuardrailPiiEntityFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GuardrailRegexFilter 

type GuardrailRegexFilter struct {

	// The action details for the regex filter used in the Guardrail.
	Action *string `locationName:"action" type:"string" enum:"GuardrailSensitiveInformationPolicyAction"`

	// The match details for the regex filter used in the Guardrail.
	Match *string `locationName:"match" type:"string"`

	// The name details for the regex filter used in the Guardrail.
	Name *string `locationName:"name" type:"string"`

	// The regex details for the regex filter used in the Guardrail.
	Regex *string `locationName:"regex" type:"string"`
	// contains filtered or unexported fields
}

The details for the regex filter used in the Guardrail.

func (GuardrailRegexFilter) GoString 

func (s GuardrailRegexFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailRegexFilter) SetAction 

func (s *GuardrailRegexFilter) SetAction(v string) *GuardrailRegexFilter

SetAction sets the Action field's value.

func (*GuardrailRegexFilter) SetMatch 

func (s *GuardrailRegexFilter) SetMatch(v string) *GuardrailRegexFilter

SetMatch sets the Match field's value.

func (*GuardrailRegexFilter) SetName 

func (s *GuardrailRegexFilter) SetName(v string) *GuardrailRegexFilter

SetName sets the Name field's value.

func (*GuardrailRegexFilter) SetRegex 

func (s *GuardrailRegexFilter) SetRegex(v string) *GuardrailRegexFilter

SetRegex sets the Regex field's value.

func (GuardrailRegexFilter) String 

func (s GuardrailRegexFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GuardrailSensitiveInformationPolicyAssessment 

type GuardrailSensitiveInformationPolicyAssessment struct {

	// The details of the PII entities used in the sensitive policy assessment for
	// the Guardrail.
	//
	// PiiEntities is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GuardrailSensitiveInformationPolicyAssessment's
	// String and GoString methods.
	PiiEntities []*GuardrailPiiEntityFilter `locationName:"piiEntities" type:"list" sensitive:"true"`

	// The details of the regexes used in the sensitive policy assessment for the
	// Guardrail.
	//
	// Regexes is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GuardrailSensitiveInformationPolicyAssessment's
	// String and GoString methods.
	Regexes []*GuardrailRegexFilter `locationName:"regexes" type:"list" sensitive:"true"`
	// contains filtered or unexported fields
}

The details of the sensitive policy assessment used in the Guardrail.

func (GuardrailSensitiveInformationPolicyAssessment) GoString 

func (s GuardrailSensitiveInformationPolicyAssessment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailSensitiveInformationPolicyAssessment) SetPiiEntities 

func (s *GuardrailSensitiveInformationPolicyAssessment) SetPiiEntities(v []*GuardrailPiiEntityFilter) *GuardrailSensitiveInformationPolicyAssessment

SetPiiEntities sets the PiiEntities field's value.

func (*GuardrailSensitiveInformationPolicyAssessment) SetRegexes 

func (s *GuardrailSensitiveInformationPolicyAssessment) SetRegexes(v []*GuardrailRegexFilter) *GuardrailSensitiveInformationPolicyAssessment

SetRegexes sets the Regexes field's value.

func (GuardrailSensitiveInformationPolicyAssessment) String 

func (s GuardrailSensitiveInformationPolicyAssessment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GuardrailTopic 

type GuardrailTopic struct {

	// The action details on a specific topic in the Guardrail.
	Action *string `locationName:"action" type:"string" enum:"GuardrailTopicPolicyAction"`

	// The name details on a specific topic in the Guardrail.
	Name *string `locationName:"name" type:"string"`

	// The type details on a specific topic in the Guardrail.
	Type *string `locationName:"type" type:"string" enum:"GuardrailTopicType"`
	// contains filtered or unexported fields
}

The details for a specific topic defined in the Guardrail.

func (GuardrailTopic) GoString 

func (s GuardrailTopic) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailTopic) SetAction 

func (s *GuardrailTopic) SetAction(v string) *GuardrailTopic

SetAction sets the Action field's value.

func (*GuardrailTopic) SetName 

func (s *GuardrailTopic) SetName(v string) *GuardrailTopic

SetName sets the Name field's value.

func (*GuardrailTopic) SetType 

func (s *GuardrailTopic) SetType(v string) *GuardrailTopic

SetType sets the Type field's value.

func (GuardrailTopic) String 

func (s GuardrailTopic) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GuardrailTopicPolicyAssessment 

type GuardrailTopicPolicyAssessment struct {

	// The topic details of the policy assessment used in the Guardrail.
	//
	// Topics is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GuardrailTopicPolicyAssessment's
	// String and GoString methods.
	Topics []*GuardrailTopic `locationName:"topics" type:"list" sensitive:"true"`
	// contains filtered or unexported fields
}

The details of the policy assessment used in the Guardrail.

func (GuardrailTopicPolicyAssessment) GoString 

func (s GuardrailTopicPolicyAssessment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailTopicPolicyAssessment) SetTopics 

func (s *GuardrailTopicPolicyAssessment) SetTopics(v []*GuardrailTopic) *GuardrailTopicPolicyAssessment

SetTopics sets the Topics field's value.

func (GuardrailTopicPolicyAssessment) String 

func (s GuardrailTopicPolicyAssessment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GuardrailTrace 

type GuardrailTrace struct {

	// The trace action details used with the Guardrail.
	Action *string `locationName:"action" type:"string" enum:"GuardrailAction"`

	// The details of the input assessments used in the Guardrail Trace.
	InputAssessments []*GuardrailAssessment `locationName:"inputAssessments" type:"list"`

	// The details of the output assessments used in the Guardrail Trace.
	OutputAssessments []*GuardrailAssessment `locationName:"outputAssessments" type:"list"`

	// The details of the trace Id used in the Guardrail Trace.
	TraceId *string `locationName:"traceId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

The trace details used in the Guardrail.

func (GuardrailTrace) GoString 

func (s GuardrailTrace) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailTrace) SetAction 

func (s *GuardrailTrace) SetAction(v string) *GuardrailTrace

SetAction sets the Action field's value.

func (*GuardrailTrace) SetInputAssessments 

func (s *GuardrailTrace) SetInputAssessments(v []*GuardrailAssessment) *GuardrailTrace

SetInputAssessments sets the InputAssessments field's value.

func (*GuardrailTrace) SetOutputAssessments 

func (s *GuardrailTrace) SetOutputAssessments(v []*GuardrailAssessment) *GuardrailTrace

SetOutputAssessments sets the OutputAssessments field's value.

func (*GuardrailTrace) SetTraceId 

func (s *GuardrailTrace) SetTraceId(v string) *GuardrailTrace

SetTraceId sets the TraceId field's value.

func (GuardrailTrace) String 

func (s GuardrailTrace) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GuardrailWordPolicyAssessment 

type GuardrailWordPolicyAssessment struct {

	// The custom word details for words defined in the Guardrail filter.
	//
	// CustomWords is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GuardrailWordPolicyAssessment's
	// String and GoString methods.
	CustomWords []*GuardrailCustomWord `locationName:"customWords" type:"list" sensitive:"true"`

	// The managed word lists for words defined in the Guardrail filter.
	//
	// ManagedWordLists is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GuardrailWordPolicyAssessment's
	// String and GoString methods.
	ManagedWordLists []*GuardrailManagedWord `locationName:"managedWordLists" type:"list" sensitive:"true"`
	// contains filtered or unexported fields
}

The assessment details for words defined in the Guardrail filter.

func (GuardrailWordPolicyAssessment) GoString 

func (s GuardrailWordPolicyAssessment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailWordPolicyAssessment) SetCustomWords 

func (s *GuardrailWordPolicyAssessment) SetCustomWords(v []*GuardrailCustomWord) *GuardrailWordPolicyAssessment

SetCustomWords sets the CustomWords field's value.

func (*GuardrailWordPolicyAssessment) SetManagedWordLists 

func (s *GuardrailWordPolicyAssessment) SetManagedWordLists(v []*GuardrailManagedWord) *GuardrailWordPolicyAssessment

SetManagedWordLists sets the ManagedWordLists field's value.

func (GuardrailWordPolicyAssessment) String 

func (s GuardrailWordPolicyAssessment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InferenceConfig 

type InferenceConfig struct {

	// Configuration settings specific to text generation while generating responses
	// using RetrieveAndGenerate.
	TextInferenceConfig *TextInferenceConfig `locationName:"textInferenceConfig" type:"structure"`
	// contains filtered or unexported fields
}

The configuration for inference settings when generating responses using RetrieveAndGenerate.

func (InferenceConfig) GoString 

func (s InferenceConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InferenceConfig) SetTextInferenceConfig 

func (s *InferenceConfig) SetTextInferenceConfig(v *TextInferenceConfig) *InferenceConfig

SetTextInferenceConfig sets the TextInferenceConfig field's value.

func (InferenceConfig) String 

func (s InferenceConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InferenceConfiguration 

type InferenceConfiguration struct {

	// The maximum number of tokens allowed in the generated response.
	MaximumLength *int64 `locationName:"maximumLength" type:"integer"`

	// A list of stop sequences. A stop sequence is a sequence of characters that
	// causes the model to stop generating the response.
	StopSequences []*string `locationName:"stopSequences" type:"list"`

	// 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 *float64 `locationName:"temperature" type:"float"`

	// 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 *int64 `locationName:"topK" type:"integer"`

	// 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 *float64 `locationName:"topP" type:"float"`
	// contains filtered or unexported fields
}

Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).

func (InferenceConfiguration) GoString 

func (s InferenceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InferenceConfiguration) SetMaximumLength 

func (s *InferenceConfiguration) SetMaximumLength(v int64) *InferenceConfiguration

SetMaximumLength sets the MaximumLength field's value.

func (*InferenceConfiguration) SetStopSequences 

func (s *InferenceConfiguration) SetStopSequences(v []*string) *InferenceConfiguration

SetStopSequences sets the StopSequences field's value.

func (*InferenceConfiguration) SetTemperature 

func (s *InferenceConfiguration) SetTemperature(v float64) *InferenceConfiguration

SetTemperature sets the Temperature field's value.

func (*InferenceConfiguration) SetTopK 

func (s *InferenceConfiguration) SetTopK(v int64) *InferenceConfiguration

SetTopK sets the TopK field's value.

func (*InferenceConfiguration) SetTopP 

func (s *InferenceConfiguration) SetTopP(v float64) *InferenceConfiguration

SetTopP sets the TopP field's value.

func (InferenceConfiguration) String 

func (s InferenceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An internal server error occurred. Retry your request.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) MarshalEvent 

func (s *InternalServerException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) UnmarshalEvent 

func (s *InternalServerException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the InternalServerException value. This method is only used internally within the SDK's EventStream handling.

type InvocationInputMember 

type InvocationInputMember struct {

	// Contains information about the API operation that the agent predicts should
	// be called.
	ApiInvocationInput *ApiInvocationInput_ `locationName:"apiInvocationInput" type:"structure"`

	// Contains information about the function that the agent predicts should be
	// called.
	FunctionInvocationInput *FunctionInvocationInput_ `locationName:"functionInvocationInput" type:"structure"`
	// contains filtered or unexported fields
}

Contains details about the API operation or function that the agent predicts should be called.

This data type is used in the following API operations:

func (InvocationInputMember) GoString 

func (s InvocationInputMember) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvocationInputMember) SetApiInvocationInput 

func (s *InvocationInputMember) SetApiInvocationInput(v *ApiInvocationInput_) *InvocationInputMember

SetApiInvocationInput sets the ApiInvocationInput field's value.

func (*InvocationInputMember) SetFunctionInvocationInput 

func (s *InvocationInputMember) SetFunctionInvocationInput(v *FunctionInvocationInput_) *InvocationInputMember

SetFunctionInvocationInput sets the FunctionInvocationInput field's value.

func (InvocationInputMember) String 

func (s InvocationInputMember) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvocationInput_ 

type InvocationInput_ struct {

	// Contains information about the action group to be invoked.
	ActionGroupInvocationInput *ActionGroupInvocationInput_ `locationName:"actionGroupInvocationInput" type:"structure"`

	// Specifies whether the agent is invoking an action group or a knowledge base.
	InvocationType *string `locationName:"invocationType" type:"string" enum:"InvocationType"`

	// Contains details about the knowledge base to look up and the query to be
	// made.
	KnowledgeBaseLookupInput *KnowledgeBaseLookupInput_ `locationName:"knowledgeBaseLookupInput" type:"structure"`

	// The unique identifier of the trace.
	TraceId *string `locationName:"traceId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Contains information pertaining to the action group or knowledge base that is being invoked.

func (InvocationInput_) GoString 

func (s InvocationInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvocationInput_) SetActionGroupInvocationInput 

func (s *InvocationInput_) SetActionGroupInvocationInput(v *ActionGroupInvocationInput_) *InvocationInput_

SetActionGroupInvocationInput sets the ActionGroupInvocationInput field's value.

func (*InvocationInput_) SetInvocationType 

func (s *InvocationInput_) SetInvocationType(v string) *InvocationInput_

SetInvocationType sets the InvocationType field's value.

func (*InvocationInput_) SetKnowledgeBaseLookupInput 

func (s *InvocationInput_) SetKnowledgeBaseLookupInput(v *KnowledgeBaseLookupInput_) *InvocationInput_

SetKnowledgeBaseLookupInput sets the KnowledgeBaseLookupInput field's value.

func (*InvocationInput_) SetTraceId 

func (s *InvocationInput_) SetTraceId(v string) *InvocationInput_

SetTraceId sets the TraceId field's value.

func (InvocationInput_) String 

func (s InvocationInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvocationResultMember 

type InvocationResultMember struct {

	// The result from the API response from the action group invocation.
	ApiResult *ApiResult `locationName:"apiResult" type:"structure"`

	// The result from the function from the action group invocation.
	FunctionResult *FunctionResult `locationName:"functionResult" type:"structure"`
	// contains filtered or unexported fields
}

A result from the invocation of an action. For more information, see Return control to the agent developer (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html) and Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).

This data type is used in the following API operations:

func (InvocationResultMember) GoString 

func (s InvocationResultMember) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvocationResultMember) SetApiResult 

func (s *InvocationResultMember) SetApiResult(v *ApiResult) *InvocationResultMember

SetApiResult sets the ApiResult field's value.

func (*InvocationResultMember) SetFunctionResult 

func (s *InvocationResultMember) SetFunctionResult(v *FunctionResult) *InvocationResultMember

SetFunctionResult sets the FunctionResult field's value.

func (InvocationResultMember) String 

func (s InvocationResultMember) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvocationResultMember) Validate 

func (s *InvocationResultMember) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InvokeAgentEventStream 

type InvokeAgentEventStream struct {

	// Reader is the EventStream reader for the ResponseStream
	// events. This value is automatically set by the SDK when the API call is made
	// Use this member when unit testing your code with the SDK to mock out the
	// EventStream Reader.
	//
	// Must not be nil.
	Reader ResponseStreamReader
	// contains filtered or unexported fields
}

InvokeAgentEventStream provides the event stream handling for the InvokeAgent.

For testing and mocking the event stream this type should be initialized via the NewInvokeAgentEventStream constructor function. Using the functional options to pass in nested mock behavior.

func NewInvokeAgentEventStream 

func NewInvokeAgentEventStream(opts ...func(*InvokeAgentEventStream)) *InvokeAgentEventStream

NewInvokeAgentEventStream initializes an InvokeAgentEventStream. This function should only be used for testing and mocking the InvokeAgentEventStream stream within your application.

The Reader member must be set before reading events from the stream. 

es := NewInvokeAgentEventStream(func(o *InvokeAgentEventStream){
    es.Reader = myMockStreamReader
})

func (*InvokeAgentEventStream) Close 

func (es *InvokeAgentEventStream) Close() (err error)

Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.

You can use the closing of the Reader's Events channel to terminate your application's read from the API's stream.

func (*InvokeAgentEventStream) Err 

func (es *InvokeAgentEventStream) Err() error

Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.

func (*InvokeAgentEventStream) Events 

func (es *InvokeAgentEventStream) Events() <-chan ResponseStreamEvent

Events returns a channel to read events from.

These events are:

  • PayloadPart
  • ReturnControlPayload
  • TracePart
  • ResponseStreamUnknownEvent

type InvokeAgentInput 

type InvokeAgentInput struct {

	// The alias of the agent to use.
	//
	// AgentAliasId is a required field
	AgentAliasId *string `location:"uri" locationName:"agentAliasId" type:"string" required:"true"`

	// The unique identifier of the agent to use.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// Specifies whether to turn on the trace or not to track the agent's reasoning
	// process. For more information, see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events).
	EnableTrace *bool `locationName:"enableTrace" type:"boolean"`

	// Specifies whether to end the session with the agent or not.
	EndSession *bool `locationName:"endSession" type:"boolean"`

	// The prompt text to send the agent.
	//
	// If you include returnControlInvocationResults in the sessionState field,
	// the inputText field will be ignored.
	//
	// InputText is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InvokeAgentInput's
	// String and GoString methods.
	InputText *string `locationName:"inputText" type:"string" sensitive:"true"`

	// The unique identifier of the session. Use the same value across requests
	// to continue the same conversation.
	//
	// SessionId is a required field
	SessionId *string `location:"uri" locationName:"sessionId" min:"2" type:"string" required:"true"`

	// Contains parameters that specify various attributes of the session. For more
	// information, see Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).
	//
	// If you include returnControlInvocationResults in the sessionState field,
	// the inputText field will be ignored.
	SessionState *SessionState `locationName:"sessionState" type:"structure"`
	// contains filtered or unexported fields
}

func (InvokeAgentInput) GoString 

func (s InvokeAgentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvokeAgentInput) SetAgentAliasId 

func (s *InvokeAgentInput) SetAgentAliasId(v string) *InvokeAgentInput

SetAgentAliasId sets the AgentAliasId field's value.

func (*InvokeAgentInput) SetAgentId 

func (s *InvokeAgentInput) SetAgentId(v string) *InvokeAgentInput

SetAgentId sets the AgentId field's value.

func (*InvokeAgentInput) SetEnableTrace 

func (s *InvokeAgentInput) SetEnableTrace(v bool) *InvokeAgentInput

SetEnableTrace sets the EnableTrace field's value.

func (*InvokeAgentInput) SetEndSession 

func (s *InvokeAgentInput) SetEndSession(v bool) *InvokeAgentInput

SetEndSession sets the EndSession field's value.

func (*InvokeAgentInput) SetInputText 

func (s *InvokeAgentInput) SetInputText(v string) *InvokeAgentInput

SetInputText sets the InputText field's value.

func (*InvokeAgentInput) SetSessionId 

func (s *InvokeAgentInput) SetSessionId(v string) *InvokeAgentInput

SetSessionId sets the SessionId field's value.

func (*InvokeAgentInput) SetSessionState 

func (s *InvokeAgentInput) SetSessionState(v *SessionState) *InvokeAgentInput

SetSessionState sets the SessionState field's value.

func (InvokeAgentInput) String 

func (s InvokeAgentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvokeAgentInput) Validate 

func (s *InvokeAgentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InvokeAgentOutput 

type InvokeAgentOutput struct {

	// The MIME type of the input data in the request. The default value is application/json.
	//
	// ContentType is a required field
	ContentType *string `location:"header" locationName:"x-amzn-bedrock-agent-content-type" type:"string" required:"true"`

	// The unique identifier of the session with the agent.
	//
	// SessionId is a required field
	SessionId *string `location:"header" locationName:"x-amz-bedrock-agent-session-id" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (*InvokeAgentOutput) GetStream 

func (s *InvokeAgentOutput) GetStream() *InvokeAgentEventStream

GetStream returns the type to interact with the event stream.

func (InvokeAgentOutput) GoString 

func (s InvokeAgentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvokeAgentOutput) SetContentType 

func (s *InvokeAgentOutput) SetContentType(v string) *InvokeAgentOutput

SetContentType sets the ContentType field's value.

func (*InvokeAgentOutput) SetSessionId 

func (s *InvokeAgentOutput) SetSessionId(v string) *InvokeAgentOutput

SetSessionId sets the SessionId field's value.

func (InvokeAgentOutput) String 

func (s InvokeAgentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KnowledgeBaseLookupInput_ 

type KnowledgeBaseLookupInput_ struct {

	// The unique identifier of the knowledge base to look up.
	//
	// KnowledgeBaseId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by KnowledgeBaseLookupInput_'s
	// String and GoString methods.
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" sensitive:"true"`

	// The query made to the knowledge base.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by KnowledgeBaseLookupInput_'s
	// String and GoString methods.
	Text *string `locationName:"text" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains details about the knowledge base to look up and the query to be made.

func (KnowledgeBaseLookupInput_) GoString 

func (s KnowledgeBaseLookupInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseLookupInput_) SetKnowledgeBaseId 

func (s *KnowledgeBaseLookupInput_) SetKnowledgeBaseId(v string) *KnowledgeBaseLookupInput_

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*KnowledgeBaseLookupInput_) SetText 

func (s *KnowledgeBaseLookupInput_) SetText(v string) *KnowledgeBaseLookupInput_

SetText sets the Text field's value.

func (KnowledgeBaseLookupInput_) String 

func (s KnowledgeBaseLookupInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KnowledgeBaseLookupOutput_ 

type KnowledgeBaseLookupOutput_ struct {

	// Contains metadata about the sources cited for the generated response.
	RetrievedReferences []*RetrievedReference `locationName:"retrievedReferences" type:"list"`
	// contains filtered or unexported fields
}

Contains details about the results from looking up the knowledge base.

func (KnowledgeBaseLookupOutput_) GoString 

func (s KnowledgeBaseLookupOutput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseLookupOutput_) SetRetrievedReferences 

func (s *KnowledgeBaseLookupOutput_) SetRetrievedReferences(v []*RetrievedReference) *KnowledgeBaseLookupOutput_

SetRetrievedReferences sets the RetrievedReferences field's value.

func (KnowledgeBaseLookupOutput_) String 

func (s KnowledgeBaseLookupOutput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KnowledgeBaseQuery 

type KnowledgeBaseQuery struct {

	// The text of the query made to the knowledge base.
	//
	// Text is a required field
	Text *string `locationName:"text" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the query made to the knowledge base.

This data type is used in the following API operations:

func (KnowledgeBaseQuery) GoString 

func (s KnowledgeBaseQuery) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseQuery) SetText 

func (s *KnowledgeBaseQuery) SetText(v string) *KnowledgeBaseQuery

SetText sets the Text field's value.

func (KnowledgeBaseQuery) String 

func (s KnowledgeBaseQuery) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseQuery) Validate 

func (s *KnowledgeBaseQuery) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KnowledgeBaseRetrievalConfiguration 

type KnowledgeBaseRetrievalConfiguration struct {

	// Contains details about how the results from the vector search should be returned.
	// For more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
	//
	// VectorSearchConfiguration is a required field
	VectorSearchConfiguration *KnowledgeBaseVectorSearchConfiguration `locationName:"vectorSearchConfiguration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).

This data type is used in the following API operations:

func (KnowledgeBaseRetrievalConfiguration) GoString 

func (s KnowledgeBaseRetrievalConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseRetrievalConfiguration) SetVectorSearchConfiguration 

func (s *KnowledgeBaseRetrievalConfiguration) SetVectorSearchConfiguration(v *KnowledgeBaseVectorSearchConfiguration) *KnowledgeBaseRetrievalConfiguration

SetVectorSearchConfiguration sets the VectorSearchConfiguration field's value.

func (KnowledgeBaseRetrievalConfiguration) String 

func (s KnowledgeBaseRetrievalConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseRetrievalConfiguration) Validate 

func (s *KnowledgeBaseRetrievalConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KnowledgeBaseRetrievalResult 

type KnowledgeBaseRetrievalResult struct {

	// Contains a chunk of text from a data source in the knowledge base.
	//
	// Content is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by KnowledgeBaseRetrievalResult's
	// String and GoString methods.
	//
	// Content is a required field
	Content *RetrievalResultContent `locationName:"content" type:"structure" required:"true" sensitive:"true"`

	// Contains information about the location of the data source.
	//
	// Location is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by KnowledgeBaseRetrievalResult's
	// String and GoString methods.
	Location *RetrievalResultLocation `locationName:"location" type:"structure" sensitive:"true"`

	// The level of relevance of the result to the query.
	Score *float64 `locationName:"score" type:"double"`
	// contains filtered or unexported fields
}

Details about a result from querying the knowledge base.

This data type is used in the following API operations:

func (KnowledgeBaseRetrievalResult) GoString 

func (s KnowledgeBaseRetrievalResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseRetrievalResult) SetContent 

func (s *KnowledgeBaseRetrievalResult) SetContent(v *RetrievalResultContent) *KnowledgeBaseRetrievalResult

SetContent sets the Content field's value.

func (*KnowledgeBaseRetrievalResult) SetLocation 

func (s *KnowledgeBaseRetrievalResult) SetLocation(v *RetrievalResultLocation) *KnowledgeBaseRetrievalResult

SetLocation sets the Location field's value.

func (*KnowledgeBaseRetrievalResult) SetScore 

func (s *KnowledgeBaseRetrievalResult) SetScore(v float64) *KnowledgeBaseRetrievalResult

SetScore sets the Score field's value.

func (KnowledgeBaseRetrievalResult) String 

func (s KnowledgeBaseRetrievalResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KnowledgeBaseRetrieveAndGenerateConfiguration 

type KnowledgeBaseRetrieveAndGenerateConfiguration struct {

	// Contains configurations for response generation based on the knowwledge base
	// query results.
	GenerationConfiguration *GenerationConfiguration `locationName:"generationConfiguration" type:"structure"`

	// The unique identifier of the knowledge base that is queried and the foundation
	// model used for generation.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The ARN of the foundation model used to generate a response.
	//
	// ModelArn is a required field
	ModelArn *string `locationName:"modelArn" min:"20" type:"string" required:"true"`

	// Contains configurations for how to retrieve and return the knowledge base
	// query.
	RetrievalConfiguration *KnowledgeBaseRetrievalConfiguration `locationName:"retrievalConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

Contains details about the resource being queried.

This data type is used in the following API operations:

func (KnowledgeBaseRetrieveAndGenerateConfiguration) GoString 

func (s KnowledgeBaseRetrieveAndGenerateConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseRetrieveAndGenerateConfiguration) SetGenerationConfiguration 

func (s *KnowledgeBaseRetrieveAndGenerateConfiguration) SetGenerationConfiguration(v *GenerationConfiguration) *KnowledgeBaseRetrieveAndGenerateConfiguration

SetGenerationConfiguration sets the GenerationConfiguration field's value.

func (*KnowledgeBaseRetrieveAndGenerateConfiguration) SetKnowledgeBaseId 

func (s *KnowledgeBaseRetrieveAndGenerateConfiguration) SetKnowledgeBaseId(v string) *KnowledgeBaseRetrieveAndGenerateConfiguration

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*KnowledgeBaseRetrieveAndGenerateConfiguration) SetModelArn 

func (s *KnowledgeBaseRetrieveAndGenerateConfiguration) SetModelArn(v string) *KnowledgeBaseRetrieveAndGenerateConfiguration

SetModelArn sets the ModelArn field's value.

func (*KnowledgeBaseRetrieveAndGenerateConfiguration) SetRetrievalConfiguration 

func (s *KnowledgeBaseRetrieveAndGenerateConfiguration) SetRetrievalConfiguration(v *KnowledgeBaseRetrievalConfiguration) *KnowledgeBaseRetrieveAndGenerateConfiguration

SetRetrievalConfiguration sets the RetrievalConfiguration field's value.

func (KnowledgeBaseRetrieveAndGenerateConfiguration) String 

func (s KnowledgeBaseRetrieveAndGenerateConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseRetrieveAndGenerateConfiguration) Validate 

func (s *KnowledgeBaseRetrieveAndGenerateConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KnowledgeBaseVectorSearchConfiguration 

type KnowledgeBaseVectorSearchConfiguration struct {

	// Specifies the filters to use on the metadata in the knowledge base data sources
	// before returning results. For more information, see Query configurations
	// (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
	//
	// Filter is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by KnowledgeBaseVectorSearchConfiguration's
	// String and GoString methods.
	Filter *RetrievalFilter `locationName:"filter" type:"structure" sensitive:"true"`

	// The number of source chunks to retrieve.
	NumberOfResults *int64 `locationName:"numberOfResults" min:"1" type:"integer"`

	// By default, Amazon Bedrock decides a search strategy for you. If you're using
	// an Amazon OpenSearch Serverless vector store that contains a filterable text
	// field, you can specify whether to query the knowledge base with a HYBRID
	// search using both vector embeddings and raw text, or SEMANTIC search using
	// only vector embeddings. For other vector store configurations, only SEMANTIC
	// search is available. For more information, see Test a knowledge base (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-test.html).
	OverrideSearchType *string `locationName:"overrideSearchType" type:"string" enum:"SearchType"`
	// contains filtered or unexported fields
}

Configurations for how to perform the search query and return results. For more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).

This data type is used in the following API operations:

func (KnowledgeBaseVectorSearchConfiguration) GoString 

func (s KnowledgeBaseVectorSearchConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseVectorSearchConfiguration) SetFilter 

func (s *KnowledgeBaseVectorSearchConfiguration) SetFilter(v *RetrievalFilter) *KnowledgeBaseVectorSearchConfiguration

SetFilter sets the Filter field's value.

func (*KnowledgeBaseVectorSearchConfiguration) SetNumberOfResults 

func (s *KnowledgeBaseVectorSearchConfiguration) SetNumberOfResults(v int64) *KnowledgeBaseVectorSearchConfiguration

SetNumberOfResults sets the NumberOfResults field's value.

func (*KnowledgeBaseVectorSearchConfiguration) SetOverrideSearchType 

func (s *KnowledgeBaseVectorSearchConfiguration) SetOverrideSearchType(v string) *KnowledgeBaseVectorSearchConfiguration

SetOverrideSearchType sets the OverrideSearchType field's value.

func (KnowledgeBaseVectorSearchConfiguration) String 

func (s KnowledgeBaseVectorSearchConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseVectorSearchConfiguration) Validate 

func (s *KnowledgeBaseVectorSearchConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModelInvocationInput_ 

type ModelInvocationInput_ struct {

	// Specifications about the inference parameters that were provided alongside
	// the prompt. These are specified in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html)
	// object that was set when the agent was created or updated. For more information,
	// see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
	InferenceConfiguration *InferenceConfiguration `locationName:"inferenceConfiguration" type:"structure"`

	// The ARN of the Lambda function to use when parsing the raw foundation model
	// output in parts of the agent sequence.
	OverrideLambda *string `locationName:"overrideLambda" type:"string"`

	// 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.
	ParserMode *string `locationName:"parserMode" type:"string" enum:"CreationMode"`

	// Specifies whether the default prompt template was OVERRIDDEN. If it was,
	// the basePromptTemplate that was set in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html)
	// object when the agent was created or updated is used instead.
	PromptCreationMode *string `locationName:"promptCreationMode" type:"string" enum:"CreationMode"`

	// The text that prompted the agent at this step.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ModelInvocationInput_'s
	// String and GoString methods.
	Text *string `locationName:"text" type:"string" sensitive:"true"`

	// The unique identifier of the trace.
	TraceId *string `locationName:"traceId" min:"2" type:"string"`

	// The step in the agent sequence.
	Type *string `locationName:"type" type:"string" enum:"PromptType"`
	// contains filtered or unexported fields
}

The input for the pre-processing step.

func (ModelInvocationInput_) GoString 

func (s ModelInvocationInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModelInvocationInput_) SetInferenceConfiguration 

func (s *ModelInvocationInput_) SetInferenceConfiguration(v *InferenceConfiguration) *ModelInvocationInput_

SetInferenceConfiguration sets the InferenceConfiguration field's value.

func (*ModelInvocationInput_) SetOverrideLambda 

func (s *ModelInvocationInput_) SetOverrideLambda(v string) *ModelInvocationInput_

SetOverrideLambda sets the OverrideLambda field's value.

func (*ModelInvocationInput_) SetParserMode 

func (s *ModelInvocationInput_) SetParserMode(v string) *ModelInvocationInput_

SetParserMode sets the ParserMode field's value.

func (*ModelInvocationInput_) SetPromptCreationMode 

func (s *ModelInvocationInput_) SetPromptCreationMode(v string) *ModelInvocationInput_

SetPromptCreationMode sets the PromptCreationMode field's value.

func (*ModelInvocationInput_) SetText 

func (s *ModelInvocationInput_) SetText(v string) *ModelInvocationInput_

SetText sets the Text field's value.

func (*ModelInvocationInput_) SetTraceId 

func (s *ModelInvocationInput_) SetTraceId(v string) *ModelInvocationInput_

SetTraceId sets the TraceId field's value.

func (*ModelInvocationInput_) SetType 

func (s *ModelInvocationInput_) SetType(v string) *ModelInvocationInput_

SetType sets the Type field's value.

func (ModelInvocationInput_) String 

func (s ModelInvocationInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Observation 

type Observation struct {

	// Contains the JSON-formatted string returned by the API invoked by the action
	// group.
	ActionGroupInvocationOutput *ActionGroupInvocationOutput_ `locationName:"actionGroupInvocationOutput" type:"structure"`

	// Contains details about the response to the user.
	FinalResponse *FinalResponse `locationName:"finalResponse" type:"structure"`

	// Contains details about the results from looking up the knowledge base.
	KnowledgeBaseLookupOutput *KnowledgeBaseLookupOutput_ `locationName:"knowledgeBaseLookupOutput" type:"structure"`

	// Contains details about the response to reprompt the input.
	//
	// RepromptResponse is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Observation's
	// String and GoString methods.
	RepromptResponse *RepromptResponse `locationName:"repromptResponse" type:"structure" sensitive:"true"`

	// The unique identifier of the trace.
	TraceId *string `locationName:"traceId" min:"2" type:"string"`

	// Specifies what kind of information the agent returns in the observation.
	// The following values are possible.
	//
	//    * ACTION_GROUP – The agent returns the result of an action group.
	//
	//    * KNOWLEDGE_BASE – The agent returns information from a knowledge base.
	//
	//    * FINISH – The agent returns a final response to the user with no follow-up.
	//
	//    * ASK_USER – The agent asks the user a question.
	//
	//    * REPROMPT – The agent prompts the user again for the same information.
	Type *string `locationName:"type" type:"string" enum:"Type"`
	// contains filtered or unexported fields
}

Contains the result or output of an action group or knowledge base, or the response to the user.

func (Observation) GoString 

func (s Observation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Observation) SetActionGroupInvocationOutput 

func (s *Observation) SetActionGroupInvocationOutput(v *ActionGroupInvocationOutput_) *Observation

SetActionGroupInvocationOutput sets the ActionGroupInvocationOutput field's value.

func (*Observation) SetFinalResponse 

func (s *Observation) SetFinalResponse(v *FinalResponse) *Observation

SetFinalResponse sets the FinalResponse field's value.

func (*Observation) SetKnowledgeBaseLookupOutput 

func (s *Observation) SetKnowledgeBaseLookupOutput(v *KnowledgeBaseLookupOutput_) *Observation

SetKnowledgeBaseLookupOutput sets the KnowledgeBaseLookupOutput field's value.

func (*Observation) SetRepromptResponse 

func (s *Observation) SetRepromptResponse(v *RepromptResponse) *Observation

SetRepromptResponse sets the RepromptResponse field's value.

func (*Observation) SetTraceId 

func (s *Observation) SetTraceId(v string) *Observation

SetTraceId sets the TraceId field's value.

func (*Observation) SetType 

func (s *Observation) SetType(v string) *Observation

SetType sets the Type field's value.

func (Observation) String 

func (s Observation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OrchestrationTrace 

type OrchestrationTrace struct {

	// Contains information pertaining to the action group or knowledge base that
	// is being invoked.
	//
	// InvocationInput is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by OrchestrationTrace's
	// String and GoString methods.
	InvocationInput *InvocationInput_ `locationName:"invocationInput" type:"structure" sensitive:"true"`

	// The input for the orchestration step.
	//
	//    * The type is ORCHESTRATION.
	//
	//    * The text contains the prompt.
	//
	//    * The inferenceConfiguration, parserMode, and overrideLambda values are
	//    set in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html)
	//    object that was set when the agent was created or updated.
	//
	// ModelInvocationInput is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by OrchestrationTrace's
	// String and GoString methods.
	ModelInvocationInput *ModelInvocationInput_ `locationName:"modelInvocationInput" type:"structure" sensitive:"true"`

	// Details about the observation (the output of the action group Lambda or knowledge
	// base) made by the agent.
	//
	// Observation is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by OrchestrationTrace's
	// String and GoString methods.
	Observation *Observation `locationName:"observation" type:"structure" sensitive:"true"`

	// Details about the reasoning, based on the input, that the agent uses to justify
	// carrying out an action group or getting information from a knowledge base.
	//
	// Rationale is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by OrchestrationTrace's
	// String and GoString methods.
	Rationale *Rationale `locationName:"rationale" type:"structure" sensitive:"true"`
	// contains filtered or unexported fields
}

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

func (OrchestrationTrace) GoString 

func (s OrchestrationTrace) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OrchestrationTrace) SetInvocationInput 

func (s *OrchestrationTrace) SetInvocationInput(v *InvocationInput_) *OrchestrationTrace

SetInvocationInput sets the InvocationInput field's value.

func (*OrchestrationTrace) SetModelInvocationInput 

func (s *OrchestrationTrace) SetModelInvocationInput(v *ModelInvocationInput_) *OrchestrationTrace

SetModelInvocationInput sets the ModelInvocationInput field's value.

func (*OrchestrationTrace) SetObservation 

func (s *OrchestrationTrace) SetObservation(v *Observation) *OrchestrationTrace

SetObservation sets the Observation field's value.

func (*OrchestrationTrace) SetRationale 

func (s *OrchestrationTrace) SetRationale(v *Rationale) *OrchestrationTrace

SetRationale sets the Rationale field's value.

func (OrchestrationTrace) String 

func (s OrchestrationTrace) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Parameter 

type Parameter struct {

	// The name of the parameter.
	Name *string `locationName:"name" type:"string"`

	// The type of the parameter.
	Type *string `locationName:"type" type:"string"`

	// The value of the parameter.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

A parameter for the API request or function.

func (Parameter) GoString 

func (s Parameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Parameter) SetName 

func (s *Parameter) SetName(v string) *Parameter

SetName sets the Name field's value.

func (*Parameter) SetType 

func (s *Parameter) SetType(v string) *Parameter

SetType sets the Type field's value.

func (*Parameter) SetValue 

func (s *Parameter) SetValue(v string) *Parameter

SetValue sets the Value field's value.

func (Parameter) String 

func (s Parameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PayloadPart 

type PayloadPart struct {

	// Contains citations for a part of an agent response.
	Attribution *Attribution `locationName:"attribution" type:"structure"`

	// A part of the agent response in bytes.
	//
	// Bytes is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PayloadPart's
	// String and GoString methods.
	//
	// Bytes is automatically base64 encoded/decoded by the SDK.
	Bytes []byte `locationName:"bytes" type:"blob" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains a part of an agent response and citations for it.

func (PayloadPart) GoString 

func (s PayloadPart) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PayloadPart) MarshalEvent 

func (s *PayloadPart) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*PayloadPart) SetAttribution 

func (s *PayloadPart) SetAttribution(v *Attribution) *PayloadPart

SetAttribution sets the Attribution field's value.

func (*PayloadPart) SetBytes 

func (s *PayloadPart) SetBytes(v []byte) *PayloadPart

SetBytes sets the Bytes field's value.

func (PayloadPart) String 

func (s PayloadPart) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PayloadPart) UnmarshalEvent 

func (s *PayloadPart) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the PayloadPart value. This method is only used internally within the SDK's EventStream handling.

type PostProcessingModelInvocationOutput_ 

type PostProcessingModelInvocationOutput_ struct {

	// Details about the response from the Lambda parsing of the output of the post-processing
	// step.
	//
	// ParsedResponse is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PostProcessingModelInvocationOutput_'s
	// String and GoString methods.
	ParsedResponse *PostProcessingParsedResponse `locationName:"parsedResponse" type:"structure" sensitive:"true"`

	// The unique identifier of the trace.
	TraceId *string `locationName:"traceId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

The foundation model output from the post-processing step.

func (PostProcessingModelInvocationOutput_) GoString 

func (s PostProcessingModelInvocationOutput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PostProcessingModelInvocationOutput_) SetParsedResponse 

func (s *PostProcessingModelInvocationOutput_) SetParsedResponse(v *PostProcessingParsedResponse) *PostProcessingModelInvocationOutput_

SetParsedResponse sets the ParsedResponse field's value.

func (*PostProcessingModelInvocationOutput_) SetTraceId 

func (s *PostProcessingModelInvocationOutput_) SetTraceId(v string) *PostProcessingModelInvocationOutput_

SetTraceId sets the TraceId field's value.

func (PostProcessingModelInvocationOutput_) String 

func (s PostProcessingModelInvocationOutput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PostProcessingParsedResponse 

type PostProcessingParsedResponse struct {

	// The text returned by the parser.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PostProcessingParsedResponse's
	// String and GoString methods.
	Text *string `locationName:"text" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Details about the response from the Lambda parsing of the output from the post-processing step.

func (PostProcessingParsedResponse) GoString 

func (s PostProcessingParsedResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PostProcessingParsedResponse) SetText 

func (s *PostProcessingParsedResponse) SetText(v string) *PostProcessingParsedResponse

SetText sets the Text field's value.

func (PostProcessingParsedResponse) String 

func (s PostProcessingParsedResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PostProcessingTrace 

type PostProcessingTrace struct {

	// The input for the post-processing step.
	//
	//    * The type is POST_PROCESSING.
	//
	//    * The text contains the prompt.
	//
	//    * The inferenceConfiguration, parserMode, and overrideLambda values are
	//    set in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html)
	//    object that was set when the agent was created or updated.
	//
	// ModelInvocationInput is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PostProcessingTrace's
	// String and GoString methods.
	ModelInvocationInput *ModelInvocationInput_ `locationName:"modelInvocationInput" type:"structure" sensitive:"true"`

	// The foundation model output from the post-processing step.
	//
	// ModelInvocationOutput is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PostProcessingTrace's
	// String and GoString methods.
	ModelInvocationOutput *PostProcessingModelInvocationOutput_ `locationName:"modelInvocationOutput" type:"structure" sensitive:"true"`
	// contains filtered or unexported fields
}

Details about the post-processing step, in which the agent shapes the response.

func (PostProcessingTrace) GoString 

func (s PostProcessingTrace) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PostProcessingTrace) SetModelInvocationInput 

func (s *PostProcessingTrace) SetModelInvocationInput(v *ModelInvocationInput_) *PostProcessingTrace

SetModelInvocationInput sets the ModelInvocationInput field's value.

func (*PostProcessingTrace) SetModelInvocationOutput 

func (s *PostProcessingTrace) SetModelInvocationOutput(v *PostProcessingModelInvocationOutput_) *PostProcessingTrace

SetModelInvocationOutput sets the ModelInvocationOutput field's value.

func (PostProcessingTrace) String 

func (s PostProcessingTrace) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PreProcessingModelInvocationOutput_ 

type PreProcessingModelInvocationOutput_ struct {

	// Details about the response from the Lambda parsing of the output of the pre-processing
	// step.
	//
	// ParsedResponse is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PreProcessingModelInvocationOutput_'s
	// String and GoString methods.
	ParsedResponse *PreProcessingParsedResponse `locationName:"parsedResponse" type:"structure" sensitive:"true"`

	// The unique identifier of the trace.
	TraceId *string `locationName:"traceId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

The foundation model output from the pre-processing step.

func (PreProcessingModelInvocationOutput_) GoString 

func (s PreProcessingModelInvocationOutput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PreProcessingModelInvocationOutput_) SetParsedResponse 

func (s *PreProcessingModelInvocationOutput_) SetParsedResponse(v *PreProcessingParsedResponse) *PreProcessingModelInvocationOutput_

SetParsedResponse sets the ParsedResponse field's value.

func (*PreProcessingModelInvocationOutput_) SetTraceId 

func (s *PreProcessingModelInvocationOutput_) SetTraceId(v string) *PreProcessingModelInvocationOutput_

SetTraceId sets the TraceId field's value.

func (PreProcessingModelInvocationOutput_) String 

func (s PreProcessingModelInvocationOutput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PreProcessingParsedResponse 

type PreProcessingParsedResponse struct {

	// Whether the user input is valid or not. If false, the agent doesn't proceed
	// to orchestration.
	IsValid *bool `locationName:"isValid" type:"boolean"`

	// The text returned by the parsing of the pre-processing step, explaining the
	// steps that the agent plans to take in orchestration, if the user input is
	// valid.
	//
	// Rationale is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PreProcessingParsedResponse's
	// String and GoString methods.
	Rationale *string `locationName:"rationale" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Details about the response from the Lambda parsing of the output from the pre-processing step.

func (PreProcessingParsedResponse) GoString 

func (s PreProcessingParsedResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PreProcessingParsedResponse) SetIsValid 

func (s *PreProcessingParsedResponse) SetIsValid(v bool) *PreProcessingParsedResponse

SetIsValid sets the IsValid field's value.

func (*PreProcessingParsedResponse) SetRationale 

func (s *PreProcessingParsedResponse) SetRationale(v string) *PreProcessingParsedResponse

SetRationale sets the Rationale field's value.

func (PreProcessingParsedResponse) String 

func (s PreProcessingParsedResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PreProcessingTrace 

type PreProcessingTrace struct {

	// The input for the pre-processing step.
	//
	//    * The type is PRE_PROCESSING.
	//
	//    * The text contains the prompt.
	//
	//    * The inferenceConfiguration, parserMode, and overrideLambda values are
	//    set in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html)
	//    object that was set when the agent was created or updated.
	//
	// ModelInvocationInput is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PreProcessingTrace's
	// String and GoString methods.
	ModelInvocationInput *ModelInvocationInput_ `locationName:"modelInvocationInput" type:"structure" sensitive:"true"`

	// The foundation model output from the pre-processing step.
	//
	// ModelInvocationOutput is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PreProcessingTrace's
	// String and GoString methods.
	ModelInvocationOutput *PreProcessingModelInvocationOutput_ `locationName:"modelInvocationOutput" type:"structure" sensitive:"true"`
	// contains filtered or unexported fields
}

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

func (PreProcessingTrace) GoString 

func (s PreProcessingTrace) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PreProcessingTrace) SetModelInvocationInput 

func (s *PreProcessingTrace) SetModelInvocationInput(v *ModelInvocationInput_) *PreProcessingTrace

SetModelInvocationInput sets the ModelInvocationInput field's value.

func (*PreProcessingTrace) SetModelInvocationOutput 

func (s *PreProcessingTrace) SetModelInvocationOutput(v *PreProcessingModelInvocationOutput_) *PreProcessingTrace

SetModelInvocationOutput sets the ModelInvocationOutput field's value.

func (PreProcessingTrace) String 

func (s PreProcessingTrace) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PromptTemplate 

type PromptTemplate struct {

	// The template for the prompt that's sent to the model for response generation.
	// You can include prompt placeholders, which become replaced before the prompt
	// is sent to the model to provide instructions and context to the model. In
	// addition, you can include XML tags to delineate meaningful sections of the
	// prompt template.
	//
	// For more information, see the following resources:
	//
	//    * Knowledge base prompt templates (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt)
	//
	//    * Use XML tags with Anthropic Claude models (https://docs.anthropic.com/claude/docs/use-xml-tags)
	//
	// TextPromptTemplate is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PromptTemplate's
	// String and GoString methods.
	TextPromptTemplate *string `locationName:"textPromptTemplate" min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt).

This data type is used in the following API operations:

func (PromptTemplate) GoString 

func (s PromptTemplate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PromptTemplate) SetTextPromptTemplate 

func (s *PromptTemplate) SetTextPromptTemplate(v string) *PromptTemplate

SetTextPromptTemplate sets the TextPromptTemplate field's value.

func (PromptTemplate) String 

func (s PromptTemplate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PromptTemplate) Validate 

func (s *PromptTemplate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PropertyParameters 

type PropertyParameters struct {

	// A list of parameters in the request body.
	Properties []*Parameter `locationName:"properties" type:"list"`
	// contains filtered or unexported fields
}

Contains the parameters in the request body.

func (PropertyParameters) GoString 

func (s PropertyParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyParameters) SetProperties 

func (s *PropertyParameters) SetProperties(v []*Parameter) *PropertyParameters

SetProperties sets the Properties field's value.

func (PropertyParameters) String 

func (s PropertyParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Rationale 

type Rationale struct {

	// The reasoning or thought process of the agent, based on the input.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Rationale's
	// String and GoString methods.
	Text *string `locationName:"text" type:"string" sensitive:"true"`

	// The unique identifier of the trace step.
	TraceId *string `locationName:"traceId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

func (Rationale) GoString 

func (s Rationale) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Rationale) SetText 

func (s *Rationale) SetText(v string) *Rationale

SetText sets the Text field's value.

func (*Rationale) SetTraceId 

func (s *Rationale) SetTraceId(v string) *Rationale

SetTraceId sets the TraceId field's value.

func (Rationale) String 

func (s Rationale) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RepromptResponse 

type RepromptResponse struct {

	// Specifies what output is prompting the agent to reprompt the input.
	//
	// Source is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RepromptResponse's
	// String and GoString methods.
	Source *string `locationName:"source" type:"string" enum:"Source" sensitive:"true"`

	// The text reprompting the input.
	Text *string `locationName:"text" type:"string"`
	// contains filtered or unexported fields
}

Contains details about the agent's response to reprompt the input.

func (RepromptResponse) GoString 

func (s RepromptResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RepromptResponse) SetSource 

func (s *RepromptResponse) SetSource(v string) *RepromptResponse

SetSource sets the Source field's value.

func (*RepromptResponse) SetText 

func (s *RepromptResponse) SetText(v string) *RepromptResponse

SetText sets the Text field's value.

func (RepromptResponse) String 

func (s RepromptResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RequestBody 

type RequestBody struct {

	// The content in the request body.
	Content map[string][]*Parameter `locationName:"content" type:"map"`
	// contains filtered or unexported fields
}

The parameters in the API request body.

func (RequestBody) GoString 

func (s RequestBody) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RequestBody) SetContent 

func (s *RequestBody) SetContent(v map[string][]*Parameter) *RequestBody

SetContent sets the Content field's value.

func (RequestBody) String 

func (s RequestBody) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"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) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) MarshalEvent 

func (s *ResourceNotFoundException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) UnmarshalEvent 

func (s *ResourceNotFoundException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ResourceNotFoundException value. This method is only used internally within the SDK's EventStream handling.

type ResponseStreamEvent 

type ResponseStreamEvent interface {
	eventstreamapi.Marshaler
	eventstreamapi.Unmarshaler
	// contains filtered or unexported methods
}

ResponseStreamEvent groups together all EventStream events writes for ResponseStream.

These events are:

  • PayloadPart
  • ReturnControlPayload
  • TracePart

type ResponseStreamReader 

type ResponseStreamReader interface {
	// Returns a channel of events as they are read from the event stream.
	Events() <-chan ResponseStreamEvent

	// Close will stop the reader reading events from the stream.
	Close() error

	// Returns any error that has occurred while reading from the event stream.
	Err() error
}

ResponseStreamReader provides the interface for reading to the stream. The default implementation for this interface will be ResponseStream.

The reader's Close method must allow multiple concurrent calls.

These events are:

  • PayloadPart
  • ReturnControlPayload
  • TracePart
  • ResponseStreamUnknownEvent

type ResponseStreamUnknownEvent 

type ResponseStreamUnknownEvent struct {
	Type    string
	Message eventstream.Message
}

ResponseStreamUnknownEvent provides a failsafe event for the ResponseStream group of events when an unknown event is received.

func (*ResponseStreamUnknownEvent) MarshalEvent 

func (e *ResponseStreamUnknownEvent) MarshalEvent(pm protocol.PayloadMarshaler) (
	msg eventstream.Message, err error,
)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ResponseStreamUnknownEvent) UnmarshalEvent 

func (e *ResponseStreamUnknownEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ResponseStream value. This method is only used internally within the SDK's EventStream handling.

type RetrievalFilter 

type RetrievalFilter struct {

	// Knowledge base data sources are returned if their metadata attributes fulfill
	// all the filter conditions inside this list.
	AndAll []*RetrievalFilter `locationName:"andAll" min:"2" type:"list"`

	// Knowledge base data sources are returned if their metadata attributes fulfill
	// at least one of the filter conditions inside this list.
	OrAll []*RetrievalFilter `locationName:"orAll" min:"2" type:"list"`
	// contains filtered or unexported fields
}

Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html). See the examples below to see how to use these filters.

This data type is used in the following API operations:

func (RetrievalFilter) GoString 

func (s RetrievalFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrievalFilter) SetAndAll 

func (s *RetrievalFilter) SetAndAll(v []*RetrievalFilter) *RetrievalFilter

SetAndAll sets the AndAll field's value.

func (*RetrievalFilter) SetOrAll 

func (s *RetrievalFilter) SetOrAll(v []*RetrievalFilter) *RetrievalFilter

SetOrAll sets the OrAll field's value.

func (RetrievalFilter) String 

func (s RetrievalFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrievalFilter) Validate 

func (s *RetrievalFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RetrievalResultContent 

type RetrievalResultContent struct {

	// The cited text from the data source.
	//
	// Text is a required field
	Text *string `locationName:"text" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the cited text from the data source.

This data type is used in the following API operations:

func (RetrievalResultContent) GoString 

func (s RetrievalResultContent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrievalResultContent) SetText 

func (s *RetrievalResultContent) SetText(v string) *RetrievalResultContent

SetText sets the Text field's value.

func (RetrievalResultContent) String 

func (s RetrievalResultContent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetrievalResultLocation 

type RetrievalResultLocation struct {

	// Contains the S3 location of the data source.
	S3Location *RetrievalResultS3Location `locationName:"s3Location" type:"structure"`

	// The type of the location of the data source.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"RetrievalResultLocationType"`
	// contains filtered or unexported fields
}

Contains information about the location of the data source.

This data type is used in the following API operations:

func (RetrievalResultLocation) GoString 

func (s RetrievalResultLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrievalResultLocation) SetS3Location 

func (s *RetrievalResultLocation) SetS3Location(v *RetrievalResultS3Location) *RetrievalResultLocation

SetS3Location sets the S3Location field's value.

func (*RetrievalResultLocation) SetType 

func (s *RetrievalResultLocation) SetType(v string) *RetrievalResultLocation

SetType sets the Type field's value.

func (RetrievalResultLocation) String 

func (s RetrievalResultLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetrievalResultS3Location 

type RetrievalResultS3Location struct {

	// The S3 URI of the data source.
	Uri *string `locationName:"uri" type:"string"`
	// contains filtered or unexported fields
}

Contains the S3 location of the data source.

This data type is used in the following API operations:

func (RetrievalResultS3Location) GoString 

func (s RetrievalResultS3Location) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrievalResultS3Location) SetUri 

func (s *RetrievalResultS3Location) SetUri(v string) *RetrievalResultS3Location

SetUri sets the Uri field's value.

func (RetrievalResultS3Location) String 

func (s RetrievalResultS3Location) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetrieveAndGenerateConfiguration 

type RetrieveAndGenerateConfiguration struct {

	// The configuration used with the external source wrapper object in the retrieveAndGenerate
	// function.
	ExternalSourcesConfiguration *ExternalSourcesRetrieveAndGenerateConfiguration `locationName:"externalSourcesConfiguration" type:"structure"`

	// Contains details about the resource being queried.
	KnowledgeBaseConfiguration *KnowledgeBaseRetrieveAndGenerateConfiguration `locationName:"knowledgeBaseConfiguration" type:"structure"`

	// The type of resource that is queried by the request.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"RetrieveAndGenerateType"`
	// contains filtered or unexported fields
}

Contains details about the resource being queried.

This data type is used in the following API operations:

func (RetrieveAndGenerateConfiguration) GoString 

func (s RetrieveAndGenerateConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveAndGenerateConfiguration) SetExternalSourcesConfiguration 

func (s *RetrieveAndGenerateConfiguration) SetExternalSourcesConfiguration(v *ExternalSourcesRetrieveAndGenerateConfiguration) *RetrieveAndGenerateConfiguration

SetExternalSourcesConfiguration sets the ExternalSourcesConfiguration field's value.

func (*RetrieveAndGenerateConfiguration) SetKnowledgeBaseConfiguration 

func (s *RetrieveAndGenerateConfiguration) SetKnowledgeBaseConfiguration(v *KnowledgeBaseRetrieveAndGenerateConfiguration) *RetrieveAndGenerateConfiguration

SetKnowledgeBaseConfiguration sets the KnowledgeBaseConfiguration field's value.

func (*RetrieveAndGenerateConfiguration) SetType 

func (s *RetrieveAndGenerateConfiguration) SetType(v string) *RetrieveAndGenerateConfiguration

SetType sets the Type field's value.

func (RetrieveAndGenerateConfiguration) String 

func (s RetrieveAndGenerateConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveAndGenerateConfiguration) Validate 

func (s *RetrieveAndGenerateConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RetrieveAndGenerateInput 

type RetrieveAndGenerateInput struct {

	// Contains the query to be made to the knowledge base.
	//
	// Input is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RetrieveAndGenerateInput's
	// String and GoString methods.
	//
	// Input is a required field
	Input *RetrieveAndGenerateInput_ `locationName:"input" type:"structure" required:"true" sensitive:"true"`

	// Contains configurations for the knowledge base query and retrieval process.
	// For more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
	RetrieveAndGenerateConfiguration *RetrieveAndGenerateConfiguration `locationName:"retrieveAndGenerateConfiguration" type:"structure"`

	// Contains details about the session with the knowledge base.
	SessionConfiguration *RetrieveAndGenerateSessionConfiguration `locationName:"sessionConfiguration" type:"structure"`

	// The unique identifier of the session. Reuse the same value to continue the
	// same session with the knowledge base.
	SessionId *string `locationName:"sessionId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

func (RetrieveAndGenerateInput) GoString 

func (s RetrieveAndGenerateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveAndGenerateInput) SetInput 

func (s *RetrieveAndGenerateInput) SetInput(v *RetrieveAndGenerateInput_) *RetrieveAndGenerateInput

SetInput sets the Input field's value.

func (*RetrieveAndGenerateInput) SetRetrieveAndGenerateConfiguration 

func (s *RetrieveAndGenerateInput) SetRetrieveAndGenerateConfiguration(v *RetrieveAndGenerateConfiguration) *RetrieveAndGenerateInput

SetRetrieveAndGenerateConfiguration sets the RetrieveAndGenerateConfiguration field's value.

func (*RetrieveAndGenerateInput) SetSessionConfiguration 

func (s *RetrieveAndGenerateInput) SetSessionConfiguration(v *RetrieveAndGenerateSessionConfiguration) *RetrieveAndGenerateInput

SetSessionConfiguration sets the SessionConfiguration field's value.

func (*RetrieveAndGenerateInput) SetSessionId 

func (s *RetrieveAndGenerateInput) SetSessionId(v string) *RetrieveAndGenerateInput

SetSessionId sets the SessionId field's value.

func (RetrieveAndGenerateInput) String 

func (s RetrieveAndGenerateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveAndGenerateInput) Validate 

func (s *RetrieveAndGenerateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RetrieveAndGenerateInput_ 

type RetrieveAndGenerateInput_ struct {

	// The query made to the knowledge base.
	//
	// Text is a required field
	Text *string `locationName:"text" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the query made to the knowledge base.

This data type is used in the following API operations:

func (RetrieveAndGenerateInput_) GoString 

func (s RetrieveAndGenerateInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveAndGenerateInput_) SetText 

func (s *RetrieveAndGenerateInput_) SetText(v string) *RetrieveAndGenerateInput_

SetText sets the Text field's value.

func (RetrieveAndGenerateInput_) String 

func (s RetrieveAndGenerateInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveAndGenerateInput_) Validate 

func (s *RetrieveAndGenerateInput_) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RetrieveAndGenerateOutput 

type RetrieveAndGenerateOutput struct {

	// A list of segments of the generated response that are based on sources in
	// the knowledge base, alongside information about the sources.
	Citations []*Citation `locationName:"citations" type:"list"`

	// Specifies if there is a guardrail intervention in the response.
	GuardrailAction *string `locationName:"guardrailAction" type:"string" enum:"GuadrailAction"`

	// Contains the response generated from querying the knowledge base.
	//
	// Output is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RetrieveAndGenerateOutput's
	// String and GoString methods.
	//
	// Output is a required field
	Output *RetrieveAndGenerateOutput_ `locationName:"output" type:"structure" required:"true" sensitive:"true"`

	// The unique identifier of the session. Reuse the same value to continue the
	// same session with the knowledge base.
	//
	// SessionId is a required field
	SessionId *string `locationName:"sessionId" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RetrieveAndGenerateOutput) GoString 

func (s RetrieveAndGenerateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveAndGenerateOutput) SetCitations 

func (s *RetrieveAndGenerateOutput) SetCitations(v []*Citation) *RetrieveAndGenerateOutput

SetCitations sets the Citations field's value.

func (*RetrieveAndGenerateOutput) SetGuardrailAction 

func (s *RetrieveAndGenerateOutput) SetGuardrailAction(v string) *RetrieveAndGenerateOutput

SetGuardrailAction sets the GuardrailAction field's value.

func (*RetrieveAndGenerateOutput) SetOutput 

func (s *RetrieveAndGenerateOutput) SetOutput(v *RetrieveAndGenerateOutput_) *RetrieveAndGenerateOutput

SetOutput sets the Output field's value.

func (*RetrieveAndGenerateOutput) SetSessionId 

func (s *RetrieveAndGenerateOutput) SetSessionId(v string) *RetrieveAndGenerateOutput

SetSessionId sets the SessionId field's value.

func (RetrieveAndGenerateOutput) String 

func (s RetrieveAndGenerateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetrieveAndGenerateOutput_ 

type RetrieveAndGenerateOutput_ struct {

	// The response generated from querying the knowledge base.
	//
	// Text is a required field
	Text *string `locationName:"text" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the response generated from querying the knowledge base.

This data type is used in the following API operations:

func (RetrieveAndGenerateOutput_) GoString 

func (s RetrieveAndGenerateOutput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveAndGenerateOutput_) SetText 

func (s *RetrieveAndGenerateOutput_) SetText(v string) *RetrieveAndGenerateOutput_

SetText sets the Text field's value.

func (RetrieveAndGenerateOutput_) String 

func (s RetrieveAndGenerateOutput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetrieveAndGenerateSessionConfiguration 

type RetrieveAndGenerateSessionConfiguration struct {

	// The ARN of the KMS key encrypting the session.
	//
	// KmsKeyArn is a required field
	KmsKeyArn *string `locationName:"kmsKeyArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains configuration about the session with the knowledge base.

This data type is used in the following API operations:

func (RetrieveAndGenerateSessionConfiguration) GoString 

func (s RetrieveAndGenerateSessionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveAndGenerateSessionConfiguration) SetKmsKeyArn 

func (s *RetrieveAndGenerateSessionConfiguration) SetKmsKeyArn(v string) *RetrieveAndGenerateSessionConfiguration

SetKmsKeyArn sets the KmsKeyArn field's value.

func (RetrieveAndGenerateSessionConfiguration) String 

func (s RetrieveAndGenerateSessionConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveAndGenerateSessionConfiguration) Validate 

func (s *RetrieveAndGenerateSessionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RetrieveInput 

type RetrieveInput struct {

	// The unique identifier of the knowledge base to query.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// If there are more results than can fit in the response, the response returns
	// a nextToken. Use this token in the nextToken field of another request to
	// retrieve the next batch of results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// Contains configurations for the knowledge base query and retrieval process.
	// For more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
	RetrievalConfiguration *KnowledgeBaseRetrievalConfiguration `locationName:"retrievalConfiguration" type:"structure"`

	// Contains the query to send the knowledge base.
	//
	// RetrievalQuery is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RetrieveInput's
	// String and GoString methods.
	//
	// RetrievalQuery is a required field
	RetrievalQuery *KnowledgeBaseQuery `locationName:"retrievalQuery" type:"structure" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (RetrieveInput) GoString 

func (s RetrieveInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveInput) SetKnowledgeBaseId 

func (s *RetrieveInput) SetKnowledgeBaseId(v string) *RetrieveInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*RetrieveInput) SetNextToken 

func (s *RetrieveInput) SetNextToken(v string) *RetrieveInput

SetNextToken sets the NextToken field's value.

func (*RetrieveInput) SetRetrievalConfiguration 

func (s *RetrieveInput) SetRetrievalConfiguration(v *KnowledgeBaseRetrievalConfiguration) *RetrieveInput

SetRetrievalConfiguration sets the RetrievalConfiguration field's value.

func (*RetrieveInput) SetRetrievalQuery 

func (s *RetrieveInput) SetRetrievalQuery(v *KnowledgeBaseQuery) *RetrieveInput

SetRetrievalQuery sets the RetrievalQuery field's value.

func (RetrieveInput) String 

func (s RetrieveInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveInput) Validate 

func (s *RetrieveInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RetrieveOutput 

type RetrieveOutput struct {

	// If there are more results than can fit in the response, the response returns
	// a nextToken. Use this token in the nextToken field of another request to
	// retrieve the next batch of results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// A list of results from querying the knowledge base.
	//
	// RetrievalResults is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RetrieveOutput's
	// String and GoString methods.
	//
	// RetrievalResults is a required field
	RetrievalResults []*KnowledgeBaseRetrievalResult `locationName:"retrievalResults" type:"list" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (RetrieveOutput) GoString 

func (s RetrieveOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveOutput) SetNextToken 

func (s *RetrieveOutput) SetNextToken(v string) *RetrieveOutput

SetNextToken sets the NextToken field's value.

func (*RetrieveOutput) SetRetrievalResults 

func (s *RetrieveOutput) SetRetrievalResults(v []*KnowledgeBaseRetrievalResult) *RetrieveOutput

SetRetrievalResults sets the RetrievalResults field's value.

func (RetrieveOutput) String 

func (s RetrieveOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetrievedReference 

type RetrievedReference struct {

	// Contains the cited text from the data source.
	//
	// Content is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RetrievedReference's
	// String and GoString methods.
	Content *RetrievalResultContent `locationName:"content" type:"structure" sensitive:"true"`

	// Contains information about the location of the data source.
	//
	// Location is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RetrievedReference's
	// String and GoString methods.
	Location *RetrievalResultLocation `locationName:"location" type:"structure" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains metadata about a source cited for the generated response.

This data type is used in the following API operations:

func (RetrievedReference) GoString 

func (s RetrievedReference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrievedReference) SetContent 

func (s *RetrievedReference) SetContent(v *RetrievalResultContent) *RetrievedReference

SetContent sets the Content field's value.

func (*RetrievedReference) SetLocation 

func (s *RetrievedReference) SetLocation(v *RetrievalResultLocation) *RetrievedReference

SetLocation sets the Location field's value.

func (RetrievedReference) String 

func (s RetrievedReference) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReturnControlPayload 

type ReturnControlPayload struct {

	// The identifier of the action group invocation.
	InvocationId *string `locationName:"invocationId" type:"string"`

	// A list of objects that contain information about the parameters and inputs
	// that need to be sent into the API operation or function, based on what the
	// agent determines from its session with the user.
	InvocationInputs []*InvocationInputMember `locationName:"invocationInputs" min:"1" type:"list"`
	// contains filtered or unexported fields
}

Contains information to return from the action group that the agent has predicted to invoke.

This data type is used in the following API operations:

func (ReturnControlPayload) GoString 

func (s ReturnControlPayload) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReturnControlPayload) MarshalEvent 

func (s *ReturnControlPayload) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ReturnControlPayload) SetInvocationId 

func (s *ReturnControlPayload) SetInvocationId(v string) *ReturnControlPayload

SetInvocationId sets the InvocationId field's value.

func (*ReturnControlPayload) SetInvocationInputs 

func (s *ReturnControlPayload) SetInvocationInputs(v []*InvocationInputMember) *ReturnControlPayload

SetInvocationInputs sets the InvocationInputs field's value.

func (ReturnControlPayload) String 

func (s ReturnControlPayload) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReturnControlPayload) UnmarshalEvent 

func (s *ReturnControlPayload) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ReturnControlPayload value. This method is only used internally within the SDK's EventStream handling.

type S3ObjectDoc 

type S3ObjectDoc struct {

	// The file location of the S3 wrapper object.
	//
	// Uri is a required field
	Uri *string `locationName:"uri" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The unique wrapper object of the document from the S3 location.

func (S3ObjectDoc) GoString 

func (s S3ObjectDoc) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3ObjectDoc) SetUri 

func (s *S3ObjectDoc) SetUri(v string) *S3ObjectDoc

SetUri sets the Uri field's value.

func (S3ObjectDoc) String 

func (s S3ObjectDoc) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3ObjectDoc) Validate 

func (s *S3ObjectDoc) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) MarshalEvent 

func (s *ServiceQuotaExceededException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) UnmarshalEvent 

func (s *ServiceQuotaExceededException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ServiceQuotaExceededException value. This method is only used internally within the SDK's EventStream handling.

type SessionState 

type SessionState struct {

	// The identifier of the invocation of an action. This value must match the
	// invocationId returned in the InvokeAgent response for the action whose results
	// are provided in the returnControlInvocationResults field. For more information,
	// see Return control to the agent developer (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html)
	// and Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).
	InvocationId *string `locationName:"invocationId" type:"string"`

	// Contains attributes that persist across a prompt and the values of those
	// attributes. These attributes replace the $prompt_session_attributes$ placeholder
	// variable in the orchestration prompt template. For more information, see
	// Prompt template placeholder variables (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html).
	PromptSessionAttributes map[string]*string `locationName:"promptSessionAttributes" type:"map"`

	// Contains information about the results from the action group invocation.
	// For more information, see Return control to the agent developer (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html)
	// and Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).
	//
	// If you include this field, the inputText field will be ignored.
	ReturnControlInvocationResults []*InvocationResultMember `locationName:"returnControlInvocationResults" min:"1" type:"list"`

	// Contains attributes that persist across a session and the values of those
	// attributes.
	SessionAttributes map[string]*string `locationName:"sessionAttributes" type:"map"`
	// contains filtered or unexported fields
}

Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html) for an action group or pass them when making an InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).

func (SessionState) GoString 

func (s SessionState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionState) SetInvocationId 

func (s *SessionState) SetInvocationId(v string) *SessionState

SetInvocationId sets the InvocationId field's value.

func (*SessionState) SetPromptSessionAttributes 

func (s *SessionState) SetPromptSessionAttributes(v map[string]*string) *SessionState

SetPromptSessionAttributes sets the PromptSessionAttributes field's value.

func (*SessionState) SetReturnControlInvocationResults 

func (s *SessionState) SetReturnControlInvocationResults(v []*InvocationResultMember) *SessionState

SetReturnControlInvocationResults sets the ReturnControlInvocationResults field's value.

func (*SessionState) SetSessionAttributes 

func (s *SessionState) SetSessionAttributes(v map[string]*string) *SessionState

SetSessionAttributes sets the SessionAttributes field's value.

func (SessionState) String 

func (s SessionState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionState) Validate 

func (s *SessionState) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Span 

type Span struct {

	// Where the text with a citation ends in the generated output.
	End *int64 `locationName:"end" type:"integer"`

	// Where the text with a citation starts in the generated output.
	Start *int64 `locationName:"start" type:"integer"`
	// contains filtered or unexported fields
}

Contains information about where the text with a citation begins and ends in the generated output.

This data type is used in the following API operations:

func (Span) GoString 

func (s Span) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Span) SetEnd 

func (s *Span) SetEnd(v int64) *Span

SetEnd sets the End field's value.

func (*Span) SetStart 

func (s *Span) SetStart(v int64) *Span

SetStart sets the Start field's value.

func (Span) String 

func (s Span) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TextInferenceConfig 

type TextInferenceConfig struct {

	// The maximum number of tokens to generate in the output text. Do not use the
	// minimum of 0 or the maximum of 65536. The limit values described here are
	// arbitary values, for actual values consult the limits defined by your specific
	// model.
	MaxTokens *int64 `locationName:"maxTokens" type:"integer"`

	// A list of sequences of characters that, if generated, will cause the model
	// to stop generating further tokens. Do not use a minimum length of 1 or a
	// maximum length of 1000. The limit values described here are arbitary values,
	// for actual values consult the limits defined by your specific model.
	StopSequences []*string `locationName:"stopSequences" type:"list"`

	// Controls the random-ness of text generated by the language model, influencing
	// how much the model sticks to the most predictable next words versus exploring
	// more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes
	// model outputs more deterministic or predictable, while a higher temperature
	// (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
	Temperature *float64 `locationName:"temperature" type:"float"`

	// A probability distribution threshold which controls what the model considers
	// for the set of possible next tokens. The model will only consider the top
	// p% of the probability distribution when generating the next token.
	TopP *float64 `locationName:"topP" type:"float"`
	// contains filtered or unexported fields
}

Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.

The valid range of maxTokens depends on the accepted values for your chosen model's inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models. (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html)

func (TextInferenceConfig) GoString 

func (s TextInferenceConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TextInferenceConfig) SetMaxTokens 

func (s *TextInferenceConfig) SetMaxTokens(v int64) *TextInferenceConfig

SetMaxTokens sets the MaxTokens field's value.

func (*TextInferenceConfig) SetStopSequences 

func (s *TextInferenceConfig) SetStopSequences(v []*string) *TextInferenceConfig

SetStopSequences sets the StopSequences field's value.

func (*TextInferenceConfig) SetTemperature 

func (s *TextInferenceConfig) SetTemperature(v float64) *TextInferenceConfig

SetTemperature sets the Temperature field's value.

func (*TextInferenceConfig) SetTopP 

func (s *TextInferenceConfig) SetTopP(v float64) *TextInferenceConfig

SetTopP sets the TopP field's value.

func (TextInferenceConfig) String 

func (s TextInferenceConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TextResponsePart 

type TextResponsePart struct {

	// Contains information about where the text with a citation begins and ends
	// in the generated output.
	Span *Span `locationName:"span" type:"structure"`

	// The part of the generated text that contains a citation.
	Text *string `locationName:"text" type:"string"`
	// contains filtered or unexported fields
}

Contains the part of the generated text that contains a citation, alongside where it begins and ends.

This data type is used in the following API operations:

func (TextResponsePart) GoString 

func (s TextResponsePart) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TextResponsePart) SetSpan 

func (s *TextResponsePart) SetSpan(v *Span) *TextResponsePart

SetSpan sets the Span field's value.

func (*TextResponsePart) SetText 

func (s *TextResponsePart) SetText(v string) *TextResponsePart

SetText sets the Text field's value.

func (TextResponsePart) String 

func (s TextResponsePart) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The number of requests exceeds the limit. Resubmit your request later.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) MarshalEvent 

func (s *ThrottlingException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) UnmarshalEvent 

func (s *ThrottlingException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ThrottlingException value. This method is only used internally within the SDK's EventStream handling.

type Trace 

type Trace struct {

	// Contains information about the failure of the interaction.
	//
	// FailureTrace is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Trace's
	// String and GoString methods.
	FailureTrace *FailureTrace `locationName:"failureTrace" type:"structure" sensitive:"true"`

	// The trace details for a trace defined in the Guardrail filter.
	//
	// GuardrailTrace is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Trace's
	// String and GoString methods.
	GuardrailTrace *GuardrailTrace `locationName:"guardrailTrace" type:"structure" sensitive:"true"`

	// Details about the orchestration step, in which the agent determines the order
	// in which actions are executed and which knowledge bases are retrieved.
	//
	// OrchestrationTrace is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Trace's
	// String and GoString methods.
	OrchestrationTrace *OrchestrationTrace `locationName:"orchestrationTrace" type:"structure" sensitive:"true"`

	// Details about the post-processing step, in which the agent shapes the response..
	//
	// PostProcessingTrace is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Trace's
	// String and GoString methods.
	PostProcessingTrace *PostProcessingTrace `locationName:"postProcessingTrace" type:"structure" sensitive:"true"`

	// Details about the pre-processing step, in which the agent contextualizes
	// and categorizes user inputs.
	//
	// PreProcessingTrace is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Trace's
	// String and GoString methods.
	PreProcessingTrace *PreProcessingTrace `locationName:"preProcessingTrace" type:"structure" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement).

func (Trace) GoString 

func (s Trace) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Trace) SetFailureTrace 

func (s *Trace) SetFailureTrace(v *FailureTrace) *Trace

SetFailureTrace sets the FailureTrace field's value.

func (*Trace) SetGuardrailTrace 

func (s *Trace) SetGuardrailTrace(v *GuardrailTrace) *Trace

SetGuardrailTrace sets the GuardrailTrace field's value.

func (*Trace) SetOrchestrationTrace 

func (s *Trace) SetOrchestrationTrace(v *OrchestrationTrace) *Trace

SetOrchestrationTrace sets the OrchestrationTrace field's value.

func (*Trace) SetPostProcessingTrace 

func (s *Trace) SetPostProcessingTrace(v *PostProcessingTrace) *Trace

SetPostProcessingTrace sets the PostProcessingTrace field's value.

func (*Trace) SetPreProcessingTrace 

func (s *Trace) SetPreProcessingTrace(v *PreProcessingTrace) *Trace

SetPreProcessingTrace sets the PreProcessingTrace field's value.

func (Trace) String 

func (s Trace) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TracePart 

type TracePart struct {

	// The unique identifier of the alias of the agent.
	AgentAliasId *string `locationName:"agentAliasId" type:"string"`

	// The unique identifier of the agent.
	AgentId *string `locationName:"agentId" type:"string"`

	// The version of the agent.
	AgentVersion *string `locationName:"agentVersion" min:"1" type:"string"`

	// The unique identifier of the session with the agent.
	SessionId *string `locationName:"sessionId" min:"2" type:"string"`

	// Contains one part of the agent's reasoning process and results from calling
	// API actions and querying knowledge bases. You can use the trace to understand
	// how the agent arrived at the response it provided the customer. For more
	// information, see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement).
	//
	// Trace is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TracePart's
	// String and GoString methods.
	Trace *Trace `locationName:"trace" type:"structure" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement).

func (TracePart) GoString 

func (s TracePart) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TracePart) MarshalEvent 

func (s *TracePart) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*TracePart) SetAgentAliasId 

func (s *TracePart) SetAgentAliasId(v string) *TracePart

SetAgentAliasId sets the AgentAliasId field's value.

func (*TracePart) SetAgentId 

func (s *TracePart) SetAgentId(v string) *TracePart

SetAgentId sets the AgentId field's value.

func (*TracePart) SetAgentVersion 

func (s *TracePart) SetAgentVersion(v string) *TracePart

SetAgentVersion sets the AgentVersion field's value.

func (*TracePart) SetSessionId 

func (s *TracePart) SetSessionId(v string) *TracePart

SetSessionId sets the SessionId field's value.

func (*TracePart) SetTrace 

func (s *TracePart) SetTrace(v *Trace) *TracePart

SetTrace sets the Trace field's value.

func (TracePart) String 

func (s TracePart) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TracePart) UnmarshalEvent 

func (s *TracePart) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the TracePart value. This method is only used internally within the SDK's EventStream handling.

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Input validation failed. Check your request parameters and retry the request.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) MarshalEvent 

func (s *ValidationException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) UnmarshalEvent 

func (s *ValidationException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ValidationException value. This method is only used internally within the SDK's EventStream handling.

Source Files

View all Source files

Directories

Path Synopsis
Package bedrockagentruntimeiface provides an interface to enable mocking the Agents for Amazon Bedrock Runtime service client for testing your code.
 Package bedrockagentruntimeiface provides an interface to enable mocking the Agents for Amazon Bedrock Runtime service client for testing your code.

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.