@aws-sdk/client-kendra 3.409.0 → 3.411.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4550,6 +4550,7 @@ const de_RetrieveResultItem = (output, context) => {
4550
4550
  DocumentTitle: smithy_client_1.expectString,
4551
4551
  DocumentURI: smithy_client_1.expectString,
4552
4552
  Id: smithy_client_1.expectString,
4553
+ ScoreAttributes: smithy_client_1._json,
4553
4554
  });
4554
4555
  };
4555
4556
  const de_RetrieveResultItemList = (output, context) => {
@@ -1,16 +1,19 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.resolveRuntimeExtensions = void 0;
4
+ const protocol_http_1 = require("@smithy/protocol-http");
4
5
  const smithy_client_1 = require("@smithy/smithy-client");
5
6
  const asPartial = (t) => t;
6
7
  const resolveRuntimeExtensions = (runtimeConfig, extensions) => {
7
8
  const extensionConfiguration = {
8
9
  ...asPartial((0, smithy_client_1.getDefaultExtensionConfiguration)(runtimeConfig)),
10
+ ...asPartial((0, protocol_http_1.getHttpHandlerExtensionConfiguration)(runtimeConfig)),
9
11
  };
10
12
  extensions.forEach((extension) => extension.configure(extensionConfiguration));
11
13
  return {
12
14
  ...runtimeConfig,
13
15
  ...(0, smithy_client_1.resolveDefaultRuntimeConfig)(extensionConfiguration),
16
+ ...(0, protocol_http_1.resolveHttpHandlerRuntimeConfig)(extensionConfiguration),
14
17
  };
15
18
  };
16
19
  exports.resolveRuntimeExtensions = resolveRuntimeExtensions;
@@ -4413,6 +4413,7 @@ const de_RetrieveResultItem = (output, context) => {
4413
4413
  DocumentTitle: __expectString,
4414
4414
  DocumentURI: __expectString,
4415
4415
  Id: __expectString,
4416
+ ScoreAttributes: _json,
4416
4417
  });
4417
4418
  };
