@aws-sdk/client-kendra 3.321.1 → 3.325.0

package/dist-types/ts3.4/commands/GetQuerySuggestionsCommand.d.ts

@@ -11,10 +11,8 @@ import {
   ServiceInputTypes,
   ServiceOutputTypes,
 } from "../KendraClient";
-import {
-  GetQuerySuggestionsRequest,
-  GetQuerySuggestionsResponse,
-} from "../models/models_0";
+import { GetQuerySuggestionsResponse } from "../models/models_0";
+import { GetQuerySuggestionsRequest } from "../models/models_1";
 export interface GetQuerySuggestionsCommandInput
   extends GetQuerySuggestionsRequest {}
 export interface GetQuerySuggestionsCommandOutput

package/dist-types/ts3.4/models/models_0.d.ts

@@ -169,6 +169,34 @@ export interface DocumentAttribute {
   Key: string | undefined;
   Value: DocumentAttributeValue | undefined;
 }
+export declare const AttributeSuggestionsMode: {
+  readonly ACTIVE: "ACTIVE";
+  readonly INACTIVE: "INACTIVE";
+};
+export type AttributeSuggestionsMode =
+  (typeof AttributeSuggestionsMode)[keyof typeof AttributeSuggestionsMode];
+export interface SuggestableConfig {
+  AttributeName?: string;
+  Suggestable?: boolean;
+}
+export interface AttributeSuggestionsDescribeConfig {
+  SuggestableConfigList?: SuggestableConfig[];
+  AttributeSuggestionsMode?: AttributeSuggestionsMode | string;
+}
+export interface DataSourceGroup {
+  GroupId: string | undefined;
+  DataSourceId: string | undefined;
+}
+export interface UserContext {
+  Token?: string;
+  UserId?: string;
+  Groups?: string[];
+  DataSourceGroups?: DataSourceGroup[];
+}
+export interface AttributeSuggestionsUpdateConfig {
+  SuggestableConfigList?: SuggestableConfig[];
+  AttributeSuggestionsMode?: AttributeSuggestionsMode | string;
+}
 export interface BasicAuthenticationConfiguration {
   Host: string | undefined;
   Port: number | undefined;
@@ -1440,6 +1468,7 @@ export interface DescribeQuerySuggestionsConfigResponse {
   LastSuggestionsBuildTime?: Date;
   LastClearTime?: Date;
   TotalSuggestionsCount?: number;
+  AttributeSuggestionsConfig?: AttributeSuggestionsDescribeConfig;
 }
 export interface DescribeThesaurusRequest {
   Id: string | undefined;
@@ -1486,10 +1515,16 @@ export interface DisassociatePersonasFromEntitiesRequest {
 export interface DisassociatePersonasFromEntitiesResponse {
   FailedEntityList?: FailedEntity[];
 }
-export interface GetQuerySuggestionsRequest {
-  IndexId: string | undefined;
-  QueryText: string | undefined;
-  MaxSuggestionsCount?: number;
+export declare const SuggestionType: {
+  readonly DOCUMENT_ATTRIBUTES: "DOCUMENT_ATTRIBUTES";
+  readonly QUERY: "QUERY";
+};
+export type SuggestionType =
+  (typeof SuggestionType)[keyof typeof SuggestionType];
+export interface SourceDocument {
+  DocumentId?: string;
+  SuggestionAttributes?: string[];
+  AdditionalAttributes?: DocumentAttribute[];
 }
 export interface SuggestionHighlight {
   BeginOffset?: number;
@@ -1505,6 +1540,7 @@ export interface SuggestionValue {
 export interface Suggestion {
   Id?: string;
   Value?: SuggestionValue;
+  SourceDocuments?: SourceDocument[];
 }
 export interface GetQuerySuggestionsResponse {
   QuerySuggestionsId?: string;
@@ -1828,16 +1864,6 @@ export interface SortingConfiguration {
 export interface SpellCorrectionConfiguration {
   IncludeQuerySpellCheckSuggestions: boolean | undefined;
 }
-export interface DataSourceGroup {
-  GroupId: string | undefined;
-  DataSourceId: string | undefined;
-}
-export interface UserContext {
-  Token?: string;
-  UserId?: string;
-  Groups?: string[];
-  DataSourceGroups?: DataSourceGroup[];
-}
 export interface FeaturedResultsItem {
   Id?: string;
   Type?: QueryResultType | string;
@@ -1880,38 +1906,6 @@ export interface TableExcerpt {
   Rows?: TableRow[];
   TotalNumberOfRows?: number;
 }
-export interface QueryResultItem {
-  Id?: string;
-  Type?: QueryResultType | string;
-  Format?: QueryResultFormat | string;
-  AdditionalAttributes?: AdditionalResultAttribute[];
-  DocumentId?: string;
-  DocumentTitle?: TextWithHighlights;
-  DocumentExcerpt?: TextWithHighlights;
-  DocumentURI?: string;
-  DocumentAttributes?: DocumentAttribute[];
-  ScoreAttributes?: ScoreAttributes;
-  FeedbackToken?: string;
-  TableExcerpt?: TableExcerpt;
-}
-export interface Correction {
-  BeginOffset?: number;
-  EndOffset?: number;
-  Term?: string;
-  CorrectedTerm?: string;
-}
-export interface SpellCorrectedQuery {
-  SuggestedQueryText?: string;
-  Corrections?: Correction[];
-}
-export declare const WarningCode: {
-  readonly QUERY_LANGUAGE_INVALID_SYNTAX: "QUERY_LANGUAGE_INVALID_SYNTAX";
-};
-export type WarningCode = (typeof WarningCode)[keyof typeof WarningCode];
-export interface Warning {
-  Message?: string;
-  Code?: WarningCode | string;
-}
 export declare const ServerSideEncryptionConfigurationFilterSensitiveLog: (
   obj: ServerSideEncryptionConfiguration
 ) => any;

package/dist-types/ts3.4/models/models_1.d.ts

@@ -1,6 +1,8 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { KendraServiceException as __BaseException } from "./KendraServiceException";
 import {
+  AdditionalResultAttribute,
+  AttributeSuggestionsUpdateConfig,
   CapacityUnitsConfiguration,
   CustomDocumentEnrichmentConfiguration,
   DataSourceConfiguration,
@@ -18,19 +20,53 @@ import {
   HierarchicalPrincipal,
   Mode,
   Principal,
-  QueryResultItem,
+  QueryResultFormat,
   QueryResultType,
   S3Path,
+  ScoreAttributes,
   SortingConfiguration,
-  SpellCorrectedQuery,
   SpellCorrectionConfiguration,
+  SuggestionType,
+  TableExcerpt,
   Tag,
+  TextWithHighlights,
   UserContext,
   UserContextPolicy,
   UserGroupResolutionConfiguration,
   UserTokenConfiguration,
-  Warning,
 } from "./models_0";
+export interface QueryResultItem {
+  Id?: string;
+  Type?: QueryResultType | string;
+  Format?: QueryResultFormat | string;
+  AdditionalAttributes?: AdditionalResultAttribute[];
+  DocumentId?: string;
+  DocumentTitle?: TextWithHighlights;
+  DocumentExcerpt?: TextWithHighlights;
+  DocumentURI?: string;
+  DocumentAttributes?: DocumentAttribute[];
+  ScoreAttributes?: ScoreAttributes;
+  FeedbackToken?: string;
+  TableExcerpt?: TableExcerpt;
+}
+export interface Correction {
+  BeginOffset?: number;
+  EndOffset?: number;
+  Term?: string;
+  CorrectedTerm?: string;
+}
+export interface SpellCorrectedQuery {
+  SuggestedQueryText?: string;
+  Corrections?: Correction[];
+}
+export declare const WarningCode: {
+  readonly QUERY_LANGUAGE_INVALID_SYNTAX: "QUERY_LANGUAGE_INVALID_SYNTAX";
+};
+export type WarningCode = (typeof WarningCode)[keyof typeof WarningCode];
+export interface Warning {
+  Message?: string;
+  Code?: WarningCode | string;
+}
 export declare class ResourceInUseException extends __BaseException {
   readonly name: "ResourceInUseException";
   readonly $fault: "client";
@@ -146,6 +182,7 @@ export interface UpdateQuerySuggestionsConfigRequest {
   IncludeQueriesWithoutUserInformation?: boolean;
   MinimumNumberOfQueryingUsers?: number;
   MinimumQueryCount?: number;
+  AttributeSuggestionsConfig?: AttributeSuggestionsUpdateConfig;
 }
 export interface UpdateThesaurusRequest {
   Id: string | undefined;
@@ -191,6 +228,19 @@ export interface QueryResult {
   SpellCorrectedQueries?: SpellCorrectedQuery[];
   FeaturedResultsItems?: FeaturedResultsItem[];
 }
+export interface AttributeSuggestionsGetConfig {
+  SuggestionAttributes?: string[];
+  AdditionalResponseAttributes?: string[];
+  AttributeFilter?: AttributeFilter;
+  UserContext?: UserContext;
+}
+export interface GetQuerySuggestionsRequest {
+  IndexId: string | undefined;
+  QueryText: string | undefined;
+  MaxSuggestionsCount?: number;
+  SuggestionTypes?: (SuggestionType | string)[];
+  AttributeSuggestionsConfig?: AttributeSuggestionsGetConfig;
+}
 export interface QueryRequest {
   IndexId: string | undefined;
   QueryText?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-kendra",
   "description": "AWS SDK for JavaScript Kendra Client for Node.js, Browser and React Native",
-  "version": "3.321.1",
+  "version": "3.325.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,33 +21,33 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.321.1",
+    "@aws-sdk/client-sts": "3.325.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.321.1",
+    "@aws-sdk/credential-provider-node": "3.325.0",
     "@aws-sdk/fetch-http-handler": "3.310.0",
     "@aws-sdk/hash-node": "3.310.0",
     "@aws-sdk/invalid-dependency": "3.310.0",
-    "@aws-sdk/middleware-content-length": "3.310.0",
-    "@aws-sdk/middleware-endpoint": "3.310.0",
-    "@aws-sdk/middleware-host-header": "3.310.0",
-    "@aws-sdk/middleware-logger": "3.310.0",
-    "@aws-sdk/middleware-recursion-detection": "3.310.0",
-    "@aws-sdk/middleware-retry": "3.310.0",
-    "@aws-sdk/middleware-serde": "3.310.0",
-    "@aws-sdk/middleware-signing": "3.310.0",
-    "@aws-sdk/middleware-stack": "3.310.0",
-    "@aws-sdk/middleware-user-agent": "3.319.0",
+    "@aws-sdk/middleware-content-length": "3.325.0",
+    "@aws-sdk/middleware-endpoint": "3.325.0",
+    "@aws-sdk/middleware-host-header": "3.325.0",
+    "@aws-sdk/middleware-logger": "3.325.0",
+    "@aws-sdk/middleware-recursion-detection": "3.325.0",
+    "@aws-sdk/middleware-retry": "3.325.0",
+    "@aws-sdk/middleware-serde": "3.325.0",
+    "@aws-sdk/middleware-signing": "3.325.0",
+    "@aws-sdk/middleware-stack": "3.325.0",
+    "@aws-sdk/middleware-user-agent": "3.325.0",
     "@aws-sdk/node-config-provider": "3.310.0",
     "@aws-sdk/node-http-handler": "3.321.1",
     "@aws-sdk/protocol-http": "3.310.0",
-    "@aws-sdk/smithy-client": "3.316.0",
+    "@aws-sdk/smithy-client": "3.325.0",
     "@aws-sdk/types": "3.310.0",
     "@aws-sdk/url-parser": "3.310.0",
     "@aws-sdk/util-base64": "3.310.0",
     "@aws-sdk/util-body-length-browser": "3.310.0",
     "@aws-sdk/util-body-length-node": "3.310.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.316.0",
-    "@aws-sdk/util-defaults-mode-node": "3.316.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.325.0",
+    "@aws-sdk/util-defaults-mode-node": "3.325.0",
     "@aws-sdk/util-endpoints": "3.319.0",
     "@aws-sdk/util-retry": "3.310.0",
     "@aws-sdk/util-user-agent-browser": "3.310.0",