Skip to content

Type definitions#

Index > QConnect > Type definitions

Auto-generated documentation for QConnect type annotations stubs module mypy-boto3-qconnect.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

GroupingConfigurationUnionTypeDef#

# GroupingConfigurationUnionTypeDef definition

GroupingConfigurationUnionTypeDef = Union[
    GroupingConfigurationTypeDef,  # (1)
    GroupingConfigurationExtraOutputTypeDef,  # (2)
]
  1. See GroupingConfigurationTypeDef
  2. See GroupingConfigurationExtraOutputTypeDef

TagFilterUnionTypeDef#

# TagFilterUnionTypeDef definition

TagFilterUnionTypeDef = Union[
    TagFilterTypeDef,  # (1)
    TagFilterExtraOutputTypeDef,  # (2)
]
  1. See TagFilterTypeDef
  2. See TagFilterExtraOutputTypeDef

VectorIngestionConfigurationUnionTypeDef#

# VectorIngestionConfigurationUnionTypeDef definition

VectorIngestionConfigurationUnionTypeDef = Union[
    VectorIngestionConfigurationTypeDef,  # (1)
    VectorIngestionConfigurationExtraOutputTypeDef,  # (2)
]
  1. See VectorIngestionConfigurationTypeDef
  2. See VectorIngestionConfigurationExtraOutputTypeDef

SourceConfigurationUnionTypeDef#

# SourceConfigurationUnionTypeDef definition

SourceConfigurationUnionTypeDef = Union[
    SourceConfigurationTypeDef,  # (1)
    SourceConfigurationExtraOutputTypeDef,  # (2)
]
  1. See SourceConfigurationTypeDef
  2. See SourceConfigurationExtraOutputTypeDef

AIAgentConfigurationUnionTypeDef#

# AIAgentConfigurationUnionTypeDef definition

AIAgentConfigurationUnionTypeDef = Union[
    AIAgentConfigurationTypeDef,  # (1)
    AIAgentConfigurationExtraOutputTypeDef,  # (2)
]
  1. See AIAgentConfigurationTypeDef
  2. See AIAgentConfigurationExtraOutputTypeDef

AIAgentConfigurationDataTypeDef#

# AIAgentConfigurationDataTypeDef definition

class AIAgentConfigurationDataTypeDef(TypedDict):
    aiAgentId: 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]],
  1. See AIPromptAPIFormatType
  2. See OriginType
  3. See StatusType
  4. See AIPromptTemplateTypeType
  5. See AIPromptTypeType
  6. See VisibilityStatusType

TextFullAIPromptEditTemplateConfigurationTypeDef#

# TextFullAIPromptEditTemplateConfigurationTypeDef definition

class TextFullAIPromptEditTemplateConfigurationTypeDef(TypedDict):
    text: str,

AmazonConnectGuideAssociationDataTypeDef#

# AmazonConnectGuideAssociationDataTypeDef definition

class AmazonConnectGuideAssociationDataTypeDef(TypedDict):
    flowId: NotRequired[str],

AppIntegrationsConfigurationExtraOutputTypeDef#

# AppIntegrationsConfigurationExtraOutputTypeDef definition

class AppIntegrationsConfigurationExtraOutputTypeDef(TypedDict):
    appIntegrationArn: str,
    objectFields: NotRequired[List[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)
  1. See AssistantCapabilityTypeType

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],
  1. See RelevanceLevelType

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]],
  1. See ContentStatusType

GenerativeContentFeedbackDataTypeDef#

# GenerativeContentFeedbackDataTypeDef definition

class GenerativeContentFeedbackDataTypeDef(TypedDict):
    relevance: RelevanceType,  # (1)
  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],
  1. See ReferenceTypeType

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]],
  1. See ContentStatusType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CreateContentRequestRequestTypeDef#

# CreateContentRequestRequestTypeDef definition

class CreateContentRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    name: str,
    uploadId: str,
    clientToken: NotRequired[str],
    metadata: NotRequired[Mapping[str, str]],
    overrideLinkOutUri: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    title: NotRequired[str],

RenderingConfigurationTypeDef#

# RenderingConfigurationTypeDef definition

class RenderingConfigurationTypeDef(TypedDict):
    templateUri: NotRequired[str],

GroupingConfigurationTypeDef#

# GroupingConfigurationTypeDef definition

class GroupingConfigurationTypeDef(TypedDict):
    criteria: NotRequired[str],
    values: NotRequired[Sequence[str]],

QuickResponseDataProviderTypeDef#

# QuickResponseDataProviderTypeDef definition

class QuickResponseDataProviderTypeDef(TypedDict):
    content: NotRequired[str],

IntentDetectedDataDetailsTypeDef#

# IntentDetectedDataDetailsTypeDef definition

class IntentDetectedDataDetailsTypeDef(TypedDict):
    intent: str,
    intentId: str,

GenerativeReferenceTypeDef#

# GenerativeReferenceTypeDef definition

class GenerativeReferenceTypeDef(TypedDict):
    generationId: NotRequired[str],
    modelId: NotRequired[str],

DeleteAIAgentRequestRequestTypeDef#

# DeleteAIAgentRequestRequestTypeDef definition

class DeleteAIAgentRequestRequestTypeDef(TypedDict):
    aiAgentId: str,
    assistantId: str,

DeleteAIAgentVersionRequestRequestTypeDef#

# DeleteAIAgentVersionRequestRequestTypeDef definition

class DeleteAIAgentVersionRequestRequestTypeDef(TypedDict):
    aiAgentId: 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,

DeleteQuickResponseRequestRequestTypeDef#

# DeleteQuickResponseRequestRequestTypeDef definition

class DeleteQuickResponseRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    quickResponseId: str,

HighlightTypeDef#

# HighlightTypeDef definition

class HighlightTypeDef(TypedDict):
    beginOffsetInclusive: NotRequired[int],
    endOffsetExclusive: NotRequired[int],

FilterTypeDef#

# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    field: FilterFieldType,  # (1)
    operator: FilterOperatorType,  # (2)
    value: str,
  1. See FilterFieldType
  2. See FilterOperatorType

GetAIAgentRequestRequestTypeDef#

# GetAIAgentRequestRequestTypeDef definition

class GetAIAgentRequestRequestTypeDef(TypedDict):
    aiAgentId: 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,

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,

GroupingConfigurationExtraOutputTypeDef#

# GroupingConfigurationExtraOutputTypeDef definition

class GroupingConfigurationExtraOutputTypeDef(TypedDict):
    criteria: NotRequired[str],
    values: NotRequired[List[str]],

GroupingConfigurationOutputTypeDef#

# GroupingConfigurationOutputTypeDef definition

class GroupingConfigurationOutputTypeDef(TypedDict):
    criteria: NotRequired[str],
    values: NotRequired[List[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)
  1. See OriginType

ListAIAgentsRequestRequestTypeDef#

# ListAIAgentsRequestRequestTypeDef definition

class ListAIAgentsRequestRequestTypeDef(TypedDict):
    assistantId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    origin: NotRequired[OriginType],  # (1)
  1. See OriginType

ListAIPromptVersionsRequestRequestTypeDef#

# ListAIPromptVersionsRequestRequestTypeDef definition

class ListAIPromptVersionsRequestRequestTypeDef(TypedDict):
    aiPromptId: str,
    assistantId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    origin: NotRequired[OriginType],  # (1)
  1. See OriginType

ListAIPromptsRequestRequestTypeDef#

# ListAIPromptsRequestRequestTypeDef definition

class ListAIPromptsRequestRequestTypeDef(TypedDict):
    assistantId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    origin: NotRequired[OriginType],  # (1)
  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],

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]],
  1. See QuickResponseStatusType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

NotifyRecommendationsReceivedErrorTypeDef#

# NotifyRecommendationsReceivedErrorTypeDef definition

class NotifyRecommendationsReceivedErrorTypeDef(TypedDict):
    message: NotRequired[str],
    recommendationId: NotRequired[str],

NotifyRecommendationsReceivedRequestRequestTypeDef#

# NotifyRecommendationsReceivedRequestRequestTypeDef definition

class NotifyRecommendationsReceivedRequestRequestTypeDef(TypedDict):
    assistantId: str,
    recommendationIds: Sequence[str],
    sessionId: str,

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,
  1. See QueryConditionComparisonOperatorType
  2. See QueryConditionFieldNameType

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]],
  1. See QuickResponseFilterOperatorType

QuickResponseOrderFieldTypeDef#

# QuickResponseOrderFieldTypeDef definition

class QuickResponseOrderFieldTypeDef(TypedDict):
    name: str,
    order: NotRequired[OrderType],  # (1)
  1. See OrderType

QuickResponseQueryFieldTypeDef#

