Skip to content

Wisdom Classes

AppIntegrationsConfiguration

appIntegrationArn

  • Type:
  • Required: Yes

objectFields

  • Type: typing.Optional[typing.List[str]]

AppIntegrationsConfigurationOutput

appIntegrationArn

  • Type:
  • Required: Yes

objectFields

  • Type: typing.Optional[typing.List[str]]

AssistantAssociationData

assistantArn

  • Type:
  • Required: Yes

assistantAssociationArn

  • Type:
  • Required: Yes

assistantAssociationId

  • Type:
  • Required: Yes

assistantId

  • Type:
  • Required: Yes

associationData

  • Type:
  • Required: Yes

associationType

  • Type: typing.Literal['KNOWLEDGE_BASE']
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

AssistantAssociationInputData

knowledgeBaseId

  • Type: typing.Optional[str]

AssistantAssociationOutputData

knowledgeBaseAssociation

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.KnowledgeBaseAssociationData]

AssistantAssociationSummary

assistantArn

  • Type:
  • Required: Yes

assistantAssociationArn

  • Type:
  • Required: Yes

assistantAssociationId

  • Type:
  • Required: Yes

assistantId

  • Type:
  • Required: Yes

associationData

  • Type:
  • Required: Yes

associationType

  • Type: typing.Literal['KNOWLEDGE_BASE']
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

AssistantData

assistantArn

  • Type:
  • Required: Yes

assistantId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']
  • Required: Yes

type

  • Type: typing.Literal['AGENT']
  • Required: Yes

description

  • Type: typing.Optional[str]

integrationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.AssistantIntegrationConfiguration]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.ServerSideEncryptionConfiguration]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

AssistantIntegrationConfiguration

topicIntegrationArn

  • Type: typing.Optional[str]

AssistantSummary

assistantArn

  • Type:
  • Required: Yes

assistantId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']
  • Required: Yes

type

  • Type: typing.Literal['AGENT']
  • Required: Yes

description

  • Type: typing.Optional[str]

integrationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.AssistantIntegrationConfiguration]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.ServerSideEncryptionConfiguration]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

Configuration

connectConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.ConnectConfiguration]

ConnectConfiguration

instanceId

  • Type: typing.Optional[str]

ContentData

contentArn

  • Type:
  • Required: Yes

contentId

  • Type:
  • Required: Yes

contentType

  • Type:
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

metadata

  • Type: typing.Dict[str, str]
  • Required: Yes

name

  • Type:
  • Required: Yes

revisionId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_FAILED']
  • Required: Yes

title

  • Type:
  • Required: Yes

url

  • Type:
  • Required: Yes

urlExpiry

  • Type:
  • Required: Yes

linkOutUri

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

ContentReference

contentArn

  • Type: typing.Optional[str]

contentId

  • Type: typing.Optional[str]

knowledgeBaseArn

  • Type: typing.Optional[str]

knowledgeBaseId

  • Type: typing.Optional[str]

ContentSummary

contentArn

  • Type:
  • Required: Yes

contentId

  • Type:
  • Required: Yes

contentType

  • Type:
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

metadata

  • Type: typing.Dict[str, str]
  • Required: Yes

name

  • Type:
  • Required: Yes

revisionId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_FAILED']
  • Required: Yes

title

  • Type:
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateAssistantAssociationRequest

assistantId

  • Type:
  • Required: Yes

association

  • Type:
  • Required: Yes

associationType

  • Type: typing.Literal['KNOWLEDGE_BASE']
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateAssistantAssociationResponse

assistantAssociation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateAssistantRequest

name

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['AGENT']
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.ServerSideEncryptionConfiguration]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateAssistantResponse

assistant

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateContentRequest

knowledgeBaseId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

uploadId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

metadata

  • Type: typing.Optional[typing.Dict[str, str]]

overrideLinkOutUri

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

title

  • Type: typing.Optional[str]

CreateContentResponse

content

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateKnowledgeBaseRequest

knowledgeBaseType

  • Type: typing.Literal['CUSTOM', 'EXTERNAL', 'QUICK_RESPONSES']
  • Required: Yes

