@aws-sdk/client-kendra 3.321.1 → 3.326.0

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

@@ -1,6 +1,143 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { KendraServiceException as __BaseException } from "./KendraServiceException";
-import { CapacityUnitsConfiguration, CustomDocumentEnrichmentConfiguration, DataSourceConfiguration, DataSourceVpcConfiguration, DocumentAttribute, DocumentAttributeValue, DocumentAttributeValueType, DocumentMetadataConfiguration, DocumentRelevanceConfiguration, ExperienceConfiguration, FeaturedDocument, FeaturedResultsItem, FeaturedResultsSet, FeaturedResultsSetStatus, HierarchicalPrincipal, Mode, Principal, QueryResultItem, QueryResultType, S3Path, SortingConfiguration, SpellCorrectedQuery, SpellCorrectionConfiguration, Tag, UserContext, UserContextPolicy, UserGroupResolutionConfiguration, UserTokenConfiguration, Warning } from "./models_0";
+import { AdditionalResultAttribute, AttributeSuggestionsUpdateConfig, CapacityUnitsConfiguration, CustomDocumentEnrichmentConfiguration, DataSourceConfiguration, DataSourceVpcConfiguration, DocumentAttribute, DocumentAttributeValue, DocumentAttributeValueType, DocumentMetadataConfiguration, DocumentRelevanceConfiguration, ExperienceConfiguration, FeaturedDocument, FeaturedResultsItem, FeaturedResultsSet, FeaturedResultsSetStatus, HierarchicalPrincipal, Mode, Principal, QueryResultFormat, QueryResultType, S3Path, ScoreAttributes, SortingConfiguration, SpellCorrectionConfiguration, SuggestionType, TableExcerpt, Tag, TextWithHighlights, UserContext, UserContextPolicy, UserGroupResolutionConfiguration, UserTokenConfiguration } from "./models_0";
+/**
+ * @public
+ * <p>A single query result.</p>
+ *          <p>A query result contains information about a document returned by the query. This
+ *          includes the original location of the document, a list of attributes assigned to the
+ *          document, and relevant text from the document that satisfies the query.</p>
+ */
+export interface QueryResultItem {
+    /**
+     * <p>The identifier for the query result.</p>
+     */
+    Id?: string;
+    /**
+     * <p>The type of document within the response. For example, a response could include a
+     *          question-answer that's relevant to the query.</p>
+     */
+    Type?: QueryResultType | string;
+    /**
+     * <p>If the <code>Type</code> of document within the response is <code>ANSWER</code>, then it
+     *          is either a <code>TABLE</code> answer or <code>TEXT</code> answer. If it's a table answer,
+     *          a table excerpt is returned in <code>TableExcerpt</code>. If it's a text answer, a text
+     *          excerpt is returned in <code>DocumentExcerpt</code>.</p>
+     */
+    Format?: QueryResultFormat | string;
+    /**
+     * <p>One or more additional attributes associated with the query result.</p>
+     */
+    AdditionalAttributes?: AdditionalResultAttribute[];
+    /**
+     * <p>The identifier for the document.</p>
+     */
+    DocumentId?: string;
+    /**
+     * <p>The title of the document. Contains the text of the title and information for
+     *          highlighting the relevant terms in the title.</p>
+     */
+    DocumentTitle?: TextWithHighlights;
+    /**
+     * <p>An extract of the text in the document. Contains information about highlighting the
+     *          relevant terms in the excerpt.</p>
+     */
+    DocumentExcerpt?: TextWithHighlights;
+    /**
+     * <p>The URI of the original location of the document.</p>
+     */
+    DocumentURI?: string;
+    /**
+     * <p>An array of document attributes assigned to a document in the search results. For
+     *          example, the document author (<code>_author</code>) or the source URI
+     *             (<code>_source_uri</code>) of the document.</p>
+     */
+    DocumentAttributes?: DocumentAttribute[];
+    /**
+     * <p>Indicates the confidence that Amazon Kendra has that a result matches the query
+     *          that you provided. Each result is placed into a bin that indicates the confidence,
+     *             <code>VERY_HIGH</code>, <code>HIGH</code>, <code>MEDIUM</code> and <code>LOW</code>. You
+     *          can use the score to determine if a response meets the confidence needed for your
+     *          application.</p>
+     *          <p>The field is only set to <code>LOW</code> when the <code>Type</code> field is set to
+     *             <code>DOCUMENT</code> and Amazon Kendra is not confident that the result matches
+     *          the query.</p>
+     */
+    ScoreAttributes?: ScoreAttributes;
+    /**
+     * <p>A token that identifies a particular result from a particular query. Use this token to
+     *          provide click-through feedback for the result. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html">Submitting feedback
+     *          </a>.</p>
+     */
+    FeedbackToken?: string;
+    /**
+     * <p>An excerpt from a table within a document.</p>
+     */
+    TableExcerpt?: TableExcerpt;
+}
+/**
+ * @public
+ * <p>A corrected misspelled word in a query.</p>
+ */
+export interface Correction {
+    /**
+     * <p>The zero-based location in the response string or text where
+     *             the corrected word starts.</p>
+     */
+    BeginOffset?: number;
+    /**
+     * <p>The zero-based location in the response string or text where
+     *             the corrected word ends.</p>
+     */
+    EndOffset?: number;
+    /**
+     * <p>The string or text of a misspelled word in a query.</p>
+     */
+    Term?: string;
+    /**
+     * <p>The string or text of a corrected misspelled word in a query.</p>
+     */
+    CorrectedTerm?: string;
+}
+/**
+ * @public
+ * <p>A query with suggested spell corrections. </p>
+ */
+export interface SpellCorrectedQuery {
+    /**
+     * <p>The query with the suggested spell corrections.</p>
+     */
+    SuggestedQueryText?: string;
+    /**
+     * <p>The corrected misspelled word or words in a query.</p>
+     */
+    Corrections?: Correction[];
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const WarningCode: {
+    readonly QUERY_LANGUAGE_INVALID_SYNTAX: "QUERY_LANGUAGE_INVALID_SYNTAX";
+};
+/**
+ * @public
+ */
+export type WarningCode = (typeof WarningCode)[keyof typeof WarningCode];
+/**
+ * @public
+ * <p>The warning code and message that explains a problem with a query.</p>
+ */
+export interface Warning {
+    /**
+     * <p>The message that explains the problem with the query.</p>
+     */
+    Message?: string;
+    /**
+     * <p>The code used to show the type of warning for the query.</p>
+     */
+    Code?: WarningCode | string;
+}
 /**
  * @public
  * <p>The resource you want to use is currently in use. Please check you have provided the
@@ -292,7 +429,7 @@ export interface UpdateFeaturedResultsSetRequest {
      */
     IndexId: string | undefined;
     /**
-     * <p>The identifier of the index used for featuring results.</p>
+     * <p>The identifier of the set of featured results that you want to update.</p>
      */
     FeaturedResultsSetId: string | undefined;
     /**
@@ -478,6 +615,11 @@ export interface UpdateQuerySuggestionsConfigRequest {
      *          <p>How you tune this setting depends on your specific needs.</p>
      */
     MinimumQueryCount?: number;
+    /**
+     * <p>Configuration information for the document fields/attributes that you want to base
+     *             query suggestions on.</p>
+     */
+    AttributeSuggestionsConfig?: AttributeSuggestionsUpdateConfig;
 }
 /**
  * @public
@@ -715,6 +857,75 @@ export interface QueryResult {
      */
     FeaturedResultsItems?: FeaturedResultsItem[];
 }