# QuickResponseQueryFieldTypeDef definition

class QuickResponseQueryFieldTypeDef(TypedDict):
    name: str,
    operator: QuickResponseQueryOperatorType,  # (1)
    values: Sequence[str],
    allowFuzziness: NotRequired[bool],
    priority: NotRequired[PriorityType],  # (2)
  1. See QuickResponseQueryOperatorType
  2. See PriorityType

RemoveAssistantAIAgentRequestRequestTypeDef#

# RemoveAssistantAIAgentRequestRequestTypeDef definition

class RemoveAssistantAIAgentRequestRequestTypeDef(TypedDict):
    aiAgentType: AIAgentTypeType,  # (1)
    assistantId: str,
  1. 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],

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)
  1. See AIAgentTypeType
  2. See AIAgentConfigurationDataTypeDef

AIPromptVersionSummaryTypeDef#

# AIPromptVersionSummaryTypeDef definition

class AIPromptVersionSummaryTypeDef(TypedDict):
    aiPromptSummary: NotRequired[AIPromptSummaryTypeDef],  # (1)
    versionNumber: NotRequired[int],
  1. See AIPromptSummaryTypeDef

AIPromptTemplateConfigurationTypeDef#

# AIPromptTemplateConfigurationTypeDef definition

class AIPromptTemplateConfigurationTypeDef(TypedDict):
    textFullAIPromptEditTemplateConfiguration: NotRequired[TextFullAIPromptEditTemplateConfigurationTypeDef],  # (1)
  1. See TextFullAIPromptEditTemplateConfigurationTypeDef

ContentAssociationContentsTypeDef#

# ContentAssociationContentsTypeDef definition

class ContentAssociationContentsTypeDef(TypedDict):
    amazonConnectGuideAssociation: NotRequired[AmazonConnectGuideAssociationDataTypeDef],  # (1)
  1. See AmazonConnectGuideAssociationDataTypeDef

CreateAssistantAssociationRequestRequestTypeDef#

# CreateAssistantAssociationRequestRequestTypeDef definition

class CreateAssistantAssociationRequestRequestTypeDef(TypedDict):
    assistantId: str,
    association: AssistantAssociationInputDataTypeDef,  # (1)
    associationType: AssociationTypeType,  # (2)
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See AssistantAssociationInputDataTypeDef
  2. See AssociationTypeType

AssistantAssociationOutputDataTypeDef#

# AssistantAssociationOutputDataTypeDef definition

class AssistantAssociationOutputDataTypeDef(TypedDict):
    knowledgeBaseAssociation: NotRequired[KnowledgeBaseAssociationDataTypeDef],  # (1)
  1. See KnowledgeBaseAssociationDataTypeDef

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]],
  1. See AIAgentTypeType AIAgentConfigurationDataTypeDef
  2. See AssistantCapabilityConfigurationTypeDef
  3. See AssistantIntegrationConfigurationTypeDef
  4. See ServerSideEncryptionConfigurationTypeDef
  5. See AssistantStatusType
  6. 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]],
  1. See AIAgentTypeType AIAgentConfigurationDataTypeDef
  2. See AssistantCapabilityConfigurationTypeDef
  3. See AssistantIntegrationConfigurationTypeDef
  4. See ServerSideEncryptionConfigurationTypeDef
  5. See AssistantStatusType
  6. 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]],
  1. See AssistantTypeType
  2. See ServerSideEncryptionConfigurationTypeDef

BedrockFoundationModelConfigurationForParsingTypeDef#

# BedrockFoundationModelConfigurationForParsingTypeDef definition

class BedrockFoundationModelConfigurationForParsingTypeDef(TypedDict):
    modelArn: str,
    parsingPrompt: NotRequired[ParsingPromptTypeDef],  # (1)
  1. See ParsingPromptTypeDef

ConfigurationTypeDef#

# ConfigurationTypeDef definition

class ConfigurationTypeDef(TypedDict):
    connectConfiguration: NotRequired[ConnectConfigurationTypeDef],  # (1)
  1. See ConnectConfigurationTypeDef

GenerativeDataDetailsTypeDef#

# GenerativeDataDetailsTypeDef definition

class GenerativeDataDetailsTypeDef(TypedDict):
    completion: str,
    rankingData: RankingDataTypeDef,  # (1)
    references: List[DataSummaryTypeDef],  # (2)
  1. See RankingDataTypeDef
  2. See DataSummaryTypeDef

ContentFeedbackDataTypeDef#

# ContentFeedbackDataTypeDef definition

class ContentFeedbackDataTypeDef(TypedDict):
    generativeContentFeedbackData: NotRequired[GenerativeContentFeedbackDataTypeDef],  # (1)
  1. See GenerativeContentFeedbackDataTypeDef

CreateContentResponseTypeDef#

# CreateContentResponseTypeDef definition

class CreateContentResponseTypeDef(TypedDict):
    content: ContentDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentDataTypeDef
  2. See ResponseMetadataTypeDef

GetContentResponseTypeDef#

# GetContentResponseTypeDef definition

class GetContentResponseTypeDef(TypedDict):
    content: ContentDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentDataTypeDef
  2. See ResponseMetadataTypeDef

GetContentSummaryResponseTypeDef#

# GetContentSummaryResponseTypeDef definition

class GetContentSummaryResponseTypeDef(TypedDict):
    contentSummary: ContentSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAIPromptsResponseTypeDef#

# ListAIPromptsResponseTypeDef definition