name

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

renderingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.RenderingConfiguration]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.ServerSideEncryptionConfiguration]

sourceConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.SourceConfiguration, aws_resource_validator.pydantic_models.wisdom.wisdom_classes.SourceConfigurationOutput, NoneType]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateKnowledgeBaseResponse

knowledgeBase

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateQuickResponseRequest

content

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

channels

  • Type: typing.Optional[typing.List[str]]

clientToken

  • Type: typing.Optional[str]

contentType

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

groupingConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.GroupingConfiguration, aws_resource_validator.pydantic_models.wisdom.wisdom_classes.GroupingConfigurationOutput, NoneType]

isActive

  • Type: typing.Optional[bool]

language

  • Type: typing.Optional[str]

shortcutKey

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateQuickResponseResponse

quickResponse

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateSessionRequest

assistantId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateSessionResponse

session

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteAssistantAssociationRequest

assistantAssociationId

  • Type:
  • Required: Yes

assistantId

  • Type:
  • Required: Yes

DeleteAssistantRequest

assistantId

  • Type:
  • Required: Yes

DeleteContentRequest

contentId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

DeleteImportJobRequest

importJobId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

DeleteKnowledgeBaseRequest

knowledgeBaseId

  • Type:
  • Required: Yes

DeleteQuickResponseRequest

knowledgeBaseId

  • Type:
  • Required: Yes

quickResponseId

  • Type:
  • Required: Yes

Document

contentReference

  • Type:
  • Required: Yes

excerpt

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.DocumentText]

title

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.DocumentText]

DocumentText

highlights

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.Highlight]]

text

  • Type: typing.Optional[str]

ExternalSourceConfiguration

configuration

  • Type:
  • Required: Yes

source

  • Type: typing.Literal['AMAZON_CONNECT']
  • Required: Yes

Filter

field

  • Type: typing.Literal['NAME']
  • Required: Yes

operator

  • Type: typing.Literal['EQUALS']
  • Required: Yes

value

  • Type:
  • Required: Yes

GetAssistantAssociationRequest

assistantAssociationId

  • Type:
  • Required: Yes

assistantId

  • Type:
  • Required: Yes

GetAssistantAssociationResponse

assistantAssociation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetAssistantRequest

assistantId

  • Type:
  • Required: Yes

GetAssistantResponse

assistant

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetContentRequest

contentId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

GetContentResponse

content

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetContentSummaryRequest

contentId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

GetContentSummaryResponse

contentSummary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetImportJobRequest

importJobId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

GetImportJobResponse

importJob

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetKnowledgeBaseRequest

knowledgeBaseId

  • Type:
  • Required: Yes

GetKnowledgeBaseResponse

knowledgeBase

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetQuickResponseRequest

knowledgeBaseId

  • Type:
  • Required: Yes

quickResponseId

  • Type:
  • Required: Yes

GetQuickResponseResponse

quickResponse

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetRecommendationsRequest

assistantId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

waitTimeSeconds

  • Type: typing.Optional[int]

GetRecommendationsResponse

recommendations

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.RecommendationData]
  • Required: Yes

triggers

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.RecommendationTrigger]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSessionRequest

assistantId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

GetSessionResponse

session

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GroupingConfiguration

criteria

  • Type: typing.Optional[str]

values

  • Type: typing.Optional[typing.List[str]]

GroupingConfigurationOutput

criteria

  • Type: typing.Optional[str]

values

  • Type: typing.Optional[typing.List[str]]

Highlight

beginOffsetInclusive

  • Type: typing.Optional[int]

endOffsetExclusive

  • Type: typing.Optional[int]

ImportJobData

createdTime

  • Type:
  • Required: Yes

importJobId

  • Type:
  • Required: Yes

importJobType

  • Type: typing.Literal['QUICK_RESPONSES']
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

lastModifiedTime

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['COMPLETE', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'FAILED', 'START_IN_PROGRESS']
  • Required: Yes

uploadId

  • Type:
  • Required: Yes

