Skip to content

Commit 31df839

Browse files
This release removes the deprecated UserId and UserGroups fields from SearchRelevantContent api's request parameters.
1 parent af175a3 commit 31df839

File tree

12 files changed

+39
-115
lines changed

12 files changed

+39
-115
lines changed

generator/ServiceModels/qbusiness/qbusiness-2023-11-27.api.json

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5294,16 +5294,6 @@
52945294
"location":"uri",
52955295
"locationName":"applicationId"
52965296
},
5297-
"userId":{
5298-
"shape":"UserId",
5299-
"location":"querystring",
5300-
"locationName":"userId"
5301-
},
5302-
"userGroups":{
5303-
"shape":"UserGroups",
5304-
"location":"querystring",
5305-
"locationName":"userGroups"
5306-
},
53075297
"queryText":{"shape":"QueryText"},
53085298
"contentSource":{"shape":"ContentSource"},
53095299
"attributeFilter":{"shape":"AttributeFilter"},

generator/ServiceModels/qbusiness/qbusiness-2023-11-27.docs.json

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
"ListWebExperiences": "<p>Lists one or more Amazon Q Business Web Experiences.</p>",
5959
"PutFeedback": "<p>Enables your end user to provide feedback on their Amazon Q Business generated chat responses.</p>",
6060
"PutGroup": "<p>Create, or updates, a mapping of users—who have access to a document—to groups.</p> <p>You can also map sub groups to groups. For example, the group \"Company Intellectual Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.</p>",
61-
"SearchRelevantContent": "<p>Searches for relevant content in a Q Business application based on a query. This operation takes a search query text, the Q Business application identifier, and optional filters (such as user ID, user groups, content source, and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.</p>",
61+
"SearchRelevantContent": "<p>Searches for relevant content in a Q Business application based on a query. This operation takes a search query text, the Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.</p>",
6262
"StartDataSourceSyncJob": "<p>Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a <code>ConflictException</code>.</p>",
6363
"StopDataSourceSyncJob": "<p>Stops an Amazon Q Business data source connector synchronization job already in progress.</p>",
6464
"TagResource": "<p>Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.</p>",
@@ -3385,7 +3385,6 @@
33853385
"refs": {
33863386
"ChatInput$userGroups": "<p>The group names that a user associated with the chat input belongs to.</p>",
33873387
"ChatSyncInput$userGroups": "<p>The group names that a user associated with the chat input belongs to.</p>",
3388-
"SearchRelevantContentRequest$userGroups": "<p>The groups the user belongs to. Used for access control.</p>",
33893388
"UsersAndGroups$userGroups": "<p>The user group names associated with a topic control rule.</p>"
33903389
}
33913390
},
@@ -3399,8 +3398,7 @@
33993398
"ListConversationsRequest$userId": "<p>The identifier of the user involved in the Amazon Q Business web experience conversation. </p>",
34003399
"ListMessagesRequest$userId": "<p>The identifier of the user involved in the Amazon Q Business web experience conversation.</p>",
34013400
"PrincipalUser$id": "<p> The identifier of the user. </p>",
3402-
"PutFeedbackRequest$userId": "<p>The identifier of the user giving the feedback.</p>",
3403-
"SearchRelevantContentRequest$userId": "<p>The ID of the user performing the search. Used for access control.</p>"
3401+
"PutFeedbackRequest$userId": "<p>The identifier of the user giving the feedback.</p>"
34043402
}
34053403
},
34063404
"UserIds": {

generator/ServiceModels/qbusiness/qbusiness-2023-11-27.normal.json

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1102,7 +1102,7 @@
11021102
{"shape":"ValidationException"},
11031103
{"shape":"AccessDeniedException"}
11041104
],
1105-
"documentation":"<p>Searches for relevant content in a Q Business application based on a query. This operation takes a search query text, the Q Business application identifier, and optional filters (such as user ID, user groups, content source, and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.</p>"
1105+
"documentation":"<p>Searches for relevant content in a Q Business application based on a query. This operation takes a search query text, the Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.</p>"
11061106
},
11071107
"StartDataSourceSyncJob":{
11081108
"name":"StartDataSourceSyncJob",
@@ -7289,18 +7289,6 @@
72897289
"location":"uri",
72907290
"locationName":"applicationId"
72917291
},
7292-
"userId":{
7293-
"shape":"UserId",
7294-
"documentation":"<p>The ID of the user performing the search. Used for access control.</p>",
7295-
"location":"querystring",
7296-
"locationName":"userId"
7297-
},
7298-
"userGroups":{
7299-
"shape":"UserGroups",
7300-
"documentation":"<p>The groups the user belongs to. Used for access control.</p>",
7301-
"location":"querystring",
7302-
"locationName":"userGroups"
7303-
},
73047292
"queryText":{
73057293
"shape":"QueryText",
73067294
"documentation":"<p>The text to search for.</p>"

sdk/code-analysis/ServiceAnalysis/QBusiness/Generated/PropertyValueRules.xml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1487,12 +1487,6 @@
14871487
<min>1</min>
14881488
<max>800</max>
14891489
</property-value-rule>
1490-
<property-value-rule>
1491-
<property>Amazon.QBusiness.Model.SearchRelevantContentRequest.UserId</property>
1492-
<min>1</min>
1493-
<max>1024</max>
1494-
<pattern>\P{C}*</pattern>
1495-
</property-value-rule>
14961490
<property-value-rule>
14971491
<property>Amazon.QBusiness.Model.SearchRelevantContentResponse.NextToken</property>
14981492
<min>1</min>

sdk/src/Services/QBusiness/Generated/Model/Internal/MarshallTransformations/SearchRelevantContentRequestMarshaller.cs

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,6 @@ public IRequest Marshall(SearchRelevantContentRequest publicRequest)
6363
if (!publicRequest.IsSetApplicationId())
6464
throw new AmazonQBusinessException("Request object does not have required field ApplicationId set");
6565
request.AddPathResource("{applicationId}", StringUtils.FromString(publicRequest.ApplicationId));
66-
67-
if (publicRequest.IsSetUserGroups())
68-
request.ParameterCollection.Add("userGroups", publicRequest.UserGroups);
69-
70-
if (publicRequest.IsSetUserId())
71-
request.Parameters.Add("userId", StringUtils.FromString(publicRequest.UserId));
7266
request.ResourcePath = "/applications/{applicationId}/relevant-content";
7367
using (StringWriter stringWriter = new StringWriter(CultureInfo.InvariantCulture))
7468
{
@@ -121,7 +115,6 @@ public IRequest Marshall(SearchRelevantContentRequest publicRequest)
121115
request.Content = System.Text.Encoding.UTF8.GetBytes(snippet);
122116
}
123117

124-
request.UseQueryString = true;
125118

126119
return request;
127120
}

