@aws-sdk/client-kendra 3.357.0 → 3.359.0

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

@@ -26,7 +26,7 @@ export interface QueryResultItem {
      */
     Format?: QueryResultFormat | string;
     /**
-     * <p>One or more additional attributes associated with the query result.</p>
+     * <p>One or more additional fields/attributes associated with the query result.</p>
      */
     AdditionalAttributes?: AdditionalResultAttribute[];
     /**
@@ -48,26 +48,25 @@ export interface QueryResultItem {
      */
     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>
+     * <p>An array of document fields/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
+     * <p>Indicates the confidence level of Amazon Kendra providing a relevant result for
+     *          the query. 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>
+     *             <code>DOCUMENT</code> and Amazon Kendra is not confident that the result is
+     *          relevant to 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>
+     *          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;
     /**
@@ -138,6 +137,52 @@ export interface Warning {
      */
     Code?: WarningCode | string;
 }
+/**
+ * @public
+ * <p>A single retrieved relevant passage result.</p>
+ */
+export interface RetrieveResultItem {
+    /**
+     * <p>The identifier of the relevant passage result.</p>
+     */
+    Id?: string;
+    /**
+     * <p>The identifier of the document.</p>
+     */
+    DocumentId?: string;
+    /**
+     * <p>The title of the document.</p>
+     */
+    DocumentTitle?: string;
+    /**
+     * <p>The contents of the relevant passage.</p>
+     */
+    Content?: string;
+    /**
+     * <p>The URI of the original location of the document.</p>
+     */
+    DocumentURI?: string;
+    /**
+     * <p>An array of document fields/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[];
+}
+/**
+ * @public
+ */
+export interface RetrieveResult {
+    /**
+     * <p>The identifier of query used for the search. You also use <code>QueryId</code> to
+     *             identify the search when using the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html">Submitfeedback</a> API.</p>
+     */
+    QueryId?: string;
+    /**
+     * <p>The results of the retrieved relevant passages for the search.</p>
+     */
+    ResultItems?: RetrieveResultItem[];
+}
 /**
  * @public
  * <p>The resource you want to use is currently in use. Please check you have provided the
@@ -819,8 +864,8 @@ export interface AttributeFilter {
  */
 export interface QueryResult {
     /**
-     * <p>The identifier for the search. You use <code>QueryId</code> to identify the
-     *          search when using the feedback API.</p>
+     * <p>The identifier for the search. You also use <code>QueryId</code> to identify the
+     *          search when using the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html">SubmitFeedback</a> API.</p>
      */
     QueryId?: string;
     /**
@@ -829,13 +874,13 @@ export interface QueryResult {
     ResultItems?: QueryResultItem[];
     /**
      * <p>Contains the facet results. A <code>FacetResult</code> contains the counts for each
-     *          attribute key that was specified in the <code>Facets</code> input parameter.</p>
+     *          field/attribute key that was specified in the <code>Facets</code> input parameter.</p>
      */
     FacetResults?: FacetResult[];
     /**
-     * <p>The total number of items found by the search; however, you can only retrieve up to 100
-     *          items. For example, if the search found 192 items, you can only retrieve the first 100 of
-     *          the items.</p>
+     * <p>The total number of items found by the search. However, you can only retrieve up to
+     *          100 items. For example, if the search found 192 items, you can only retrieve the first
+     *          100 of the items.</p>
      */
     TotalNumberOfResults?: number;
     /**
@@ -885,6 +930,64 @@ export interface AttributeSuggestionsGetConfig {
      */
     UserContext?: UserContext;
 }
+/**
+ * @public
+ */
+export interface RetrieveRequest {
+    /**
+     * <p>The identifier of the index to retrieve relevant passages for the
+     *             search.</p>
+     */
+    IndexId: string | undefined;
+    /**
+     * <p>The input query text to retrieve relevant passages for the search.
+     *             Amazon Kendra truncates queries at 30 token words, which excludes
+     *             punctuation and stop words. Truncation still applies if you use Boolean
+     *             or more advanced, complex queries.</p>
+     */
+    QueryText: string | undefined;
+    /**
+     * <p>Filters search results by document fields/attributes. You can only provide
+     *             one attribute filter; however, the <code>AndAllFilters</code>, <code>NotFilter</code>,
+     *             and <code>OrAllFilters</code> parameters contain a list of other filters.</p>
+     *          <p>The <code>AttributeFilter</code> parameter means you can create a set of
+     *             filtering rules that a document must satisfy to be included in the query results.</p>
+     */
+    AttributeFilter?: AttributeFilter;
+    /**
+     * <p>A list of document fields/attributes to include in the response. You can limit
+     *             the response to include certain document fields. By default, all document
+     *             fields are included in the response.</p>
+     */
+    RequestedDocumentAttributes?: string[];
+    /**
+     * <p>Overrides relevance tuning configurations of fields/attributes set at the index
+     *             level.</p>
+     *          <p>If you use this API to override the relevance tuning configured at the index level,
+     *             but there is no relevance tuning configured at the index level, then
+     *             Amazon Kendra does not apply any relevance tuning.</p>
+     *          <p>If there is relevance tuning configured for fields at the index level, and you use
+     *             this API to override only some of these fields, then for the fields you did not
+     *             override, the importance is set to 1.</p>
+     */
+    DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[];
+    /**
+     * <p>Retrieved relevant passages are returned in pages the size of the
+     *             <code>PageSize</code> parameter. By default, Amazon Kendra returns the first page
+     *             of results. Use this parameter to get result pages after the first one.</p>
+     */
+    PageNumber?: number;
+    /**
+     * <p>Sets the number of retrieved relevant passages that are returned in each page of
+     *             results. The default page size is 10. The maximum number of results returned is 100.
+     *             If you ask for more than 100 results, only 100 are returned.</p>
+     */
+    PageSize?: number;
+    /**
+     * <p>The user context token or user and group information.</p>
+     */
+    UserContext?: UserContext;
+}
 /**
  * @public
  */
@@ -931,8 +1034,7 @@ export interface GetQuerySuggestionsRequest {
  */
 export interface QueryRequest {
     /**
-     * <p>The identifier of the index to search. The identifier is returned in the response
-     *          from the <code>CreateIndex</code> API.</p>
+     * <p>The identifier of the index for the search.</p>
      */
     IndexId: string | undefined;
     /**
@@ -942,46 +1044,43 @@ export interface QueryRequest {
      */
     QueryText?: string;
     /**
-     * <p>Enables filtered searches based on document attributes. You can only provide one
-     *          attribute filter; however, the <code>AndAllFilters</code>, <code>NotFilter</code>, and
-     *             <code>OrAllFilters</code> parameters contain a list of other filters.</p>
-     *          <p>The <code>AttributeFilter</code> parameter enables you to create a set of filtering
-     *          rules that a document must satisfy to be included in the query results.</p>
+     * <p>Filters search results by document fields/attributes. You can only provide
+     *          one attribute filter; however, the <code>AndAllFilters</code>, <code>NotFilter</code>,
+     *          and <code>OrAllFilters</code> parameters contain a list of other filters.</p>
+     *          <p>The <code>AttributeFilter</code> parameter means you can create a set of
+     *          filtering rules that a document must satisfy to be included in the query results.</p>
      */
     AttributeFilter?: AttributeFilter;
     /**
-     * <p>An array of documents attributes. Amazon Kendra returns a count for each attribute
-     *          key specified. This helps your users narrow their search.</p>
+     * <p>An array of documents fields/attributes for faceted search. Amazon Kendra returns a
+     *          count for each field key specified. This helps your users narrow their search.</p>
      */
     Facets?: Facet[];
     /**
-     * <p>An array of document attributes to include in the response. You can limit the response
-     *          to include certain document attributes. By default all document attributes are included in
-     *          the response.</p>
+     * <p>An array of document fields/attributes to include in the response. You can limit the
+     *          response to include certain document fields. By default, all document attributes are
+     *          included in the response.</p>
      */
     RequestedDocumentAttributes?: string[];
     /**
-     * <p>Sets the type of query. Only results for the specified query type are returned.</p>
+     * <p>Sets the type of query result or response. Only results for the specified type are
+     *          returned.</p>
      */
     QueryResultTypeFilter?: QueryResultType | string;
     /**
-     * <p>Overrides relevance tuning configurations of fields or attributes set at the index
-     *          level.</p>
-     *          <p>If you use this API to override the relevance tuning configured at the index level, but
-     *          there is no relevance tuning configured at the index level, then Amazon Kendra does
-     *          not apply any relevance tuning.</p>
-     *          <p>If there is relevance tuning configured at the index level, but you do not use this API
-     *          to override any relevance tuning in the index, then Amazon Kendra uses the relevance
-     *          tuning that is configured at the index level.</p>
-     *          <p>If there is relevance tuning configured for fields at the index level, but you use this
-     *          API to override only some of these fields, then for the fields you did not override, the
-     *          importance is set to 1.</p>
+     * <p>Overrides relevance tuning configurations of fields/attributes set at the index level.</p>
+     *          <p>If you use this API to override the relevance tuning configured at the index level, but there
+     *          is no relevance tuning configured at the index level, then Amazon Kendra does not apply any
+     *          relevance tuning.</p>
+     *          <p>If there is relevance tuning configured for fields at the index level, and you use this API to
+     *          override only some of these fields, then for the fields you did not override, the importance is
+     *          set to 1.</p>
      */
     DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[];
     /**
-     * <p>Query results are returned in pages the size of the <code>PageSize</code> parameter. By
-     *          default, Amazon Kendra returns the first page of results. Use this parameter to get
-     *          result pages after the first one.</p>
+     * <p>Query results are returned in pages the size of the <code>PageSize</code> parameter.
+     *          By default, Amazon Kendra returns the first page of results. Use this parameter to
+     *          get result pages after the first one.</p>
      */
     PageNumber?: number;
     /**
@@ -996,7 +1095,7 @@ export interface QueryRequest {
      *          results should be sorted in ascending or descending order. In the case of ties in sorting
      *          the results, the results are sorted by relevance.</p>
      *          <p>If you don't provide sorting configuration, the results are sorted by the relevance that
-     *             Amazon Kendra determines for the result.</p>
+     *          Amazon Kendra determines for the result.</p>
      */
     SortingConfiguration?: SortingConfiguration;
     /**

package/dist-types/protocols/Aws_json1_1.d.ts

@@ -52,6 +52,7 @@ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } fro
 import { ListThesauriCommandInput, ListThesauriCommandOutput } from "../commands/ListThesauriCommand";
 import { PutPrincipalMappingCommandInput, PutPrincipalMappingCommandOutput } from "../commands/PutPrincipalMappingCommand";
 import { QueryCommandInput, QueryCommandOutput } from "../commands/QueryCommand";
+import { RetrieveCommandInput, RetrieveCommandOutput } from "../commands/RetrieveCommand";
 import { StartDataSourceSyncJobCommandInput, StartDataSourceSyncJobCommandOutput } from "../commands/StartDataSourceSyncJobCommand";
 import { StopDataSourceSyncJobCommandInput, StopDataSourceSyncJobCommandOutput } from "../commands/StopDataSourceSyncJobCommand";
 import { SubmitFeedbackCommandInput, SubmitFeedbackCommandOutput } from "../commands/SubmitFeedbackCommand";
@@ -273,6 +274,10 @@ export declare const se_PutPrincipalMappingCommand: (input: PutPrincipalMappingC
  * serializeAws_json1_1QueryCommand
  */
 export declare const se_QueryCommand: (input: QueryCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_json1_1RetrieveCommand
+ */
+export declare const se_RetrieveCommand: (input: RetrieveCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_json1_1StartDataSourceSyncJobCommand
  */
@@ -533,6 +538,10 @@ export declare const de_PutPrincipalMappingCommand: (output: __HttpResponse, con
  * deserializeAws_json1_1QueryCommand
  */
 export declare const de_QueryCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<QueryCommandOutput>;
+/**
+ * deserializeAws_json1_1RetrieveCommand
+ */
+export declare const de_RetrieveCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<RetrieveCommandOutput>;
 /**
  * deserializeAws_json1_1StartDataSourceSyncJobCommand
  */

package/dist-types/ts3.4/Kendra.d.ts

@@ -204,6 +204,10 @@ import {
   PutPrincipalMappingCommandOutput,
 } from "./commands/PutPrincipalMappingCommand";
 import { QueryCommandInput, QueryCommandOutput } from "./commands/QueryCommand";
+import {
+  RetrieveCommandInput,
+  RetrieveCommandOutput,
+} from "./commands/RetrieveCommand";
 import {
   StartDataSourceSyncJobCommandInput,
   StartDataSourceSyncJobCommandOutput,
@@ -952,6 +956,19 @@ export interface Kendra {
     options: __HttpHandlerOptions,
     cb: (err: any, data?: QueryCommandOutput) => void
   ): void;
+  retrieve(
+    args: RetrieveCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<RetrieveCommandOutput>;
+  retrieve(
+    args: RetrieveCommandInput,
+    cb: (err: any, data?: RetrieveCommandOutput) => void
+  ): void;
+  retrieve(
+    args: RetrieveCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: RetrieveCommandOutput) => void
+  ): void;
   startDataSourceSyncJob(
     args: StartDataSourceSyncJobCommandInput,
     options?: __HttpHandlerOptions

package/dist-types/ts3.4/KendraClient.d.ts

@@ -251,6 +251,10 @@ import {
   PutPrincipalMappingCommandOutput,
 } from "./commands/PutPrincipalMappingCommand";
 import { QueryCommandInput, QueryCommandOutput } from "./commands/QueryCommand";
+import {
+  RetrieveCommandInput,
+  RetrieveCommandOutput,
+} from "./commands/RetrieveCommand";
 import {
   StartDataSourceSyncJobCommandInput,
   StartDataSourceSyncJobCommandOutput,
@@ -362,6 +366,7 @@ export type ServiceInputTypes =
   | ListThesauriCommandInput
   | PutPrincipalMappingCommandInput
   | QueryCommandInput
+  | RetrieveCommandInput
   | StartDataSourceSyncJobCommandInput
   | StopDataSourceSyncJobCommandInput
   | SubmitFeedbackCommandInput
@@ -428,6 +433,7 @@ export type ServiceOutputTypes =
   | ListThesauriCommandOutput
   | PutPrincipalMappingCommandOutput
   | QueryCommandOutput
+  | RetrieveCommandOutput
   | StartDataSourceSyncJobCommandOutput
   | StopDataSourceSyncJobCommandOutput
   | SubmitFeedbackCommandOutput

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

@@ -0,0 +1,35 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+  Handler,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+} from "@aws-sdk/types";
+import {
+  KendraClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../KendraClient";
+import { RetrieveRequest, RetrieveResult } from "../models/models_1";
+export { __MetadataBearer, $Command };
+export interface RetrieveCommandInput extends RetrieveRequest {}
+export interface RetrieveCommandOutput
+  extends RetrieveResult,
+    __MetadataBearer {}
+export declare class RetrieveCommand extends $Command<
+  RetrieveCommandInput,
+  RetrieveCommandOutput,
+  KendraClientResolvedConfig
+> {
+  readonly input: RetrieveCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: RetrieveCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: KendraClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<RetrieveCommandInput, RetrieveCommandOutput>;
+  private serialize;
+  private deserialize;
+}

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

@@ -50,6 +50,7 @@ export * from "./ListTagsForResourceCommand";
 export * from "./ListThesauriCommand";
 export * from "./PutPrincipalMappingCommand";
 export * from "./QueryCommand";
+export * from "./RetrieveCommand";
 export * from "./StartDataSourceSyncJobCommand";
 export * from "./StopDataSourceSyncJobCommand";
 export * from "./SubmitFeedbackCommand";

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

@@ -67,6 +67,18 @@ export interface Warning {
   Message?: string;
   Code?: WarningCode | string;
 }
+export interface RetrieveResultItem {
+  Id?: string;
+  DocumentId?: string;
+  DocumentTitle?: string;
+  Content?: string;
+  DocumentURI?: string;
+  DocumentAttributes?: DocumentAttribute[];
+}
+export interface RetrieveResult {
+  QueryId?: string;
+  ResultItems?: RetrieveResultItem[];
+}
 export declare class ResourceInUseException extends __BaseException {
   readonly name: "ResourceInUseException";
   readonly $fault: "client";
@@ -234,6 +246,16 @@ export interface AttributeSuggestionsGetConfig {
   AttributeFilter?: AttributeFilter;
   UserContext?: UserContext;
 }
+export interface RetrieveRequest {
+  IndexId: string | undefined;
+  QueryText: string | undefined;
+  AttributeFilter?: AttributeFilter;
+  RequestedDocumentAttributes?: string[];
+  DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[];
+  PageNumber?: number;
+  PageSize?: number;
+  UserContext?: UserContext;
+}
 export interface GetQuerySuggestionsRequest {
   IndexId: string | undefined;
   QueryText: string | undefined;

package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts

@@ -211,6 +211,10 @@ import {
   QueryCommandInput,
   QueryCommandOutput,
 } from "../commands/QueryCommand";
+import {
+  RetrieveCommandInput,
+  RetrieveCommandOutput,
+} from "../commands/RetrieveCommand";
 import {
   StartDataSourceSyncJobCommandInput,
   StartDataSourceSyncJobCommandOutput,
@@ -471,6 +475,10 @@ export declare const se_QueryCommand: (
   input: QueryCommandInput,
   context: __SerdeContext
 ) => Promise<__HttpRequest>;
+export declare const se_RetrieveCommand: (
+  input: RetrieveCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
 export declare const se_StartDataSourceSyncJobCommand: (
   input: StartDataSourceSyncJobCommandInput,
   context: __SerdeContext
@@ -731,6 +739,10 @@ export declare const de_QueryCommand: (
   output: __HttpResponse,
   context: __SerdeContext
 ) => Promise<QueryCommandOutput>;
+export declare const de_RetrieveCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<RetrieveCommandOutput>;
 export declare const de_StartDataSourceSyncJobCommand: (
   output: __HttpResponse,
   context: __SerdeContext

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.357.0",
+  "version": "3.359.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.357.0",
+    "@aws-sdk/client-sts": "3.359.0",
     "@aws-sdk/config-resolver": "3.357.0",
-    "@aws-sdk/credential-provider-node": "3.357.0",
+    "@aws-sdk/credential-provider-node": "3.358.0",
     "@aws-sdk/fetch-http-handler": "3.357.0",
     "@aws-sdk/hash-node": "3.357.0",
     "@aws-sdk/invalid-dependency": "3.357.0",
@@ -39,14 +39,14 @@
     "@aws-sdk/middleware-user-agent": "3.357.0",
     "@aws-sdk/node-config-provider": "3.357.0",
     "@aws-sdk/node-http-handler": "3.357.0",
-    "@aws-sdk/smithy-client": "3.357.0",
+    "@aws-sdk/smithy-client": "3.358.0",
     "@aws-sdk/types": "3.357.0",
     "@aws-sdk/url-parser": "3.357.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.357.0",
-    "@aws-sdk/util-defaults-mode-node": "3.357.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.358.0",
+    "@aws-sdk/util-defaults-mode-node": "3.358.0",
     "@aws-sdk/util-endpoints": "3.357.0",
     "@aws-sdk/util-retry": "3.357.0",
     "@aws-sdk/util-user-agent-browser": "3.357.0",