Type definitions#
Auto-generated documentation for QConnect type annotations stubs module mypy-boto3-qconnect.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]AppIntegrationsConfigurationUnionTypeDef#
# AppIntegrationsConfigurationUnionTypeDef definition
AppIntegrationsConfigurationUnionTypeDef = Union[
AppIntegrationsConfigurationTypeDef, # (1)
AppIntegrationsConfigurationOutputTypeDef, # (2)
]CustomerProfileAttributesUnionTypeDef#
# CustomerProfileAttributesUnionTypeDef definition
CustomerProfileAttributesUnionTypeDef = Union[
CustomerProfileAttributesTypeDef, # (1)
CustomerProfileAttributesOutputTypeDef, # (2)
]GuardrailTopicConfigUnionTypeDef#
# GuardrailTopicConfigUnionTypeDef definition
GuardrailTopicConfigUnionTypeDef = Union[
GuardrailTopicConfigTypeDef, # (1)
GuardrailTopicConfigOutputTypeDef, # (2)
]HierarchicalChunkingConfigurationUnionTypeDef#
# HierarchicalChunkingConfigurationUnionTypeDef definition
HierarchicalChunkingConfigurationUnionTypeDef = Union[
HierarchicalChunkingConfigurationTypeDef, # (1)
HierarchicalChunkingConfigurationOutputTypeDef, # (2)
]OrConditionUnionTypeDef#
# OrConditionUnionTypeDef definition
OrConditionUnionTypeDef = Union[
OrConditionTypeDef, # (1)
OrConditionOutputTypeDef, # (2)
]UrlConfigurationUnionTypeDef#
# UrlConfigurationUnionTypeDef definition
UrlConfigurationUnionTypeDef = Union[
UrlConfigurationTypeDef, # (1)
UrlConfigurationOutputTypeDef, # (2)
]EmailMessageTemplateContentUnionTypeDef#
# EmailMessageTemplateContentUnionTypeDef definition
EmailMessageTemplateContentUnionTypeDef = Union[
EmailMessageTemplateContentTypeDef, # (1)
EmailMessageTemplateContentOutputTypeDef, # (2)
]ChunkingConfigurationUnionTypeDef#
# ChunkingConfigurationUnionTypeDef definition
ChunkingConfigurationUnionTypeDef = Union[
ChunkingConfigurationTypeDef, # (1)
ChunkingConfigurationOutputTypeDef, # (2)
]TagFilterUnionTypeDef#
# TagFilterUnionTypeDef definition
TagFilterUnionTypeDef = Union[
TagFilterTypeDef, # (1)
TagFilterOutputTypeDef, # (2)
]WebCrawlerConfigurationUnionTypeDef#
# WebCrawlerConfigurationUnionTypeDef definition
WebCrawlerConfigurationUnionTypeDef = Union[
WebCrawlerConfigurationTypeDef, # (1)
WebCrawlerConfigurationOutputTypeDef, # (2)
]KnowledgeBaseAssociationConfigurationDataUnionTypeDef#
# KnowledgeBaseAssociationConfigurationDataUnionTypeDef definition
KnowledgeBaseAssociationConfigurationDataUnionTypeDef = Union[
KnowledgeBaseAssociationConfigurationDataTypeDef, # (1)
KnowledgeBaseAssociationConfigurationDataOutputTypeDef, # (2)
]- See KnowledgeBaseAssociationConfigurationDataTypeDef
- See KnowledgeBaseAssociationConfigurationDataOutputTypeDef
ManagedSourceConfigurationUnionTypeDef#
# ManagedSourceConfigurationUnionTypeDef definition
ManagedSourceConfigurationUnionTypeDef = Union[
ManagedSourceConfigurationTypeDef, # (1)
ManagedSourceConfigurationOutputTypeDef, # (2)
]AssociationConfigurationDataUnionTypeDef#
# AssociationConfigurationDataUnionTypeDef definition
AssociationConfigurationDataUnionTypeDef = Union[
AssociationConfigurationDataTypeDef, # (1)
AssociationConfigurationDataOutputTypeDef, # (2)
]AssociationConfigurationUnionTypeDef#
# AssociationConfigurationUnionTypeDef definition
AssociationConfigurationUnionTypeDef = Union[
AssociationConfigurationTypeDef, # (1)
AssociationConfigurationOutputTypeDef, # (2)
]AnswerRecommendationAIAgentConfigurationUnionTypeDef#
# AnswerRecommendationAIAgentConfigurationUnionTypeDef definition
AnswerRecommendationAIAgentConfigurationUnionTypeDef = Union[
AnswerRecommendationAIAgentConfigurationTypeDef, # (1)
AnswerRecommendationAIAgentConfigurationOutputTypeDef, # (2)
]- See AnswerRecommendationAIAgentConfigurationTypeDef
- See AnswerRecommendationAIAgentConfigurationOutputTypeDef
ManualSearchAIAgentConfigurationUnionTypeDef#
# ManualSearchAIAgentConfigurationUnionTypeDef definition
ManualSearchAIAgentConfigurationUnionTypeDef = Union[
ManualSearchAIAgentConfigurationTypeDef, # (1)
ManualSearchAIAgentConfigurationOutputTypeDef, # (2)
]SelfServiceAIAgentConfigurationUnionTypeDef#
# SelfServiceAIAgentConfigurationUnionTypeDef definition
SelfServiceAIAgentConfigurationUnionTypeDef = Union[
SelfServiceAIAgentConfigurationTypeDef, # (1)
SelfServiceAIAgentConfigurationOutputTypeDef, # (2)
]AIAgentConfigurationDataTypeDef#
# AIAgentConfigurationDataTypeDef definition
class AIAgentConfigurationDataTypeDef(TypedDict):
aiAgentId: str,GuardrailContentFilterConfigTypeDef#
# GuardrailContentFilterConfigTypeDef definition
class GuardrailContentFilterConfigTypeDef(TypedDict):
inputStrength: GuardrailFilterStrengthType, # (1)
outputStrength: GuardrailFilterStrengthType, # (1)
type: GuardrailContentFilterTypeType, # (3)GuardrailContextualGroundingFilterConfigTypeDef#
# GuardrailContextualGroundingFilterConfigTypeDef definition
class GuardrailContextualGroundingFilterConfigTypeDef(TypedDict):
threshold: float,
type: GuardrailContextualGroundingFilterTypeType, # (1)GuardrailPiiEntityConfigTypeDef#
# GuardrailPiiEntityConfigTypeDef definition
class GuardrailPiiEntityConfigTypeDef(TypedDict):
action: GuardrailSensitiveInformationActionType, # (1)
type: GuardrailPiiEntityTypeType, # (2)GuardrailRegexConfigTypeDef#
# GuardrailRegexConfigTypeDef definition
class GuardrailRegexConfigTypeDef(TypedDict):
action: GuardrailSensitiveInformationActionType, # (1)
name: str,
pattern: str,
description: NotRequired[str],AIGuardrailSummaryTypeDef#
# AIGuardrailSummaryTypeDef definition
class AIGuardrailSummaryTypeDef(TypedDict):
aiGuardrailArn: str,
aiGuardrailId: str,
assistantArn: str,
assistantId: str,
name: str,
visibilityStatus: VisibilityStatusType, # (2)
description: NotRequired[str],
modifiedTime: NotRequired[datetime],
status: NotRequired[StatusType], # (1)
tags: NotRequired[dict[str, str]],- See StatusType
- See VisibilityStatusType
GuardrailTopicConfigOutputTypeDef#
# GuardrailTopicConfigOutputTypeDef definition
class GuardrailTopicConfigOutputTypeDef(TypedDict):
definition: str,
name: str,
type: GuardrailTopicTypeType, # (1)
examples: NotRequired[list[str]],GuardrailManagedWordsConfigTypeDef#
# GuardrailManagedWordsConfigTypeDef definition
class GuardrailManagedWordsConfigTypeDef(TypedDict):
type: GuardrailManagedWordsTypeType, # (1)GuardrailWordConfigTypeDef#
# GuardrailWordConfigTypeDef definition
class GuardrailWordConfigTypeDef(TypedDict):
text: str,AIPromptSummaryTypeDef#
# AIPromptSummaryTypeDef definition
class AIPromptSummaryTypeDef(TypedDict):
aiPromptArn: str,
aiPromptId: str,
apiFormat: AIPromptAPIFormatType, # (1)
assistantArn: str,
assistantId: str,
modelId: str,
name: str,
templateType: AIPromptTemplateTypeType, # (4)
type: AIPromptTypeType, # (5)
visibilityStatus: VisibilityStatusType, # (6)
description: NotRequired[str],
modifiedTime: NotRequired[datetime],
origin: NotRequired[OriginType], # (2)
status: NotRequired[StatusType], # (3)
tags: NotRequired[dict[str, str]],- See AIPromptAPIFormatType
- See OriginType
- See StatusType
- See AIPromptTemplateTypeType
- See AIPromptTypeType
- See VisibilityStatusType
TextFullAIPromptEditTemplateConfigurationTypeDef#
# TextFullAIPromptEditTemplateConfigurationTypeDef definition
class TextFullAIPromptEditTemplateConfigurationTypeDef(TypedDict):
text: str,ActivateMessageTemplateRequestRequestTypeDef#
# ActivateMessageTemplateRequestRequestTypeDef definition
class ActivateMessageTemplateRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
messageTemplateId: str,
versionNumber: int,ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],AgentAttributesTypeDef#
# AgentAttributesTypeDef definition
class AgentAttributesTypeDef(TypedDict):
firstName: NotRequired[str],
lastName: NotRequired[str],AmazonConnectGuideAssociationDataTypeDef#
# AmazonConnectGuideAssociationDataTypeDef definition
class AmazonConnectGuideAssociationDataTypeDef(TypedDict):
flowId: NotRequired[str],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],AssistantCapabilityConfigurationTypeDef#
# AssistantCapabilityConfigurationTypeDef definition
class AssistantCapabilityConfigurationTypeDef(TypedDict):
type: NotRequired[AssistantCapabilityTypeType], # (1)AssistantIntegrationConfigurationTypeDef#
# AssistantIntegrationConfigurationTypeDef definition
class AssistantIntegrationConfigurationTypeDef(TypedDict):
topicIntegrationArn: NotRequired[str],ServerSideEncryptionConfigurationTypeDef#
# ServerSideEncryptionConfigurationTypeDef definition
class ServerSideEncryptionConfigurationTypeDef(TypedDict):
kmsKeyId: NotRequired[str],ParsingPromptTypeDef#
# ParsingPromptTypeDef definition
class ParsingPromptTypeDef(TypedDict):
parsingPromptText: str,FixedSizeChunkingConfigurationTypeDef#
# FixedSizeChunkingConfigurationTypeDef definition
class FixedSizeChunkingConfigurationTypeDef(TypedDict):
maxTokens: int,
overlapPercentage: int,SemanticChunkingConfigurationTypeDef#
# SemanticChunkingConfigurationTypeDef definition
class SemanticChunkingConfigurationTypeDef(TypedDict):
breakpointPercentileThreshold: int,
bufferSize: int,
maxTokens: int,CitationSpanTypeDef#
# CitationSpanTypeDef definition
class CitationSpanTypeDef(TypedDict):
beginOffsetInclusive: NotRequired[int],
endOffsetExclusive: NotRequired[int],ConnectConfigurationTypeDef#
# ConnectConfigurationTypeDef definition
class ConnectConfigurationTypeDef(TypedDict):
instanceId: NotRequired[str],RankingDataTypeDef#
# RankingDataTypeDef definition
class RankingDataTypeDef(TypedDict):
relevanceLevel: NotRequired[RelevanceLevelType], # (1)
relevanceScore: NotRequired[float],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]],GenerativeContentFeedbackDataTypeDef#
# GenerativeContentFeedbackDataTypeDef definition
class GenerativeContentFeedbackDataTypeDef(TypedDict):
relevance: RelevanceType, # (1)- See RelevanceType
ContentReferenceTypeDef#
# ContentReferenceTypeDef definition
class ContentReferenceTypeDef(TypedDict):
contentArn: NotRequired[str],
contentId: NotRequired[str],
knowledgeBaseArn: NotRequired[str],
knowledgeBaseId: NotRequired[str],
referenceType: NotRequired[ReferenceTypeType], # (1)
sourceURL: 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]],SelfServiceConversationHistoryTypeDef#
# SelfServiceConversationHistoryTypeDef definition
class SelfServiceConversationHistoryTypeDef(TypedDict):
turnNumber: int,
botResponse: NotRequired[str],
inputTranscript: NotRequired[str],ConversationStateTypeDef#
# ConversationStateTypeDef definition
class ConversationStateTypeDef(TypedDict):
status: ConversationStatusType, # (2)
reason: NotRequired[ConversationStatusReasonType], # (1)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],CreateMessageTemplateAttachmentRequestRequestTypeDef#
# CreateMessageTemplateAttachmentRequestRequestTypeDef definition
class CreateMessageTemplateAttachmentRequestRequestTypeDef(TypedDict):
body: str,
contentDisposition: ContentDispositionType, # (1)
knowledgeBaseId: str,
messageTemplateId: str,
name: str,
clientToken: NotRequired[str],MessageTemplateAttachmentTypeDef#
# MessageTemplateAttachmentTypeDef definition
class MessageTemplateAttachmentTypeDef(TypedDict):
attachmentId: str,
contentDisposition: ContentDispositionType, # (1)
name: str,
uploadedTime: datetime,
url: str,
urlExpiry: datetime,GroupingConfigurationTypeDef#
# GroupingConfigurationTypeDef definition
class GroupingConfigurationTypeDef(TypedDict):
criteria: NotRequired[str],
values: NotRequired[Sequence[str]],CreateMessageTemplateVersionRequestRequestTypeDef#
# CreateMessageTemplateVersionRequestRequestTypeDef definition
class CreateMessageTemplateVersionRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
messageTemplateId: str,
messageTemplateContentSha256: NotRequired[str],QuickResponseDataProviderTypeDef#
# QuickResponseDataProviderTypeDef definition
class QuickResponseDataProviderTypeDef(TypedDict):
content: NotRequired[str],CustomerProfileAttributesOutputTypeDef#
# CustomerProfileAttributesOutputTypeDef definition
class CustomerProfileAttributesOutputTypeDef(TypedDict):
accountNumber: NotRequired[str],
additionalInformation: NotRequired[str],
address1: NotRequired[str],
address2: NotRequired[str],
address3: NotRequired[str],
address4: NotRequired[str],
billingAddress1: NotRequired[str],
billingAddress2: NotRequired[str],
billingAddress3: NotRequired[str],
billingAddress4: NotRequired[str],
billingCity: NotRequired[str],
billingCountry: NotRequired[str],
billingCounty: NotRequired[str],
billingPostalCode: NotRequired[str],
billingProvince: NotRequired[str],
billingState: NotRequired[str],
birthDate: NotRequired[str],
businessEmailAddress: NotRequired[str],
businessName: NotRequired[str],
businessPhoneNumber: NotRequired[str],
city: NotRequired[str],
country: NotRequired[str],
county: NotRequired[str],
custom: NotRequired[dict[str, str]],
emailAddress: NotRequired[str],
firstName: NotRequired[str],
gender: NotRequired[str],
homePhoneNumber: NotRequired[str],
lastName: NotRequired[str],
mailingAddress1: NotRequired[str],
mailingAddress2: NotRequired[str],
mailingAddress3: NotRequired[str],
mailingAddress4: NotRequired[str],
mailingCity: NotRequired[str],
mailingCountry: NotRequired[str],
mailingCounty: NotRequired[str],
mailingPostalCode: NotRequired[str],
mailingProvince: NotRequired[str],
mailingState: NotRequired[str],
middleName: NotRequired[str],
mobilePhoneNumber: NotRequired[str],
partyType: NotRequired[str],
phoneNumber: NotRequired[str],
postalCode: NotRequired[str],
profileARN: NotRequired[str],
profileId: NotRequired[str],
province: NotRequired[str],
shippingAddress1: NotRequired[str],
shippingAddress2: NotRequired[str],
shippingAddress3: NotRequired[str],
shippingAddress4: NotRequired[str],
shippingCity: NotRequired[str],
shippingCountry: NotRequired[str],
shippingCounty: NotRequired[str],
shippingPostalCode: NotRequired[str],
shippingProvince: NotRequired[str],
shippingState: NotRequired[str],
state: NotRequired[str],CustomerProfileAttributesTypeDef#
# CustomerProfileAttributesTypeDef definition
class CustomerProfileAttributesTypeDef(TypedDict):
accountNumber: NotRequired[str],
additionalInformation: NotRequired[str],
address1: NotRequired[str],
address2: NotRequired[str],
address3: NotRequired[str],
address4: NotRequired[str],
billingAddress1: NotRequired[str],
billingAddress2: NotRequired[str],
billingAddress3: NotRequired[str],
billingAddress4: NotRequired[str],
billingCity: NotRequired[str],
billingCountry: NotRequired[str],
billingCounty: NotRequired[str],
billingPostalCode: NotRequired[str],
billingProvince: NotRequired[str],
billingState: NotRequired[str],
birthDate: NotRequired[str],
businessEmailAddress: NotRequired[str],
businessName: NotRequired[str],
businessPhoneNumber: NotRequired[str],
city: NotRequired[str],
country: NotRequired[str],
county: NotRequired[str],
custom: NotRequired[Mapping[str, str]],
emailAddress: NotRequired[str],
firstName: NotRequired[str],
gender: NotRequired[str],
homePhoneNumber: NotRequired[str],
lastName: NotRequired[str],
mailingAddress1: NotRequired[str],
mailingAddress2: NotRequired[str],
mailingAddress3: NotRequired[str],
mailingAddress4: NotRequired[str],
mailingCity: NotRequired[str],
mailingCountry: NotRequired[str],
mailingCounty: NotRequired[str],
mailingPostalCode: NotRequired[str],
mailingProvince: NotRequired[str],
mailingState: NotRequired[str],
middleName: NotRequired[str],
mobilePhoneNumber: NotRequired[str],
partyType: NotRequired[str],
phoneNumber: NotRequired[str],
postalCode: NotRequired[str],
profileARN: NotRequired[str],
profileId: NotRequired[str],
province: NotRequired[str],
shippingAddress1: NotRequired[str],
shippingAddress2: NotRequired[str],
shippingAddress3: NotRequired[str],
shippingAddress4: NotRequired[str],
shippingCity: NotRequired[str],
shippingCountry: NotRequired[str],
shippingCounty: NotRequired[str],
shippingPostalCode: NotRequired[str],
shippingProvince: NotRequired[str],
shippingState: NotRequired[str],
state: NotRequired[str],IntentDetectedDataDetailsTypeDef#
# IntentDetectedDataDetailsTypeDef definition
class IntentDetectedDataDetailsTypeDef(TypedDict):
intent: str,
intentId: str,GenerativeReferenceTypeDef#
# GenerativeReferenceTypeDef definition
class GenerativeReferenceTypeDef(TypedDict):
generationId: NotRequired[str],
modelId: NotRequired[str],DeactivateMessageTemplateRequestRequestTypeDef#
# DeactivateMessageTemplateRequestRequestTypeDef definition
class DeactivateMessageTemplateRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
messageTemplateId: str,
versionNumber: int,DeleteAIAgentRequestRequestTypeDef#
# DeleteAIAgentRequestRequestTypeDef definition
class DeleteAIAgentRequestRequestTypeDef(TypedDict):
aiAgentId: str,
assistantId: str,DeleteAIAgentVersionRequestRequestTypeDef#
# DeleteAIAgentVersionRequestRequestTypeDef definition
class DeleteAIAgentVersionRequestRequestTypeDef(TypedDict):
aiAgentId: str,
assistantId: str,
versionNumber: int,DeleteAIGuardrailRequestRequestTypeDef#
# DeleteAIGuardrailRequestRequestTypeDef definition
class DeleteAIGuardrailRequestRequestTypeDef(TypedDict):
aiGuardrailId: str,
assistantId: str,DeleteAIGuardrailVersionRequestRequestTypeDef#
# DeleteAIGuardrailVersionRequestRequestTypeDef definition
class DeleteAIGuardrailVersionRequestRequestTypeDef(TypedDict):
aiGuardrailId: str,
assistantId: str,
versionNumber: int,DeleteAIPromptRequestRequestTypeDef#
# DeleteAIPromptRequestRequestTypeDef definition
class DeleteAIPromptRequestRequestTypeDef(TypedDict):
aiPromptId: str,
assistantId: str,DeleteAIPromptVersionRequestRequestTypeDef#
# DeleteAIPromptVersionRequestRequestTypeDef definition
class DeleteAIPromptVersionRequestRequestTypeDef(TypedDict):
aiPromptId: str,
assistantId: str,
versionNumber: int,DeleteAssistantAssociationRequestRequestTypeDef#
# DeleteAssistantAssociationRequestRequestTypeDef definition
class DeleteAssistantAssociationRequestRequestTypeDef(TypedDict):
assistantAssociationId: str,
assistantId: str,DeleteAssistantRequestRequestTypeDef#
# DeleteAssistantRequestRequestTypeDef definition
class DeleteAssistantRequestRequestTypeDef(TypedDict):
assistantId: str,DeleteContentAssociationRequestRequestTypeDef#
# DeleteContentAssociationRequestRequestTypeDef definition
class DeleteContentAssociationRequestRequestTypeDef(TypedDict):
contentAssociationId: str,
contentId: str,
knowledgeBaseId: 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,DeleteMessageTemplateAttachmentRequestRequestTypeDef#
# DeleteMessageTemplateAttachmentRequestRequestTypeDef definition
class DeleteMessageTemplateAttachmentRequestRequestTypeDef(TypedDict):
attachmentId: str,
knowledgeBaseId: str,
messageTemplateId: str,DeleteMessageTemplateRequestRequestTypeDef#
# DeleteMessageTemplateRequestRequestTypeDef definition
class DeleteMessageTemplateRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
messageTemplateId: str,DeleteQuickResponseRequestRequestTypeDef#
# DeleteQuickResponseRequestRequestTypeDef definition
class DeleteQuickResponseRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
quickResponseId: str,HighlightTypeDef#
# HighlightTypeDef definition
class HighlightTypeDef(TypedDict):
beginOffsetInclusive: NotRequired[int],
endOffsetExclusive: NotRequired[int],EmailHeaderTypeDef#
# EmailHeaderTypeDef definition
class EmailHeaderTypeDef(TypedDict):
name: NotRequired[str],
value: NotRequired[str],MessageTemplateBodyContentProviderTypeDef#
# MessageTemplateBodyContentProviderTypeDef definition
class MessageTemplateBodyContentProviderTypeDef(TypedDict):
content: NotRequired[str],GroupingConfigurationOutputTypeDef#
# GroupingConfigurationOutputTypeDef definition
class GroupingConfigurationOutputTypeDef(TypedDict):
criteria: NotRequired[str],
values: NotRequired[list[str]],FilterTypeDef#
# FilterTypeDef definition
class FilterTypeDef(TypedDict):
field: FilterFieldType, # (1)
operator: FilterOperatorType, # (2)
value: str,- See FilterFieldType
- See FilterOperatorType
GetAIAgentRequestRequestTypeDef#
# GetAIAgentRequestRequestTypeDef definition
class GetAIAgentRequestRequestTypeDef(TypedDict):
aiAgentId: str,
assistantId: str,GetAIGuardrailRequestRequestTypeDef#
# GetAIGuardrailRequestRequestTypeDef definition
class GetAIGuardrailRequestRequestTypeDef(TypedDict):
aiGuardrailId: str,
assistantId: str,GetAIPromptRequestRequestTypeDef#
# GetAIPromptRequestRequestTypeDef definition
class GetAIPromptRequestRequestTypeDef(TypedDict):
aiPromptId: str,
assistantId: str,GetAssistantAssociationRequestRequestTypeDef#
# GetAssistantAssociationRequestRequestTypeDef definition
class GetAssistantAssociationRequestRequestTypeDef(TypedDict):
assistantAssociationId: str,
assistantId: str,GetAssistantRequestRequestTypeDef#
# GetAssistantRequestRequestTypeDef definition
class GetAssistantRequestRequestTypeDef(TypedDict):
assistantId: str,GetContentAssociationRequestRequestTypeDef#
# GetContentAssociationRequestRequestTypeDef definition
class GetContentAssociationRequestRequestTypeDef(TypedDict):
contentAssociationId: str,
contentId: str,
knowledgeBaseId: 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,GetMessageTemplateRequestRequestTypeDef#
# GetMessageTemplateRequestRequestTypeDef definition
class GetMessageTemplateRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
messageTemplateId: str,GetNextMessageRequestRequestTypeDef#
# GetNextMessageRequestRequestTypeDef definition
class GetNextMessageRequestRequestTypeDef(TypedDict):
assistantId: str,
nextMessageToken: str,
sessionId: 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,GuardrailTopicConfigTypeDef#
# GuardrailTopicConfigTypeDef definition
class GuardrailTopicConfigTypeDef(TypedDict):
definition: str,
name: str,
type: GuardrailTopicTypeType, # (1)
examples: NotRequired[Sequence[str]],HierarchicalChunkingLevelConfigurationTypeDef#
# HierarchicalChunkingLevelConfigurationTypeDef definition
class HierarchicalChunkingLevelConfigurationTypeDef(TypedDict):
maxTokens: int,IntentInputDataTypeDef#
# IntentInputDataTypeDef definition
class IntentInputDataTypeDef(TypedDict):
intentId: str,PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],ListAIAgentVersionsRequestRequestTypeDef#
# ListAIAgentVersionsRequestRequestTypeDef definition
class ListAIAgentVersionsRequestRequestTypeDef(TypedDict):
aiAgentId: str,
assistantId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
origin: NotRequired[OriginType], # (1)- See OriginType
ListAIAgentsRequestRequestTypeDef#
# ListAIAgentsRequestRequestTypeDef definition
class ListAIAgentsRequestRequestTypeDef(TypedDict):
assistantId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
origin: NotRequired[OriginType], # (1)- See OriginType
ListAIGuardrailVersionsRequestRequestTypeDef#
# ListAIGuardrailVersionsRequestRequestTypeDef definition
class ListAIGuardrailVersionsRequestRequestTypeDef(TypedDict):
aiGuardrailId: str,
assistantId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListAIGuardrailsRequestRequestTypeDef#
# ListAIGuardrailsRequestRequestTypeDef definition
class ListAIGuardrailsRequestRequestTypeDef(TypedDict):
assistantId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListAIPromptVersionsRequestRequestTypeDef#
# ListAIPromptVersionsRequestRequestTypeDef definition
class ListAIPromptVersionsRequestRequestTypeDef(TypedDict):
aiPromptId: str,
assistantId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
origin: NotRequired[OriginType], # (1)- See OriginType
ListAIPromptsRequestRequestTypeDef#
# ListAIPromptsRequestRequestTypeDef definition
class ListAIPromptsRequestRequestTypeDef(TypedDict):
assistantId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
origin: NotRequired[OriginType], # (1)- See OriginType
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],ListContentAssociationsRequestRequestTypeDef#
# ListContentAssociationsRequestRequestTypeDef definition
class ListContentAssociationsRequestRequestTypeDef(TypedDict):
contentId: str,
knowledgeBaseId: str,
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],ListMessageTemplateVersionsRequestRequestTypeDef#
# ListMessageTemplateVersionsRequestRequestTypeDef definition
class ListMessageTemplateVersionsRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
messageTemplateId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],MessageTemplateVersionSummaryTypeDef#
# MessageTemplateVersionSummaryTypeDef definition
class MessageTemplateVersionSummaryTypeDef(TypedDict):
channelSubtype: ChannelSubtypeType, # (1)
isActive: bool,
knowledgeBaseArn: str,
knowledgeBaseId: str,
messageTemplateArn: str,
messageTemplateId: str,
name: str,
versionNumber: int,ListMessageTemplatesRequestRequestTypeDef#
# ListMessageTemplatesRequestRequestTypeDef definition
class ListMessageTemplatesRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],MessageTemplateSummaryTypeDef#
# MessageTemplateSummaryTypeDef definition
class MessageTemplateSummaryTypeDef(TypedDict):
channelSubtype: ChannelSubtypeType, # (1)
createdTime: datetime,
knowledgeBaseArn: str,
knowledgeBaseId: str,
lastModifiedBy: str,
lastModifiedTime: datetime,
messageTemplateArn: str,
messageTemplateId: str,
name: str,
activeVersionNumber: NotRequired[int],
description: NotRequired[str],
tags: NotRequired[dict[str, str]],ListMessagesRequestRequestTypeDef#
# ListMessagesRequestRequestTypeDef definition
class ListMessagesRequestRequestTypeDef(TypedDict):
assistantId: str,
sessionId: str,
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,TextMessageTypeDef#
# TextMessageTypeDef definition
class TextMessageTypeDef(TypedDict):
value: NotRequired[str],MessageTemplateFilterFieldTypeDef#
# MessageTemplateFilterFieldTypeDef definition
class MessageTemplateFilterFieldTypeDef(TypedDict):
name: str,
operator: MessageTemplateFilterOperatorType, # (1)
includeNoExistence: NotRequired[bool],
values: NotRequired[Sequence[str]],MessageTemplateOrderFieldTypeDef#
# MessageTemplateOrderFieldTypeDef definition
class MessageTemplateOrderFieldTypeDef(TypedDict):
name: str,
order: NotRequired[OrderType], # (1)- See OrderType
MessageTemplateQueryFieldTypeDef#
# MessageTemplateQueryFieldTypeDef definition
class MessageTemplateQueryFieldTypeDef(TypedDict):
name: str,
operator: MessageTemplateQueryOperatorType, # (1)
values: Sequence[str],
allowFuzziness: NotRequired[bool],
priority: NotRequired[PriorityType], # (2)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,TagConditionTypeDef#
# TagConditionTypeDef definition
class TagConditionTypeDef(TypedDict):
key: str,
value: NotRequired[str],QueryConditionItemTypeDef#
# QueryConditionItemTypeDef definition
class QueryConditionItemTypeDef(TypedDict):
comparator: QueryConditionComparisonOperatorType, # (1)
field: QueryConditionFieldNameType, # (2)
value: str,QueryTextInputDataTypeDef#
# QueryTextInputDataTypeDef definition
class QueryTextInputDataTypeDef(TypedDict):
text: 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)RemoveAssistantAIAgentRequestRequestTypeDef#
# RemoveAssistantAIAgentRequestRequestTypeDef definition
class RemoveAssistantAIAgentRequestRequestTypeDef(TypedDict):
aiAgentType: AIAgentTypeType, # (1)
assistantId: str,- See AIAgentTypeType
RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef#
# RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef definition
class RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,RuntimeSessionDataValueTypeDef#
# RuntimeSessionDataValueTypeDef definition
class RuntimeSessionDataValueTypeDef(TypedDict):
stringValue: NotRequired[str],SessionSummaryTypeDef#
# SessionSummaryTypeDef definition
class SessionSummaryTypeDef(TypedDict):
assistantArn: str,
assistantId: str,
sessionArn: str,
sessionId: str,SeedUrlTypeDef#
# SeedUrlTypeDef definition
class SeedUrlTypeDef(TypedDict):
url: NotRequired[str],SessionIntegrationConfigurationTypeDef#
# SessionIntegrationConfigurationTypeDef definition
class SessionIntegrationConfigurationTypeDef(TypedDict):
topicIntegrationArn: NotRequired[str],StartContentUploadRequestRequestTypeDef#
# StartContentUploadRequestRequestTypeDef definition
class StartContentUploadRequestRequestTypeDef(TypedDict):
contentType: str,
knowledgeBaseId: str,
presignedUrlTimeToLive: NotRequired[int],SystemEndpointAttributesTypeDef#
# SystemEndpointAttributesTypeDef definition
class SystemEndpointAttributesTypeDef(TypedDict):
address: NotRequired[str],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,WebCrawlerLimitsTypeDef#
# WebCrawlerLimitsTypeDef definition
class WebCrawlerLimitsTypeDef(TypedDict):
rateLimit: NotRequired[int],UpdateAssistantAIAgentRequestRequestTypeDef#
# UpdateAssistantAIAgentRequestRequestTypeDef definition
class UpdateAssistantAIAgentRequestRequestTypeDef(TypedDict):
aiAgentType: AIAgentTypeType, # (1)
assistantId: str,
configuration: AIAgentConfigurationDataTypeDef, # (2)AIGuardrailContentPolicyConfigOutputTypeDef#
# AIGuardrailContentPolicyConfigOutputTypeDef definition
class AIGuardrailContentPolicyConfigOutputTypeDef(TypedDict):
filtersConfig: list[GuardrailContentFilterConfigTypeDef], # (1)AIGuardrailContentPolicyConfigTypeDef#
# AIGuardrailContentPolicyConfigTypeDef definition
class AIGuardrailContentPolicyConfigTypeDef(TypedDict):
filtersConfig: Sequence[GuardrailContentFilterConfigTypeDef], # (1)AIGuardrailContextualGroundingPolicyConfigOutputTypeDef#
# AIGuardrailContextualGroundingPolicyConfigOutputTypeDef definition
class AIGuardrailContextualGroundingPolicyConfigOutputTypeDef(TypedDict):
filtersConfig: list[GuardrailContextualGroundingFilterConfigTypeDef], # (1)AIGuardrailContextualGroundingPolicyConfigTypeDef#
# AIGuardrailContextualGroundingPolicyConfigTypeDef definition
class AIGuardrailContextualGroundingPolicyConfigTypeDef(TypedDict):
filtersConfig: Sequence[GuardrailContextualGroundingFilterConfigTypeDef], # (1)AIGuardrailSensitiveInformationPolicyConfigOutputTypeDef#
# AIGuardrailSensitiveInformationPolicyConfigOutputTypeDef definition
class AIGuardrailSensitiveInformationPolicyConfigOutputTypeDef(TypedDict):
piiEntitiesConfig: NotRequired[list[GuardrailPiiEntityConfigTypeDef]], # (1)
regexesConfig: NotRequired[list[GuardrailRegexConfigTypeDef]], # (2)AIGuardrailSensitiveInformationPolicyConfigTypeDef#
# AIGuardrailSensitiveInformationPolicyConfigTypeDef definition
class AIGuardrailSensitiveInformationPolicyConfigTypeDef(TypedDict):
piiEntitiesConfig: NotRequired[Sequence[GuardrailPiiEntityConfigTypeDef]], # (1)
regexesConfig: NotRequired[Sequence[GuardrailRegexConfigTypeDef]], # (2)AIGuardrailVersionSummaryTypeDef#
# AIGuardrailVersionSummaryTypeDef definition
class AIGuardrailVersionSummaryTypeDef(TypedDict):
aiGuardrailSummary: NotRequired[AIGuardrailSummaryTypeDef], # (1)
versionNumber: NotRequired[int],AIGuardrailTopicPolicyConfigOutputTypeDef#
# AIGuardrailTopicPolicyConfigOutputTypeDef definition
class AIGuardrailTopicPolicyConfigOutputTypeDef(TypedDict):
topicsConfig: list[GuardrailTopicConfigOutputTypeDef], # (1)AIGuardrailWordPolicyConfigOutputTypeDef#
# AIGuardrailWordPolicyConfigOutputTypeDef definition
class AIGuardrailWordPolicyConfigOutputTypeDef(TypedDict):
managedWordListsConfig: NotRequired[list[GuardrailManagedWordsConfigTypeDef]], # (1)
wordsConfig: NotRequired[list[GuardrailWordConfigTypeDef]], # (2)AIGuardrailWordPolicyConfigTypeDef#
# AIGuardrailWordPolicyConfigTypeDef definition
class AIGuardrailWordPolicyConfigTypeDef(TypedDict):
managedWordListsConfig: NotRequired[Sequence[GuardrailManagedWordsConfigTypeDef]], # (1)
wordsConfig: NotRequired[Sequence[GuardrailWordConfigTypeDef]], # (2)AIPromptVersionSummaryTypeDef#
# AIPromptVersionSummaryTypeDef definition
class AIPromptVersionSummaryTypeDef(TypedDict):
aiPromptSummary: NotRequired[AIPromptSummaryTypeDef], # (1)
versionNumber: NotRequired[int],AIPromptTemplateConfigurationTypeDef#
# AIPromptTemplateConfigurationTypeDef definition
class AIPromptTemplateConfigurationTypeDef(TypedDict):
textFullAIPromptEditTemplateConfiguration: NotRequired[TextFullAIPromptEditTemplateConfigurationTypeDef], # (1)ActivateMessageTemplateResponseTypeDef#
# ActivateMessageTemplateResponseTypeDef definition
class ActivateMessageTemplateResponseTypeDef(TypedDict):
messageTemplateArn: str,
messageTemplateId: str,
versionNumber: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DeactivateMessageTemplateResponseTypeDef#
# DeactivateMessageTemplateResponseTypeDef definition
class DeactivateMessageTemplateResponseTypeDef(TypedDict):
messageTemplateArn: str,
messageTemplateId: str,
versionNumber: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListAIGuardrailsResponseTypeDef#
# ListAIGuardrailsResponseTypeDef definition
class ListAIGuardrailsResponseTypeDef(TypedDict):
aiGuardrailSummaries: list[AIGuardrailSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListAIPromptsResponseTypeDef#
# ListAIPromptsResponseTypeDef definition
class ListAIPromptsResponseTypeDef(TypedDict):
aiPromptSummaries: list[AIPromptSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)SendMessageResponseTypeDef#
# SendMessageResponseTypeDef definition
class SendMessageResponseTypeDef(TypedDict):
nextMessageToken: str,
requestMessageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartContentUploadResponseTypeDef#
# StartContentUploadResponseTypeDef definition
class StartContentUploadResponseTypeDef(TypedDict):
headersToInclude: dict[str, str],
uploadId: str,
url: str,
urlExpiry: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ContentAssociationContentsTypeDef#
# ContentAssociationContentsTypeDef definition
class ContentAssociationContentsTypeDef(TypedDict):
amazonConnectGuideAssociation: NotRequired[AmazonConnectGuideAssociationDataTypeDef], # (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, # (5)
type: AssistantTypeType, # (6)
aiAgentConfiguration: NotRequired[dict[AIAgentTypeType, AIAgentConfigurationDataTypeDef]], # (1)
capabilityConfiguration: NotRequired[AssistantCapabilityConfigurationTypeDef], # (2)
description: NotRequired[str],
integrationConfiguration: NotRequired[AssistantIntegrationConfigurationTypeDef], # (3)
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (4)
tags: NotRequired[dict[str, str]],- See AIAgentTypeType AIAgentConfigurationDataTypeDef
- See AssistantCapabilityConfigurationTypeDef
- See AssistantIntegrationConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See AssistantStatusType
- See AssistantTypeType
AssistantSummaryTypeDef#
# AssistantSummaryTypeDef definition
class AssistantSummaryTypeDef(TypedDict):
assistantArn: str,
assistantId: str,
name: str,
status: AssistantStatusType, # (5)
type: AssistantTypeType, # (6)
aiAgentConfiguration: NotRequired[dict[AIAgentTypeType, AIAgentConfigurationDataTypeDef]], # (1)
capabilityConfiguration: NotRequired[AssistantCapabilityConfigurationTypeDef], # (2)
description: NotRequired[str],
integrationConfiguration: NotRequired[AssistantIntegrationConfigurationTypeDef], # (3)
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (4)
tags: NotRequired[dict[str, str]],- See AIAgentTypeType AIAgentConfigurationDataTypeDef
- See AssistantCapabilityConfigurationTypeDef
- 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]],BedrockFoundationModelConfigurationForParsingTypeDef#
# BedrockFoundationModelConfigurationForParsingTypeDef definition
class BedrockFoundationModelConfigurationForParsingTypeDef(TypedDict):
modelArn: str,
parsingPrompt: NotRequired[ParsingPromptTypeDef], # (1)ConfigurationTypeDef#
# ConfigurationTypeDef definition
class ConfigurationTypeDef(TypedDict):
connectConfiguration: NotRequired[ConnectConfigurationTypeDef], # (1)GenerativeDataDetailsPaginatorTypeDef#
# GenerativeDataDetailsPaginatorTypeDef definition
class GenerativeDataDetailsPaginatorTypeDef(TypedDict):
completion: str,
rankingData: RankingDataTypeDef, # (1)
references: list[dict[str, Any]],GenerativeDataDetailsTypeDef#
# GenerativeDataDetailsTypeDef definition
class GenerativeDataDetailsTypeDef(TypedDict):
completion: str,
rankingData: RankingDataTypeDef, # (1)
references: list[dict[str, Any]],CreateContentResponseTypeDef#
# CreateContentResponseTypeDef definition
class CreateContentResponseTypeDef(TypedDict):
content: ContentDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetContentResponseTypeDef#
# GetContentResponseTypeDef definition
class GetContentResponseTypeDef(TypedDict):
content: ContentDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateContentResponseTypeDef#
# UpdateContentResponseTypeDef definition
class UpdateContentResponseTypeDef(TypedDict):
content: ContentDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ContentFeedbackDataTypeDef#
# ContentFeedbackDataTypeDef definition
class ContentFeedbackDataTypeDef(TypedDict):
generativeContentFeedbackData: NotRequired[GenerativeContentFeedbackDataTypeDef], # (1)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],SearchContentResponseTypeDef#
# SearchContentResponseTypeDef definition
class SearchContentResponseTypeDef(TypedDict):
contentSummaries: list[ContentSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ConversationContextTypeDef#
# ConversationContextTypeDef definition
class ConversationContextTypeDef(TypedDict):
selfServiceConversationHistory: Sequence[SelfServiceConversationHistoryTypeDef], # (1)CreateAIAgentVersionRequestRequestTypeDef#
# CreateAIAgentVersionRequestRequestTypeDef definition
class CreateAIAgentVersionRequestRequestTypeDef(TypedDict):
aiAgentId: str,
assistantId: str,
clientToken: NotRequired[str],
modifiedTime: NotRequired[TimestampTypeDef],CreateAIGuardrailVersionRequestRequestTypeDef#
# CreateAIGuardrailVersionRequestRequestTypeDef definition
class CreateAIGuardrailVersionRequestRequestTypeDef(TypedDict):
aiGuardrailId: str,
assistantId: str,
clientToken: NotRequired[str],
modifiedTime: NotRequired[TimestampTypeDef],CreateAIPromptVersionRequestRequestTypeDef#
# CreateAIPromptVersionRequestRequestTypeDef definition
class CreateAIPromptVersionRequestRequestTypeDef(TypedDict):
aiPromptId: str,
assistantId: str,
clientToken: NotRequired[str],
modifiedTime: NotRequired[TimestampTypeDef],CreateMessageTemplateAttachmentResponseTypeDef#
# CreateMessageTemplateAttachmentResponseTypeDef definition
class CreateMessageTemplateAttachmentResponseTypeDef(TypedDict):
attachment: MessageTemplateAttachmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateMessageTemplateMetadataRequestRequestTypeDef#
# UpdateMessageTemplateMetadataRequestRequestTypeDef definition
class UpdateMessageTemplateMetadataRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
messageTemplateId: str,
description: NotRequired[str],
groupingConfiguration: NotRequired[GroupingConfigurationTypeDef], # (1)
name: NotRequired[str],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],DataReferenceTypeDef#
# DataReferenceTypeDef definition
class DataReferenceTypeDef(TypedDict):
contentReference: NotRequired[ContentReferenceTypeDef], # (1)
generativeReference: NotRequired[GenerativeReferenceTypeDef], # (2)DocumentTextTypeDef#
# DocumentTextTypeDef definition
class DocumentTextTypeDef(TypedDict):
highlights: NotRequired[list[HighlightTypeDef]], # (1)
text: NotRequired[str],- See HighlightTypeDef
EmailMessageTemplateContentBodyTypeDef#
# EmailMessageTemplateContentBodyTypeDef definition
class EmailMessageTemplateContentBodyTypeDef(TypedDict):
html: NotRequired[MessageTemplateBodyContentProviderTypeDef], # (1)
plainText: NotRequired[MessageTemplateBodyContentProviderTypeDef], # (1)SMSMessageTemplateContentBodyTypeDef#
# SMSMessageTemplateContentBodyTypeDef definition
class SMSMessageTemplateContentBodyTypeDef(TypedDict):
plainText: NotRequired[MessageTemplateBodyContentProviderTypeDef], # (1)MessageTemplateSearchResultDataTypeDef#
# MessageTemplateSearchResultDataTypeDef definition
class MessageTemplateSearchResultDataTypeDef(TypedDict):
channelSubtype: ChannelSubtypeType, # (1)
createdTime: datetime,
knowledgeBaseArn: str,
knowledgeBaseId: str,
lastModifiedBy: str,
lastModifiedTime: datetime,
messageTemplateArn: str,
messageTemplateId: str,
name: str,
description: NotRequired[str],
groupingConfiguration: NotRequired[GroupingConfigurationOutputTypeDef], # (2)
isActive: NotRequired[bool],
language: NotRequired[str],
tags: NotRequired[dict[str, str]],
versionNumber: NotRequired[int],SearchExpressionTypeDef#
# SearchExpressionTypeDef definition
class SearchExpressionTypeDef(TypedDict):
filters: Sequence[FilterTypeDef], # (1)- See FilterTypeDef
HierarchicalChunkingConfigurationOutputTypeDef#
# HierarchicalChunkingConfigurationOutputTypeDef definition
class HierarchicalChunkingConfigurationOutputTypeDef(TypedDict):
levelConfigurations: list[HierarchicalChunkingLevelConfigurationTypeDef], # (1)
overlapTokens: int,HierarchicalChunkingConfigurationTypeDef#
# HierarchicalChunkingConfigurationTypeDef definition
class HierarchicalChunkingConfigurationTypeDef(TypedDict):
levelConfigurations: Sequence[HierarchicalChunkingLevelConfigurationTypeDef], # (1)
overlapTokens: int,ListAIAgentVersionsRequestPaginateTypeDef#
# ListAIAgentVersionsRequestPaginateTypeDef definition
class ListAIAgentVersionsRequestPaginateTypeDef(TypedDict):
aiAgentId: str,
assistantId: str,
origin: NotRequired[OriginType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)- See OriginType
- See PaginatorConfigTypeDef
ListAIAgentsRequestPaginateTypeDef#
# ListAIAgentsRequestPaginateTypeDef definition
class ListAIAgentsRequestPaginateTypeDef(TypedDict):
assistantId: str,
origin: NotRequired[OriginType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)- See OriginType
- See PaginatorConfigTypeDef
ListAIGuardrailVersionsRequestPaginateTypeDef#
# ListAIGuardrailVersionsRequestPaginateTypeDef definition
class ListAIGuardrailVersionsRequestPaginateTypeDef(TypedDict):
aiGuardrailId: str,
assistantId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListAIGuardrailsRequestPaginateTypeDef#
# ListAIGuardrailsRequestPaginateTypeDef definition
class ListAIGuardrailsRequestPaginateTypeDef(TypedDict):
assistantId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListAIPromptVersionsRequestPaginateTypeDef#
# ListAIPromptVersionsRequestPaginateTypeDef definition
class ListAIPromptVersionsRequestPaginateTypeDef(TypedDict):
aiPromptId: str,
assistantId: str,
origin: NotRequired[OriginType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)- See OriginType
- See PaginatorConfigTypeDef
ListAIPromptsRequestPaginateTypeDef#
# ListAIPromptsRequestPaginateTypeDef definition
class ListAIPromptsRequestPaginateTypeDef(TypedDict):
assistantId: str,
origin: NotRequired[OriginType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)- See OriginType
- See PaginatorConfigTypeDef
ListAssistantAssociationsRequestPaginateTypeDef#
# ListAssistantAssociationsRequestPaginateTypeDef definition
class ListAssistantAssociationsRequestPaginateTypeDef(TypedDict):
assistantId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListAssistantsRequestPaginateTypeDef#
# ListAssistantsRequestPaginateTypeDef definition
class ListAssistantsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListContentAssociationsRequestPaginateTypeDef#
# ListContentAssociationsRequestPaginateTypeDef definition
class ListContentAssociationsRequestPaginateTypeDef(TypedDict):
contentId: str,
knowledgeBaseId: str,
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)ListMessageTemplateVersionsRequestPaginateTypeDef#
# ListMessageTemplateVersionsRequestPaginateTypeDef definition
class ListMessageTemplateVersionsRequestPaginateTypeDef(TypedDict):
knowledgeBaseId: str,
messageTemplateId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListMessageTemplatesRequestPaginateTypeDef#
# ListMessageTemplatesRequestPaginateTypeDef definition
class ListMessageTemplatesRequestPaginateTypeDef(TypedDict):
knowledgeBaseId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListMessagesRequestPaginateTypeDef#
# ListMessagesRequestPaginateTypeDef definition
class ListMessagesRequestPaginateTypeDef(TypedDict):
assistantId: str,
sessionId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListQuickResponsesRequestPaginateTypeDef#
# ListQuickResponsesRequestPaginateTypeDef definition
class ListQuickResponsesRequestPaginateTypeDef(TypedDict):
knowledgeBaseId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListMessageTemplateVersionsResponseTypeDef#
# ListMessageTemplateVersionsResponseTypeDef definition
class ListMessageTemplateVersionsResponseTypeDef(TypedDict):
messageTemplateVersionSummaries: list[MessageTemplateVersionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListMessageTemplatesResponseTypeDef#
# ListMessageTemplatesResponseTypeDef definition
class ListMessageTemplatesResponseTypeDef(TypedDict):
messageTemplateSummaries: list[MessageTemplateSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListQuickResponsesResponseTypeDef#
# ListQuickResponsesResponseTypeDef definition
class ListQuickResponsesResponseTypeDef(TypedDict):
quickResponseSummaries: list[QuickResponseSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],MessageDataTypeDef#
# MessageDataTypeDef definition
class MessageDataTypeDef(TypedDict):
text: NotRequired[TextMessageTypeDef], # (1)MessageTemplateSearchExpressionTypeDef#
# MessageTemplateSearchExpressionTypeDef definition
class MessageTemplateSearchExpressionTypeDef(TypedDict):
filters: NotRequired[Sequence[MessageTemplateFilterFieldTypeDef]], # (1)
orderOnField: NotRequired[MessageTemplateOrderFieldTypeDef], # (2)
queries: NotRequired[Sequence[MessageTemplateQueryFieldTypeDef]], # (3)- See MessageTemplateFilterFieldTypeDef
- See MessageTemplateOrderFieldTypeDef
- See MessageTemplateQueryFieldTypeDef
NotifyRecommendationsReceivedResponseTypeDef#
# NotifyRecommendationsReceivedResponseTypeDef definition
class NotifyRecommendationsReceivedResponseTypeDef(TypedDict):
errors: list[NotifyRecommendationsReceivedErrorTypeDef], # (1)
recommendationIds: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)OrConditionOutputTypeDef#
# OrConditionOutputTypeDef definition
class OrConditionOutputTypeDef(TypedDict):
andConditions: NotRequired[list[TagConditionTypeDef]], # (1)
tagCondition: NotRequired[TagConditionTypeDef], # (2)OrConditionTypeDef#
# OrConditionTypeDef definition
class OrConditionTypeDef(TypedDict):
andConditions: NotRequired[Sequence[TagConditionTypeDef]], # (1)
tagCondition: NotRequired[TagConditionTypeDef], # (2)QueryConditionTypeDef#
# QueryConditionTypeDef definition
class QueryConditionTypeDef(TypedDict):
single: NotRequired[QueryConditionItemTypeDef], # (1)QueryInputDataTypeDef#
# QueryInputDataTypeDef definition
class QueryInputDataTypeDef(TypedDict):
intentInputData: NotRequired[IntentInputDataTypeDef], # (1)
queryTextInputData: NotRequired[QueryTextInputDataTypeDef], # (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
RuntimeSessionDataTypeDef#
# RuntimeSessionDataTypeDef definition
class RuntimeSessionDataTypeDef(TypedDict):
key: str,
value: RuntimeSessionDataValueTypeDef, # (1)SearchSessionsResponseTypeDef#
# SearchSessionsResponseTypeDef definition
class SearchSessionsResponseTypeDef(TypedDict):
sessionSummaries: list[SessionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],UrlConfigurationOutputTypeDef#
# UrlConfigurationOutputTypeDef definition
class UrlConfigurationOutputTypeDef(TypedDict):
seedUrls: NotRequired[list[SeedUrlTypeDef]], # (1)- See SeedUrlTypeDef
UrlConfigurationTypeDef#
# UrlConfigurationTypeDef definition
class UrlConfigurationTypeDef(TypedDict):
seedUrls: NotRequired[Sequence[SeedUrlTypeDef]], # (1)- See SeedUrlTypeDef
SystemAttributesTypeDef#
# SystemAttributesTypeDef definition
class SystemAttributesTypeDef(TypedDict):
customerEndpoint: NotRequired[SystemEndpointAttributesTypeDef], # (1)
name: NotRequired[str],
systemEndpoint: NotRequired[SystemEndpointAttributesTypeDef], # (1)ListAIGuardrailVersionsResponseTypeDef#
# ListAIGuardrailVersionsResponseTypeDef definition
class ListAIGuardrailVersionsResponseTypeDef(TypedDict):
aiGuardrailVersionSummaries: list[AIGuardrailVersionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],AIGuardrailDataTypeDef#
# AIGuardrailDataTypeDef definition
class AIGuardrailDataTypeDef(TypedDict):
aiGuardrailArn: str,
aiGuardrailId: str,
assistantArn: str,
assistantId: str,
blockedInputMessaging: str,
blockedOutputsMessaging: str,
name: str,
visibilityStatus: VisibilityStatusType, # (6)
contentPolicyConfig: NotRequired[AIGuardrailContentPolicyConfigOutputTypeDef], # (1)
contextualGroundingPolicyConfig: NotRequired[AIGuardrailContextualGroundingPolicyConfigOutputTypeDef], # (2)
description: NotRequired[str],
modifiedTime: NotRequired[datetime],
sensitiveInformationPolicyConfig: NotRequired[AIGuardrailSensitiveInformationPolicyConfigOutputTypeDef], # (3)
status: NotRequired[StatusType], # (4)
tags: NotRequired[dict[str, str]],
topicPolicyConfig: NotRequired[AIGuardrailTopicPolicyConfigOutputTypeDef], # (5)
wordPolicyConfig: NotRequired[AIGuardrailWordPolicyConfigOutputTypeDef], # (7)- See AIGuardrailContentPolicyConfigOutputTypeDef
- See AIGuardrailContextualGroundingPolicyConfigOutputTypeDef
- See AIGuardrailSensitiveInformationPolicyConfigOutputTypeDef
- See StatusType
- See AIGuardrailTopicPolicyConfigOutputTypeDef
- See VisibilityStatusType
- See AIGuardrailWordPolicyConfigOutputTypeDef
ListAIPromptVersionsResponseTypeDef#
# ListAIPromptVersionsResponseTypeDef definition
class ListAIPromptVersionsResponseTypeDef(TypedDict):
aiPromptVersionSummaries: list[AIPromptVersionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],AIPromptDataTypeDef#
# AIPromptDataTypeDef definition
class AIPromptDataTypeDef(TypedDict):
aiPromptArn: str,
aiPromptId: str,
apiFormat: AIPromptAPIFormatType, # (1)
assistantArn: str,
assistantId: str,
modelId: str,
name: str,
templateConfiguration: AIPromptTemplateConfigurationTypeDef, # (4)
templateType: AIPromptTemplateTypeType, # (5)
type: AIPromptTypeType, # (6)
visibilityStatus: VisibilityStatusType, # (7)
description: NotRequired[str],
modifiedTime: NotRequired[datetime],
origin: NotRequired[OriginType], # (2)
status: NotRequired[StatusType], # (3)
tags: NotRequired[dict[str, str]],- See AIPromptAPIFormatType
- See OriginType
- See StatusType
- See AIPromptTemplateConfigurationTypeDef
- See AIPromptTemplateTypeType
- See AIPromptTypeType
- See VisibilityStatusType
CreateAIPromptRequestRequestTypeDef#
# CreateAIPromptRequestRequestTypeDef definition
class CreateAIPromptRequestRequestTypeDef(TypedDict):
apiFormat: AIPromptAPIFormatType, # (1)
assistantId: str,
modelId: str,
name: str,
templateConfiguration: AIPromptTemplateConfigurationTypeDef, # (2)
templateType: AIPromptTemplateTypeType, # (3)
type: AIPromptTypeType, # (4)
visibilityStatus: VisibilityStatusType, # (5)
clientToken: NotRequired[str],
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],- See AIPromptAPIFormatType
- See AIPromptTemplateConfigurationTypeDef
- See AIPromptTemplateTypeType
- See AIPromptTypeType
- See VisibilityStatusType
UpdateAIPromptRequestRequestTypeDef#
# UpdateAIPromptRequestRequestTypeDef definition
class UpdateAIPromptRequestRequestTypeDef(TypedDict):
aiPromptId: str,
assistantId: str,
visibilityStatus: VisibilityStatusType, # (1)
clientToken: NotRequired[str],
description: NotRequired[str],
templateConfiguration: NotRequired[AIPromptTemplateConfigurationTypeDef], # (2)ContentAssociationDataTypeDef#
# ContentAssociationDataTypeDef definition
class ContentAssociationDataTypeDef(TypedDict):
associationData: ContentAssociationContentsTypeDef, # (1)
associationType: ContentAssociationTypeType, # (2)
contentArn: str,
contentAssociationArn: str,
contentAssociationId: str,
contentId: str,
knowledgeBaseArn: str,
knowledgeBaseId: str,
tags: NotRequired[dict[str, str]],ContentAssociationSummaryTypeDef#
# ContentAssociationSummaryTypeDef definition
class ContentAssociationSummaryTypeDef(TypedDict):
associationData: ContentAssociationContentsTypeDef, # (1)
associationType: ContentAssociationTypeType, # (2)
contentArn: str,
contentAssociationArn: str,
contentAssociationId: str,
contentId: str,
knowledgeBaseArn: str,
knowledgeBaseId: str,
tags: NotRequired[dict[str, str]],CreateContentAssociationRequestRequestTypeDef#
# CreateContentAssociationRequestRequestTypeDef definition
class CreateContentAssociationRequestRequestTypeDef(TypedDict):
association: ContentAssociationContentsTypeDef, # (1)
associationType: ContentAssociationTypeType, # (2)
contentId: str,
knowledgeBaseId: str,
clientToken: NotRequired[str],
tags: NotRequired[Mapping[str, str]],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)UpdateAssistantAIAgentResponseTypeDef#
# UpdateAssistantAIAgentResponseTypeDef definition
class UpdateAssistantAIAgentResponseTypeDef(TypedDict):
assistant: AssistantDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListAssistantsResponseTypeDef#
# ListAssistantsResponseTypeDef definition
class ListAssistantsResponseTypeDef(TypedDict):
assistantSummaries: list[AssistantSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ParsingConfigurationTypeDef#
# ParsingConfigurationTypeDef definition
class ParsingConfigurationTypeDef(TypedDict):
parsingStrategy: ParsingStrategyType, # (2)
bedrockFoundationModelConfiguration: NotRequired[BedrockFoundationModelConfigurationForParsingTypeDef], # (1)ExternalSourceConfigurationTypeDef#
# ExternalSourceConfigurationTypeDef definition
class ExternalSourceConfigurationTypeDef(TypedDict):
configuration: ConfigurationTypeDef, # (1)
source: ExternalSourceType, # (2)PutFeedbackRequestRequestTypeDef#
# PutFeedbackRequestRequestTypeDef definition
class PutFeedbackRequestRequestTypeDef(TypedDict):
assistantId: str,
contentFeedback: ContentFeedbackDataTypeDef, # (1)
targetId: str,
targetType: TargetTypeType, # (2)PutFeedbackResponseTypeDef#
# PutFeedbackResponseTypeDef definition
class PutFeedbackResponseTypeDef(TypedDict):
assistantArn: str,
assistantId: str,
contentFeedback: ContentFeedbackDataTypeDef, # (1)
targetId: str,
targetType: TargetTypeType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)DocumentTypeDef#
# DocumentTypeDef definition
class DocumentTypeDef(TypedDict):
contentReference: ContentReferenceTypeDef, # (1)
excerpt: NotRequired[DocumentTextTypeDef], # (2)
title: NotRequired[DocumentTextTypeDef], # (2)TextDataTypeDef#
# TextDataTypeDef definition
class TextDataTypeDef(TypedDict):
excerpt: NotRequired[DocumentTextTypeDef], # (1)
title: NotRequired[DocumentTextTypeDef], # (1)EmailMessageTemplateContentOutputTypeDef#
# EmailMessageTemplateContentOutputTypeDef definition
class EmailMessageTemplateContentOutputTypeDef(TypedDict):
body: NotRequired[EmailMessageTemplateContentBodyTypeDef], # (1)
headers: NotRequired[list[EmailHeaderTypeDef]], # (2)
subject: NotRequired[str],EmailMessageTemplateContentTypeDef#
# EmailMessageTemplateContentTypeDef definition
class EmailMessageTemplateContentTypeDef(TypedDict):
body: NotRequired[EmailMessageTemplateContentBodyTypeDef], # (1)
headers: NotRequired[Sequence[EmailHeaderTypeDef]], # (2)
subject: NotRequired[str],SMSMessageTemplateContentTypeDef#
# SMSMessageTemplateContentTypeDef definition
class SMSMessageTemplateContentTypeDef(TypedDict):
body: NotRequired[SMSMessageTemplateContentBodyTypeDef], # (1)SearchMessageTemplatesResponseTypeDef#
# SearchMessageTemplatesResponseTypeDef definition
class SearchMessageTemplatesResponseTypeDef(TypedDict):
results: list[MessageTemplateSearchResultDataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],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],AIGuardrailTopicPolicyConfigTypeDef#
# AIGuardrailTopicPolicyConfigTypeDef definition
class AIGuardrailTopicPolicyConfigTypeDef(TypedDict):
topicsConfig: Sequence[GuardrailTopicConfigUnionTypeDef], # (1)ChunkingConfigurationOutputTypeDef#
# ChunkingConfigurationOutputTypeDef definition
class ChunkingConfigurationOutputTypeDef(TypedDict):
chunkingStrategy: ChunkingStrategyType, # (1)
fixedSizeChunkingConfiguration: NotRequired[FixedSizeChunkingConfigurationTypeDef], # (2)
hierarchicalChunkingConfiguration: NotRequired[HierarchicalChunkingConfigurationOutputTypeDef], # (3)
semanticChunkingConfiguration: NotRequired[SemanticChunkingConfigurationTypeDef], # (4)- See ChunkingStrategyType
- See FixedSizeChunkingConfigurationTypeDef
- See HierarchicalChunkingConfigurationOutputTypeDef
- See SemanticChunkingConfigurationTypeDef
MessageInputTypeDef#
# MessageInputTypeDef definition
class MessageInputTypeDef(TypedDict):
value: MessageDataTypeDef, # (1)MessageOutputTypeDef#
# MessageOutputTypeDef definition
class MessageOutputTypeDef(TypedDict):
messageId: str,
participant: ParticipantType, # (1)
timestamp: datetime,
value: MessageDataTypeDef, # (2)- See ParticipantType
- See MessageDataTypeDef
SearchMessageTemplatesRequestPaginateTypeDef#
# SearchMessageTemplatesRequestPaginateTypeDef definition
class SearchMessageTemplatesRequestPaginateTypeDef(TypedDict):
knowledgeBaseId: str,
searchExpression: MessageTemplateSearchExpressionTypeDef, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)SearchMessageTemplatesRequestRequestTypeDef#
# SearchMessageTemplatesRequestRequestTypeDef definition
class SearchMessageTemplatesRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
searchExpression: MessageTemplateSearchExpressionTypeDef, # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],TagFilterOutputTypeDef#
# TagFilterOutputTypeDef definition
class TagFilterOutputTypeDef(TypedDict):
andConditions: NotRequired[list[TagConditionTypeDef]], # (1)
orConditions: NotRequired[list[OrConditionOutputTypeDef]], # (2)
tagCondition: NotRequired[TagConditionTypeDef], # (3)QueryAssistantRequestPaginateTypeDef#
# QueryAssistantRequestPaginateTypeDef definition
class QueryAssistantRequestPaginateTypeDef(TypedDict):
assistantId: str,
overrideKnowledgeBaseSearchType: NotRequired[KnowledgeBaseSearchTypeType], # (1)
queryCondition: NotRequired[Sequence[QueryConditionTypeDef]], # (2)
queryInputData: NotRequired[QueryInputDataTypeDef], # (3)
queryText: NotRequired[str],
sessionId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)- See KnowledgeBaseSearchTypeType
- See QueryConditionTypeDef
- See QueryInputDataTypeDef
- See PaginatorConfigTypeDef
QueryAssistantRequestRequestTypeDef#
# QueryAssistantRequestRequestTypeDef definition
class QueryAssistantRequestRequestTypeDef(TypedDict):
assistantId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
overrideKnowledgeBaseSearchType: NotRequired[KnowledgeBaseSearchTypeType], # (1)
queryCondition: NotRequired[Sequence[QueryConditionTypeDef]], # (2)
queryInputData: NotRequired[QueryInputDataTypeDef], # (3)
queryText: NotRequired[str],
sessionId: 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],UpdateSessionDataRequestRequestTypeDef#
# UpdateSessionDataRequestRequestTypeDef definition
class UpdateSessionDataRequestRequestTypeDef(TypedDict):
assistantId: str,
data: Sequence[RuntimeSessionDataTypeDef], # (1)
sessionId: str,
namespace: NotRequired[SessionDataNamespaceType], # (2)UpdateSessionDataResponseTypeDef#
# UpdateSessionDataResponseTypeDef definition
class UpdateSessionDataResponseTypeDef(TypedDict):
data: list[RuntimeSessionDataTypeDef], # (1)
namespace: SessionDataNamespaceType, # (2)
sessionArn: str,
sessionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)WebCrawlerConfigurationOutputTypeDef#
# WebCrawlerConfigurationOutputTypeDef definition
class WebCrawlerConfigurationOutputTypeDef(TypedDict):
urlConfiguration: UrlConfigurationOutputTypeDef, # (3)
crawlerLimits: NotRequired[WebCrawlerLimitsTypeDef], # (1)
exclusionFilters: NotRequired[list[str]],
inclusionFilters: NotRequired[list[str]],
scope: NotRequired[WebScopeTypeType], # (2)MessageTemplateAttributesOutputTypeDef#
# MessageTemplateAttributesOutputTypeDef definition
class MessageTemplateAttributesOutputTypeDef(TypedDict):
agentAttributes: NotRequired[AgentAttributesTypeDef], # (1)
customAttributes: NotRequired[dict[str, str]],
customerProfileAttributes: NotRequired[CustomerProfileAttributesOutputTypeDef], # (2)
systemAttributes: NotRequired[SystemAttributesTypeDef], # (3)MessageTemplateAttributesTypeDef#
# MessageTemplateAttributesTypeDef definition
class MessageTemplateAttributesTypeDef(TypedDict):
agentAttributes: NotRequired[AgentAttributesTypeDef], # (1)
customAttributes: NotRequired[Mapping[str, str]],
customerProfileAttributes: NotRequired[CustomerProfileAttributesUnionTypeDef], # (2)
systemAttributes: NotRequired[SystemAttributesTypeDef], # (3)- See AgentAttributesTypeDef
- See CustomerProfileAttributesTypeDef CustomerProfileAttributesOutputTypeDef
- See SystemAttributesTypeDef
CreateAIGuardrailResponseTypeDef#
# CreateAIGuardrailResponseTypeDef definition
class CreateAIGuardrailResponseTypeDef(TypedDict):
aiGuardrail: AIGuardrailDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateAIGuardrailVersionResponseTypeDef#
# CreateAIGuardrailVersionResponseTypeDef definition
class CreateAIGuardrailVersionResponseTypeDef(TypedDict):
aiGuardrail: AIGuardrailDataTypeDef, # (1)
versionNumber: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetAIGuardrailResponseTypeDef#
# GetAIGuardrailResponseTypeDef definition
class GetAIGuardrailResponseTypeDef(TypedDict):
aiGuardrail: AIGuardrailDataTypeDef, # (1)
versionNumber: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateAIGuardrailResponseTypeDef#
# UpdateAIGuardrailResponseTypeDef definition
class UpdateAIGuardrailResponseTypeDef(TypedDict):
aiGuardrail: AIGuardrailDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateAIPromptResponseTypeDef#
# CreateAIPromptResponseTypeDef definition
class CreateAIPromptResponseTypeDef(TypedDict):
aiPrompt: AIPromptDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateAIPromptVersionResponseTypeDef#
# CreateAIPromptVersionResponseTypeDef definition
class CreateAIPromptVersionResponseTypeDef(TypedDict):
aiPrompt: AIPromptDataTypeDef, # (1)
versionNumber: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetAIPromptResponseTypeDef#
# GetAIPromptResponseTypeDef definition
class GetAIPromptResponseTypeDef(TypedDict):
aiPrompt: AIPromptDataTypeDef, # (1)
versionNumber: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateAIPromptResponseTypeDef#
# UpdateAIPromptResponseTypeDef definition
class UpdateAIPromptResponseTypeDef(TypedDict):
aiPrompt: AIPromptDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateContentAssociationResponseTypeDef#
# CreateContentAssociationResponseTypeDef definition
class CreateContentAssociationResponseTypeDef(TypedDict):
contentAssociation: ContentAssociationDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetContentAssociationResponseTypeDef#
# GetContentAssociationResponseTypeDef definition
class GetContentAssociationResponseTypeDef(TypedDict):
contentAssociation: ContentAssociationDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListContentAssociationsResponseTypeDef#
# ListContentAssociationsResponseTypeDef definition
class ListContentAssociationsResponseTypeDef(TypedDict):
contentAssociationSummaries: list[ContentAssociationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],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]],ContentDataDetailsTypeDef#
# ContentDataDetailsTypeDef definition
class ContentDataDetailsTypeDef(TypedDict):
rankingData: RankingDataTypeDef, # (1)
textData: TextDataTypeDef, # (2)- See RankingDataTypeDef
- See TextDataTypeDef
SourceContentDataDetailsTypeDef#
# SourceContentDataDetailsTypeDef definition
class SourceContentDataDetailsTypeDef(TypedDict):
id: str,
rankingData: RankingDataTypeDef, # (2)
textData: TextDataTypeDef, # (3)
type: SourceContentTypeType, # (4)
citationSpan: NotRequired[CitationSpanTypeDef], # (1)- See CitationSpanTypeDef
- See RankingDataTypeDef
- See TextDataTypeDef
- See SourceContentTypeType
MessageTemplateContentProviderOutputTypeDef#
# MessageTemplateContentProviderOutputTypeDef definition
class MessageTemplateContentProviderOutputTypeDef(TypedDict):
email: NotRequired[EmailMessageTemplateContentOutputTypeDef], # (1)
sms: NotRequired[SMSMessageTemplateContentTypeDef], # (2)CreateAIGuardrailRequestRequestTypeDef#
# CreateAIGuardrailRequestRequestTypeDef definition
class CreateAIGuardrailRequestRequestTypeDef(TypedDict):
assistantId: str,
blockedInputMessaging: str,
blockedOutputsMessaging: str,
name: str,
visibilityStatus: VisibilityStatusType, # (1)
clientToken: NotRequired[str],
contentPolicyConfig: NotRequired[AIGuardrailContentPolicyConfigTypeDef], # (2)
contextualGroundingPolicyConfig: NotRequired[AIGuardrailContextualGroundingPolicyConfigTypeDef], # (3)
description: NotRequired[str],
sensitiveInformationPolicyConfig: NotRequired[AIGuardrailSensitiveInformationPolicyConfigTypeDef], # (4)
tags: NotRequired[Mapping[str, str]],
topicPolicyConfig: NotRequired[AIGuardrailTopicPolicyConfigTypeDef], # (5)
wordPolicyConfig: NotRequired[AIGuardrailWordPolicyConfigTypeDef], # (6)- See VisibilityStatusType
- See AIGuardrailContentPolicyConfigTypeDef
- See AIGuardrailContextualGroundingPolicyConfigTypeDef
- See AIGuardrailSensitiveInformationPolicyConfigTypeDef
- See AIGuardrailTopicPolicyConfigTypeDef
- See AIGuardrailWordPolicyConfigTypeDef
UpdateAIGuardrailRequestRequestTypeDef#
# UpdateAIGuardrailRequestRequestTypeDef definition
class UpdateAIGuardrailRequestRequestTypeDef(TypedDict):
aiGuardrailId: str,
assistantId: str,
blockedInputMessaging: str,
blockedOutputsMessaging: str,
visibilityStatus: VisibilityStatusType, # (1)
clientToken: NotRequired[str],
contentPolicyConfig: NotRequired[AIGuardrailContentPolicyConfigTypeDef], # (2)
contextualGroundingPolicyConfig: NotRequired[AIGuardrailContextualGroundingPolicyConfigTypeDef], # (3)
description: NotRequired[str],
sensitiveInformationPolicyConfig: NotRequired[AIGuardrailSensitiveInformationPolicyConfigTypeDef], # (4)
topicPolicyConfig: NotRequired[AIGuardrailTopicPolicyConfigTypeDef], # (5)
wordPolicyConfig: NotRequired[AIGuardrailWordPolicyConfigTypeDef], # (6)- See VisibilityStatusType
- See AIGuardrailContentPolicyConfigTypeDef
- See AIGuardrailContextualGroundingPolicyConfigTypeDef
- See AIGuardrailSensitiveInformationPolicyConfigTypeDef
- See AIGuardrailTopicPolicyConfigTypeDef
- See AIGuardrailWordPolicyConfigTypeDef
VectorIngestionConfigurationOutputTypeDef#
# VectorIngestionConfigurationOutputTypeDef definition
class VectorIngestionConfigurationOutputTypeDef(TypedDict):
chunkingConfiguration: NotRequired[ChunkingConfigurationOutputTypeDef], # (1)
parsingConfiguration: NotRequired[ParsingConfigurationTypeDef], # (2)ChunkingConfigurationTypeDef#
# ChunkingConfigurationTypeDef definition
class ChunkingConfigurationTypeDef(TypedDict):
chunkingStrategy: ChunkingStrategyType, # (1)
fixedSizeChunkingConfiguration: NotRequired[FixedSizeChunkingConfigurationTypeDef], # (2)
hierarchicalChunkingConfiguration: NotRequired[HierarchicalChunkingConfigurationUnionTypeDef], # (3)
semanticChunkingConfiguration: NotRequired[SemanticChunkingConfigurationTypeDef], # (4)- See ChunkingStrategyType
- See FixedSizeChunkingConfigurationTypeDef
- See HierarchicalChunkingConfigurationTypeDef HierarchicalChunkingConfigurationOutputTypeDef
- See SemanticChunkingConfigurationTypeDef
SendMessageRequestRequestTypeDef#
# SendMessageRequestRequestTypeDef definition
class SendMessageRequestRequestTypeDef(TypedDict):
assistantId: str,
message: MessageInputTypeDef, # (1)
sessionId: str,
type: MessageTypeType, # (2)
clientToken: NotRequired[str],
conversationContext: NotRequired[ConversationContextTypeDef], # (3)GetNextMessageResponseTypeDef#
# GetNextMessageResponseTypeDef definition
class GetNextMessageResponseTypeDef(TypedDict):
conversationSessionData: list[RuntimeSessionDataTypeDef], # (1)
conversationState: ConversationStateTypeDef, # (2)
nextMessageToken: str,
requestMessageId: str,
response: MessageOutputTypeDef, # (3)
type: MessageTypeType, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See RuntimeSessionDataTypeDef
- See ConversationStateTypeDef
- See MessageOutputTypeDef
- See MessageTypeType
- See ResponseMetadataTypeDef
ListMessagesResponseTypeDef#
# ListMessagesResponseTypeDef definition
class ListMessagesResponseTypeDef(TypedDict):
messages: list[MessageOutputTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],KnowledgeBaseAssociationConfigurationDataOutputTypeDef#
# KnowledgeBaseAssociationConfigurationDataOutputTypeDef definition
class KnowledgeBaseAssociationConfigurationDataOutputTypeDef(TypedDict):
contentTagFilter: NotRequired[TagFilterOutputTypeDef], # (1)
maxResults: NotRequired[int],
overrideKnowledgeBaseSearchType: NotRequired[KnowledgeBaseSearchTypeType], # (2)SessionDataTypeDef#
# SessionDataTypeDef definition
class SessionDataTypeDef(TypedDict):
name: str,
sessionArn: str,
sessionId: str,
aiAgentConfiguration: NotRequired[dict[AIAgentTypeType, AIAgentConfigurationDataTypeDef]], # (1)
description: NotRequired[str],
integrationConfiguration: NotRequired[SessionIntegrationConfigurationTypeDef], # (2)
tagFilter: NotRequired[TagFilterOutputTypeDef], # (3)
tags: NotRequired[dict[str, str]],- See AIAgentTypeType AIAgentConfigurationDataTypeDef
- See SessionIntegrationConfigurationTypeDef
- See TagFilterOutputTypeDef
TagFilterTypeDef#
# TagFilterTypeDef definition
class TagFilterTypeDef(TypedDict):
andConditions: NotRequired[Sequence[TagConditionTypeDef]], # (1)
orConditions: NotRequired[Sequence[OrConditionUnionTypeDef]], # (2)
tagCondition: NotRequired[TagConditionTypeDef], # (3)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],ManagedSourceConfigurationOutputTypeDef#
# ManagedSourceConfigurationOutputTypeDef definition
class ManagedSourceConfigurationOutputTypeDef(TypedDict):
webCrawlerConfiguration: NotRequired[WebCrawlerConfigurationOutputTypeDef], # (1)WebCrawlerConfigurationTypeDef#
# WebCrawlerConfigurationTypeDef definition
class WebCrawlerConfigurationTypeDef(TypedDict):
urlConfiguration: UrlConfigurationUnionTypeDef, # (3)
crawlerLimits: NotRequired[WebCrawlerLimitsTypeDef], # (1)
exclusionFilters: NotRequired[Sequence[str]],
inclusionFilters: NotRequired[Sequence[str]],
scope: NotRequired[WebScopeTypeType], # (2)- See WebCrawlerLimitsTypeDef
- See WebScopeTypeType
- See UrlConfigurationTypeDef UrlConfigurationOutputTypeDef
RenderMessageTemplateRequestRequestTypeDef#
# RenderMessageTemplateRequestRequestTypeDef definition
class RenderMessageTemplateRequestRequestTypeDef(TypedDict):
attributes: MessageTemplateAttributesTypeDef, # (1)
knowledgeBaseId: str,
messageTemplateId: 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],DataDetailsPaginatorTypeDef#
# DataDetailsPaginatorTypeDef definition
class DataDetailsPaginatorTypeDef(TypedDict):
contentData: NotRequired[ContentDataDetailsTypeDef], # (1)
generativeData: NotRequired[GenerativeDataDetailsPaginatorTypeDef], # (2)
intentDetectedData: NotRequired[IntentDetectedDataDetailsTypeDef], # (3)
sourceContentData: NotRequired[SourceContentDataDetailsTypeDef], # (4)- See ContentDataDetailsTypeDef
- See GenerativeDataDetailsPaginatorTypeDef
- See IntentDetectedDataDetailsTypeDef
- See SourceContentDataDetailsTypeDef
DataDetailsTypeDef#
# DataDetailsTypeDef definition
class DataDetailsTypeDef(TypedDict):
contentData: NotRequired[ContentDataDetailsTypeDef], # (1)
generativeData: NotRequired[GenerativeDataDetailsTypeDef], # (2)
intentDetectedData: NotRequired[IntentDetectedDataDetailsTypeDef], # (3)
sourceContentData: NotRequired[SourceContentDataDetailsTypeDef], # (4)- See ContentDataDetailsTypeDef
- See GenerativeDataDetailsTypeDef
- See IntentDetectedDataDetailsTypeDef
- See SourceContentDataDetailsTypeDef
MessageTemplateContentProviderTypeDef#
# MessageTemplateContentProviderTypeDef definition
class MessageTemplateContentProviderTypeDef(TypedDict):
email: NotRequired[EmailMessageTemplateContentUnionTypeDef], # (1)
sms: NotRequired[SMSMessageTemplateContentTypeDef], # (2)- See EmailMessageTemplateContentTypeDef EmailMessageTemplateContentOutputTypeDef
- See SMSMessageTemplateContentTypeDef
ExtendedMessageTemplateDataTypeDef#
# ExtendedMessageTemplateDataTypeDef definition
class ExtendedMessageTemplateDataTypeDef(TypedDict):
channelSubtype: ChannelSubtypeType, # (3)
content: MessageTemplateContentProviderOutputTypeDef, # (4)
createdTime: datetime,
knowledgeBaseArn: str,
knowledgeBaseId: str,
lastModifiedBy: str,
lastModifiedTime: datetime,
messageTemplateArn: str,
messageTemplateContentSha256: str,
messageTemplateId: str,
name: str,
attachments: NotRequired[list[MessageTemplateAttachmentTypeDef]], # (1)
attributeTypes: NotRequired[list[MessageTemplateAttributeTypeType]], # (2)
defaultAttributes: NotRequired[MessageTemplateAttributesOutputTypeDef], # (5)
description: NotRequired[str],
groupingConfiguration: NotRequired[GroupingConfigurationOutputTypeDef], # (6)
isActive: NotRequired[bool],
language: NotRequired[str],
tags: NotRequired[dict[str, str]],
versionNumber: NotRequired[int],- See MessageTemplateAttachmentTypeDef
- See MessageTemplateAttributeTypeType
- See ChannelSubtypeType
- See MessageTemplateContentProviderOutputTypeDef
- See MessageTemplateAttributesOutputTypeDef
- See GroupingConfigurationOutputTypeDef
MessageTemplateDataTypeDef#
# MessageTemplateDataTypeDef definition
class MessageTemplateDataTypeDef(TypedDict):
channelSubtype: ChannelSubtypeType, # (2)
content: MessageTemplateContentProviderOutputTypeDef, # (3)
createdTime: datetime,
knowledgeBaseArn: str,
knowledgeBaseId: str,
lastModifiedBy: str,
lastModifiedTime: datetime,
messageTemplateArn: str,
messageTemplateContentSha256: str,
messageTemplateId: str,
name: str,
attributeTypes: NotRequired[list[MessageTemplateAttributeTypeType]], # (1)
defaultAttributes: NotRequired[MessageTemplateAttributesOutputTypeDef], # (4)
description: NotRequired[str],
groupingConfiguration: NotRequired[GroupingConfigurationOutputTypeDef], # (5)
language: NotRequired[str],
tags: NotRequired[dict[str, str]],- See MessageTemplateAttributeTypeType
- See ChannelSubtypeType
- See MessageTemplateContentProviderOutputTypeDef
- See MessageTemplateAttributesOutputTypeDef
- See GroupingConfigurationOutputTypeDef
RenderMessageTemplateResponseTypeDef#
# RenderMessageTemplateResponseTypeDef definition
class RenderMessageTemplateResponseTypeDef(TypedDict):
attachments: list[MessageTemplateAttachmentTypeDef], # (1)
attributesNotInterpolated: list[str],
content: MessageTemplateContentProviderOutputTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See MessageTemplateAttachmentTypeDef
- See MessageTemplateContentProviderOutputTypeDef
- See ResponseMetadataTypeDef
AssociationConfigurationDataOutputTypeDef#
# AssociationConfigurationDataOutputTypeDef definition
class AssociationConfigurationDataOutputTypeDef(TypedDict):
knowledgeBaseAssociationConfigurationData: NotRequired[KnowledgeBaseAssociationConfigurationDataOutputTypeDef], # (1)CreateSessionResponseTypeDef#
# CreateSessionResponseTypeDef definition
class CreateSessionResponseTypeDef(TypedDict):
session: SessionDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetSessionResponseTypeDef#
# GetSessionResponseTypeDef definition
class GetSessionResponseTypeDef(TypedDict):
session: SessionDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateSessionResponseTypeDef#
# UpdateSessionResponseTypeDef definition
class UpdateSessionResponseTypeDef(TypedDict):
session: SessionDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateSessionRequestRequestTypeDef#
# CreateSessionRequestRequestTypeDef definition
class CreateSessionRequestRequestTypeDef(TypedDict):
assistantId: str,
name: str,
aiAgentConfiguration: NotRequired[Mapping[AIAgentTypeType, AIAgentConfigurationDataTypeDef]], # (1)
clientToken: NotRequired[str],
description: NotRequired[str],
tagFilter: NotRequired[TagFilterTypeDef], # (2)
tags: NotRequired[Mapping[str, str]],UpdateSessionRequestRequestTypeDef#
# UpdateSessionRequestRequestTypeDef definition
class UpdateSessionRequestRequestTypeDef(TypedDict):
assistantId: str,
sessionId: str,
aiAgentConfiguration: NotRequired[Mapping[AIAgentTypeType, AIAgentConfigurationDataTypeDef]], # (1)
description: NotRequired[str],
tagFilter: NotRequired[TagFilterTypeDef], # (2)SourceConfigurationOutputTypeDef#
# SourceConfigurationOutputTypeDef definition
class SourceConfigurationOutputTypeDef(TypedDict):
appIntegrations: NotRequired[AppIntegrationsConfigurationOutputTypeDef], # (1)
managedSourceConfiguration: NotRequired[ManagedSourceConfigurationOutputTypeDef], # (2)DataSummaryPaginatorTypeDef#
# DataSummaryPaginatorTypeDef definition
class DataSummaryPaginatorTypeDef(TypedDict):
details: DataDetailsPaginatorTypeDef, # (1)
reference: DataReferenceTypeDef, # (2)DataSummaryTypeDef#
# DataSummaryTypeDef definition
class DataSummaryTypeDef(TypedDict):
details: DataDetailsTypeDef, # (1)
reference: DataReferenceTypeDef, # (2)CreateMessageTemplateRequestRequestTypeDef#
# CreateMessageTemplateRequestRequestTypeDef definition
class CreateMessageTemplateRequestRequestTypeDef(TypedDict):
channelSubtype: ChannelSubtypeType, # (1)
content: MessageTemplateContentProviderTypeDef, # (2)
knowledgeBaseId: str,
name: str,
clientToken: NotRequired[str],
defaultAttributes: NotRequired[MessageTemplateAttributesTypeDef], # (3)
description: NotRequired[str],
groupingConfiguration: NotRequired[GroupingConfigurationTypeDef], # (4)
language: NotRequired[str],
tags: NotRequired[Mapping[str, str]],- See ChannelSubtypeType
- See MessageTemplateContentProviderTypeDef
- See MessageTemplateAttributesTypeDef
- See GroupingConfigurationTypeDef
UpdateMessageTemplateRequestRequestTypeDef#
# UpdateMessageTemplateRequestRequestTypeDef definition
class UpdateMessageTemplateRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
messageTemplateId: str,
content: NotRequired[MessageTemplateContentProviderTypeDef], # (1)
defaultAttributes: NotRequired[MessageTemplateAttributesTypeDef], # (2)
language: NotRequired[str],CreateMessageTemplateVersionResponseTypeDef#
# CreateMessageTemplateVersionResponseTypeDef definition
class CreateMessageTemplateVersionResponseTypeDef(TypedDict):
messageTemplate: ExtendedMessageTemplateDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetMessageTemplateResponseTypeDef#
# GetMessageTemplateResponseTypeDef definition
class GetMessageTemplateResponseTypeDef(TypedDict):
messageTemplate: ExtendedMessageTemplateDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateMessageTemplateResponseTypeDef#
# CreateMessageTemplateResponseTypeDef definition
class CreateMessageTemplateResponseTypeDef(TypedDict):
messageTemplate: MessageTemplateDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateMessageTemplateMetadataResponseTypeDef#
# UpdateMessageTemplateMetadataResponseTypeDef definition
class UpdateMessageTemplateMetadataResponseTypeDef(TypedDict):
messageTemplate: MessageTemplateDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateMessageTemplateResponseTypeDef#
# UpdateMessageTemplateResponseTypeDef definition
class UpdateMessageTemplateResponseTypeDef(TypedDict):
messageTemplate: MessageTemplateDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)VectorIngestionConfigurationTypeDef#
# VectorIngestionConfigurationTypeDef definition
class VectorIngestionConfigurationTypeDef(TypedDict):
chunkingConfiguration: NotRequired[ChunkingConfigurationUnionTypeDef], # (1)
parsingConfiguration: NotRequired[ParsingConfigurationTypeDef], # (2)AssociationConfigurationOutputTypeDef#
# AssociationConfigurationOutputTypeDef definition
class AssociationConfigurationOutputTypeDef(TypedDict):
associationConfigurationData: NotRequired[AssociationConfigurationDataOutputTypeDef], # (1)
associationId: NotRequired[str],
associationType: NotRequired[AIAgentAssociationConfigurationTypeType], # (2)KnowledgeBaseAssociationConfigurationDataTypeDef#
# KnowledgeBaseAssociationConfigurationDataTypeDef definition
class KnowledgeBaseAssociationConfigurationDataTypeDef(TypedDict):
contentTagFilter: NotRequired[TagFilterUnionTypeDef], # (1)
maxResults: NotRequired[int],
overrideKnowledgeBaseSearchType: NotRequired[KnowledgeBaseSearchTypeType], # (2)KnowledgeBaseDataTypeDef#
# KnowledgeBaseDataTypeDef definition
class KnowledgeBaseDataTypeDef(TypedDict):
knowledgeBaseArn: str,
knowledgeBaseId: str,
knowledgeBaseType: KnowledgeBaseTypeType, # (2)
name: str,
status: KnowledgeBaseStatusType, # (6)
description: NotRequired[str],
ingestionFailureReasons: NotRequired[list[str]],
ingestionStatus: NotRequired[SyncStatusType], # (1)
lastContentModificationTime: NotRequired[datetime],
renderingConfiguration: NotRequired[RenderingConfigurationTypeDef], # (3)
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (4)
sourceConfiguration: NotRequired[SourceConfigurationOutputTypeDef], # (5)
tags: NotRequired[dict[str, str]],
vectorIngestionConfiguration: NotRequired[VectorIngestionConfigurationOutputTypeDef], # (7)- See SyncStatusType
- See KnowledgeBaseTypeType
- See RenderingConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See SourceConfigurationOutputTypeDef
- See KnowledgeBaseStatusType
- See VectorIngestionConfigurationOutputTypeDef
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]],
vectorIngestionConfiguration: NotRequired[VectorIngestionConfigurationOutputTypeDef], # (6)- See KnowledgeBaseTypeType
- See RenderingConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See SourceConfigurationOutputTypeDef
- See KnowledgeBaseStatusType
- See VectorIngestionConfigurationOutputTypeDef
ManagedSourceConfigurationTypeDef#
# ManagedSourceConfigurationTypeDef definition
class ManagedSourceConfigurationTypeDef(TypedDict):
webCrawlerConfiguration: NotRequired[WebCrawlerConfigurationUnionTypeDef], # (1)ResultDataPaginatorTypeDef#
# ResultDataPaginatorTypeDef definition
class ResultDataPaginatorTypeDef(TypedDict):
resultId: str,
data: NotRequired[DataSummaryPaginatorTypeDef], # (1)
document: NotRequired[DocumentTypeDef], # (2)
relevanceScore: NotRequired[float],
type: NotRequired[QueryResultTypeType], # (3)RecommendationDataTypeDef#
# RecommendationDataTypeDef definition
class RecommendationDataTypeDef(TypedDict):
recommendationId: str,
data: NotRequired[DataSummaryTypeDef], # (1)
document: NotRequired[DocumentTypeDef], # (2)
relevanceLevel: NotRequired[RelevanceLevelType], # (3)
relevanceScore: NotRequired[float],
type: NotRequired[RecommendationTypeType], # (4)- See DataSummaryTypeDef
- See DocumentTypeDef
- See RelevanceLevelType
- See RecommendationTypeType
ResultDataTypeDef#
# ResultDataTypeDef definition
class ResultDataTypeDef(TypedDict):
resultId: str,
data: NotRequired[DataSummaryTypeDef], # (1)
document: NotRequired[DocumentTypeDef], # (2)
relevanceScore: NotRequired[float],
type: NotRequired[QueryResultTypeType], # (3)- See DataSummaryTypeDef
- See DocumentTypeDef
- See QueryResultTypeType
AnswerRecommendationAIAgentConfigurationOutputTypeDef#
# AnswerRecommendationAIAgentConfigurationOutputTypeDef definition
class AnswerRecommendationAIAgentConfigurationOutputTypeDef(TypedDict):
answerGenerationAIGuardrailId: NotRequired[str],
answerGenerationAIPromptId: NotRequired[str],
associationConfigurations: NotRequired[list[AssociationConfigurationOutputTypeDef]], # (1)
intentLabelingGenerationAIPromptId: NotRequired[str],
locale: NotRequired[str],
queryReformulationAIPromptId: NotRequired[str],ManualSearchAIAgentConfigurationOutputTypeDef#
# ManualSearchAIAgentConfigurationOutputTypeDef definition
class ManualSearchAIAgentConfigurationOutputTypeDef(TypedDict):
answerGenerationAIGuardrailId: NotRequired[str],
answerGenerationAIPromptId: NotRequired[str],
associationConfigurations: NotRequired[list[AssociationConfigurationOutputTypeDef]], # (1)
locale: NotRequired[str],SelfServiceAIAgentConfigurationOutputTypeDef#
# SelfServiceAIAgentConfigurationOutputTypeDef definition
class SelfServiceAIAgentConfigurationOutputTypeDef(TypedDict):
associationConfigurations: NotRequired[list[AssociationConfigurationOutputTypeDef]], # (1)
selfServiceAIGuardrailId: NotRequired[str],
selfServiceAnswerGenerationAIPromptId: NotRequired[str],
selfServicePreProcessingAIPromptId: NotRequired[str],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],QueryAssistantResponsePaginatorTypeDef#
# QueryAssistantResponsePaginatorTypeDef definition
class QueryAssistantResponsePaginatorTypeDef(TypedDict):
results: list[ResultDataPaginatorTypeDef], # (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],AIAgentConfigurationOutputTypeDef#
# AIAgentConfigurationOutputTypeDef definition
class AIAgentConfigurationOutputTypeDef(TypedDict):
answerRecommendationAIAgentConfiguration: NotRequired[AnswerRecommendationAIAgentConfigurationOutputTypeDef], # (1)
manualSearchAIAgentConfiguration: NotRequired[ManualSearchAIAgentConfigurationOutputTypeDef], # (2)
selfServiceAIAgentConfiguration: NotRequired[SelfServiceAIAgentConfigurationOutputTypeDef], # (3)- See AnswerRecommendationAIAgentConfigurationOutputTypeDef
- See ManualSearchAIAgentConfigurationOutputTypeDef
- See SelfServiceAIAgentConfigurationOutputTypeDef
AssociationConfigurationDataTypeDef#
# AssociationConfigurationDataTypeDef definition
class AssociationConfigurationDataTypeDef(TypedDict):
knowledgeBaseAssociationConfigurationData: NotRequired[KnowledgeBaseAssociationConfigurationDataUnionTypeDef], # (1)- See KnowledgeBaseAssociationConfigurationDataTypeDef KnowledgeBaseAssociationConfigurationDataOutputTypeDef
SourceConfigurationTypeDef#
# SourceConfigurationTypeDef definition
class SourceConfigurationTypeDef(TypedDict):
appIntegrations: NotRequired[AppIntegrationsConfigurationUnionTypeDef], # (1)
managedSourceConfiguration: NotRequired[ManagedSourceConfigurationUnionTypeDef], # (2)- See AppIntegrationsConfigurationTypeDef AppIntegrationsConfigurationOutputTypeDef
- See ManagedSourceConfigurationTypeDef ManagedSourceConfigurationOutputTypeDef
AIAgentDataTypeDef#
# AIAgentDataTypeDef definition
class AIAgentDataTypeDef(TypedDict):
aiAgentArn: str,
aiAgentId: str,
assistantArn: str,
assistantId: str,
configuration: AIAgentConfigurationOutputTypeDef, # (1)
name: str,
type: AIAgentTypeType, # (4)
visibilityStatus: VisibilityStatusType, # (5)
description: NotRequired[str],
modifiedTime: NotRequired[datetime],
origin: NotRequired[OriginType], # (2)
status: NotRequired[StatusType], # (3)
tags: NotRequired[dict[str, str]],- See AIAgentConfigurationOutputTypeDef
- See OriginType
- See StatusType
- See AIAgentTypeType
- See VisibilityStatusType
AIAgentSummaryTypeDef#
# AIAgentSummaryTypeDef definition
class AIAgentSummaryTypeDef(TypedDict):
aiAgentArn: str,
aiAgentId: str,
assistantArn: str,
assistantId: str,
name: str,
type: AIAgentTypeType, # (4)
visibilityStatus: VisibilityStatusType, # (5)
configuration: NotRequired[AIAgentConfigurationOutputTypeDef], # (1)
description: NotRequired[str],
modifiedTime: NotRequired[datetime],
origin: NotRequired[OriginType], # (2)
status: NotRequired[StatusType], # (3)
tags: NotRequired[dict[str, str]],- See AIAgentConfigurationOutputTypeDef
- See OriginType
- See StatusType
- See AIAgentTypeType
- See VisibilityStatusType
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]],
vectorIngestionConfiguration: NotRequired[VectorIngestionConfigurationTypeDef], # (5)- See KnowledgeBaseTypeType
- See RenderingConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See SourceConfigurationTypeDef
- See VectorIngestionConfigurationTypeDef
CreateAIAgentResponseTypeDef#
# CreateAIAgentResponseTypeDef definition
class CreateAIAgentResponseTypeDef(TypedDict):
aiAgent: AIAgentDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateAIAgentVersionResponseTypeDef#
# CreateAIAgentVersionResponseTypeDef definition
class CreateAIAgentVersionResponseTypeDef(TypedDict):
aiAgent: AIAgentDataTypeDef, # (1)
versionNumber: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetAIAgentResponseTypeDef#
# GetAIAgentResponseTypeDef definition
class GetAIAgentResponseTypeDef(TypedDict):
aiAgent: AIAgentDataTypeDef, # (1)
versionNumber: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateAIAgentResponseTypeDef#
# UpdateAIAgentResponseTypeDef definition
class UpdateAIAgentResponseTypeDef(TypedDict):
aiAgent: AIAgentDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)AIAgentVersionSummaryTypeDef#
# AIAgentVersionSummaryTypeDef definition
class AIAgentVersionSummaryTypeDef(TypedDict):
aiAgentSummary: NotRequired[AIAgentSummaryTypeDef], # (1)
versionNumber: NotRequired[int],ListAIAgentsResponseTypeDef#
# ListAIAgentsResponseTypeDef definition
class ListAIAgentsResponseTypeDef(TypedDict):
aiAgentSummaries: list[AIAgentSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],AssociationConfigurationTypeDef#
# AssociationConfigurationTypeDef definition
class AssociationConfigurationTypeDef(TypedDict):
associationConfigurationData: NotRequired[AssociationConfigurationDataUnionTypeDef], # (1)
associationId: NotRequired[str],
associationType: NotRequired[AIAgentAssociationConfigurationTypeType], # (2)- See AssociationConfigurationDataTypeDef AssociationConfigurationDataOutputTypeDef
- See AIAgentAssociationConfigurationTypeType
ListAIAgentVersionsResponseTypeDef#
# ListAIAgentVersionsResponseTypeDef definition
class ListAIAgentVersionsResponseTypeDef(TypedDict):
aiAgentVersionSummaries: list[AIAgentVersionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],AnswerRecommendationAIAgentConfigurationTypeDef#
# AnswerRecommendationAIAgentConfigurationTypeDef definition
class AnswerRecommendationAIAgentConfigurationTypeDef(TypedDict):
answerGenerationAIGuardrailId: NotRequired[str],
answerGenerationAIPromptId: NotRequired[str],
associationConfigurations: NotRequired[Sequence[AssociationConfigurationTypeDef]], # (1)
intentLabelingGenerationAIPromptId: NotRequired[str],
locale: NotRequired[str],
queryReformulationAIPromptId: NotRequired[str],ManualSearchAIAgentConfigurationTypeDef#
# ManualSearchAIAgentConfigurationTypeDef definition
class ManualSearchAIAgentConfigurationTypeDef(TypedDict):
answerGenerationAIGuardrailId: NotRequired[str],
answerGenerationAIPromptId: NotRequired[str],
associationConfigurations: NotRequired[Sequence[AssociationConfigurationTypeDef]], # (1)
locale: NotRequired[str],SelfServiceAIAgentConfigurationTypeDef#
# SelfServiceAIAgentConfigurationTypeDef definition
class SelfServiceAIAgentConfigurationTypeDef(TypedDict):
associationConfigurations: NotRequired[Sequence[AssociationConfigurationUnionTypeDef]], # (1)
selfServiceAIGuardrailId: NotRequired[str],
selfServiceAnswerGenerationAIPromptId: NotRequired[str],
selfServicePreProcessingAIPromptId: NotRequired[str],AIAgentConfigurationTypeDef#
# AIAgentConfigurationTypeDef definition
class AIAgentConfigurationTypeDef(TypedDict):
answerRecommendationAIAgentConfiguration: NotRequired[AnswerRecommendationAIAgentConfigurationUnionTypeDef], # (1)
manualSearchAIAgentConfiguration: NotRequired[ManualSearchAIAgentConfigurationUnionTypeDef], # (2)
selfServiceAIAgentConfiguration: NotRequired[SelfServiceAIAgentConfigurationUnionTypeDef], # (3)- See AnswerRecommendationAIAgentConfigurationTypeDef AnswerRecommendationAIAgentConfigurationOutputTypeDef
- See ManualSearchAIAgentConfigurationTypeDef ManualSearchAIAgentConfigurationOutputTypeDef
- See SelfServiceAIAgentConfigurationTypeDef SelfServiceAIAgentConfigurationOutputTypeDef
CreateAIAgentRequestRequestTypeDef#
# CreateAIAgentRequestRequestTypeDef definition
class CreateAIAgentRequestRequestTypeDef(TypedDict):
assistantId: str,
configuration: AIAgentConfigurationTypeDef, # (1)
name: str,
type: AIAgentTypeType, # (2)
visibilityStatus: VisibilityStatusType, # (3)
clientToken: NotRequired[str],
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],UpdateAIAgentRequestRequestTypeDef#
# UpdateAIAgentRequestRequestTypeDef definition
class UpdateAIAgentRequestRequestTypeDef(TypedDict):
aiAgentId: str,
assistantId: str,
visibilityStatus: VisibilityStatusType, # (1)
clientToken: NotRequired[str],
configuration: NotRequired[AIAgentConfigurationTypeDef], # (2)
description: NotRequired[str],