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
|
// 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"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Queries a knowledge base and generates responses based on the retrieved
// results. The response only cites sources that are relevant to the query.
func (c *Client) RetrieveAndGenerate(ctx context.Context, params *RetrieveAndGenerateInput, optFns ...func(*Options)) (*RetrieveAndGenerateOutput, error) {
if params == nil {
params = &RetrieveAndGenerateInput{}
}
result, metadata, err := c.invokeOperation(ctx, "RetrieveAndGenerate", params, optFns, c.addOperationRetrieveAndGenerateMiddlewares)
if err != nil {
return nil, err
}
out := result.(*RetrieveAndGenerateOutput)
out.ResultMetadata = metadata
return out, nil
}
type RetrieveAndGenerateInput struct {
// Contains the query to be made to the knowledge base.
//
// This member is required.
Input *types.RetrieveAndGenerateInput
// Contains configurations for the knowledge base query and retrieval process. For
// more information, see [Query configurations].
//
// [Query configurations]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
RetrieveAndGenerateConfiguration *types.RetrieveAndGenerateConfiguration
// Contains details about the session with the knowledge base.
SessionConfiguration *types.RetrieveAndGenerateSessionConfiguration
// The unique identifier of the session. When you first make a RetrieveAndGenerate
// request, Amazon Bedrock automatically generates this value. You must reuse this
// value for all subsequent requests in the same conversational session. This value
// allows Amazon Bedrock to maintain context and knowledge from previous
// interactions. You can't explicitly set the sessionId yourself.
SessionId *string
noSmithyDocumentSerde
}
type RetrieveAndGenerateOutput struct {
// Contains the response generated from querying the knowledge base.
//
// This member is required.
Output *types.RetrieveAndGenerateOutput
// The unique identifier of the session. When you first make a RetrieveAndGenerate
// request, Amazon Bedrock automatically generates this value. You must reuse this
// value for all subsequent requests in the same conversational session. This value
// allows Amazon Bedrock to maintain context and knowledge from previous
// interactions. You can't explicitly set the sessionId yourself.
//
// This member is required.
SessionId *string
// A list of segments of the generated response that are based on sources in the
// knowledge base, alongside information about the sources.
Citations []types.Citation
// Specifies if there is a guardrail intervention in the response.
GuardrailAction types.GuadrailAction
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationRetrieveAndGenerateMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpRetrieveAndGenerate{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpRetrieveAndGenerate{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "RetrieveAndGenerate"); 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 = addOpRetrieveAndGenerateValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRetrieveAndGenerate(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_opRetrieveAndGenerate(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "RetrieveAndGenerate",
}
}
|
