1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package bedrockruntime
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/bedrockruntime/document"
"github.com/aws/aws-sdk-go-v2/service/bedrockruntime/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// 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. Should a model
// have unique inference parameters, you can also pass those unique parameters to
// the model.
//
// 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.
func (c *Client) Converse(ctx context.Context, params *ConverseInput, optFns ...func(*Options)) (*ConverseOutput, error) {
if params == nil {
params = &ConverseInput{}
}
result, metadata, err := c.invokeOperation(ctx, "Converse", params, optFns, c.addOperationConverseMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ConverseOutput)
out.ResultMetadata = metadata
return out, nil
}
type ConverseInput struct {
// The messages that you want to send to the model.
//
// This member is required.
Messages []types.Message
// 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)]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]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]in the Amazon Bedrock User Guide.
//
// [Run inference using a Provisioned Throughput]: https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html
// [Use a custom model in Amazon Bedrock]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html
// [Amazon Bedrock base model IDs (on-demand throughput)]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns
//
// This member is required.
ModelId *string
// Additional inference parameters that the model supports, beyond the base set of
// inference parameters that Converse supports in the inferenceConfig field. For
// more information, see [Model parameters].
//
// [Model parameters]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html
AdditionalModelRequestFields document.Interface
// 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)] 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 .
//
// [Internet Engineering Task Force (IETF)]: https://datatracker.ietf.org/doc/html/rfc6901
AdditionalModelResponseFieldPaths []string
// Configuration information for a guardrail that you want to use in the request.
GuardrailConfig *types.GuardrailConfiguration
// 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 *types.InferenceConfiguration
// A system prompt to pass to the model.
System []types.SystemContentBlock
// 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 *types.ToolConfiguration
noSmithyDocumentSerde
}
type ConverseOutput struct {
// Metrics for the call to Converse .
//
// This member is required.
Metrics *types.ConverseMetrics
// The result from the call to Converse .
//
// This member is required.
Output types.ConverseOutput
// The reason why the model stopped generating output.
//
// This member is required.
StopReason types.StopReason
// 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.
//
// This member is required.
Usage *types.TokenUsage
// Additional fields in the response that are unique to the model.
AdditionalModelResponseFields document.Interface
// A trace object that contains information about the Guardrail behavior.
Trace *types.ConverseTrace
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationConverseMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpConverse{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpConverse{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "Converse"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpConverseValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opConverse(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opConverse(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "Converse",
}
}
|