class ListAIPromptsResponseTypeDef(TypedDict):
    aiPromptSummaries: List[AIPromptSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AIPromptSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListContentsResponseTypeDef#

# ListContentsResponseTypeDef definition

class ListContentsResponseTypeDef(TypedDict):
    contentSummaries: List[ContentSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SearchContentResponseTypeDef#

# SearchContentResponseTypeDef definition

class SearchContentResponseTypeDef(TypedDict):
    contentSummaries: List[ContentSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentSummaryTypeDef
  2. See ResponseMetadataTypeDef

StartContentUploadResponseTypeDef#

# StartContentUploadResponseTypeDef definition

class StartContentUploadResponseTypeDef(TypedDict):
    headersToInclude: Dict[str, str],
    uploadId: str,
    url: str,
    urlExpiry: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateContentResponseTypeDef#

# UpdateContentResponseTypeDef definition

class UpdateContentResponseTypeDef(TypedDict):
    content: ContentDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentDataTypeDef
  2. See ResponseMetadataTypeDef

CreateAIAgentVersionRequestRequestTypeDef#

# CreateAIAgentVersionRequestRequestTypeDef definition

class CreateAIAgentVersionRequestRequestTypeDef(TypedDict):
    aiAgentId: str,
    assistantId: str,
    clientToken: NotRequired[str],
    modifiedTime: NotRequired[Union[datetime, str]],

CreateAIPromptVersionRequestRequestTypeDef#

# CreateAIPromptVersionRequestRequestTypeDef definition

class CreateAIPromptVersionRequestRequestTypeDef(TypedDict):
    aiPromptId: str,
    assistantId: str,
    clientToken: NotRequired[str],
    modifiedTime: NotRequired[Union[datetime, 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]],
  1. See QuickResponseDataProviderTypeDef
  2. See GroupingConfigurationTypeDef

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],
  1. See QuickResponseDataProviderTypeDef
  2. See GroupingConfigurationTypeDef

DataReferenceTypeDef#

# DataReferenceTypeDef definition

class DataReferenceTypeDef(TypedDict):
    contentReference: NotRequired[ContentReferenceTypeDef],  # (1)
    generativeReference: NotRequired[GenerativeReferenceTypeDef],  # (2)
  1. See ContentReferenceTypeDef
  2. See GenerativeReferenceTypeDef

DocumentTextTypeDef#

# DocumentTextTypeDef definition

class DocumentTextTypeDef(TypedDict):
    highlights: NotRequired[List[HighlightTypeDef]],  # (1)
    text: NotRequired[str],
  1. See HighlightTypeDef

SearchExpressionTypeDef#

# SearchExpressionTypeDef definition

class SearchExpressionTypeDef(TypedDict):
    filters: Sequence[FilterTypeDef],  # (1)
  1. See FilterTypeDef

HierarchicalChunkingConfigurationExtraOutputTypeDef#

# HierarchicalChunkingConfigurationExtraOutputTypeDef definition

class HierarchicalChunkingConfigurationExtraOutputTypeDef(TypedDict):
    levelConfigurations: List[HierarchicalChunkingLevelConfigurationTypeDef],  # (1)
    overlapTokens: int,
  1. See HierarchicalChunkingLevelConfigurationTypeDef

HierarchicalChunkingConfigurationOutputTypeDef#

# HierarchicalChunkingConfigurationOutputTypeDef definition

class HierarchicalChunkingConfigurationOutputTypeDef(TypedDict):
    levelConfigurations: List[HierarchicalChunkingLevelConfigurationTypeDef],  # (1)
    overlapTokens: int,
  1. See HierarchicalChunkingLevelConfigurationTypeDef

HierarchicalChunkingConfigurationTypeDef#

# HierarchicalChunkingConfigurationTypeDef definition

class HierarchicalChunkingConfigurationTypeDef(TypedDict):
    levelConfigurations: Sequence[HierarchicalChunkingLevelConfigurationTypeDef],  # (1)
    overlapTokens: int,
  1. See HierarchicalChunkingLevelConfigurationTypeDef

ListAIAgentVersionsRequestListAIAgentVersionsPaginateTypeDef#

# ListAIAgentVersionsRequestListAIAgentVersionsPaginateTypeDef definition

class ListAIAgentVersionsRequestListAIAgentVersionsPaginateTypeDef(TypedDict):
    aiAgentId: str,
    assistantId: str,
    origin: NotRequired[OriginType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See OriginType
  2. See PaginatorConfigTypeDef

ListAIAgentsRequestListAIAgentsPaginateTypeDef#

# ListAIAgentsRequestListAIAgentsPaginateTypeDef definition

class ListAIAgentsRequestListAIAgentsPaginateTypeDef(TypedDict):
    assistantId: str,
    origin: NotRequired[OriginType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See OriginType
  2. See PaginatorConfigTypeDef

ListAIPromptVersionsRequestListAIPromptVersionsPaginateTypeDef#

# ListAIPromptVersionsRequestListAIPromptVersionsPaginateTypeDef definition

class ListAIPromptVersionsRequestListAIPromptVersionsPaginateTypeDef(TypedDict):
    aiPromptId: str,
    assistantId: str,
    origin: NotRequired[OriginType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See OriginType
  2. See PaginatorConfigTypeDef

ListAIPromptsRequestListAIPromptsPaginateTypeDef#

# ListAIPromptsRequestListAIPromptsPaginateTypeDef definition

class ListAIPromptsRequestListAIPromptsPaginateTypeDef(TypedDict):
    assistantId: str,
    origin: NotRequired[OriginType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See OriginType
  2. See PaginatorConfigTypeDef

ListAssistantAssociationsRequestListAssistantAssociationsPaginateTypeDef#

# ListAssistantAssociationsRequestListAssistantAssociationsPaginateTypeDef definition

class ListAssistantAssociationsRequestListAssistantAssociationsPaginateTypeDef(TypedDict):
    assistantId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAssistantsRequestListAssistantsPaginateTypeDef#

# ListAssistantsRequestListAssistantsPaginateTypeDef definition

class ListAssistantsRequestListAssistantsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListContentAssociationsRequestListContentAssociationsPaginateTypeDef#

# ListContentAssociationsRequestListContentAssociationsPaginateTypeDef definition

class ListContentAssociationsRequestListContentAssociationsPaginateTypeDef(TypedDict):
    contentId: str,
    knowledgeBaseId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListContentsRequestListContentsPaginateTypeDef#

# ListContentsRequestListContentsPaginateTypeDef definition

class ListContentsRequestListContentsPaginateTypeDef(TypedDict):
    knowledgeBaseId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListImportJobsRequestListImportJobsPaginateTypeDef#

# ListImportJobsRequestListImportJobsPaginateTypeDef definition

class ListImportJobsRequestListImportJobsPaginateTypeDef(TypedDict):
    knowledgeBaseId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef#

# ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef definition

class ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQuickResponsesRequestListQuickResponsesPaginateTypeDef#

# ListQuickResponsesRequestListQuickResponsesPaginateTypeDef definition

class ListQuickResponsesRequestListQuickResponsesPaginateTypeDef(TypedDict):
    knowledgeBaseId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQuickResponsesResponseTypeDef#

# ListQuickResponsesResponseTypeDef definition

class ListQuickResponsesResponseTypeDef(TypedDict):
    nextToken: str,
    quickResponseSummaries: List[QuickResponseSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QuickResponseSummaryTypeDef
  2. See ResponseMetadataTypeDef

NotifyRecommendationsReceivedResponseTypeDef#

# NotifyRecommendationsReceivedResponseTypeDef definition

class NotifyRecommendationsReceivedResponseTypeDef(TypedDict):
    errors: List[NotifyRecommendationsReceivedErrorTypeDef],  # (1)
    recommendationIds: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NotifyRecommendationsReceivedErrorTypeDef
  2. See ResponseMetadataTypeDef

OrConditionExtraOutputTypeDef#

# OrConditionExtraOutputTypeDef definition

class OrConditionExtraOutputTypeDef(TypedDict):
    andConditions: NotRequired[List[TagConditionTypeDef]],  # (1)
    tagCondition: NotRequired[TagConditionTypeDef],  # (2)
  1. See TagConditionTypeDef
  2. See TagConditionTypeDef

OrConditionOutputTypeDef#

# OrConditionOutputTypeDef definition

class OrConditionOutputTypeDef(TypedDict):
    andConditions: NotRequired[List[TagConditionTypeDef]],  # (1)
    tagCondition: NotRequired[TagConditionTypeDef],  # (2)
  1. See TagConditionTypeDef
  2. See TagConditionTypeDef

OrConditionTypeDef#

# OrConditionTypeDef definition

class OrConditionTypeDef(TypedDict):
    andConditions: NotRequired[Sequence[TagConditionTypeDef]],  # (1)
    tagCondition: NotRequired[TagConditionTypeDef],  # (2)
  1. See TagConditionTypeDef
  2. See TagConditionTypeDef

QueryConditionTypeDef#

# QueryConditionTypeDef definition

class QueryConditionTypeDef(TypedDict):
    single: NotRequired[QueryConditionItemTypeDef],  # (1)
  1. See QueryConditionItemTypeDef

QueryInputDataTypeDef#

# QueryInputDataTypeDef definition

class QueryInputDataTypeDef(TypedDict):
    intentInputData: NotRequired[IntentInputDataTypeDef],  # (1)
    queryTextInputData: NotRequired[QueryTextInputDataTypeDef],  # (2)
  1. See IntentInputDataTypeDef
  2. See QueryTextInputDataTypeDef

RecommendationTriggerDataTypeDef#

# RecommendationTriggerDataTypeDef definition

class RecommendationTriggerDataTypeDef(TypedDict):
    query: NotRequired[QueryRecommendationTriggerDataTypeDef],  # (1)
  1. See QueryRecommendationTriggerDataTypeDef

QuickResponseContentsTypeDef#

# QuickResponseContentsTypeDef definition

class QuickResponseContentsTypeDef(TypedDict):
    markdown: NotRequired[QuickResponseContentProviderTypeDef],  # (1)
    plainText: NotRequired[QuickResponseContentProviderTypeDef],  # (1)
  1. See QuickResponseContentProviderTypeDef
  2. See QuickResponseContentProviderTypeDef

QuickResponseSearchExpressionTypeDef#

# QuickResponseSearchExpressionTypeDef definition

class QuickResponseSearchExpressionTypeDef(TypedDict):
    filters: NotRequired[Sequence[QuickResponseFilterFieldTypeDef]],  # (1)
    orderOnField: NotRequired[QuickResponseOrderFieldTypeDef],  # (2)
    queries: NotRequired[Sequence[QuickResponseQueryFieldTypeDef]],  # (3)
  1. See QuickResponseFilterFieldTypeDef
  2. See QuickResponseOrderFieldTypeDef
  3. See QuickResponseQueryFieldTypeDef

RuntimeSessionDataTypeDef#

# RuntimeSessionDataTypeDef definition

class RuntimeSessionDataTypeDef(TypedDict):
    key: str,
    value: RuntimeSessionDataValueTypeDef,  # (1)
  1. See RuntimeSessionDataValueTypeDef

SearchSessionsResponseTypeDef#

# SearchSessionsResponseTypeDef definition

class SearchSessionsResponseTypeDef(TypedDict):
    nextToken: str,
    sessionSummaries: List[SessionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SessionSummaryTypeDef
  2. See ResponseMetadataTypeDef

UrlConfigurationExtraOutputTypeDef#

# UrlConfigurationExtraOutputTypeDef definition

class UrlConfigurationExtraOutputTypeDef(TypedDict):
    seedUrls: NotRequired[List[SeedUrlTypeDef]],  # (1)
  1. See SeedUrlTypeDef

UrlConfigurationOutputTypeDef#

# UrlConfigurationOutputTypeDef definition

class UrlConfigurationOutputTypeDef(TypedDict):
    seedUrls: NotRequired[List[SeedUrlTypeDef]],  # (1)
  1. See SeedUrlTypeDef

UrlConfigurationTypeDef#

# UrlConfigurationTypeDef definition

class UrlConfigurationTypeDef(TypedDict):
    seedUrls: NotRequired[Sequence[SeedUrlTypeDef]],  # (1)
  1. See SeedUrlTypeDef

ListAIPromptVersionsResponseTypeDef#

# ListAIPromptVersionsResponseTypeDef definition

class ListAIPromptVersionsResponseTypeDef(TypedDict):
    aiPromptVersionSummaries: List[AIPromptVersionSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AIPromptVersionSummaryTypeDef
  2. See ResponseMetadataTypeDef

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]],
  1. See AIPromptAPIFormatType
  2. See OriginType
  3. See StatusType
  4. See AIPromptTemplateConfigurationTypeDef
  5. See AIPromptTemplateTypeType
  6. See AIPromptTypeType
  7. 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]],
  1. See AIPromptAPIFormatType
  2. See AIPromptTemplateConfigurationTypeDef
  3. See AIPromptTemplateTypeType
  4. See AIPromptTypeType
  5. 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)
  1. See VisibilityStatusType
  2. See AIPromptTemplateConfigurationTypeDef

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]],
  1. See ContentAssociationContentsTypeDef
  2. See ContentAssociationTypeType

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]],
  1. See ContentAssociationContentsTypeDef
  2. See ContentAssociationTypeType

