Skip to content

Type definitions#

Index > QConnect > Type definitions

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

AppIntegrationsConfigurationPaginatorTypeDef#

# AppIntegrationsConfigurationPaginatorTypeDef definition

class AppIntegrationsConfigurationPaginatorTypeDef(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],

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],

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],

CreateSessionRequestRequestTypeDef#

# CreateSessionRequestRequestTypeDef definition

class CreateSessionRequestRequestTypeDef(TypedDict):
    assistantId: str,
    name: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

GenerativeReferenceTypeDef#

# GenerativeReferenceTypeDef definition

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

DeleteAssistantAssociationRequestRequestTypeDef#

# DeleteAssistantAssociationRequestRequestTypeDef definition

class DeleteAssistantAssociationRequestRequestTypeDef(TypedDict):
    assistantAssociationId: str,
    assistantId: str,

DeleteAssistantRequestRequestTypeDef#

# DeleteAssistantRequestRequestTypeDef definition

class DeleteAssistantRequestRequestTypeDef(TypedDict):
    assistantId: str,

DeleteContentRequestRequestTypeDef#

# DeleteContentRequestRequestTypeDef definition

class DeleteContentRequestRequestTypeDef(TypedDict):
    contentId: str,
    knowledgeBaseId: str,

DeleteImportJobRequestRequestTypeDef#

# DeleteImportJobRequestRequestTypeDef definition

class DeleteImportJobRequestRequestTypeDef(TypedDict):
    importJobId: str,
    knowledgeBaseId: str,

DeleteKnowledgeBaseRequestRequestTypeDef#

# DeleteKnowledgeBaseRequestRequestTypeDef definition

class DeleteKnowledgeBaseRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,

DeleteQuickResponseRequestRequestTypeDef#

# DeleteQuickResponseRequestRequestTypeDef definition

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

HighlightTypeDef#

# HighlightTypeDef definition

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

FilterTypeDef#

# FilterTypeDef definition

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

GetAssistantAssociationRequestRequestTypeDef#

# GetAssistantAssociationRequestRequestTypeDef definition

class GetAssistantAssociationRequestRequestTypeDef(TypedDict):
    assistantAssociationId: str,
    assistantId: str,

GetAssistantRequestRequestTypeDef#

# GetAssistantRequestRequestTypeDef definition

class GetAssistantRequestRequestTypeDef(TypedDict):
    assistantId: str,

GetContentRequestRequestTypeDef#

# GetContentRequestRequestTypeDef definition

class GetContentRequestRequestTypeDef(TypedDict):
    contentId: str,
    knowledgeBaseId: str,

GetContentSummaryRequestRequestTypeDef#

# GetContentSummaryRequestRequestTypeDef definition

class GetContentSummaryRequestRequestTypeDef(TypedDict):
    contentId: str,
    knowledgeBaseId: str,

GetImportJobRequestRequestTypeDef#

# GetImportJobRequestRequestTypeDef definition

class GetImportJobRequestRequestTypeDef(TypedDict):
    importJobId: str,
    knowledgeBaseId: str,

GetKnowledgeBaseRequestRequestTypeDef#

# GetKnowledgeBaseRequestRequestTypeDef definition

class GetKnowledgeBaseRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,

GetQuickResponseRequestRequestTypeDef#

# GetQuickResponseRequestRequestTypeDef definition

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

GetRecommendationsRequestRequestTypeDef#

# GetRecommendationsRequestRequestTypeDef definition

class GetRecommendationsRequestRequestTypeDef(TypedDict):
    assistantId: str,
    sessionId: str,
    maxResults: NotRequired[int],
    waitTimeSeconds: NotRequired[int],

GetSessionRequestRequestTypeDef#

# GetSessionRequestRequestTypeDef definition

class GetSessionRequestRequestTypeDef(TypedDict):
    assistantId: str,
    sessionId: str,

GroupingConfigurationPaginatorTypeDef#

# GroupingConfigurationPaginatorTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAssistantAssociationsRequestRequestTypeDef#

# ListAssistantAssociationsRequestRequestTypeDef definition

class ListAssistantAssociationsRequestRequestTypeDef(TypedDict):
    assistantId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListAssistantsRequestRequestTypeDef#

# ListAssistantsRequestRequestTypeDef definition

class ListAssistantsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListContentsRequestRequestTypeDef#

# ListContentsRequestRequestTypeDef definition

class ListContentsRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListImportJobsRequestRequestTypeDef#

# ListImportJobsRequestRequestTypeDef definition

class ListImportJobsRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListKnowledgeBasesRequestRequestTypeDef#

# ListKnowledgeBasesRequestRequestTypeDef definition

class ListKnowledgeBasesRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListQuickResponsesRequestRequestTypeDef#

# ListQuickResponsesRequestRequestTypeDe