bedrockagentruntime

package
v1.50.11 Latest Latest
Warning

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

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

Documentation

Overview

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

Amazon Bedrock Agent

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

indicates if agent uses default prompt or overriden prompt

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

types of invocations

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

types of prompts

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

Parsing error source

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

types of observations

View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// This exception is thrown when a request is denied per access permissions
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeBadGatewayException for service response error code
	// "BadGatewayException".
	//
	// This exception is thrown when a request fails due to dependency like Lambda,
	// Bedrock, STS resource
	ErrCodeBadGatewayException = "BadGatewayException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// This exception is thrown when there is a conflict performing an operation
	ErrCodeConflictException = "ConflictException"

	// ErrCodeDependencyFailedException for service response error code
	// "DependencyFailedException".
	//
	// This exception is thrown when a request fails due to dependency like Lambda,
	// Bedrock, STS resource due to a customer fault (i.e. bad configuration)
	ErrCodeDependencyFailedException = "DependencyFailedException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// This exception is thrown if there was an unexpected error during processing
	// of request
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// This exception is thrown when a resource referenced by the operation does
	// not exist
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// This exception is thrown when a request is made beyond the service quota
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// This exception is thrown when the number of requests exceeds the limit
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// This exception is thrown when the request's input validation fails
	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 (
	// RetrievalResultLocationTypeS3 is a RetrievalResultLocationType enum value
	RetrievalResultLocationTypeS3 = "S3"
)

The location type of a retrieval result.

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

The type of RetrieveAndGenerate.

Variables

This section is empty.

Functions

func CreationMode_Values 

func CreationMode_Values() []string

CreationMode_Values returns all elements of the CreationMode 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 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 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:"-"`

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

This exception is thrown when a request is denied per access permissions

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 {

	// Agent Trace Action Group Name
	//
	// 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"`

	// Agent Trace Action Group API path
	//
	// 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"`

	// list of parameters included in action group invocation
	Parameters []*Parameter `locationName:"parameters" type:"list"`

	// Request Body Content Map
	RequestBody *RequestBody `locationName:"requestBody" type:"structure"`

	// Agent Trace Action Group Action verb
	//
	// 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
}

input to lambda used in action group

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_) 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 {

	// Agent Trace Action Group Lambda Invocation Output String
	//
	// 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
}

output from lambda used in 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 Attribution 

type Attribution struct {

	// List of citations
	Citations []*Citation `locationName:"citations" type:"list"`
	// contains filtered or unexported fields
}

Citations associated with final 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:"-"`

	// Non Blank String
	Message_ *string `locationName:"message" type:"string"`

	// Non Blank String
	ResourceName *string `locationName:"resourceName" type:"string"`
	// contains filtered or unexported fields
}

This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource

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.

Invokes the specified Bedrock model to run inference using the input provided in the request body.

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 This exception is thrown when there is a conflict performing an operation

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

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

  • InternalServerException This exception is thrown if there was an unexpected error during processing of request

  • DependencyFailedException This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration)

  • BadGatewayException This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource

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

  • AccessDeniedException This exception is thrown when a request is denied per access permissions

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

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.

Retrieve from knowledge base.

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 This exception is thrown when there is a conflict performing an operation

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

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

  • InternalServerException This exception is thrown if there was an unexpected error during processing of request

  • DependencyFailedException This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration)

  • BadGatewayException This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource

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

  • AccessDeniedException This exception is thrown when a request is denied per access permissions

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

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.

RetrieveAndGenerate API

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 This exception is thrown when there is a conflict performing an operation

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

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

  • InternalServerException This exception is thrown if there was an unexpected error during processing of request

  • DependencyFailedException This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration)

  • BadGatewayException This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource

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

  • AccessDeniedException This exception is thrown when a request is denied per access permissions

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

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 Citation 

type Citation struct {

	// Generate response part
	GeneratedResponsePart *GeneratedResponsePart `locationName:"generatedResponsePart" type:"structure"`

	// list of retrieved references
	RetrievedReferences []*RetrievedReference `locationName:"retrievedReferences" type:"list"`
	// contains filtered or unexported fields
}

Citation associated with the agent response

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:"-"`

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

This exception is thrown when there is a conflict performing an operation

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 DependencyFailedException 

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

	// Non Blank String
	Message_ *string `locationName:"message" type:"string"`

	// Non Blank String
	ResourceName *string `locationName:"resourceName" type:"string"`
	// contains filtered or unexported fields
}

This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration)

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 FailureTrace 