CreateContentAssociationRequestRequestTypeDef#

# CreateContentAssociationRequestRequestTypeDef definition

class CreateContentAssociationRequestRequestTypeDef(TypedDict):
    association: ContentAssociationContentsTypeDef,  # (1)
    associationType: ContentAssociationTypeType,  # (2)
    contentId: str,
    knowledgeBaseId: str,
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See ContentAssociationContentsTypeDef
  2. See ContentAssociationTypeType

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]],
  1. See AssistantAssociationOutputDataTypeDef
  2. See AssociationTypeType

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]],
  1. See AssistantAssociationOutputDataTypeDef
  2. See AssociationTypeType

CreateAssistantResponseTypeDef#

# CreateAssistantResponseTypeDef definition

class CreateAssistantResponseTypeDef(TypedDict):
    assistant: AssistantDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssistantDataTypeDef
  2. See ResponseMetadataTypeDef

GetAssistantResponseTypeDef#

# GetAssistantResponseTypeDef definition

class GetAssistantResponseTypeDef(TypedDict):
    assistant: AssistantDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssistantDataTypeDef
  2. See ResponseMetadataTypeDef

UpdateAssistantAIAgentResponseTypeDef#

# UpdateAssistantAIAgentResponseTypeDef definition

class UpdateAssistantAIAgentResponseTypeDef(TypedDict):
    assistant: AssistantDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssistantDataTypeDef
  2. See ResponseMetadataTypeDef

ListAssistantsResponseTypeDef#

# ListAssistantsResponseTypeDef definition

class ListAssistantsResponseTypeDef(TypedDict):
    assistantSummaries: List[AssistantSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssistantSummaryTypeDef
  2. See ResponseMetadataTypeDef

ParsingConfigurationTypeDef#

# ParsingConfigurationTypeDef definition

class ParsingConfigurationTypeDef(TypedDict):
    parsingStrategy: ParsingStrategyType,  # (2)
    bedrockFoundationModelConfiguration: NotRequired[BedrockFoundationModelConfigurationForParsingTypeDef],  # (1)
  1. See BedrockFoundationModelConfigurationForParsingTypeDef
  2. See ParsingStrategyType

ExternalSourceConfigurationTypeDef#

# ExternalSourceConfigurationTypeDef definition

class ExternalSourceConfigurationTypeDef(TypedDict):
    configuration: ConfigurationTypeDef,  # (1)
    source: ExternalSourceType,  # (2)
  1. See ConfigurationTypeDef
  2. See ExternalSourceType

PutFeedbackRequestRequestTypeDef#

# PutFeedbackRequestRequestTypeDef definition

class PutFeedbackRequestRequestTypeDef(TypedDict):
    assistantId: str,
    contentFeedback: ContentFeedbackDataTypeDef,  # (1)
    targetId: str,
    targetType: TargetTypeType,  # (2)
  1. See ContentFeedbackDataTypeDef
  2. See TargetTypeType

PutFeedbackResponseTypeDef#

# PutFeedbackResponseTypeDef definition

class PutFeedbackResponseTypeDef(TypedDict):
    assistantArn: str,
    assistantId: str,
    contentFeedback: ContentFeedbackDataTypeDef,  # (1)
    targetId: str,
    targetType: TargetTypeType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ContentFeedbackDataTypeDef
  2. See TargetTypeType
  3. See ResponseMetadataTypeDef

DataSummaryTypeDef#

# DataSummaryTypeDef definition

class DataSummaryTypeDef(TypedDict):
    details: DataDetailsTypeDef,  # (1)
    reference: DataReferenceTypeDef,  # (2)
  1. See DataDetailsTypeDef
  2. See DataReferenceTypeDef

DocumentTypeDef#

# DocumentTypeDef definition

class DocumentTypeDef(TypedDict):
    contentReference: ContentReferenceTypeDef,  # (1)
    excerpt: NotRequired[DocumentTextTypeDef],  # (2)
    title: NotRequired[DocumentTextTypeDef],  # (2)
  1. See ContentReferenceTypeDef
  2. See DocumentTextTypeDef
  3. See DocumentTextTypeDef

TextDataTypeDef#

# TextDataTypeDef definition

class TextDataTypeDef(TypedDict):
    excerpt: NotRequired[DocumentTextTypeDef],  # (1)
    title: NotRequired[DocumentTextTypeDef],  # (1)
  1. See DocumentTextTypeDef
  2. See DocumentTextTypeDef

SearchContentRequestRequestTypeDef#

# SearchContentRequestRequestTypeDef definition

class SearchContentRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    searchExpression: SearchExpressionTypeDef,  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See SearchExpressionTypeDef

SearchContentRequestSearchContentPaginateTypeDef#

# SearchContentRequestSearchContentPaginateTypeDef definition

class SearchContentRequestSearchContentPaginateTypeDef(TypedDict):
    knowledgeBaseId: str,
    searchExpression: SearchExpressionTypeDef,  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SearchExpressionTypeDef
  2. See PaginatorConfigTypeDef

SearchSessionsRequestRequestTypeDef#

# SearchSessionsRequestRequestTypeDef definition

class SearchSessionsRequestRequestTypeDef(TypedDict):
    assistantId: str,
    searchExpression: SearchExpressionTypeDef,  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See SearchExpressionTypeDef

SearchSessionsRequestSearchSessionsPaginateTypeDef#

# SearchSessionsRequestSearchSessionsPaginateTypeDef definition

class SearchSessionsRequestSearchSessionsPaginateTypeDef(TypedDict):
    assistantId: str,
    searchExpression: SearchExpressionTypeDef,  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SearchExpressionTypeDef
  2. See PaginatorConfigTypeDef

ChunkingConfigurationExtraOutputTypeDef#

# ChunkingConfigurationExtraOutputTypeDef definition

class ChunkingConfigurationExtraOutputTypeDef(TypedDict):
    chunkingStrategy: ChunkingStrategyType,  # (1)
    fixedSizeChunkingConfiguration: NotRequired[FixedSizeChunkingConfigurationTypeDef],  # (2)
    hierarchicalChunkingConfiguration: NotRequired[HierarchicalChunkingConfigurationExtraOutputTypeDef],  # (3)
    semanticChunkingConfiguration: NotRequired[SemanticChunkingConfigurationTypeDef],  # (4)
  1. See ChunkingStrategyType
  2. See FixedSizeChunkingConfigurationTypeDef
  3. See HierarchicalChunkingConfigurationExtraOutputTypeDef
  4. See SemanticChunkingConfigurationTypeDef

ChunkingConfigurationOutputTypeDef#

# ChunkingConfigurationOutputTypeDef definition

class ChunkingConfigurationOutputTypeDef(TypedDict):
    chunkingStrategy: ChunkingStrategyType,  # (1)
    fixedSizeChunkingConfiguration: NotRequired[FixedSizeChunkingConfigurationTypeDef],  # (2)
    hierarchicalChunkingConfiguration: NotRequired[HierarchicalChunkingConfigurationOutputTypeDef],  # (3)
    semanticChunkingConfiguration: NotRequired[SemanticChunkingConfigurationTypeDef],  # (4)
  1. See ChunkingStrategyType
  2. See FixedSizeChunkingConfigurationTypeDef
  3. See HierarchicalChunkingConfigurationOutputTypeDef
  4. See SemanticChunkingConfigurationTypeDef

ChunkingConfigurationTypeDef#

# ChunkingConfigurationTypeDef definition

class ChunkingConfigurationTypeDef(TypedDict):
    chunkingStrategy: ChunkingStrategyType,  # (1)
    fixedSizeChunkingConfiguration: NotRequired[FixedSizeChunkingConfigurationTypeDef],  # (2)
    hierarchicalChunkingConfiguration: NotRequired[HierarchicalChunkingConfigurationTypeDef],  # (3)
    semanticChunkingConfiguration: NotRequired[SemanticChunkingConfigurationTypeDef],  # (4)
  1. See ChunkingStrategyType
  2. See FixedSizeChunkingConfigurationTypeDef
  3. See HierarchicalChunkingConfigurationTypeDef
  4. See SemanticChunkingConfigurationTypeDef

TagFilterExtraOutputTypeDef#

# TagFilterExtraOutputTypeDef definition

class TagFilterExtraOutputTypeDef(TypedDict):
    andConditions: NotRequired[List[TagConditionTypeDef]],  # (1)
    orConditions: NotRequired[List[OrConditionExtraOutputTypeDef]],  # (2)
    tagCondition: NotRequired[TagConditionTypeDef],  # (3)
  1. See TagConditionTypeDef
  2. See OrConditionExtraOutputTypeDef
  3. See TagConditionTypeDef

TagFilterOutputTypeDef#

# TagFilterOutputTypeDef definition

class TagFilterOutputTypeDef(TypedDict):
    andConditions: NotRequired[List[TagConditionTypeDef]],  # (1)
    orConditions: NotRequired[List[OrConditionOutputTypeDef]],  # (2)
    tagCondition: NotRequired[TagConditionTypeDef],  # (3)
  1. See TagConditionTypeDef
  2. See OrConditionOutputTypeDef
  3. See TagConditionTypeDef

TagFilterTypeDef#

# TagFilterTypeDef definition

class TagFilterTypeDef(TypedDict):
    andConditions: NotRequired[Sequence[TagConditionTypeDef]],  # (1)
    orConditions: NotRequired[Sequence[OrConditionTypeDef]],  # (2)
    tagCondition: NotRequired[TagConditionTypeDef],  # (3)
  1. See TagConditionTypeDef
  2. See OrConditionTypeDef
  3. See TagConditionTypeDef

QueryAssistantRequestQueryAssistantPaginateTypeDef#

# QueryAssistantRequestQueryAssistantPaginateTypeDef definition

class QueryAssistantRequestQueryAssistantPaginateTypeDef(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)
  1. See KnowledgeBaseSearchTypeType
  2. See QueryConditionTypeDef
  3. See QueryInputDataTypeDef
  4. 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],
  1. See KnowledgeBaseSearchTypeType
  2. See QueryConditionTypeDef
  3. See QueryInputDataTypeDef