sdk/src/Services/QBusiness/Generated/Model/SearchRelevantContentRequest.cs

Lines changed: 4 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ namespace Amazon.QBusiness.Model
3333
/// Container for the parameters to the SearchRelevantContent operation.
3434
/// Searches for relevant content in a Q Business application based on a query. This operation
3535
/// takes a search query text, the Q Business application identifier, and optional filters
36-
/// (such as user ID, user groups, content source, and maximum results) as input. It returns
37-
/// a list of relevant content items, where each item includes the content text, the unique
38-
/// document identifier, the document title, the document URI, any relevant document attributes,
39-
/// and score attributes indicating the confidence level of the relevance.
36+
/// (such as content source and maximum results) as input. It returns a list of relevant
37+
/// content items, where each item includes the content text, the unique document identifier,
38+
/// the document title, the document URI, any relevant document attributes, and score
39+
/// attributes indicating the confidence level of the relevance.
4040
/// </summary>
4141
public partial class SearchRelevantContentRequest : AmazonQBusinessRequest
4242
{
@@ -46,8 +46,6 @@ public partial class SearchRelevantContentRequest : AmazonQBusinessRequest
4646
private int? _maxResults;
4747
private string _nextToken;
4848
private string _queryText;
49-
private List<string> _userGroups = AWSConfigs.InitializeCollections ? new List<string>() : null;
50-
private string _userId;
5149

5250
/// <summary>
5351
/// Gets and sets the property ApplicationId.
@@ -158,42 +156,5 @@ internal bool IsSetQueryText()
158156
return this._queryText != null;
159157
}
160158