url

  • Type:
  • Required: Yes

urlExpiry

  • Type:
  • Required: Yes

externalSourceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.ExternalSourceConfiguration]

failedRecordReport

  • Type: typing.Optional[str]

metadata

  • Type: typing.Optional[typing.Dict[str, str]]

ImportJobSummary

createdTime

  • Type:
  • Required: Yes

importJobId

  • Type:
  • Required: Yes

importJobType

  • Type: typing.Literal['QUICK_RESPONSES']
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

lastModifiedTime

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['COMPLETE', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'FAILED', 'START_IN_PROGRESS']
  • Required: Yes

uploadId

  • Type:
  • Required: Yes

externalSourceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.ExternalSourceConfiguration]

metadata

  • Type: typing.Optional[typing.Dict[str, str]]

KnowledgeBaseAssociationData

knowledgeBaseArn

  • Type: typing.Optional[str]

knowledgeBaseId

  • Type: typing.Optional[str]

KnowledgeBaseData

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

knowledgeBaseType

  • Type: typing.Literal['CUSTOM', 'EXTERNAL', 'QUICK_RESPONSES']
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']
  • Required: Yes

description

  • Type: typing.Optional[str]

lastContentModificationTime

  • Type: typing.Optional[datetime.datetime]

renderingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.RenderingConfiguration]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.ServerSideEncryptionConfiguration]

sourceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.SourceConfigurationOutput]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

KnowledgeBaseSummary

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

knowledgeBaseType

  • Type: typing.Literal['CUSTOM', 'EXTERNAL', 'QUICK_RESPONSES']
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']
  • Required: Yes

description

  • Type: typing.Optional[str]

renderingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.RenderingConfiguration]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.ServerSideEncryptionConfiguration]

sourceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.SourceConfigurationOutput]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

ListAssistantAssociationsRequest

assistantId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListAssistantAssociationsRequestPaginate

assistantId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.PaginatorConfig]

ListAssistantAssociationsResponse

assistantAssociationSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.AssistantAssociationSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListAssistantsRequest

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListAssistantsRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.PaginatorConfig]

ListAssistantsResponse

assistantSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.AssistantSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListContentsRequest

knowledgeBaseId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListContentsRequestPaginate

knowledgeBaseId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.PaginatorConfig]

ListContentsResponse

contentSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.ContentSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListImportJobsRequest

knowledgeBaseId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListImportJobsRequestPaginate

knowledgeBaseId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.PaginatorConfig]

ListImportJobsResponse

importJobSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.ImportJobSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListKnowledgeBasesRequest

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListKnowledgeBasesRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.PaginatorConfig]

ListKnowledgeBasesResponse

knowledgeBaseSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.KnowledgeBaseSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListQuickResponsesRequest

knowledgeBaseId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListQuickResponsesRequestPaginate

knowledgeBaseId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.PaginatorConfig]

ListQuickResponsesResponse

quickResponseSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.QuickResponseSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NotifyRecommendationsReceivedError

message

  • Type: typing.Optional[str]

recommendationId

  • Type: typing.Optional[str]

NotifyRecommendationsReceivedRequest

assistantId

  • Type:
  • Required: Yes

recommendationIds

  • Type: typing.List[str]
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

NotifyRecommendationsReceivedResponse

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.NotifyRecommendationsReceivedError]
  • Required: Yes

recommendationIds

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

QueryAssistantRequest

assistantId

  • Type:
  • Required: Yes

queryText

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

QueryAssistantRequestPaginate

assistantId

  • Type:
  • Required: Yes

queryText

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.PaginatorConfig]

QueryAssistantResponse

results

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.ResultData]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

QueryRecommendationTriggerData

text

  • Type: typing.Optional[str]

QuickResponseContentProvider

content

  • Type: typing.Optional[str]

QuickResponseContents

markdown

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.QuickResponseContentProvider]

plainText

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.QuickResponseContentProvider]

QuickResponseData

contentType

  • Type:
  • Required: Yes

createdTime

  • Type:
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

lastModifiedTime

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