4418
4419
  const de_RetrieveResultItemList = (output, context) => {
@@ -1,12 +1,15 @@
1
+ import { getHttpHandlerExtensionConfiguration, resolveHttpHandlerRuntimeConfig } from "@smithy/protocol-http";
1
2
  import { getDefaultExtensionConfiguration, resolveDefaultRuntimeConfig } from "@smithy/smithy-client";
2
3
  const asPartial = (t) => t;
3
4
  export const resolveRuntimeExtensions = (runtimeConfig, extensions) => {
4
5
  const extensionConfiguration = {
5
6
  ...asPartial(getDefaultExtensionConfiguration(runtimeConfig)),
7
+ ...asPartial(getHttpHandlerExtensionConfiguration(runtimeConfig)),
6
8
  };
7
9
  extensions.forEach((extension) => extension.configure(extensionConfiguration));
8
10
  return {
9
11
  ...runtimeConfig,
10
12
  ...resolveDefaultRuntimeConfig(extensionConfiguration),
13
+ ...resolveHttpHandlerRuntimeConfig(extensionConfiguration),
11
14
  };
12
15
  };
@@ -27,7 +27,10 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
27
27
  * the <code>BatchPutDocument</code> API.</p>
28
28
  * <p>The documents are deleted asynchronously. You can see the progress of the deletion by
29
29
  * using Amazon Web Services CloudWatch. Any error messages related to the processing of the
30
- * batch are sent to you CloudWatch log.</p>
30
+ * batch are sent to your Amazon Web Services CloudWatch log. You can also use the
31
+ * <code>BatchGetDocumentStatus</code> API to monitor the progress of deleting your documents.</p>
32
+ * <p>Deleting documents from an index using <code>BatchDeleteDocument</code> could take up
33
+ * to an hour or more, depending on the number of documents you want to delete.</p>
31
34
  * @example
32
35
  * Use a bare-bones client and the command you need to make an API call.
33
36
  * ```javascript
@@ -29,10 +29,9 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
29
29
  * unstructured text into an index, add custom attributes to the documents, and to attach
30
30
  * an access control list to the documents added to the index.</p>
31
31
  * <p>The documents are indexed asynchronously. You can see the progress of the batch using
32
- * Amazon Web Services
33
- * CloudWatch. Any error messages related to processing the batch are sent to your
34
- * Amazon Web Services
35
- * CloudWatch log.</p>
32
+ * Amazon Web Services CloudWatch. Any error messages related to processing the batch
33
+ * are sent to your Amazon Web Services CloudWatch log. You can also use the
34
+ * <code>BatchGetDocumentStatus</code> API to monitor the progress of indexing your documents.</p>
36
35
  * <p>For an example of ingesting inline documents using Python and Java SDKs, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html">Adding files
37
36
  * directly to an index</a>.</p>
38
37
  * @example
@@ -27,8 +27,8 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat
27
27
  * if index creation has completed, check the <code>Status</code> field returned from a call to
28
28
  * <code>DescribeIndex</code>. The <code>Status</code> field is set to <code>ACTIVE</code> when
29
29
  * the index is ready to use.</p>
30
- * <p>Once the index is active you can index your documents using the
31
- * <code>BatchPutDocument</code> API or using one of the supported data sources.</p>
30
+ * <p>Once the index is active, you can index your documents using the
31
+ * <code>BatchPutDocument</code> API or using one of the supported <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-sources.html">data sources</a>.</p>
32
32
  * <p>For an example of creating an index and data source using the Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting started with Python
33
33
  * SDK</a>. For an example of creating an index and data source using the Java SDK, see
34
34
  * <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java
@@ -27,6 +27,9 @@ export interface DeleteDataSourceCommandOutput extends __MetadataBearer {
27
27
  * data source is already being deleted. While the data source is being deleted, the
28
28
  * <code>Status</code> field returned by a call to the <code>DescribeDataSource</code> API is
29
29
  * set to <code>DELETING</code>. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html">Deleting Data Sources</a>.</p>
30
+ * <p>Deleting an entire data source or re-syncing your index after deleting specific documents
31
+ * from a data source could take up to an hour or more, depending on the number of documents you
32
+ * want to delete.</p>
30
33
  * @example
31
34
  * Use a bare-bones client and the command you need to make an API call.
32
35
  * ```javascript
@@ -32,8 +32,8 @@ export interface RetrieveCommandOutput extends RetrieveResult, __MetadataBearer
32
32
  * include question-answer or FAQ type responses from your index. The passages
33
33
  * are text excerpts that can be semantically extracted from multiple documents
34
34
  * and multiple parts of the same document. If in extreme cases your documents
35
- * produce no relevant passages using the <code>Retrieve</code> API, you can
36
- * alternatively use the <code>Query</code> API.</p>
35
+ * produce zero passages using the <code>Retrieve</code> API, you can alternatively
36
+ * use the <code>Query</code> API and its types of responses.</p>
37
37
  * <p>You can also do the following:</p>
38
38
  * <ul>
39
39
  * <li>
@@ -48,6 +48,10 @@ export interface RetrieveCommandOutput extends RetrieveResult, __MetadataBearer
48
48
  * </ul>
49
49
  * <p>You can also include certain fields in the response that might provide useful
50
50
  * additional information.</p>
51
+ * <p>The <code>Retrieve</code> API shares the number of <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_CapacityUnitsConfiguration.html">query capacity
52
+ * units</a> that you set for your index. For more information on what's included in
53
+ * a single capacity unit and the default base capacity for an index, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html">Adjusting
54
+ * capacity</a>.</p>
51
55
  * @example
52
56
  * Use a bare-bones client and the command you need to make an API call.
53
57
  * ```javascript
@@ -195,6 +199,9 @@ export interface RetrieveCommandOutput extends RetrieveResult, __MetadataBearer
195
199
  * // },
196
200
  * // },
197
201
  * // ],
202
+ * // ScoreAttributes: { // ScoreAttributes
203
+ * // ScoreConfidence: "VERY_HIGH" || "HIGH" || "MEDIUM" || "LOW" || "NOT_AVAILABLE",
204
+ * // },
198
205
  * // },
199
206
  * // ],
200
207
  * // };
@@ -26,6 +26,9 @@ export interface StartDataSourceSyncJobCommandOutput extends StartDataSourceSync
26
26
  * <p>Starts a synchronization job for a data source connector. If a synchronization job is
27
27
  * already in progress, Amazon Kendra returns a <code>ResourceInUseException</code>
28
28
  * exception.</p>
29
+ * <p>Re-syncing your data source with your index after modifying, adding, or deleting
30
+ * documents from your data source respository could take up to an hour or more, depending on
31
+ * the number of documents to sync.</p>
29
32
  * @example
30
33
  * Use a bare-bones client and the command you need to make an API call.
31
34
  * ```javascript
@@ -1,6 +1,7 @@
1
+ import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
1
2
  import { DefaultExtensionConfiguration } from "@smithy/types";
2
3
  /**
3
4
  * @internal
4
5
  */
5
- export interface KendraExtensionConfiguration extends DefaultExtensionConfiguration {
6
+ export interface KendraExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration {
6
7
  }
@@ -156,23 +156,31 @@ export interface AdditionalResultAttribute {
156
156
  }
157
157
  /**
158
158
  * @public
159
- * <p>Maps a column or attribute in the data source to an index field. You must first create the
160
- * fields in the index using the <code>UpdateIndex</code> API.</p>
159
+ * <p>Maps attributes or field names of the documents synced from the data source
160
+ * to Amazon Kendra index field names. You can set up field mappings for each
161
+ * data source when calling <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html">CreateDataSource</a>
162
+ * or <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateDataSource.html">UpdateDataSource</a> API. To create custom fields, use the <code>UpdateIndex</code>
163
+ * API to first create an index field and then map to the data source field. For more
164
+ * information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.</p>
161
165
  */
162
166
  export interface DataSourceToIndexFieldMapping {
163
167
  /**
164
168
  * @public
165
- * <p>The name of the column or attribute in the data source.</p>
169
+ * <p>The name of the field in the data source. You must first create the index field
170
+ * using the <code>UpdateIndex</code> API.</p>
166
171
  */
167
172
  DataSourceFieldName: string | undefined;
168
173
  /**
169
174
  * @public
170
- * <p>The type of data stored in the column or attribute.</p>
175
+ * <p>The format for date fields in the data source. If the field specified in
176
+ * <code>DataSourceFieldName</code> is a date field, you must specify the date
177
+ * format. If the field is not a date field, an exception is thrown.</p>
171
178
  */
172
179
  DateFieldFormat?: string;
173
180
  /**
174
181
  * @public
175
- * <p>The name of the field in the index.</p>
182
+ * <p>The name of the index field to map to the data source field. The index field type
183
+ * must match the data source field type.</p>
176
184
  */
177
185
  IndexFieldName: string | undefined;
178
186
  }
@@ -1535,9 +1543,8 @@ export interface BatchPutDocumentResponse {
1535
1543
  * validation check. Each document contains an error message that indicates why the
1536
1544
  * document couldn't be added to the index.</p>
1537
1545
  * <p>If there was an error adding a document to an index the error is reported in your
1538
- * Amazon Web Services CloudWatch log. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-logs.html">Monitoring Amazon
1539
- * Kendra with Amazon CloudWatch Logs</a>
1540
- * </p>
1546
+ * Amazon Web Services CloudWatch log. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-logs.html">Monitoring
1547
+ * Amazon Kendra with Amazon CloudWatch logs</a>.</p>
1541
1548
  */
1542
1549
  FailedDocuments?: BatchPutDocumentResponseFailedDocument[];
1543
1550
  }
@@ -2318,7 +2325,8 @@ export interface SqlConfiguration {
2318
2325
  }
2319
2326
  /**
2320
2327
  * @public
2321
- * <p>Provides the configuration information to connect to a index. </p>
2328
+ * <p>Provides the configuration information to an <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html">Amazon Kendra supported
2329
+ * database</a>.</p>
2322
2330
  */
2323
2331
  export interface DatabaseConfiguration {
2324
2332
  /**
@@ -194,6 +194,13 @@ export interface RetrieveResultItem {
194
194
  * or the source URI (<code>_source_uri</code>) of the document.</p>
195
195
  */
196
196
  DocumentAttributes?: DocumentAttribute[];
197
+ /**
198
+ * @public
199
+ * <p>The confidence score bucket for a retrieved passage result. The confidence
200
+ * bucket provides a relative ranking that indicates how confident Amazon Kendra
201
+ * is that the response is relevant to the query.</p>
202
+ */
203
+ ScoreAttributes?: ScoreAttributes;
197
204
  }
198
205
  /**
199
206
  * @public
@@ -801,7 +808,7 @@ export interface UpdateThesaurusRequest {
801
808
  }
802
809
  /**
803
810
  * @public
804
- * <p>Information about a document attribute. You can use document attributes as
811
+ * <p>Information about a document attribute or field. You can use document attributes as
805
812
  * facets.</p>
806
813
  * <p>For example, the document attribute or facet "Department" includes the values "HR",
807
814
  * "Engineering", and "Accounting". You can display these values in the search results so that
@@ -838,24 +845,24 @@ export interface Facet {
838
845
  }
839
846
  /**
840
847
  * @public
841
- * <p>Provides the count of documents that match a particular attribute when doing a faceted
842
- * search.</p>
848
+ * <p>Provides the count of documents that match a particular document attribute or
849
+ * field when doing a faceted search.</p>
843
850
  */
844
851
  export interface DocumentAttributeValueCountPair {
845
852
  /**
846
853
  * @public
847
- * <p>The value of the attribute. For example, "HR".</p>
854
+ * <p>The value of the attribute/field. For example, "HR".</p>
848
855
  */
849
856
  DocumentAttributeValue?: DocumentAttributeValue;
850
857
  /**
851
858
  * @public
852
- * <p>The number of documents in the response that have the attribute value for the
853
- * key.</p>
859
+ * <p>The number of documents in the response that have the attribute/field value for
860
+ * the key.</p>
854
861
  */
855
862
  Count?: number;
856
863
  /**
857
864
  * @public
858
- * <p>Contains the results of a document attribute that is a nested facet. A
865
+ * <p>Contains the results of a document attribute/field that is a nested facet. A
859
866
  * <code>FacetResult</code> contains the counts for each facet nested within a
860
867
  * facet.</p>
861
868
  * <p>For example, the document attribute or facet "Department" includes a value called
@@ -895,89 +902,112 @@ export interface FacetResult {
895
902
  }
896
903
  /**
897
904
  * @public
898
- * <p>Provides filtering the query results based on document attributes or metadata
899
- * fields.</p>
900
- * <p>When you use the <code>AndAllFilters</code> or <code>OrAllFilters</code>, filters you
901
- * can use 2 layers under the first attribute filter. For example, you can use:</p>
905
+ * <p>Filters the search results based on document attributes or fields.</p>
906
+ * <p>You can filter results using attributes for your particular documents.
907
+ * The attributes must exist in your index. For example, if your documents
908
+ * include the custom attribute "Department", you can filter documents that
909
+ * belong to the "HR" department. You would use the <code>EqualsTo</code>
910
+ * operation to filter results or documents with "Department" equals to "HR".</p>
911
+ * <p>You can use <code>AndAllFilters</code> and <code>AndOrFilters</code> in
912
+ * combination with each other or with other operations such as <code>EqualsTo</code>.
913
+ * For example:</p>
902
914
  * <p>
903
- * <code><AndAllFilters></code>
915
+ * <code>AndAllFilters</code>
904
916
  * </p>
905
- * <ol>
917
+ * <ul>
906
918
  * <li>
907
919
  * <p>
908
- * <code> <OrAllFilters></code>
909
- * </p>
920
+ * <code>EqualsTo</code>: "Department", "HR"</p>
910
921
  * </li>
911
922
  * <li>
912
923
  * <p>
913
- * <code> <EqualsTo></code>
924
+ * <code>AndOrFilters</code>
914
925
  * </p>
926
+ * <ul>
927
+ * <li>
928
+ * <p>
929
+ * <code>ContainsAny</code>: "Project Name", ["new hires", "new hiring"]</p>
930
+ * </li>
931
+ * </ul>
915
932
  * </li>
916
- * </ol>
917
- * <p>If you use more than 2 layers, you receive a <code>ValidationException</code> exception
918
- * with the message "<code>AttributeFilter</code> cannot have a depth of more than 2."</p>
919
- * <p>If you use more than 10 attribute filters in a given list for <code>AndAllFilters</code>
920
- * or <code>OrAllFilters</code>, you receive a <code>ValidationException</code> with the
921
- * message "<code>AttributeFilter</code> cannot have a length of more than 10".</p>
933
+ * </ul>
934
+ * <p>This example filters results or documents that belong to the HR department
935
+ * <i>and</i> belong to projects that contain "new hires"
936
+ * <i>or</i> "new hiring" in the project name (must use
937
+ * <code>ContainAny</code> with <code>StringListValue</code>). This example is
938
+ * filtering with a depth of 2.</p>
939
+ * <p>You cannot filter more than a depth of 2, otherwise you receive a
940
+ * <code>ValidationException</code> exception with the message "AttributeFilter
941
+ * cannot have a depth of more than 2." Also, if you use more than 10 attribute
942
+ * filters in a given list for <code>AndAllFilters</code> or <code>OrAllFilters</code>,
943
+ * you receive a <code>ValidationException</code> with the message "AttributeFilter
944
+ * cannot have a length of more than 10".</p>
945
+ * <p>For examples of using <code>AttributeFilter</code>, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering">Using
946
+ * document attributes to filter search results</a>.</p>
922
947
  */
923
948
  export interface AttributeFilter {
924
949
  /**
925
950
  * @public
926
- * <p>Performs a logical <code>AND</code> operation on all supplied filters.</p>
951
+ * <p>Performs a logical <code>AND</code> operation on all filters that you specify.</p>
927
952
  */
928
953
  AndAllFilters?: AttributeFilter[];
929
954
  /**
930
955
  * @public
931
- * <p>Performs a logical <code>OR</code> operation on all supplied filters.</p>
956
+ * <p>Performs a logical <code>OR</code> operation on all filters that you specify.</p>
932
957
  */
933
958
  OrAllFilters?: AttributeFilter[];
934
959
  /**
935
960
  * @public
936
- * <p>Performs a logical <code>NOT</code> operation on all supplied filters.</p>
961
+ * <p>Performs a logical <code>NOT</code> operation on all filters that you specify.</p>
937
962
  */
938
963
  NotFilter?: AttributeFilter;
939
964
  /**
940
965
  * @public
941
- * <p>Performs an equals operation on two document attributes or metadata fields.</p>
966
+ * <p>Performs an equals operation on document attributes/fields and their values.</p>
942
967
  */
943
968
  EqualsTo?: DocumentAttribute;
944
969
  /**
945
970
  * @public
946
- * <p>Returns true when a document contains all of the specified document attributes or
947
- * metadata fields. This filter is only applicable to <code>StringListValue</code>
948
- * metadata.</p>
971
+ * <p>Returns true when a document contains all of the specified document attributes/fields.
972
+ * This filter is only applicable to <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">StringListValue</a>.</p>
949
973
  */
950
974
  ContainsAll?: DocumentAttribute;
951
975
  /**
952
976
  * @public
953
- * <p>Returns true when a document contains any of the specified document attributes or
954
- * metadata fields. This filter is only applicable to <code>StringListValue</code>
955
- * metadata.</p>
977
+ * <p>Returns true when a document contains any of the specified document attributes/fields.
978
+ * This filter is only applicable to <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">StringListValue</a>.</p>
956
979
  */
957
980
  ContainsAny?: DocumentAttribute;
958
981
  /**
959
982
  * @public
960
- * <p>Performs a greater than operation on two document attributes or metadata fields. Use
961
- * with a document attribute of type <code>Date</code> or <code>Long</code>.</p>
983
+ * <p>Performs a greater than operation on document attributes/fields and their
984
+ * values. Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
985
+ * type</a>
986
+ * <code>Date</code> or <code>Long</code>.</p>
962
987
  */
963
988
  GreaterThan?: DocumentAttribute;
964
989
  /**
965
990
  * @public
966
- * <p>Performs a greater or equals than operation on two document attributes or metadata
967
- * fields. Use with a document attribute of type <code>Date</code> or
968
- * <code>Long</code>.</p>
991
+ * <p>Performs a greater or equals than operation on document attributes/fields and
992
+ * their values. Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
993
+ * type</a>
994
+ * <code>Date</code> or <code>Long</code>.</p>
969
995
  */
970
996
  GreaterThanOrEquals?: DocumentAttribute;
971
997
  /**
972
998
  * @public
973
- * <p>Performs a less than operation on two document attributes or metadata fields. Use with a
974
- * document attribute of type <code>Date</code> or <code>Long</code>.</p>
999
+ * <p>Performs a less than operation on document attributes/fields and their values.
1000
+ * Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
1001
+ * type</a>
1002
+ * <code>Date</code> or <code>Long</code>.</p>
975
1003
  */
976
1004
  LessThan?: DocumentAttribute;
977
1005
  /**
978
1006
  * @public
979
- * <p>Performs a less than or equals operation on two document attributes or metadata fields.
980
- * Use with a document attribute of type <code>Date</code> or <code>Long</code>.</p>
1007
+ * <p>Performs a less than or equals operation on document attributes/fields and
1008
+ * their values. Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
1009
+ * type</a>
1010
+ * <code>Date</code> or <code>Long</code>.</p>
981
1011
  */
982
1012
  LessThanOrEquals?: DocumentAttribute;
983
1013
  }
@@ -11,7 +11,10 @@ export declare const getRuntimeConfig: (config: KendraClientConfig) => {
11
11
  defaultUserAgentProvider: import("@smithy/types").Provider<import("@smithy/types").UserAgent>;
12
12
  maxAttempts: number | import("@smithy/types").Provider<number>;
13
13
  region: string | import("@smithy/types").Provider<any>;
14
- requestHandler: (import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> & import("@smithy/protocol-http").HttpHandler) | RequestHandler;
14
+ requestHandler: (import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> & import("@smithy/types").RequestHandler<import("@smithy/protocol-http").HttpRequest, import("@smithy/protocol-http").HttpResponse, import("@smithy/types").HttpHandlerOptions> & {
15
+ updateHttpClientConfig(key: never, value: never): void;
16
+ httpHandlerConfigs(): {};
17
+ }) | RequestHandler;
15
18
  retryMode: string | import("@smithy/types").Provider<string>;
16
19
  sha256: import("@smithy/types").HashConstructor;
17
20
  streamCollector: import("@smithy/types").StreamCollector;
@@ -11,7 +11,10 @@ export declare const getRuntimeConfig: (config: KendraClientConfig) => {
11
11
  defaultUserAgentProvider: import("@smithy/types").Provider<import("@smithy/types").UserAgent>;
12
12
  maxAttempts: number | import("@smithy/types").Provider<number>;
13
13
  region: string | import("@smithy/types").Provider<string>;
14
- requestHandler: (import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> & import("@smithy/protocol-http").HttpHandler) | RequestHandler;
14
+ requestHandler: (import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> & import("@smithy/types").RequestHandler<import("@smithy/protocol-http").HttpRequest, import("@smithy/protocol-http").HttpResponse, import("@smithy/types").HttpHandlerOptions> & {
15
+ updateHttpClientConfig(key: never, value: never): void;
16
+ httpHandlerConfigs(): {};
17
+ }) | RequestHandler;
15
18
  retryMode: string | import("@smithy/types").Provider<string>;
16
19
  sha256: import("@smithy/types").HashConstructor;
17
20
  streamCollector: import("@smithy/types").StreamCollector;
@@ -5,7 +5,10 @@ import { KendraClientConfig } from "./KendraClient";
5
5
  export declare const getRuntimeConfig: (config: KendraClientConfig) => {
6
6
  runtime: string;
7
7
  sha256: import("@smithy/types").HashConstructor;
8
- requestHandler: (import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> & import("@smithy/protocol-http").HttpHandler) | import("@smithy/fetch-http-handler").FetchHttpHandler;
8
+ requestHandler: (import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> & import("@smithy/types").RequestHandler<import("@smithy/protocol-http").HttpRequest, import("@smithy/protocol-http").HttpResponse, import("@smithy/types").HttpHandlerOptions> & {
9
+ updateHttpClientConfig(key: never, value: never): void;
10
+ httpHandlerConfigs(): {};
11
+ }) | import("@smithy/fetch-http-handler").FetchHttpHandler;
9
12
  apiVersion: string;
10
13
  urlParser: import("@smithy/types").UrlParser;
11
14
  bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
@@ -3,7 +3,7 @@ import { KendraExtensionConfiguration } from "./extensionConfiguration";
3
3
  * @public
4
4
  */
5
5
  export interface RuntimeExtension {
6
- configure(clientConfiguration: KendraExtensionConfiguration): void;
6
+ configure(extensionConfiguration: KendraExtensionConfiguration): void;
7
7
  }
8
8
  /**
9
9
  * @public
@@ -1,3 +1,5 @@
1
+ import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
1
2
  import { DefaultExtensionConfiguration } from "@smithy/types";
2
3
  export interface KendraExtensionConfiguration
3
- extends DefaultExtensionConfiguration {}
4
+ extends HttpHandlerExtensionConfiguration,
5
+ DefaultExtensionConfiguration {}
@@ -74,6 +74,7 @@ export interface RetrieveResultItem {
74
74
  Content?: string;
75
75
  DocumentURI?: string;
76
76
  DocumentAttributes?: DocumentAttribute[];
77
+ ScoreAttributes?: ScoreAttributes;
77
78
  }
78
79
  export interface RetrieveResult {
79
80
  QueryId?: string;
@@ -20,7 +20,14 @@ export declare const getRuntimeConfig: (config: KendraClientConfig) => {
20
20
  any,
21
21
  import("@smithy/types").HttpHandlerOptions
22
22
  > &
23
- import("@smithy/protocol-http").HttpHandler)
23
+ import("@smithy/types").RequestHandler<
24
+ import("@smithy/protocol-http").HttpRequest,
25
+ import("@smithy/protocol-http").HttpResponse,
26
+ import("@smithy/types").HttpHandlerOptions
27
+ > & {
28
+ updateHttpClientConfig(key: never, value: never): void;
29
+ httpHandlerConfigs(): {};
30
+ })
24
31
  | RequestHandler;
25
32
  retryMode: string | import("@smithy/types").Provider<string>;
26
33
  sha256: import("@smithy/types").HashConstructor;
@@ -20,7 +20,14 @@ export declare const getRuntimeConfig: (config: KendraClientConfig) => {
20
20
  any,
21
21
  import("@smithy/types").HttpHandlerOptions
22
22
  > &
23
- import("@smithy/protocol-http").HttpHandler)
23
+ import("@smithy/types").RequestHandler<
24
+ import("@smithy/protocol-http").HttpRequest,
25
+ import("@smithy/protocol-http").HttpResponse,
26
+ import("@smithy/types").HttpHandlerOptions
27
+ > & {
28
+ updateHttpClientConfig(key: never, value: never): void;
29
+ httpHandlerConfigs(): {};
30
+ })
24
31
  | RequestHandler;
25
32
  retryMode: string | import("@smithy/types").Provider<string>;
26
33
  sha256: import("@smithy/types").HashConstructor;
@@ -8,7 +8,14 @@ export declare const getRuntimeConfig: (config: KendraClientConfig) => {
8
8
  any,
9
9
  import("@smithy/types").HttpHandlerOptions
10
10
  > &
11
- import("@smithy/protocol-http").HttpHandler)
11
+ import("@smithy/types").RequestHandler<
12
+ import("@smithy/protocol-http").HttpRequest,
13
+ import("@smithy/protocol-http").HttpResponse,
14
+ import("@smithy/types").HttpHandlerOptions
15
+ > & {
16
+ updateHttpClientConfig(key: never, value: never): void;
17
+ httpHandlerConfigs(): {};
18
+ })
12
19
  | import("@smithy/fetch-http-handler").FetchHttpHandler;
13
20
  apiVersion: string;
14
21
  urlParser: import("@smithy/types").UrlParser;
@@ -1,6 +1,6 @@
1
1
  import { KendraExtensionConfiguration } from "./extensionConfiguration";
2
2
  export interface RuntimeExtension {
3
- configure(clientConfiguration: KendraExtensionConfiguration): void;
3
+ configure(extensionConfiguration: KendraExtensionConfiguration): void;
4
4
  }
5
5
  export interface RuntimeExtensionsConfig {
6
6
  extensions: RuntimeExtension[];
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-kendra",
3
3
  "description": "AWS SDK for JavaScript Kendra Client for Node.js, Browser and React Native",
4
- "version": "3.409.0",
4
+ "version": "3.411.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,37 +21,37 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.409.0",
25
- "@aws-sdk/credential-provider-node": "3.409.0",
26
- "@aws-sdk/middleware-host-header": "3.408.0",
27
- "@aws-sdk/middleware-logger": "3.408.0",
28
- "@aws-sdk/middleware-recursion-detection": "3.408.0",
29
- "@aws-sdk/middleware-signing": "3.408.0",
30
- "@aws-sdk/middleware-user-agent": "3.408.0",
31
- "@aws-sdk/types": "3.408.0",
32
- "@aws-sdk/util-endpoints": "3.408.0",
33
- "@aws-sdk/util-user-agent-browser": "3.408.0",
34
- "@aws-sdk/util-user-agent-node": "3.408.0",
35
- "@smithy/config-resolver": "^2.0.5",
36
- "@smithy/fetch-http-handler": "^2.0.5",
37
- "@smithy/hash-node": "^2.0.5",
38
- "@smithy/invalid-dependency": "^2.0.5",
39
- "@smithy/middleware-content-length": "^2.0.5",
40
- "@smithy/middleware-endpoint": "^2.0.5",
41
- "@smithy/middleware-retry": "^2.0.5",
42
- "@smithy/middleware-serde": "^2.0.5",
24
+ "@aws-sdk/client-sts": "3.410.0",
25
+ "@aws-sdk/credential-provider-node": "3.410.0",
26
+ "@aws-sdk/middleware-host-header": "3.410.0",
27
+ "@aws-sdk/middleware-logger": "3.410.0",
28
+ "@aws-sdk/middleware-recursion-detection": "3.410.0",
29
+ "@aws-sdk/middleware-signing": "3.410.0",
30
+ "@aws-sdk/middleware-user-agent": "3.410.0",
31
+ "@aws-sdk/types": "3.410.0",
32
+ "@aws-sdk/util-endpoints": "3.410.0",
33
+ "@aws-sdk/util-user-agent-browser": "3.410.0",
34
+ "@aws-sdk/util-user-agent-node": "3.410.0",
35
+ "@smithy/config-resolver": "^2.0.7",
36
+ "@smithy/fetch-http-handler": "^2.1.2",
37
+ "@smithy/hash-node": "^2.0.6",
38
+ "@smithy/invalid-dependency": "^2.0.6",
39
+ "@smithy/middleware-content-length": "^2.0.8",
40
+ "@smithy/middleware-endpoint": "^2.0.6",
41
+ "@smithy/middleware-retry": "^2.0.9",
42
+ "@smithy/middleware-serde": "^2.0.6",
43
43
  "@smithy/middleware-stack": "^2.0.0",
44
- "@smithy/node-config-provider": "^2.0.6",
45
- "@smithy/node-http-handler": "^2.0.5",
46
- "@smithy/protocol-http": "^2.0.5",
47
- "@smithy/smithy-client": "^2.0.5",
48
- "@smithy/types": "^2.2.2",
49
- "@smithy/url-parser": "^2.0.5",
44
+ "@smithy/node-config-provider": "^2.0.9",
45
+ "@smithy/node-http-handler": "^2.1.2",
46
+ "@smithy/protocol-http": "^3.0.2",
47
+ "@smithy/smithy-client": "^2.1.3",
48
+ "@smithy/types": "^2.3.0",
49
+ "@smithy/url-parser": "^2.0.6",
50
50
  "@smithy/util-base64": "^2.0.0",
51
51
  "@smithy/util-body-length-browser": "^2.0.0",
52
52
  "@smithy/util-body-length-node": "^2.1.0",
53
- "@smithy/util-defaults-mode-browser": "^2.0.6",
54
- "@smithy/util-defaults-mode-node": "^2.0.6",
53
+ "@smithy/util-defaults-mode-browser": "^2.0.7",
54
+ "@smithy/util-defaults-mode-node": "^2.0.9",
55
55
  "@smithy/util-retry": "^2.0.0",
56
56
  "@smithy/util-utf8": "^2.0.0",
57
57
  "tslib": "^2.5.0",