File: //opt/go/pkg/mod/github.com/aws/
[email protected]/service/bedrockruntime/api.go
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package bedrockruntime
import (
"bytes"
"fmt"
"io"
"sync"
"time"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awserr"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/client"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/private/protocol"
"github.com/aws/aws-sdk-go/private/protocol/eventstream"
"github.com/aws/aws-sdk-go/private/protocol/eventstream/eventstreamapi"
"github.com/aws/aws-sdk-go/private/protocol/rest"
"github.com/aws/aws-sdk-go/private/protocol/restjson"
)
const opApplyGuardrail = "ApplyGuardrail"
// ApplyGuardrailRequest generates a "aws/request.Request" representing the
// client's request for the ApplyGuardrail 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 ApplyGuardrail for more information on using the ApplyGuardrail
// 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 ApplyGuardrailRequest method.
// req, resp := client.ApplyGuardrailRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ApplyGuardrail
func (c *BedrockRuntime) ApplyGuardrailRequest(input *ApplyGuardrailInput) (req *request.Request, output *ApplyGuardrailOutput) {
op := &request.Operation{
Name: opApplyGuardrail,
HTTPMethod: "POST",
HTTPPath: "/guardrail/{guardrailIdentifier}/version/{guardrailVersion}/apply",
}
if input == nil {
input = &ApplyGuardrailInput{}
}
output = &ApplyGuardrailOutput{}
req = c.newRequest(op, input, output)
return
}
// ApplyGuardrail API operation for Amazon Bedrock Runtime.
//
// The action to apply a guardrail.
//
// 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 Amazon Bedrock Runtime's
// API operation ApplyGuardrail for usage and error information.
//
// Returned Error Types:
//
// - AccessDeniedException
// The request is denied because of missing access permissions.
//
// - ResourceNotFoundException
// The specified resource ARN was not found. Check the ARN and try your request
// again.
//
// - ThrottlingException
// Your request was throttled because of service-wide limitations. Resubmit
// your request later or in a different region. You can also purchase Provisioned
// Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html)
// to increase the rate or number of tokens you can process.
//
// - InternalServerException
// An internal server error occurred. Retry your request.
//
// - ValidationException
// Input validation failed. Check your request parameters and retry the request.
//
// - ServiceQuotaExceededException
// Your request exceeds the service quota for your account. You can view your
// quotas at Viewing service quotas (https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html).
// You can resubmit your request later.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ApplyGuardrail
func (c *BedrockRuntime) ApplyGuardrail(input *ApplyGuardrailInput) (*ApplyGuardrailOutput, error) {
req, out := c.ApplyGuardrailRequest(input)
return out, req.Send()
}
// ApplyGuardrailWithContext is the same as ApplyGuardrail with the addition of
// the ability to pass a context and additional request options.
//
// See ApplyGuardrail 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 *BedrockRuntime) ApplyGuardrailWithContext(ctx aws.Context, input *ApplyGuardrailInput, opts ...request.Option) (*ApplyGuardrailOutput, error) {
req, out := c.ApplyGuardrailRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opConverse = "Converse"
// ConverseRequest generates a "aws/request.Request" representing the
// client's request for the Converse 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 Converse for more information on using the Converse
// 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 ConverseRequest method.
// req, resp := client.ConverseRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/Converse
func (c *BedrockRuntime) ConverseRequest(input *ConverseInput) (req *request.Request, output *ConverseOutput) {
op := &request.Operation{
Name: opConverse,
HTTPMethod: "POST",
HTTPPath: "/model/{modelId}/converse",
}
if input == nil {
input = &ConverseInput{}
}
output = &ConverseOutput{}
req = c.newRequest(op, input, output)
return
}
// Converse API operation for Amazon Bedrock Runtime.
//
// Sends messages to the specified Amazon Bedrock model. Converse provides a
// consistent interface that works with all models that support messages. This
// allows you to write code once and use it with different models. If a model
// has unique inference parameters, you can also pass those unique parameters
// to the model.
//
// Amazon Bedrock doesn't store any text, images, or documents that you provide
// as content. The data is only used to generate the response.
//
// For information about the Converse API, see Use the Converse API in the Amazon
// Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse
// API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool
// use (Function calling) in the Amazon Bedrock User Guide
//
// For example code, see Converse API examples in the Amazon Bedrock User Guide.
//
// This operation requires permission for the bedrock:InvokeModel action.
//
// 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 Amazon Bedrock Runtime's
// API operation Converse for usage and error information.
//
// Returned Error Types:
//
// - AccessDeniedException
// The request is denied because of missing access permissions.
//
// - ResourceNotFoundException
// The specified resource ARN was not found. Check the ARN and try your request
// again.
//
// - ThrottlingException
// Your request was throttled because of service-wide limitations. Resubmit
// your request later or in a different region. You can also purchase Provisioned
// Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html)
// to increase the rate or number of tokens you can process.
//
// - ModelTimeoutException
// The request took too long to process. Processing time exceeded the model
// timeout length.
//
// - InternalServerException
// An internal server error occurred. Retry your request.
//
// - ServiceUnavailableException
// The service isn't currently available. Try again later.
//
// - ValidationException
// Input validation failed. Check your request parameters and retry the request.
//
// - ModelNotReadyException
// The model specified in the request is not ready to serve inference requests.
//
// - ModelErrorException
// The request failed due to an error while processing the model.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/Converse
func (c *BedrockRuntime) Converse(input *ConverseInput) (*ConverseOutput, error) {
req, out := c.ConverseRequest(input)
return out, req.Send()
}
// ConverseWithContext is the same as Converse with the addition of
// the ability to pass a context and additional request options.
//
// See Converse 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 *BedrockRuntime) ConverseWithContext(ctx aws.Context, input *ConverseInput, opts ...request.Option) (*ConverseOutput, error) {
req, out := c.ConverseRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opConverseStream = "ConverseStream"
// ConverseStreamRequest generates a "aws/request.Request" representing the
// client's request for the ConverseStream 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 ConverseStream for more information on using the ConverseStream
// 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 ConverseStreamRequest method.
// req, resp := client.ConverseStreamRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseStream
func (c *BedrockRuntime) ConverseStreamRequest(input *ConverseStreamInput) (req *request.Request, output *ConverseStreamOutput) {
op := &request.Operation{
Name: opConverseStream,
HTTPMethod: "POST",
HTTPPath: "/model/{modelId}/converse-stream",
}
if input == nil {
input = &ConverseStreamInput{}
}
output = &ConverseStreamOutput{}
req = c.newRequest(op, input, output)
es := NewConverseStreamEventStream()
output.eventStream = es
req.Handlers.Send.Swap(client.LogHTTPResponseHandler.Name, client.LogHTTPResponseHeaderHandler)
req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, rest.UnmarshalHandler)
req.Handlers.Unmarshal.PushBack(es.runOutputStream)
req.Handlers.Unmarshal.PushBack(es.runOnStreamPartClose)
return
}
// ConverseStream API operation for Amazon Bedrock Runtime.
//
// Sends messages to the specified Amazon Bedrock model and returns the response
// in a stream. ConverseStream provides a consistent API that works with all
// Amazon Bedrock models that support messages. This allows you to write code
// once and use it with different models. Should a model have unique inference
// parameters, you can also pass those unique parameters to the model.
//
// To find out if a model supports streaming, call GetFoundationModel (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html)
// and check the responseStreamingSupported field in the response.
//
// The CLI doesn't support streaming operations in Amazon Bedrock, including
// ConverseStream.
//
// Amazon Bedrock doesn't store any text, images, or documents that you provide
// as content. The data is only used to generate the response.
//
// For information about the Converse API, see Use the Converse API in the Amazon
// Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse
// API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool
// use (Function calling) in the Amazon Bedrock User Guide
//
// For example code, see Conversation streaming example in the Amazon Bedrock
// User Guide.
//
// This operation requires permission for the bedrock:InvokeModelWithResponseStream
// action.
//
// 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 Amazon Bedrock Runtime's
// API operation ConverseStream for usage and error information.
//
// Returned Error Types:
//
// - AccessDeniedException
// The request is denied because of missing access permissions.
//
// - ResourceNotFoundException
// The specified resource ARN was not found. Check the ARN and try your request
// again.
//
// - ThrottlingException
// Your request was throttled because of service-wide limitations. Resubmit
// your request later or in a different region. You can also purchase Provisioned
// Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html)
// to increase the rate or number of tokens you can process.
//
// - ModelTimeoutException
// The request took too long to process. Processing time exceeded the model
// timeout length.
//
// - InternalServerException
// An internal server error occurred. Retry your request.
//
// - ServiceUnavailableException
// The service isn't currently available. Try again later.
//
// - ValidationException
// Input validation failed. Check your request parameters and retry the request.
//
// - ModelNotReadyException
// The model specified in the request is not ready to serve inference requests.
//
// - ModelErrorException
// The request failed due to an error while processing the model.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseStream
func (c *BedrockRuntime) ConverseStream(input *ConverseStreamInput) (*ConverseStreamOutput, error) {
req, out := c.ConverseStreamRequest(input)
return out, req.Send()
}
// ConverseStreamWithContext is the same as ConverseStream with the addition of
// the ability to pass a context and additional request options.
//
// See ConverseStream 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 *BedrockRuntime) ConverseStreamWithContext(ctx aws.Context, input *ConverseStreamInput, opts ...request.Option) (*ConverseStreamOutput, error) {
req, out := c.ConverseStreamRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
var _ awserr.Error
var _ time.Time
// ConverseStreamEventStream provides the event stream handling for the ConverseStream.
//
// For testing and mocking the event stream this type should be initialized via
// the NewConverseStreamEventStream constructor function. Using the functional options
// to pass in nested mock behavior.
type ConverseStreamEventStream struct {
// Reader is the EventStream reader for the ConverseStreamOutput_
// 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 ConverseStreamOutput_Reader
outputReader io.ReadCloser
done chan struct{}
closeOnce sync.Once
err *eventstreamapi.OnceError
}
// NewConverseStreamEventStream initializes an ConverseStreamEventStream.
// This function should only be used for testing and mocking the ConverseStreamEventStream
// stream within your application.
//
// The Reader member must be set before reading events from the stream.
//
// es := NewConverseStreamEventStream(func(o *ConverseStreamEventStream){
// es.Reader = myMockStreamReader
// })
func NewConverseStreamEventStream(opts ...func(*ConverseStreamEventStream)) *ConverseStreamEventStream {
es := &ConverseStreamEventStream{
done: make(chan struct{}),
err: eventstreamapi.NewOnceError(),
}
for _, fn := range opts {
fn(es)
}
return es
}
func (es *ConverseStreamEventStream) runOnStreamPartClose(r *request.Request) {
if es.done == nil {
return
}
go es.waitStreamPartClose()
}
func (es *ConverseStreamEventStream) waitStreamPartClose() {
var outputErrCh <-chan struct{}
if v, ok := es.Reader.(interface{ ErrorSet() <-chan struct{} }); ok {
outputErrCh = v.ErrorSet()
}
var outputClosedCh <-chan struct{}
if v, ok := es.Reader.(interface{ Closed() <-chan struct{} }); ok {
outputClosedCh = v.Closed()
}
select {
case <-es.done:
case <-outputErrCh:
es.err.SetError(es.Reader.Err())
es.Close()
case <-outputClosedCh:
if err := es.Reader.Err(); err != nil {
es.err.SetError(es.Reader.Err())
}
es.Close()
}
}
// Events returns a channel to read events from.
//
// These events are:
//
// - ContentBlockDeltaEvent
// - ContentBlockStartEvent
// - ContentBlockStopEvent
// - MessageStartEvent
// - MessageStopEvent
// - ConverseStreamMetadataEvent
// - ConverseStreamOutput_UnknownEvent
func (es *ConverseStreamEventStream) Events() <-chan ConverseStreamOutput_Event {
return es.Reader.Events()
}
func (es *ConverseStreamEventStream) runOutputStream(r *request.Request) {
var opts []func(*eventstream.Decoder)
if r.Config.Logger != nil && r.Config.LogLevel.Matches(aws.LogDebugWithEventStreamBody) {
opts = append(opts, eventstream.DecodeWithLogger(r.Config.Logger))
}
unmarshalerForEvent := unmarshalerForConverseStreamOutput_Event{
metadata: protocol.ResponseMetadata{
StatusCode: r.HTTPResponse.StatusCode,
RequestID: r.RequestID,
},
}.UnmarshalerForEventName
decoder := eventstream.NewDecoder(r.HTTPResponse.Body, opts...)
eventReader := eventstreamapi.NewEventReader(decoder,
protocol.HandlerPayloadUnmarshal{
Unmarshalers: r.Handlers.UnmarshalStream,
},
unmarshalerForEvent,
)
es.outputReader = r.HTTPResponse.Body
es.Reader = newReadConverseStreamOutput_(eventReader)
}
// 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 *ConverseStreamEventStream) Close() (err error) {
es.closeOnce.Do(es.safeClose)
return es.Err()
}
func (es *ConverseStreamEventStream) safeClose() {
if es.done != nil {
close(es.done)
}
es.Reader.Close()
if es.outputReader != nil {
es.outputReader.Close()
}
}
// 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 *ConverseStreamEventStream) Err() error {
if err := es.err.Err(); err != nil {
return err
}
if err := es.Reader.Err(); err != nil {
return err
}
return nil
}
const opInvokeModel = "InvokeModel"
// InvokeModelRequest generates a "aws/request.Request" representing the
// client's request for the InvokeModel 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 InvokeModel for more information on using the InvokeModel
// 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 InvokeModelRequest method.
// req, resp := client.InvokeModelRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/InvokeModel
func (c *BedrockRuntime) InvokeModelRequest(input *InvokeModelInput) (req *request.Request, output *InvokeModelOutput) {
op := &request.Operation{
Name: opInvokeModel,
HTTPMethod: "POST",
HTTPPath: "/model/{modelId}/invoke",
}
if input == nil {
input = &InvokeModelInput{}
}
output = &InvokeModelOutput{}
req = c.newRequest(op, input, output)
return
}
// InvokeModel API operation for Amazon Bedrock Runtime.
//
// Invokes the specified Amazon Bedrock model to run inference using the prompt
// and inference parameters provided in the request body. You use model inference
// to generate text, images, and embeddings.
//
// For example code, see Invoke model code examples in the Amazon Bedrock User
// Guide.
//
// This operation requires permission for the bedrock:InvokeModel action.
//
// 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 Amazon Bedrock Runtime's
// API operation InvokeModel for usage and error information.
//
// Returned Error Types:
//
// - AccessDeniedException
// The request is denied because of missing access permissions.
//
// - ResourceNotFoundException
// The specified resource ARN was not found. Check the ARN and try your request
// again.
//
// - ThrottlingException
// Your request was throttled because of service-wide limitations. Resubmit
// your request later or in a different region. You can also purchase Provisioned
// Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html)
// to increase the rate or number of tokens you can process.
//
// - ModelTimeoutException
// The request took too long to process. Processing time exceeded the model
// timeout length.
//
// - InternalServerException
// An internal server error occurred. Retry your request.
//
// - ServiceUnavailableException
// The service isn't currently available. Try again later.
//
// - ValidationException
// Input validation failed. Check your request parameters and retry the request.
//
// - ModelNotReadyException
// The model specified in the request is not ready to serve inference requests.
//
// - ServiceQuotaExceededException
// Your request exceeds the service quota for your account. You can view your
// quotas at Viewing service quotas (https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html).
// You can resubmit your request later.
//
// - ModelErrorException
// The request failed due to an error while processing the model.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/InvokeModel
func (c *BedrockRuntime) InvokeModel(input *InvokeModelInput) (*InvokeModelOutput, error) {
req, out := c.InvokeModelRequest(input)
return out, req.Send()
}
// InvokeModelWithContext is the same as InvokeModel with the addition of
// the ability to pass a context and additional request options.
//
// See InvokeModel 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 *BedrockRuntime) InvokeModelWithContext(ctx aws.Context, input *InvokeModelInput, opts ...request.Option) (*InvokeModelOutput, error) {
req, out := c.InvokeModelRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opInvokeModelWithResponseStream = "InvokeModelWithResponseStream"
// InvokeModelWithResponseStreamRequest generates a "aws/request.Request" representing the
// client's request for the InvokeModelWithResponseStream 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 InvokeModelWithResponseStream for more information on using the InvokeModelWithResponseStream
// 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 InvokeModelWithResponseStreamRequest method.
// req, resp := client.InvokeModelWithResponseStreamRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/InvokeModelWithResponseStream
func (c *BedrockRuntime) InvokeModelWithResponseStreamRequest(input *InvokeModelWithResponseStreamInput) (req *request.Request, output *InvokeModelWithResponseStreamOutput) {
op := &request.Operation{
Name: opInvokeModelWithResponseStream,
HTTPMethod: "POST",
HTTPPath: "/model/{modelId}/invoke-with-response-stream",
}
if input == nil {
input = &InvokeModelWithResponseStreamInput{}
}
output = &InvokeModelWithResponseStreamOutput{}
req = c.newRequest(op, input, output)
es := NewInvokeModelWithResponseStreamEventStream()
output.eventStream = es
req.Handlers.Send.Swap(client.LogHTTPResponseHandler.Name, client.LogHTTPResponseHeaderHandler)
req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, rest.UnmarshalHandler)
req.Handlers.Unmarshal.PushBack(es.runOutputStream)
req.Handlers.Unmarshal.PushBack(es.runOnStreamPartClose)
return
}
// InvokeModelWithResponseStream API operation for Amazon Bedrock Runtime.
//
// Invoke the specified Amazon Bedrock model to run inference using the prompt
// and inference parameters provided in the request body. The response is returned
// in a stream.
//
// To see if a model supports streaming, call GetFoundationModel (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html)
// and check the responseStreamingSupported field in the response.
//
// The CLI doesn't support streaming operations in Amazon Bedrock, including
// InvokeModelWithResponseStream.
//
// For example code, see Invoke model with streaming code example in the Amazon
// Bedrock User Guide.
//
// This operation requires permissions to perform the bedrock:InvokeModelWithResponseStream
// action.
//
// 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 Amazon Bedrock Runtime's
// API operation InvokeModelWithResponseStream for usage and error information.
//
// Returned Error Types:
//
// - AccessDeniedException
// The request is denied because of missing access permissions.
//
// - ResourceNotFoundException
// The specified resource ARN was not found. Check the ARN and try your request
// again.
//
// - ThrottlingException
// Your request was throttled because of service-wide limitations. Resubmit
// your request later or in a different region. You can also purchase Provisioned
// Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html)
// to increase the rate or number of tokens you can process.
//
// - ModelTimeoutException
// The request took too long to process. Processing time exceeded the model
// timeout length.
//
// - InternalServerException
// An internal server error occurred. Retry your request.
//
// - ServiceUnavailableException
// The service isn't currently available. Try again later.
//
// - ModelStreamErrorException
// An error occurred while streaming the response. Retry your request.
//
// - ValidationException
// Input validation failed. Check your request parameters and retry the request.
//
// - ModelNotReadyException
// The model specified in the request is not ready to serve inference requests.
//
// - ServiceQuotaExceededException
// Your request exceeds the service quota for your account. You can view your
// quotas at Viewing service quotas (https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html).
// You can resubmit your request later.
//
// - ModelErrorException
// The request failed due to an error while processing the model.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/InvokeModelWithResponseStream
func (c *BedrockRuntime) InvokeModelWithResponseStream(input *InvokeModelWithResponseStreamInput) (*InvokeModelWithResponseStreamOutput, error) {
req, out := c.InvokeModelWithResponseStreamRequest(input)
return out, req.Send()
}
// InvokeModelWithResponseStreamWithContext is the same as InvokeModelWithResponseStream with the addition of
// the ability to pass a context and additional request options.
//
// See InvokeModelWithResponseStream 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 *BedrockRuntime) InvokeModelWithResponseStreamWithContext(ctx aws.Context, input *InvokeModelWithResponseStreamInput, opts ...request.Option) (*InvokeModelWithResponseStreamOutput, error) {
req, out := c.InvokeModelWithResponseStreamRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
var _ awserr.Error
var _ time.Time
// InvokeModelWithResponseStreamEventStream provides the event stream handling for the InvokeModelWithResponseStream.
//
// For testing and mocking the event stream this type should be initialized via
// the NewInvokeModelWithResponseStreamEventStream constructor function. Using the functional options
// to pass in nested mock behavior.
type InvokeModelWithResponseStreamEventStream 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
outputReader io.ReadCloser
done chan struct{}
closeOnce sync.Once
err *eventstreamapi.OnceError
}
// NewInvokeModelWithResponseStreamEventStream initializes an InvokeModelWithResponseStreamEventStream.
// This function should only be used for testing and mocking the InvokeModelWithResponseStreamEventStream
// stream within your application.
//
// The Reader member must be set before reading events from the stream.
//
// es := NewInvokeModelWithResponseStreamEventStream(func(o *InvokeModelWithResponseStreamEventStream){
// es.Reader = myMockStreamReader
// })
func NewInvokeModelWithResponseStreamEventStream(opts ...func(*InvokeModelWithResponseStreamEventStream)) *InvokeModelWithResponseStreamEventStream {
es := &InvokeModelWithResponseStreamEventStream{
done: make(chan struct{}),
err: eventstreamapi.NewOnceError(),
}
for _, fn := range opts {
fn(es)
}
return es
}
func (es *InvokeModelWithResponseStreamEventStream) runOnStreamPartClose(r *request.Request) {
if es.done == nil {
return
}
go es.waitStreamPartClose()
}
func (es *InvokeModelWithResponseStreamEventStream) waitStreamPartClose() {
var outputErrCh <-chan struct{}
if v, ok := es.Reader.(interface{ ErrorSet() <-chan struct{} }); ok {
outputErrCh = v.ErrorSet()
}
var outputClosedCh <-chan struct{}
if v, ok := es.Reader.(interface{ Closed() <-chan struct{} }); ok {
outputClosedCh = v.Closed()
}
select {
case <-es.done:
case <-outputErrCh:
es.err.SetError(es.Reader.Err())
es.Close()
case <-outputClosedCh:
if err := es.Reader.Err(); err != nil {
es.err.SetError(es.Reader.Err())
}
es.Close()
}
}
// Events returns a channel to read events from.
//
// These events are:
//
// - PayloadPart
// - ResponseStreamUnknownEvent
func (es *InvokeModelWithResponseStreamEventStream) Events() <-chan ResponseStreamEvent {
return es.Reader.Events()
}
func (es *InvokeModelWithResponseStreamEventStream) runOutputStream(r *request.Request) {
var opts []func(*eventstream.Decoder)
if r.Config.Logger != nil && r.Config.LogLevel.Matches(aws.LogDebugWithEventStreamBody) {
opts = append(opts, eventstream.DecodeWithLogger(r.Config.Logger))
}
unmarshalerForEvent := unmarshalerForResponseStreamEvent{
metadata: protocol.ResponseMetadata{
StatusCode: r.HTTPResponse.StatusCode,
RequestID: r.RequestID,
},
}.UnmarshalerForEventName
decoder := eventstream.NewDecoder(r.HTTPResponse.Body, opts...)
eventReader := eventstreamapi.NewEventReader(decoder,
protocol.HandlerPayloadUnmarshal{
Unmarshalers: r.Handlers.UnmarshalStream,
},
unmarshalerForEvent,
)
es.outputReader = r.HTTPResponse.Body
es.Reader = newReadResponseStream(eventReader)
}
// 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 *InvokeModelWithResponseStreamEventStream) Close() (err error) {
es.closeOnce.Do(es.safeClose)
return es.Err()
}
func (es *InvokeModelWithResponseStreamEventStream) safeClose() {
if es.done != nil {
close(es.done)
}
es.Reader.Close()
if es.outputReader != nil {
es.outputReader.Close()
}
}
// 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 *InvokeModelWithResponseStreamEventStream) Err() error {
if err := es.err.Err(); err != nil {
return err
}
if err := es.Reader.Err(); err != nil {
return err
}
return nil
}
// The request is denied because of missing access permissions.
type AccessDeniedException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"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) String() string {
return awsutil.Prettify(s)
}
// 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) GoString() string {
return s.String()
}
func newErrorAccessDeniedException(v protocol.ResponseMetadata) error {
return &AccessDeniedException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *AccessDeniedException) Code() string {
return "AccessDeniedException"
}
// Message returns the exception's message.
func (s *AccessDeniedException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) OrigErr() error {
return nil
}
func (s *AccessDeniedException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *AccessDeniedException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) RequestID() string {
return s.RespMetadata.RequestID
}
// The model must request at least one tool (no text is generated). For example,
// {"any" : {}}.
type AnyToolChoice struct {
_ struct{} `type:"structure"`
}
// 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 AnyToolChoice) String() string {
return awsutil.Prettify(s)
}
// 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 AnyToolChoice) GoString() string {
return s.String()
}
type ApplyGuardrailInput struct {
_ struct{} `type:"structure"`
// The content details used in the request to apply the guardrail.
//
// Content is a required field
Content []*GuardrailContentBlock `locationName:"content" type:"list" required:"true"`
// The guardrail identifier used in the request to apply the guardrail.
//
// GuardrailIdentifier is a required field
GuardrailIdentifier *string `location:"uri" locationName:"guardrailIdentifier" type:"string" required:"true"`
// The guardrail version used in the request to apply the guardrail.
//
// GuardrailVersion is a required field
GuardrailVersion *string `location:"uri" locationName:"guardrailVersion" type:"string" required:"true"`
// The source of data used in the request to apply the guardrail.
//
// Source is a required field
Source *string `locationName:"source" type:"string" required:"true" enum:"GuardrailContentSource"`
}
// 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 ApplyGuardrailInput) String() string {
return awsutil.Prettify(s)
}
// 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 ApplyGuardrailInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ApplyGuardrailInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ApplyGuardrailInput"}
if s.Content == nil {
invalidParams.Add(request.NewErrParamRequired("Content"))
}
if s.GuardrailIdentifier == nil {
invalidParams.Add(request.NewErrParamRequired("GuardrailIdentifier"))
}
if s.GuardrailIdentifier != nil && len(*s.GuardrailIdentifier) < 1 {
invalidParams.Add(request.NewErrParamMinLen("GuardrailIdentifier", 1))
}
if s.GuardrailVersion == nil {
invalidParams.Add(request.NewErrParamRequired("GuardrailVersion"))
}
if s.GuardrailVersion != nil && len(*s.GuardrailVersion) < 1 {
invalidParams.Add(request.NewErrParamMinLen("GuardrailVersion", 1))
}
if s.Source == nil {
invalidParams.Add(request.NewErrParamRequired("Source"))
}
if s.Content != nil {
for i, v := range s.Content {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Content", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetContent sets the Content field's value.
func (s *ApplyGuardrailInput) SetContent(v []*GuardrailContentBlock) *ApplyGuardrailInput {
s.Content = v
return s
}
// SetGuardrailIdentifier sets the GuardrailIdentifier field's value.
func (s *ApplyGuardrailInput) SetGuardrailIdentifier(v string) *ApplyGuardrailInput {
s.GuardrailIdentifier = &v
return s
}
// SetGuardrailVersion sets the GuardrailVersion field's value.
func (s *ApplyGuardrailInput) SetGuardrailVersion(v string) *ApplyGuardrailInput {
s.GuardrailVersion = &v
return s
}
// SetSource sets the Source field's value.
func (s *ApplyGuardrailInput) SetSource(v string) *ApplyGuardrailInput {
s.Source = &v
return s
}
type ApplyGuardrailOutput struct {
_ struct{} `type:"structure"`
// The action taken in the response from the guardrail.
//
// Action is a required field
Action *string `locationName:"action" type:"string" required:"true" enum:"GuardrailAction"`
// The assessment details in the response from the guardrail.
//
// Assessments is a required field
Assessments []*GuardrailAssessment `locationName:"assessments" type:"list" required:"true"`
// The output details in the response from the guardrail.
//
// Outputs is a required field
Outputs []*GuardrailOutputContent `locationName:"outputs" type:"list" required:"true"`
// The usage details in the response from the guardrail.
//
// Usage is a required field
Usage *GuardrailUsage `locationName:"usage" type:"structure" required:"true"`
}
// 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 ApplyGuardrailOutput) String() string {
return awsutil.Prettify(s)
}
// 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 ApplyGuardrailOutput) GoString() string {
return s.String()
}
// SetAction sets the Action field's value.
func (s *ApplyGuardrailOutput) SetAction(v string) *ApplyGuardrailOutput {
s.Action = &v
return s
}
// SetAssessments sets the Assessments field's value.
func (s *ApplyGuardrailOutput) SetAssessments(v []*GuardrailAssessment) *ApplyGuardrailOutput {
s.Assessments = v
return s
}
// SetOutputs sets the Outputs field's value.
func (s *ApplyGuardrailOutput) SetOutputs(v []*GuardrailOutputContent) *ApplyGuardrailOutput {
s.Outputs = v
return s
}
// SetUsage sets the Usage field's value.
func (s *ApplyGuardrailOutput) SetUsage(v *GuardrailUsage) *ApplyGuardrailOutput {
s.Usage = v
return s
}
// The Model automatically decides if a tool should be called or whether to
// generate text instead. For example, {"auto" : {}}.
type AutoToolChoice struct {
_ struct{} `type:"structure"`
}
// 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 AutoToolChoice) String() string {
return awsutil.Prettify(s)
}
// 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 AutoToolChoice) GoString() string {
return s.String()
}
// A block of content for a message that you pass to, or receive from, a model
// with the Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html)
// or ConverseStream (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html)
// API operations.
type ContentBlock struct {
_ struct{} `type:"structure"`
// A document to include in the message.
Document *DocumentBlock `locationName:"document" type:"structure"`
// Contains the content to assess with the guardrail. If you don't specify guardContent
// in a call to the Converse API, the guardrail (if passed in the Converse API)
// assesses the entire message.
GuardContent *GuardrailConverseContentBlock `locationName:"guardContent" type:"structure"`
// Image to include in the message.
//
// This field is only supported by Anthropic Claude 3 models.
Image *ImageBlock `locationName:"image" type:"structure"`
// Text to include in the message.
Text *string `locationName:"text" type:"string"`
// The result for a tool request that a model makes.
ToolResult *ToolResultBlock `locationName:"toolResult" type:"structure"`
}
// 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 ContentBlock) String() string {
return awsutil.Prettify(s)
}
// 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 ContentBlock) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ContentBlock) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ContentBlock"}
if s.Document != nil {
if err := s.Document.Validate(); err != nil {
invalidParams.AddNested("Document", err.(request.ErrInvalidParams))
}
}
if s.GuardContent != nil {
if err := s.GuardContent.Validate(); err != nil {
invalidParams.AddNested("GuardContent", err.(request.ErrInvalidParams))
}
}
if s.Image != nil {
if err := s.Image.Validate(); err != nil {
invalidParams.AddNested("Image", err.(request.ErrInvalidParams))
}
}
if s.ToolResult != nil {
if err := s.ToolResult.Validate(); err != nil {
invalidParams.AddNested("ToolResult", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDocument sets the Document field's value.
func (s *ContentBlock) SetDocument(v *DocumentBlock) *ContentBlock {
s.Document = v
return s
}
// SetGuardContent sets the GuardContent field's value.
func (s *ContentBlock) SetGuardContent(v *GuardrailConverseContentBlock) *ContentBlock {
s.GuardContent = v
return s
}
// SetImage sets the Image field's value.
func (s *ContentBlock) SetImage(v *ImageBlock) *ContentBlock {
s.Image = v
return s
}
// SetText sets the Text field's value.
func (s *ContentBlock) SetText(v string) *ContentBlock {
s.Text = &v
return s
}
// SetToolResult sets the ToolResult field's value.
func (s *ContentBlock) SetToolResult(v *ToolResultBlock) *ContentBlock {
s.ToolResult = v
return s
}
// A bock of content in a streaming response.
type ContentBlockDelta struct {
_ struct{} `type:"structure"`
// The content text.
Text *string `locationName:"text" type:"string"`
// Information about a tool that the model is requesting to use.
ToolUse *ToolUseBlockDelta `locationName:"toolUse" type:"structure"`
}
// 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 ContentBlockDelta) String() string {
return awsutil.Prettify(s)
}
// 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 ContentBlockDelta) GoString() string {
return s.String()
}
// SetText sets the Text field's value.
func (s *ContentBlockDelta) SetText(v string) *ContentBlockDelta {
s.Text = &v
return s
}
// SetToolUse sets the ToolUse field's value.
func (s *ContentBlockDelta) SetToolUse(v *ToolUseBlockDelta) *ContentBlockDelta {
s.ToolUse = v
return s
}
// The content block delta event.
type ContentBlockDeltaEvent struct {
_ struct{} `type:"structure"`
// The block index for a content block delta event.
//
// ContentBlockIndex is a required field
ContentBlockIndex *int64 `locationName:"contentBlockIndex" type:"integer" required:"true"`
// The delta for a content block delta event.
//
// Delta is a required field
Delta *ContentBlockDelta `locationName:"delta" type:"structure" required:"true"`
}
// 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 ContentBlockDeltaEvent) String() string {
return awsutil.Prettify(s)
}
// 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 ContentBlockDeltaEvent) GoString() string {
return s.String()
}
// SetContentBlockIndex sets the ContentBlockIndex field's value.
func (s *ContentBlockDeltaEvent) SetContentBlockIndex(v int64) *ContentBlockDeltaEvent {
s.ContentBlockIndex = &v
return s
}
// SetDelta sets the Delta field's value.
func (s *ContentBlockDeltaEvent) SetDelta(v *ContentBlockDelta) *ContentBlockDeltaEvent {
s.Delta = v
return s
}
// The ContentBlockDeltaEvent is and event in the ConverseStreamOutput_ group of events.
func (s *ContentBlockDeltaEvent) eventConverseStreamOutput_() {}
// UnmarshalEvent unmarshals the EventStream Message into the ContentBlockDeltaEvent value.
// This method is only used internally within the SDK's EventStream handling.
func (s *ContentBlockDeltaEvent) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
if err := payloadUnmarshaler.UnmarshalPayload(
bytes.NewReader(msg.Payload), s,
); err != nil {
return err
}
return nil
}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (s *ContentBlockDeltaEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error) {
msg.Headers.Set(eventstreamapi.MessageTypeHeader, eventstream.StringValue(eventstreamapi.EventMessageType))
var buf bytes.Buffer
if err = pm.MarshalPayload(&buf, s); err != nil {
return eventstream.Message{}, err
}
msg.Payload = buf.Bytes()
return msg, err
}
// Content block start information.
type ContentBlockStart struct {
_ struct{} `type:"structure"`
// Information about a tool that the model is requesting to use.
ToolUse *ToolUseBlockStart `locationName:"toolUse" type:"structure"`
}
// 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 ContentBlockStart) String() string {
return awsutil.Prettify(s)
}
// 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 ContentBlockStart) GoString() string {
return s.String()
}
// SetToolUse sets the ToolUse field's value.
func (s *ContentBlockStart) SetToolUse(v *ToolUseBlockStart) *ContentBlockStart {
s.ToolUse = v
return s
}
// Content block start event.
type ContentBlockStartEvent struct {
_ struct{} `type:"structure"`
// The index for a content block start event.
//
// ContentBlockIndex is a required field
ContentBlockIndex *int64 `locationName:"contentBlockIndex" type:"integer" required:"true"`
// Start information about a content block start event.
//
// Start is a required field
Start *ContentBlockStart `locationName:"start" type:"structure" required:"true"`
}
// 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 ContentBlockStartEvent) String() string {
return awsutil.Prettify(s)
}
// 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 ContentBlockStartEvent) GoString() string {
return s.String()
}
// SetContentBlockIndex sets the ContentBlockIndex field's value.
func (s *ContentBlockStartEvent) SetContentBlockIndex(v int64) *ContentBlockStartEvent {
s.ContentBlockIndex = &v
return s
}
// SetStart sets the Start field's value.
func (s *ContentBlockStartEvent) SetStart(v *ContentBlockStart) *ContentBlockStartEvent {
s.Start = v
return s
}
// The ContentBlockStartEvent is and event in the ConverseStreamOutput_ group of events.
func (s *ContentBlockStartEvent) eventConverseStreamOutput_() {}
// UnmarshalEvent unmarshals the EventStream Message into the ContentBlockStartEvent value.
// This method is only used internally within the SDK's EventStream handling.
func (s *ContentBlockStartEvent) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
if err := payloadUnmarshaler.UnmarshalPayload(
bytes.NewReader(msg.Payload), s,
); err != nil {
return err
}
return nil
}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (s *ContentBlockStartEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error) {
msg.Headers.Set(eventstreamapi.MessageTypeHeader, eventstream.StringValue(eventstreamapi.EventMessageType))
var buf bytes.Buffer
if err = pm.MarshalPayload(&buf, s); err != nil {
return eventstream.Message{}, err
}
msg.Payload = buf.Bytes()
return msg, err
}
// A content block stop event.
type ContentBlockStopEvent struct {
_ struct{} `type:"structure"`
// The index for a content block.
//
// ContentBlockIndex is a required field
ContentBlockIndex *int64 `locationName:"contentBlockIndex" type:"integer" required:"true"`
}
// 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 ContentBlockStopEvent) String() string {
return awsutil.Prettify(s)
}
// 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 ContentBlockStopEvent) GoString() string {
return s.String()
}
// SetContentBlockIndex sets the ContentBlockIndex field's value.
func (s *ContentBlockStopEvent) SetContentBlockIndex(v int64) *ContentBlockStopEvent {
s.ContentBlockIndex = &v
return s
}
// The ContentBlockStopEvent is and event in the ConverseStreamOutput_ group of events.
func (s *ContentBlockStopEvent) eventConverseStreamOutput_() {}
// UnmarshalEvent unmarshals the EventStream Message into the ContentBlockStopEvent value.
// This method is only used internally within the SDK's EventStream handling.
func (s *ContentBlockStopEvent) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
if err := payloadUnmarshaler.UnmarshalPayload(
bytes.NewReader(msg.Payload), s,
); err != nil {
return err
}
return nil
}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (s *ContentBlockStopEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error) {
msg.Headers.Set(eventstreamapi.MessageTypeHeader, eventstream.StringValue(eventstreamapi.EventMessageType))
var buf bytes.Buffer
if err = pm.MarshalPayload(&buf, s); err != nil {
return eventstream.Message{}, err
}
msg.Payload = buf.Bytes()
return msg, err
}
type ConverseInput struct {
_ struct{} `type:"structure"`
// Additional model parameters field paths to return in the response. Converse
// returns the requested fields as a JSON Pointer object in the additionalModelResponseFields
// field. The following is example JSON for additionalModelResponseFieldPaths.
//
// [ "/stop_sequence" ]
//
// For information about the JSON Pointer syntax, see the Internet Engineering
// Task Force (IETF) (https://datatracker.ietf.org/doc/html/rfc6901) documentation.
//
// Converse rejects an empty JSON Pointer or incorrectly structured JSON Pointer
// with a 400 error code. if the JSON Pointer is valid, but the requested field
// is not in the model response, it is ignored by Converse.
AdditionalModelResponseFieldPaths []*string `locationName:"additionalModelResponseFieldPaths" type:"list"`
// Configuration information for a guardrail that you want to use in the request.
GuardrailConfig *GuardrailConfiguration `locationName:"guardrailConfig" type:"structure"`
// Inference parameters to pass to the model. Converse supports a base set of
// inference parameters. If you need to pass additional parameters that the
// model supports, use the additionalModelRequestFields request field.
InferenceConfig *InferenceConfiguration `locationName:"inferenceConfig" type:"structure"`
// The messages that you want to send to the model.
//
// Messages is a required field
Messages []*Message `locationName:"messages" type:"list" required:"true"`
// The identifier for the model that you want to call.
//
// The modelId to provide depends on the type of model that you use:
//
// * If you use a base model, specify the model ID or its ARN. For a list
// of model IDs for base models, see Amazon Bedrock base model IDs (on-demand
// throughput) (https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns)
// in the Amazon Bedrock User Guide.
//
// * If you use a provisioned model, specify the ARN of the Provisioned Throughput.
// For more information, see Run inference using a Provisioned Throughput
// (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html)
// in the Amazon Bedrock User Guide.
//
// * If you use a custom model, first purchase Provisioned Throughput for
// it. Then specify the ARN of the resulting provisioned model. For more
// information, see Use a custom model in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html)
// in the Amazon Bedrock User Guide.
//
// ModelId is a required field
ModelId *string `location:"uri" locationName:"modelId" min:"1" type:"string" required:"true"`
// A system prompt to pass to the model.
System []*SystemContentBlock `locationName:"system" type:"list"`
// Configuration information for the tools that the model can use when generating
// a response.
//
// This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere
// Command R+, and Mistral Large models.
ToolConfig *ToolConfiguration `locationName:"toolConfig" type:"structure"`
}
// 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 ConverseInput) String() string {
return awsutil.Prettify(s)
}
// 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 ConverseInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ConverseInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ConverseInput"}
if s.Messages == nil {
invalidParams.Add(request.NewErrParamRequired("Messages"))
}
if s.ModelId == nil {
invalidParams.Add(request.NewErrParamRequired("ModelId"))
}
if s.ModelId != nil && len(*s.ModelId) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ModelId", 1))
}
if s.GuardrailConfig != nil {
if err := s.GuardrailConfig.Validate(); err != nil {
invalidParams.AddNested("GuardrailConfig", err.(request.ErrInvalidParams))
}
}
if s.InferenceConfig != nil {
if err := s.InferenceConfig.Validate(); err != nil {
invalidParams.AddNested("InferenceConfig", err.(request.ErrInvalidParams))
}
}
if s.Messages != nil {
for i, v := range s.Messages {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Messages", i), err.(request.ErrInvalidParams))
}
}
}
if s.System != nil {
for i, v := range s.System {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "System", i), err.(request.ErrInvalidParams))
}
}
}
if s.ToolConfig != nil {
if err := s.ToolConfig.Validate(); err != nil {
invalidParams.AddNested("ToolConfig", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAdditionalModelResponseFieldPaths sets the AdditionalModelResponseFieldPaths field's value.
func (s *ConverseInput) SetAdditionalModelResponseFieldPaths(v []*string) *ConverseInput {
s.AdditionalModelResponseFieldPaths = v
return s
}
// SetGuardrailConfig sets the GuardrailConfig field's value.
func (s *ConverseInput) SetGuardrailConfig(v *GuardrailConfiguration) *ConverseInput {
s.GuardrailConfig = v
return s
}
// SetInferenceConfig sets the InferenceConfig field's value.
func (s *ConverseInput) SetInferenceConfig(v *InferenceConfiguration) *ConverseInput {
s.InferenceConfig = v
return s
}
// SetMessages sets the Messages field's value.
func (s *ConverseInput) SetMessages(v []*Message) *ConverseInput {
s.Messages = v
return s
}
// SetModelId sets the ModelId field's value.
func (s *ConverseInput) SetModelId(v string) *ConverseInput {
s.ModelId = &v
return s
}
// SetSystem sets the System field's value.
func (s *ConverseInput) SetSystem(v []*SystemContentBlock) *ConverseInput {
s.System = v
return s
}
// SetToolConfig sets the ToolConfig field's value.
func (s *ConverseInput) SetToolConfig(v *ToolConfiguration) *ConverseInput {
s.ToolConfig = v
return s
}
// Metrics for a call to Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html).
type ConverseMetrics struct {
_ struct{} `type:"structure"`
// The latency of the call to Converse, in milliseconds.
//
// LatencyMs is a required field
LatencyMs *int64 `locationName:"latencyMs" type:"long" required:"true"`
}
// 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 ConverseMetrics) String() string {
return awsutil.Prettify(s)
}
// 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 ConverseMetrics) GoString() string {
return s.String()
}
// SetLatencyMs sets the LatencyMs field's value.
func (s *ConverseMetrics) SetLatencyMs(v int64) *ConverseMetrics {
s.LatencyMs = &v
return s
}
type ConverseOutput struct {
_ struct{} `type:"structure"`
// Metrics for the call to Converse.
//
// Metrics is a required field
Metrics *ConverseMetrics `locationName:"metrics" type:"structure" required:"true"`
// The result from the call to Converse.
//
// Output is a required field
Output *ConverseOutput_ `locationName:"output" type:"structure" required:"true"`
// The reason why the model stopped generating output.
//
// StopReason is a required field
StopReason *string `locationName:"stopReason" type:"string" required:"true" enum:"StopReason"`
// A trace object that contains information about the Guardrail behavior.
Trace *ConverseTrace `locationName:"trace" type:"structure"`
// The total number of tokens used in the call to Converse. The total includes
// the tokens input to the model and the tokens generated by the model.
//
// Usage is a required field
Usage *TokenUsage `locationName:"usage" type:"structure" required:"true"`
}
// 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 ConverseOutput) String() string {
return awsutil.Prettify(s)
}
// 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 ConverseOutput) GoString() string {
return s.String()
}
// SetMetrics sets the Metrics field's value.
func (s *ConverseOutput) SetMetrics(v *ConverseMetrics) *ConverseOutput {
s.Metrics = v
return s
}
// SetOutput sets the Output field's value.
func (s *ConverseOutput) SetOutput(v *ConverseOutput_) *ConverseOutput {
s.Output = v
return s
}
// SetStopReason sets the StopReason field's value.
func (s *ConverseOutput) SetStopReason(v string) *ConverseOutput {
s.StopReason = &v
return s
}
// SetTrace sets the Trace field's value.
func (s *ConverseOutput) SetTrace(v *ConverseTrace) *ConverseOutput {
s.Trace = v
return s
}
// SetUsage sets the Usage field's value.
func (s *ConverseOutput) SetUsage(v *TokenUsage) *ConverseOutput {
s.Usage = v
return s
}
// The output from a call to Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html).
type ConverseOutput_ struct {
_ struct{} `type:"structure"`
// The message that the model generates.
Message *Message `locationName:"message" type:"structure"`
}
// 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 ConverseOutput_) String() string {
return awsutil.Prettify(s)
}
// 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 ConverseOutput_) GoString() string {
return s.String()
}
// SetMessage sets the Message field's value.
func (s *ConverseOutput_) SetMessage(v *Message) *ConverseOutput_ {
s.Message = v
return s
}
type ConverseStreamInput struct {
_ struct{} `type:"structure"`
// Additional model parameters field paths to return in the response. ConverseStream
// returns the requested fields as a JSON Pointer object in the additionalModelResponseFields
// field. The following is example JSON for additionalModelResponseFieldPaths.
//
// [ "/stop_sequence" ]
//
// For information about the JSON Pointer syntax, see the Internet Engineering
// Task Force (IETF) (https://datatracker.ietf.org/doc/html/rfc6901) documentation.
//
// ConverseStream rejects an empty JSON Pointer or incorrectly structured JSON
// Pointer with a 400 error code. if the JSON Pointer is valid, but the requested
// field is not in the model response, it is ignored by ConverseStream.
AdditionalModelResponseFieldPaths []*string `locationName:"additionalModelResponseFieldPaths" type:"list"`
// Configuration information for a guardrail that you want to use in the request.
GuardrailConfig *GuardrailStreamConfiguration `locationName:"guardrailConfig" type:"structure"`
// Inference parameters to pass to the model. ConverseStream supports a base
// set of inference parameters. If you need to pass additional parameters that
// the model supports, use the additionalModelRequestFields request field.
InferenceConfig *InferenceConfiguration `locationName:"inferenceConfig" type:"structure"`
// The messages that you want to send to the model.
//
// Messages is a required field
Messages []*Message `locationName:"messages" type:"list" required:"true"`
// The ID for the model.
//
// The modelId to provide depends on the type of model that you use:
//
// * If you use a base model, specify the model ID or its ARN. For a list
// of model IDs for base models, see Amazon Bedrock base model IDs (on-demand
// throughput) (https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns)
// in the Amazon Bedrock User Guide.
//
// * If you use a provisioned model, specify the ARN of the Provisioned Throughput.
// For more information, see Run inference using a Provisioned Throughput
// (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html)
// in the Amazon Bedrock User Guide.
//
// * If you use a custom model, first purchase Provisioned Throughput for
// it. Then specify the ARN of the resulting provisioned model. For more
// information, see Use a custom model in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html)
// in the Amazon Bedrock User Guide.
//
// ModelId is a required field
ModelId *string `location:"uri" locationName:"modelId" min:"1" type:"string" required:"true"`
// A system prompt to send to the model.
System []*SystemContentBlock `locationName:"system" type:"list"`
// Configuration information for the tools that the model can use when generating
// a response.
//
// This field is only supported by Anthropic Claude 3 models.
ToolConfig *ToolConfiguration `locationName:"toolConfig" type:"structure"`
}
// 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 ConverseStreamInput) String() string {
return awsutil.Prettify(s)
}
// 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 ConverseStreamInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ConverseStreamInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ConverseStreamInput"}
if s.Messages == nil {
invalidParams.Add(request.NewErrParamRequired("Messages"))
}
if s.ModelId == nil {
invalidParams.Add(request.NewErrParamRequired("ModelId"))
}
if s.ModelId != nil && len(*s.ModelId) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ModelId", 1))
}
if s.GuardrailConfig != nil {
if err := s.GuardrailConfig.Validate(); err != nil {
invalidParams.AddNested("GuardrailConfig", err.(request.ErrInvalidParams))
}
}
if s.InferenceConfig != nil {
if err := s.InferenceConfig.Validate(); err != nil {
invalidParams.AddNested("InferenceConfig", err.(request.ErrInvalidParams))
}
}
if s.Messages != nil {
for i, v := range s.Messages {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Messages", i), err.(request.ErrInvalidParams))
}
}
}
if s.System != nil {
for i, v := range s.System {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "System", i), err.(request.ErrInvalidParams))
}
}
}
if s.ToolConfig != nil {
if err := s.ToolConfig.Validate(); err != nil {
invalidParams.AddNested("ToolConfig", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAdditionalModelResponseFieldPaths sets the AdditionalModelResponseFieldPaths field's value.
func (s *ConverseStreamInput) SetAdditionalModelResponseFieldPaths(v []*string) *ConverseStreamInput {
s.AdditionalModelResponseFieldPaths = v
return s
}
// SetGuardrailConfig sets the GuardrailConfig field's value.
func (s *ConverseStreamInput) SetGuardrailConfig(v *GuardrailStreamConfiguration) *ConverseStreamInput {
s.GuardrailConfig = v
return s
}
// SetInferenceConfig sets the InferenceConfig field's value.
func (s *ConverseStreamInput) SetInferenceConfig(v *InferenceConfiguration) *ConverseStreamInput {
s.InferenceConfig = v
return s
}
// SetMessages sets the Messages field's value.
func (s *ConverseStreamInput) SetMessages(v []*Message) *ConverseStreamInput {
s.Messages = v
return s
}
// SetModelId sets the ModelId field's value.
func (s *ConverseStreamInput) SetModelId(v string) *ConverseStreamInput {
s.ModelId = &v
return s
}
// SetSystem sets the System field's value.
func (s *ConverseStreamInput) SetSystem(v []*SystemContentBlock) *ConverseStreamInput {
s.System = v
return s
}
// SetToolConfig sets the ToolConfig field's value.
func (s *ConverseStreamInput) SetToolConfig(v *ToolConfiguration) *ConverseStreamInput {
s.ToolConfig = v
return s
}
// A conversation stream metadata event.
type ConverseStreamMetadataEvent struct {
_ struct{} `type:"structure"`
// The metrics for the conversation stream metadata event.
//
// Metrics is a required field
Metrics *ConverseStreamMetrics `locationName:"metrics" type:"structure" required:"true"`
// The trace object in the response from ConverseStream (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html)
// that contains information about the guardrail behavior.
Trace *ConverseStreamTrace `locationName:"trace" type:"structure"`
// Usage information for the conversation stream event.
//
// Usage is a required field
Usage *TokenUsage `locationName:"usage" type:"structure" required:"true"`
}
// 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 ConverseStreamMetadataEvent) String() string {
return awsutil.Prettify(s)
}
// 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 ConverseStreamMetadataEvent) GoString() string {
return s.String()
}
// SetMetrics sets the Metrics field's value.
func (s *ConverseStreamMetadataEvent) SetMetrics(v *ConverseStreamMetrics) *ConverseStreamMetadataEvent {
s.Metrics = v
return s
}
// SetTrace sets the Trace field's value.
func (s *ConverseStreamMetadataEvent) SetTrace(v *ConverseStreamTrace) *ConverseStreamMetadataEvent {
s.Trace = v
return s
}
// SetUsage sets the Usage field's value.
func (s *ConverseStreamMetadataEvent) SetUsage(v *TokenUsage) *ConverseStreamMetadataEvent {
s.Usage = v
return s
}
// The ConverseStreamMetadataEvent is and event in the ConverseStreamOutput_ group of events.
func (s *ConverseStreamMetadataEvent) eventConverseStreamOutput_() {}
// UnmarshalEvent unmarshals the EventStream Message into the ConverseStreamMetadataEvent value.
// This method is only used internally within the SDK's EventStream handling.
func (s *ConverseStreamMetadataEvent) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
if err := payloadUnmarshaler.UnmarshalPayload(
bytes.NewReader(msg.Payload), s,
); err != nil {
return err
}
return nil
}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (s *ConverseStreamMetadataEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error) {
msg.Headers.Set(eventstreamapi.MessageTypeHeader, eventstream.StringValue(eventstreamapi.EventMessageType))
var buf bytes.Buffer
if err = pm.MarshalPayload(&buf, s); err != nil {
return eventstream.Message{}, err
}
msg.Payload = buf.Bytes()
return msg, err
}
// Metrics for the stream.
type ConverseStreamMetrics struct {
_ struct{} `type:"structure"`
// The latency for the streaming request, in milliseconds.
//
// LatencyMs is a required field
LatencyMs *int64 `locationName:"latencyMs" type:"long" required:"true"`
}
// 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 ConverseStreamMetrics) String() string {
return awsutil.Prettify(s)
}
// 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 ConverseStreamMetrics) GoString() string {
return s.String()
}
// SetLatencyMs sets the LatencyMs field's value.
func (s *ConverseStreamMetrics) SetLatencyMs(v int64) *ConverseStreamMetrics {
s.LatencyMs = &v
return s
}
type ConverseStreamOutput struct {
_ struct{} `type:"structure" payload:"Stream"`
eventStream *ConverseStreamEventStream
}
// 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 ConverseStreamOutput) String() string {
return awsutil.Prettify(s)
}
// 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 ConverseStreamOutput) GoString() string {
return s.String()
}
// GetStream returns the type to interact with the event stream.
func (s *ConverseStreamOutput) GetStream() *ConverseStreamEventStream {
return s.eventStream
}
// ConverseStreamOutput_Event groups together all EventStream
// events writes for ConverseStreamOutput_.
//
// These events are:
//
// - ContentBlockDeltaEvent
// - ContentBlockStartEvent
// - ContentBlockStopEvent
// - MessageStartEvent
// - MessageStopEvent
// - ConverseStreamMetadataEvent
type ConverseStreamOutput_Event interface {
eventConverseStreamOutput_()
eventstreamapi.Marshaler
eventstreamapi.Unmarshaler
}
// ConverseStreamOutput_Reader provides the interface for reading to the stream. The
// default implementation for this interface will be ConverseStreamOutput_.
//
// The reader's Close method must allow multiple concurrent calls.
//
// These events are:
//
// - ContentBlockDeltaEvent
// - ContentBlockStartEvent
// - ContentBlockStopEvent
// - MessageStartEvent
// - MessageStopEvent
// - ConverseStreamMetadataEvent
// - ConverseStreamOutput_UnknownEvent
type ConverseStreamOutput_Reader interface {
// Returns a channel of events as they are read from the event stream.
Events() <-chan ConverseStreamOutput_Event
// 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
}
type readConverseStreamOutput_ struct {
eventReader *eventstreamapi.EventReader
stream chan ConverseStreamOutput_Event
err *eventstreamapi.OnceError
done chan struct{}
closeOnce sync.Once
}
func newReadConverseStreamOutput_(eventReader *eventstreamapi.EventReader) *readConverseStreamOutput_ {
r := &readConverseStreamOutput_{
eventReader: eventReader,
stream: make(chan ConverseStreamOutput_Event),
done: make(chan struct{}),
err: eventstreamapi.NewOnceError(),
}
go r.readEventStream()
return r
}
// Close will close the underlying event stream reader.
func (r *readConverseStreamOutput_) Close() error {
r.closeOnce.Do(r.safeClose)
return r.Err()
}
func (r *readConverseStreamOutput_) ErrorSet() <-chan struct{} {
return r.err.ErrorSet()
}
func (r *readConverseStreamOutput_) Closed() <-chan struct{} {
return r.done
}
func (r *readConverseStreamOutput_) safeClose() {
close(r.done)
}
func (r *readConverseStreamOutput_) Err() error {
return r.err.Err()
}
func (r *readConverseStreamOutput_) Events() <-chan ConverseStreamOutput_Event {
return r.stream
}
func (r *readConverseStreamOutput_) readEventStream() {
defer r.Close()
defer close(r.stream)
for {
event, err := r.eventReader.ReadEvent()
if err != nil {
if err == io.EOF {
return
}
select {
case <-r.done:
// If closed already ignore the error
return
default:
}
if _, ok := err.(*eventstreamapi.UnknownMessageTypeError); ok {
continue
}
r.err.SetError(err)
return
}
select {
case r.stream <- event.(ConverseStreamOutput_Event):
case <-r.done:
return
}
}
}
type unmarshalerForConverseStreamOutput_Event struct {
metadata protocol.ResponseMetadata
}
func (u unmarshalerForConverseStreamOutput_Event) UnmarshalerForEventName(eventType string) (eventstreamapi.Unmarshaler, error) {
switch eventType {
case "contentBlockDelta":
return &ContentBlockDeltaEvent{}, nil
case "contentBlockStart":
return &ContentBlockStartEvent{}, nil
case "contentBlockStop":
return &ContentBlockStopEvent{}, nil
case "messageStart":
return &MessageStartEvent{}, nil
case "messageStop":
return &MessageStopEvent{}, nil
case "metadata":
return &ConverseStreamMetadataEvent{}, nil
case "internalServerException":
return newErrorInternalServerException(u.metadata).(eventstreamapi.Unmarshaler), nil
case "modelStreamErrorException":
return newErrorModelStreamErrorException(u.metadata).(eventstreamapi.Unmarshaler), nil
case "serviceUnavailableException":
return newErrorServiceUnavailableException(u.metadata).(eventstreamapi.Unmarshaler), nil
case "throttlingException":
return newErrorThrottlingException(u.metadata).(eventstreamapi.Unmarshaler), nil
case "validationException":
return newErrorValidationException(u.metadata).(eventstreamapi.Unmarshaler), nil
default:
return &ConverseStreamOutput_UnknownEvent{Type: eventType}, nil
}
}
// ConverseStreamOutput_UnknownEvent provides a failsafe event for the
// ConverseStreamOutput_ group of events when an unknown event is received.
type ConverseStreamOutput_UnknownEvent struct {
Type string
Message eventstream.Message
}
// The ConverseStreamOutput_UnknownEvent is and event in the ConverseStreamOutput_
// group of events.
func (s *ConverseStreamOutput_UnknownEvent) eventConverseStreamOutput_() {}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (e *ConverseStreamOutput_UnknownEvent) MarshalEvent(pm protocol.PayloadMarshaler) (
msg eventstream.Message, err error,
) {
return e.Message.Clone(), nil
}
// UnmarshalEvent unmarshals the EventStream Message into the ConverseStreamOutput_ value.
// This method is only used internally within the SDK's EventStream handling.
func (e *ConverseStreamOutput_UnknownEvent) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
e.Message = msg.Clone()
return nil
}
// The trace object in a response from ConverseStream (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html).
// Currently, you can only trace guardrails.
type ConverseStreamTrace struct {
_ struct{} `type:"structure"`
// The guardrail trace object.
Guardrail *GuardrailTraceAssessment `locationName:"guardrail" type:"structure"`
}
// 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 ConverseStreamTrace) String() string {
return awsutil.Prettify(s)
}
// 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 ConverseStreamTrace) GoString() string {
return s.String()
}
// SetGuardrail sets the Guardrail field's value.
func (s *ConverseStreamTrace) SetGuardrail(v *GuardrailTraceAssessment) *ConverseStreamTrace {
s.Guardrail = v
return s
}
// The trace object in a response from Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html).
// Currently, you can only trace guardrails.
type ConverseTrace struct {
_ struct{} `type:"structure"`
// The guardrail trace object.
Guardrail *GuardrailTraceAssessment `locationName:"guardrail" type:"structure"`
}
// 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 ConverseTrace) String() string {
return awsutil.Prettify(s)
}
// 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 ConverseTrace) GoString() string {
return s.String()
}
// SetGuardrail sets the Guardrail field's value.
func (s *ConverseTrace) SetGuardrail(v *GuardrailTraceAssessment) *ConverseTrace {
s.Guardrail = v
return s
}
// A document to include in a message.
type DocumentBlock struct {
_ struct{} `type:"structure"`
// The format of a document, or its extension.
//
// Format is a required field
Format *string `locationName:"format" type:"string" required:"true" enum:"DocumentFormat"`
// A name for the document. The name can only contain the following characters:
//
// * Alphanumeric characters
//
// * Whitespace characters (no more than one in a row)
//
// * Hyphens
//
// * Parentheses
//
// * Square brackets
//
// This field is vulnerable to prompt injections, because the model might inadvertently
// interpret it as instructions. Therefore, we recommend that you specify a
// neutral name.
//
// Name is a required field
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
// Contains the content of the document.
//
// Source is a required field
Source *DocumentSource `locationName:"source" type:"structure" required:"true"`
}
// 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 DocumentBlock) String() string {
return awsutil.Prettify(s)
}
// 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 DocumentBlock) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DocumentBlock) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DocumentBlock"}
if s.Format == nil {
invalidParams.Add(request.NewErrParamRequired("Format"))
}
if s.Name == nil {
invalidParams.Add(request.NewErrParamRequired("Name"))
}
if s.Name != nil && len(*s.Name) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Name", 1))
}
if s.Source == nil {
invalidParams.Add(request.NewErrParamRequired("Source"))
}
if s.Source != nil {
if err := s.Source.Validate(); err != nil {
invalidParams.AddNested("Source", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFormat sets the Format field's value.
func (s *DocumentBlock) SetFormat(v string) *DocumentBlock {
s.Format = &v
return s
}
// SetName sets the Name field's value.
func (s *DocumentBlock) SetName(v string) *DocumentBlock {
s.Name = &v
return s
}
// SetSource sets the Source field's value.
func (s *DocumentBlock) SetSource(v *DocumentSource) *DocumentBlock {
s.Source = v
return s
}
// Contains the content of a document.
type DocumentSource struct {
_ struct{} `type:"structure"`
// The raw bytes for the document. If you use an Amazon Web Services SDK, you
// don't need to encode the bytes in base64.
// Bytes is automatically base64 encoded/decoded by the SDK.
Bytes []byte `locationName:"bytes" min:"1" type:"blob"`
}
// 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 DocumentSource) String() string {
return awsutil.Prettify(s)
}
// 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 DocumentSource) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DocumentSource) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DocumentSource"}
if s.Bytes != nil && len(s.Bytes) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Bytes", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetBytes sets the Bytes field's value.
func (s *DocumentSource) SetBytes(v []byte) *DocumentSource {
s.Bytes = v
return s
}
// A behavior assessment of the guardrail policies used in a call to the Converse
// API.
type GuardrailAssessment struct {
_ struct{} `type:"structure"`
// The content policy.
ContentPolicy *GuardrailContentPolicyAssessment `locationName:"contentPolicy" type:"structure"`
// The contextual grounding policy used for the guardrail assessment.
ContextualGroundingPolicy *GuardrailContextualGroundingPolicyAssessment `locationName:"contextualGroundingPolicy" type:"structure"`
// The sensitive information policy.
SensitiveInformationPolicy *GuardrailSensitiveInformationPolicyAssessment `locationName:"sensitiveInformationPolicy" type:"structure"`
// The topic policy.
TopicPolicy *GuardrailTopicPolicyAssessment `locationName:"topicPolicy" type:"structure"`
// The word policy.
WordPolicy *GuardrailWordPolicyAssessment `locationName:"wordPolicy" type:"structure"`
}
// 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 GuardrailAssessment) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailAssessment) GoString() string {
return s.String()
}
// SetContentPolicy sets the ContentPolicy field's value.
func (s *GuardrailAssessment) SetContentPolicy(v *GuardrailContentPolicyAssessment) *GuardrailAssessment {
s.ContentPolicy = v
return s
}
// SetContextualGroundingPolicy sets the ContextualGroundingPolicy field's value.
func (s *GuardrailAssessment) SetContextualGroundingPolicy(v *GuardrailContextualGroundingPolicyAssessment) *GuardrailAssessment {
s.ContextualGroundingPolicy = v
return s
}
// SetSensitiveInformationPolicy sets the SensitiveInformationPolicy field's value.
func (s *GuardrailAssessment) SetSensitiveInformationPolicy(v *GuardrailSensitiveInformationPolicyAssessment) *GuardrailAssessment {
s.SensitiveInformationPolicy = v
return s
}
// SetTopicPolicy sets the TopicPolicy field's value.
func (s *GuardrailAssessment) SetTopicPolicy(v *GuardrailTopicPolicyAssessment) *GuardrailAssessment {
s.TopicPolicy = v
return s
}
// SetWordPolicy sets the WordPolicy field's value.
func (s *GuardrailAssessment) SetWordPolicy(v *GuardrailWordPolicyAssessment) *GuardrailAssessment {
s.WordPolicy = v
return s
}
// Configuration information for a guardrail that you use with the Converse
// (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html)
// operation.
type GuardrailConfiguration struct {
_ struct{} `type:"structure"`
// The identifier for the guardrail.
//
// GuardrailIdentifier is a required field
GuardrailIdentifier *string `locationName:"guardrailIdentifier" type:"string" required:"true"`
// The version of the guardrail.
//
// GuardrailVersion is a required field
GuardrailVersion *string `locationName:"guardrailVersion" type:"string" required:"true"`
// The trace behavior for the guardrail.
Trace *string `locationName:"trace" type:"string" enum:"GuardrailTrace"`
}
// 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) String() string {
return awsutil.Prettify(s)
}
// 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) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GuardrailConfiguration) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GuardrailConfiguration"}
if s.GuardrailIdentifier == nil {
invalidParams.Add(request.NewErrParamRequired("GuardrailIdentifier"))
}
if s.GuardrailVersion == nil {
invalidParams.Add(request.NewErrParamRequired("GuardrailVersion"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetGuardrailIdentifier sets the GuardrailIdentifier field's value.
func (s *GuardrailConfiguration) SetGuardrailIdentifier(v string) *GuardrailConfiguration {
s.GuardrailIdentifier = &v
return s
}
// SetGuardrailVersion sets the GuardrailVersion field's value.
func (s *GuardrailConfiguration) SetGuardrailVersion(v string) *GuardrailConfiguration {
s.GuardrailVersion = &v
return s
}
// SetTrace sets the Trace field's value.
func (s *GuardrailConfiguration) SetTrace(v string) *GuardrailConfiguration {
s.Trace = &v
return s
}
// The content block to be evaluated by the guardrail.
type GuardrailContentBlock struct {
_ struct{} `type:"structure"`
// Text within content block to be evaluated by the guardrail.
Text *GuardrailTextBlock `locationName:"text" type:"structure"`
}
// 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 GuardrailContentBlock) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailContentBlock) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GuardrailContentBlock) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GuardrailContentBlock"}
if s.Text != nil {
if err := s.Text.Validate(); err != nil {
invalidParams.AddNested("Text", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetText sets the Text field's value.
func (s *GuardrailContentBlock) SetText(v *GuardrailTextBlock) *GuardrailContentBlock {
s.Text = v
return s
}
// The content filter for a guardrail.
type GuardrailContentFilter struct {
_ struct{} `type:"structure"`
// The guardrail action.
//
// Action is a required field
Action *string `locationName:"action" type:"string" required:"true" enum:"GuardrailContentPolicyAction"`
// The guardrail confidence.
//
// Confidence is a required field
Confidence *string `locationName:"confidence" type:"string" required:"true" enum:"GuardrailContentFilterConfidence"`
// The guardrail type.
//
// Type is a required field
Type *string `locationName:"type" type:"string" required:"true" enum:"GuardrailContentFilterType"`
}
// 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 GuardrailContentFilter) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailContentFilter) GoString() string {
return s.String()
}
// SetAction sets the Action field's value.
func (s *GuardrailContentFilter) SetAction(v string) *GuardrailContentFilter {
s.Action = &v
return s
}
// SetConfidence sets the Confidence field's value.
func (s *GuardrailContentFilter) SetConfidence(v string) *GuardrailContentFilter {
s.Confidence = &v
return s
}
// SetType sets the Type field's value.
func (s *GuardrailContentFilter) SetType(v string) *GuardrailContentFilter {
s.Type = &v
return s
}
// An assessment of a content policy for a guardrail.
type GuardrailContentPolicyAssessment struct {
_ struct{} `type:"structure"`
// The content policy filters.
//
// Filters is a required field
Filters []*GuardrailContentFilter `locationName:"filters" type:"list" required:"true"`
}
// 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 GuardrailContentPolicyAssessment) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailContentPolicyAssessment) GoString() string {
return s.String()
}
// SetFilters sets the Filters field's value.
func (s *GuardrailContentPolicyAssessment) SetFilters(v []*GuardrailContentFilter) *GuardrailContentPolicyAssessment {
s.Filters = v
return s
}
// The details for the guardrails contextual grounding filter.
type GuardrailContextualGroundingFilter struct {
_ struct{} `type:"structure"`
// The action performed by the guardrails contextual grounding filter.
//
// Action is a required field
Action *string `locationName:"action" type:"string" required:"true" enum:"GuardrailContextualGroundingPolicyAction"`
// The score generated by contextual grounding filter.
//
// Score is a required field
Score *float64 `locationName:"score" type:"double" required:"true"`
// The threshold used by contextual grounding filter to determine whether the
// content is grounded or not.
//
// Threshold is a required field
Threshold *float64 `locationName:"threshold" type:"double" required:"true"`
// The contextual grounding filter type.
//
// Type is a required field
Type *string `locationName:"type" type:"string" required:"true" enum:"GuardrailContextualGroundingFilterType"`
}
// 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 GuardrailContextualGroundingFilter) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailContextualGroundingFilter) GoString() string {
return s.String()
}
// SetAction sets the Action field's value.
func (s *GuardrailContextualGroundingFilter) SetAction(v string) *GuardrailContextualGroundingFilter {
s.Action = &v
return s
}
// SetScore sets the Score field's value.
func (s *GuardrailContextualGroundingFilter) SetScore(v float64) *GuardrailContextualGroundingFilter {
s.Score = &v
return s
}
// SetThreshold sets the Threshold field's value.
func (s *GuardrailContextualGroundingFilter) SetThreshold(v float64) *GuardrailContextualGroundingFilter {
s.Threshold = &v
return s
}
// SetType sets the Type field's value.
func (s *GuardrailContextualGroundingFilter) SetType(v string) *GuardrailContextualGroundingFilter {
s.Type = &v
return s
}
// The policy assessment details for the guardrails contextual grounding filter.
type GuardrailContextualGroundingPolicyAssessment struct {
_ struct{} `type:"structure"`
// The filter details for the guardrails contextual grounding filter.
Filters []*GuardrailContextualGroundingFilter `locationName:"filters" type:"list"`
}
// 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 GuardrailContextualGroundingPolicyAssessment) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailContextualGroundingPolicyAssessment) GoString() string {
return s.String()
}
// SetFilters sets the Filters field's value.
func (s *GuardrailContextualGroundingPolicyAssessment) SetFilters(v []*GuardrailContextualGroundingFilter) *GuardrailContextualGroundingPolicyAssessment {
s.Filters = v
return s
}
// A content block for selective guarding with the Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html)
// or ConverseStream (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html)
// API operations.
type GuardrailConverseContentBlock struct {
_ struct{} `type:"structure"`
// The text to guard.
Text *GuardrailConverseTextBlock `locationName:"text" type:"structure"`
}
// 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 GuardrailConverseContentBlock) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailConverseContentBlock) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GuardrailConverseContentBlock) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GuardrailConverseContentBlock"}
if s.Text != nil {
if err := s.Text.Validate(); err != nil {
invalidParams.AddNested("Text", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetText sets the Text field's value.
func (s *GuardrailConverseContentBlock) SetText(v *GuardrailConverseTextBlock) *GuardrailConverseContentBlock {
s.Text = v
return s
}
// A text block that contains text that you want to assess with a guardrail.
// For more information, see GuardrailConverseContentBlock.
type GuardrailConverseTextBlock struct {
_ struct{} `type:"structure"`
// The qualifier details for the guardrails contextual grounding filter.
Qualifiers []*string `locationName:"qualifiers" type:"list" enum:"GuardrailConverseContentQualifier"`
// The text that you want to guard.
//
// Text is a required field
Text *string `locationName:"text" type:"string" required:"true"`
}
// 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 GuardrailConverseTextBlock) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailConverseTextBlock) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GuardrailConverseTextBlock) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GuardrailConverseTextBlock"}
if s.Text == nil {
invalidParams.Add(request.NewErrParamRequired("Text"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetQualifiers sets the Qualifiers field's value.
func (s *GuardrailConverseTextBlock) SetQualifiers(v []*string) *GuardrailConverseTextBlock {
s.Qualifiers = v
return s
}
// SetText sets the Text field's value.
func (s *GuardrailConverseTextBlock) SetText(v string) *GuardrailConverseTextBlock {
s.Text = &v
return s
}
// A custom word configured in a guardrail.
type GuardrailCustomWord struct {
_ struct{} `type:"structure"`
// The action for the custom word.
//
// Action is a required field
Action *string `locationName:"action" type:"string" required:"true" enum:"GuardrailWordPolicyAction"`
// The match for the custom word.
//
// Match is a required field
Match *string `locationName:"match" type:"string" required:"true"`
}
// 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 GuardrailCustomWord) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailCustomWord) GoString() string {
return s.String()
}
// SetAction sets the Action field's value.
func (s *GuardrailCustomWord) SetAction(v string) *GuardrailCustomWord {
s.Action = &v
return s
}
// SetMatch sets the Match field's value.
func (s *GuardrailCustomWord) SetMatch(v string) *GuardrailCustomWord {
s.Match = &v
return s
}
// A managed word configured in a guardrail.
type GuardrailManagedWord struct {
_ struct{} `type:"structure"`
// The action for the managed word.
//
// Action is a required field
Action *string `locationName:"action" type:"string" required:"true" enum:"GuardrailWordPolicyAction"`
// The match for the managed word.
//
// Match is a required field
Match *string `locationName:"match" type:"string" required:"true"`
// The type for the managed word.
//
// Type is a required field
Type *string `locationName:"type" type:"string" required:"true" enum:"GuardrailManagedWordType"`
}
// 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 GuardrailManagedWord) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailManagedWord) GoString() string {
return s.String()
}
// SetAction sets the Action field's value.
func (s *GuardrailManagedWord) SetAction(v string) *GuardrailManagedWord {
s.Action = &v
return s
}
// SetMatch sets the Match field's value.
func (s *GuardrailManagedWord) SetMatch(v string) *GuardrailManagedWord {
s.Match = &v
return s
}
// SetType sets the Type field's value.
func (s *GuardrailManagedWord) SetType(v string) *GuardrailManagedWord {
s.Type = &v
return s
}
// The output content produced by the guardrail.
type GuardrailOutputContent struct {
_ struct{} `type:"structure"`
// The specific text for the output content produced by the guardrail.
Text *string `locationName:"text" type:"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 GuardrailOutputContent) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailOutputContent) GoString() string {
return s.String()
}
// SetText sets the Text field's value.
func (s *GuardrailOutputContent) SetText(v string) *GuardrailOutputContent {
s.Text = &v
return s
}
// A Personally Identifiable Information (PII) entity configured in a guardrail.
type GuardrailPiiEntityFilter struct {
_ struct{} `type:"structure"`
// The PII entity filter action.
//
// Action is a required field
Action *string `locationName:"action" type:"string" required:"true" enum:"GuardrailSensitiveInformationPolicyAction"`
// The PII entity filter match.
//
// Match is a required field
Match *string `locationName:"match" type:"string" required:"true"`
// The PII entity filter type.
//
// Type is a required field
Type *string `locationName:"type" type:"string" required:"true" enum:"GuardrailPiiEntityType"`
}
// 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 GuardrailPiiEntityFilter) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailPiiEntityFilter) GoString() string {
return s.String()
}
// SetAction sets the Action field's value.
func (s *GuardrailPiiEntityFilter) SetAction(v string) *GuardrailPiiEntityFilter {
s.Action = &v
return s
}
// SetMatch sets the Match field's value.
func (s *GuardrailPiiEntityFilter) SetMatch(v string) *GuardrailPiiEntityFilter {
s.Match = &v
return s
}
// SetType sets the Type field's value.
func (s *GuardrailPiiEntityFilter) SetType(v string) *GuardrailPiiEntityFilter {
s.Type = &v
return s
}
// A Regex filter configured in a guardrail.
type GuardrailRegexFilter struct {
_ struct{} `type:"structure"`
// The region filter action.
//
// Action is a required field
Action *string `locationName:"action" type:"string" required:"true" enum:"GuardrailSensitiveInformationPolicyAction"`
// The regesx filter match.
Match *string `locationName:"match" type:"string"`
// The regex filter name.
Name *string `locationName:"name" type:"string"`
// The regex query.
Regex *string `locationName:"regex" type:"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 GuardrailRegexFilter) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailRegexFilter) GoString() string {
return s.String()
}
// SetAction sets the Action field's value.
func (s *GuardrailRegexFilter) SetAction(v string) *GuardrailRegexFilter {
s.Action = &v
return s
}
// SetMatch sets the Match field's value.
func (s *GuardrailRegexFilter) SetMatch(v string) *GuardrailRegexFilter {
s.Match = &v
return s
}
// SetName sets the Name field's value.
func (s *GuardrailRegexFilter) SetName(v string) *GuardrailRegexFilter {
s.Name = &v
return s
}
// SetRegex sets the Regex field's value.
func (s *GuardrailRegexFilter) SetRegex(v string) *GuardrailRegexFilter {
s.Regex = &v
return s
}
// The assessment for aPersonally Identifiable Information (PII) policy.
type GuardrailSensitiveInformationPolicyAssessment struct {
_ struct{} `type:"structure"`
// The PII entities in the assessment.
//
// PiiEntities is a required field
PiiEntities []*GuardrailPiiEntityFilter `locationName:"piiEntities" type:"list" required:"true"`
// The regex queries in the assessment.
//
// Regexes is a required field
Regexes []*GuardrailRegexFilter `locationName:"regexes" type:"list" required:"true"`
}
// 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 GuardrailSensitiveInformationPolicyAssessment) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailSensitiveInformationPolicyAssessment) GoString() string {
return s.String()
}
// SetPiiEntities sets the PiiEntities field's value.
func (s *GuardrailSensitiveInformationPolicyAssessment) SetPiiEntities(v []*GuardrailPiiEntityFilter) *GuardrailSensitiveInformationPolicyAssessment {
s.PiiEntities = v
return s
}
// SetRegexes sets the Regexes field's value.
func (s *GuardrailSensitiveInformationPolicyAssessment) SetRegexes(v []*GuardrailRegexFilter) *GuardrailSensitiveInformationPolicyAssessment {
s.Regexes = v
return s
}
// Configuration information for a guardrail that you use with the ConverseStream
// action.
type GuardrailStreamConfiguration struct {
_ struct{} `type:"structure"`
// The identifier for the guardrail.
//
// GuardrailIdentifier is a required field
GuardrailIdentifier *string `locationName:"guardrailIdentifier" type:"string" required:"true"`
// The version of the guardrail.
//
// GuardrailVersion is a required field
GuardrailVersion *string `locationName:"guardrailVersion" type:"string" required:"true"`
// The processing mode.
//
// The processing mode. For more information, see Configure streaming response
// behavior in the Amazon Bedrock User Guide.
StreamProcessingMode *string `locationName:"streamProcessingMode" type:"string" enum:"GuardrailStreamProcessingMode"`
// The trace behavior for the guardrail.
Trace *string `locationName:"trace" type:"string" enum:"GuardrailTrace"`
}
// 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 GuardrailStreamConfiguration) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailStreamConfiguration) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GuardrailStreamConfiguration) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GuardrailStreamConfiguration"}
if s.GuardrailIdentifier == nil {
invalidParams.Add(request.NewErrParamRequired("GuardrailIdentifier"))
}
if s.GuardrailVersion == nil {
invalidParams.Add(request.NewErrParamRequired("GuardrailVersion"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetGuardrailIdentifier sets the GuardrailIdentifier field's value.
func (s *GuardrailStreamConfiguration) SetGuardrailIdentifier(v string) *GuardrailStreamConfiguration {
s.GuardrailIdentifier = &v
return s
}
// SetGuardrailVersion sets the GuardrailVersion field's value.
func (s *GuardrailStreamConfiguration) SetGuardrailVersion(v string) *GuardrailStreamConfiguration {
s.GuardrailVersion = &v
return s
}
// SetStreamProcessingMode sets the StreamProcessingMode field's value.
func (s *GuardrailStreamConfiguration) SetStreamProcessingMode(v string) *GuardrailStreamConfiguration {
s.StreamProcessingMode = &v
return s
}
// SetTrace sets the Trace field's value.
func (s *GuardrailStreamConfiguration) SetTrace(v string) *GuardrailStreamConfiguration {
s.Trace = &v
return s
}
// The text block to be evaluated by the guardrail.
type GuardrailTextBlock struct {
_ struct{} `type:"structure"`
// The qualifiers describing the text block.
Qualifiers []*string `locationName:"qualifiers" type:"list" enum:"GuardrailContentQualifier"`
// The input text details to be evaluated by the guardrail.
//
// Text is a required field
Text *string `locationName:"text" type:"string" required:"true"`
}
// 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 GuardrailTextBlock) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailTextBlock) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GuardrailTextBlock) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GuardrailTextBlock"}
if s.Text == nil {
invalidParams.Add(request.NewErrParamRequired("Text"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetQualifiers sets the Qualifiers field's value.
func (s *GuardrailTextBlock) SetQualifiers(v []*string) *GuardrailTextBlock {
s.Qualifiers = v
return s
}
// SetText sets the Text field's value.
func (s *GuardrailTextBlock) SetText(v string) *GuardrailTextBlock {
s.Text = &v
return s
}
// Information about a topic guardrail.
type GuardrailTopic struct {
_ struct{} `type:"structure"`
// The action the guardrail should take when it intervenes on a topic.
//
// Action is a required field
Action *string `locationName:"action" type:"string" required:"true" enum:"GuardrailTopicPolicyAction"`
// The name for the guardrail.
//
// Name is a required field
Name *string `locationName:"name" type:"string" required:"true"`
// The type behavior that the guardrail should perform when the model detects
// the topic.
//
// Type is a required field
Type *string `locationName:"type" type:"string" required:"true" enum:"GuardrailTopicType"`
}
// 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 GuardrailTopic) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailTopic) GoString() string {
return s.String()
}
// SetAction sets the Action field's value.
func (s *GuardrailTopic) SetAction(v string) *GuardrailTopic {
s.Action = &v
return s
}
// SetName sets the Name field's value.
func (s *GuardrailTopic) SetName(v string) *GuardrailTopic {
s.Name = &v
return s
}
// SetType sets the Type field's value.
func (s *GuardrailTopic) SetType(v string) *GuardrailTopic {
s.Type = &v
return s
}
// A behavior assessment of a topic policy.
type GuardrailTopicPolicyAssessment struct {
_ struct{} `type:"structure"`
// The topics in the assessment.
//
// Topics is a required field
Topics []*GuardrailTopic `locationName:"topics" type:"list" required:"true"`
}
// 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 GuardrailTopicPolicyAssessment) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailTopicPolicyAssessment) GoString() string {
return s.String()
}
// SetTopics sets the Topics field's value.
func (s *GuardrailTopicPolicyAssessment) SetTopics(v []*GuardrailTopic) *GuardrailTopicPolicyAssessment {
s.Topics = v
return s
}
// A Top level guardrail trace object. For more information, see ConverseTrace.
type GuardrailTraceAssessment struct {
_ struct{} `type:"structure"`
// The input assessment.
InputAssessment map[string]*GuardrailAssessment `locationName:"inputAssessment" type:"map"`
// The output from the model.
ModelOutput []*string `locationName:"modelOutput" type:"list"`
// the output assessments.
OutputAssessments map[string][]*GuardrailAssessment `locationName:"outputAssessments" type:"map"`
}
// 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 GuardrailTraceAssessment) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailTraceAssessment) GoString() string {
return s.String()
}
// SetInputAssessment sets the InputAssessment field's value.
func (s *GuardrailTraceAssessment) SetInputAssessment(v map[string]*GuardrailAssessment) *GuardrailTraceAssessment {
s.InputAssessment = v
return s
}
// SetModelOutput sets the ModelOutput field's value.
func (s *GuardrailTraceAssessment) SetModelOutput(v []*string) *GuardrailTraceAssessment {
s.ModelOutput = v
return s
}
// SetOutputAssessments sets the OutputAssessments field's value.
func (s *GuardrailTraceAssessment) SetOutputAssessments(v map[string][]*GuardrailAssessment) *GuardrailTraceAssessment {
s.OutputAssessments = v
return s
}
// The details on the use of the guardrail.
type GuardrailUsage struct {
_ struct{} `type:"structure"`
// The content policy units processed by the guardrail.
//
// ContentPolicyUnits is a required field
ContentPolicyUnits *int64 `locationName:"contentPolicyUnits" type:"integer" required:"true"`
// The contextual grounding policy units processed by the guardrail.
//
// ContextualGroundingPolicyUnits is a required field
ContextualGroundingPolicyUnits *int64 `locationName:"contextualGroundingPolicyUnits" type:"integer" required:"true"`
// The sensitive information policy free units processed by the guardrail.
//
// SensitiveInformationPolicyFreeUnits is a required field
SensitiveInformationPolicyFreeUnits *int64 `locationName:"sensitiveInformationPolicyFreeUnits" type:"integer" required:"true"`
// The sensitive information policy units processed by the guardrail.
//
// SensitiveInformationPolicyUnits is a required field
SensitiveInformationPolicyUnits *int64 `locationName:"sensitiveInformationPolicyUnits" type:"integer" required:"true"`
// The topic policy units processed by the guardrail.
//
// TopicPolicyUnits is a required field
TopicPolicyUnits *int64 `locationName:"topicPolicyUnits" type:"integer" required:"true"`
// The word policy units processed by the guardrail.
//
// WordPolicyUnits is a required field
WordPolicyUnits *int64 `locationName:"wordPolicyUnits" type:"integer" required:"true"`
}
// 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 GuardrailUsage) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailUsage) GoString() string {
return s.String()
}
// SetContentPolicyUnits sets the ContentPolicyUnits field's value.
func (s *GuardrailUsage) SetContentPolicyUnits(v int64) *GuardrailUsage {
s.ContentPolicyUnits = &v
return s
}
// SetContextualGroundingPolicyUnits sets the ContextualGroundingPolicyUnits field's value.
func (s *GuardrailUsage) SetContextualGroundingPolicyUnits(v int64) *GuardrailUsage {
s.ContextualGroundingPolicyUnits = &v
return s
}
// SetSensitiveInformationPolicyFreeUnits sets the SensitiveInformationPolicyFreeUnits field's value.
func (s *GuardrailUsage) SetSensitiveInformationPolicyFreeUnits(v int64) *GuardrailUsage {
s.SensitiveInformationPolicyFreeUnits = &v
return s
}
// SetSensitiveInformationPolicyUnits sets the SensitiveInformationPolicyUnits field's value.
func (s *GuardrailUsage) SetSensitiveInformationPolicyUnits(v int64) *GuardrailUsage {
s.SensitiveInformationPolicyUnits = &v
return s
}
// SetTopicPolicyUnits sets the TopicPolicyUnits field's value.
func (s *GuardrailUsage) SetTopicPolicyUnits(v int64) *GuardrailUsage {
s.TopicPolicyUnits = &v
return s
}
// SetWordPolicyUnits sets the WordPolicyUnits field's value.
func (s *GuardrailUsage) SetWordPolicyUnits(v int64) *GuardrailUsage {
s.WordPolicyUnits = &v
return s
}
// The word policy assessment.
type GuardrailWordPolicyAssessment struct {
_ struct{} `type:"structure"`
// Custom words in the assessment.
//
// CustomWords is a required field
CustomWords []*GuardrailCustomWord `locationName:"customWords" type:"list" required:"true"`
// Managed word lists in the assessment.
//
// ManagedWordLists is a required field
ManagedWordLists []*GuardrailManagedWord `locationName:"managedWordLists" type:"list" required:"true"`
}
// 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 GuardrailWordPolicyAssessment) String() string {
return awsutil.Prettify(s)
}
// 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 GuardrailWordPolicyAssessment) GoString() string {
return s.String()
}
// SetCustomWords sets the CustomWords field's value.
func (s *GuardrailWordPolicyAssessment) SetCustomWords(v []*GuardrailCustomWord) *GuardrailWordPolicyAssessment {
s.CustomWords = v
return s
}
// SetManagedWordLists sets the ManagedWordLists field's value.
func (s *GuardrailWordPolicyAssessment) SetManagedWordLists(v []*GuardrailManagedWord) *GuardrailWordPolicyAssessment {
s.ManagedWordLists = v
return s
}
// Image content for a message.
type ImageBlock struct {
_ struct{} `type:"structure"`
// The format of the image.
//
// Format is a required field
Format *string `locationName:"format" type:"string" required:"true" enum:"ImageFormat"`
// The source for the image.
//
// Source is a required field
Source *ImageSource `locationName:"source" type:"structure" required:"true"`
}
// 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 ImageBlock) String() string {
return awsutil.Prettify(s)
}
// 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 ImageBlock) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ImageBlock) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ImageBlock"}
if s.Format == nil {
invalidParams.Add(request.NewErrParamRequired("Format"))
}
if s.Source == nil {
invalidParams.Add(request.NewErrParamRequired("Source"))
}
if s.Source != nil {
if err := s.Source.Validate(); err != nil {
invalidParams.AddNested("Source", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFormat sets the Format field's value.
func (s *ImageBlock) SetFormat(v string) *ImageBlock {
s.Format = &v
return s
}
// SetSource sets the Source field's value.
func (s *ImageBlock) SetSource(v *ImageSource) *ImageBlock {
s.Source = v
return s
}
// The source for an image.
type ImageSource struct {
_ struct{} `type:"structure"`
// The raw image bytes for the image. If you use an AWS SDK, you don't need
// to encode the image bytes in base64.
// Bytes is automatically base64 encoded/decoded by the SDK.
Bytes []byte `locationName:"bytes" min:"1" type:"blob"`
}
// 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 ImageSource) String() string {
return awsutil.Prettify(s)
}
// 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 ImageSource) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ImageSource) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ImageSource"}
if s.Bytes != nil && len(s.Bytes) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Bytes", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetBytes sets the Bytes field's value.
func (s *ImageSource) SetBytes(v []byte) *ImageSource {
s.Bytes = v
return s
}
// Base inference parameters to pass to a model in a call to Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html)
// or ConverseStream (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html).
// For more information, see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
//
// If you need to pass additional parameters that the model supports, use the
// additionalModelRequestFields request field in the call to Converse or ConverseStream.
// For more information, see Model parameters (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
type InferenceConfiguration struct {
_ struct{} `type:"structure"`
// The maximum number of tokens to allow in the generated response. The default
// value is the maximum allowed value for the model that you are using. For
// more information, see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
MaxTokens *int64 `locationName:"maxTokens" min:"1" 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.
//
// The default value is the default value for the model that you are using.
// For more information, see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
Temperature *float64 `locationName:"temperature" type:"float"`
// The percentage of most-likely candidates that the model considers for the
// next token. For example, if you choose a value of 0.8 for topP, the model
// selects from the top 80% of the probability distribution of tokens that could
// be next in the sequence.
//
// The default value is the default value for the model that you are using.
// For more information, see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
TopP *float64 `locationName:"topP" type:"float"`
}
// 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 InferenceConfiguration) String() string {
return awsutil.Prettify(s)
}
// 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) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *InferenceConfiguration) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "InferenceConfiguration"}
if s.MaxTokens != nil && *s.MaxTokens < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxTokens", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMaxTokens sets the MaxTokens field's value.
func (s *InferenceConfiguration) SetMaxTokens(v int64) *InferenceConfiguration {
s.MaxTokens = &v
return s
}
// SetStopSequences sets the StopSequences field's value.
func (s *InferenceConfiguration) SetStopSequences(v []*string) *InferenceConfiguration {
s.StopSequences = v
return s
}
// SetTemperature sets the Temperature field's value.
func (s *InferenceConfiguration) SetTemperature(v float64) *InferenceConfiguration {
s.Temperature = &v
return s
}
// SetTopP sets the TopP field's value.
func (s *InferenceConfiguration) SetTopP(v float64) *InferenceConfiguration {
s.TopP = &v
return s
}
// An internal server error occurred. Retry your request.
type InternalServerException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"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) String() string {
return awsutil.Prettify(s)
}
// 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) GoString() string {
return s.String()
}
// The InternalServerException is and event in the ConverseStreamOutput_ group of events.
func (s *InternalServerException) eventConverseStreamOutput_() {}
// The InternalServerException is and event in the ResponseStream group of events.
func (s *InternalServerException) eventResponseStream() {}
// UnmarshalEvent unmarshals the EventStream Message into the InternalServerException value.
// This method is only used internally within the SDK's EventStream handling.
func (s *InternalServerException) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
if err := payloadUnmarshaler.UnmarshalPayload(
bytes.NewReader(msg.Payload), s,
); err != nil {
return err
}
return nil
}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (s *InternalServerException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error) {
msg.Headers.Set(eventstreamapi.MessageTypeHeader, eventstream.StringValue(eventstreamapi.ExceptionMessageType))
var buf bytes.Buffer
if err = pm.MarshalPayload(&buf, s); err != nil {
return eventstream.Message{}, err
}
msg.Payload = buf.Bytes()
return msg, err
}
func newErrorInternalServerException(v protocol.ResponseMetadata) error {
return &InternalServerException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *InternalServerException) Code() string {
return "InternalServerException"
}
// Message returns the exception's message.
func (s *InternalServerException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalServerException) OrigErr() error {
return nil
}
func (s *InternalServerException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *InternalServerException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *InternalServerException) RequestID() string {
return s.RespMetadata.RequestID
}
type InvokeModelInput struct {
_ struct{} `type:"structure" payload:"Body"`
// The desired MIME type of the inference body in the response. The default
// value is application/json.
Accept *string `location:"header" locationName:"Accept" type:"string"`
// The prompt and inference parameters in the format specified in the contentType
// in the header. You must provide the body in JSON format. To see the format
// and content of the request and response bodies for different models, refer
// to Inference parameters (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
// For more information, see Run inference (https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html)
// in the Bedrock User Guide.
//
// Body is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by InvokeModelInput's
// String and GoString methods.
//
// Body is a required field
Body []byte `locationName:"body" type:"blob" required:"true" sensitive:"true"`
// The MIME type of the input data in the request. You must specify application/json.
ContentType *string `location:"header" locationName:"Content-Type" type:"string"`
// The unique identifier of the guardrail that you want to use. If you don't
// provide a value, no guardrail is applied to the invocation.
//
// An error will be thrown in the following situations.
//
// * You don't provide a guardrail identifier but you specify the amazon-bedrock-guardrailConfig
// field in the request body.
//
// * You enable the guardrail but the contentType isn't application/json.
//
// * You provide a guardrail identifier, but guardrailVersion isn't specified.
GuardrailIdentifier *string `location:"header" locationName:"X-Amzn-Bedrock-GuardrailIdentifier" type:"string"`
// The version number for the guardrail. The value can also be DRAFT.
GuardrailVersion *string `location:"header" locationName:"X-Amzn-Bedrock-GuardrailVersion" type:"string"`
// The unique identifier of the model to invoke to run inference.
//
// The modelId to provide depends on the type of model that you use:
//
// * If you use a base model, specify the model ID or its ARN. For a list
// of model IDs for base models, see Amazon Bedrock base model IDs (on-demand
// throughput) (https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns)
// in the Amazon Bedrock User Guide.
//
// * If you use a provisioned model, specify the ARN of the Provisioned Throughput.
// For more information, see Run inference using a Provisioned Throughput
// (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html)
// in the Amazon Bedrock User Guide.
//
// * If you use a custom model, first purchase Provisioned Throughput for
// it. Then specify the ARN of the resulting provisioned model. For more
// information, see Use a custom model in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html)
// in the Amazon Bedrock User Guide.
//
// ModelId is a required field
ModelId *string `location:"uri" locationName:"modelId" min:"1" type:"string" required:"true"`
// Specifies whether to enable or disable the Bedrock trace. If enabled, you
// can see the full Bedrock trace.
Trace *string `location:"header" locationName:"X-Amzn-Bedrock-Trace" type:"string" enum:"Trace"`
}
// 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 InvokeModelInput) String() string {
return awsutil.Prettify(s)
}
// 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 InvokeModelInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *InvokeModelInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "InvokeModelInput"}
if s.Body == nil {
invalidParams.Add(request.NewErrParamRequired("Body"))
}
if s.ModelId == nil {
invalidParams.Add(request.NewErrParamRequired("ModelId"))
}
if s.ModelId != nil && len(*s.ModelId) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ModelId", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAccept sets the Accept field's value.
func (s *InvokeModelInput) SetAccept(v string) *InvokeModelInput {
s.Accept = &v
return s
}
// SetBody sets the Body field's value.
func (s *InvokeModelInput) SetBody(v []byte) *InvokeModelInput {
s.Body = v
return s
}
// SetContentType sets the ContentType field's value.
func (s *InvokeModelInput) SetContentType(v string) *InvokeModelInput {
s.ContentType = &v
return s
}
// SetGuardrailIdentifier sets the GuardrailIdentifier field's value.
func (s *InvokeModelInput) SetGuardrailIdentifier(v string) *InvokeModelInput {
s.GuardrailIdentifier = &v
return s
}
// SetGuardrailVersion sets the GuardrailVersion field's value.
func (s *InvokeModelInput) SetGuardrailVersion(v string) *InvokeModelInput {
s.GuardrailVersion = &v
return s
}
// SetModelId sets the ModelId field's value.
func (s *InvokeModelInput) SetModelId(v string) *InvokeModelInput {
s.ModelId = &v
return s
}
// SetTrace sets the Trace field's value.
func (s *InvokeModelInput) SetTrace(v string) *InvokeModelInput {
s.Trace = &v
return s
}
type InvokeModelOutput struct {
_ struct{} `type:"structure" payload:"Body"`
// Inference response from the model in the format specified in the contentType
// header. To see the format and content of the request and response bodies
// for different models, refer to Inference parameters (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
//
// Body is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by InvokeModelOutput's
// String and GoString methods.
//
// Body is a required field
Body []byte `locationName:"body" type:"blob" required:"true" sensitive:"true"`
// The MIME type of the inference result.
//
// ContentType is a required field
ContentType *string `location:"header" locationName:"Content-Type" type:"string" required:"true"`
}
// 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 InvokeModelOutput) String() string {
return awsutil.Prettify(s)
}
// 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 InvokeModelOutput) GoString() string {
return s.String()
}
// SetBody sets the Body field's value.
func (s *InvokeModelOutput) SetBody(v []byte) *InvokeModelOutput {
s.Body = v
return s
}
// SetContentType sets the ContentType field's value.
func (s *InvokeModelOutput) SetContentType(v string) *InvokeModelOutput {
s.ContentType = &v
return s
}
type InvokeModelWithResponseStreamInput struct {
_ struct{} `type:"structure" payload:"Body"`
// The desired MIME type of the inference body in the response. The default
// value is application/json.
Accept *string `location:"header" locationName:"X-Amzn-Bedrock-Accept" type:"string"`
// The prompt and inference parameters in the format specified in the contentType
// in the header. You must provide the body in JSON format. To see the format
// and content of the request and response bodies for different models, refer
// to Inference parameters (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
// For more information, see Run inference (https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html)
// in the Bedrock User Guide.
//
// Body is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by InvokeModelWithResponseStreamInput's
// String and GoString methods.
//
// Body is a required field
Body []byte `locationName:"body" type:"blob" required:"true" sensitive:"true"`
// The MIME type of the input data in the request. You must specify application/json.
ContentType *string `location:"header" locationName:"Content-Type" type:"string"`
// The unique identifier of the guardrail that you want to use. If you don't
// provide a value, no guardrail is applied to the invocation.
//
// An error is thrown in the following situations.
//
// * You don't provide a guardrail identifier but you specify the amazon-bedrock-guardrailConfig
// field in the request body.
//
// * You enable the guardrail but the contentType isn't application/json.
//
// * You provide a guardrail identifier, but guardrailVersion isn't specified.
GuardrailIdentifier *string `location:"header" locationName:"X-Amzn-Bedrock-GuardrailIdentifier" type:"string"`
// The version number for the guardrail. The value can also be DRAFT.
GuardrailVersion *string `location:"header" locationName:"X-Amzn-Bedrock-GuardrailVersion" type:"string"`
// The unique identifier of the model to invoke to run inference.
//
// The modelId to provide depends on the type of model that you use:
//
// * If you use a base model, specify the model ID or its ARN. For a list
// of model IDs for base models, see Amazon Bedrock base model IDs (on-demand
// throughput) (https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns)
// in the Amazon Bedrock User Guide.
//
// * If you use a provisioned model, specify the ARN of the Provisioned Throughput.
// For more information, see Run inference using a Provisioned Throughput
// (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html)
// in the Amazon Bedrock User Guide.
//
// * If you use a custom model, first purchase Provisioned Throughput for
// it. Then specify the ARN of the resulting provisioned model. For more
// information, see Use a custom model in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html)
// in the Amazon Bedrock User Guide.
//
// ModelId is a required field
ModelId *string `location:"uri" locationName:"modelId" min:"1" type:"string" required:"true"`
// Specifies whether to enable or disable the Bedrock trace. If enabled, you
// can see the full Bedrock trace.
Trace *string `location:"header" locationName:"X-Amzn-Bedrock-Trace" type:"string" enum:"Trace"`
}
// 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 InvokeModelWithResponseStreamInput) String() string {
return awsutil.Prettify(s)
}
// 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 InvokeModelWithResponseStreamInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *InvokeModelWithResponseStreamInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "InvokeModelWithResponseStreamInput"}
if s.Body == nil {
invalidParams.Add(request.NewErrParamRequired("Body"))
}
if s.ModelId == nil {
invalidParams.Add(request.NewErrParamRequired("ModelId"))
}
if s.ModelId != nil && len(*s.ModelId) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ModelId", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAccept sets the Accept field's value.
func (s *InvokeModelWithResponseStreamInput) SetAccept(v string) *InvokeModelWithResponseStreamInput {
s.Accept = &v
return s
}
// SetBody sets the Body field's value.
func (s *InvokeModelWithResponseStreamInput) SetBody(v []byte) *InvokeModelWithResponseStreamInput {
s.Body = v
return s
}
// SetContentType sets the ContentType field's value.
func (s *InvokeModelWithResponseStreamInput) SetContentType(v string) *InvokeModelWithResponseStreamInput {
s.ContentType = &v
return s
}
// SetGuardrailIdentifier sets the GuardrailIdentifier field's value.
func (s *InvokeModelWithResponseStreamInput) SetGuardrailIdentifier(v string) *InvokeModelWithResponseStreamInput {
s.GuardrailIdentifier = &v
return s
}
// SetGuardrailVersion sets the GuardrailVersion field's value.
func (s *InvokeModelWithResponseStreamInput) SetGuardrailVersion(v string) *InvokeModelWithResponseStreamInput {
s.GuardrailVersion = &v
return s
}
// SetModelId sets the ModelId field's value.
func (s *InvokeModelWithResponseStreamInput) SetModelId(v string) *InvokeModelWithResponseStreamInput {
s.ModelId = &v
return s
}
// SetTrace sets the Trace field's value.
func (s *InvokeModelWithResponseStreamInput) SetTrace(v string) *InvokeModelWithResponseStreamInput {
s.Trace = &v
return s
}
type InvokeModelWithResponseStreamOutput struct {
_ struct{} `type:"structure" payload:"Body"`
eventStream *InvokeModelWithResponseStreamEventStream
// The MIME type of the inference result.
//
// ContentType is a required field
ContentType *string `location:"header" locationName:"X-Amzn-Bedrock-Content-Type" type:"string" required:"true"`
}
// 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 InvokeModelWithResponseStreamOutput) String() string {
return awsutil.Prettify(s)
}
// 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 InvokeModelWithResponseStreamOutput) GoString() string {
return s.String()
}
// SetContentType sets the ContentType field's value.
func (s *InvokeModelWithResponseStreamOutput) SetContentType(v string) *InvokeModelWithResponseStreamOutput {
s.ContentType = &v
return s
}
// GetStream returns the type to interact with the event stream.
func (s *InvokeModelWithResponseStreamOutput) GetStream() *InvokeModelWithResponseStreamEventStream {
return s.eventStream
}
// A message input, or returned from, a call to Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html)
// or ConverseStream (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html).
type Message struct {
_ struct{} `type:"structure"`
// The message content. Note the following restrictions:
//
// * You can include up to 20 images. Each image's size, height, and width
// must be no more than 3.75 MB, 8000 px, and 8000 px, respectively.
//
// * You can include up to five documents. Each document's size must be no
// more than 4.5 MB.
//
// * If you include a ContentBlock with a document field in the array, you
// must also include a ContentBlock with a text field.
//
// * You can only include images and documents if the role is user.
//
// Content is a required field
Content []*ContentBlock `locationName:"content" type:"list" required:"true"`
// The role that the message plays in the message.
//
// Role is a required field
Role *string `locationName:"role" type:"string" required:"true" enum:"ConversationRole"`
}
// 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 Message) String() string {
return awsutil.Prettify(s)
}
// 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 Message) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *Message) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "Message"}
if s.Content == nil {
invalidParams.Add(request.NewErrParamRequired("Content"))
}
if s.Role == nil {
invalidParams.Add(request.NewErrParamRequired("Role"))
}
if s.Content != nil {
for i, v := range s.Content {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Content", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetContent sets the Content field's value.
func (s *Message) SetContent(v []*ContentBlock) *Message {
s.Content = v
return s
}
// SetRole sets the Role field's value.
func (s *Message) SetRole(v string) *Message {
s.Role = &v
return s
}
// The start of a message.
type MessageStartEvent struct {
_ struct{} `type:"structure"`
// The role for the message.
//
// Role is a required field
Role *string `locationName:"role" type:"string" required:"true" enum:"ConversationRole"`
}
// 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 MessageStartEvent) String() string {
return awsutil.Prettify(s)
}
// 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 MessageStartEvent) GoString() string {
return s.String()
}
// SetRole sets the Role field's value.
func (s *MessageStartEvent) SetRole(v string) *MessageStartEvent {
s.Role = &v
return s
}
// The MessageStartEvent is and event in the ConverseStreamOutput_ group of events.
func (s *MessageStartEvent) eventConverseStreamOutput_() {}
// UnmarshalEvent unmarshals the EventStream Message into the MessageStartEvent value.
// This method is only used internally within the SDK's EventStream handling.
func (s *MessageStartEvent) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
if err := payloadUnmarshaler.UnmarshalPayload(
bytes.NewReader(msg.Payload), s,
); err != nil {
return err
}
return nil
}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (s *MessageStartEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error) {
msg.Headers.Set(eventstreamapi.MessageTypeHeader, eventstream.StringValue(eventstreamapi.EventMessageType))
var buf bytes.Buffer
if err = pm.MarshalPayload(&buf, s); err != nil {
return eventstream.Message{}, err
}
msg.Payload = buf.Bytes()
return msg, err
}
// The stop event for a message.
type MessageStopEvent struct {
_ struct{} `type:"structure"`
// The reason why the model stopped generating output.
//
// StopReason is a required field
StopReason *string `locationName:"stopReason" type:"string" required:"true" enum:"StopReason"`
}
// 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 MessageStopEvent) String() string {
return awsutil.Prettify(s)
}
// 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 MessageStopEvent) GoString() string {
return s.String()
}
// SetStopReason sets the StopReason field's value.
func (s *MessageStopEvent) SetStopReason(v string) *MessageStopEvent {
s.StopReason = &v
return s
}
// The MessageStopEvent is and event in the ConverseStreamOutput_ group of events.
func (s *MessageStopEvent) eventConverseStreamOutput_() {}
// UnmarshalEvent unmarshals the EventStream Message into the MessageStopEvent value.
// This method is only used internally within the SDK's EventStream handling.
func (s *MessageStopEvent) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
if err := payloadUnmarshaler.UnmarshalPayload(
bytes.NewReader(msg.Payload), s,
); err != nil {
return err
}
return nil
}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (s *MessageStopEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error) {
msg.Headers.Set(eventstreamapi.MessageTypeHeader, eventstream.StringValue(eventstreamapi.EventMessageType))
var buf bytes.Buffer
if err = pm.MarshalPayload(&buf, s); err != nil {
return eventstream.Message{}, err
}
msg.Payload = buf.Bytes()
return msg, err
}
// The request failed due to an error while processing the model.
type ModelErrorException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// The original status code.
OriginalStatusCode *int64 `locationName:"originalStatusCode" min:"100" type:"integer"`
// The resource name.
ResourceName *string `locationName:"resourceName" type:"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 ModelErrorException) String() string {
return awsutil.Prettify(s)
}
// 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 ModelErrorException) GoString() string {
return s.String()
}
func newErrorModelErrorException(v protocol.ResponseMetadata) error {
return &ModelErrorException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ModelErrorException) Code() string {
return "ModelErrorException"
}
// Message returns the exception's message.
func (s *ModelErrorException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ModelErrorException) OrigErr() error {
return nil
}
func (s *ModelErrorException) Error() string {
return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ModelErrorException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ModelErrorException) RequestID() string {
return s.RespMetadata.RequestID
}
// The model specified in the request is not ready to serve inference requests.
type ModelNotReadyException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"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 ModelNotReadyException) String() string {
return awsutil.Prettify(s)
}
// 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 ModelNotReadyException) GoString() string {
return s.String()
}
func newErrorModelNotReadyException(v protocol.ResponseMetadata) error {
return &ModelNotReadyException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ModelNotReadyException) Code() string {
return "ModelNotReadyException"
}
// Message returns the exception's message.
func (s *ModelNotReadyException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ModelNotReadyException) OrigErr() error {
return nil
}
func (s *ModelNotReadyException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ModelNotReadyException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ModelNotReadyException) RequestID() string {
return s.RespMetadata.RequestID
}
// An error occurred while streaming the response. Retry your request.
type ModelStreamErrorException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
// The original message.
OriginalMessage *string `locationName:"originalMessage" type:"string"`
// The original status code.
OriginalStatusCode *int64 `locationName:"originalStatusCode" min:"100" type:"integer"`
}
// 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 ModelStreamErrorException) String() string {
return awsutil.Prettify(s)
}
// 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 ModelStreamErrorException) GoString() string {
return s.String()
}
// The ModelStreamErrorException is and event in the ConverseStreamOutput_ group of events.
func (s *ModelStreamErrorException) eventConverseStreamOutput_() {}
// The ModelStreamErrorException is and event in the ResponseStream group of events.
func (s *ModelStreamErrorException) eventResponseStream() {}
// UnmarshalEvent unmarshals the EventStream Message into the ModelStreamErrorException value.
// This method is only used internally within the SDK's EventStream handling.
func (s *ModelStreamErrorException) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
if err := payloadUnmarshaler.UnmarshalPayload(
bytes.NewReader(msg.Payload), s,
); err != nil {
return err
}
return nil
}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (s *ModelStreamErrorException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error) {
msg.Headers.Set(eventstreamapi.MessageTypeHeader, eventstream.StringValue(eventstreamapi.ExceptionMessageType))
var buf bytes.Buffer
if err = pm.MarshalPayload(&buf, s); err != nil {
return eventstream.Message{}, err
}
msg.Payload = buf.Bytes()
return msg, err
}
func newErrorModelStreamErrorException(v protocol.ResponseMetadata) error {
return &ModelStreamErrorException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ModelStreamErrorException) Code() string {
return "ModelStreamErrorException"
}
// Message returns the exception's message.
func (s *ModelStreamErrorException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ModelStreamErrorException) OrigErr() error {
return nil
}
func (s *ModelStreamErrorException) Error() string {
return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ModelStreamErrorException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ModelStreamErrorException) RequestID() string {
return s.RespMetadata.RequestID
}
// The request took too long to process. Processing time exceeded the model
// timeout length.
type ModelTimeoutException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"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 ModelTimeoutException) String() string {
return awsutil.Prettify(s)
}
// 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 ModelTimeoutException) GoString() string {
return s.String()
}
// The ModelTimeoutException is and event in the ResponseStream group of events.
func (s *ModelTimeoutException) eventResponseStream() {}
// UnmarshalEvent unmarshals the EventStream Message into the ModelTimeoutException value.
// This method is only used internally within the SDK's EventStream handling.
func (s *ModelTimeoutException) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
if err := payloadUnmarshaler.UnmarshalPayload(
bytes.NewReader(msg.Payload), s,
); err != nil {
return err
}
return nil
}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (s *ModelTimeoutException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error) {
msg.Headers.Set(eventstreamapi.MessageTypeHeader, eventstream.StringValue(eventstreamapi.ExceptionMessageType))
var buf bytes.Buffer
if err = pm.MarshalPayload(&buf, s); err != nil {
return eventstream.Message{}, err
}
msg.Payload = buf.Bytes()
return msg, err
}
func newErrorModelTimeoutException(v protocol.ResponseMetadata) error {
return &ModelTimeoutException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ModelTimeoutException) Code() string {
return "ModelTimeoutException"
}
// Message returns the exception's message.
func (s *ModelTimeoutException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ModelTimeoutException) OrigErr() error {
return nil
}
func (s *ModelTimeoutException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ModelTimeoutException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ModelTimeoutException) RequestID() string {
return s.RespMetadata.RequestID
}
// Payload content included in the response.
type PayloadPart struct {
_ struct{} `type:"structure" sensitive:"true"`
// Base64-encoded bytes of payload data.
//
// 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"`
}
// 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) String() string {
return awsutil.Prettify(s)
}
// 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) GoString() string {
return s.String()
}
// SetBytes sets the Bytes field's value.
func (s *PayloadPart) SetBytes(v []byte) *PayloadPart {
s.Bytes = v
return s
}
// The PayloadPart is and event in the ResponseStream group of events.
func (s *PayloadPart) eventResponseStream() {}
// UnmarshalEvent unmarshals the EventStream Message into the PayloadPart value.
// This method is only used internally within the SDK's EventStream handling.
func (s *PayloadPart) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
if err := payloadUnmarshaler.UnmarshalPayload(
bytes.NewReader(msg.Payload), s,
); err != nil {
return err
}
return nil
}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (s *PayloadPart) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error) {
msg.Headers.Set(eventstreamapi.MessageTypeHeader, eventstream.StringValue(eventstreamapi.EventMessageType))
var buf bytes.Buffer
if err = pm.MarshalPayload(&buf, s); err != nil {
return eventstream.Message{}, err
}
msg.Payload = buf.Bytes()
return msg, err
}
// The specified resource ARN was not found. Check the ARN and try your request
// again.
type ResourceNotFoundException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"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) String() string {
return awsutil.Prettify(s)
}
// 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) GoString() string {
return s.String()
}
func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error {
return &ResourceNotFoundException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ResourceNotFoundException) Code() string {
return "ResourceNotFoundException"
}
// Message returns the exception's message.
func (s *ResourceNotFoundException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) OrigErr() error {
return nil
}
func (s *ResourceNotFoundException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ResourceNotFoundException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) RequestID() string {
return s.RespMetadata.RequestID
}
// ResponseStreamEvent groups together all EventStream
// events writes for ResponseStream.
//
// These events are:
//
// - PayloadPart
type ResponseStreamEvent interface {
eventResponseStream()
eventstreamapi.Marshaler
eventstreamapi.Unmarshaler
}
// ResponseStreamReader provides the interface for reading to the stream. The
// default implementation for this interface will be ResponseStream.
//
// The reader's Close method must allow multiple concurrent calls.
//
// These events are:
//
// - PayloadPart
// - ResponseStreamUnknownEvent
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
}
type readResponseStream struct {
eventReader *eventstreamapi.EventReader
stream chan ResponseStreamEvent
err *eventstreamapi.OnceError
done chan struct{}
closeOnce sync.Once
}
func newReadResponseStream(eventReader *eventstreamapi.EventReader) *readResponseStream {
r := &readResponseStream{
eventReader: eventReader,
stream: make(chan ResponseStreamEvent),
done: make(chan struct{}),
err: eventstreamapi.NewOnceError(),
}
go r.readEventStream()
return r
}
// Close will close the underlying event stream reader.
func (r *readResponseStream) Close() error {
r.closeOnce.Do(r.safeClose)
return r.Err()
}
func (r *readResponseStream) ErrorSet() <-chan struct{} {
return r.err.ErrorSet()
}
func (r *readResponseStream) Closed() <-chan struct{} {
return r.done
}
func (r *readResponseStream) safeClose() {
close(r.done)
}
func (r *readResponseStream) Err() error {
return r.err.Err()
}
func (r *readResponseStream) Events() <-chan ResponseStreamEvent {
return r.stream
}
func (r *readResponseStream) readEventStream() {
defer r.Close()
defer close(r.stream)
for {
event, err := r.eventReader.ReadEvent()
if err != nil {
if err == io.EOF {
return
}
select {
case <-r.done:
// If closed already ignore the error
return
default:
}
if _, ok := err.(*eventstreamapi.UnknownMessageTypeError); ok {
continue
}
r.err.SetError(err)
return
}
select {
case r.stream <- event.(ResponseStreamEvent):
case <-r.done:
return
}
}
}
type unmarshalerForResponseStreamEvent struct {
metadata protocol.ResponseMetadata
}
func (u unmarshalerForResponseStreamEvent) UnmarshalerForEventName(eventType string) (eventstreamapi.Unmarshaler, error) {
switch eventType {
case "chunk":
return &PayloadPart{}, nil
case "internalServerException":
return newErrorInternalServerException(u.metadata).(eventstreamapi.Unmarshaler), nil
case "modelStreamErrorException":
return newErrorModelStreamErrorException(u.metadata).(eventstreamapi.Unmarshaler), nil
case "modelTimeoutException":
return newErrorModelTimeoutException(u.metadata).(eventstreamapi.Unmarshaler), nil
case "serviceUnavailableException":
return newErrorServiceUnavailableException(u.metadata).(eventstreamapi.Unmarshaler), nil
case "throttlingException":
return newErrorThrottlingException(u.metadata).(eventstreamapi.Unmarshaler), nil
case "validationException":
return newErrorValidationException(u.metadata).(eventstreamapi.Unmarshaler), nil
default:
return &ResponseStreamUnknownEvent{Type: eventType}, nil
}
}
// ResponseStreamUnknownEvent provides a failsafe event for the
// ResponseStream group of events when an unknown event is received.
type ResponseStreamUnknownEvent struct {
Type string
Message eventstream.Message
}
// The ResponseStreamUnknownEvent is and event in the ResponseStream
// group of events.
func (s *ResponseStreamUnknownEvent) eventResponseStream() {}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (e *ResponseStreamUnknownEvent) MarshalEvent(pm protocol.PayloadMarshaler) (
msg eventstream.Message, err error,
) {
return e.Message.Clone(), nil
}
// UnmarshalEvent unmarshals the EventStream Message into the ResponseStream value.
// This method is only used internally within the SDK's EventStream handling.
func (e *ResponseStreamUnknownEvent) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
e.Message = msg.Clone()
return nil
}
// Your request exceeds the service quota for your account. You can view your
// quotas at Viewing service quotas (https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html).
// You can resubmit your request later.
type ServiceQuotaExceededException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"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) String() string {
return awsutil.Prettify(s)
}
// 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) GoString() string {
return s.String()
}
func newErrorServiceQuotaExceededException(v protocol.ResponseMetadata) error {
return &ServiceQuotaExceededException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ServiceQuotaExceededException) Code() string {
return "ServiceQuotaExceededException"
}
// Message returns the exception's message.
func (s *ServiceQuotaExceededException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceQuotaExceededException) OrigErr() error {
return nil
}
func (s *ServiceQuotaExceededException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ServiceQuotaExceededException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ServiceQuotaExceededException) RequestID() string {
return s.RespMetadata.RequestID
}
// The service isn't currently available. Try again later.
type ServiceUnavailableException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"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 ServiceUnavailableException) String() string {
return awsutil.Prettify(s)
}
// 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 ServiceUnavailableException) GoString() string {
return s.String()
}
// The ServiceUnavailableException is and event in the ConverseStreamOutput_ group of events.
func (s *ServiceUnavailableException) eventConverseStreamOutput_() {}
// The ServiceUnavailableException is and event in the ResponseStream group of events.
func (s *ServiceUnavailableException) eventResponseStream() {}
// UnmarshalEvent unmarshals the EventStream Message into the ServiceUnavailableException value.
// This method is only used internally within the SDK's EventStream handling.
func (s *ServiceUnavailableException) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
if err := payloadUnmarshaler.UnmarshalPayload(
bytes.NewReader(msg.Payload), s,
); err != nil {
return err
}
return nil
}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (s *ServiceUnavailableException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error) {
msg.Headers.Set(eventstreamapi.MessageTypeHeader, eventstream.StringValue(eventstreamapi.ExceptionMessageType))
var buf bytes.Buffer
if err = pm.MarshalPayload(&buf, s); err != nil {
return eventstream.Message{}, err
}
msg.Payload = buf.Bytes()
return msg, err
}
func newErrorServiceUnavailableException(v protocol.ResponseMetadata) error {
return &ServiceUnavailableException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ServiceUnavailableException) Code() string {
return "ServiceUnavailableException"
}
// Message returns the exception's message.
func (s *ServiceUnavailableException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceUnavailableException) OrigErr() error {
return nil
}
func (s *ServiceUnavailableException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ServiceUnavailableException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ServiceUnavailableException) RequestID() string {
return s.RespMetadata.RequestID
}
// The model must request a specific tool. For example, {"tool" : {"name" :
// "Your tool name"}}.
//
// This field is only supported by Anthropic Claude 3 models.
type SpecificToolChoice struct {
_ struct{} `type:"structure"`
// The name of the tool that the model must request.
//
// Name is a required field
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
}
// 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 SpecificToolChoice) String() string {
return awsutil.Prettify(s)
}
// 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 SpecificToolChoice) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *SpecificToolChoice) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "SpecificToolChoice"}
if s.Name == nil {
invalidParams.Add(request.NewErrParamRequired("Name"))
}
if s.Name != nil && len(*s.Name) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Name", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetName sets the Name field's value.
func (s *SpecificToolChoice) SetName(v string) *SpecificToolChoice {
s.Name = &v
return s
}
// A system content block.
type SystemContentBlock struct {
_ struct{} `type:"structure"`
// A content block to assess with the guardrail. Use with the Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html)
// or ConverseStream (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html)
// API operations.
//
// For more information, see Use a guardrail with the Converse API in the Amazon
// Bedrock User Guide.
GuardContent *GuardrailConverseContentBlock `locationName:"guardContent" type:"structure"`
// A system prompt for the model.
Text *string `locationName:"text" min:"1" type:"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 SystemContentBlock) String() string {
return awsutil.Prettify(s)
}
// 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 SystemContentBlock) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *SystemContentBlock) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "SystemContentBlock"}
if s.Text != nil && len(*s.Text) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Text", 1))
}
if s.GuardContent != nil {
if err := s.GuardContent.Validate(); err != nil {
invalidParams.AddNested("GuardContent", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetGuardContent sets the GuardContent field's value.
func (s *SystemContentBlock) SetGuardContent(v *GuardrailConverseContentBlock) *SystemContentBlock {
s.GuardContent = v
return s
}
// SetText sets the Text field's value.
func (s *SystemContentBlock) SetText(v string) *SystemContentBlock {
s.Text = &v
return s
}
// Your request was throttled because of service-wide limitations. Resubmit
// your request later or in a different region. You can also purchase Provisioned
// Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html)
// to increase the rate or number of tokens you can process.
type ThrottlingException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"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) String() string {
return awsutil.Prettify(s)
}
// 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) GoString() string {
return s.String()
}
// The ThrottlingException is and event in the ConverseStreamOutput_ group of events.
func (s *ThrottlingException) eventConverseStreamOutput_() {}
// The ThrottlingException is and event in the ResponseStream group of events.
func (s *ThrottlingException) eventResponseStream() {}
// UnmarshalEvent unmarshals the EventStream Message into the ThrottlingException value.
// This method is only used internally within the SDK's EventStream handling.
func (s *ThrottlingException) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
if err := payloadUnmarshaler.UnmarshalPayload(
bytes.NewReader(msg.Payload), s,
); err != nil {
return err
}
return nil
}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (s *ThrottlingException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error) {
msg.Headers.Set(eventstreamapi.MessageTypeHeader, eventstream.StringValue(eventstreamapi.ExceptionMessageType))
var buf bytes.Buffer
if err = pm.MarshalPayload(&buf, s); err != nil {
return eventstream.Message{}, err
}
msg.Payload = buf.Bytes()
return msg, err
}
func newErrorThrottlingException(v protocol.ResponseMetadata) error {
return &ThrottlingException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ThrottlingException) Code() string {
return "ThrottlingException"
}
// Message returns the exception's message.
func (s *ThrottlingException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) OrigErr() error {
return nil
}
func (s *ThrottlingException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ThrottlingException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) RequestID() string {
return s.RespMetadata.RequestID
}
// The tokens used in a message API inference call.
type TokenUsage struct {
_ struct{} `type:"structure"`
// The number of tokens sent in the request to the model.
//
// InputTokens is a required field
InputTokens *int64 `locationName:"inputTokens" type:"integer" required:"true"`
// The number of tokens that the model generated for the request.
//
// OutputTokens is a required field
OutputTokens *int64 `locationName:"outputTokens" type:"integer" required:"true"`
// The total of input tokens and tokens generated by the model.
//
// TotalTokens is a required field
TotalTokens *int64 `locationName:"totalTokens" type:"integer" required:"true"`
}
// 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 TokenUsage) String() string {
return awsutil.Prettify(s)
}
// 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 TokenUsage) GoString() string {
return s.String()
}
// SetInputTokens sets the InputTokens field's value.
func (s *TokenUsage) SetInputTokens(v int64) *TokenUsage {
s.InputTokens = &v
return s
}
// SetOutputTokens sets the OutputTokens field's value.
func (s *TokenUsage) SetOutputTokens(v int64) *TokenUsage {
s.OutputTokens = &v
return s
}
// SetTotalTokens sets the TotalTokens field's value.
func (s *TokenUsage) SetTotalTokens(v int64) *TokenUsage {
s.TotalTokens = &v
return s
}
// Information about a tool that you can use with the Converse API. For more
// information, see Tool use (function calling) (https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html)
// in the Amazon Bedrock User Guide.
type Tool struct {
_ struct{} `type:"structure"`
// The specfication for the tool.
ToolSpec *ToolSpecification `locationName:"toolSpec" type:"structure"`
}
// 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 Tool) String() string {
return awsutil.Prettify(s)
}
// 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 Tool) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *Tool) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "Tool"}
if s.ToolSpec != nil {
if err := s.ToolSpec.Validate(); err != nil {
invalidParams.AddNested("ToolSpec", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetToolSpec sets the ToolSpec field's value.
func (s *Tool) SetToolSpec(v *ToolSpecification) *Tool {
s.ToolSpec = v
return s
}
// Determines which tools the model should request in a call to Converse or
// ConverseStream. ToolChoice is only supported by Anthropic Claude 3 models
// and by Mistral AI Mistral Large.
type ToolChoice struct {
_ struct{} `type:"structure"`
// The model must request at least one tool (no text is generated).
Any *AnyToolChoice `locationName:"any" type:"structure"`
// (Default). The Model automatically decides if a tool should be called or
// whether to generate text instead.
Auto *AutoToolChoice `locationName:"auto" type:"structure"`
// The Model must request the specified tool. Only supported by Anthropic Claude
// 3 models.
Tool *SpecificToolChoice `locationName:"tool" type:"structure"`
}
// 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 ToolChoice) String() string {
return awsutil.Prettify(s)
}
// 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 ToolChoice) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ToolChoice) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ToolChoice"}
if s.Tool != nil {
if err := s.Tool.Validate(); err != nil {
invalidParams.AddNested("Tool", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAny sets the Any field's value.
func (s *ToolChoice) SetAny(v *AnyToolChoice) *ToolChoice {
s.Any = v
return s
}
// SetAuto sets the Auto field's value.
func (s *ToolChoice) SetAuto(v *AutoToolChoice) *ToolChoice {
s.Auto = v
return s
}
// SetTool sets the Tool field's value.
func (s *ToolChoice) SetTool(v *SpecificToolChoice) *ToolChoice {
s.Tool = v
return s
}
// Configuration information for the tools that you pass to a model. For more
// information, see Tool use (function calling) (https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html)
// in the Amazon Bedrock User Guide.
//
// This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere
// Command R+, and Mistral Large models.
type ToolConfiguration struct {
_ struct{} `type:"structure"`
// If supported by model, forces the model to request a tool.
ToolChoice *ToolChoice `locationName:"toolChoice" type:"structure"`
// An array of tools that you want to pass to a model.
//
// Tools is a required field
Tools []*Tool `locationName:"tools" min:"1" type:"list" required:"true"`
}
// 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 ToolConfiguration) String() string {
return awsutil.Prettify(s)
}
// 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 ToolConfiguration) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ToolConfiguration) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ToolConfiguration"}
if s.Tools == nil {
invalidParams.Add(request.NewErrParamRequired("Tools"))
}
if s.Tools != nil && len(s.Tools) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Tools", 1))
}
if s.ToolChoice != nil {
if err := s.ToolChoice.Validate(); err != nil {
invalidParams.AddNested("ToolChoice", err.(request.ErrInvalidParams))
}
}
if s.Tools != nil {
for i, v := range s.Tools {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tools", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetToolChoice sets the ToolChoice field's value.
func (s *ToolConfiguration) SetToolChoice(v *ToolChoice) *ToolConfiguration {
s.ToolChoice = v
return s
}
// SetTools sets the Tools field's value.
func (s *ToolConfiguration) SetTools(v []*Tool) *ToolConfiguration {
s.Tools = v
return s
}
// The schema for the tool. The top level schema type must be object.
type ToolInputSchema struct {
_ struct{} `type:"structure"`
}
// 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 ToolInputSchema) String() string {
return awsutil.Prettify(s)
}
// 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 ToolInputSchema) GoString() string {
return s.String()
}
// A tool result block that contains the results for a tool request that the
// model previously made.
type ToolResultBlock struct {
_ struct{} `type:"structure"`
// The content for tool result content block.
//
// Content is a required field
Content []*ToolResultContentBlock `locationName:"content" type:"list" required:"true"`
// The status for the tool result content block.
//
// This field is only supported Anthropic Claude 3 models.
Status *string `locationName:"status" type:"string" enum:"ToolResultStatus"`
// The ID of the tool request that this is the result for.
//
// ToolUseId is a required field
ToolUseId *string `locationName:"toolUseId" min:"1" type:"string" required:"true"`
}
// 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 ToolResultBlock) String() string {
return awsutil.Prettify(s)
}
// 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 ToolResultBlock) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ToolResultBlock) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ToolResultBlock"}
if s.Content == nil {
invalidParams.Add(request.NewErrParamRequired("Content"))
}
if s.ToolUseId == nil {
invalidParams.Add(request.NewErrParamRequired("ToolUseId"))
}
if s.ToolUseId != nil && len(*s.ToolUseId) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ToolUseId", 1))
}
if s.Content != nil {
for i, v := range s.Content {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Content", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetContent sets the Content field's value.
func (s *ToolResultBlock) SetContent(v []*ToolResultContentBlock) *ToolResultBlock {
s.Content = v
return s
}
// SetStatus sets the Status field's value.
func (s *ToolResultBlock) SetStatus(v string) *ToolResultBlock {
s.Status = &v
return s
}
// SetToolUseId sets the ToolUseId field's value.
func (s *ToolResultBlock) SetToolUseId(v string) *ToolResultBlock {
s.ToolUseId = &v
return s
}
// The tool result content block.
type ToolResultContentBlock struct {
_ struct{} `type:"structure"`
// A tool result that is a document.
Document *DocumentBlock `locationName:"document" type:"structure"`
// A tool result that is an image.
//
// This field is only supported by Anthropic Claude 3 models.
Image *ImageBlock `locationName:"image" type:"structure"`
// A tool result that is text.
Text *string `locationName:"text" type:"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 ToolResultContentBlock) String() string {
return awsutil.Prettify(s)
}
// 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 ToolResultContentBlock) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ToolResultContentBlock) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ToolResultContentBlock"}
if s.Document != nil {
if err := s.Document.Validate(); err != nil {
invalidParams.AddNested("Document", err.(request.ErrInvalidParams))
}
}
if s.Image != nil {
if err := s.Image.Validate(); err != nil {
invalidParams.AddNested("Image", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDocument sets the Document field's value.
func (s *ToolResultContentBlock) SetDocument(v *DocumentBlock) *ToolResultContentBlock {
s.Document = v
return s
}
// SetImage sets the Image field's value.
func (s *ToolResultContentBlock) SetImage(v *ImageBlock) *ToolResultContentBlock {
s.Image = v
return s
}
// SetText sets the Text field's value.
func (s *ToolResultContentBlock) SetText(v string) *ToolResultContentBlock {
s.Text = &v
return s
}
// The specification for the tool.
type ToolSpecification struct {
_ struct{} `type:"structure"`
// The description for the tool.
Description *string `locationName:"description" min:"1" type:"string"`
// The input schema for the tool in JSON format.
//
// InputSchema is a required field
InputSchema *ToolInputSchema `locationName:"inputSchema" type:"structure" required:"true"`
// The name for the tool.
//
// Name is a required field
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
}
// 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 ToolSpecification) String() string {
return awsutil.Prettify(s)
}
// 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 ToolSpecification) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ToolSpecification) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ToolSpecification"}
if s.Description != nil && len(*s.Description) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Description", 1))
}
if s.InputSchema == nil {
invalidParams.Add(request.NewErrParamRequired("InputSchema"))
}
if s.Name == nil {
invalidParams.Add(request.NewErrParamRequired("Name"))
}
if s.Name != nil && len(*s.Name) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Name", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDescription sets the Description field's value.
func (s *ToolSpecification) SetDescription(v string) *ToolSpecification {
s.Description = &v
return s
}
// SetInputSchema sets the InputSchema field's value.
func (s *ToolSpecification) SetInputSchema(v *ToolInputSchema) *ToolSpecification {
s.InputSchema = v
return s
}
// SetName sets the Name field's value.
func (s *ToolSpecification) SetName(v string) *ToolSpecification {
s.Name = &v
return s
}
// The delta for a tool use block.
type ToolUseBlockDelta struct {
_ struct{} `type:"structure"`
// The input for a requested tool.
//
// Input is a required field
Input *string `locationName:"input" type:"string" required:"true"`
}
// 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 ToolUseBlockDelta) String() string {
return awsutil.Prettify(s)
}
// 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 ToolUseBlockDelta) GoString() string {
return s.String()
}
// SetInput sets the Input field's value.
func (s *ToolUseBlockDelta) SetInput(v string) *ToolUseBlockDelta {
s.Input = &v
return s
}
// The start of a tool use block.
type ToolUseBlockStart struct {
_ struct{} `type:"structure"`
// The name of the tool that the model is requesting to use.
//
// Name is a required field
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
// The ID for the tool request.
//
// ToolUseId is a required field
ToolUseId *string `locationName:"toolUseId" min:"1" type:"string" required:"true"`
}
// 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 ToolUseBlockStart) String() string {
return awsutil.Prettify(s)
}
// 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 ToolUseBlockStart) GoString() string {
return s.String()
}
// SetName sets the Name field's value.
func (s *ToolUseBlockStart) SetName(v string) *ToolUseBlockStart {
s.Name = &v
return s
}
// SetToolUseId sets the ToolUseId field's value.
func (s *ToolUseBlockStart) SetToolUseId(v string) *ToolUseBlockStart {
s.ToolUseId = &v
return s
}
// Input validation failed. Check your request parameters and retry the request.
type ValidationException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"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) String() string {
return awsutil.Prettify(s)
}
// 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) GoString() string {
return s.String()
}
// The ValidationException is and event in the ConverseStreamOutput_ group of events.
func (s *ValidationException) eventConverseStreamOutput_() {}
// The ValidationException is and event in the ResponseStream group of events.
func (s *ValidationException) eventResponseStream() {}
// UnmarshalEvent unmarshals the EventStream Message into the ValidationException value.
// This method is only used internally within the SDK's EventStream handling.
func (s *ValidationException) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
if err := payloadUnmarshaler.UnmarshalPayload(
bytes.NewReader(msg.Payload), s,
); err != nil {
return err
}
return nil
}
// MarshalEvent marshals the type into an stream event value. This method
// should only used internally within the SDK's EventStream handling.
func (s *ValidationException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error) {
msg.Headers.Set(eventstreamapi.MessageTypeHeader, eventstream.StringValue(eventstreamapi.ExceptionMessageType))
var buf bytes.Buffer
if err = pm.MarshalPayload(&buf, s); err != nil {
return eventstream.Message{}, err
}
msg.Payload = buf.Bytes()
return msg, err
}
func newErrorValidationException(v protocol.ResponseMetadata) error {
return &ValidationException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ValidationException) Code() string {
return "ValidationException"
}
// Message returns the exception's message.
func (s *ValidationException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ValidationException) OrigErr() error {
return nil
}
func (s *ValidationException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ValidationException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ValidationException) RequestID() string {
return s.RespMetadata.RequestID
}
const (
// ConversationRoleUser is a ConversationRole enum value
ConversationRoleUser = "user"
// ConversationRoleAssistant is a ConversationRole enum value
ConversationRoleAssistant = "assistant"
)
// ConversationRole_Values returns all elements of the ConversationRole enum
func ConversationRole_Values() []string {
return []string{
ConversationRoleUser,
ConversationRoleAssistant,
}
}
const (
// DocumentFormatPdf is a DocumentFormat enum value
DocumentFormatPdf = "pdf"
// DocumentFormatCsv is a DocumentFormat enum value
DocumentFormatCsv = "csv"
// DocumentFormatDoc is a DocumentFormat enum value
DocumentFormatDoc = "doc"
// DocumentFormatDocx is a DocumentFormat enum value
DocumentFormatDocx = "docx"
// DocumentFormatXls is a DocumentFormat enum value
DocumentFormatXls = "xls"
// DocumentFormatXlsx is a DocumentFormat enum value
DocumentFormatXlsx = "xlsx"
// DocumentFormatHtml is a DocumentFormat enum value
DocumentFormatHtml = "html"
// DocumentFormatTxt is a DocumentFormat enum value
DocumentFormatTxt = "txt"
// DocumentFormatMd is a DocumentFormat enum value
DocumentFormatMd = "md"
)
// DocumentFormat_Values returns all elements of the DocumentFormat enum
func DocumentFormat_Values() []string {
return []string{
DocumentFormatPdf,
DocumentFormatCsv,
DocumentFormatDoc,
DocumentFormatDocx,
DocumentFormatXls,
DocumentFormatXlsx,
DocumentFormatHtml,
DocumentFormatTxt,
DocumentFormatMd,
}
}
const (
// GuardrailActionNone is a GuardrailAction enum value
GuardrailActionNone = "NONE"
// GuardrailActionGuardrailIntervened is a GuardrailAction enum value
GuardrailActionGuardrailIntervened = "GUARDRAIL_INTERVENED"
)
// GuardrailAction_Values returns all elements of the GuardrailAction enum
func GuardrailAction_Values() []string {
return []string{
GuardrailActionNone,
GuardrailActionGuardrailIntervened,
}
}
const (
// GuardrailContentFilterConfidenceNone is a GuardrailContentFilterConfidence enum value
GuardrailContentFilterConfidenceNone = "NONE"
// GuardrailContentFilterConfidenceLow is a GuardrailContentFilterConfidence enum value
GuardrailContentFilterConfidenceLow = "LOW"
// GuardrailContentFilterConfidenceMedium is a GuardrailContentFilterConfidence enum value
GuardrailContentFilterConfidenceMedium = "MEDIUM"
// GuardrailContentFilterConfidenceHigh is a GuardrailContentFilterConfidence enum value
GuardrailContentFilterConfidenceHigh = "HIGH"
)
// GuardrailContentFilterConfidence_Values returns all elements of the GuardrailContentFilterConfidence enum
func GuardrailContentFilterConfidence_Values() []string {
return []string{
GuardrailContentFilterConfidenceNone,
GuardrailContentFilterConfidenceLow,
GuardrailContentFilterConfidenceMedium,
GuardrailContentFilterConfidenceHigh,
}
}
const (
// GuardrailContentFilterTypeInsults is a GuardrailContentFilterType enum value
GuardrailContentFilterTypeInsults = "INSULTS"
// GuardrailContentFilterTypeHate is a GuardrailContentFilterType enum value
GuardrailContentFilterTypeHate = "HATE"
// GuardrailContentFilterTypeSexual is a GuardrailContentFilterType enum value
GuardrailContentFilterTypeSexual = "SEXUAL"
// GuardrailContentFilterTypeViolence is a GuardrailContentFilterType enum value
GuardrailContentFilterTypeViolence = "VIOLENCE"
// GuardrailContentFilterTypeMisconduct is a GuardrailContentFilterType enum value
GuardrailContentFilterTypeMisconduct = "MISCONDUCT"
// GuardrailContentFilterTypePromptAttack is a GuardrailContentFilterType enum value
GuardrailContentFilterTypePromptAttack = "PROMPT_ATTACK"
)
// GuardrailContentFilterType_Values returns all elements of the GuardrailContentFilterType enum
func GuardrailContentFilterType_Values() []string {
return []string{
GuardrailContentFilterTypeInsults,
GuardrailContentFilterTypeHate,
GuardrailContentFilterTypeSexual,
GuardrailContentFilterTypeViolence,
GuardrailContentFilterTypeMisconduct,
GuardrailContentFilterTypePromptAttack,
}
}
const (
// GuardrailContentPolicyActionBlocked is a GuardrailContentPolicyAction enum value
GuardrailContentPolicyActionBlocked = "BLOCKED"
)
// GuardrailContentPolicyAction_Values returns all elements of the GuardrailContentPolicyAction enum
func GuardrailContentPolicyAction_Values() []string {
return []string{
GuardrailContentPolicyActionBlocked,
}
}
const (
// GuardrailContentQualifierGroundingSource is a GuardrailContentQualifier enum value
GuardrailContentQualifierGroundingSource = "grounding_source"
// GuardrailContentQualifierQuery is a GuardrailContentQualifier enum value
GuardrailContentQualifierQuery = "query"
// GuardrailContentQualifierGuardContent is a GuardrailContentQualifier enum value
GuardrailContentQualifierGuardContent = "guard_content"
)
// GuardrailContentQualifier_Values returns all elements of the GuardrailContentQualifier enum
func GuardrailContentQualifier_Values() []string {
return []string{
GuardrailContentQualifierGroundingSource,
GuardrailContentQualifierQuery,
GuardrailContentQualifierGuardContent,
}
}
const (
// GuardrailContentSourceInput is a GuardrailContentSource enum value
GuardrailContentSourceInput = "INPUT"
// GuardrailContentSourceOutput is a GuardrailContentSource enum value
GuardrailContentSourceOutput = "OUTPUT"
)
// GuardrailContentSource_Values returns all elements of the GuardrailContentSource enum
func GuardrailContentSource_Values() []string {
return []string{
GuardrailContentSourceInput,
GuardrailContentSourceOutput,
}
}
const (
// GuardrailContextualGroundingFilterTypeGrounding is a GuardrailContextualGroundingFilterType enum value
GuardrailContextualGroundingFilterTypeGrounding = "GROUNDING"
// GuardrailContextualGroundingFilterTypeRelevance is a GuardrailContextualGroundingFilterType enum value
GuardrailContextualGroundingFilterTypeRelevance = "RELEVANCE"
)
// GuardrailContextualGroundingFilterType_Values returns all elements of the GuardrailContextualGroundingFilterType enum
func GuardrailContextualGroundingFilterType_Values() []string {
return []string{
GuardrailContextualGroundingFilterTypeGrounding,
GuardrailContextualGroundingFilterTypeRelevance,
}
}
const (
// GuardrailContextualGroundingPolicyActionBlocked is a GuardrailContextualGroundingPolicyAction enum value
GuardrailContextualGroundingPolicyActionBlocked = "BLOCKED"
// GuardrailContextualGroundingPolicyActionNone is a GuardrailContextualGroundingPolicyAction enum value
GuardrailContextualGroundingPolicyActionNone = "NONE"
)
// GuardrailContextualGroundingPolicyAction_Values returns all elements of the GuardrailContextualGroundingPolicyAction enum
func GuardrailContextualGroundingPolicyAction_Values() []string {
return []string{
GuardrailContextualGroundingPolicyActionBlocked,
GuardrailContextualGroundingPolicyActionNone,
}
}
const (
// GuardrailConverseContentQualifierGroundingSource is a GuardrailConverseContentQualifier enum value
GuardrailConverseContentQualifierGroundingSource = "grounding_source"
// GuardrailConverseContentQualifierQuery is a GuardrailConverseContentQualifier enum value
GuardrailConverseContentQualifierQuery = "query"
// GuardrailConverseContentQualifierGuardContent is a GuardrailConverseContentQualifier enum value
GuardrailConverseContentQualifierGuardContent = "guard_content"
)
// GuardrailConverseContentQualifier_Values returns all elements of the GuardrailConverseContentQualifier enum
func GuardrailConverseContentQualifier_Values() []string {
return []string{
GuardrailConverseContentQualifierGroundingSource,
GuardrailConverseContentQualifierQuery,
GuardrailConverseContentQualifierGuardContent,
}
}
const (
// GuardrailManagedWordTypeProfanity is a GuardrailManagedWordType enum value
GuardrailManagedWordTypeProfanity = "PROFANITY"
)
// GuardrailManagedWordType_Values returns all elements of the GuardrailManagedWordType enum
func GuardrailManagedWordType_Values() []string {
return []string{
GuardrailManagedWordTypeProfanity,
}
}
const (
// GuardrailPiiEntityTypeAddress is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeAddress = "ADDRESS"
// GuardrailPiiEntityTypeAge is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeAge = "AGE"
// GuardrailPiiEntityTypeAwsAccessKey is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeAwsAccessKey = "AWS_ACCESS_KEY"
// GuardrailPiiEntityTypeAwsSecretKey is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeAwsSecretKey = "AWS_SECRET_KEY"
// GuardrailPiiEntityTypeCaHealthNumber is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeCaHealthNumber = "CA_HEALTH_NUMBER"
// GuardrailPiiEntityTypeCaSocialInsuranceNumber is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeCaSocialInsuranceNumber = "CA_SOCIAL_INSURANCE_NUMBER"
// GuardrailPiiEntityTypeCreditDebitCardCvv is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeCreditDebitCardCvv = "CREDIT_DEBIT_CARD_CVV"
// GuardrailPiiEntityTypeCreditDebitCardExpiry is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeCreditDebitCardExpiry = "CREDIT_DEBIT_CARD_EXPIRY"
// GuardrailPiiEntityTypeCreditDebitCardNumber is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeCreditDebitCardNumber = "CREDIT_DEBIT_CARD_NUMBER"
// GuardrailPiiEntityTypeDriverId is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeDriverId = "DRIVER_ID"
// GuardrailPiiEntityTypeEmail is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeEmail = "EMAIL"
// GuardrailPiiEntityTypeInternationalBankAccountNumber is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeInternationalBankAccountNumber = "INTERNATIONAL_BANK_ACCOUNT_NUMBER"
// GuardrailPiiEntityTypeIpAddress is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeIpAddress = "IP_ADDRESS"
// GuardrailPiiEntityTypeLicensePlate is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeLicensePlate = "LICENSE_PLATE"
// GuardrailPiiEntityTypeMacAddress is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeMacAddress = "MAC_ADDRESS"
// GuardrailPiiEntityTypeName is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeName = "NAME"
// GuardrailPiiEntityTypePassword is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypePassword = "PASSWORD"
// GuardrailPiiEntityTypePhone is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypePhone = "PHONE"
// GuardrailPiiEntityTypePin is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypePin = "PIN"
// GuardrailPiiEntityTypeSwiftCode is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeSwiftCode = "SWIFT_CODE"
// GuardrailPiiEntityTypeUkNationalHealthServiceNumber is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeUkNationalHealthServiceNumber = "UK_NATIONAL_HEALTH_SERVICE_NUMBER"
// GuardrailPiiEntityTypeUkNationalInsuranceNumber is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeUkNationalInsuranceNumber = "UK_NATIONAL_INSURANCE_NUMBER"
// GuardrailPiiEntityTypeUkUniqueTaxpayerReferenceNumber is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeUkUniqueTaxpayerReferenceNumber = "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"
// GuardrailPiiEntityTypeUrl is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeUrl = "URL"
// GuardrailPiiEntityTypeUsername is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeUsername = "USERNAME"
// GuardrailPiiEntityTypeUsBankAccountNumber is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeUsBankAccountNumber = "US_BANK_ACCOUNT_NUMBER"
// GuardrailPiiEntityTypeUsBankRoutingNumber is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeUsBankRoutingNumber = "US_BANK_ROUTING_NUMBER"
// GuardrailPiiEntityTypeUsIndividualTaxIdentificationNumber is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeUsIndividualTaxIdentificationNumber = "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"
// GuardrailPiiEntityTypeUsPassportNumber is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeUsPassportNumber = "US_PASSPORT_NUMBER"
// GuardrailPiiEntityTypeUsSocialSecurityNumber is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeUsSocialSecurityNumber = "US_SOCIAL_SECURITY_NUMBER"
// GuardrailPiiEntityTypeVehicleIdentificationNumber is a GuardrailPiiEntityType enum value
GuardrailPiiEntityTypeVehicleIdentificationNumber = "VEHICLE_IDENTIFICATION_NUMBER"
)
// GuardrailPiiEntityType_Values returns all elements of the GuardrailPiiEntityType enum
func GuardrailPiiEntityType_Values() []string {
return []string{
GuardrailPiiEntityTypeAddress,
GuardrailPiiEntityTypeAge,
GuardrailPiiEntityTypeAwsAccessKey,
GuardrailPiiEntityTypeAwsSecretKey,
GuardrailPiiEntityTypeCaHealthNumber,
GuardrailPiiEntityTypeCaSocialInsuranceNumber,
GuardrailPiiEntityTypeCreditDebitCardCvv,
GuardrailPiiEntityTypeCreditDebitCardExpiry,
GuardrailPiiEntityTypeCreditDebitCardNumber,
GuardrailPiiEntityTypeDriverId,
GuardrailPiiEntityTypeEmail,
GuardrailPiiEntityTypeInternationalBankAccountNumber,
GuardrailPiiEntityTypeIpAddress,
GuardrailPiiEntityTypeLicensePlate,
GuardrailPiiEntityTypeMacAddress,
GuardrailPiiEntityTypeName,
GuardrailPiiEntityTypePassword,
GuardrailPiiEntityTypePhone,
GuardrailPiiEntityTypePin,
GuardrailPiiEntityTypeSwiftCode,
GuardrailPiiEntityTypeUkNationalHealthServiceNumber,
GuardrailPiiEntityTypeUkNationalInsuranceNumber,
GuardrailPiiEntityTypeUkUniqueTaxpayerReferenceNumber,
GuardrailPiiEntityTypeUrl,
GuardrailPiiEntityTypeUsername,
GuardrailPiiEntityTypeUsBankAccountNumber,
GuardrailPiiEntityTypeUsBankRoutingNumber,
GuardrailPiiEntityTypeUsIndividualTaxIdentificationNumber,
GuardrailPiiEntityTypeUsPassportNumber,
GuardrailPiiEntityTypeUsSocialSecurityNumber,
GuardrailPiiEntityTypeVehicleIdentificationNumber,
}
}
const (
// GuardrailSensitiveInformationPolicyActionAnonymized is a GuardrailSensitiveInformationPolicyAction enum value
GuardrailSensitiveInformationPolicyActionAnonymized = "ANONYMIZED"
// GuardrailSensitiveInformationPolicyActionBlocked is a GuardrailSensitiveInformationPolicyAction enum value
GuardrailSensitiveInformationPolicyActionBlocked = "BLOCKED"
)
// GuardrailSensitiveInformationPolicyAction_Values returns all elements of the GuardrailSensitiveInformationPolicyAction enum
func GuardrailSensitiveInformationPolicyAction_Values() []string {
return []string{
GuardrailSensitiveInformationPolicyActionAnonymized,
GuardrailSensitiveInformationPolicyActionBlocked,
}
}
const (
// GuardrailStreamProcessingModeSync is a GuardrailStreamProcessingMode enum value
GuardrailStreamProcessingModeSync = "sync"
// GuardrailStreamProcessingModeAsync is a GuardrailStreamProcessingMode enum value
GuardrailStreamProcessingModeAsync = "async"
)
// GuardrailStreamProcessingMode_Values returns all elements of the GuardrailStreamProcessingMode enum
func GuardrailStreamProcessingMode_Values() []string {
return []string{
GuardrailStreamProcessingModeSync,
GuardrailStreamProcessingModeAsync,
}
}
const (
// GuardrailTopicPolicyActionBlocked is a GuardrailTopicPolicyAction enum value
GuardrailTopicPolicyActionBlocked = "BLOCKED"
)
// GuardrailTopicPolicyAction_Values returns all elements of the GuardrailTopicPolicyAction enum
func GuardrailTopicPolicyAction_Values() []string {
return []string{
GuardrailTopicPolicyActionBlocked,
}
}
const (
// GuardrailTopicTypeDeny is a GuardrailTopicType enum value
GuardrailTopicTypeDeny = "DENY"
)
// GuardrailTopicType_Values returns all elements of the GuardrailTopicType enum
func GuardrailTopicType_Values() []string {
return []string{
GuardrailTopicTypeDeny,
}
}
const (
// GuardrailTraceEnabled is a GuardrailTrace enum value
GuardrailTraceEnabled = "enabled"
// GuardrailTraceDisabled is a GuardrailTrace enum value
GuardrailTraceDisabled = "disabled"
)
// GuardrailTrace_Values returns all elements of the GuardrailTrace enum
func GuardrailTrace_Values() []string {
return []string{
GuardrailTraceEnabled,
GuardrailTraceDisabled,
}
}
const (
// GuardrailWordPolicyActionBlocked is a GuardrailWordPolicyAction enum value
GuardrailWordPolicyActionBlocked = "BLOCKED"
)
// GuardrailWordPolicyAction_Values returns all elements of the GuardrailWordPolicyAction enum
func GuardrailWordPolicyAction_Values() []string {
return []string{
GuardrailWordPolicyActionBlocked,
}
}
const (
// ImageFormatPng is a ImageFormat enum value
ImageFormatPng = "png"
// ImageFormatJpeg is a ImageFormat enum value
ImageFormatJpeg = "jpeg"
// ImageFormatGif is a ImageFormat enum value
ImageFormatGif = "gif"
// ImageFormatWebp is a ImageFormat enum value
ImageFormatWebp = "webp"
)
// ImageFormat_Values returns all elements of the ImageFormat enum
func ImageFormat_Values() []string {
return []string{
ImageFormatPng,
ImageFormatJpeg,
ImageFormatGif,
ImageFormatWebp,
}
}
const (
// StopReasonEndTurn is a StopReason enum value
StopReasonEndTurn = "end_turn"
// StopReasonToolUse is a StopReason enum value
StopReasonToolUse = "tool_use"
// StopReasonMaxTokens is a StopReason enum value
StopReasonMaxTokens = "max_tokens"
// StopReasonStopSequence is a StopReason enum value
StopReasonStopSequence = "stop_sequence"
// StopReasonGuardrailIntervened is a StopReason enum value
StopReasonGuardrailIntervened = "guardrail_intervened"
// StopReasonContentFiltered is a StopReason enum value
StopReasonContentFiltered = "content_filtered"
)
// StopReason_Values returns all elements of the StopReason enum
func StopReason_Values() []string {
return []string{
StopReasonEndTurn,
StopReasonToolUse,
StopReasonMaxTokens,
StopReasonStopSequence,
StopReasonGuardrailIntervened,
StopReasonContentFiltered,
}
}
const (
// ToolResultStatusSuccess is a ToolResultStatus enum value
ToolResultStatusSuccess = "success"
// ToolResultStatusError is a ToolResultStatus enum value
ToolResultStatusError = "error"
)
// ToolResultStatus_Values returns all elements of the ToolResultStatus enum
func ToolResultStatus_Values() []string {
return []string{
ToolResultStatusSuccess,
ToolResultStatusError,
}
}
const (
// TraceEnabled is a Trace enum value
TraceEnabled = "ENABLED"
// TraceDisabled is a Trace enum value
TraceDisabled = "DISABLED"
)
// Trace_Values returns all elements of the Trace enum
func Trace_Values() []string {
return []string{
TraceEnabled,
TraceDisabled,
}
}