RecommendationTriggerTypeDef#

# RecommendationTriggerTypeDef definition

class RecommendationTriggerTypeDef(TypedDict):
    data: RecommendationTriggerDataTypeDef,  # (1)
    id: str,
    recommendationIds: List[str],
    source: RecommendationSourceTypeType,  # (2)
    type: RecommendationTriggerTypeType,  # (3)
  1. See RecommendationTriggerDataTypeDef
  2. See RecommendationSourceTypeType
  3. 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]],
  1. See QuickResponseContentsTypeDef
  2. See GroupingConfigurationOutputTypeDef
  3. See QuickResponseStatusType

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]],
  1. See QuickResponseContentsTypeDef
  2. See GroupingConfigurationOutputTypeDef
  3. See QuickResponseStatusType

SearchQuickResponsesRequestRequestTypeDef#

# SearchQuickResponsesRequestRequestTypeDef definition

class SearchQuickResponsesRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    searchExpression: QuickResponseSearchExpressionTypeDef,  # (1)
    attributes: NotRequired[Mapping[str, str]],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See QuickResponseSearchExpressionTypeDef

SearchQuickResponsesRequestSearchQuickResponsesPaginateTypeDef#

# SearchQuickResponsesRequestSearchQuickResponsesPaginateTypeDef definition

class SearchQuickResponsesRequestSearchQuickResponsesPaginateTypeDef(TypedDict):
    knowledgeBaseId: str,
    searchExpression: QuickResponseSearchExpressionTypeDef,  # (1)
    attributes: NotRequired[Mapping[str, str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See QuickResponseSearchExpressionTypeDef
  2. See PaginatorConfigTypeDef

UpdateSessionDataRequestRequestTypeDef#

# UpdateSessionDataRequestRequestTypeDef definition

class UpdateSessionDataRequestRequestTypeDef(TypedDict):
    assistantId: str,
    data: Sequence[RuntimeSessionDataTypeDef],  # (1)
    sessionId: str,
    namespace: NotRequired[SessionDataNamespaceType],  # (2)
  1. See RuntimeSessionDataTypeDef
  2. See SessionDataNamespaceType

UpdateSessionDataResponseTypeDef#

# UpdateSessionDataResponseTypeDef definition

class UpdateSessionDataResponseTypeDef(TypedDict):
    data: List[RuntimeSessionDataTypeDef],  # (1)
    namespace: SessionDataNamespaceType,  # (2)
    sessionArn: str,
    sessionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RuntimeSessionDataTypeDef
  2. See SessionDataNamespaceType
  3. See ResponseMetadataTypeDef

WebCrawlerConfigurationExtraOutputTypeDef#

# WebCrawlerConfigurationExtraOutputTypeDef definition

class WebCrawlerConfigurationExtraOutputTypeDef(TypedDict):
    urlConfiguration: UrlConfigurationExtraOutputTypeDef,  # (3)
    crawlerLimits: NotRequired[WebCrawlerLimitsTypeDef],  # (1)
    exclusionFilters: NotRequired[List[str]],
    inclusionFilters: NotRequired[List[str]],
    scope: NotRequired[WebScopeTypeType],  # (2)
  1. See WebCrawlerLimitsTypeDef
  2. See WebScopeTypeType
  3. See UrlConfigurationExtraOutputTypeDef

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)
  1. See WebCrawlerLimitsTypeDef
  2. See WebScopeTypeType
  3. See UrlConfigurationOutputTypeDef

WebCrawlerConfigurationTypeDef#

# WebCrawlerConfigurationTypeDef definition

class WebCrawlerConfigurationTypeDef(TypedDict):
    urlConfiguration: UrlConfigurationTypeDef,  # (3)
    crawlerLimits: NotRequired[WebCrawlerLimitsTypeDef],  # (1)
    exclusionFilters: NotRequired[Sequence[str]],
    inclusionFilters: NotRequired[Sequence[str]],
    scope: NotRequired[WebScopeTypeType],  # (2)
  1. See WebCrawlerLimitsTypeDef
  2. See WebScopeTypeType
  3. See UrlConfigurationTypeDef

CreateAIPromptResponseTypeDef#

# CreateAIPromptResponseTypeDef definition

class CreateAIPromptResponseTypeDef(TypedDict):
    aiPrompt: AIPromptDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AIPromptDataTypeDef
  2. See ResponseMetadataTypeDef

CreateAIPromptVersionResponseTypeDef#

# CreateAIPromptVersionResponseTypeDef definition

class CreateAIPromptVersionResponseTypeDef(TypedDict):
    aiPrompt: AIPromptDataTypeDef,  # (1)
    versionNumber: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AIPromptDataTypeDef
  2. See ResponseMetadataTypeDef

GetAIPromptResponseTypeDef#

# GetAIPromptResponseTypeDef definition

class GetAIPromptResponseTypeDef(TypedDict):
    aiPrompt: AIPromptDataTypeDef,  # (1)
    versionNumber: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AIPromptDataTypeDef
  2. See ResponseMetadataTypeDef

UpdateAIPromptResponseTypeDef#

# UpdateAIPromptResponseTypeDef definition

class UpdateAIPromptResponseTypeDef(TypedDict):
    aiPrompt: AIPromptDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AIPromptDataTypeDef
  2. See ResponseMetadataTypeDef

CreateContentAssociationResponseTypeDef#

# CreateContentAssociationResponseTypeDef definition

class CreateContentAssociationResponseTypeDef(TypedDict):
    contentAssociation: ContentAssociationDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentAssociationDataTypeDef
  2. See ResponseMetadataTypeDef

GetContentAssociationResponseTypeDef#

# GetContentAssociationResponseTypeDef definition

class GetContentAssociationResponseTypeDef(TypedDict):
    contentAssociation: ContentAssociationDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentAssociationDataTypeDef
  2. See ResponseMetadataTypeDef

ListContentAssociationsResponseTypeDef#

# ListContentAssociationsResponseTypeDef definition

class ListContentAssociationsResponseTypeDef(TypedDict):
    contentAssociationSummaries: List[ContentAssociationSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentAssociationSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateAssistantAssociationResponseTypeDef#

# CreateAssistantAssociationResponseTypeDef definition

class CreateAssistantAssociationResponseTypeDef(TypedDict):
    assistantAssociation: AssistantAssociationDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssistantAssociationDataTypeDef
  2. See ResponseMetadataTypeDef

GetAssistantAssociationResponseTypeDef#

# GetAssistantAssociationResponseTypeDef definition

class GetAssistantAssociationResponseTypeDef(TypedDict):
    assistantAssociation: AssistantAssociationDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssistantAssociationDataTypeDef
  2. See ResponseMetadataTypeDef

ListAssistantAssociationsResponseTypeDef#

# ListAssistantAssociationsResponseTypeDef definition

class ListAssistantAssociationsResponseTypeDef(TypedDict):
    assistantAssociationSummaries: List[AssistantAssociationSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssistantAssociationSummaryTypeDef
  2. See ResponseMetadataTypeDef

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]],
  1. See ExternalSourceConfigurationTypeDef
  2. See ImportJobTypeType
  3. See ImportJobStatusType

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]],
  1. See ExternalSourceConfigurationTypeDef
  2. See ImportJobTypeType
  3. See ImportJobStatusType

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]],
  1. See ImportJobTypeType
  2. See ExternalSourceConfigurationTypeDef

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)
  1. See DataSummaryTypeDef
  2. See DocumentTypeDef
  3. See RelevanceLevelType
  4. 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)
  1. See DataSummaryTypeDef
  2. See DocumentTypeDef
  3. See QueryResultTypeType

