Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

ChunkingStrategy

sealed class ChunkingStrategy

CitationSpan

class CitationSpan

Contains information about where the text with a citation begins and ends in the generated output.

Configuration

sealed class Configuration

The configuration information of the external data source.

ConflictException

class ConflictException : QConnectException

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ConnectConfiguration

class ConnectConfiguration

The configuration information of the Amazon Connect data source.

ContentAssociationContents

sealed class ContentAssociationContents

The contents of a content association.

ContentAssociationData

class ContentAssociationData

Information about the content association.

ContentAssociationSummary

class ContentAssociationSummary

Summary information about a content association.

ContentAssociationType

sealed class ContentAssociationType

ContentData

class ContentData

Information about the content.

ContentDataDetails

class ContentDataDetails

Details about the content data.

ContentDisposition

sealed class ContentDisposition

ContentFeedbackData

sealed class ContentFeedbackData

Information about the feedback.

ContentReference

class ContentReference

Reference information about the content.

ContentStatus

sealed class ContentStatus

ContentSummary

class ContentSummary

Summary information about the content.

ConversationContext

class ConversationContext

The conversation context to include in SendMessage.

ConversationState

class ConversationState

The conversation state associated to a message.

ConversationStatus

sealed class ConversationStatus

ConversationStatusReason

sealed class ConversationStatusReason

CreateAiAgentRequest

class CreateAiAgentRequest

CreateAiAgentResponse

class CreateAiAgentResponse

CreateAiAgentVersionRequest

class CreateAiAgentVersionRequest

CreateAiAgentVersionResponse

class CreateAiAgentVersionResponse

CreateAiGuardrailRequest

class CreateAiGuardrailRequest

CreateAiGuardrailResponse

class CreateAiGuardrailResponse

CreateAiGuardrailVersionRequest

class CreateAiGuardrailVersionRequest

CreateAiGuardrailVersionResponse

class CreateAiGuardrailVersionResponse

CreateAiPromptRequest

class CreateAiPromptRequest

CreateAiPromptResponse

class CreateAiPromptResponse

CreateAiPromptVersionRequest

class CreateAiPromptVersionRequest

CreateAiPromptVersionResponse

class CreateAiPromptVersionResponse

CreateAssistantAssociationRequest

class CreateAssistantAssociationRequest

CreateAssistantAssociationResponse

class CreateAssistantAssociationResponse

CreateAssistantRequest

class CreateAssistantRequest

CreateAssistantResponse

class CreateAssistantResponse

CreateContentAssociationRequest

class CreateContentAssociationRequest

CreateContentAssociationResponse

class CreateContentAssociationResponse

CreateContentRequest

class CreateContentRequest

CreateContentResponse

class CreateContentResponse

CreateKnowledgeBaseRequest

class CreateKnowledgeBaseRequest

CreateKnowledgeBaseResponse

class CreateKnowledgeBaseResponse

CreateMessageTemplateAttachmentRequest

class CreateMessageTemplateAttachmentRequest

CreateMessageTemplateAttachmentResponse

class CreateMessageTemplateAttachmentResponse

CreateMessageTemplateRequest

class CreateMessageTemplateRequest

CreateMessageTemplateResponse

class CreateMessageTemplateResponse

CreateMessageTemplateVersionRequest

class CreateMessageTemplateVersionRequest

CreateMessageTemplateVersionResponse

class CreateMessageTemplateVersionResponse

CreateQuickResponseRequest

class CreateQuickResponseRequest

CreateQuickResponseResponse

class CreateQuickResponseResponse

CreateSessionRequest

class CreateSessionRequest

CreateSessionResponse

class CreateSessionResponse

CustomerProfileAttributes

class CustomerProfileAttributes

The customer profile attributes that are used with the message template.

DataDetails

sealed class DataDetails

Details about the data.

DataReference

sealed class DataReference

Reference data.

DataSummary

class DataSummary

Summary of the data.

DeactivateMessageTemplateRequest

class DeactivateMessageTemplateRequest

DeactivateMessageTemplateResponse

class DeactivateMessageTemplateResponse

DeleteAiAgentRequest

class DeleteAiAgentRequest

DeleteAiAgentResponse

class DeleteAiAgentResponse

DeleteAiAgentVersionRequest

class DeleteAiAgentVersionRequest

DeleteAiAgentVersionResponse

class DeleteAiAgentVersionResponse

DeleteAiGuardrailRequest

class DeleteAiGuardrailRequest

DeleteAiGuardrailResponse

class DeleteAiGuardrailResponse

DeleteAiGuardrailVersionRequest

