@aws-sdk/client-qconnect 3.693.0 → 3.696.0

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

@@ -0,0 +1,349 @@
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import {
+  ChannelSubtype,
+  ContentDataDetails,
+  ContentSummary,
+  DataReference,
+  Document,
+  ExternalSourceConfiguration,
+  GroupingConfiguration,
+  ImportJobData,
+  ImportJobType,
+  IntentDetectedDataDetails,
+  KnowledgeBaseData,
+  QueryResultType,
+  QuickResponseContents,
+  QuickResponseStatus,
+  RankingData,
+  RecommendationTrigger,
+  RecommendationType,
+  RelevanceLevel,
+  SearchExpression,
+  SourceContentDataDetails,
+} from "./models_0";
+import { QConnectServiceException as __BaseException } from "./QConnectServiceException";
+export interface RemoveKnowledgeBaseTemplateUriResponse {}
+export interface SearchContentRequest {
+  nextToken?: string | undefined;
+  maxResults?: number | undefined;
+  knowledgeBaseId: string | undefined;
+  searchExpression: SearchExpression | undefined;
+}
+export interface SearchContentResponse {
+  contentSummaries: ContentSummary[] | undefined;
+  nextToken?: string | undefined;
+}
+export declare const MessageTemplateFilterOperator: {
+  readonly EQUALS: "EQUALS";
+  readonly PREFIX: "PREFIX";
+};
+export type MessageTemplateFilterOperator =
+  (typeof MessageTemplateFilterOperator)[keyof typeof MessageTemplateFilterOperator];
+export interface MessageTemplateFilterField {
+  name: string | undefined;
+  values?: string[] | undefined;
+  operator: MessageTemplateFilterOperator | undefined;
+  includeNoExistence?: boolean | undefined;
+}
+export declare const Order: {
+  readonly ASC: "ASC";
+  readonly DESC: "DESC";
+};
+export type Order = (typeof Order)[keyof typeof Order];
+export interface MessageTemplateOrderField {
+  name: string | undefined;
+  order?: Order | undefined;
+}
+export declare const MessageTemplateQueryOperator: {
+  readonly CONTAINS: "CONTAINS";
+  readonly CONTAINS_AND_PREFIX: "CONTAINS_AND_PREFIX";
+};
+export type MessageTemplateQueryOperator =
+  (typeof MessageTemplateQueryOperator)[keyof typeof MessageTemplateQueryOperator];
+export declare const Priority: {
+  readonly HIGH: "HIGH";
+  readonly LOW: "LOW";
+  readonly MEDIUM: "MEDIUM";
+};
+export type Priority = (typeof Priority)[keyof typeof Priority];
+export interface MessageTemplateQueryField {
+  name: string | undefined;
+  values: string[] | undefined;
+  operator: MessageTemplateQueryOperator | undefined;
+  allowFuzziness?: boolean | undefined;
+  priority?: Priority | undefined;
+}
+export interface MessageTemplateSearchExpression {
+  queries?: MessageTemplateQueryField[] | undefined;
+  filters?: MessageTemplateFilterField[] | undefined;
+  orderOnField?: MessageTemplateOrderField | undefined;
+}
+export interface SearchMessageTemplatesRequest {
+  knowledgeBaseId: string | undefined;
+  searchExpression: MessageTemplateSearchExpression | undefined;
+  nextToken?: string | undefined;
+  maxResults?: number | undefined;
+}
+export interface MessageTemplateSearchResultData {
+  messageTemplateArn: string | undefined;
+  messageTemplateId: string | undefined;
+  knowledgeBaseArn: string | undefined;
+  knowledgeBaseId: string | undefined;
+  name: string | undefined;
+  channelSubtype: ChannelSubtype | undefined;
+  createdTime: Date | undefined;
+  lastModifiedTime: Date | undefined;
+  lastModifiedBy: string | undefined;
+  isActive?: boolean | undefined;
+  versionNumber?: number | undefined;
+  description?: string | undefined;
+  groupingConfiguration?: GroupingConfiguration | undefined;
+  language?: string | undefined;
+  tags?: Record<string, string> | undefined;
+}
+export interface SearchMessageTemplatesResponse {
+  results: MessageTemplateSearchResultData[] | undefined;
+  nextToken?: string | undefined;
+}
+export declare const QuickResponseFilterOperator: {
+  readonly EQUALS: "EQUALS";
+  readonly PREFIX: "PREFIX";
+};
+export type QuickResponseFilterOperator =
+  (typeof QuickResponseFilterOperator)[keyof typeof QuickResponseFilterOperator];
+export interface QuickResponseFilterField {
+  name: string | undefined;
+  values?: string[] | undefined;
+  operator: QuickResponseFilterOperator | undefined;
+  includeNoExistence?: boolean | undefined;
+}
+export interface QuickResponseOrderField {
+  name: string | undefined;
+  order?: Order | undefined;
+}
+export declare const QuickResponseQueryOperator: {
+  readonly CONTAINS: "CONTAINS";
+  readonly CONTAINS_AND_PREFIX: "CONTAINS_AND_PREFIX";
+};
+export type QuickResponseQueryOperator =
+  (typeof QuickResponseQueryOperator)[keyof typeof QuickResponseQueryOperator];
+export interface QuickResponseQueryField {
+  name: string | undefined;
+  values: string[] | undefined;
+  operator: QuickResponseQueryOperator | undefined;
+  allowFuzziness?: boolean | undefined;
+  priority?: Priority | undefined;
+}
+export interface QuickResponseSearchExpression {
+  queries?: QuickResponseQueryField[] | undefined;
+  filters?: QuickResponseFilterField[] | undefined;
+  orderOnField?: QuickResponseOrderField | undefined;
+}
+export interface SearchQuickResponsesRequest {
+  knowledgeBaseId: string | undefined;
+  searchExpression: QuickResponseSearchExpression | undefined;
+  nextToken?: string | undefined;
+  maxResults?: number | undefined;
+  attributes?: Record<string, string> | undefined;
+}
+export interface QuickResponseSearchResultData {
+  quickResponseArn: string | undefined;
+  quickResponseId: string | undefined;
+  knowledgeBaseArn: string | undefined;
+  knowledgeBaseId: string | undefined;
+  name: string | undefined;
+  contentType: string | undefined;
+  status: QuickResponseStatus | undefined;
+  contents: QuickResponseContents | undefined;
+  createdTime: Date | undefined;
+  lastModifiedTime: Date | undefined;
+  isActive: boolean | undefined;
+  description?: string | undefined;
+  groupingConfiguration?: GroupingConfiguration | undefined;
+  shortcutKey?: string | undefined;
+  lastModifiedBy?: string | undefined;
+  channels?: string[] | undefined;
+  language?: string | undefined;
+  attributesNotInterpolated?: string[] | undefined;
+  attributesInterpolated?: string[] | undefined;
+  tags?: Record<string, string> | undefined;
+}
+export interface SearchQuickResponsesResponse {
+  results: QuickResponseSearchResultData[] | undefined;
+  nextToken?: string | undefined;
+}
+export interface StartContentUploadRequest {
+  knowledgeBaseId: string | undefined;
+  contentType: string | undefined;
+  presignedUrlTimeToLive?: number | undefined;
+}
+export interface StartContentUploadResponse {
+  uploadId: string | undefined;
+  url: string | undefined;
+  urlExpiry: Date | undefined;
+  headersToInclude: Record<string, string> | undefined;
+}
+export interface StartImportJobRequest {
+  knowledgeBaseId: string | undefined;
+  importJobType: ImportJobType | undefined;
+  uploadId: string | undefined;
+  clientToken?: string | undefined;
+  metadata?: Record<string, string> | undefined;
+  externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
+}
+export interface StartImportJobResponse {
+  importJob?: ImportJobData | undefined;
+}
+export interface UpdateKnowledgeBaseTemplateUriRequest {
+  knowledgeBaseId: string | undefined;
+  templateUri: string | undefined;
+}
+export interface UpdateKnowledgeBaseTemplateUriResponse {
+  knowledgeBase?: KnowledgeBaseData | undefined;
+}
+export interface ListTagsForResourceRequest {
+  resourceArn: string | undefined;
+}
+export interface ListTagsForResourceResponse {
+  tags?: Record<string, string> | undefined;
+}
+export interface TagResourceRequest {
+  resourceArn: string | undefined;
+  tags: Record<string, string> | undefined;
+}
+export interface TagResourceResponse {}
+export declare class TooManyTagsException extends __BaseException {
+  readonly name: "TooManyTagsException";
+  readonly $fault: "client";
+  resourceName?: string | undefined;
+  constructor(
+    opts: __ExceptionOptionType<TooManyTagsException, __BaseException>
+  );
+}
+export interface UntagResourceRequest {
+  resourceArn: string | undefined;
+  tagKeys: string[] | undefined;
+}
+export interface UntagResourceResponse {}
+export type DataDetails =
+  | DataDetails.ContentDataMember
+  | DataDetails.GenerativeDataMember
+  | DataDetails.IntentDetectedDataMember
+  | DataDetails.SourceContentDataMember
+  | DataDetails.$UnknownMember;
+export declare namespace DataDetails {
+  interface ContentDataMember {
+    contentData: ContentDataDetails;
+    generativeData?: never;
+    intentDetectedData?: never;
+    sourceContentData?: never;
+    $unknown?: never;
+  }
+  interface GenerativeDataMember {
+    contentData?: never;
+    generativeData: GenerativeDataDetails;
+    intentDetectedData?: never;
+    sourceContentData?: never;
+    $unknown?: never;
+  }
+  interface IntentDetectedDataMember {
+    contentData?: never;
+    generativeData?: never;
+    intentDetectedData: IntentDetectedDataDetails;
+    sourceContentData?: never;
+    $unknown?: never;
+  }
+  interface SourceContentDataMember {
+    contentData?: never;
+    generativeData?: never;
+    intentDetectedData?: never;
+    sourceContentData: SourceContentDataDetails;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    contentData?: never;
+    generativeData?: never;
+    intentDetectedData?: never;
+    sourceContentData?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    contentData: (value: ContentDataDetails) => T;
+    generativeData: (value: GenerativeDataDetails) => T;
+    intentDetectedData: (value: IntentDetectedDataDetails) => T;
+    sourceContentData: (value: SourceContentDataDetails) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: DataDetails, visitor: Visitor<T>) => T;
+}
+export interface DataSummary {
+  reference: DataReference | undefined;
+  details: DataDetails | undefined;
+}
+export interface GenerativeDataDetails {
+  completion: string | undefined;
+  references: DataSummary[] | undefined;
+  rankingData: RankingData | undefined;
+}
+export interface RecommendationData {
+  recommendationId: string | undefined;
+  document?: Document | undefined;
+  relevanceScore?: number | undefined;
+  relevanceLevel?: RelevanceLevel | undefined;
+  type?: RecommendationType | undefined;
+  data?: DataSummary | undefined;
+}
+export interface ResultData {
+  resultId: string | undefined;
+  document?: Document | undefined;
+  relevanceScore?: number | undefined;
+  data?: DataSummary | undefined;
+  type?: QueryResultType | undefined;
+}
+export interface GetRecommendationsResponse {
+  recommendations: RecommendationData[] | undefined;
+  triggers?: RecommendationTrigger[] | undefined;
+}
+export interface QueryAssistantResponse {
+  results: ResultData[] | undefined;
+  nextToken?: string | undefined;
+}
+export declare const MessageTemplateSearchResultDataFilterSensitiveLog: (
+  obj: MessageTemplateSearchResultData
+) => any;
+export declare const SearchMessageTemplatesResponseFilterSensitiveLog: (
+  obj: SearchMessageTemplatesResponse
+) => any;
+export declare const SearchQuickResponsesRequestFilterSensitiveLog: (
+  obj: SearchQuickResponsesRequest
+) => any;
+export declare const QuickResponseSearchResultDataFilterSensitiveLog: (
+  obj: QuickResponseSearchResultData
+) => any;
+export declare const SearchQuickResponsesResponseFilterSensitiveLog: (
+  obj: SearchQuickResponsesResponse
+) => any;
+export declare const StartContentUploadResponseFilterSensitiveLog: (
+  obj: StartContentUploadResponse
+) => any;
+export declare const StartImportJobResponseFilterSensitiveLog: (
+  obj: StartImportJobResponse
+) => any;
+export declare const UpdateKnowledgeBaseTemplateUriResponseFilterSensitiveLog: (
+  obj: UpdateKnowledgeBaseTemplateUriResponse
+) => any;
+export declare const DataDetailsFilterSensitiveLog: (obj: DataDetails) => any;
+export declare const DataSummaryFilterSensitiveLog: (obj: DataSummary) => any;
+export declare const GenerativeDataDetailsFilterSensitiveLog: (
+  obj: GenerativeDataDetails
+) => any;
+export declare const RecommendationDataFilterSensitiveLog: (
+  obj: RecommendationData
+) => any;
+export declare const ResultDataFilterSensitiveLog: (obj: ResultData) => any;
+export declare const GetRecommendationsResponseFilterSensitiveLog: (
+  obj: GetRecommendationsResponse
+) => any;
+export declare const QueryAssistantResponseFilterSensitiveLog: (
+  obj: QueryAssistantResponse
+) => any;