161-
/// <summary>
162-
/// Gets and sets the property UserGroups.
163-
/// <para>
164-
/// The groups the user belongs to. Used for access control.
165-
/// </para>
166-
/// </summary>
167-
public List<string> UserGroups
168-
{
169-
get { return this._userGroups; }
170-
set { this._userGroups = value; }
171-
}
172-
173-
// Check to see if UserGroups property is set
174-
internal bool IsSetUserGroups()
175-
{
176-
return this._userGroups != null && (this._userGroups.Count > 0 || !AWSConfigs.InitializeCollections);
177-
}
178-
179-
/// <summary>
180-
/// Gets and sets the property UserId.
181-
/// <para>
182-
/// The ID of the user performing the search. Used for access control.
183-
/// </para>
184-
/// </summary>
185-
[AWSProperty(Min=1, Max=1024)]
186-
public string UserId
187-
{
188-
get { return this._userId; }
189-
set { this._userId = value; }
190-
}
191-
192-
// Check to see if UserId property is set
193-
internal bool IsSetUserId()
194-
{
195-
return this._userId != null;
196-
}
197-
198159
}
199160
}

sdk/src/Services/QBusiness/Generated/_bcl35/AmazonQBusinessClient.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4679,10 +4679,10 @@ public virtual PutGroupResponse EndPutGroup(IAsyncResult asyncResult)
46794679
/// <summary>
46804680
/// Searches for relevant content in a Q Business application based on a query. This operation
46814681
/// takes a search query text, the Q Business application identifier, and optional filters
4682-
/// (such as user ID, user groups, content source, and maximum results) as input. It returns
4683-
/// a list of relevant content items, where each item includes the content text, the unique
4684-
/// document identifier, the document title, the document URI, any relevant document attributes,
4685-
/// and score attributes indicating the confidence level of the relevance.
4682+
/// (such as content source and maximum results) as input. It returns a list of relevant
4683+
/// content items, where each item includes the content text, the unique document identifier,
4684+
/// the document title, the document URI, any relevant document attributes, and score
4685+
/// attributes indicating the confidence level of the relevance.
46864686
/// </summary>
46874687
/// <param name="request">Container for the necessary parameters to execute the SearchRelevantContent service method.</param>
46884688
///

sdk/src/Services/QBusiness/Generated/_bcl35/IAmazonQBusiness.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3691,10 +3691,10 @@ public partial interface IAmazonQBusiness : IAmazonService, IDisposable
36913691
/// <summary>
36923692
/// Searches for relevant content in a Q Business application based on a query. This operation
36933693
/// takes a search query text, the Q Business application identifier, and optional filters
3694-
/// (such as user ID, user groups, content source, and maximum results) as input. It returns
3695-
/// a list of relevant content items, where each item includes the content text, the unique
3696-
/// document identifier, the document title, the document URI, any relevant document attributes,
3697-
/// and score attributes indicating the confidence level of the relevance.
3694+
/// (such as content source and maximum results) as input. It returns a list of relevant
3695+
/// content items, where each item includes the content text, the unique document identifier,
3696+
/// the document title, the document URI, any relevant document attributes, and score
3697+
/// attributes indicating the confidence level of the relevance.
36983698
/// </summary>
36993699
/// <param name="request">Container for the necessary parameters to execute the SearchRelevantContent service method.</param>
37003700
///

