Type definitions#
Index > ConnectWisdomService > Type definitions
Auto-generated documentation for ConnectWisdomService type annotations stubs module types-boto3-wisdom.
AppIntegrationsConfigurationUnionTypeDef#
# AppIntegrationsConfigurationUnionTypeDef definition
AppIntegrationsConfigurationUnionTypeDef = Union[
AppIntegrationsConfigurationTypeDef, # (1)
AppIntegrationsConfigurationOutputTypeDef, # (2)
]
AppIntegrationsConfigurationOutputTypeDef#
# AppIntegrationsConfigurationOutputTypeDef definition
class AppIntegrationsConfigurationOutputTypeDef(TypedDict):
appIntegrationArn: str,
objectFields: NotRequired[list[str]],
AppIntegrationsConfigurationTypeDef#
# AppIntegrationsConfigurationTypeDef definition
class AppIntegrationsConfigurationTypeDef(TypedDict):
appIntegrationArn: str,
objectFields: NotRequired[Sequence[str]],
AssistantAssociationInputDataTypeDef#
# AssistantAssociationInputDataTypeDef definition
class AssistantAssociationInputDataTypeDef(TypedDict):
knowledgeBaseId: NotRequired[str],
KnowledgeBaseAssociationDataTypeDef#
# KnowledgeBaseAssociationDataTypeDef definition
class KnowledgeBaseAssociationDataTypeDef(TypedDict):
knowledgeBaseArn: NotRequired[str],
knowledgeBaseId: NotRequired[str],
AssistantIntegrationConfigurationTypeDef#
# AssistantIntegrationConfigurationTypeDef definition
class AssistantIntegrationConfigurationTypeDef(TypedDict):
topicIntegrationArn: NotRequired[str],
ServerSideEncryptionConfigurationTypeDef#
# ServerSideEncryptionConfigurationTypeDef definition
class ServerSideEncryptionConfigurationTypeDef(TypedDict):
kmsKeyId: NotRequired[str],
ConnectConfigurationTypeDef#
# ConnectConfigurationTypeDef definition
class ConnectConfigurationTypeDef(TypedDict):
instanceId: NotRequired[str],
ContentDataTypeDef#
# ContentDataTypeDef definition
class ContentDataTypeDef(TypedDict):
contentArn: str,
contentId: str,
contentType: str,
knowledgeBaseArn: str,
knowledgeBaseId: str,
metadata: dict[str, str],
name: str,
revisionId: str,
status: ContentStatusType, # (1)
title: str,
url: str,
urlExpiry: datetime,
linkOutUri: NotRequired[str],
tags: NotRequired[dict[str, str]],
ContentReferenceTypeDef#
# ContentReferenceTypeDef definition
class ContentReferenceTypeDef(TypedDict):
contentArn: NotRequired[str],
contentId: NotRequired[str],
knowledgeBaseArn: NotRequired[str],
knowledgeBaseId: NotRequired[str],
ContentSummaryTypeDef#
# ContentSummaryTypeDef definition
class ContentSummaryTypeDef(TypedDict):
contentArn: str,
contentId: str,
contentType: str,
knowledgeBaseArn: str,
knowledgeBaseId: str,
metadata: dict[str, str],
name: str,
revisionId: str,
status: ContentStatusType, # (1)
title: str,
tags: NotRequired[dict[str, str]],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
CreateContentRequestRequestTypeDef#
# CreateContentRequestRequestTypeDef definition
class CreateContentRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
name: str,
uploadId: str,
clientToken: NotRequired[str],
metadata: NotRequired[Mapping[str, str]],
overrideLinkOutUri: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
title: NotRequired[str],
RenderingConfigurationTypeDef#
# RenderingConfigurationTypeDef definition
class RenderingConfigurationTypeDef(TypedDict):
templateUri: NotRequired[str],
GroupingConfigurationTypeDef#
# GroupingConfigurationTypeDef definition
class GroupingConfigurationTypeDef(TypedDict):
criteria: NotRequired[str],
values: NotRequired[Sequence[str]],
QuickResponseDataProviderTypeDef#
# QuickResponseDataProviderTypeDef definition
class QuickResponseDataProviderTypeDef(TypedDict):
content: NotRequired[str],
CreateSessionRequestRequestTypeDef#
# CreateSessionRequestRequestTypeDef definition
class CreateSessionRequestRequestTypeDef(TypedDict):
assistantId: str,
name: str,
clientToken: NotRequired[str],
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
DeleteAssistantAssociationRequestRequestTypeDef#
# DeleteAssistantAssociationRequestRequestTypeDef definition
class DeleteAssistantAssociationRequestRequestTypeDef(TypedDict):
assistantAssociationId: str,
assistantId: str,
DeleteAssistantRequestRequestTypeDef#
# DeleteAssistantRequestRequestTypeDef definition
class DeleteAssistantRequestRequestTypeDef(TypedDict):
assistantId: str,
DeleteContentRequestRequestTypeDef#
# DeleteContentRequestRequestTypeDef definition
class DeleteContentRequestRequestTypeDef(TypedDict):
contentId: str,
knowledgeBaseId: str,
DeleteImportJobRequestRequestTypeDef#
# DeleteImportJobRequestRequestTypeDef definition
class DeleteImportJobRequestRequestTypeDef(TypedDict):
importJobId: str,
knowledgeBaseId: str,
DeleteKnowledgeBaseRequestRequestTypeDef#
# DeleteKnowledgeBaseRequestRequestTypeDef definition
class DeleteKnowledgeBaseRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
DeleteQuickResponseRequestRequestTypeDef#
# DeleteQuickResponseRequestRequestTypeDef definition
class DeleteQuickResponseRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
quickResponseId: str,
HighlightTypeDef#
# HighlightTypeDef definition
class HighlightTypeDef(TypedDict):
beginOffsetInclusive: NotRequired[int],
endOffsetExclusive: NotRequired[int],
FilterTypeDef#
# FilterTypeDef definition
class FilterTypeDef(TypedDict):
field: FilterFieldType, # (1)
operator: FilterOperatorType, # (2)
value: str,
- See FilterFieldType
- See FilterOperatorType
GetAssistantAssociationRequestRequestTypeDef#
# GetAssistantAssociationRequestRequestTypeDef definition
class GetAssistantAssociationRequestRequestTypeDef(TypedDict):
assistantAssociationId: str,
assistantId: str,
GetAssistantRequestRequestTypeDef#
# GetAssistantRequestRequestTypeDef definition
class GetAssistantRequestRequestTypeDef(TypedDict):
assistantId: str,
GetContentRequestRequestTypeDef#
# GetContentRequestRequestTypeDef definition
class GetContentRequestRequestTypeDef(TypedDict):
contentId: str,
knowledgeBaseId: str,
GetContentSummaryRequestRequestTypeDef#
# GetContentSummaryRequestRequestTypeDef definition
class GetContentSummaryRequestRequestTypeDef(TypedDict):
contentId: str,
knowledgeBaseId: str,
GetImportJobRequestRequestTypeDef#
# GetImportJobRequestRequestTypeDef definition
class GetImportJobRequestRequestTypeDef(TypedDict):
importJobId: str,
knowledgeBaseId: str,
GetKnowledgeBaseRequestRequestTypeDef#
# GetKnowledgeBaseRequestRequestTypeDef definition
class GetKnowledgeBaseRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
GetQuickResponseRequestRequestTypeDef#
# GetQuickResponseRequestRequestTypeDef definition
class GetQuickResponseRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
quickResponseId: str,
GetRecommendationsRequestRequestTypeDef#
# GetRecommendationsRequestRequestTypeDef definition
class GetRecommendationsRequestRequestTypeDef(TypedDict):
assistantId: str,
sessionId: str,
maxResults: NotRequired[int],
waitTimeSeconds: NotRequired[int],
GetSessionRequestRequestTypeDef#
# GetSessionRequestRequestTypeDef definition
class GetSessionRequestRequestTypeDef(TypedDict):
assistantId: str,
sessionId: str,
GroupingConfigurationOutputTypeDef#
# GroupingConfigurationOutputTypeDef definition
class GroupingConfigurationOutputTypeDef(TypedDict):
criteria: NotRequired[str],
values: NotRequired[list[str]],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListAssistantAssociationsRequestRequestTypeDef#
# ListAssistantAssociationsRequestRequestTypeDef definition
class ListAssistantAssociationsRequestRequestTypeDef(TypedDict):
assistantId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListAssistantsRequestRequestTypeDef#
# ListAssistantsRequestRequestTypeDef definition
class ListAssistantsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListContentsRequestRequestTypeDef#
# ListContentsRequestRequestTypeDef definition
class ListContentsRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListImportJobsRequestRequestTypeDef#
# ListImportJobsRequestRequestTypeDef definition
class ListImportJobsRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListKnowledgeBasesRequestRequestTypeDef#
# ListKnowledgeBasesRequestRequestTypeDef definition
class ListKnowledgeBasesRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListQuickResponsesRequestRequestTypeDef#
# ListQuickResponsesRequestRequestTypeDef definition
class ListQuickResponsesRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
QuickResponseSummaryTypeDef#
# QuickResponseSummaryTypeDef definition
class QuickResponseSummaryTypeDef(TypedDict):
contentType: str,
createdTime: datetime,
knowledgeBaseArn: str,
knowledgeBaseId: str,
lastModifiedTime: datetime,
name: str,
quickResponseArn: str,
quickResponseId: str,
status: QuickResponseStatusType, # (1)
channels: NotRequired[list[str]],
description: NotRequired[str],
isActive: NotRequired[bool],
lastModifiedBy: NotRequired[str],
tags: NotRequired[dict[str, str]],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
NotifyRecommendationsReceivedErrorTypeDef#
# NotifyRecommendationsReceivedErrorTypeDef definition
class NotifyRecommendationsReceivedErrorTypeDef(TypedDict):
message: NotRequired[str],
recommendationId: NotRequired[str],
NotifyRecommendationsReceivedRequestRequestTypeDef#
# NotifyRecommendationsReceivedRequestRequestTypeDef definition
class NotifyRecommendationsReceivedRequestRequestTypeDef(TypedDict):
assistantId: str,
recommendationIds: Sequence[str],
sessionId: str,
QueryAssistantRequestRequestTypeDef#
# QueryAssistantRequestRequestTypeDef definition
class QueryAssistantRequestRequestTypeDef(TypedDict):
assistantId: str,
queryText: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
QueryRecommendationTriggerDataTypeDef#
# QueryRecommendationTriggerDataTypeDef definition
class QueryRecommendationTriggerDataTypeDef(TypedDict):
text: NotRequired[str],
QuickResponseContentProviderTypeDef#
# QuickResponseContentProviderTypeDef definition
class QuickResponseContentProviderTypeDef(TypedDict):
content: NotRequired[str],
QuickResponseFilterFieldTypeDef#
# QuickResponseFilterFieldTypeDef definition
class QuickResponseFilterFieldTypeDef(TypedDict):
name: str,
operator: QuickResponseFilterOperatorType, # (1)
includeNoExistence: NotRequired[bool],
values: NotRequired[Sequence[str]],
QuickResponseOrderFieldTypeDef#
# QuickResponseOrderFieldTypeDef definition
class QuickResponseOrderFieldTypeDef(TypedDict):
name: str,
order: NotRequired[OrderType], # (1)
- See OrderType
QuickResponseQueryFieldTypeDef#
# QuickResponseQueryFieldTypeDef definition
class QuickResponseQueryFieldTypeDef(TypedDict):
name: str,
operator: QuickResponseQueryOperatorType, # (1)
values: Sequence[str],
allowFuzziness: NotRequired[bool],
priority: NotRequired[PriorityType], # (2)
RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef#
# RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef definition
class RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
SessionSummaryTypeDef#
# SessionSummaryTypeDef definition
class SessionSummaryTypeDef(TypedDict):
assistantArn: str,
assistantId: str,
sessionArn: str,
sessionId: str,
SessionIntegrationConfigurationTypeDef#
# SessionIntegrationConfigurationTypeDef definition
class SessionIntegrationConfigurationTypeDef(TypedDict):
topicIntegrationArn: NotRequired[str],
StartContentUploadRequestRequestTypeDef#
# StartContentUploadRequestRequestTypeDef definition
class StartContentUploadRequestRequestTypeDef(TypedDict):
contentType: str,
knowledgeBaseId: str,
presignedUrlTimeToLive: NotRequired[int],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateContentRequestRequestTypeDef#
# UpdateContentRequestRequestTypeDef definition
class UpdateContentRequestRequestTypeDef(TypedDict):
contentId: str,
knowledgeBaseId: str,
metadata: NotRequired[Mapping[str, str]],
overrideLinkOutUri: NotRequired[str],
removeOverrideLinkOutUri: NotRequired[bool],
revisionId: NotRequired[str],
title: NotRequired[str],
uploadId: NotRequired[str],
UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef#
# UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef definition
class UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
templateUri: str,
SourceConfigurationOutputTypeDef#
# SourceConfigurationOutputTypeDef definition
class SourceConfigurationOutputTypeDef(TypedDict):
appIntegrations: NotRequired[AppIntegrationsConfigurationOutputTypeDef], # (1)
CreateAssistantAssociationRequestRequestTypeDef#
# CreateAssistantAssociationRequestRequestTypeDef definition
class CreateAssistantAssociationRequestRequestTypeDef(TypedDict):
assistantId: str,
association: AssistantAssociationInputDataTypeDef, # (1)
associationType: AssociationTypeType, # (2)
clientToken: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
AssistantAssociationOutputDataTypeDef#
# AssistantAssociationOutputDataTypeDef definition
class AssistantAssociationOutputDataTypeDef(TypedDict):
knowledgeBaseAssociation: NotRequired[KnowledgeBaseAssociationDataTypeDef], # (1)
AssistantDataTypeDef#
# AssistantDataTypeDef definition
class AssistantDataTypeDef(TypedDict):
assistantArn: str,
assistantId: str,
name: str,
status: AssistantStatusType, # (3)
type: AssistantTypeType, # (4)
description: NotRequired[str],
integrationConfiguration: NotRequired[AssistantIntegrationConfigurationTypeDef], # (1)
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (2)
tags: NotRequired[dict[str, str]],
- See AssistantIntegrationConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See AssistantStatusType
- See AssistantTypeType
AssistantSummaryTypeDef#
# AssistantSummaryTypeDef definition
class AssistantSummaryTypeDef(TypedDict):
assistantArn: str,
assistantId: str,
name: str,
status: AssistantStatusType, # (3)
type: AssistantTypeType, # (4)
description: NotRequired[str],
integrationConfiguration: NotRequired[AssistantIntegrationConfigurationTypeDef], # (1)
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (2)
tags: NotRequired[dict[str, str]],
- See AssistantIntegrationConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See AssistantStatusType
- See AssistantTypeType
CreateAssistantRequestRequestTypeDef#
# CreateAssistantRequestRequestTypeDef definition
class CreateAssistantRequestRequestTypeDef(TypedDict):
name: str,
type: AssistantTypeType, # (1)
clientToken: NotRequired[str],
description: NotRequired[str],
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (2)
tags: NotRequired[Mapping[str, str]],
ConfigurationTypeDef#
# ConfigurationTypeDef definition
class ConfigurationTypeDef(TypedDict):
connectConfiguration: NotRequired[ConnectConfigurationTypeDef], # (1)
CreateContentResponseTypeDef#
# CreateContentResponseTypeDef definition
class CreateContentResponseTypeDef(TypedDict):
content: ContentDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetContentResponseTypeDef#
# GetContentResponseTypeDef definition
class GetContentResponseTypeDef(TypedDict):
content: ContentDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetContentSummaryResponseTypeDef#
# GetContentSummaryResponseTypeDef definition
class GetContentSummaryResponseTypeDef(TypedDict):
contentSummary: ContentSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListContentsResponseTypeDef#
# ListContentsResponseTypeDef definition
class ListContentsResponseTypeDef(TypedDict):
contentSummaries: list[ContentSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SearchContentResponseTypeDef#
# SearchContentResponseTypeDef definition
class SearchContentResponseTypeDef(TypedDict):
contentSummaries: list[ContentSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
StartContentUploadResponseTypeDef#
# StartContentUploadResponseTypeDef definition
class StartContentUploadResponseTypeDef(TypedDict):
headersToInclude: dict[str, str],
uploadId: str,
url: str,
urlExpiry: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateContentResponseTypeDef#
# UpdateContentResponseTypeDef definition
class UpdateContentResponseTypeDef(TypedDict):
content: ContentDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateQuickResponseRequestRequestTypeDef#
# CreateQuickResponseRequestRequestTypeDef definition
class CreateQuickResponseRequestRequestTypeDef(TypedDict):
content: QuickResponseDataProviderTypeDef, # (1)
knowledgeBaseId: str,
name: str,
channels: NotRequired[Sequence[str]],
clientToken: NotRequired[str],
contentType: NotRequired[str],
description: NotRequired[str],
groupingConfiguration: NotRequired[GroupingConfigurationTypeDef], # (2)
isActive: NotRequired[bool],
language: NotRequired[str],
shortcutKey: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
UpdateQuickResponseRequestRequestTypeDef#
# UpdateQuickResponseRequestRequestTypeDef definition
class UpdateQuickResponseRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
quickResponseId: str,
channels: NotRequired[Sequence[str]],
content: NotRequired[QuickResponseDataProviderTypeDef], # (1)
contentType: NotRequired[str],
description: NotRequired[str],
groupingConfiguration: NotRequired[GroupingConfigurationTypeDef], # (2)
isActive: NotRequired[bool],
language: NotRequired[str],
name: NotRequired[str],
removeDescription: NotRequired[bool],
removeGroupingConfiguration: NotRequired[bool],
removeShortcutKey: NotRequired[bool],
shortcutKey: NotRequired[str],
DocumentTextTypeDef#
# DocumentTextTypeDef definition
class DocumentTextTypeDef(TypedDict):
highlights: NotRequired[list[HighlightTypeDef]], # (1)
text: NotRequired[str],
- See HighlightTypeDef
SearchExpressionTypeDef#
# SearchExpressionTypeDef definition
class SearchExpressionTypeDef(TypedDict):
filters: Sequence[FilterTypeDef], # (1)
- See FilterTypeDef
ListAssistantAssociationsRequestPaginateTypeDef#
# ListAssistantAssociationsRequestPaginateTypeDef definition
class ListAssistantAssociationsRequestPaginateTypeDef(TypedDict):
assistantId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAssistantsRequestPaginateTypeDef#
# ListAssistantsRequestPaginateTypeDef definition
class ListAssistantsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListContentsRequestPaginateTypeDef#
# ListContentsRequestPaginateTypeDef definition
class ListContentsRequestPaginateTypeDef(TypedDict):
knowledgeBaseId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListImportJobsRequestPaginateTypeDef#
# ListImportJobsRequestPaginateTypeDef definition
class ListImportJobsRequestPaginateTypeDef(TypedDict):
knowledgeBaseId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListKnowledgeBasesRequestPaginateTypeDef#
# ListKnowledgeBasesRequestPaginateTypeDef definition
class ListKnowledgeBasesRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListQuickResponsesRequestPaginateTypeDef#
# ListQuickResponsesRequestPaginateTypeDef definition
class ListQuickResponsesRequestPaginateTypeDef(TypedDict):
knowledgeBaseId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
QueryAssistantRequestPaginateTypeDef#
# QueryAssistantRequestPaginateTypeDef definition
class QueryAssistantRequestPaginateTypeDef(TypedDict):
assistantId: str,
queryText: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListQuickResponsesResponseTypeDef#
# ListQuickResponsesResponseTypeDef definition
class ListQuickResponsesResponseTypeDef(TypedDict):
quickResponseSummaries: list[QuickResponseSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
NotifyRecommendationsReceivedResponseTypeDef#
# NotifyRecommendationsReceivedResponseTypeDef definition
class NotifyRecommendationsReceivedResponseTypeDef(TypedDict):
errors: list[NotifyRecommendationsReceivedErrorTypeDef], # (1)
recommendationIds: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RecommendationTriggerDataTypeDef#
# RecommendationTriggerDataTypeDef definition
class RecommendationTriggerDataTypeDef(TypedDict):
query: NotRequired[QueryRecommendationTriggerDataTypeDef], # (1)
QuickResponseContentsTypeDef#
# QuickResponseContentsTypeDef definition
class QuickResponseContentsTypeDef(TypedDict):
markdown: NotRequired[QuickResponseContentProviderTypeDef], # (1)
plainText: NotRequired[QuickResponseContentProviderTypeDef], # (1)
QuickResponseSearchExpressionTypeDef#
# QuickResponseSearchExpressionTypeDef definition
class QuickResponseSearchExpressionTypeDef(TypedDict):
filters: NotRequired[Sequence[QuickResponseFilterFieldTypeDef]], # (1)
orderOnField: NotRequired[QuickResponseOrderFieldTypeDef], # (2)
queries: NotRequired[Sequence[QuickResponseQueryFieldTypeDef]], # (3)
- See QuickResponseFilterFieldTypeDef
- See QuickResponseOrderFieldTypeDef
- See QuickResponseQueryFieldTypeDef
SearchSessionsResponseTypeDef#
# SearchSessionsResponseTypeDef definition
class SearchSessionsResponseTypeDef(TypedDict):
sessionSummaries: list[SessionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
SessionDataTypeDef#
# SessionDataTypeDef definition
class SessionDataTypeDef(TypedDict):
name: str,
sessionArn: str,
sessionId: str,
description: NotRequired[str],
integrationConfiguration: NotRequired[SessionIntegrationConfigurationTypeDef], # (1)
tags: NotRequired[dict[str, str]],
KnowledgeBaseDataTypeDef#
# KnowledgeBaseDataTypeDef definition
class KnowledgeBaseDataTypeDef(TypedDict):
knowledgeBaseArn: str,
knowledgeBaseId: str,
knowledgeBaseType: KnowledgeBaseTypeType, # (1)
name: str,
status: KnowledgeBaseStatusType, # (5)
description: NotRequired[str],
lastContentModificationTime: NotRequired[datetime],
renderingConfiguration: NotRequired[RenderingConfigurationTypeDef], # (2)
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (3)
sourceConfiguration: NotRequired[SourceConfigurationOutputTypeDef], # (4)
tags: NotRequired[dict[str, str]],
- See KnowledgeBaseTypeType
- See RenderingConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See SourceConfigurationOutputTypeDef
- See KnowledgeBaseStatusType
KnowledgeBaseSummaryTypeDef#
# KnowledgeBaseSummaryTypeDef definition
class KnowledgeBaseSummaryTypeDef(TypedDict):
knowledgeBaseArn: str,
knowledgeBaseId: str,
knowledgeBaseType: KnowledgeBaseTypeType, # (1)
name: str,
status: KnowledgeBaseStatusType, # (5)
description: NotRequired[str],
renderingConfiguration: NotRequired[RenderingConfigurationTypeDef], # (2)
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (3)
sourceConfiguration: NotRequired[SourceConfigurationOutputTypeDef], # (4)
tags: NotRequired[dict[str, str]],
- See KnowledgeBaseTypeType
- See RenderingConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See SourceConfigurationOutputTypeDef
- See KnowledgeBaseStatusType
SourceConfigurationTypeDef#
# SourceConfigurationTypeDef definition
class SourceConfigurationTypeDef(TypedDict):
appIntegrations: NotRequired[AppIntegrationsConfigurationUnionTypeDef], # (1)
AssistantAssociationDataTypeDef#
# AssistantAssociationDataTypeDef definition
class AssistantAssociationDataTypeDef(TypedDict):
assistantArn: str,
assistantAssociationArn: str,
assistantAssociationId: str,
assistantId: str,
associationData: AssistantAssociationOutputDataTypeDef, # (1)
associationType: AssociationTypeType, # (2)
tags: NotRequired[dict[str, str]],
AssistantAssociationSummaryTypeDef#
# AssistantAssociationSummaryTypeDef definition
class AssistantAssociationSummaryTypeDef(TypedDict):
assistantArn: str,
assistantAssociationArn: str,
assistantAssociationId: str,
assistantId: str,
associationData: AssistantAssociationOutputDataTypeDef, # (1)
associationType: AssociationTypeType, # (2)
tags: NotRequired[dict[str, str]],
CreateAssistantResponseTypeDef#
# CreateAssistantResponseTypeDef definition
class CreateAssistantResponseTypeDef(TypedDict):
assistant: AssistantDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAssistantResponseTypeDef#
# GetAssistantResponseTypeDef definition
class GetAssistantResponseTypeDef(TypedDict):
assistant: AssistantDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAssistantsResponseTypeDef#
# ListAssistantsResponseTypeDef definition
class ListAssistantsResponseTypeDef(TypedDict):
assistantSummaries: list[AssistantSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ExternalSourceConfigurationTypeDef#
# ExternalSourceConfigurationTypeDef definition
class ExternalSourceConfigurationTypeDef(TypedDict):
configuration: ConfigurationTypeDef, # (1)
source: ExternalSourceType, # (2)
DocumentTypeDef#
# DocumentTypeDef definition
class DocumentTypeDef(TypedDict):
contentReference: ContentReferenceTypeDef, # (1)
excerpt: NotRequired[DocumentTextTypeDef], # (2)
title: NotRequired[DocumentTextTypeDef], # (2)
SearchContentRequestPaginateTypeDef#
# SearchContentRequestPaginateTypeDef definition
class SearchContentRequestPaginateTypeDef(TypedDict):
knowledgeBaseId: str,
searchExpression: SearchExpressionTypeDef, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
SearchContentRequestRequestTypeDef#
# SearchContentRequestRequestTypeDef definition
class SearchContentRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
searchExpression: SearchExpressionTypeDef, # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
SearchSessionsRequestPaginateTypeDef#
# SearchSessionsRequestPaginateTypeDef definition
class SearchSessionsRequestPaginateTypeDef(TypedDict):
assistantId: str,
searchExpression: SearchExpressionTypeDef, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
SearchSessionsRequestRequestTypeDef#
# SearchSessionsRequestRequestTypeDef definition
class SearchSessionsRequestRequestTypeDef(TypedDict):
assistantId: str,
searchExpression: SearchExpressionTypeDef, # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
RecommendationTriggerTypeDef#
# RecommendationTriggerTypeDef definition
class RecommendationTriggerTypeDef(TypedDict):
data: RecommendationTriggerDataTypeDef, # (1)
id: str,
recommendationIds: list[str],
source: RecommendationSourceTypeType, # (2)
type: RecommendationTriggerTypeType, # (3)
- See RecommendationTriggerDataTypeDef
- See RecommendationSourceTypeType
- See RecommendationTriggerTypeType
QuickResponseDataTypeDef#
# QuickResponseDataTypeDef definition
class QuickResponseDataTypeDef(TypedDict):
contentType: str,
createdTime: datetime,
knowledgeBaseArn: str,
knowledgeBaseId: str,
lastModifiedTime: datetime,
name: str,
quickResponseArn: str,
quickResponseId: str,
status: QuickResponseStatusType, # (3)
channels: NotRequired[list[str]],
contents: NotRequired[QuickResponseContentsTypeDef], # (1)
description: NotRequired[str],
groupingConfiguration: NotRequired[GroupingConfigurationOutputTypeDef], # (2)
isActive: NotRequired[bool],
language: NotRequired[str],
lastModifiedBy: NotRequired[str],
shortcutKey: NotRequired[str],
tags: NotRequired[dict[str, str]],
QuickResponseSearchResultDataTypeDef#
# QuickResponseSearchResultDataTypeDef definition
class QuickResponseSearchResultDataTypeDef(TypedDict):
contentType: str,
contents: QuickResponseContentsTypeDef, # (1)
createdTime: datetime,
isActive: bool,
knowledgeBaseArn: str,
knowledgeBaseId: str,
lastModifiedTime: datetime,
name: str,
quickResponseArn: str,
quickResponseId: str,
status: QuickResponseStatusType, # (3)
attributesInterpolated: NotRequired[list[str]],
attributesNotInterpolated: NotRequired[list[str]],
channels: NotRequired[list[str]],
description: NotRequired[str],
groupingConfiguration: NotRequired[GroupingConfigurationOutputTypeDef], # (2)
language: NotRequired[str],
lastModifiedBy: NotRequired[str],
shortcutKey: NotRequired[str],
tags: NotRequired[dict[str, str]],
SearchQuickResponsesRequestPaginateTypeDef#
# SearchQuickResponsesRequestPaginateTypeDef definition
class SearchQuickResponsesRequestPaginateTypeDef(TypedDict):
knowledgeBaseId: str,
searchExpression: QuickResponseSearchExpressionTypeDef, # (1)
attributes: NotRequired[Mapping[str, str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
SearchQuickResponsesRequestRequestTypeDef#
# SearchQuickResponsesRequestRequestTypeDef definition
class SearchQuickResponsesRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
searchExpression: QuickResponseSearchExpressionTypeDef, # (1)
attributes: NotRequired[Mapping[str, str]],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
CreateSessionResponseTypeDef#
# CreateSessionResponseTypeDef definition
class CreateSessionResponseTypeDef(TypedDict):
session: SessionDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSessionResponseTypeDef#
# GetSessionResponseTypeDef definition
class GetSessionResponseTypeDef(TypedDict):
session: SessionDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateKnowledgeBaseResponseTypeDef#
# CreateKnowledgeBaseResponseTypeDef definition
class CreateKnowledgeBaseResponseTypeDef(TypedDict):
knowledgeBase: KnowledgeBaseDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetKnowledgeBaseResponseTypeDef#
# GetKnowledgeBaseResponseTypeDef definition
class GetKnowledgeBaseResponseTypeDef(TypedDict):
knowledgeBase: KnowledgeBaseDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateKnowledgeBaseTemplateUriResponseTypeDef#
# UpdateKnowledgeBaseTemplateUriResponseTypeDef definition
class UpdateKnowledgeBaseTemplateUriResponseTypeDef(TypedDict):
knowledgeBase: KnowledgeBaseDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListKnowledgeBasesResponseTypeDef#
# ListKnowledgeBasesResponseTypeDef definition
class ListKnowledgeBasesResponseTypeDef(TypedDict):
knowledgeBaseSummaries: list[KnowledgeBaseSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
CreateKnowledgeBaseRequestRequestTypeDef#
# CreateKnowledgeBaseRequestRequestTypeDef definition
class CreateKnowledgeBaseRequestRequestTypeDef(TypedDict):
knowledgeBaseType: KnowledgeBaseTypeType, # (1)
name: str,
clientToken: NotRequired[str],
description: NotRequired[str],
renderingConfiguration: NotRequired[RenderingConfigurationTypeDef], # (2)
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (3)
sourceConfiguration: NotRequired[SourceConfigurationTypeDef], # (4)
tags: NotRequired[Mapping[str, str]],
- See KnowledgeBaseTypeType
- See RenderingConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See SourceConfigurationTypeDef
CreateAssistantAssociationResponseTypeDef#
# CreateAssistantAssociationResponseTypeDef definition
class CreateAssistantAssociationResponseTypeDef(TypedDict):
assistantAssociation: AssistantAssociationDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAssistantAssociationResponseTypeDef#
# GetAssistantAssociationResponseTypeDef definition
class GetAssistantAssociationResponseTypeDef(TypedDict):
assistantAssociation: AssistantAssociationDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAssistantAssociationsResponseTypeDef#
# ListAssistantAssociationsResponseTypeDef definition
class ListAssistantAssociationsResponseTypeDef(TypedDict):
assistantAssociationSummaries: list[AssistantAssociationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ImportJobDataTypeDef#
# ImportJobDataTypeDef definition
class ImportJobDataTypeDef(TypedDict):
createdTime: datetime,
importJobId: str,
importJobType: ImportJobTypeType, # (2)
knowledgeBaseArn: str,
knowledgeBaseId: str,
lastModifiedTime: datetime,
status: ImportJobStatusType, # (3)
uploadId: str,
url: str,
urlExpiry: datetime,
externalSourceConfiguration: NotRequired[ExternalSourceConfigurationTypeDef], # (1)
failedRecordReport: NotRequired[str],
metadata: NotRequired[dict[str, str]],
ImportJobSummaryTypeDef#
# ImportJobSummaryTypeDef definition
class ImportJobSummaryTypeDef(TypedDict):
createdTime: datetime,
importJobId: str,
importJobType: ImportJobTypeType, # (2)
knowledgeBaseArn: str,
knowledgeBaseId: str,
lastModifiedTime: datetime,
status: ImportJobStatusType, # (3)
uploadId: str,
externalSourceConfiguration: NotRequired[ExternalSourceConfigurationTypeDef], # (1)
metadata: NotRequired[dict[str, str]],
StartImportJobRequestRequestTypeDef#
# StartImportJobRequestRequestTypeDef definition
class StartImportJobRequestRequestTypeDef(TypedDict):
importJobType: ImportJobTypeType, # (1)
knowledgeBaseId: str,
uploadId: str,
clientToken: NotRequired[str],
externalSourceConfiguration: NotRequired[ExternalSourceConfigurationTypeDef], # (2)
metadata: NotRequired[Mapping[str, str]],
RecommendationDataTypeDef#
# RecommendationDataTypeDef definition
class RecommendationDataTypeDef(TypedDict):
document: DocumentTypeDef, # (1)
recommendationId: str,
relevanceLevel: NotRequired[RelevanceLevelType], # (2)
relevanceScore: NotRequired[float],
type: NotRequired[RecommendationTypeType], # (3)
- See DocumentTypeDef
- See RelevanceLevelType
- See RecommendationTypeType
ResultDataTypeDef#
# ResultDataTypeDef definition
class ResultDataTypeDef(TypedDict):
document: DocumentTypeDef, # (1)
resultId: str,
relevanceScore: NotRequired[float],
- See DocumentTypeDef
CreateQuickResponseResponseTypeDef#
# CreateQuickResponseResponseTypeDef definition
class CreateQuickResponseResponseTypeDef(TypedDict):
quickResponse: QuickResponseDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetQuickResponseResponseTypeDef#
# GetQuickResponseResponseTypeDef definition
class GetQuickResponseResponseTypeDef(TypedDict):
quickResponse: QuickResponseDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateQuickResponseResponseTypeDef#
# UpdateQuickResponseResponseTypeDef definition
class UpdateQuickResponseResponseTypeDef(TypedDict):
quickResponse: QuickResponseDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchQuickResponsesResponseTypeDef#
# SearchQuickResponsesResponseTypeDef definition
class SearchQuickResponsesResponseTypeDef(TypedDict):
results: list[QuickResponseSearchResultDataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
GetImportJobResponseTypeDef#
# GetImportJobResponseTypeDef definition
class GetImportJobResponseTypeDef(TypedDict):
importJob: ImportJobDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartImportJobResponseTypeDef#
# StartImportJobResponseTypeDef definition
class StartImportJobResponseTypeDef(TypedDict):
importJob: ImportJobDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListImportJobsResponseTypeDef#
# ListImportJobsResponseTypeDef definition
class ListImportJobsResponseTypeDef(TypedDict):
importJobSummaries: list[ImportJobSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
GetRecommendationsResponseTypeDef#
# GetRecommendationsResponseTypeDef definition
class GetRecommendationsResponseTypeDef(TypedDict):
recommendations: list[RecommendationDataTypeDef], # (1)
triggers: list[RecommendationTriggerTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
QueryAssistantResponseTypeDef#
# QueryAssistantResponseTypeDef definition
class QueryAssistantResponseTypeDef(TypedDict):
results: list[ResultDataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],