class DeleteAiGuardrailVersionRequest

DeleteAiGuardrailVersionResponse

class DeleteAiGuardrailVersionResponse

DeleteAiPromptRequest

class DeleteAiPromptRequest

DeleteAiPromptResponse

class DeleteAiPromptResponse

DeleteAiPromptVersionRequest

class DeleteAiPromptVersionRequest

DeleteAiPromptVersionResponse

class DeleteAiPromptVersionResponse

DeleteAssistantAssociationRequest

class DeleteAssistantAssociationRequest

DeleteAssistantAssociationResponse

class DeleteAssistantAssociationResponse

DeleteAssistantRequest

class DeleteAssistantRequest

DeleteAssistantResponse

class DeleteAssistantResponse

DeleteContentAssociationRequest

class DeleteContentAssociationRequest

DeleteContentAssociationResponse

class DeleteContentAssociationResponse

DeleteContentRequest

class DeleteContentRequest

DeleteContentResponse

class DeleteContentResponse

DeleteImportJobRequest

class DeleteImportJobRequest

DeleteImportJobResponse

class DeleteImportJobResponse

DeleteKnowledgeBaseRequest

class DeleteKnowledgeBaseRequest

DeleteKnowledgeBaseResponse

class DeleteKnowledgeBaseResponse

DeleteMessageTemplateAttachmentRequest

class DeleteMessageTemplateAttachmentRequest

DeleteMessageTemplateAttachmentResponse

class DeleteMessageTemplateAttachmentResponse

DeleteMessageTemplateRequest

class DeleteMessageTemplateRequest

DeleteMessageTemplateResponse

class DeleteMessageTemplateResponse

DeleteQuickResponseRequest

class DeleteQuickResponseRequest

DeleteQuickResponseResponse

class DeleteQuickResponseResponse

Document

class Document

The document.

DocumentText

class DocumentText

The text of the document.

EmailHeader

class EmailHeader

The email header to include in email messages.

EmailMessageTemplateContent

class EmailMessageTemplateContent

The content of the message template that applies to the email channel subtype.

EmailMessageTemplateContentBody

class EmailMessageTemplateContentBody

The body to use in email messages.

ExtendedMessageTemplateData

class ExtendedMessageTemplateData

The extended data of a message template.

ExternalSource

sealed class ExternalSource

ExternalSourceConfiguration

class ExternalSourceConfiguration

The configuration information of the external data source.

Filter

class Filter

A search filter.

FilterField

sealed class FilterField

FilterOperator

sealed class FilterOperator

FixedSizeChunkingConfiguration

class FixedSizeChunkingConfiguration

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

GenerativeChunkDataDetails

class GenerativeChunkDataDetails

Details about the generative chunk data.

GenerativeContentFeedbackData

class GenerativeContentFeedbackData

The feedback information for a generative target type.

GenerativeDataDetails

class GenerativeDataDetails

Details about generative data.

GenerativeReference

class GenerativeReference

Reference information about generative content.

GetAiAgentRequest

class GetAiAgentRequest

GetAiAgentResponse

class GetAiAgentResponse

GetAiGuardrailRequest

class GetAiGuardrailRequest

GetAiGuardrailResponse

class GetAiGuardrailResponse

GetAiPromptRequest

class GetAiPromptRequest

GetAiPromptResponse

class GetAiPromptResponse

GetAssistantAssociationRequest

class GetAssistantAssociationRequest

GetAssistantAssociationResponse

class GetAssistantAssociationResponse

GetAssistantRequest

class GetAssistantRequest

GetAssistantResponse

class GetAssistantResponse

GetContentAssociationRequest

class GetContentAssociationRequest

GetContentAssociationResponse

class GetContentAssociationResponse

GetContentRequest

class GetContentRequest

GetContentResponse

class GetContentResponse

GetContentSummaryRequest

class GetContentSummaryRequest

GetContentSummaryResponse

class GetContentSummaryResponse

GetImportJobRequest

class GetImportJobRequest

GetImportJobResponse

class GetImportJobResponse

GetKnowledgeBaseRequest

class GetKnowledgeBaseRequest

GetKnowledgeBaseResponse

class GetKnowledgeBaseResponse

GetMessageTemplateRequest

class GetMessageTemplateRequest

GetMessageTemplateResponse

class GetMessageTemplateResponse

GetNextMessageRequest

class GetNextMessageRequest

GetNextMessageResponse

class GetNextMessageResponse

GetQuickResponseRequest

class GetQuickResponseRequest

GetQuickResponseResponse

class GetQuickResponseResponse

GetRecommendationsRequest

