Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- AppIntegrations
Configuration Configuration information for Amazon AppIntegrations to automatically ingest content.
- Assistant
Association Data Information about the assistant association.
- Assistant
Association Summary Summary information about the assistant association.
- Assistant
Data The assistant data.
- Assistant
Integration Configuration The configuration information for the Wisdom assistant integration.
- Assistant
Summary Summary information about the assistant.
- Connect
Configuration The configuration information of the Amazon Connect data source.
- Content
Data Information about the content.
- Content
Reference Reference information about the content.
- Content
Summary Summary information about the content.
- Document
The document.
- Document
Text The text of the document.
- External
Source Configuration The configuration information of the external data source.
- Filter
A search filter.
- Grouping
Configuration The configuration information of the grouping of Wisdom users.
- Highlight
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
- Import
JobData Summary information about the import job.
- Import
JobSummary Summary information about the import job.
- Knowledge
Base Association Data Association information about the knowledge base.
- Knowledge
Base Data Information about the knowledge base.
- Knowledge
Base Summary Summary information about the knowledge base.
- Notify
Recommendations Received Error An error occurred when creating a recommendation.
- Query
Recommendation Trigger Data Data associated with the QUERY RecommendationTriggerType.
- Quick
Response Contents The content of the quick response stored in different media types.
- Quick
Response Data Information about the quick response.
- Quick
Response Filter Field The quick response fields to filter the quick response query results by.
The following is the list of supported field names.
-
name
-
description
-
shortcutKey
-
isActive
-
channels
-
language
-
contentType
-
createdTime
-
lastModifiedTime
-
lastModifiedBy
-
groupingConfiguration.criteria
-
groupingConfiguration.values
-
- Quick
Response Order Field The quick response fields to order the quick response query results by.
The following is the list of supported field names.
-
name
-
description
-
shortcutKey
-
isActive
-
channels
-
language
-
contentType
-
createdTime
-
lastModifiedTime
-
lastModifiedBy
-
groupingConfiguration.criteria
-
groupingConfiguration.values
-
- Quick
Response Query Field The quick response fields to query quick responses by.
The following is the list of supported field names.
-
content
-
name
-
description
-
shortcutKey
-
- Quick
Response Search Expression Information about the import job.
- Quick
Response Search Result Data The result of quick response search.
- Quick
Response Summary The summary information about the quick response.
- Recommendation
Data Information about the recommendation.
- Recommendation
Trigger A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in
recommendationIds
by a single RecommendationTrigger.- Rendering
Configuration Information about how to render the content.
- Result
Data Information about the result.
- Search
Expression The search expression.
- Server
Side Encryption Configuration The configuration information for the customer managed key used for encryption.
- Session
Data Information about the session.
- Session
Integration Configuration The configuration information for the session integration.
- Session
Summary Summary information about the session.
Enums§
- Assistant
Association Input Data The data that is input into Wisdom as a result of the assistant association.
- Assistant
Association Output Data The data that is output as a result of the assistant association.
- Assistant
Status - When writing a match expression against
AssistantStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Assistant
Type - When writing a match expression against
AssistantType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Association
Type - When writing a match expression against
AssociationType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Configuration
The configuration information of the external data source.
- Content
Status - When writing a match expression against
ContentStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - External
Source - When writing a match expression against
ExternalSource
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Filter
Field - When writing a match expression against
FilterField
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Filter
Operator - When writing a match expression against
FilterOperator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Import
JobStatus - When writing a match expression against
ImportJobStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Import
JobType - When writing a match expression against
ImportJobType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Knowledge
Base Status - When writing a match expression against
KnowledgeBaseStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Knowledge
Base Type - When writing a match expression against
KnowledgeBaseType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Order
- When writing a match expression against
Order
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Priority
- When writing a match expression against
Priority
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Quick
Response Content Provider The container quick response content.
- Quick
Response Data Provider The container of quick response data.
- Quick
Response Filter Operator - When writing a match expression against
QuickResponseFilterOperator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Quick
Response Query Operator - When writing a match expression against
QuickResponseQueryOperator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Quick
Response Status - When writing a match expression against
QuickResponseStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Recommendation
Source Type - When writing a match expression against
RecommendationSourceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Recommendation
Trigger Data A union type containing information related to the trigger.
- Recommendation
Trigger Type - When writing a match expression against
RecommendationTriggerType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Recommendation
Type - When writing a match expression against
RecommendationType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Relevance
Level - When writing a match expression against
RelevanceLevel
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Source
Configuration Configuration information about the external data source.