sdk/src/Services/QBusiness/Generated/_bcl45/AmazonQBusinessClient.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5365,10 +5365,10 @@ public virtual PutGroupResponse PutGroup(PutGroupRequest request)
53655365
/// <summary>
53665366
/// Searches for relevant content in a Q Business application based on a query. This operation
53675367
/// takes a search query text, the Q Business application identifier, and optional filters
5368-
/// (such as user ID, user groups, content source, and maximum results) as input. It returns
5369-
/// a list of relevant content items, where each item includes the content text, the unique
5370-
/// document identifier, the document title, the document URI, any relevant document attributes,
5371-
/// and score attributes indicating the confidence level of the relevance.
5368+
/// (such as content source and maximum results) as input. It returns a list of relevant
5369+
/// content items, where each item includes the content text, the unique document identifier,
5370+
/// the document title, the document URI, any relevant document attributes, and score
5371+
/// attributes indicating the confidence level of the relevance.
53725372
/// </summary>
53735373
/// <param name="request">Container for the necessary parameters to execute the SearchRelevantContent service method.</param>
53745374
///
@@ -5411,10 +5411,10 @@ public virtual SearchRelevantContentResponse SearchRelevantContent(SearchRelevan
54115411
/// <summary>
54125412
/// Searches for relevant content in a Q Business application based on a query. This operation
54135413
/// takes a search query text, the Q Business application identifier, and optional filters
5414-
/// (such as user ID, user groups, content source, and maximum results) as input. It returns
5415-
/// a list of relevant content items, where each item includes the content text, the unique
5416-
/// document identifier, the document title, the document URI, any relevant document attributes,
5417-
/// and score attributes indicating the confidence level of the relevance.
5414+
/// (such as content source and maximum results) as input. It returns a list of relevant
5415+
/// content items, where each item includes the content text, the unique document identifier,
5416+
/// the document title, the document URI, any relevant document attributes, and score
5417+
/// attributes indicating the confidence level of the relevance.
54185418
/// </summary>
54195419
/// <param name="request">Container for the necessary parameters to execute the SearchRelevantContent service method.</param>
54205420
/// <param name="cancellationToken">

sdk/src/Services/QBusiness/Generated/_bcl45/IAmazonQBusiness.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4429,10 +4429,10 @@ public partial interface IAmazonQBusiness : IAmazonService, IDisposable
44294429
/// <summary>
44304430
/// Searches for relevant content in a Q Business application based on a query. This operation
44314431
/// takes a search query text, the Q Business application identifier, and optional filters
4432-
/// (such as user ID, user groups, content source, and maximum results) as input. It returns
4433-
/// a list of relevant content items, where each item includes the content text, the unique
4434-
/// document identifier, the document title, the document URI, any relevant document attributes,
4435-
/// and score attributes indicating the confidence level of the relevance.
4432+
/// (such as content source and maximum results) as input. It returns a list of relevant
4433+
/// content items, where each item includes the content text, the unique document identifier,
4434+
/// the document title, the document URI, any relevant document attributes, and score
4435+
/// attributes indicating the confidence level of the relevance.
44364436
/// </summary>
44374437
/// <param name="request">Container for the necessary parameters to execute the SearchRelevantContent service method.</param>
44384438
///
@@ -4469,10 +4469,10 @@ public partial interface IAmazonQBusiness : IAmazonService, IDisposable
44694469
/// <summary>
44704470
/// Searches for relevant content in a Q Business application based on a query. This operation
44714471
/// takes a search query text, the Q Business application identifier, and optional filters
4472-
/// (such as user ID, user groups, content source, and maximum results) as input. It returns
4473-
/// a list of relevant content items, where each item includes the content text, the unique
4474-
/// document identifier, the document title, the document URI, any relevant document attributes,
4475-
/// and score attributes indicating the confidence level of the relevance.
4472+
/// (such as content source and maximum results) as input. It returns a list of relevant
4473+
/// content items, where each item includes the content text, the unique document identifier,
4474+
/// the document title, the document URI, any relevant document attributes, and score
4475+
/// attributes indicating the confidence level of the relevance.
44764476
/// </summary>
44774477
/// <param name="request">Container for the necessary parameters to execute the SearchRelevantContent service method.</param>
44784478
/// <param name="cancellationToken">

0 commit comments

Comments
 (0)