ContentDataDetailsTypeDef#

# ContentDataDetailsTypeDef definition

class ContentDataDetailsTypeDef(TypedDict):
    rankingData: RankingDataTypeDef,  # (1)
    textData: TextDataTypeDef,  # (2)
  1. See RankingDataTypeDef
  2. See TextDataTypeDef

SourceContentDataDetailsTypeDef#

# SourceContentDataDetailsTypeDef definition

class SourceContentDataDetailsTypeDef(TypedDict):
    id: str,
    rankingData: RankingDataTypeDef,  # (2)
    textData: TextDataTypeDef,  # (3)
    type: SourceContentTypeType,  # (4)
    citationSpan: NotRequired[CitationSpanTypeDef],  # (1)
  1. See CitationSpanTypeDef
  2. See RankingDataTypeDef
  3. See TextDataTypeDef
  4. See SourceContentTypeType

VectorIngestionConfigurationExtraOutputTypeDef#

# VectorIngestionConfigurationExtraOutputTypeDef definition

class VectorIngestionConfigurationExtraOutputTypeDef(TypedDict):
    chunkingConfiguration: NotRequired[ChunkingConfigurationExtraOutputTypeDef],  # (1)
    parsingConfiguration: NotRequired[ParsingConfigurationTypeDef],  # (2)
  1. See ChunkingConfigurationExtraOutputTypeDef
  2. See ParsingConfigurationTypeDef

VectorIngestionConfigurationOutputTypeDef#

# VectorIngestionConfigurationOutputTypeDef definition

class VectorIngestionConfigurationOutputTypeDef(TypedDict):
    chunkingConfiguration: NotRequired[ChunkingConfigurationOutputTypeDef],  # (1)
    parsingConfiguration: NotRequired[ParsingConfigurationTypeDef],  # (2)
  1. See ChunkingConfigurationOutputTypeDef
  2. See ParsingConfigurationTypeDef

VectorIngestionConfigurationTypeDef#

# VectorIngestionConfigurationTypeDef definition

class VectorIngestionConfigurationTypeDef(TypedDict):
    chunkingConfiguration: NotRequired[ChunkingConfigurationTypeDef],  # (1)
    parsingConfiguration: NotRequired[ParsingConfigurationTypeDef],  # (2)
  1. See ChunkingConfigurationTypeDef
  2. See ParsingConfigurationTypeDef

KnowledgeBaseAssociationConfigurationDataExtraOutputTypeDef#

# KnowledgeBaseAssociationConfigurationDataExtraOutputTypeDef definition

class KnowledgeBaseAssociationConfigurationDataExtraOutputTypeDef(TypedDict):
    contentTagFilter: NotRequired[TagFilterExtraOutputTypeDef],  # (1)
    maxResults: NotRequired[int],
    overrideKnowledgeBaseSearchType: NotRequired[KnowledgeBaseSearchTypeType],  # (2)
  1. See TagFilterExtraOutputTypeDef
  2. See KnowledgeBaseSearchTypeType

KnowledgeBaseAssociationConfigurationDataOutputTypeDef#

# KnowledgeBaseAssociationConfigurationDataOutputTypeDef definition

class KnowledgeBaseAssociationConfigurationDataOutputTypeDef(TypedDict):
    contentTagFilter: NotRequired[TagFilterOutputTypeDef],  # (1)
    maxResults: NotRequired[int],
    overrideKnowledgeBaseSearchType: NotRequired[KnowledgeBaseSearchTypeType],  # (2)
  1. See TagFilterOutputTypeDef
  2. See KnowledgeBaseSearchTypeType

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]],
  1. See AIAgentTypeType AIAgentConfigurationDataTypeDef
  2. See SessionIntegrationConfigurationTypeDef
  3. See TagFilterOutputTypeDef

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]],
  1. See AIAgentTypeType AIAgentConfigurationDataTypeDef
  2. See TagFilterTypeDef

KnowledgeBaseAssociationConfigurationDataTypeDef#

# KnowledgeBaseAssociationConfigurationDataTypeDef definition

class KnowledgeBaseAssociationConfigurationDataTypeDef(TypedDict):
    contentTagFilter: NotRequired[TagFilterTypeDef],  # (1)
    maxResults: NotRequired[int],
    overrideKnowledgeBaseSearchType: NotRequired[KnowledgeBaseSearchTypeType],  # (2)
  1. See TagFilterTypeDef
  2. See KnowledgeBaseSearchTypeType

UpdateSessionRequestRequestTypeDef#

# UpdateSessionRequestRequestTypeDef definition

class UpdateSessionRequestRequestTypeDef(TypedDict):
    assistantId: str,
    sessionId: str,
    aiAgentConfiguration: NotRequired[Mapping[AIAgentTypeType, AIAgentConfigurationDataTypeDef]],  # (1)
    description: NotRequired[str],
    tagFilter: NotRequired[TagFilterTypeDef],  # (2)
  1. See AIAgentTypeType AIAgentConfigurationDataTypeDef
  2. See TagFilterTypeDef

CreateQuickResponseResponseTypeDef#

# CreateQuickResponseResponseTypeDef definition

class CreateQuickResponseResponseTypeDef(TypedDict):
    quickResponse: QuickResponseDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QuickResponseDataTypeDef
  2. See ResponseMetadataTypeDef

GetQuickResponseResponseTypeDef#

# GetQuickResponseResponseTypeDef definition

class GetQuickResponseResponseTypeDef(TypedDict):
    quickResponse: QuickResponseDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QuickResponseDataTypeDef
  2. See ResponseMetadataTypeDef

UpdateQuickResponseResponseTypeDef#

# UpdateQuickResponseResponseTypeDef definition

class UpdateQuickResponseResponseTypeDef(TypedDict):
    quickResponse: QuickResponseDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QuickResponseDataTypeDef
  2. See ResponseMetadataTypeDef

SearchQuickResponsesResponseTypeDef#

# SearchQuickResponsesResponseTypeDef definition

