func CreationMode_Values() []string
CreationMode_Values returns all elements of the CreationMode enum
func ExternalSourceType_Values() []string
ExternalSourceType_Values returns all elements of the ExternalSourceType enum
func GuadrailAction_Values() []string
GuadrailAction_Values returns all elements of the GuadrailAction enum
func InvocationType_Values() []string
InvocationType_Values returns all elements of the InvocationType enum
func PromptType_Values() []string
PromptType_Values returns all elements of the PromptType enum
func ResponseState_Values() []string
ResponseState_Values returns all elements of the ResponseState enum
func RetrievalResultLocationType_Values() []string
RetrievalResultLocationType_Values returns all elements of the RetrievalResultLocationType enum
func RetrieveAndGenerateType_Values() []string
RetrieveAndGenerateType_Values returns all elements of the RetrieveAndGenerateType enum
func SearchType_Values() []string
SearchType_Values returns all elements of the SearchType enum
func Source_Values() []string
Source_Values returns all elements of the Source enum
func Type_Values() []string
Type_Values returns all elements of the Type enum
type AccessDeniedException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
The request is denied because of missing access permissions. Check your permissions and retry your request.
func (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (s *AccessDeniedException) Error() string
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 (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 (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 (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_ struct {
// The name of the action group.
//
// ActionGroupName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ActionGroupInvocationInput_'s
// String and GoString methods.
ActionGroupName *string `locationName:"actionGroupName" type:"string" sensitive:"true"`
// The path to the API to call, based off the action group.
//
// ApiPath is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ActionGroupInvocationInput_'s
// String and GoString methods.
ApiPath *string `locationName:"apiPath" type:"string" sensitive:"true"`
// The function in the action group to call.
//
// Function is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ActionGroupInvocationInput_'s
// String and GoString methods.
Function *string `locationName:"function" type:"string" sensitive:"true"`
// The parameters in the Lambda input event.
Parameters []*Parameter `locationName:"parameters" type:"list"`
// The parameters in the request body for the Lambda input event.
RequestBody *RequestBody `locationName:"requestBody" type:"structure"`
// The API method being used, based off the action group.
//
// Verb is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ActionGroupInvocationInput_'s
// String and GoString methods.
Verb *string `locationName:"verb" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in OrchestrationTrace (https://docs.aws.amazon.com/bedrock/latest/userguide/trace-orchestration.html) in the Amazon Bedrock User Guide.
func (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 (s *ActionGroupInvocationInput_) SetActionGroupName(v string) *ActionGroupInvocationInput_
SetActionGroupName sets the ActionGroupName field's value.
func (s *ActionGroupInvocationInput_) SetApiPath(v string) *ActionGroupInvocationInput_
SetApiPath sets the ApiPath field's value.
func (s *ActionGroupInvocationInput_) SetFunction(v string) *ActionGroupInvocationInput_
SetFunction sets the Function field's value.
func (s *ActionGroupInvocationInput_) SetParameters(v []*Parameter) *ActionGroupInvocationInput_
SetParameters sets the Parameters field's value.
func (s *ActionGroupInvocationInput_) SetRequestBody(v *RequestBody) *ActionGroupInvocationInput_
SetRequestBody sets the RequestBody field's value.
func (s *ActionGroupInvocationInput_) SetVerb(v string) *ActionGroupInvocationInput_
SetVerb sets the Verb field's value.
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_ struct {
// The JSON-formatted string returned by the API invoked by the action group.
//
// Text is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ActionGroupInvocationOutput_'s
// String and GoString methods.
Text *string `locationName:"text" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
Contains the JSON-formatted string returned by the API invoked by the action group.
func (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 (s *ActionGroupInvocationOutput_) SetText(v string) *ActionGroupInvocationOutput_
SetText sets the Text field's value.
func (s ActionGroupInvocationOutput_) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ApiInvocationInput_ struct {
// The action group that the API operation belongs to.
//
// ActionGroup is a required field
ActionGroup *string `locationName:"actionGroup" type:"string" required:"true"`
// The path to the API operation.
//
// ApiPath is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ApiInvocationInput_'s
// String and GoString methods.
ApiPath *string `locationName:"apiPath" type:"string" sensitive:"true"`
// The HTTP method of the API operation.
HttpMethod *string `locationName:"httpMethod" type:"string"`
// The parameters to provide for the API request, as the agent elicited from
// the user.
Parameters []*ApiParameter `locationName:"parameters" type:"list"`
// The request body to provide for the API request, as the agent elicited from
// the user.
RequestBody *ApiRequestBody `locationName:"requestBody" type:"structure"`
// contains filtered or unexported fields
}
Contains information about the API operation that the agent predicts should be called.
This data type is used in the following API operations:
func (s ApiInvocationInput_) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ApiInvocationInput_) SetActionGroup(v string) *ApiInvocationInput_
SetActionGroup sets the ActionGroup field's value.
func (s *ApiInvocationInput_) SetApiPath(v string) *ApiInvocationInput_
SetApiPath sets the ApiPath field's value.
func (s *ApiInvocationInput_) SetHttpMethod(v string) *ApiInvocationInput_
SetHttpMethod sets the HttpMethod field's value.
func (s *ApiInvocationInput_) SetParameters(v []*ApiParameter) *ApiInvocationInput_
SetParameters sets the Parameters field's value.
func (s *ApiInvocationInput_) SetRequestBody(v *ApiRequestBody) *ApiInvocationInput_
SetRequestBody sets the RequestBody field's value.
func (s ApiInvocationInput_) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ApiParameter struct {
// The name of the parameter.
Name *string `locationName:"name" type:"string"`
// The data type for the parameter.
Type *string `locationName:"type" type:"string"`
// The value of the parameter.
Value *string `locationName:"value" type:"string"`
// contains filtered or unexported fields
}
Information about a parameter to provide to the API request.
This data type is used in the following API operations:
func (s ApiParameter) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ApiParameter) SetName(v string) *ApiParameter
SetName sets the Name field's value.
func (s *ApiParameter) SetType(v string) *ApiParameter
SetType sets the Type field's value.
func (s *ApiParameter) SetValue(v string) *ApiParameter
SetValue sets the Value field's value.
func (s ApiParameter) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ApiRequestBody struct {
// The content of the request body. The key of the object in this field is a
// media type defining the format of the request body.
Content map[string]*PropertyParameters `locationName:"content" type:"map"`
// contains filtered or unexported fields
}
The request body to provide for the API request, as the agent elicited from the user.
This data type is used in the following API operations:
func (s ApiRequestBody) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ApiRequestBody) SetContent(v map[string]*PropertyParameters) *ApiRequestBody
SetContent sets the Content field's value.
func (s ApiRequestBody) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ApiResult struct {
// The action group that the API operation belongs to.
//
// ActionGroup is a required field
ActionGroup *string `locationName:"actionGroup" type:"string" required:"true"`
// The path to the API operation.
//
// ApiPath is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ApiResult's
// String and GoString methods.
ApiPath *string `locationName:"apiPath" type:"string" sensitive:"true"`
// The HTTP method for the API operation.
HttpMethod *string `locationName:"httpMethod" type:"string"`
// http status code from API execution response (for example: 200, 400, 500).
HttpStatusCode *int64 `locationName:"httpStatusCode" type:"integer"`
// The response body from the API operation. The key of the object is the content
// type (currently, only TEXT is supported). The response may be returned directly
// or from the Lambda function.
ResponseBody map[string]*ContentBody `locationName:"responseBody" type:"map"`
// Controls the final response state returned to end user when API/Function
// execution failed. When this state is FAILURE, the request would fail with
// dependency failure exception. When this state is REPROMPT, the API/function
// response will be sent to model for re-prompt
ResponseState *string `locationName:"responseState" type:"string" enum:"ResponseState"`
// contains filtered or unexported fields
}
Contains information about the API operation that was called from the action group and the response body that was returned.
This data type is used in the following API operations:
func (s ApiResult) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ApiResult) SetActionGroup(v string) *ApiResult
SetActionGroup sets the ActionGroup field's value.
func (s *ApiResult) SetApiPath(v string) *ApiResult
SetApiPath sets the ApiPath field's value.
func (s *ApiResult) SetHttpMethod(v string) *ApiResult
SetHttpMethod sets the HttpMethod field's value.
func (s *ApiResult) SetHttpStatusCode(v int64) *ApiResult
SetHttpStatusCode sets the HttpStatusCode field's value.
func (s *ApiResult) SetResponseBody(v map[string]*ContentBody) *ApiResult
SetResponseBody sets the ResponseBody field's value.
func (s *ApiResult) SetResponseState(v string) *ApiResult
SetResponseState sets the ResponseState field's value.
func (s ApiResult) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ApiResult) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Attribution struct {
// A list of citations and related information for a part of an agent response.
Citations []*Citation `locationName:"citations" type:"list"`
// contains filtered or unexported fields
}
Contains citations for a part of an agent response.
func (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 (s *Attribution) SetCitations(v []*Citation) *Attribution
SetCitations sets the Citations field's value.
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 struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// The name of the dependency that caused the issue, such as Amazon Bedrock,
// Lambda, or STS.
ResourceName *string `locationName:"resourceName" type:"string"`
// contains filtered or unexported fields
}
There was an issue with a dependency due to a server issue. Retry your request.
func (s *BadGatewayException) Code() string
Code returns the exception type name.
func (s *BadGatewayException) Error() string
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 (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 (s *BadGatewayException) Message() string
Message returns the exception's message.
func (s *BadGatewayException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *BadGatewayException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *BadGatewayException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 (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 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(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 (c *BedrockAgentRuntime) InvokeAgent(input *InvokeAgentInput) (*InvokeAgentOutput, error)
InvokeAgent API operation for Agents for Amazon Bedrock Runtime.
The CLI doesn't support InvokeAgent.
Sends a prompt for the agent to process and respond to. Note the following fields for the request:
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events).
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.
The response is returned in the bytes field of the chunk object.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.
Errors are also surfaced in the response.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Agents for Amazon Bedrock Runtime's API operation InvokeAgent for usage and error information.
Returned Error Types:
ConflictException There was a conflict performing an operation. Resolve the conflict and retry your request.
ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
ValidationException Input validation failed. Check your request parameters and retry the request.
InternalServerException An internal server error occurred. Retry your request.
DependencyFailedException There was an issue with a dependency. Check the resource configurations and retry the request.
BadGatewayException There was an issue with a dependency due to a server issue. Retry your request.
ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
AccessDeniedException The request is denied because of missing access permissions. Check your permissions and retry your request.
ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InvokeAgent
func (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 (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 (c *BedrockAgentRuntime) Retrieve(input *RetrieveInput) (*RetrieveOutput, error)
Retrieve API operation for Agents for Amazon Bedrock Runtime.
Queries a knowledge base and retrieves information from it.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Agents for Amazon Bedrock Runtime's API operation Retrieve for usage and error information.
Returned Error Types:
ConflictException There was a conflict performing an operation. Resolve the conflict and retry your request.
ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
ValidationException Input validation failed. Check your request parameters and retry the request.
InternalServerException An internal server error occurred. Retry your request.
DependencyFailedException There was an issue with a dependency. Check the resource configurations and retry the request.
BadGatewayException There was an issue with a dependency due to a server issue. Retry your request.
ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
AccessDeniedException The request is denied because of missing access permissions. Check your permissions and retry your request.
ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Retrieve
func (c *BedrockAgentRuntime) RetrieveAndGenerate(input *RetrieveAndGenerateInput) (*RetrieveAndGenerateOutput, error)
RetrieveAndGenerate API operation for Agents for Amazon Bedrock Runtime.
Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources that are relevant to the query.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Agents for Amazon Bedrock Runtime's API operation RetrieveAndGenerate for usage and error information.
Returned Error Types:
ConflictException There was a conflict performing an operation. Resolve the conflict and retry your request.
ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
ValidationException Input validation failed. Check your request parameters and retry the request.
InternalServerException An internal server error occurred. Retry your request.
DependencyFailedException There was an issue with a dependency. Check the resource configurations and retry the request.
BadGatewayException There was an issue with a dependency due to a server issue. Retry your request.
ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
AccessDeniedException The request is denied because of missing access permissions. Check your permissions and retry your request.
ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerate
func (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 (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 (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 (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 (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 (c *BedrockAgentRuntime) RetrieveWithContext(ctx aws.Context, input *RetrieveInput, opts ...request.Option) (*RetrieveOutput, error)
RetrieveWithContext is the same as Retrieve with the addition of the ability to pass a context and additional request options.
See Retrieve for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type ByteContentDoc struct {
// The MIME type of the document contained in the wrapper object.
//
// ContentType is a required field
ContentType *string `locationName:"contentType" type:"string" required:"true"`
// The byte value of the file to upload, encoded as a Base-64 string.
//
// Data is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ByteContentDoc's
// String and GoString methods.
//
// Data is automatically base64 encoded/decoded by the SDK.
//
// Data is a required field
Data []byte `locationName:"data" min:"1" type:"blob" required:"true" sensitive:"true"`
// The file name of the document contained in the wrapper object.
//
// Identifier is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ByteContentDoc's
// String and GoString methods.
//
// Identifier is a required field
Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true" sensitive:"true"`
// contains filtered or unexported fields
}
This property contains the document to chat with, along with its attributes.
func (s ByteContentDoc) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ByteContentDoc) SetContentType(v string) *ByteContentDoc
SetContentType sets the ContentType field's value.
func (s *ByteContentDoc) SetData(v []byte) *ByteContentDoc
SetData sets the Data field's value.
func (s *ByteContentDoc) SetIdentifier(v string) *ByteContentDoc
SetIdentifier sets the Identifier field's value.
func (s ByteContentDoc) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ByteContentDoc) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Citation struct {
// Contains the generated response and metadata
GeneratedResponsePart *GeneratedResponsePart `locationName:"generatedResponsePart" type:"structure"`
// Contains metadata about the sources cited for the generated response.
RetrievedReferences []*RetrievedReference `locationName:"retrievedReferences" type:"list"`
// contains filtered or unexported fields
}
An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.
This data type is used in the following API operations:
InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the citations field
RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the citations field
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 (s *Citation) SetGeneratedResponsePart(v *GeneratedResponsePart) *Citation
SetGeneratedResponsePart sets the GeneratedResponsePart field's value.
func (s *Citation) SetRetrievedReferences(v []*RetrievedReference) *Citation
SetRetrievedReferences sets the RetrievedReferences field's value.
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 struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
There was a conflict performing an operation. Resolve the conflict and retry your request.
func (s *ConflictException) Code() string
Code returns the exception type name.
func (s *ConflictException) Error() string
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 (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 (s *ConflictException) Message() string
Message returns the exception's message.
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 (s *ConflictException) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the ConflictException value. This method is only used internally within the SDK's EventStream handling.
type ContentBody struct {
// The body of the API response.
Body *string `locationName:"body" type:"string"`
// contains filtered or unexported fields
}
Contains the body of the API response.
This data type is used in the following API operations:
func (s ContentBody) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ContentBody) SetBody(v string) *ContentBody
SetBody sets the Body field's value.
func (s ContentBody) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DependencyFailedException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// The name of the dependency that caused the issue, such as Amazon Bedrock,
// Lambda, or STS.
ResourceName *string `locationName:"resourceName" type:"string"`
// contains filtered or unexported fields
}
There was an issue with a dependency. Check the resource configurations and retry the request.
func (s *DependencyFailedException) Code() string
Code returns the exception type name.
func (s *DependencyFailedException) Error() string
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 (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 (s *DependencyFailedException) Message() string
Message returns the exception's message.
func (s *DependencyFailedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *DependencyFailedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *DependencyFailedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 (s *DependencyFailedException) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the DependencyFailedException value. This method is only used internally within the SDK's EventStream handling.
type ExternalSource struct {
// The identifier, contentType, and data of the external source wrapper object.
ByteContent *ByteContentDoc `locationName:"byteContent" type:"structure"`
// The S3 location of the external source wrapper object.
S3Location *S3ObjectDoc `locationName:"s3Location" type:"structure"`
// The source type of the external source wrapper object.
//
// SourceType is a required field
SourceType *string `locationName:"sourceType" type:"string" required:"true" enum:"ExternalSourceType"`
// contains filtered or unexported fields
}
The unique external source of the content contained in the wrapper object.
func (s ExternalSource) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExternalSource) SetByteContent(v *ByteContentDoc) *ExternalSource
SetByteContent sets the ByteContent field's value.
func (s *ExternalSource) SetS3Location(v *S3ObjectDoc) *ExternalSource
SetS3Location sets the S3Location field's value.
func (s *ExternalSource) SetSourceType(v string) *ExternalSource
SetSourceType sets the SourceType field's value.
func (s ExternalSource) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExternalSource) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ExternalSourcesGenerationConfiguration struct {
// The configuration details for the guardrail.
GuardrailConfiguration *GuardrailConfiguration `locationName:"guardrailConfiguration" type:"structure"`
// Configuration settings for inference when using RetrieveAndGenerate to generate
// responses while using an external source.
InferenceConfig *InferenceConfig `locationName:"inferenceConfig" type:"structure"`
// Contain the textPromptTemplate string for the external source wrapper object.
PromptTemplate *PromptTemplate `locationName:"promptTemplate" type:"structure"`
// contains filtered or unexported fields
}
Contains the generation configuration of the external source wrapper object.
func (s ExternalSourcesGenerationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExternalSourcesGenerationConfiguration) SetGuardrailConfiguration(v *GuardrailConfiguration) *ExternalSourcesGenerationConfiguration
SetGuardrailConfiguration sets the GuardrailConfiguration field's value.
func (s *ExternalSourcesGenerationConfiguration) SetInferenceConfig(v *InferenceConfig) *ExternalSourcesGenerationConfiguration
SetInferenceConfig sets the InferenceConfig field's value.
func (s *ExternalSourcesGenerationConfiguration) SetPromptTemplate(v *PromptTemplate) *ExternalSourcesGenerationConfiguration
SetPromptTemplate sets the PromptTemplate field's value.
func (s ExternalSourcesGenerationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExternalSourcesGenerationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ExternalSourcesRetrieveAndGenerateConfiguration struct {
// The prompt used with the external source wrapper object with the retrieveAndGenerate
// function.
GenerationConfiguration *ExternalSourcesGenerationConfiguration `locationName:"generationConfiguration" type:"structure"`
// The modelArn used with the external source wrapper object in the retrieveAndGenerate
// function.
//
// ModelArn is a required field
ModelArn *string `locationName:"modelArn" min:"20" type:"string" required:"true"`
// The document used with the external source wrapper object in the retrieveAndGenerate
// function.
//
// Sources is a required field
Sources []*ExternalSource `locationName:"sources" min:"1" type:"list" required:"true"`
// contains filtered or unexported fields
}
The configurations of the external source wrapper object in the retrieveAndGenerate function.
func (s ExternalSourcesRetrieveAndGenerateConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExternalSourcesRetrieveAndGenerateConfiguration) SetGenerationConfiguration(v *ExternalSourcesGenerationConfiguration) *ExternalSourcesRetrieveAndGenerateConfiguration
SetGenerationConfiguration sets the GenerationConfiguration field's value.
func (s *ExternalSourcesRetrieveAndGenerateConfiguration) SetModelArn(v string) *ExternalSourcesRetrieveAndGenerateConfiguration
SetModelArn sets the ModelArn field's value.
func (s *ExternalSourcesRetrieveAndGenerateConfiguration) SetSources(v []*ExternalSource) *ExternalSourcesRetrieveAndGenerateConfiguration
SetSources sets the Sources field's value.
func (s ExternalSourcesRetrieveAndGenerateConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExternalSourcesRetrieveAndGenerateConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type FailureTrace struct {
// The reason the interaction failed.
//
// FailureReason is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by FailureTrace's
// String and GoString methods.
FailureReason *string `locationName:"failureReason" type:"string" sensitive:"true"`
// The unique identifier of the trace.
TraceId *string `locationName:"traceId" min:"2" type:"string"`
// contains filtered or unexported fields
}
Contains information about the failure of the interaction.
func (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 (s *FailureTrace) SetFailureReason(v string) *FailureTrace
SetFailureReason sets the FailureReason field's value.
func (s *FailureTrace) SetTraceId(v string) *FailureTrace
SetTraceId sets the TraceId field's value.
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 struct {
// The text in the response to the user.
//
// Text is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by FinalResponse's
// String and GoString methods.
Text *string `locationName:"text" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
Contains details about the response to the user.
func (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 (s *FinalResponse) SetText(v string) *FinalResponse
SetText sets the Text field's value.
func (s FinalResponse) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type FunctionInvocationInput_ struct {
// The action group that the function belongs to.
//
// ActionGroup is a required field
ActionGroup *string `locationName:"actionGroup" type:"string" required:"true"`
// The name of the function.
Function *string `locationName:"function" type:"string"`
// A list of parameters of the function.
Parameters []*FunctionParameter `locationName:"parameters" type:"list"`
// contains filtered or unexported fields
}
Contains information about the function that the agent predicts should be called.
This data type is used in the following API operations:
func (s FunctionInvocationInput_) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *FunctionInvocationInput_) SetActionGroup(v string) *FunctionInvocationInput_
SetActionGroup sets the ActionGroup field's value.
func (s *FunctionInvocationInput_) SetFunction(v string) *FunctionInvocationInput_
SetFunction sets the Function field's value.
func (s *FunctionInvocationInput_) SetParameters(v []*FunctionParameter) *FunctionInvocationInput_
SetParameters sets the Parameters field's value.
func (s FunctionInvocationInput_) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type FunctionParameter struct {
// The name of the parameter.
Name *string `locationName:"name" type:"string"`
// The data type of the parameter.
Type *string `locationName:"type" type:"string"`
// The value of the parameter.
Value *string `locationName:"value" type:"string"`
// contains filtered or unexported fields
}
Contains information about a parameter of the function.
This data type is used in the following API operations:
func (s FunctionParameter) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *FunctionParameter) SetName(v string) *FunctionParameter
SetName sets the Name field's value.
func (s *FunctionParameter) SetType(v string) *FunctionParameter
SetType sets the Type field's value.
func (s *FunctionParameter) SetValue(v string) *FunctionParameter
SetValue sets the Value field's value.
func (s FunctionParameter) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type FunctionResult struct {
// The action group that the function belongs to.
//
// ActionGroup is a required field
ActionGroup *string `locationName:"actionGroup" type:"string" required:"true"`
// The name of the function that was called.
Function *string `locationName:"function" type:"string"`
// The response from the function call using the parameters. The key of the
// object is the content type (currently, only TEXT is supported). The response
// may be returned directly or from the Lambda function.
ResponseBody map[string]*ContentBody `locationName:"responseBody" type:"map"`
// Controls the final response state returned to end user when API/Function
// execution failed. When this state is FAILURE, the request would fail with
// dependency failure exception. When this state is REPROMPT, the API/function
// response will be sent to model for re-prompt
ResponseState *string `locationName:"responseState" type:"string" enum:"ResponseState"`
// contains filtered or unexported fields
}
Contains information about the function that was called from the action group and the response that was returned.
This data type is used in the following API operations:
func (s FunctionResult) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *FunctionResult) SetActionGroup(v string) *FunctionResult
SetActionGroup sets the ActionGroup field's value.
func (s *FunctionResult) SetFunction(v string) *FunctionResult
SetFunction sets the Function field's value.
func (s *FunctionResult) SetResponseBody(v map[string]*ContentBody) *FunctionResult
SetResponseBody sets the ResponseBody field's value.
func (s *FunctionResult) SetResponseState(v string) *FunctionResult
SetResponseState sets the ResponseState field's value.
func (s FunctionResult) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *FunctionResult) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GeneratedResponsePart struct {
// Contains metadata about a textual part of the generated response that is
// accompanied by a citation.
//
// TextResponsePart is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by GeneratedResponsePart's
// String and GoString methods.
TextResponsePart *TextResponsePart `locationName:"textResponsePart" type:"structure" sensitive:"true"`
// contains filtered or unexported fields
}
Contains metadata about a part of the generated response that is accompanied by a citation.
This data type is used in the following API operations:
InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the generatedResponsePart field
RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the generatedResponsePart field
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 (s *GeneratedResponsePart) SetTextResponsePart(v *TextResponsePart) *GeneratedResponsePart
SetTextResponsePart sets the TextResponsePart field's value.
func (s GeneratedResponsePart) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GenerationConfiguration struct {
// The configuration details for the guardrail.
GuardrailConfiguration *GuardrailConfiguration `locationName:"guardrailConfiguration" type:"structure"`
// Configuration settings for inference when using RetrieveAndGenerate to generate
// responses while using a knowledge base as a source.
InferenceConfig *InferenceConfig `locationName:"inferenceConfig" type:"structure"`
// Contains the template for the prompt that's sent to the model for response
// generation.
PromptTemplate *PromptTemplate `locationName:"promptTemplate" type:"structure"`
// contains filtered or unexported fields
}
Contains configurations for response generation based on the knowledge base query results.
This data type is used in the following API operations:
func (s GenerationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GenerationConfiguration) SetGuardrailConfiguration(v *GuardrailConfiguration) *GenerationConfiguration
SetGuardrailConfiguration sets the GuardrailConfiguration field's value.
func (s *GenerationConfiguration) SetInferenceConfig(v *InferenceConfig) *GenerationConfiguration
SetInferenceConfig sets the InferenceConfig field's value.
func (s *GenerationConfiguration) SetPromptTemplate(v *PromptTemplate) *GenerationConfiguration
SetPromptTemplate sets the PromptTemplate field's value.
func (s GenerationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GenerationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GuardrailConfiguration struct {
// The unique identifier for the guardrail.
//
// GuardrailId is a required field
GuardrailId *string `locationName:"guardrailId" type:"string" required:"true"`
// The version of the guardrail.
//
// GuardrailVersion is a required field
GuardrailVersion *string `locationName:"guardrailVersion" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
The configuration details for the guardrail.
func (s GuardrailConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GuardrailConfiguration) SetGuardrailId(v string) *GuardrailConfiguration
SetGuardrailId sets the GuardrailId field's value.
func (s *GuardrailConfiguration) SetGuardrailVersion(v string) *GuardrailConfiguration
SetGuardrailVersion sets the GuardrailVersion field's value.
func (s GuardrailConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GuardrailConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InferenceConfig struct {
// Configuration settings specific to text generation while generating responses
// using RetrieveAndGenerate.
TextInferenceConfig *TextInferenceConfig `locationName:"textInferenceConfig" type:"structure"`
// contains filtered or unexported fields
}
The configuration for inference settings when generating responses using RetrieveAndGenerate.
func (s InferenceConfig) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InferenceConfig) SetTextInferenceConfig(v *TextInferenceConfig) *InferenceConfig
SetTextInferenceConfig sets the TextInferenceConfig field's value.
func (s InferenceConfig) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InferenceConfiguration struct {
// The maximum number of tokens allowed in the generated response.
MaximumLength *int64 `locationName:"maximumLength" type:"integer"`
// A list of stop sequences. A stop sequence is a sequence of characters that
// causes the model to stop generating the response.
StopSequences []*string `locationName:"stopSequences" type:"list"`
// The likelihood of the model selecting higher-probability options while generating
// a response. A lower value makes the model more likely to choose higher-probability
// options, while a higher value makes the model more likely to choose lower-probability
// options.
Temperature *float64 `locationName:"temperature" type:"float"`
// While generating a response, the model determines the probability of the
// following token at each point of generation. The value that you set for topK
// is the number of most-likely candidates from which the model chooses the
// next token in the sequence. For example, if you set topK to 50, the model
// selects the next token from among the top 50 most likely choices.
TopK *int64 `locationName:"topK" type:"integer"`
// While generating a response, the model determines the probability of the
// following token at each point of generation. The value that you set for Top
// P determines the number of most-likely candidates from which the model chooses
// the next token in the sequence. For example, if you set topP to 80, the model
// only selects the next token from the top 80% of the probability distribution
// of next tokens.
TopP *float64 `locationName:"topP" type:"float"`
// contains filtered or unexported fields
}
Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
func (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 (s *InferenceConfiguration) SetMaximumLength(v int64) *InferenceConfiguration
SetMaximumLength sets the MaximumLength field's value.
func (s *InferenceConfiguration) SetStopSequences(v []*string) *InferenceConfiguration
SetStopSequences sets the StopSequences field's value.
func (s *InferenceConfiguration) SetTemperature(v float64) *InferenceConfiguration
SetTemperature sets the Temperature field's value.
func (s *InferenceConfiguration) SetTopK(v int64) *InferenceConfiguration
SetTopK sets the TopK field's value.
func (s *InferenceConfiguration) SetTopP(v float64) *InferenceConfiguration
SetTopP sets the TopP field's value.
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 struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
An internal server error occurred. Retry your request.
func (s *InternalServerException) Code() string
Code returns the exception type name.
func (s *InternalServerException) Error() string
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 (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 (s *InternalServerException) Message() string
Message returns the exception's message.
func (s *InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 (s *InternalServerException) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the InternalServerException value. This method is only used internally within the SDK's EventStream handling.
type InvocationInputMember struct {
// Contains information about the API operation that the agent predicts should
// be called.
ApiInvocationInput *ApiInvocationInput_ `locationName:"apiInvocationInput" type:"structure"`
// Contains information about the function that the agent predicts should be
// called.
FunctionInvocationInput *FunctionInvocationInput_ `locationName:"functionInvocationInput" type:"structure"`
// contains filtered or unexported fields
}
Contains details about the API operation or function that the agent predicts should be called.
This data type is used in the following API operations:
func (s InvocationInputMember) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvocationInputMember) SetApiInvocationInput(v *ApiInvocationInput_) *InvocationInputMember
SetApiInvocationInput sets the ApiInvocationInput field's value.
func (s *InvocationInputMember) SetFunctionInvocationInput(v *FunctionInvocationInput_) *InvocationInputMember
SetFunctionInvocationInput sets the FunctionInvocationInput field's value.
func (s InvocationInputMember) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvocationInput_ struct {
// Contains information about the action group to be invoked.
ActionGroupInvocationInput *ActionGroupInvocationInput_ `locationName:"actionGroupInvocationInput" type:"structure"`
// Specifies whether the agent is invoking an action group or a knowledge base.
InvocationType *string `locationName:"invocationType" type:"string" enum:"InvocationType"`
// Contains details about the knowledge base to look up and the query to be
// made.
KnowledgeBaseLookupInput *KnowledgeBaseLookupInput_ `locationName:"knowledgeBaseLookupInput" type:"structure"`
// The unique identifier of the trace.
TraceId *string `locationName:"traceId" min:"2" type:"string"`
// contains filtered or unexported fields
}
Contains information pertaining to the action group or knowledge base that is being invoked.
func (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 (s *InvocationInput_) SetActionGroupInvocationInput(v *ActionGroupInvocationInput_) *InvocationInput_
SetActionGroupInvocationInput sets the ActionGroupInvocationInput field's value.
func (s *InvocationInput_) SetInvocationType(v string) *InvocationInput_
SetInvocationType sets the InvocationType field's value.
func (s *InvocationInput_) SetKnowledgeBaseLookupInput(v *KnowledgeBaseLookupInput_) *InvocationInput_
SetKnowledgeBaseLookupInput sets the KnowledgeBaseLookupInput field's value.
func (s *InvocationInput_) SetTraceId(v string) *InvocationInput_
SetTraceId sets the TraceId field's value.
func (s InvocationInput_) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvocationResultMember struct {
// The result from the API response from the action group invocation.
ApiResult *ApiResult `locationName:"apiResult" type:"structure"`
// The result from the function from the action group invocation.
FunctionResult *FunctionResult `locationName:"functionResult" type:"structure"`
// contains filtered or unexported fields
}
A result from the invocation of an action. For more information, see Return control to the agent developer (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html) and Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).
This data type is used in the following API operations:
func (s InvocationResultMember) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvocationResultMember) SetApiResult(v *ApiResult) *InvocationResultMember
SetApiResult sets the ApiResult field's value.
func (s *InvocationResultMember) SetFunctionResult(v *FunctionResult) *InvocationResultMember
SetFunctionResult sets the FunctionResult field's value.
func (s InvocationResultMember) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvocationResultMember) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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(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 (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 (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 (es *InvokeAgentEventStream) Events() <-chan ResponseStreamEvent
Events returns a channel to read events from.
These events are:
type InvokeAgentInput struct {
// The alias of the agent to use.
//
// AgentAliasId is a required field
AgentAliasId *string `location:"uri" locationName:"agentAliasId" type:"string" required:"true"`
// The unique identifier of the agent to use.
//
// AgentId is a required field
AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`
// Specifies whether to turn on the trace or not to track the agent's reasoning
// process. For more information, see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events).
EnableTrace *bool `locationName:"enableTrace" type:"boolean"`
// Specifies whether to end the session with the agent or not.
EndSession *bool `locationName:"endSession" type:"boolean"`
// The prompt text to send the agent.
//
// If you include returnControlInvocationResults in the sessionState field,
// the inputText field will be ignored.
//
// InputText is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by InvokeAgentInput's
// String and GoString methods.
InputText *string `locationName:"inputText" type:"string" sensitive:"true"`
// The unique identifier of the session. Use the same value across requests
// to continue the same conversation.
//
// SessionId is a required field
SessionId *string `location:"uri" locationName:"sessionId" min:"2" type:"string" required:"true"`
// Contains parameters that specify various attributes of the session. For more
// information, see Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).
//
// If you include returnControlInvocationResults in the sessionState field,
// the inputText field will be ignored.
SessionState *SessionState `locationName:"sessionState" type:"structure"`
// contains filtered or unexported fields
}
func (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 (s *InvokeAgentInput) SetAgentAliasId(v string) *InvokeAgentInput
SetAgentAliasId sets the AgentAliasId field's value.
func (s *InvokeAgentInput) SetAgentId(v string) *InvokeAgentInput
SetAgentId sets the AgentId field's value.
func (s *InvokeAgentInput) SetEnableTrace(v bool) *InvokeAgentInput
SetEnableTrace sets the EnableTrace field's value.
func (s *InvokeAgentInput) SetEndSession(v bool) *InvokeAgentInput
SetEndSession sets the EndSession field's value.
func (s *InvokeAgentInput) SetInputText(v string) *InvokeAgentInput
SetInputText sets the InputText field's value.
func (s *InvokeAgentInput) SetSessionId(v string) *InvokeAgentInput
SetSessionId sets the SessionId field's value.
func (s *InvokeAgentInput) SetSessionState(v *SessionState) *InvokeAgentInput
SetSessionState sets the SessionState field's value.
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 (s *InvokeAgentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InvokeAgentOutput struct {
// The MIME type of the input data in the request. The default value is application/json.
//
// ContentType is a required field
ContentType *string `location:"header" locationName:"x-amzn-bedrock-agent-content-type" type:"string" required:"true"`
// The unique identifier of the session with the agent.
//
// SessionId is a required field
SessionId *string `location:"header" locationName:"x-amz-bedrock-agent-session-id" min:"2" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s *InvokeAgentOutput) GetStream() *InvokeAgentEventStream
GetStream returns the type to interact with the event stream.
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 (s *InvokeAgentOutput) SetContentType(v string) *InvokeAgentOutput
SetContentType sets the ContentType field's value.
func (s *InvokeAgentOutput) SetSessionId(v string) *InvokeAgentOutput
SetSessionId sets the SessionId field's value.
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_ struct {
// The unique identifier of the knowledge base to look up.
//
// KnowledgeBaseId is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by KnowledgeBaseLookupInput_'s
// String and GoString methods.
KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" sensitive:"true"`
// The query made to the knowledge base.
//
// Text is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by KnowledgeBaseLookupInput_'s
// String and GoString methods.
Text *string `locationName:"text" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
Contains details about the knowledge base to look up and the query to be made.
func (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 (s *KnowledgeBaseLookupInput_) SetKnowledgeBaseId(v string) *KnowledgeBaseLookupInput_
SetKnowledgeBaseId sets the KnowledgeBaseId field's value.
func (s *KnowledgeBaseLookupInput_) SetText(v string) *KnowledgeBaseLookupInput_
SetText sets the Text field's value.
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_ struct {
// Contains metadata about the sources cited for the generated response.
RetrievedReferences []*RetrievedReference `locationName:"retrievedReferences" type:"list"`
// contains filtered or unexported fields
}
Contains details about the results from looking up the knowledge base.
func (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 (s *KnowledgeBaseLookupOutput_) SetRetrievedReferences(v []*RetrievedReference) *KnowledgeBaseLookupOutput_
SetRetrievedReferences sets the RetrievedReferences field's value.
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 struct {
// The text of the query made to the knowledge base.
//
// Text is a required field
Text *string `locationName:"text" type:"string" required:"true"`
// contains filtered or unexported fields
}
Contains the query made to the knowledge base.
This data type is used in the following API operations:
func (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 (s *KnowledgeBaseQuery) SetText(v string) *KnowledgeBaseQuery
SetText sets the Text field's value.
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 (s *KnowledgeBaseQuery) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KnowledgeBaseRetrievalConfiguration struct {
// Contains details about how the results from the vector search should be returned.
// For more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
//
// VectorSearchConfiguration is a required field
VectorSearchConfiguration *KnowledgeBaseVectorSearchConfiguration `locationName:"vectorSearchConfiguration" type:"structure" required:"true"`
// contains filtered or unexported fields
}
Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
This data type is used in the following API operations:
Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) – in the retrievalConfiguration field
RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) – in the retrievalConfiguration field
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 (s *KnowledgeBaseRetrievalConfiguration) SetVectorSearchConfiguration(v *KnowledgeBaseVectorSearchConfiguration) *KnowledgeBaseRetrievalConfiguration
SetVectorSearchConfiguration sets the VectorSearchConfiguration field's value.
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 (s *KnowledgeBaseRetrievalConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KnowledgeBaseRetrievalResult struct {
// Contains a chunk of text from a data source in the knowledge base.
//
// Content is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by KnowledgeBaseRetrievalResult's
// String and GoString methods.
//
// Content is a required field
Content *RetrievalResultContent `locationName:"content" type:"structure" required:"true" sensitive:"true"`
// Contains information about the location of the data source.
//
// Location is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by KnowledgeBaseRetrievalResult's
// String and GoString methods.
Location *RetrievalResultLocation `locationName:"location" type:"structure" sensitive:"true"`
// The level of relevance of the result to the query.
Score *float64 `locationName:"score" type:"double"`
// contains filtered or unexported fields
}
Details about a result from querying the knowledge base.
This data type is used in the following API operations:
func (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 (s *KnowledgeBaseRetrievalResult) SetContent(v *RetrievalResultContent) *KnowledgeBaseRetrievalResult
SetContent sets the Content field's value.
func (s *KnowledgeBaseRetrievalResult) SetLocation(v *RetrievalResultLocation) *KnowledgeBaseRetrievalResult
SetLocation sets the Location field's value.
func (s *KnowledgeBaseRetrievalResult) SetScore(v float64) *KnowledgeBaseRetrievalResult
SetScore sets the Score field's value.
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 struct {
// Contains configurations for response generation based on the knowwledge base
// query results.
GenerationConfiguration *GenerationConfiguration `locationName:"generationConfiguration" type:"structure"`
// The unique identifier of the knowledge base that is queried and the foundation
// model used for generation.
//
// KnowledgeBaseId is a required field
KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`
// The ARN of the foundation model used to generate a response.
//
// ModelArn is a required field
ModelArn *string `locationName:"modelArn" min:"20" type:"string" required:"true"`
// Contains configurations for how to retrieve and return the knowledge base
// query.
RetrievalConfiguration *KnowledgeBaseRetrievalConfiguration `locationName:"retrievalConfiguration" type:"structure"`
// contains filtered or unexported fields
}
Contains details about the resource being queried.
This data type is used in the following API operations:
Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) – in the knowledgeBaseConfiguration field
RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) – in the knowledgeBaseConfiguration field
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 (s *KnowledgeBaseRetrieveAndGenerateConfiguration) SetGenerationConfiguration(v *GenerationConfiguration) *KnowledgeBaseRetrieveAndGenerateConfiguration
SetGenerationConfiguration sets the GenerationConfiguration field's value.
func (s *KnowledgeBaseRetrieveAndGenerateConfiguration) SetKnowledgeBaseId(v string) *KnowledgeBaseRetrieveAndGenerateConfiguration
SetKnowledgeBaseId sets the KnowledgeBaseId field's value.
func (s *KnowledgeBaseRetrieveAndGenerateConfiguration) SetModelArn(v string) *KnowledgeBaseRetrieveAndGenerateConfiguration
SetModelArn sets the ModelArn field's value.
func (s *KnowledgeBaseRetrieveAndGenerateConfiguration) SetRetrievalConfiguration(v *KnowledgeBaseRetrievalConfiguration) *KnowledgeBaseRetrieveAndGenerateConfiguration
SetRetrievalConfiguration sets the RetrievalConfiguration field's value.
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 (s *KnowledgeBaseRetrieveAndGenerateConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KnowledgeBaseVectorSearchConfiguration struct {
// Specifies the filters to use on the metadata in the knowledge base data sources
// before returning results. For more information, see Query configurations
// (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
//
// Filter is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by KnowledgeBaseVectorSearchConfiguration's
// String and GoString methods.
Filter *RetrievalFilter `locationName:"filter" type:"structure" sensitive:"true"`
// The number of source chunks to retrieve.
NumberOfResults *int64 `locationName:"numberOfResults" min:"1" type:"integer"`
// By default, Amazon Bedrock decides a search strategy for you. If you're using
// an Amazon OpenSearch Serverless vector store that contains a filterable text
// field, you can specify whether to query the knowledge base with a HYBRID
// search using both vector embeddings and raw text, or SEMANTIC search using
// only vector embeddings. For other vector store configurations, only SEMANTIC
// search is available. For more information, see Test a knowledge base (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-test.html).
OverrideSearchType *string `locationName:"overrideSearchType" type:"string" enum:"SearchType"`
// contains filtered or unexported fields
}
Configurations for how to perform the search query and return results. For more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
This data type is used in the following API operations:
Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) – in the vectorSearchConfiguration field
RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) – in the vectorSearchConfiguration field
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 (s *KnowledgeBaseVectorSearchConfiguration) SetFilter(v *RetrievalFilter) *KnowledgeBaseVectorSearchConfiguration
SetFilter sets the Filter field's value.
func (s *KnowledgeBaseVectorSearchConfiguration) SetNumberOfResults(v int64) *KnowledgeBaseVectorSearchConfiguration
SetNumberOfResults sets the NumberOfResults field's value.
func (s *KnowledgeBaseVectorSearchConfiguration) SetOverrideSearchType(v string) *KnowledgeBaseVectorSearchConfiguration
SetOverrideSearchType sets the OverrideSearchType field's value.
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 (s *KnowledgeBaseVectorSearchConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ModelInvocationInput_ struct {
// Specifications about the inference parameters that were provided alongside
// the prompt. These are specified in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html)
// object that was set when the agent was created or updated. For more information,
// see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
InferenceConfiguration *InferenceConfiguration `locationName:"inferenceConfiguration" type:"structure"`
// The ARN of the Lambda function to use when parsing the raw foundation model
// output in parts of the agent sequence.
OverrideLambda *string `locationName:"overrideLambda" type:"string"`
// Specifies whether to override the default parser Lambda function when parsing
// the raw foundation model output in the part of the agent sequence defined
// by the promptType.
ParserMode *string `locationName:"parserMode" type:"string" enum:"CreationMode"`
// Specifies whether the default prompt template was OVERRIDDEN. If it was,
// the basePromptTemplate that was set in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html)
// object when the agent was created or updated is used instead.
PromptCreationMode *string `locationName:"promptCreationMode" type:"string" enum:"CreationMode"`
// The text that prompted the agent at this step.
//
// Text is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ModelInvocationInput_'s
// String and GoString methods.
Text *string `locationName:"text" type:"string" sensitive:"true"`
// The unique identifier of the trace.
TraceId *string `locationName:"traceId" min:"2" type:"string"`
// The step in the agent sequence.
Type *string `locationName:"type" type:"string" enum:"PromptType"`
// contains filtered or unexported fields
}
The input for the pre-processing step.
The type matches the agent step.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) object that was set when the agent was created or updated.
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 (s *ModelInvocationInput_) SetInferenceConfiguration(v *InferenceConfiguration) *ModelInvocationInput_
SetInferenceConfiguration sets the InferenceConfiguration field's value.
func (s *ModelInvocationInput_) SetOverrideLambda(v string) *ModelInvocationInput_
SetOverrideLambda sets the OverrideLambda field's value.
func (s *ModelInvocationInput_) SetParserMode(v string) *ModelInvocationInput_
SetParserMode sets the ParserMode field's value.
func (s *ModelInvocationInput_) SetPromptCreationMode(v string) *ModelInvocationInput_
SetPromptCreationMode sets the PromptCreationMode field's value.
func (s *ModelInvocationInput_) SetText(v string) *ModelInvocationInput_
SetText sets the Text field's value.
func (s *ModelInvocationInput_) SetTraceId(v string) *ModelInvocationInput_
SetTraceId sets the TraceId field's value.
func (s *ModelInvocationInput_) SetType(v string) *ModelInvocationInput_
SetType sets the Type field's value.
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 struct {
// Contains the JSON-formatted string returned by the API invoked by the action
// group.
ActionGroupInvocationOutput *ActionGroupInvocationOutput_ `locationName:"actionGroupInvocationOutput" type:"structure"`
// Contains details about the response to the user.
FinalResponse *FinalResponse `locationName:"finalResponse" type:"structure"`
// Contains details about the results from looking up the knowledge base.
KnowledgeBaseLookupOutput *KnowledgeBaseLookupOutput_ `locationName:"knowledgeBaseLookupOutput" type:"structure"`
// Contains details about the response to reprompt the input.
//
// RepromptResponse is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Observation's
// String and GoString methods.
RepromptResponse *RepromptResponse `locationName:"repromptResponse" type:"structure" sensitive:"true"`
// The unique identifier of the trace.
TraceId *string `locationName:"traceId" min:"2" type:"string"`
// Specifies what kind of information the agent returns in the observation.
// The following values are possible.
//
// * ACTION_GROUP – The agent returns the result of an action group.
//
// * KNOWLEDGE_BASE – The agent returns information from a knowledge base.
//
// * FINISH – The agent returns a final response to the user with no follow-up.
//
// * ASK_USER – The agent asks the user a question.
//
// * REPROMPT – The agent prompts the user again for the same information.
Type *string `locationName:"type" type:"string" enum:"Type"`
// contains filtered or unexported fields
}
Contains the result or output of an action group or knowledge base, or the response to the user.
func (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 (s *Observation) SetActionGroupInvocationOutput(v *ActionGroupInvocationOutput_) *Observation
SetActionGroupInvocationOutput sets the ActionGroupInvocationOutput field's value.
func (s *Observation) SetFinalResponse(v *FinalResponse) *Observation
SetFinalResponse sets the FinalResponse field's value.
func (s *Observation) SetKnowledgeBaseLookupOutput(v *KnowledgeBaseLookupOutput_) *Observation
SetKnowledgeBaseLookupOutput sets the KnowledgeBaseLookupOutput field's value.
func (s *Observation) SetRepromptResponse(v *RepromptResponse) *Observation
SetRepromptResponse sets the RepromptResponse field's value.
func (s *Observation) SetTraceId(v string) *Observation
SetTraceId sets the TraceId field's value.
func (s *Observation) SetType(v string) *Observation
SetType sets the Type field's value.
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 struct {
// Contains information pertaining to the action group or knowledge base that
// is being invoked.
//
// InvocationInput is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by OrchestrationTrace's
// String and GoString methods.
InvocationInput *InvocationInput_ `locationName:"invocationInput" type:"structure" sensitive:"true"`
// The input for the orchestration step.
//
// * The type is ORCHESTRATION.
//
// * The text contains the prompt.
//
// * The inferenceConfiguration, parserMode, and overrideLambda values are
// set in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html)
// object that was set when the agent was created or updated.
//
// ModelInvocationInput is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by OrchestrationTrace's
// String and GoString methods.
ModelInvocationInput *ModelInvocationInput_ `locationName:"modelInvocationInput" type:"structure" sensitive:"true"`
// Details about the observation (the output of the action group Lambda or knowledge
// base) made by the agent.
//
// Observation is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by OrchestrationTrace's
// String and GoString methods.
Observation *Observation `locationName:"observation" type:"structure" sensitive:"true"`
// Details about the reasoning, based on the input, that the agent uses to justify
// carrying out an action group or getting information from a knowledge base.
//
// Rationale is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by OrchestrationTrace's
// String and GoString methods.
Rationale *Rationale `locationName:"rationale" type:"structure" sensitive:"true"`
// contains filtered or unexported fields
}
Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
func (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 (s *OrchestrationTrace) SetInvocationInput(v *InvocationInput_) *OrchestrationTrace
SetInvocationInput sets the InvocationInput field's value.
func (s *OrchestrationTrace) SetModelInvocationInput(v *ModelInvocationInput_) *OrchestrationTrace
SetModelInvocationInput sets the ModelInvocationInput field's value.
func (s *OrchestrationTrace) SetObservation(v *Observation) *OrchestrationTrace
SetObservation sets the Observation field's value.
func (s *OrchestrationTrace) SetRationale(v *Rationale) *OrchestrationTrace
SetRationale sets the Rationale field's value.
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 struct {
// The name of the parameter.
Name *string `locationName:"name" type:"string"`
// The type of the parameter.
Type *string `locationName:"type" type:"string"`
// The value of the parameter.
Value *string `locationName:"value" type:"string"`
// contains filtered or unexported fields
}
A parameter for the API request or function.
func (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 (s *Parameter) SetName(v string) *Parameter
SetName sets the Name field's value.
func (s *Parameter) SetType(v string) *Parameter
SetType sets the Type field's value.
func (s *Parameter) SetValue(v string) *Parameter
SetValue sets the Value field's value.
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 struct {
// Contains citations for a part of an agent response.
Attribution *Attribution `locationName:"attribution" type:"structure"`
// A part of the agent response in bytes.
//
// Bytes is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by PayloadPart's
// String and GoString methods.
//
// Bytes is automatically base64 encoded/decoded by the SDK.
Bytes []byte `locationName:"bytes" type:"blob" sensitive:"true"`
// contains filtered or unexported fields
}
Contains a part of an agent response and citations for it.
func (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 (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 (s *PayloadPart) SetAttribution(v *Attribution) *PayloadPart
SetAttribution sets the Attribution field's value.
func (s *PayloadPart) SetBytes(v []byte) *PayloadPart
SetBytes sets the Bytes field's value.
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 (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_ struct {
// Details about the response from the Lambda parsing of the output of the post-processing
// step.
//
// ParsedResponse is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by PostProcessingModelInvocationOutput_'s
// String and GoString methods.
ParsedResponse *PostProcessingParsedResponse `locationName:"parsedResponse" type:"structure" sensitive:"true"`
// The unique identifier of the trace.
TraceId *string `locationName:"traceId" min:"2" type:"string"`
// contains filtered or unexported fields
}
The foundation model output from the post-processing step.
func (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 (s *PostProcessingModelInvocationOutput_) SetParsedResponse(v *PostProcessingParsedResponse) *PostProcessingModelInvocationOutput_
SetParsedResponse sets the ParsedResponse field's value.
func (s *PostProcessingModelInvocationOutput_) SetTraceId(v string) *PostProcessingModelInvocationOutput_
SetTraceId sets the TraceId field's value.
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 struct {
// The text returned by the parser.
//
// Text is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by PostProcessingParsedResponse's
// String and GoString methods.
Text *string `locationName:"text" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
Details about the response from the Lambda parsing of the output from the post-processing step.
func (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 (s *PostProcessingParsedResponse) SetText(v string) *PostProcessingParsedResponse
SetText sets the Text field's value.
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 struct {
// The input for the post-processing step.
//
// * The type is POST_PROCESSING.
//
// * The text contains the prompt.
//
// * The inferenceConfiguration, parserMode, and overrideLambda values are
// set in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html)
// object that was set when the agent was created or updated.
//
// ModelInvocationInput is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by PostProcessingTrace's
// String and GoString methods.
ModelInvocationInput *ModelInvocationInput_ `locationName:"modelInvocationInput" type:"structure" sensitive:"true"`
// The foundation model output from the post-processing step.
//
// ModelInvocationOutput is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by PostProcessingTrace's
// String and GoString methods.
ModelInvocationOutput *PostProcessingModelInvocationOutput_ `locationName:"modelInvocationOutput" type:"structure" sensitive:"true"`
// contains filtered or unexported fields
}
Details about the post-processing step, in which the agent shapes the response.
func (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 (s *PostProcessingTrace) SetModelInvocationInput(v *ModelInvocationInput_) *PostProcessingTrace
SetModelInvocationInput sets the ModelInvocationInput field's value.
func (s *PostProcessingTrace) SetModelInvocationOutput(v *PostProcessingModelInvocationOutput_) *PostProcessingTrace
SetModelInvocationOutput sets the ModelInvocationOutput field's value.
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_ struct {
// Details about the response from the Lambda parsing of the output of the pre-processing
// step.
//
// ParsedResponse is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by PreProcessingModelInvocationOutput_'s
// String and GoString methods.
ParsedResponse *PreProcessingParsedResponse `locationName:"parsedResponse" type:"structure" sensitive:"true"`
// The unique identifier of the trace.
TraceId *string `locationName:"traceId" min:"2" type:"string"`
// contains filtered or unexported fields
}
The foundation model output from the pre-processing step.
func (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 (s *PreProcessingModelInvocationOutput_) SetParsedResponse(v *PreProcessingParsedResponse) *PreProcessingModelInvocationOutput_
SetParsedResponse sets the ParsedResponse field's value.
func (s *PreProcessingModelInvocationOutput_) SetTraceId(v string) *PreProcessingModelInvocationOutput_
SetTraceId sets the TraceId field's value.
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 struct {
// Whether the user input is valid or not. If false, the agent doesn't proceed
// to orchestration.
IsValid *bool `locationName:"isValid" type:"boolean"`
// The text returned by the parsing of the pre-processing step, explaining the
// steps that the agent plans to take in orchestration, if the user input is
// valid.
//
// Rationale is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by PreProcessingParsedResponse's
// String and GoString methods.
Rationale *string `locationName:"rationale" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
Details about the response from the Lambda parsing of the output from the pre-processing step.
func (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 (s *PreProcessingParsedResponse) SetIsValid(v bool) *PreProcessingParsedResponse
SetIsValid sets the IsValid field's value.
func (s *PreProcessingParsedResponse) SetRationale(v string) *PreProcessingParsedResponse
SetRationale sets the Rationale field's value.
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 struct {
// The input for the pre-processing step.
//
// * The type is PRE_PROCESSING.
//
// * The text contains the prompt.
//
// * The inferenceConfiguration, parserMode, and overrideLambda values are
// set in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html)
// object that was set when the agent was created or updated.
//
// ModelInvocationInput is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by PreProcessingTrace's
// String and GoString methods.
ModelInvocationInput *ModelInvocationInput_ `locationName:"modelInvocationInput" type:"structure" sensitive:"true"`
// The foundation model output from the pre-processing step.
//
// ModelInvocationOutput is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by PreProcessingTrace's
// String and GoString methods.
ModelInvocationOutput *PreProcessingModelInvocationOutput_ `locationName:"modelInvocationOutput" type:"structure" sensitive:"true"`
// contains filtered or unexported fields
}
Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
func (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 (s *PreProcessingTrace) SetModelInvocationInput(v *ModelInvocationInput_) *PreProcessingTrace
SetModelInvocationInput sets the ModelInvocationInput field's value.
func (s *PreProcessingTrace) SetModelInvocationOutput(v *PreProcessingModelInvocationOutput_) *PreProcessingTrace
SetModelInvocationOutput sets the ModelInvocationOutput field's value.
func (s PreProcessingTrace) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type PromptTemplate struct {
// The template for the prompt that's sent to the model for response generation.
// You can include prompt placeholders, which become replaced before the prompt
// is sent to the model to provide instructions and context to the model. In
// addition, you can include XML tags to delineate meaningful sections of the
// prompt template.
//
// For more information, see the following resources:
//
// * Knowledge base prompt templates (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt)
//
// * Use XML tags with Anthropic Claude models (https://docs.anthropic.com/claude/docs/use-xml-tags)
//
// TextPromptTemplate is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by PromptTemplate's
// String and GoString methods.
TextPromptTemplate *string `locationName:"textPromptTemplate" min:"1" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt).
This data type is used in the following API operations:
func (s PromptTemplate) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PromptTemplate) SetTextPromptTemplate(v string) *PromptTemplate
SetTextPromptTemplate sets the TextPromptTemplate field's value.
func (s PromptTemplate) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PromptTemplate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PropertyParameters struct {
// A list of parameters in the request body.
Properties []*Parameter `locationName:"properties" type:"list"`
// contains filtered or unexported fields
}
Contains the parameters in the request body.
func (s PropertyParameters) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PropertyParameters) SetProperties(v []*Parameter) *PropertyParameters
SetProperties sets the Properties field's value.
func (s PropertyParameters) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Rationale struct {
// The reasoning or thought process of the agent, based on the input.
//
// Text is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Rationale's
// String and GoString methods.
Text *string `locationName:"text" type:"string" sensitive:"true"`
// The unique identifier of the trace step.
TraceId *string `locationName:"traceId" min:"2" type:"string"`
// contains filtered or unexported fields
}
Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
func (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 (s *Rationale) SetText(v string) *Rationale
SetText sets the Text field's value.
func (s *Rationale) SetTraceId(v string) *Rationale
SetTraceId sets the TraceId field's value.
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 struct {
// Specifies what output is prompting the agent to reprompt the input.
//
// Source is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by RepromptResponse's
// String and GoString methods.
Source *string `locationName:"source" type:"string" enum:"Source" sensitive:"true"`
// The text reprompting the input.
Text *string `locationName:"text" type:"string"`
// contains filtered or unexported fields
}
Contains details about the agent's response to reprompt the input.
func (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 (s *RepromptResponse) SetSource(v string) *RepromptResponse
SetSource sets the Source field's value.
func (s *RepromptResponse) SetText(v string) *RepromptResponse
SetText sets the Text field's value.
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 struct {
// The content in the request body.
Content map[string][]*Parameter `locationName:"content" type:"map"`
// contains filtered or unexported fields
}
The parameters in the API request body.
func (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 (s *RequestBody) SetContent(v map[string][]*Parameter) *RequestBody
SetContent sets the Content field's value.
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 struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
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 (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 (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 (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 interface {
eventstreamapi.Marshaler
eventstreamapi.Unmarshaler
// contains filtered or unexported methods
}
ResponseStreamEvent groups together all EventStream events writes for ResponseStream.
These events are:
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:
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 (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 (e *ResponseStreamUnknownEvent) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the ResponseStream value. This method is only used internally within the SDK's EventStream handling.
type RetrievalFilter struct {
// Knowledge base data sources whose metadata attributes fulfill all the filter
// conditions inside this list are returned.
AndAll []*RetrievalFilter `locationName:"andAll" min:"2" type:"list"`
// Knowledge base data sources whose metadata attributes fulfill at least one
// of the filter conditions inside this list are returned.
OrAll []*RetrievalFilter `locationName:"orAll" min:"2" type:"list"`
// contains filtered or unexported fields
}
Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
This data type is used in the following API operations:
Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) – in the filter field
RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) – in the filter field
func (s RetrievalFilter) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RetrievalFilter) SetAndAll(v []*RetrievalFilter) *RetrievalFilter
SetAndAll sets the AndAll field's value.
func (s *RetrievalFilter) SetOrAll(v []*RetrievalFilter) *RetrievalFilter
SetOrAll sets the OrAll field's value.
func (s RetrievalFilter) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RetrievalFilter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RetrievalResultContent struct {
// The cited text from the data source.
//
// Text is a required field
Text *string `locationName:"text" type:"string" required:"true"`
// contains filtered or unexported fields
}
Contains the cited text from the data source.
This data type is used in the following API operations:
Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) – in the content field
RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the content field
InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the content field
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 (s *RetrievalResultContent) SetText(v string) *RetrievalResultContent
SetText sets the Text field's value.
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 struct {
// Contains the S3 location of the data source.
S3Location *RetrievalResultS3Location `locationName:"s3Location" type:"structure"`
// The type of the location of the data source.
//
// Type is a required field
Type *string `locationName:"type" type:"string" required:"true" enum:"RetrievalResultLocationType"`
// contains filtered or unexported fields
}
Contains information about the location of the data source.
This data type is used in the following API operations:
Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) – in the location field
RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the location field
InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the locatino field
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 (s *RetrievalResultLocation) SetS3Location(v *RetrievalResultS3Location) *RetrievalResultLocation
SetS3Location sets the S3Location field's value.
func (s *RetrievalResultLocation) SetType(v string) *RetrievalResultLocation
SetType sets the Type field's value.
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 struct {
// The S3 URI of the data source.
Uri *string `locationName:"uri" type:"string"`
// contains filtered or unexported fields
}
Contains the S3 location of the data source.
This data type is used in the following API operations:
Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) – in the s3Location field
RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the s3Location field
InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the s3Location field
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 (s *RetrievalResultS3Location) SetUri(v string) *RetrievalResultS3Location
SetUri sets the Uri field's value.
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 struct {
// The configuration used with the external source wrapper object in the retrieveAndGenerate
// function.
ExternalSourcesConfiguration *ExternalSourcesRetrieveAndGenerateConfiguration `locationName:"externalSourcesConfiguration" type:"structure"`
// Contains details about the resource being queried.
KnowledgeBaseConfiguration *KnowledgeBaseRetrieveAndGenerateConfiguration `locationName:"knowledgeBaseConfiguration" type:"structure"`
// The type of resource that is queried by the request.
//
// Type is a required field
Type *string `locationName:"type" type:"string" required:"true" enum:"RetrieveAndGenerateType"`
// contains filtered or unexported fields
}
Contains details about the resource being queried.
This data type is used in the following API operations:
func (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 (s *RetrieveAndGenerateConfiguration) SetExternalSourcesConfiguration(v *ExternalSourcesRetrieveAndGenerateConfiguration) *RetrieveAndGenerateConfiguration
SetExternalSourcesConfiguration sets the ExternalSourcesConfiguration field's value.
func (s *RetrieveAndGenerateConfiguration) SetKnowledgeBaseConfiguration(v *KnowledgeBaseRetrieveAndGenerateConfiguration) *RetrieveAndGenerateConfiguration
SetKnowledgeBaseConfiguration sets the KnowledgeBaseConfiguration field's value.
func (s *RetrieveAndGenerateConfiguration) SetType(v string) *RetrieveAndGenerateConfiguration
SetType sets the Type field's value.
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 (s *RetrieveAndGenerateConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RetrieveAndGenerateInput struct {
// Contains the query to be made to the knowledge base.
//
// Input is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by RetrieveAndGenerateInput's
// String and GoString methods.
//
// Input is a required field
Input *RetrieveAndGenerateInput_ `locationName:"input" type:"structure" required:"true" sensitive:"true"`
// Contains configurations for the knowledge base query and retrieval process.
// For more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
RetrieveAndGenerateConfiguration *RetrieveAndGenerateConfiguration `locationName:"retrieveAndGenerateConfiguration" type:"structure"`
// Contains details about the session with the knowledge base.
SessionConfiguration *RetrieveAndGenerateSessionConfiguration `locationName:"sessionConfiguration" type:"structure"`
// The unique identifier of the session. Reuse the same value to continue the
// same session with the knowledge base.
SessionId *string `locationName:"sessionId" min:"2" type:"string"`
// contains filtered or unexported fields
}
func (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 (s *RetrieveAndGenerateInput) SetInput(v *RetrieveAndGenerateInput_) *RetrieveAndGenerateInput
SetInput sets the Input field's value.
func (s *RetrieveAndGenerateInput) SetRetrieveAndGenerateConfiguration(v *RetrieveAndGenerateConfiguration) *RetrieveAndGenerateInput
SetRetrieveAndGenerateConfiguration sets the RetrieveAndGenerateConfiguration field's value.
func (s *RetrieveAndGenerateInput) SetSessionConfiguration(v *RetrieveAndGenerateSessionConfiguration) *RetrieveAndGenerateInput
SetSessionConfiguration sets the SessionConfiguration field's value.
func (s *RetrieveAndGenerateInput) SetSessionId(v string) *RetrieveAndGenerateInput
SetSessionId sets the SessionId field's value.
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 (s *RetrieveAndGenerateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RetrieveAndGenerateInput_ struct {
// The query made to the knowledge base.
//
// Text is a required field
Text *string `locationName:"text" type:"string" required:"true"`
// contains filtered or unexported fields
}
Contains the query made to the knowledge base.
This data type is used in the following API operations:
func (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 (s *RetrieveAndGenerateInput_) SetText(v string) *RetrieveAndGenerateInput_
SetText sets the Text field's value.
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 (s *RetrieveAndGenerateInput_) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RetrieveAndGenerateOutput struct {
// A list of segments of the generated response that are based on sources in
// the knowledge base, alongside information about the sources.
Citations []*Citation `locationName:"citations" type:"list"`
// Specifies if there is a guardrail intervention in the response.
GuardrailAction *string `locationName:"guardrailAction" type:"string" enum:"GuadrailAction"`
// Contains the response generated from querying the knowledge base.
//
// Output is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by RetrieveAndGenerateOutput's
// String and GoString methods.
//
// Output is a required field
Output *RetrieveAndGenerateOutput_ `locationName:"output" type:"structure" required:"true" sensitive:"true"`
// The unique identifier of the session. Reuse the same value to continue the
// same session with the knowledge base.
//
// SessionId is a required field
SessionId *string `locationName:"sessionId" min:"2" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (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 (s *RetrieveAndGenerateOutput) SetCitations(v []*Citation) *RetrieveAndGenerateOutput
SetCitations sets the Citations field's value.
func (s *RetrieveAndGenerateOutput) SetGuardrailAction(v string) *RetrieveAndGenerateOutput
SetGuardrailAction sets the GuardrailAction field's value.
func (s *RetrieveAndGenerateOutput) SetOutput(v *RetrieveAndGenerateOutput_) *RetrieveAndGenerateOutput
SetOutput sets the Output field's value.
func (s *RetrieveAndGenerateOutput) SetSessionId(v string) *RetrieveAndGenerateOutput
SetSessionId sets the SessionId field's value.
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_ struct {
// The response generated from querying the knowledge base.
//
// Text is a required field
Text *string `locationName:"text" type:"string" required:"true"`
// contains filtered or unexported fields
}
Contains the response generated from querying the knowledge base.
This data type is used in the following API operations:
func (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 (s *RetrieveAndGenerateOutput_) SetText(v string) *RetrieveAndGenerateOutput_
SetText sets the Text field's value.
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 struct {
// The ARN of the KMS key encrypting the session.
//
// KmsKeyArn is a required field
KmsKeyArn *string `locationName:"kmsKeyArn" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Contains configuration about the session with the knowledge base.
This data type is used in the following API operations:
func (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 (s *RetrieveAndGenerateSessionConfiguration) SetKmsKeyArn(v string) *RetrieveAndGenerateSessionConfiguration
SetKmsKeyArn sets the KmsKeyArn field's value.
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 (s *RetrieveAndGenerateSessionConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RetrieveInput struct {
// The unique identifier of the knowledge base to query.
//
// KnowledgeBaseId is a required field
KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
// If there are more results than can fit in the response, the response returns
// a nextToken. Use this token in the nextToken field of another request to
// retrieve the next batch of results.
NextToken *string `locationName:"nextToken" min:"1" type:"string"`
// Contains configurations for the knowledge base query and retrieval process.
// For more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
RetrievalConfiguration *KnowledgeBaseRetrievalConfiguration `locationName:"retrievalConfiguration" type:"structure"`
// Contains the query to send the knowledge base.
//
// RetrievalQuery is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by RetrieveInput's
// String and GoString methods.
//
// RetrievalQuery is a required field
RetrievalQuery *KnowledgeBaseQuery `locationName:"retrievalQuery" type:"structure" required:"true" sensitive:"true"`
// contains filtered or unexported fields
}
func (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 (s *RetrieveInput) SetKnowledgeBaseId(v string) *RetrieveInput
SetKnowledgeBaseId sets the KnowledgeBaseId field's value.
func (s *RetrieveInput) SetNextToken(v string) *RetrieveInput
SetNextToken sets the NextToken field's value.
func (s *RetrieveInput) SetRetrievalConfiguration(v *KnowledgeBaseRetrievalConfiguration) *RetrieveInput
SetRetrievalConfiguration sets the RetrievalConfiguration field's value.
func (s *RetrieveInput) SetRetrievalQuery(v *KnowledgeBaseQuery) *RetrieveInput
SetRetrievalQuery sets the RetrievalQuery field's value.
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 (s *RetrieveInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RetrieveOutput struct {
// If there are more results than can fit in the response, the response returns
// a nextToken. Use this token in the nextToken field of another request to
// retrieve the next batch of results.
NextToken *string `locationName:"nextToken" min:"1" type:"string"`
// A list of results from querying the knowledge base.
//
// RetrievalResults is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by RetrieveOutput's
// String and GoString methods.
//
// RetrievalResults is a required field
RetrievalResults []*KnowledgeBaseRetrievalResult `locationName:"retrievalResults" type:"list" required:"true" sensitive:"true"`
// contains filtered or unexported fields
}
func (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 (s *RetrieveOutput) SetNextToken(v string) *RetrieveOutput
SetNextToken sets the NextToken field's value.
func (s *RetrieveOutput) SetRetrievalResults(v []*KnowledgeBaseRetrievalResult) *RetrieveOutput
SetRetrievalResults sets the RetrievalResults field's value.
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 struct {
// Contains the cited text from the data source.
//
// Content is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by RetrievedReference's
// String and GoString methods.
Content *RetrievalResultContent `locationName:"content" type:"structure" sensitive:"true"`
// Contains information about the location of the data source.
//
// Location is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by RetrievedReference's
// String and GoString methods.
Location *RetrievalResultLocation `locationName:"location" type:"structure" sensitive:"true"`
// contains filtered or unexported fields
}
Contains metadata about a source cited for the generated response.
This data type is used in the following API operations:
RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the retrievedReferences field
InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the retrievedReferences field
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 (s *RetrievedReference) SetContent(v *RetrievalResultContent) *RetrievedReference
SetContent sets the Content field's value.
func (s *RetrievedReference) SetLocation(v *RetrievalResultLocation) *RetrievedReference
SetLocation sets the Location field's value.
func (s RetrievedReference) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ReturnControlPayload struct {
// The identifier of the action group invocation.
InvocationId *string `locationName:"invocationId" type:"string"`
// A list of objects that contain information about the parameters and inputs
// that need to be sent into the API operation or function, based on what the
// agent determines from its session with the user.
InvocationInputs []*InvocationInputMember `locationName:"invocationInputs" min:"1" type:"list"`
// contains filtered or unexported fields
}
Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the following API operations:
func (s ReturnControlPayload) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ReturnControlPayload) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (s *ReturnControlPayload) SetInvocationId(v string) *ReturnControlPayload
SetInvocationId sets the InvocationId field's value.
func (s *ReturnControlPayload) SetInvocationInputs(v []*InvocationInputMember) *ReturnControlPayload
SetInvocationInputs sets the InvocationInputs field's value.
func (s ReturnControlPayload) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ReturnControlPayload) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the ReturnControlPayload value. This method is only used internally within the SDK's EventStream handling.
type S3ObjectDoc struct {
// The file location of the S3 wrapper object.
//
// Uri is a required field
Uri *string `locationName:"uri" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
The unique wrapper object of the document from the S3 location.
func (s S3ObjectDoc) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3ObjectDoc) SetUri(v string) *S3ObjectDoc
SetUri sets the Uri field's value.
func (s S3ObjectDoc) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3ObjectDoc) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ServiceQuotaExceededException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
The number of requests exceeds the service quota. Resubmit your request later.
func (s *ServiceQuotaExceededException) Code() string
Code returns the exception type name.
func (s *ServiceQuotaExceededException) Error() string
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 (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 (s *ServiceQuotaExceededException) Message() string
Message returns the exception's message.
func (s *ServiceQuotaExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceQuotaExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceQuotaExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 (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 struct {
// The identifier of the invocation of an action. This value must match the
// invocationId returned in the InvokeAgent response for the action whose results
// are provided in the returnControlInvocationResults field. For more information,
// see Return control to the agent developer (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html)
// and Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).
InvocationId *string `locationName:"invocationId" type:"string"`
// Contains attributes that persist across a prompt and the values of those
// attributes. These attributes replace the $prompt_session_attributes$ placeholder
// variable in the orchestration prompt template. For more information, see
// Prompt template placeholder variables (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html).
PromptSessionAttributes map[string]*string `locationName:"promptSessionAttributes" type:"map"`
// Contains information about the results from the action group invocation.
// For more information, see Return control to the agent developer (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html)
// and Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).
//
// If you include this field, the inputText field will be ignored.
ReturnControlInvocationResults []*InvocationResultMember `locationName:"returnControlInvocationResults" min:"1" type:"list"`
// Contains attributes that persist across a session and the values of those
// attributes.
SessionAttributes map[string]*string `locationName:"sessionAttributes" type:"map"`
// contains filtered or unexported fields
}
Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html) for an action group or pass them when making an InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).
func (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 (s *SessionState) SetInvocationId(v string) *SessionState
SetInvocationId sets the InvocationId field's value.
func (s *SessionState) SetPromptSessionAttributes(v map[string]*string) *SessionState
SetPromptSessionAttributes sets the PromptSessionAttributes field's value.
func (s *SessionState) SetReturnControlInvocationResults(v []*InvocationResultMember) *SessionState
SetReturnControlInvocationResults sets the ReturnControlInvocationResults field's value.
func (s *SessionState) SetSessionAttributes(v map[string]*string) *SessionState
SetSessionAttributes sets the SessionAttributes field's value.
func (s SessionState) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SessionState) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Span struct {
// Where the text with a citation ends in the generated output.
End *int64 `locationName:"end" type:"integer"`
// Where the text with a citation starts in the generated output.
Start *int64 `locationName:"start" type:"integer"`
// contains filtered or unexported fields
}
Contains information about where the text with a citation begins and ends in the generated output.
This data type is used in the following API operations:
RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the span field
InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the span field
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 (s *Span) SetEnd(v int64) *Span
SetEnd sets the End field's value.
func (s *Span) SetStart(v int64) *Span
SetStart sets the Start field's value.
func (s Span) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type TextInferenceConfig struct {
// The maximum number of tokens to generate in the output text. Do not use the
// minimum of 0 or the maximum of 65536. The limit values described here are
// arbitary values, for actual values consult the limits defined by your specific
// model.
MaxTokens *int64 `locationName:"maxTokens" type:"integer"`
// A list of sequences of characters that, if generated, will cause the model
// to stop generating further tokens. Do not use a minimum length of 1 or a
// maximum length of 1000. The limit values described here are arbitary values,
// for actual values consult the limits defined by your specific model.
StopSequences []*string `locationName:"stopSequences" type:"list"`
// Controls the random-ness of text generated by the language model, influencing
// how much the model sticks to the most predictable next words versus exploring
// more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes
// model outputs more deterministic or predictable, while a higher temperature
// (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
Temperature *float64 `locationName:"temperature" type:"float"`
// A probability distribution threshold which controls what the model considers
// for the set of possible next tokens. The model will only consider the top
// p% of the probability distribution when generating the next token.
TopP *float64 `locationName:"topP" type:"float"`
// contains filtered or unexported fields
}
Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.
The valid range of maxTokens depends on the accepted values for your chosen model's inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models. (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html)
func (s TextInferenceConfig) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TextInferenceConfig) SetMaxTokens(v int64) *TextInferenceConfig
SetMaxTokens sets the MaxTokens field's value.
func (s *TextInferenceConfig) SetStopSequences(v []*string) *TextInferenceConfig
SetStopSequences sets the StopSequences field's value.
func (s *TextInferenceConfig) SetTemperature(v float64) *TextInferenceConfig
SetTemperature sets the Temperature field's value.
func (s *TextInferenceConfig) SetTopP(v float64) *TextInferenceConfig
SetTopP sets the TopP field's value.
func (s TextInferenceConfig) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type TextResponsePart struct {
// Contains information about where the text with a citation begins and ends
// in the generated output.
Span *Span `locationName:"span" type:"structure"`
// The part of the generated text that contains a citation.
Text *string `locationName:"text" type:"string"`
// contains filtered or unexported fields
}
Contains the part of the generated text that contains a citation, alongside where it begins and ends.
This data type is used in the following API operations:
RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the textResponsePart field
InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the textResponsePart field
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 (s *TextResponsePart) SetSpan(v *Span) *TextResponsePart
SetSpan sets the Span field's value.
func (s *TextResponsePart) SetText(v string) *TextResponsePart
SetText sets the Text field's value.
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 struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
The number of requests exceeds the limit. Resubmit your request later.
func (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
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 (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 (s *ThrottlingException) Message() string
Message returns the exception's message.
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 (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 struct {
// Contains information about the failure of the interaction.
//
// FailureTrace is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Trace's
// String and GoString methods.
FailureTrace *FailureTrace `locationName:"failureTrace" type:"structure" sensitive:"true"`
// Details about the orchestration step, in which the agent determines the order
// in which actions are executed and which knowledge bases are retrieved.
//
// OrchestrationTrace is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Trace's
// String and GoString methods.
OrchestrationTrace *OrchestrationTrace `locationName:"orchestrationTrace" type:"structure" sensitive:"true"`
// Details about the post-processing step, in which the agent shapes the response..
//
// PostProcessingTrace is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Trace's
// String and GoString methods.
PostProcessingTrace *PostProcessingTrace `locationName:"postProcessingTrace" type:"structure" sensitive:"true"`
// Details about the pre-processing step, in which the agent contextualizes
// and categorizes user inputs.
//
// PreProcessingTrace is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Trace's
// String and GoString methods.
PreProcessingTrace *PreProcessingTrace `locationName:"preProcessingTrace" type:"structure" sensitive:"true"`
// contains filtered or unexported fields
}
Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement).
func (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 (s *Trace) SetFailureTrace(v *FailureTrace) *Trace
SetFailureTrace sets the FailureTrace field's value.
func (s *Trace) SetOrchestrationTrace(v *OrchestrationTrace) *Trace
SetOrchestrationTrace sets the OrchestrationTrace field's value.
func (s *Trace) SetPostProcessingTrace(v *PostProcessingTrace) *Trace
SetPostProcessingTrace sets the PostProcessingTrace field's value.
func (s *Trace) SetPreProcessingTrace(v *PreProcessingTrace) *Trace
SetPreProcessingTrace sets the PreProcessingTrace field's value.
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 struct {
// The unique identifier of the alias of the agent.
AgentAliasId *string `locationName:"agentAliasId" type:"string"`
// The unique identifier of the agent.
AgentId *string `locationName:"agentId" type:"string"`
// The version of the agent.
AgentVersion *string `locationName:"agentVersion" min:"1" type:"string"`
// The unique identifier of the session with the agent.
SessionId *string `locationName:"sessionId" min:"2" type:"string"`
// Contains one part of the agent's reasoning process and results from calling
// API actions and querying knowledge bases. You can use the trace to understand
// how the agent arrived at the response it provided the customer. For more
// information, see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement).
//
// Trace is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by TracePart's
// String and GoString methods.
Trace *Trace `locationName:"trace" type:"structure" sensitive:"true"`
// contains filtered or unexported fields
}
Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement).
func (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 (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 (s *TracePart) SetAgentAliasId(v string) *TracePart
SetAgentAliasId sets the AgentAliasId field's value.
func (s *TracePart) SetAgentId(v string) *TracePart
SetAgentId sets the AgentId field's value.
func (s *TracePart) SetAgentVersion(v string) *TracePart
SetAgentVersion sets the AgentVersion field's value.
func (s *TracePart) SetSessionId(v string) *TracePart
SetSessionId sets the SessionId field's value.
func (s *TracePart) SetTrace(v *Trace) *TracePart
SetTrace sets the Trace field's value.
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 (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 struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// contains filtered or unexported fields
}
Input validation failed. Check your request parameters and retry the request.
func (s *ValidationException) Code() string
Code returns the exception type name.
func (s *ValidationException) Error() string
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 (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 (s *ValidationException) Message() string
Message returns the exception's message.
func (s *ValidationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ValidationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ValidationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 (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.