@aws-sdk/client-kendra 3.357.0 → 3.359.0

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

@@ -0,0 +1,263 @@
+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";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link RetrieveCommand}.
+ */
+export interface RetrieveCommandInput extends RetrieveRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link RetrieveCommand}.
+ */
+export interface RetrieveCommandOutput extends RetrieveResult, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Retrieves relevant passages or text excerpts given an input query.</p>
+ *          <p>This API is similar to the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html">Query</a>
+ *             API. However, by default, the <code>Query</code> API only
+ *             returns excerpt passages of up to 100 token words. With the
+ *             <code>Retrieve</code> API, you can retrieve longer passages of up to
+ *             200 token words and up to 100 semantically relevant passages. This doesn't
+ *             include question-answer or FAQ type responses from your index. The passages
+ *             are text excerpts that can be semantically extracted from multiple documents
+ *             and multiple parts of the same document. If in extreme cases your documents
+ *             produce no relevant passages using the <code>Retrieve</code> API, you can
+ *             alternatively use the <code>Query</code> API.</p>
+ *          <p>You can also do the following:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Override boosting at the index level</p>
+ *             </li>
+ *             <li>
+ *                <p>Filter based on document fields or attributes</p>
+ *             </li>
+ *             <li>
+ *                <p>Filter based on the user or their group access to documents</p>
+ *             </li>
+ *          </ul>
+ *          <p>You can also include certain fields in the response that might provide useful
+ *             additional information.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KendraClient, RetrieveCommand } from "@aws-sdk/client-kendra"; // ES Modules import
+ * // const { KendraClient, RetrieveCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
+ * const client = new KendraClient(config);
+ * const input = { // RetrieveRequest
+ *   IndexId: "STRING_VALUE", // required
+ *   QueryText: "STRING_VALUE", // required
+ *   AttributeFilter: { // AttributeFilter
+ *     AndAllFilters: [ // AttributeFilterList
+ *       {
+ *         AndAllFilters: [
+ *           "<AttributeFilter>",
+ *         ],
+ *         OrAllFilters: [
+ *           "<AttributeFilter>",
+ *         ],
+ *         NotFilter: "<AttributeFilter>",
+ *         EqualsTo: { // DocumentAttribute
+ *           Key: "STRING_VALUE", // required
+ *           Value: { // DocumentAttributeValue
+ *             StringValue: "STRING_VALUE",
+ *             StringListValue: [ // DocumentAttributeStringListValue
+ *               "STRING_VALUE",
+ *             ],
+ *             LongValue: Number("long"),
+ *             DateValue: new Date("TIMESTAMP"),
+ *           },
+ *         },
+ *         ContainsAll: {
+ *           Key: "STRING_VALUE", // required
+ *           Value: {
+ *             StringValue: "STRING_VALUE",
+ *             StringListValue: [
+ *               "STRING_VALUE",
+ *             ],
+ *             LongValue: Number("long"),
+ *             DateValue: new Date("TIMESTAMP"),
+ *           },
+ *         },
+ *         ContainsAny: {
+ *           Key: "STRING_VALUE", // required
+ *           Value: {
+ *             StringValue: "STRING_VALUE",
+ *             StringListValue: [
+ *               "STRING_VALUE",
+ *             ],
+ *             LongValue: Number("long"),
+ *             DateValue: new Date("TIMESTAMP"),
+ *           },
+ *         },
+ *         GreaterThan: {
+ *           Key: "STRING_VALUE", // required
+ *           Value: {
+ *             StringValue: "STRING_VALUE",
+ *             StringListValue: [
+ *               "STRING_VALUE",
+ *             ],
+ *             LongValue: Number("long"),
+ *             DateValue: new Date("TIMESTAMP"),
+ *           },
+ *         },
+ *         GreaterThanOrEquals: {
+ *           Key: "STRING_VALUE", // required
+ *           Value: {
+ *             StringValue: "STRING_VALUE",
+ *             StringListValue: [
+ *               "STRING_VALUE",
+ *             ],
+ *             LongValue: Number("long"),
+ *             DateValue: new Date("TIMESTAMP"),
+ *           },
+ *         },
+ *         LessThan: "<DocumentAttribute>",
+ *         LessThanOrEquals: "<DocumentAttribute>",
+ *       },
+ *     ],
+ *     OrAllFilters: [
+ *       "<AttributeFilter>",
+ *     ],
+ *     NotFilter: "<AttributeFilter>",
+ *     EqualsTo: "<DocumentAttribute>",
+ *     ContainsAll: "<DocumentAttribute>",
+ *     ContainsAny: "<DocumentAttribute>",
+ *     GreaterThan: "<DocumentAttribute>",
+ *     GreaterThanOrEquals: "<DocumentAttribute>",
+ *     LessThan: "<DocumentAttribute>",
+ *     LessThanOrEquals: "<DocumentAttribute>",
+ *   },
+ *   RequestedDocumentAttributes: [ // DocumentAttributeKeyList
+ *     "STRING_VALUE",
+ *   ],
+ *   DocumentRelevanceOverrideConfigurations: [ // DocumentRelevanceOverrideConfigurationList
+ *     { // DocumentRelevanceConfiguration
+ *       Name: "STRING_VALUE", // required
+ *       Relevance: { // Relevance
+ *         Freshness: true || false,
+ *         Importance: Number("int"),
+ *         Duration: "STRING_VALUE",
+ *         RankOrder: "ASCENDING" || "DESCENDING",
+ *         ValueImportanceMap: { // ValueImportanceMap
+ *           "<keys>": Number("int"),
+ *         },
+ *       },
+ *     },
+ *   ],
+ *   PageNumber: Number("int"),
+ *   PageSize: Number("int"),
+ *   UserContext: { // UserContext
+ *     Token: "STRING_VALUE",
+ *     UserId: "STRING_VALUE",
+ *     Groups: [ // Groups
+ *       "STRING_VALUE",
+ *     ],
+ *     DataSourceGroups: [ // DataSourceGroups
+ *       { // DataSourceGroup
+ *         GroupId: "STRING_VALUE", // required
+ *         DataSourceId: "STRING_VALUE", // required
+ *       },
+ *     ],
+ *   },
+ * };
+ * const command = new RetrieveCommand(input);
+ * const response = await client.send(command);
+ * // { // RetrieveResult
+ * //   QueryId: "STRING_VALUE",
+ * //   ResultItems: [ // RetrieveResultItemList
+ * //     { // RetrieveResultItem
+ * //       Id: "STRING_VALUE",
+ * //       DocumentId: "STRING_VALUE",
+ * //       DocumentTitle: "STRING_VALUE",
+ * //       Content: "STRING_VALUE",
+ * //       DocumentURI: "STRING_VALUE",
+ * //       DocumentAttributes: [ // DocumentAttributeList
+ * //         { // DocumentAttribute
+ * //           Key: "STRING_VALUE", // required
+ * //           Value: { // DocumentAttributeValue
+ * //             StringValue: "STRING_VALUE",
+ * //             StringListValue: [ // DocumentAttributeStringListValue
+ * //               "STRING_VALUE",
+ * //             ],
+ * //             LongValue: Number("long"),
+ * //             DateValue: new Date("TIMESTAMP"),
+ * //           },
+ * //         },
+ * //       ],
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param RetrieveCommandInput - {@link RetrieveCommandInput}
+ * @returns {@link RetrieveCommandOutput}
+ * @see {@link RetrieveCommandInput} for command's `input` shape.
+ * @see {@link RetrieveCommandOutput} for command's `response` shape.
+ * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this action. Please ensure you have the
+ *             required permission policies and user accounts and try again.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>A conflict occurred with the request. Please fix any inconsistences with your
+ *             resources and try again.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An issue occurred with the internal server used for your Amazon Kendra service.
+ *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource you want to use doesn’t exist. Please check you have provided the correct
+ *             resource and try again.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>You have exceeded the set limits for your Amazon Kendra service. Please see
+ *             <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a> for
+ *             more information, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> to inquire about
+ *             an increase of limits.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling. Please reduce the number of requests
+ *             and try again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
+ *             Please provide the correct input and try again.</p>
+ *
+ * @throws {@link KendraServiceException}
+ * <p>Base exception class for all service exceptions from Kendra service.</p>
+ *
+ */
+export declare class RetrieveCommand extends $Command<RetrieveCommandInput, RetrieveCommandOutput, KendraClientResolvedConfig> {
+    readonly input: RetrieveCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: RetrieveCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RetrieveCommandInput, RetrieveCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/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/models/models_0.d.ts

@@ -209,9 +209,9 @@ export interface DataSourceVpcConfiguration {
  * <p>Provides the configuration information to connect to Alfresco as your data
  *             source.</p>
  *          <note>
- *             <p>Alfresco data source connector is currently in preview mode. Basic authentication
- *                 is currently supported. If you would like to use Alfresco connector in production,
- *                 contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
+ *             <p>Support for <code>AlfrescoConfiguration</code> ended May 2023.
+ *                 We recommend migrating to or using the Alfresco data source template
+ *                 schema / <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> API.</p>
  *          </note>
  */
 export interface AlfrescoConfiguration {
@@ -1326,6 +1326,9 @@ export interface Document {
     HierarchicalAccessControlList?: HierarchicalPrincipal[];
     /**
      * <p>The file type of the document in the <code>Blob</code> field.</p>
+     *          <p>If you want to index snippets or subsets of HTML documents instead of the entirety
+     *             of the HTML documents, you must add the <code>HTML</code> start and closing tags
+     *             (<code><HTML>content</HTML></code>) around the content.</p>
      */
     ContentType?: ContentType | string;
     /**
@@ -3233,23 +3236,19 @@ export interface ServiceNowKnowledgeArticleConfiguration {
      */
     CrawlAttachments?: boolean;
     /**
-     * <p>A list of regular expression patterns to include certain attachments of knowledge
-     *             articles in your ServiceNow. Item that match the patterns are included in the index.
-     *             Items that don't match the patterns are excluded from the index. If an item matches both
-     *             an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item
+     * <p>A list of regular expression patterns applied to include knowledge article
+     *             attachments. Attachments that match the patterns are included in the index. Items that
+     *             don't match the patterns are excluded from the index. If an item matches both an
+     *             inclusion and exclusion pattern, the exclusion pattern takes precedence and the item
      *             isn't included in the index.</p>
-     *          <p>The regex is applied to the field specified in the
-     *             <code>PatternTargetField</code>.</p>
      */
     IncludeAttachmentFilePatterns?: string[];
     /**
-     * <p>A list of regular expression patterns to exclude certain attachments of knowledge
-     *             articles in your ServiceNow. Item that match the patterns are excluded from the index.
-     *             Items that don't match the patterns are included in the index. If an item matches both
-     *             an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item
-     *             isn't included in the index.</p>
-     *          <p>The regex is applied to the field specified in the
-     *             <code>PatternTargetField</code>.</p>
+     * <p>A list of regular expression patterns applied to exclude certain knowledge article
+     *             attachments. Attachments that match the patterns are excluded from the index. Items that
+     *             don't match the patterns are included in the index. If an item matches both an inclusion
+     *             and exclusion pattern, the exclusion pattern takes precedence and the item isn't
+     *             included in the index.</p>
      */
     ExcludeAttachmentFilePatterns?: string[];
     /**
@@ -3685,19 +3684,19 @@ export interface SeedUrlConfiguration {
      *          <ul>
      *             <li>
      *                <p>
-     *                   <code>HOST_ONLY</code> – crawl only the website host names. For
+     *                   <code>HOST_ONLY</code>—crawl only the website host names. For
      *                     example, if the seed URL is "abc.example.com", then only URLs with host name
      *                     "abc.example.com" are crawled.</p>
      *             </li>
      *             <li>
      *                <p>
-     *                   <code>SUBDOMAINS</code> – crawl the website host names with subdomains.
+     *                   <code>SUBDOMAINS</code>—crawl the website host names with subdomains.
      *                     For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and
      *                     "b.abc.example.com" are also crawled.</p>
      *             </li>
      *             <li>
      *                <p>
-     *                   <code>EVERYTHING</code> – crawl the website host names with subdomains
+     *                   <code>EVERYTHING</code>—crawl the website host names with subdomains
      *                     and other domains that the web pages link to.</p>
      *             </li>
      *          </ul>
@@ -3775,12 +3774,8 @@ export interface WebCrawlerConfiguration {
      */
     Urls: Urls | undefined;
     /**
-     * <p>Specifies the number of levels in a website that you want to crawl.</p>
-     *          <p>The first level begins from the website seed or starting point URL. For example, if a
-     *             website has three levels—index level (the seed in this example), sections level, and
-     *             subsections level—and you are only interested in crawling information up to the
-     *             sections level (levels 0-1), you can set your depth to 1.</p>
-     *          <p>The default crawl depth is set to 2.</p>
+     * <p>The 'depth' or number of levels from the seed level to crawl. For example, the seed
+     *             URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.</p>
      */
     CrawlDepth?: number;
     /**
@@ -3985,7 +3980,12 @@ export interface DataSourceConfiguration {
      */
     GitHubConfiguration?: GitHubConfiguration;
     /**
+     * @deprecated
+     *
      * <p>Provides the configuration information to connect to Alfresco as your data source.</p>
+     *          <p>Support for <code>AlfrescoConfiguration</code> ended May 2023.
+     *       We recommend migrating to or using the Alfresco data source template
+     *       schema / <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> API.</p>
      */
     AlfrescoConfiguration?: AlfrescoConfiguration;
     /**
@@ -4283,8 +4283,9 @@ export interface CreateFaqRequest {
      * <p>The format of the FAQ input file. You can choose between a basic CSV format, a CSV
      *             format that includes customs attributes in a header, and a JSON format that includes
      *             custom attributes.</p>
-     *          <p>The format must match the format of the file stored in the S3 bucket identified in the
-     *                 <code>S3Path</code> parameter.</p>
+     *          <p>The default format is CSV.</p>
+     *          <p>The format must match the format of the file stored in the S3 bucket identified in
+     *             the <code>S3Path</code> parameter.</p>
      *          <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html">Adding questions and
      *             answers</a>.</p>
      */
@@ -7679,11 +7680,11 @@ export type ScoreConfidence = (typeof ScoreConfidence)[keyof typeof ScoreConfide
 /**
  * @public
  * <p>Provides a relative ranking that indicates how confident Amazon Kendra is that the
- *          response matches the query.</p>
+ *          response is relevant to the query.</p>
  */
 export interface ScoreAttributes {
     /**
-     * <p>A relative ranking for how well the response matches the query.</p>
+     * <p>A relative ranking for how relevant the response is to the query.</p>
      */
     ScoreConfidence?: ScoreConfidence | string;
 }