class SearchQuickResponsesResponseTypeDef(TypedDict):
    nextToken: str,
    results: List[QuickResponseSearchResultDataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QuickResponseSearchResultDataTypeDef
  2. See ResponseMetadataTypeDef

ManagedSourceConfigurationExtraOutputTypeDef#

# ManagedSourceConfigurationExtraOutputTypeDef definition

class ManagedSourceConfigurationExtraOutputTypeDef(TypedDict):
    webCrawlerConfiguration: NotRequired[WebCrawlerConfigurationExtraOutputTypeDef],  # (1)
  1. See WebCrawlerConfigurationExtraOutputTypeDef

ManagedSourceConfigurationOutputTypeDef#

# ManagedSourceConfigurationOutputTypeDef definition

class ManagedSourceConfigurationOutputTypeDef(TypedDict):
    webCrawlerConfiguration: NotRequired[WebCrawlerConfigurationOutputTypeDef],  # (1)
  1. See WebCrawlerConfigurationOutputTypeDef

ManagedSourceConfigurationTypeDef#

# ManagedSourceConfigurationTypeDef definition

class ManagedSourceConfigurationTypeDef(TypedDict):
    webCrawlerConfiguration: NotRequired[WebCrawlerConfigurationTypeDef],  # (1)
  1. See WebCrawlerConfigurationTypeDef

GetImportJobResponseTypeDef#

# GetImportJobResponseTypeDef definition

class GetImportJobResponseTypeDef(TypedDict):
    importJob: ImportJobDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImportJobDataTypeDef
  2. See ResponseMetadataTypeDef

StartImportJobResponseTypeDef#

# StartImportJobResponseTypeDef definition

class StartImportJobResponseTypeDef(TypedDict):
    importJob: ImportJobDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImportJobDataTypeDef
  2. See ResponseMetadataTypeDef

ListImportJobsResponseTypeDef#

# ListImportJobsResponseTypeDef definition

class ListImportJobsResponseTypeDef(TypedDict):
    importJobSummaries: List[ImportJobSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImportJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetRecommendationsResponseTypeDef#

# GetRecommendationsResponseTypeDef definition

class GetRecommendationsResponseTypeDef(TypedDict):
    recommendations: List[RecommendationDataTypeDef],  # (1)
    triggers: List[RecommendationTriggerTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RecommendationDataTypeDef
  2. See RecommendationTriggerTypeDef
  3. See ResponseMetadataTypeDef

QueryAssistantResponseTypeDef#

# QueryAssistantResponseTypeDef definition

class QueryAssistantResponseTypeDef(TypedDict):
    nextToken: str,
    results: List[ResultDataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResultDataTypeDef
  2. See ResponseMetadataTypeDef

DataDetailsTypeDef#

# DataDetailsTypeDef definition

class DataDetailsTypeDef(TypedDict):
    contentData: NotRequired[ContentDataDetailsTypeDef],  # (1)
    generativeData: NotRequired[GenerativeDataDetailsTypeDef],  # (2)
    intentDetectedData: NotRequired[IntentDetectedDataDetailsTypeDef],  # (3)
    sourceContentData: NotRequired[SourceContentDataDetailsTypeDef],  # (4)
  1. See ContentDataDetailsTypeDef
  2. See GenerativeDataDetailsTypeDef
  3. See IntentDetectedDataDetailsTypeDef
  4. See SourceContentDataDetailsTypeDef

AssociationConfigurationDataExtraOutputTypeDef#

# AssociationConfigurationDataExtraOutputTypeDef definition

class AssociationConfigurationDataExtraOutputTypeDef(TypedDict):
    knowledgeBaseAssociationConfigurationData: NotRequired[KnowledgeBaseAssociationConfigurationDataExtraOutputTypeDef],  # (1)
  1. See KnowledgeBaseAssociationConfigurationDataExtraOutputTypeDef

AssociationConfigurationDataOutputTypeDef#

# AssociationConfigurationDataOutputTypeDef definition

class AssociationConfigurationDataOutputTypeDef(TypedDict):
    knowledgeBaseAssociationConfigurationData: NotRequired[KnowledgeBaseAssociationConfigurationDataOutputTypeDef],  # (1)
  1. See KnowledgeBaseAssociationConfigurationDataOutputTypeDef

CreateSessionResponseTypeDef#

# CreateSessionResponseTypeDef definition

class CreateSessionResponseTypeDef(TypedDict):
    session: SessionDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SessionDataTypeDef
  2. See ResponseMetadataTypeDef

GetSessionResponseTypeDef#

# GetSessionResponseTypeDef definition

class GetSessionResponseTypeDef(TypedDict):
    session: SessionDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SessionDataTypeDef
  2. See ResponseMetadataTypeDef

UpdateSessionResponseTypeDef#

# UpdateSessionResponseTypeDef definition

class UpdateSessionResponseTypeDef(TypedDict):
    session: SessionDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SessionDataTypeDef
  2. See ResponseMetadataTypeDef

AssociationConfigurationDataTypeDef#

# AssociationConfigurationDataTypeDef definition

class AssociationConfigurationDataTypeDef(TypedDict):
    knowledgeBaseAssociationConfigurationData: NotRequired[KnowledgeBaseAssociationConfigurationDataTypeDef],  # (1)
  1. See KnowledgeBaseAssociationConfigurationDataTypeDef

SourceConfigurationExtraOutputTypeDef#

# SourceConfigurationExtraOutputTypeDef definition

class SourceConfigurationExtraOutputTypeDef(TypedDict):
    appIntegrations: NotRequired[AppIntegrationsConfigurationExtraOutputTypeDef],  # (1)
    managedSourceConfiguration: NotRequired[ManagedSourceConfigurationExtraOutputTypeDef],  # (2)
  1. See AppIntegrationsConfigurationExtraOutputTypeDef
  2. See ManagedSourceConfigurationExtraOutputTypeDef

SourceConfigurationOutputTypeDef#

# SourceConfigurationOutputTypeDef definition

class SourceConfigurationOutputTypeDef(TypedDict):
    appIntegrations: NotRequired[AppIntegrationsConfigurationOutputTypeDef],  # (1)
    managedSourceConfiguration: NotRequired[ManagedSourceConfigurationOutputTypeDef],  # (2)
  1. See AppIntegrationsConfigurationOutputTypeDef
  2. See ManagedSourceConfigurationOutputTypeDef

SourceConfigurationTypeDef#

# SourceConfigurationTypeDef definition

class SourceConfigurationTypeDef(TypedDict):
    appIntegrations: NotRequired[AppIntegrationsConfigurationTypeDef],  # (1)
    managedSourceConfiguration: NotRequired[ManagedSourceConfigurationTypeDef],  # (2)
  1. See AppIntegrationsConfigurationTypeDef
  2. See ManagedSourceConfigurationTypeDef

AssociationConfigurationExtraOutputTypeDef#

# AssociationConfigurationExtraOutputTypeDef definition

class AssociationConfigurationExtraOutputTypeDef(TypedDict):
    associationConfigurationData: NotRequired[AssociationConfigurationDataExtraOutputTypeDef],  # (1)
    associationId: NotRequired[str],
    associationType: NotRequired[AIAgentAssociationConfigurationTypeType],  # (2)
  1. See AssociationConfigurationDataExtraOutputTypeDef
  2. See AIAgentAssociationConfigurationTypeType

AssociationConfigurationOutputTypeDef#

# AssociationConfigurationOutputTypeDef definition

class AssociationConfigurationOutputTypeDef(TypedDict):
    associationConfigurationData: NotRequired[AssociationConfigurationDataOutputTypeDef],  # (1)
    associationId: NotRequired[str],
    associationType: NotRequired[AIAgentAssociationConfigurationTypeType],  # (2)
  1. See AssociationConfigurationDataOutputTypeDef
  2. See AIAgentAssociationConfigurationTypeType

AssociationConfigurationTypeDef#

# AssociationConfigurationTypeDef definition

class AssociationConfigurationTypeDef(TypedDict):
    associationConfigurationData: NotRequired[AssociationConfigurationDataTypeDef],  # (1)
    associationId: NotRequired[str],
    associationType: NotRequired[AIAgentAssociationConfigurationTypeType],  # (2)
  1. See AssociationConfigurationDataTypeDef
  2. See AIAgentAssociationConfigurationTypeType

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)
  1. See SyncStatusType
  2. See KnowledgeBaseTypeType
  3. See RenderingConfigurationTypeDef
  4. See ServerSideEncryptionConfigurationTypeDef
  5. See SourceConfigurationOutputTypeDef
  6. See KnowledgeBaseStatusType
  7. 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)
  1. See KnowledgeBaseTypeType
  2. See RenderingConfigurationTypeDef
  3. See ServerSideEncryptionConfigurationTypeDef
  4. See SourceConfigurationOutputTypeDef
  5. See KnowledgeBaseStatusType
  6. See VectorIngestionConfigurationOutputTypeDef

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)
  1. See KnowledgeBaseTypeType
  2. See RenderingConfigurationTypeDef
  3. See ServerSideEncryptionConfigurationTypeDef
  4. See SourceConfigurationTypeDef
  5. See VectorIngestionConfigurationTypeDef

AnswerRecommendationAIAgentConfigurationExtraOutputTypeDef#

# AnswerRecommendationAIAgentConfigurationExtraOutputTypeDef definition

class AnswerRecommendationAIAgentConfigurationExtraOutputTypeDef(TypedDict):
    answerGenerationAIPromptId: NotRequired[str],
    associationConfigurations: NotRequired[List[AssociationConfigurationExtraOutputTypeDef]],  # (1)
    intentLabelingGenerationAIPromptId: NotRequired[str],
    queryReformulationAIPromptId: NotRequired[str],
  1. See AssociationConfigurationExtraOutputTypeDef

ManualSearchAIAgentConfigurationExtraOutputTypeDef#

# ManualSearchAIAgentConfigurationExtraOutputTypeDef definition

class ManualSearchAIAgentConfigurationExtraOutputTypeDef(TypedDict):
    answerGenerationAIPromptId: NotRequired[str],
    associationConfigurations: NotRequired[List[AssociationConfigurationExtraOutputTypeDef]],  # (1)
  1. See AssociationConfigurationExtraOutputTypeDef

AnswerRecommendationAIAgentConfigurationOutputTypeDef#

# AnswerRecommendationAIAgentConfigurationOutputTypeDef definition

class AnswerRecommendationAIAgentConfigurationOutputTypeDef(TypedDict):
    answerGenerationAIPromptId: NotRequired[str],
    associationConfigurations: NotRequired[List[AssociationConfigurationOutputTypeDef]],  # (1)
    intentLabelingGenerationAIPromptId: NotRequired[str],
    queryReformulationAIPromptId: NotRequired[str],
  1. See AssociationConfigurationOutputTypeDef

ManualSearchAIAgentConfigurationOutputTypeDef#

# ManualSearchAIAgentConfigurationOutputTypeDef definition

class ManualSearchAIAgentConfigurationOutputTypeDef(TypedDict):
    answerGenerationAIPromptId: NotRequired[str],
    associationConfigurations: NotRequired[List[AssociationConfigurationOutputTypeDef]],  # (1)
  1. See AssociationConfigurationOutputTypeDef

AnswerRecommendationAIAgentConfigurationTypeDef#

# AnswerRecommendationAIAgentConfigurationTypeDef definition

class AnswerRecommendationAIAgentConfigurationTypeDef(TypedDict):
    answerGenerationAIPromptId: NotRequired[str],
    associationConfigurations: NotRequired[Sequence[AssociationConfigurationTypeDef]],  # (1)
    intentLabelingGenerationAIPromptId: NotRequired[str],
    queryReformulationAIPromptId: NotRequired[str],
  1. See AssociationConfigurationTypeDef

ManualSearchAIAgentConfigurationTypeDef#

# ManualSearchAIAgentConfigurationTypeDef definition

class ManualSearchAIAgentConfigurationTypeDef(TypedDict):
    answerGenerationAIPromptId: NotRequired[str],
    associationConfigurations: NotRequired[Sequence[AssociationConfigurationTypeDef]],  # (1)
  1. See AssociationConfigurationTypeDef

CreateKnowledgeBaseResponseTypeDef#

# CreateKnowledgeBaseResponseTypeDef definition

class CreateKnowledgeBaseResponseTypeDef(TypedDict):
    knowledgeBase: KnowledgeBaseDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseDataTypeDef
  2. See ResponseMetadataTypeDef

GetKnowledgeBaseResponseTypeDef#

# GetKnowledgeBaseResponseTypeDef definition

class GetKnowledgeBaseResponseTypeDef(TypedDict):
    knowledgeBase: KnowledgeBaseDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseDataTypeDef
  2. See ResponseMetadataTypeDef

UpdateKnowledgeBaseTemplateUriResponseTypeDef#

# UpdateKnowledgeBaseTemplateUriResponseTypeDef definition

class UpdateKnowledgeBaseTemplateUriResponseTypeDef(TypedDict):
    knowledgeBase: KnowledgeBaseDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseDataTypeDef
  2. See ResponseMetadataTypeDef

ListKnowledgeBasesResponseTypeDef#

# ListKnowledgeBasesResponseTypeDef definition

class ListKnowledgeBasesResponseTypeDef(TypedDict):
    knowledgeBaseSummaries: List[KnowledgeBaseSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseSummaryTypeDef
  2. See ResponseMetadataTypeDef

AIAgentConfigurationExtraOutputTypeDef#

# AIAgentConfigurationExtraOutputTypeDef definition

class AIAgentConfigurationExtraOutputTypeDef(TypedDict):
    answerRecommendationAIAgentConfiguration: NotRequired[AnswerRecommendationAIAgentConfigurationExtraOutputTypeDef],  # (1)
    manualSearchAIAgentConfiguration: NotRequired[ManualSearchAIAgentConfigurationExtraOutputTypeDef],  # (2)
  1. See AnswerRecommendationAIAgentConfigurationExtraOutputTypeDef
  2. See ManualSearchAIAgentConfigurationExtraOutputTypeDef

AIAgentConfigurationOutputTypeDef#

# AIAgentConfigurationOutputTypeDef definition

class AIAgentConfigurationOutputTypeDef(TypedDict):
    answerRecommendationAIAgentConfiguration: NotRequired[AnswerRecommendationAIAgentConfigurationOutputTypeDef],  # (1)
    manualSearchAIAgentConfiguration: NotRequired[ManualSearchAIAgentConfigurationOutputTypeDef],  # (2)
  1. See AnswerRecommendationAIAgentConfigurationOutputTypeDef
  2. See ManualSearchAIAgentConfigurationOutputTypeDef

AIAgentConfigurationTypeDef#

# AIAgentConfigurationTypeDef definition

class AIAgentConfigurationTypeDef(TypedDict):
    answerRecommendationAIAgentConfiguration: NotRequired[AnswerRecommendationAIAgentConfigurationTypeDef],  # (1)
    manualSearchAIAgentConfiguration: NotRequired[ManualSearchAIAgentConfigurationTypeDef],  # (2)
  1. See AnswerRecommendationAIAgentConfigurationTypeDef
  2. See ManualSearchAIAgentConfigurationTypeDef

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]],
  1. See AIAgentConfigurationOutputTypeDef
  2. See OriginType
  3. See StatusType
  4. See AIAgentTypeType
  5. 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]],
  1. See AIAgentConfigurationOutputTypeDef
  2. See OriginType
  3. See StatusType
  4. See AIAgentTypeType
  5. See VisibilityStatusType

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]],
  1. See AIAgentConfigurationTypeDef
  2. See AIAgentTypeType
  3. See VisibilityStatusType