class GetRecommendationsRequest

GetRecommendationsResponse

class GetRecommendationsResponse

GetSessionRequest

class GetSessionRequest

GetSessionResponse

class GetSessionResponse

GroupingConfiguration

class GroupingConfiguration

The configuration information of the grouping of Amazon Q in Connect users.

GuardrailContentFilterConfig

class GuardrailContentFilterConfig

Contains filter strengths for harmful content. AI Guardrail's support the following content filters to detect and filter harmful user inputs and FM-generated outputs.

GuardrailContentFilterType

sealed class GuardrailContentFilterType

Type of text to text filter in content policy

GuardrailContextualGroundingFilterConfig

class GuardrailContextualGroundingFilterConfig

The filter configuration details for the AI Guardrail's contextual grounding filter.

GuardrailContextualGroundingFilterType

sealed class GuardrailContextualGroundingFilterType

Type of contextual grounding filter

GuardrailFilterStrength

sealed class GuardrailFilterStrength

Strength for filters

GuardrailManagedWordsConfig

class GuardrailManagedWordsConfig

The managed word list to configure for the AI Guardrail.

GuardrailManagedWordsType

sealed class GuardrailManagedWordsType

Options for managed words.

GuardrailPiiEntityConfig

class GuardrailPiiEntityConfig

The PII entity to configure for the AI Guardrail.

GuardrailPiiEntityType

sealed class GuardrailPiiEntityType

The currently supported PII entities

GuardrailRegexConfig

class GuardrailRegexConfig

The regular expression to configure for the AI Guardrail.

GuardrailSensitiveInformationAction

sealed class GuardrailSensitiveInformationAction

Options for sensitive information action.

GuardrailTopicConfig

class GuardrailTopicConfig

Details about topics for the AI Guardrail to identify and deny.

GuardrailTopicType

sealed class GuardrailTopicType

Type of topic in a policy

GuardrailWordConfig

class GuardrailWordConfig

A word to configure for the AI Guardrail.

HierarchicalChunkingConfiguration

class HierarchicalChunkingConfiguration

Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

HierarchicalChunkingLevelConfiguration

class HierarchicalChunkingLevelConfiguration

Token settings for each layer.

Highlight

class Highlight

Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

ImportJobData

class ImportJobData

Summary information about the import job.

ImportJobStatus

sealed class ImportJobStatus

ImportJobSummary

class ImportJobSummary

Summary information about the import job.

ImportJobType

sealed class ImportJobType

IntentDetectedDataDetails

class IntentDetectedDataDetails

Details about the detected intent.

IntentInputData

class IntentInputData

Information about the Amazon Q intent.

KnowledgeBaseAssociationConfigurationData

class KnowledgeBaseAssociationConfigurationData

The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.

KnowledgeBaseAssociationData

class KnowledgeBaseAssociationData

Association information about the knowledge base.

KnowledgeBaseData

class KnowledgeBaseData

Information about the knowledge base.

KnowledgeBaseSearchType

sealed class KnowledgeBaseSearchType

KnowledgeBaseStatus

sealed class KnowledgeBaseStatus

KnowledgeBaseSummary

class KnowledgeBaseSummary

Summary information about the knowledge base.

KnowledgeBaseType

sealed class KnowledgeBaseType

ListAiAgentsRequest

class ListAiAgentsRequest

ListAiAgentsResponse

class ListAiAgentsResponse

ListAiAgentVersionsRequest

class ListAiAgentVersionsRequest

ListAiAgentVersionsResponse

class ListAiAgentVersionsResponse

ListAiGuardrailsRequest

class ListAiGuardrailsRequest

ListAiGuardrailsResponse

class ListAiGuardrailsResponse

ListAiGuardrailVersionsRequest

class ListAiGuardrailVersionsRequest

ListAiGuardrailVersionsResponse

class ListAiGuardrailVersionsResponse

ListAiPromptsRequest

class ListAiPromptsRequest

ListAiPromptsResponse

class ListAiPromptsResponse

ListAiPromptVersionsRequest

class ListAiPromptVersionsRequest

ListAiPromptVersionsResponse

class ListAiPromptVersionsResponse

ListAssistantAssociationsRequest

class ListAssistantAssociationsRequest

ListAssistantAssociationsResponse

class ListAssistantAssociationsResponse

ListAssistantsRequest

class ListAssistantsRequest

ListAssistantsResponse

class ListAssistantsResponse

ListContentAssociationsRequest

class ListContentAssociationsRequest

ListContentAssociationsResponse

class ListContentAssociationsResponse

ListContentsRequest

class ListContentsRequest

