@aws-sdk/client-kendra 3.131.0 → 3.141.0

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

@@ -1,4 +1,39 @@
-import { AttributeFilter, DocumentRelevanceConfiguration, Facet, QueryResultType, SortingConfiguration, SpellCorrectionConfiguration, UserContext } from "./models_0";
+import { AttributeFilter, DocumentRelevanceConfiguration, Facet, FacetResult, QueryResultItem, QueryResultType, SortingConfiguration, SpellCorrectedQuery, SpellCorrectionConfiguration, UserContext, Warning } from "./models_0";
+export interface QueryResult {
+    /**
+     * <p>The unique identifier for the search. You use <code>QueryId</code>
+     *          to identify the search when using the feedback API.</p>
+     */
+    QueryId?: string;
+    /**
+     * <p>The results of the search.</p>
+     */
+    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>
+     */
+    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>
+     */
+    TotalNumberOfResults?: number;
+    /**
+     * <p>A list of warning codes and their messages on problems with your query.</p>
+     *          <p>Amazon Kendra currently only supports one type of warning, which is a warning
+     *          on invalid syntax used in the query. For examples of invalid query syntax,
+     *          see <a href="https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax">Searching
+     *             with advanced query syntax</a>.</p>
+     */
+    Warnings?: Warning[];
+    /**
+     * <p>A list of information related to suggested spell corrections for a query.</p>
+     */
+    SpellCorrectedQueries?: SpellCorrectedQuery[];
+}
 export interface QueryRequest {
     /**
      * <p>The unique identifier of the index to search. The identifier is
@@ -87,9 +122,11 @@ export interface QueryRequest {
      */
     SpellCorrectionConfiguration?: SpellCorrectionConfiguration;
 }
-export declare namespace QueryRequest {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: QueryRequest) => any;
-}
+/**
+ * @internal
+ */
+export declare const QueryResultFilterSensitiveLog: (obj: QueryResult) => any;
+/**
+ * @internal
+ */
+export declare const QueryRequestFilterSensitiveLog: (obj: QueryRequest) => any;

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

@@ -1,8 +1,7 @@
 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 { QueryResult } from "../models/models_0";
-import { QueryRequest } from "../models/models_1";
+import { QueryRequest, QueryResult } from "../models/models_1";
 export interface QueryCommandInput extends QueryRequest {
 }
 export interface QueryCommandOutput extends QueryResult, __MetadataBearer {