UpdateAIAgentRequestRequestTypeDef#

# UpdateAIAgentRequestRequestTypeDef definition

class UpdateAIAgentRequestRequestTypeDef(TypedDict):
    aiAgentId: str,
    assistantId: str,
    visibilityStatus: VisibilityStatusType,  # (1)
    clientToken: NotRequired[str],
    configuration: NotRequired[AIAgentConfigurationTypeDef],  # (2)
    description: NotRequired[str],
  1. See VisibilityStatusType
  2. See AIAgentConfigurationTypeDef

CreateAIAgentResponseTypeDef#

# CreateAIAgentResponseTypeDef definition

class CreateAIAgentResponseTypeDef(TypedDict):
    aiAgent: AIAgentDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AIAgentDataTypeDef
  2. See ResponseMetadataTypeDef

CreateAIAgentVersionResponseTypeDef#

# CreateAIAgentVersionResponseTypeDef definition

class CreateAIAgentVersionResponseTypeDef(TypedDict):
    aiAgent: AIAgentDataTypeDef,  # (1)
    versionNumber: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AIAgentDataTypeDef
  2. See ResponseMetadataTypeDef

GetAIAgentResponseTypeDef#

# GetAIAgentResponseTypeDef definition

class GetAIAgentResponseTypeDef(TypedDict):
    aiAgent: AIAgentDataTypeDef,  # (1)
    versionNumber: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AIAgentDataTypeDef
  2. See ResponseMetadataTypeDef

UpdateAIAgentResponseTypeDef#

# UpdateAIAgentResponseTypeDef definition

class UpdateAIAgentResponseTypeDef(TypedDict):
    aiAgent: AIAgentDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AIAgentDataTypeDef
  2. See ResponseMetadataTypeDef

AIAgentVersionSummaryTypeDef#

# AIAgentVersionSummaryTypeDef definition

class AIAgentVersionSummaryTypeDef(TypedDict):
    aiAgentSummary: NotRequired[AIAgentSummaryTypeDef],  # (1)
    versionNumber: NotRequired[int],
  1. See AIAgentSummaryTypeDef

ListAIAgentsResponseTypeDef#

# ListAIAgentsResponseTypeDef definition

class ListAIAgentsResponseTypeDef(TypedDict):
    aiAgentSummaries: List[AIAgentSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AIAgentSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAIAgentVersionsResponseTypeDef#

# ListAIAgentVersionsResponseTypeDef definition

class ListAIAgentVersionsResponseTypeDef(TypedDict):
    aiAgentVersionSummaries: List[AIAgentVersionSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AIAgentVersionSummaryTypeDef
  2. See ResponseMetadataTypeDef