ListContentsResponse

class ListContentsResponse

ListImportJobsRequest

class ListImportJobsRequest

ListImportJobsResponse

class ListImportJobsResponse

ListKnowledgeBasesRequest

class ListKnowledgeBasesRequest

ListKnowledgeBasesResponse

class ListKnowledgeBasesResponse

ListMessagesRequest

class ListMessagesRequest

ListMessagesResponse

class ListMessagesResponse

ListMessageTemplatesRequest

class ListMessageTemplatesRequest

ListMessageTemplatesResponse

class ListMessageTemplatesResponse

ListMessageTemplateVersionsRequest

class ListMessageTemplateVersionsRequest

ListMessageTemplateVersionsResponse

class ListMessageTemplateVersionsResponse

ListQuickResponsesRequest

class ListQuickResponsesRequest

ListQuickResponsesResponse

class ListQuickResponsesResponse

ListTagsForResourceRequest

class ListTagsForResourceRequest

ListTagsForResourceResponse

class ListTagsForResourceResponse

ManagedSourceConfiguration

sealed class ManagedSourceConfiguration

Source configuration for managed resources.

ManualSearchAiAgentConfiguration

class ManualSearchAiAgentConfiguration

The configuration for the MANUAL_SEARCH AI Agent type.

MessageConfiguration

class MessageConfiguration

The configuration for a SendMessage request.

MessageData

sealed class MessageData

The message data.

MessageInput

class MessageInput

The message input.

MessageOutput

class MessageOutput

The message output.

MessageTemplateAttachment

class MessageTemplateAttachment

Information about the message template attachment.

MessageTemplateAttributes

class MessageTemplateAttributes

The attributes that are used with the message template.

MessageTemplateAttributeType

sealed class MessageTemplateAttributeType

MessageTemplateBodyContentProvider

sealed class MessageTemplateBodyContentProvider

The container of the message template body.

MessageTemplateContentProvider

sealed class MessageTemplateContentProvider

The container of message template content.

MessageTemplateData

class MessageTemplateData

The data of a message template.

MessageTemplateFilterField

class MessageTemplateFilterField

The message template fields to filter the message template query results by. The following is the list of supported field names:

MessageTemplateFilterOperator

sealed class MessageTemplateFilterOperator

MessageTemplateOrderField

class MessageTemplateOrderField

The message template fields to order the message template query results by. The following is the list of supported field names:

MessageTemplateQueryField

class MessageTemplateQueryField

The message template fields to query message templates by. The following is the list of supported field names:

MessageTemplateQueryOperator

sealed class MessageTemplateQueryOperator

MessageTemplateSearchExpression

class MessageTemplateSearchExpression

The search expression of the message template.

MessageTemplateSearchResultData

class MessageTemplateSearchResultData

The result of message template search.

MessageTemplateSummary

class MessageTemplateSummary

The summary of the message template.

MessageTemplateVersionSummary

class MessageTemplateVersionSummary

The summary of the message template version.

MessageType

sealed class MessageType

NotifyRecommendationsReceivedError

class NotifyRecommendationsReceivedError

An error occurred when creating a recommendation.

NotifyRecommendationsReceivedRequest

class NotifyRecommendationsReceivedRequest

NotifyRecommendationsReceivedResponse

class NotifyRecommendationsReceivedResponse

OrCondition

sealed class OrCondition

A list of conditions which would be applied together with an OR condition.

Order

sealed class Order

Origin

sealed class Origin

ParsingConfiguration

class ParsingConfiguration

Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.

ParsingPrompt

class ParsingPrompt

Instructions for interpreting the contents of a document.

ParsingStrategy

sealed class ParsingStrategy

Participant

sealed class Participant

PreconditionFailedException

class PreconditionFailedException : QConnectException

The provided revisionId does not match, indicating the content has been modified since it was last read.

Priority

sealed class Priority

PutFeedbackRequest

class PutFeedbackRequest

PutFeedbackResponse

class PutFeedbackResponse

QConnectException

open class QConnectException : AwsServiceException

Base class for all service related exceptions thrown by the QConnect client

QueryAssistantRequest

class QueryAssistantRequest

QueryAssistantResponse

class QueryAssistantResponse

QueryCondition

sealed class QueryCondition

Information about how to query content.

QueryConditionComparisonOperator

sealed class QueryConditionComparisonOperator

QueryConditionFieldName

sealed class QueryConditionFieldName

QueryConditionItem

class QueryConditionItem

The condition for the query.

QueryInputData

sealed class QueryInputData

Input information for the query.

QueryRecommendationTriggerData