quickResponseArn

  • Type:
  • Required: Yes

quickResponseId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CREATED', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_FAILED', 'UPDATE_IN_PROGRESS']
  • Required: Yes

channels

  • Type: typing.Optional[typing.List[str]]

contents

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.QuickResponseContents]

description

  • Type: typing.Optional[str]

groupingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.GroupingConfigurationOutput]

isActive

  • Type: typing.Optional[bool]

language

  • Type: typing.Optional[str]

lastModifiedBy

  • Type: typing.Optional[str]

shortcutKey

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

QuickResponseDataProvider

content

  • Type: typing.Optional[str]

QuickResponseFilterField

name

  • Type:
  • Required: Yes

operator

  • Type: typing.Literal['EQUALS', 'PREFIX']
  • Required: Yes

includeNoExistence

  • Type: typing.Optional[bool]

values

  • Type: typing.Optional[typing.List[str]]

QuickResponseOrderField

name

  • Type:
  • Required: Yes

order

  • Type: typing.Optional[typing.Literal['ASC', 'DESC']]

QuickResponseQueryField

name

  • Type:
  • Required: Yes

operator

  • Type: typing.Literal['CONTAINS', 'CONTAINS_AND_PREFIX']
  • Required: Yes

values

  • Type: typing.List[str]
  • Required: Yes

allowFuzziness

  • Type: typing.Optional[bool]

priority

  • Type: typing.Optional[typing.Literal['HIGH', 'LOW', 'MEDIUM']]

QuickResponseSearchExpression

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.QuickResponseFilterField]]

orderOnField

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.QuickResponseOrderField]

queries

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.QuickResponseQueryField]]

QuickResponseSearchResultData

contentType

  • Type:
  • Required: Yes

contents

  • Type:
  • Required: Yes

createdTime

  • Type:
  • Required: Yes

isActive

  • Type:
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

lastModifiedTime

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

quickResponseArn

  • Type:
  • Required: Yes

quickResponseId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CREATED', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_FAILED', 'UPDATE_IN_PROGRESS']
  • Required: Yes

attributesInterpolated

  • Type: typing.Optional[typing.List[str]]

attributesNotInterpolated

  • Type: typing.Optional[typing.List[str]]

channels

  • Type: typing.Optional[typing.List[str]]

description

  • Type: typing.Optional[str]

groupingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.GroupingConfigurationOutput]

language

  • Type: typing.Optional[str]

lastModifiedBy

  • Type: typing.Optional[str]

shortcutKey

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

QuickResponseSummary

contentType

  • Type:
  • Required: Yes

createdTime

  • Type:
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

lastModifiedTime

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

quickResponseArn

  • Type:
  • Required: Yes

quickResponseId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CREATED', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_FAILED', 'UPDATE_IN_PROGRESS']
  • Required: Yes

channels

  • Type: typing.Optional[typing.List[str]]

description

  • Type: typing.Optional[str]

isActive

  • Type: typing.Optional[bool]

lastModifiedBy

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

RecommendationData

document

  • Type:
  • Required: Yes

recommendationId

  • Type:
  • Required: Yes

relevanceLevel

  • Type: typing.Optional[typing.Literal['HIGH', 'LOW', 'MEDIUM']]

relevanceScore

  • Type: typing.Optional[float]

type

  • Type: typing.Optional[typing.Literal['KNOWLEDGE_CONTENT']]

RecommendationTrigger

data

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

recommendationIds

  • Type: typing.List[str]
  • Required: Yes

source

  • Type: typing.Literal['ISSUE_DETECTION', 'OTHER', 'RULE_EVALUATION']
  • Required: Yes

type

  • Type: typing.Literal['QUERY']
  • Required: Yes

RecommendationTriggerData

query

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.QueryRecommendationTriggerData]

RemoveKnowledgeBaseTemplateUriRequest

knowledgeBaseId

  • Type:
  • Required: Yes

RenderingConfiguration

templateUri

  • Type: typing.Optional[str]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

ResultData

document

  • Type:
  • Required: Yes