+/**
+ * @public
+ * <p>Provides the configuration information for the document fields/attributes that you want
+ *             to base query suggestions on.</p>
+ */
+export interface AttributeSuggestionsGetConfig {
+    /**
+     * <p>The list of document field/attribute keys or field names to use for query suggestions.
+     *             If the content within any of the fields match what your user starts typing as their query,
+     *             then the field content is returned as a query suggestion.</p>
+     */
+    SuggestionAttributes?: string[];
+    /**
+     * <p>The list of additional document field/attribute keys or field names to include in the
+     *             response. You can use additional fields to provide extra information in the response.
+     *             Additional fields are not used to based suggestions on.</p>
+     */
+    AdditionalResponseAttributes?: string[];
+    /**
+     * <p>Filters the search results based on document fields/attributes.</p>
+     */
+    AttributeFilter?: AttributeFilter;
+    /**
+     * <p>Applies user context filtering so that only users who are given access to certain
+     *             documents see these document in their search results.</p>
+     */
+    UserContext?: UserContext;
+}
+/**
+ * @public
+ */
+export interface GetQuerySuggestionsRequest {
+    /**
+     * <p>The identifier of the index you want to get query suggestions from.</p>
+     */
+    IndexId: string | undefined;
+    /**
+     * <p>The text of a user's query to generate query suggestions.</p>
+     *          <p>A query is suggested if the query prefix matches
+     *             what a user starts to type as their query.</p>
+     *          <p>Amazon Kendra does not show any suggestions if a user
+     *             types fewer than two characters or more than 60 characters.
+     *             A query must also have at least one search result and contain
+     *             at least one word of more than four characters.</p>
+     */
+    QueryText: string | undefined;
+    /**
+     * <p>The maximum number of query suggestions you want to show
+     *             to your users.</p>
+     */
+    MaxSuggestionsCount?: number;
+    /**
+     * <p>The suggestions type to base query suggestions on. The suggestion
+     *             types are query history or document fields/attributes. You can set
+     *             one type or the other.</p>
+     *          <p>If you set query history as your suggestions type, Amazon Kendra
+     *             suggests queries relevant to your users based on popular queries in
+     *             the query history.</p>
+     *          <p>If you set document fields/attributes as your suggestions type,
+     *             Amazon Kendra suggests queries relevant to your users based on the
+     *             contents of document fields.</p>
+     */
+    SuggestionTypes?: (SuggestionType | string)[];
+    /**
+     * <p>Configuration information for the document fields/attributes that you
+     *             want to base query suggestions on.</p>
+     */
+    AttributeSuggestionsConfig?: AttributeSuggestionsGetConfig;
+}
 /**
  * @public
  */

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.326.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.326.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.321.1",
+    "@aws-sdk/credential-provider-node": "3.326.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",