class QueryRecommendationTriggerData

Data associated with the QUERY RecommendationTriggerType.

QueryResultType

sealed class QueryResultType

QueryTextInputData

class QueryTextInputData

Information about the text to search for.

QuickResponseContentProvider

sealed class QuickResponseContentProvider

The container quick response content.

QuickResponseContents

class QuickResponseContents

The content of the quick response stored in different media types.

QuickResponseData

class QuickResponseData

Information about the quick response.

QuickResponseDataProvider

sealed class QuickResponseDataProvider

The container of quick response data.

QuickResponseFilterField

class QuickResponseFilterField

The quick response fields to filter the quick response query results by.

QuickResponseFilterOperator

sealed class QuickResponseFilterOperator

QuickResponseOrderField

class QuickResponseOrderField

The quick response fields to order the quick response query results by.

QuickResponseQueryField

class QuickResponseQueryField

The quick response fields to query quick responses by.

QuickResponseQueryOperator

sealed class QuickResponseQueryOperator

QuickResponseSearchExpression

class QuickResponseSearchExpression

Information about the import job.

QuickResponseSearchResultData

class QuickResponseSearchResultData

The result of quick response search.

QuickResponseStatus

sealed class QuickResponseStatus

QuickResponseSummary

class QuickResponseSummary

The summary information about the quick response.

RankingData

class RankingData

Details about the source content ranking data.

RecommendationData

class RecommendationData

Information about the recommendation.

RecommendationSourceType

sealed class RecommendationSourceType

RecommendationTrigger

class RecommendationTrigger

A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.

RecommendationTriggerData

sealed class RecommendationTriggerData

A union type containing information related to the trigger.

RecommendationTriggerType

sealed class RecommendationTriggerType

RecommendationType

sealed class RecommendationType

ReferenceType

sealed class ReferenceType

Relevance

sealed class Relevance

RelevanceLevel

sealed class RelevanceLevel

RemoveAssistantAiAgentRequest

class RemoveAssistantAiAgentRequest

RemoveAssistantAiAgentResponse

class RemoveAssistantAiAgentResponse

RemoveKnowledgeBaseTemplateUriRequest

class RemoveKnowledgeBaseTemplateUriRequest

RemoveKnowledgeBaseTemplateUriResponse

class RemoveKnowledgeBaseTemplateUriResponse

RenderingConfiguration

class RenderingConfiguration

Information about how to render the content.

RenderMessageTemplateRequest

class RenderMessageTemplateRequest

RenderMessageTemplateResponse

class RenderMessageTemplateResponse

RequestTimeoutException

class RequestTimeoutException : QConnectException

The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.

ResourceNotFoundException

class ResourceNotFoundException : QConnectException

The specified resource does not exist.

ResultData

class ResultData

Information about the result.

RuntimeSessionData

class RuntimeSessionData

The list of key-value pairs that are stored on the session.

RuntimeSessionDataValue

sealed class RuntimeSessionDataValue

A union type that specifies the data stored on the session.

SearchContentRequest

class SearchContentRequest

SearchContentResponse

class SearchContentResponse

SearchExpression

class SearchExpression

The search expression.

SearchMessageTemplatesRequest

class SearchMessageTemplatesRequest

SearchMessageTemplatesResponse

class SearchMessageTemplatesResponse

SearchQuickResponsesRequest

class SearchQuickResponsesRequest

SearchQuickResponsesResponse

class SearchQuickResponsesResponse

SearchSessionsRequest

class SearchSessionsRequest

SearchSessionsResponse

class SearchSessionsResponse

SeedUrl

class SeedUrl

A URL for crawling.

SelfServiceAiAgentConfiguration

class SelfServiceAiAgentConfiguration

The configuration for AI Agents of type SELF_SERVICE.

SelfServiceConversationHistory

class SelfServiceConversationHistory

The conversation history data to included in conversation context data before the Amazon Q in Connect session.

SemanticChunkingConfiguration

class SemanticChunkingConfiguration

Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.

SendMessageRequest

class SendMessageRequest

SendMessageResponse

class SendMessageResponse

ServerSideEncryptionConfiguration

class ServerSideEncryptionConfiguration

The configuration information for the customer managed key used for encryption.

ServiceQuotaExceededException

class ServiceQuotaExceededException : QConnectException

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

SessionData

class SessionData

Information about the session.

SessionDataNamespace

sealed class SessionDataNamespace

SessionIntegrationConfiguration

class SessionIntegrationConfiguration

The configuration information for the session integration.

SessionSummary

class SessionSummary

Summary information about the session.

SmsMessageTemplateContent