resultId

  • Type:
  • Required: Yes

relevanceScore

  • Type: typing.Optional[float]

SearchContentRequest

knowledgeBaseId

  • Type:
  • Required: Yes

searchExpression

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchContentRequestPaginate

knowledgeBaseId

  • Type:
  • Required: Yes

searchExpression

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.PaginatorConfig]

SearchContentResponse

contentSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.ContentSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

SearchExpression

filters

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.Filter]
  • Required: Yes

SearchQuickResponsesRequest

knowledgeBaseId

  • Type:
  • Required: Yes

searchExpression

  • Type:
  • Required: Yes

attributes

  • Type: typing.Optional[typing.Dict[str, str]]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchQuickResponsesRequestPaginate

knowledgeBaseId

  • Type:
  • Required: Yes

searchExpression

  • Type:
  • Required: Yes

attributes

  • Type: typing.Optional[typing.Dict[str, str]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.PaginatorConfig]

SearchQuickResponsesResponse

results

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.QuickResponseSearchResultData]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

SearchSessionsRequest

assistantId

  • Type:
  • Required: Yes

searchExpression

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchSessionsRequestPaginate

assistantId

  • Type:
  • Required: Yes

searchExpression

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.PaginatorConfig]

SearchSessionsResponse

sessionSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.SessionSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ServerSideEncryptionConfiguration

kmsKeyId

  • Type: typing.Optional[str]

SessionData

name

  • Type:
  • Required: Yes

sessionArn

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

integrationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.SessionIntegrationConfiguration]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

SessionIntegrationConfiguration

topicIntegrationArn

  • Type: typing.Optional[str]

SessionSummary

assistantArn

  • Type:
  • Required: Yes

assistantId

  • Type:
  • Required: Yes

sessionArn

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

SourceConfiguration

appIntegrations

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.AppIntegrationsConfiguration]

SourceConfigurationOutput

appIntegrations

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.AppIntegrationsConfigurationOutput]

StartContentUploadRequest

contentType

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

presignedUrlTimeToLive

  • Type: typing.Optional[int]

StartContentUploadResponse

headersToInclude

  • Type: typing.Dict[str, str]
  • Required: Yes

uploadId

  • Type:
  • Required: Yes

url

  • Type:
  • Required: Yes

urlExpiry

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartImportJobRequest

importJobType

  • Type: typing.Literal['QUICK_RESPONSES']
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

uploadId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

externalSourceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.ExternalSourceConfiguration]

metadata

  • Type: typing.Optional[typing.Dict[str, str]]

StartImportJobResponse

importJob

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

UntagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateContentRequest

contentId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

metadata

  • Type: typing.Optional[typing.Dict[str, str]]

overrideLinkOutUri

  • Type: typing.Optional[str]

removeOverrideLinkOutUri

  • Type: typing.Optional[bool]

revisionId

  • Type: typing.Optional[str]

title

  • Type: typing.Optional[str]

uploadId

  • Type: typing.Optional[str]

UpdateContentResponse

content

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateKnowledgeBaseTemplateUriRequest

knowledgeBaseId

  • Type:
  • Required: Yes

templateUri

  • Type:
  • Required: Yes

UpdateKnowledgeBaseTemplateUriResponse

knowledgeBase

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateQuickResponseRequest

knowledgeBaseId

  • Type:
  • Required: Yes

quickResponseId

  • Type:
  • Required: Yes

channels

  • Type: typing.Optional[typing.List[str]]

content

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.QuickResponseDataProvider]

contentType

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

groupingConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.wisdom.wisdom_classes.GroupingConfiguration, aws_resource_validator.pydantic_models.wisdom.wisdom_classes.GroupingConfigurationOutput, NoneType]

isActive

  • Type: typing.Optional[bool]

language

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

removeDescription

  • Type: typing.Optional[bool]

removeGroupingConfiguration

  • Type: typing.Optional[bool]

removeShortcutKey

  • Type: typing.Optional[bool]

shortcutKey

  • Type: typing.Optional[str]

UpdateQuickResponseResponse

quickResponse

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes