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 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package bedrockagentruntime
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/bedrockagentruntime/types"
"github.com/aws/smithy-go/middleware"
smithysync "github.com/aws/smithy-go/sync"
"sync"
)
// The CLI doesn't support streaming operations in Amazon Bedrock, including
// InvokeAgent .
//
// Sends a prompt for the agent to process and respond to. Note the following
// fields for the request:
//
// - To continue the same conversation with an agent, use the same sessionId
// value in the request.
//
// - To activate trace enablement, turn enableTrace to true . Trace enablement
// helps you follow the agent's reasoning process that led it to the information it
// processed, the actions it took, and the final result it yielded. For more
// information, see [Trace enablement].
//
// - End a conversation by setting endSession to true .
//
// - In the sessionState object, you can include attributes for the session or
// prompt or, if you configured an action group to return control, results from
// invocation of the action group.
//
// The response is returned in the bytes field of the chunk object.
//
// - The attribution object contains citations for parts of the response.
//
// - If you set enableTrace to true in the request, you can trace the agent's
// steps and reasoning process that led it to the response.
//
// - If the action predicted was configured to return control, the response
// returns parameters for the action, elicited from the user, in the
// returnControl field.
//
// - Errors are also surfaced in the response.
//
// [Trace enablement]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events
func (c *Client) InvokeAgent(ctx context.Context, params *InvokeAgentInput, optFns ...func(*Options)) (*InvokeAgentOutput, error) {
if params == nil {
params = &InvokeAgentInput{}
}
result, metadata, err := c.invokeOperation(ctx, "InvokeAgent", params, optFns, c.addOperationInvokeAgentMiddlewares)
if err != nil {
return nil, err
}
out := result.(*InvokeAgentOutput)
out.ResultMetadata = metadata
return out, nil
}
type InvokeAgentInput struct {
// The alias of the agent to use.
//
// This member is required.
AgentAliasId *string
// The unique identifier of the agent to use.
//
// This member is required.
AgentId *string
// The unique identifier of the session. Use the same value across requests to
// continue the same conversation.
//
// This member is required.
SessionId *string
// Specifies whether to turn on the trace or not to track the agent's reasoning
// process. For more information, see [Trace enablement].
//
// [Trace enablement]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events
EnableTrace *bool
// Specifies whether to end the session with the agent or not.
EndSession *bool
// The prompt text to send the agent.
//
// If you include returnControlInvocationResults in the sessionState field, the
// inputText field will be ignored.
InputText *string
// The unique identifier of the agent memory.
MemoryId *string
// Contains parameters that specify various attributes of the session. For more
// information, see [Control session context].
//
// If you include returnControlInvocationResults in the sessionState field, the
// inputText field will be ignored.
//
// [Control session context]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html
SessionState *types.SessionState
noSmithyDocumentSerde
}
type InvokeAgentOutput struct {
// The MIME type of the input data in the request. The default value is
// application/json .
//
// This member is required.
ContentType *string
// The unique identifier of the session with the agent.
//
// This member is required.
SessionId *string
// The unique identifier of the agent memory.
MemoryId *string
eventStream *InvokeAgentEventStream
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
// GetStream returns the type to interact with the event stream.
func (o *InvokeAgentOutput) GetStream() *InvokeAgentEventStream {
return o.eventStream
}
func (c *Client) addOperationInvokeAgentMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpInvokeAgent{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpInvokeAgent{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "InvokeAgent"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addEventStreamInvokeAgentMiddleware(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 = 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 = addOpInvokeAgentValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opInvokeAgent(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_opInvokeAgent(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "InvokeAgent",
}
}
// InvokeAgentEventStream provides the event stream handling for the InvokeAgent operation.
//
// For testing and mocking the event stream this type should be initialized via
// the NewInvokeAgentEventStream constructor function. Using the functional options
// to pass in nested mock behavior.
type InvokeAgentEventStream struct {
// ResponseStreamReader 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
done chan struct{}
closeOnce sync.Once
err *smithysync.OnceErr
}
// NewInvokeAgentEventStream initializes an InvokeAgentEventStream.
// This function should only be used for testing and mocking the InvokeAgentEventStream
// stream within your application.
//
// The Reader member must be set before reading events from the stream.
func NewInvokeAgentEventStream(optFns ...func(*InvokeAgentEventStream)) *InvokeAgentEventStream {
es := &InvokeAgentEventStream{
done: make(chan struct{}),
err: smithysync.NewOnceErr(),
}
for _, fn := range optFns {
fn(es)
}
return es
}
// Events returns a channel to read events from.
func (es *InvokeAgentEventStream) Events() <-chan types.ResponseStream {
return es.Reader.Events()
}
// 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.
//
// Will close the underlying EventStream writer and reader, and no more events can be
// sent or received.
func (es *InvokeAgentEventStream) Close() error {
es.closeOnce.Do(es.safeClose)
return es.Err()
}
func (es *InvokeAgentEventStream) safeClose() {
close(es.done)
es.Reader.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 *InvokeAgentEventStream) Err() error {
if err := es.err.Err(); err != nil {
return err
}
if err := es.Reader.Err(); err != nil {
return err
}
return nil
}
func (es *InvokeAgentEventStream) waitStreamClose() {
type errorSet interface {
ErrorSet() <-chan struct{}
}
var outputErrCh <-chan struct{}
if v, ok := es.Reader.(errorSet); 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()
}
}
|