type FailureTrace struct {

	// Agent Trace Failed Reason String
	//
	// 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"`

	// Identifier for trace
	TraceId *string `locationName:"traceId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Trace Part which is emitted when agent trace could not be generated

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 {

	// Agent Trace Action Group Lambda Invocation Output String
	//
	// 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
}

Agent finish output

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 GeneratedResponsePart 

type GeneratedResponsePart struct {

	// Text response part
	TextResponsePart *TextResponsePart `locationName:"textResponsePart" type:"structure"`
	// contains filtered or unexported fields
}

Generate response part

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 InferenceConfiguration 

type InferenceConfiguration struct {

	// Maximum length of output
	MaximumLength *int64 `locationName:"maximumLength" type:"integer"`

	// List of stop sequences
	StopSequences []*string `locationName:"stopSequences" type:"list"`

	// Controls randomness, higher values increase diversity
	Temperature *float64 `locationName:"temperature" type:"float"`

	// Sample from the k most likely next tokens
	TopK *int64 `locationName:"topK" type:"integer"`

	// Cumulative probability cutoff for token selection
	TopP *float64 `locationName:"topP" type:"float"`
	// contains filtered or unexported fields
}

Configurations for controlling the inference response of an InvokeAgent API call

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:"-"`

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

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

type InvocationInput_ struct {

	// input to lambda used in action group
	ActionGroupInvocationInput *ActionGroupInvocationInput_ `locationName:"actionGroupInvocationInput" type:"structure"`

	// types of invocations
	InvocationType *string `locationName:"invocationType" type:"string" enum:"InvocationType"`

	// Input to lambda used in action group
	KnowledgeBaseLookupInput *KnowledgeBaseLookupInput_ `locationName:"knowledgeBaseLookupInput" type:"structure"`

	// Identifier for trace
	TraceId *string `locationName:"traceId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Trace Part which contains input details for action group or knowledge base

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 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
  • TracePart
  • ResponseStreamUnknownEvent

type InvokeAgentInput 

type InvokeAgentInput struct {

	// Identifier for Agent Alias
	//
	// AgentAliasId is a required field
	AgentAliasId *string `location:"uri" locationName:"agentAliasId" type:"string" required:"true"`

	// Identifier for Agent
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// Enable agent trace events for improved debugging
	EnableTrace *bool `locationName:"enableTrace" type:"boolean"`

	// End current session
	EndSession *bool `locationName:"endSession" type:"boolean"`

	// Input data in the format specified in the Content-Type request header.
	//
	// InputText is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InvokeAgentInput's
	// String and GoString methods.
	//
	// InputText is a required field
	InputText *string `locationName:"inputText" type:"string" required:"true" sensitive:"true"`

	// Identifier used for the current session
	//
	// SessionId is a required field
	SessionId *string `location:"uri" locationName:"sessionId" min:"2" type:"string" required:"true"`

	// Session state passed by customer. Base64 encoded json string representation
	// of SessionState.
	SessionState *SessionState `locationName:"sessionState" type:"structure"`
	// contains filtered or unexported fields
}

InvokeAgent Request

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 {

	// streaming response mimetype of the model
	//
	// ContentType is a required field
	ContentType *string `location:"header" locationName:"x-amzn-bedrock-agent-content-type" type:"string" required:"true"`

	// streaming response mimetype of the model
	//
	// 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
}

InvokeAgent Response

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 {

	// Agent Trace Action Group Knowledge Base Id
	//
	// 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"`

	// Agent Trace Action Group Lambda Invocation Output String
	//
	// 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
}

Input to lambda used in action group

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 {

	// list of retrieved references
	RetrievedReferences []*RetrievedReference `locationName:"retrievedReferences" type:"list"`
	// contains filtered or unexported fields
}

Input to lambda used in action group

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 {

	// Knowledge base input query in text
	//
	// Text is a required field
	Text *string `locationName:"text" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Knowledge base input query.

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 {

	// Knowledge base vector search configuration
	//
	// VectorSearchConfiguration is a required field
	VectorSearchConfiguration *KnowledgeBaseVectorSearchConfiguration `locationName:"vectorSearchConfiguration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Search parameters for retrieving from knowledge base.

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 {

	// Content of a retrieval result.
	//
	// Content is a required field
	Content *RetrievalResultContent `locationName:"content" type:"structure" required:"true"`

	// The source location of a retrieval result.
	Location *RetrievalResultLocation `locationName:"location" type:"structure"`

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

Result item returned from a knowledge base retrieval.

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 {

	// Identifier of the KnowledgeBase
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// Arn of a Bedrock model.
	//
	// ModelArn is a required field
	ModelArn *string `locationName:"modelArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configurations for retrieval and generation for knowledge base.

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

	// Top-K results to retrieve from knowledge base.
	//
	// NumberOfResults is a required field
	NumberOfResults *int64 `locationName:"numberOfResults" min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Knowledge base vector search configuration

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

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

SetNumberOfResults sets the NumberOfResults 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 {

	// Configurations for controlling the inference response of an InvokeAgent API
	// call
	InferenceConfiguration *InferenceConfiguration `locationName:"inferenceConfiguration" type:"structure"`

	// ARN of a Lambda.
	OverrideLambda *string `locationName:"overrideLambda" type:"string"`

	// indicates if agent uses default prompt or overriden prompt
	ParserMode *string `locationName:"parserMode" type:"string" enum:"CreationMode"`

	// indicates if agent uses default prompt or overriden prompt
	PromptCreationMode *string `locationName:"promptCreationMode" type:"string" enum:"CreationMode"`

	// Prompt Message
	//
	// 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"`

	// Identifier for trace
	TraceId *string `locationName:"traceId" min:"2" type:"string"`

	// types of prompts
	Type *string `locationName:"type" type:"string" enum:"PromptType"`
	// contains filtered or unexported fields
}

Trace Part which contains information used to call Invoke Model

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 {

	// output from lambda used in action group
	ActionGroupInvocationOutput *ActionGroupInvocationOutput_ `locationName:"actionGroupInvocationOutput" type:"structure"`

	// Agent finish output
	FinalResponse *FinalResponse `locationName:"finalResponse" type:"structure"`

	// Input to lambda used in action group
	KnowledgeBaseLookupOutput *KnowledgeBaseLookupOutput_ `locationName:"knowledgeBaseLookupOutput" type:"structure"`

	// Observation information if there were reprompts
	//
	// 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"`

	// Identifier for trace
	TraceId *string `locationName:"traceId" min:"2" type:"string"`

	// types of observations
	Type *string `locationName:"type" type:"string" enum:"Type"`
	// contains filtered or unexported fields
}

Trace Part which contains output details for action group or knowledge base or final response

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 {

	// Trace Part which contains input details for action group or knowledge base
	//
	// 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"`

	// Trace Part which contains information used to call Invoke Model
	//
	// 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"`

	// Trace Part which contains output details for action group or knowledge base
	// or final response
	//
	// 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"`

	// Trace Part which contains information related to reasoning
	//
	// 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
}

Trace contains intermidate response during orchestration

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 {

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

	// Type of parameter
	Type *string `locationName:"type" type:"string"`

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

parameters included in action group invocation

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 {

	// Citations associated with final agent response
	Attribution *Attribution `locationName:"attribution" type:"structure"`

	// PartBody of the payload 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
}

Base 64 endoded byte response

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 {

	// Trace Part which contains information if preprocessing was successful
	//
	// 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"`

	// Identifier for trace
	TraceId *string `locationName:"traceId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Trace Part which contains information related to postprocessing

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 {

	// Agent Trace Output String
	//
	// 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
}

Trace Part which contains information if preprocessing was successful

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 {

	// Trace Part which contains information used to call Invoke Model
	//
	// 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"`

	// Trace Part which contains information related to postprocessing
	//
	// 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
}

Trace Part which contains information related to post processing step

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 {

	// Trace Part which contains information if preprocessing was successful
	//
	// 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"`

	// Identifier for trace
	TraceId *string `locationName:"traceId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Trace Part which contains information related to preprocessing

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 {

	// Boolean value
	IsValid *bool `locationName:"isValid" type:"boolean"`

	// Agent Trace Rationale String
	//
	// 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
}

Trace Part which contains information if preprocessing was successful

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 {

	// Trace Part which contains information used to call Invoke Model
	//
	// 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"`

	// Trace Part which contains information related to preprocessing
	//
	// 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
}

Trace Part which contains information related to preprocessing step

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 Rationale 

type Rationale struct {

	// Agent Trace Rationale String
	//
	// 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"`

	// Identifier for trace
	TraceId *string `locationName:"traceId" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Trace Part which contains information related to reasoning

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 {

	// Parsing error source
	//
	// 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"`

	// Reprompt response text
	Text *string `locationName:"text" type:"string"`
	// contains filtered or unexported fields
}

Observation information if there were reprompts

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 {

	// Content type paramter map
	Content map[string][]*Parameter `locationName:"content" type:"map"`
	// contains filtered or unexported fields
}

Request Body Content Map

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:"-"`

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

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

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
  • 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
  • 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 RetrievalResultContent 

type RetrievalResultContent struct {

	// Content of a retrieval result in text
	//
	// Text is a required field
	Text *string `locationName:"text" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Content of a retrieval result.

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 {

	// The S3 location of a retrieval result.
	S3Location *RetrievalResultS3Location `locationName:"s3Location" type:"structure"`

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

The source location of a retrieval result.

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 {

	// URI of S3 location
	Uri *string `locationName:"uri" type:"string"`
	// contains filtered or unexported fields
}

The S3 location of a retrieval result.

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 {

	// Configurations for retrieval and generation for knowledge base.
	KnowledgeBaseConfiguration *KnowledgeBaseRetrieveAndGenerateConfiguration `locationName:"knowledgeBaseConfiguration" type:"structure"`

	// The type of RetrieveAndGenerate.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"RetrieveAndGenerateType"`
	// contains filtered or unexported fields
}

Configures the retrieval and generation for the session.

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

	// Customer input of the turn
	//
	// 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"`

	// Configures the retrieval and generation for the session.
	RetrieveAndGenerateConfiguration *RetrieveAndGenerateConfiguration `locationName:"retrieveAndGenerateConfiguration" type:"structure"`

	// Configures common parameters of the session.
	SessionConfiguration *RetrieveAndGenerateSessionConfiguration `locationName:"sessionConfiguration" type:"structure"`

	// Identifier of the session.
	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 {

	// Customer input of the turn in text
	//
	// Text is a required field
	Text *string `locationName:"text" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Customer input of the turn

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 {

	// List of citations
	Citations []*Citation `locationName:"citations" type:"list"`

	// Service response of the turn
	//
	// 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"`

	// Identifier of the session.
	//
	// 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) 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 {

	// Service response of the turn in text
	//
	// Text is a required field
	Text *string `locationName:"text" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Service response of the turn

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 KMS key arn to encrypt the customer data of the session.
	//
	// KmsKeyArn is a required field
	KmsKeyArn *string `locationName:"kmsKeyArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configures common parameters of the session.

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 {

	// Identifier of the KnowledgeBase
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// Opaque continuation token of previous paginated response.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// Search parameters for retrieving from knowledge base.
	RetrievalConfiguration *KnowledgeBaseRetrievalConfiguration `locationName:"retrievalConfiguration" type:"structure"`

	// Knowledge base input query.
	//
	// 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 {

	// Opaque continuation token of previous paginated response.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// List of knowledge base retrieval results
	//
	// 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 {

	// Content of a retrieval result.
	Content *RetrievalResultContent `locationName:"content" type:"structure"`

	// The source location of a retrieval result.
	Location *RetrievalResultLocation `locationName:"location" type:"structure"`
	// contains filtered or unexported fields
}

Retrieved reference

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 ServiceQuotaExceededException 

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

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

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

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 {

	// Prompt Session Attributes
	PromptSessionAttributes map[string]*string `locationName:"promptSessionAttributes" type:"map"`

	// Session Attributes
	SessionAttributes map[string]*string `locationName:"sessionAttributes" type:"map"`
	// contains filtered or unexported fields
}

Session state provided

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

func (s *SessionState) SetPromptSessionAttributes(v map[string]*string) *SessionState

SetPromptSessionAttributes sets the PromptSessionAttributes 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".

type Span 

type Span struct {

	// End of span
	End *int64 `locationName:"end" type:"integer"`

	// Start of span
	Start *int64 `locationName:"start" type:"integer"`
	// contains filtered or unexported fields
}

Span of text

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 TextResponsePart 

type TextResponsePart struct {

	// Span of text
	Span *Span `locationName:"span" type:"structure"`

	// Response part in text
	Text *string `locationName:"text" type:"string"`
	// contains filtered or unexported fields
}

Text response part

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:"-"`

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

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

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 {

	// Trace Part which is emitted when agent trace could not be generated
	//
	// 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"`

	// Trace contains intermidate response during orchestration
	//
	// 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"`

	// Trace Part which contains information related to post processing step
	//
	// 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"`

	// Trace Part which contains information related to preprocessing step
	//
	// 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
}

Trace contains intermidate response for customer

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

	// Identifier of the agent alias.
	AgentAliasId *string `locationName:"agentAliasId" type:"string"`

	// Identifier of the agent.
	AgentId *string `locationName:"agentId" type:"string"`

	// Identifier of the session.
	SessionId *string `locationName:"sessionId" min:"2" type:"string"`

	// Trace contains intermidate response for customer
	//
	// 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
}

Trace Part which contains intermidate response for customer

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

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

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

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.