package/dist-types/ts3.4/pagination/ListMessageTemplateVersionsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListMessageTemplateVersionsCommandInput,
+  ListMessageTemplateVersionsCommandOutput,
+} from "../commands/ListMessageTemplateVersionsCommand";
+import { QConnectPaginationConfiguration } from "./Interfaces";
+export declare const paginateListMessageTemplateVersions: (
+  config: QConnectPaginationConfiguration,
+  input: ListMessageTemplateVersionsCommandInput,
+  ...rest: any[]
+) => Paginator<ListMessageTemplateVersionsCommandOutput>;

package/dist-types/ts3.4/pagination/ListMessageTemplatesPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListMessageTemplatesCommandInput,
+  ListMessageTemplatesCommandOutput,
+} from "../commands/ListMessageTemplatesCommand";
+import { QConnectPaginationConfiguration } from "./Interfaces";
+export declare const paginateListMessageTemplates: (
+  config: QConnectPaginationConfiguration,
+  input: ListMessageTemplatesCommandInput,
+  ...rest: any[]
+) => Paginator<ListMessageTemplatesCommandOutput>;

package/dist-types/ts3.4/pagination/SearchMessageTemplatesPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  SearchMessageTemplatesCommandInput,
+  SearchMessageTemplatesCommandOutput,
+} from "../commands/SearchMessageTemplatesCommand";
+import { QConnectPaginationConfiguration } from "./Interfaces";
+export declare const paginateSearchMessageTemplates: (
+  config: QConnectPaginationConfiguration,
+  input: SearchMessageTemplatesCommandInput,
+  ...rest: any[]
+) => Paginator<SearchMessageTemplatesCommandOutput>;

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

@@ -9,8 +9,11 @@ export * from "./ListContentAssociationsPaginator";
 export * from "./ListContentsPaginator";
 export * from "./ListImportJobsPaginator";
 export * from "./ListKnowledgeBasesPaginator";
+export * from "./ListMessageTemplateVersionsPaginator";
+export * from "./ListMessageTemplatesPaginator";
 export * from "./ListQuickResponsesPaginator";
 export * from "./QueryAssistantPaginator";
 export * from "./SearchContentPaginator";
+export * from "./SearchMessageTemplatesPaginator";
 export * from "./SearchQuickResponsesPaginator";
 export * from "./SearchSessionsPaginator";