String appIntegrationArn
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
provided, including at least Id, ArticleNumber, VersionNumber,
Title, PublishStatus, and IsDeleted as source fields.
For
ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
provided, including at least number, short_description, sys_mod_count,
workflow_state, and active as source fields.
For Zendesk,
your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
provided, including at least id, title, updated_at, and draft
as source fields.
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file
extensions that are among docx, pdf, html, htm, and
txt.
For Amazon S3, the ObjectConfiguration and FileConfiguration of your
AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the
following format: s3://your_s3_bucket_name.
The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal
app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and
s3:GetBucketLocation against the bucket.
List<E> objectFields
The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.
For Salesforce, you must include at least Id, ArticleNumber,
VersionNumber, Title, PublishStatus, and IsDeleted.
For
ServiceNow, you must include at least number, short_description,
sys_mod_count, workflow_state, and active.
For Zendesk, you
must include at least id, title, updated_at, and draft.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
String assistantArn
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
String assistantAssociationArn
The Amazon Resource Name (ARN) of the assistant association.
String assistantAssociationId
The identifier of the assistant association.
String assistantId
The identifier of the Amazon Q in Connect assistant.
AssistantAssociationOutputData associationData
A union type that currently has a single argument, the knowledge base ID.
String associationType
The type of association.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String knowledgeBaseId
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
KnowledgeBaseAssociationData knowledgeBaseAssociation
The knowledge base where output data is sent.
String assistantArn
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
String assistantAssociationArn
The Amazon Resource Name (ARN) of the assistant association.
String assistantAssociationId
The identifier of the assistant association.
String assistantId
The identifier of the Amazon Q in Connect assistant.
AssistantAssociationOutputData associationData
The association data.
String associationType
The type of association.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String type
The type of Amazon Q in Connect assistant capability.
String assistantArn
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
String assistantId
The identifier of the Amazon Q in Connect assistant.
AssistantCapabilityConfiguration capabilityConfiguration
The configuration information for the Amazon Q in Connect assistant capability.
String description
The description.
AssistantIntegrationConfiguration integrationConfiguration
The configuration information for the Amazon Q in Connect assistant integration.
String name
The name.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey,
kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to
invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow
kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the
connect.amazonaws.com service principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
String status
The status of the assistant.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String type
The type of assistant.
String topicIntegrationArn
The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
String assistantArn
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
String assistantId
The identifier of the Amazon Q in Connect assistant.
AssistantCapabilityConfiguration capabilityConfiguration
The configuration information for the Amazon Q in Connect assistant capability.
String description
The description of the assistant.
AssistantIntegrationConfiguration integrationConfiguration
The configuration information for the Amazon Q in Connect assistant integration.
String name
The name of the assistant.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey,
kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to
invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow
kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the
connect.amazonaws.com service principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
String status
The status of the assistant.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String type
The type of the assistant.
ConnectConfiguration connectConfiguration
The configuration information of the Amazon Connect data source.
String instanceId
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
String contentArn
The Amazon Resource Name (ARN) of the content.
String contentId
The identifier of the content.
String contentType
The media type of the content.
String knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
String knowledgeBaseId
The identifier of the knowledge base.
String linkOutUri
The URI of the content.
Map<K,V> metadata
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
String name
The name of the content.
String revisionId
The identifier of the content revision.
String status
The status of the content.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String title
The title of the content.
String url
The URL of the content.
Date urlExpiry
The expiration time of the URL as an epoch timestamp.
RankingData rankingData
Details about the content ranking data.
TextData textData
Details about the content text data.
GenerativeContentFeedbackData generativeContentFeedbackData
Information about the feedback for a generative target type.
String contentArn
The Amazon Resource Name (ARN) of the content.
String contentId
The identifier of the content.
String knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
String knowledgeBaseId
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
String contentArn
The Amazon Resource Name (ARN) of the content.
String contentId
The identifier of the content.
String contentType
The media type of the content.
String knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
String knowledgeBaseId
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
Map<K,V> metadata
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
String name
The name of the content.
String revisionId
The identifier of the revision of the content.
String status
The status of the content.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String title
The title of the content.
String assistantId
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
AssistantAssociationInputData association
The identifier of the associated resource.
String associationType
The type of association.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
AssistantAssociationData assistantAssociation
The assistant association.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String description
The description of the assistant.
String name
The name of the assistant.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The configuration information for the customer managed key used for encryption.
The customer managed key must have a policy that allows kms:CreateGrant,
kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the
IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy
must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey
permissions to the connect.amazonaws.com service principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String type
The type of assistant.
AssistantData assistant
Information about the assistant.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String knowledgeBaseId
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Map<K,V> metadata
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
String name
The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.
String overrideLinkOutUri
The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String title
The title of the content. If not set, the title is equal to the name.
String uploadId
A pointer to the uploaded asset. This value is returned by StartContentUpload.
ContentData content
The content.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String description
The description.
String knowledgeBaseType
The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
String name
The name of the knowledge base.
RenderingConfiguration renderingConfiguration
Information about how to render the content.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey,
kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to
invoke Amazon Q in Connect.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
SourceConfiguration sourceConfiguration
The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
KnowledgeBaseData knowledgeBase
The knowledge base.
List<E> channels
The Amazon Connect channels this quick response applies to.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
QuickResponseDataProvider content
The content of the quick response.
String contentType
The media type of the quick response content.
Use application/x.quickresponse;format=plain for a quick response written in plain text.
Use application/x.quickresponse;format=markdown for a quick response written in richtext.
String description
The description of the quick response.
GroupingConfiguration groupingConfiguration
The configuration information of the user groups that the quick response is accessible to.
Boolean isActive
Whether the quick response is active.
String knowledgeBaseId
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
String language
The language code value for the language in which the quick response is written. The supported language codes
include de_DE, en_US, es_ES, fr_FR, id_ID,
it_IT, ja_JP, ko_KR, pt_BR, zh_CN,
zh_TW
String name
The name of the quick response.
String shortcutKey
The shortcut key of the quick response. The value should be unique across the knowledge base.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
QuickResponseData quickResponse
The quick response.
String assistantId
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
String description
The description.
String name
The name of the session.
TagFilter tagFilter
An object that can be used to specify Tag conditions.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
SessionData session
The session.
ContentDataDetails contentData
Details about the content data.
GenerativeDataDetails generativeData
Details about the generative data.
SourceContentDataDetails sourceContentData
Details about the content data.
ContentReference contentReference
GenerativeReference generativeReference
Reference information about the generative content.
DataDetails details
Details about the data.
DataReference reference
Reference information about the content.
String assistantAssociationId
The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
String assistantId
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
String assistantId
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
String knowledgeBaseId
The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
ContentReference contentReference
A reference to the content resource.
DocumentText excerpt
The excerpt from the document.
DocumentText title
The title of the document.
Configuration configuration
The configuration information of the external data source.
String source
The type of the external data source.
String relevance
The relevance of the feedback.
String completion
The LLM response.
RankingData rankingData
Details about the generative content ranking data.
List<E> references
The references used to generative the LLM response.
String assistantAssociationId
The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
String assistantId
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
AssistantAssociationData assistantAssociation
The assistant association.
String assistantId
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
AssistantData assistant
Information about the assistant.
String contentId
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
String knowledgeBaseId
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
ContentData content
The content.
ContentSummary contentSummary
The content summary.
ImportJobData importJob
The import job.
String knowledgeBaseId
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
KnowledgeBaseData knowledgeBase
The knowledge base.
QuickResponseData quickResponse
The quick response.
String assistantId
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Integer maxResults
The maximum number of results to return per page.
String sessionId
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
Integer waitTimeSeconds
The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If
a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are
available and the wait time expires, the call returns successfully with an empty list.
SessionData session
The session.
String criteria
The criteria used for grouping Amazon Q in Connect users.
The following is the list of supported criteria values.
RoutingProfileArn: Grouping the users by their Amazon Connect routing
profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
List<E> values
The list of values that define different groups of Amazon Q in Connect users.
When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing
profiles as values of this parameter.
Date createdTime
The timestamp when the import job was created.
ExternalSourceConfiguration externalSourceConfiguration
String failedRecordReport
The link to donwload the information of resource data that failed to be imported.
String importJobId
The identifier of the import job.
String importJobType
The type of the import job.
String knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
String knowledgeBaseId
The identifier of the knowledge base.
Date lastModifiedTime
The timestamp when the import job data was last modified.
Map<K,V> metadata
The metadata fields of the imported Amazon Q in Connect resources.
String status
The status of the import job.
String uploadId
A pointer to the uploaded asset. This value is returned by StartContentUpload.
String url
The download link to the resource file that is uploaded to the import job.
Date urlExpiry
The expiration time of the URL as an epoch timestamp.
Date createdTime
The timestamp when the import job was created.
ExternalSourceConfiguration externalSourceConfiguration
The configuration information of the external source that the resource data are imported from.
String importJobId
The identifier of the import job.
String importJobType
The type of import job.
String knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
String knowledgeBaseId
The identifier of the knowledge base.
Date lastModifiedTime
The timestamp when the import job was last modified.
Map<K,V> metadata
The metadata fields of the imported Amazon Q in Connect resources.
String status
The status of the import job.
String uploadId
A pointer to the uploaded asset. This value is returned by StartContentUpload.
String description
The description.
String knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
String knowledgeBaseId
The identifier of the knowledge base.
String knowledgeBaseType
The type of knowledge base.
Date lastContentModificationTime
An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
String name
The name of the knowledge base.
RenderingConfiguration renderingConfiguration
Information about how to render the content.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey,
kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to
invoke Amazon Q in Connect.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
SourceConfiguration sourceConfiguration
Source configuration information about the knowledge base.
String status
The status of the knowledge base.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String description
The description of the knowledge base.
String knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
String knowledgeBaseId
The identifier of the knowledge base.
String knowledgeBaseType
The type of knowledge base.
String name
The name of the knowledge base.
RenderingConfiguration renderingConfiguration
Information about how to render the content.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey,
kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to
invoke Amazon Q in Connect.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
SourceConfiguration sourceConfiguration
Configuration information about the external data source.
String status
The status of the knowledge base summary.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String assistantId
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Integer maxResults
The maximum number of results to return per page.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
String knowledgeBaseId
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Integer maxResults
The maximum number of results to return per page.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
String knowledgeBaseId
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Integer maxResults
The maximum number of results to return per page.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
String knowledgeBaseId
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Integer maxResults
The maximum number of results to return per page.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
String resourceArn
The Amazon Resource Name (ARN) of the resource.
String assistantId
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
List<E> recommendationIds
The identifiers of the recommendations.
String sessionId
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
List<E> andConditions
A list of conditions which would be applied together with an AND condition.
TagCondition tagCondition
A leaf node condition which can be used to specify a tag condition.
String assistantId
The identifier of the Amazon Q in Connect assistant.
ContentFeedbackData contentFeedback
Information about the feedback provided.
String targetId
The identifier of the feedback target.
String targetType
The type of the feedback target.
String assistantArn
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
String assistantId
The identifier of the Amazon Q in Connect assistant.
ContentFeedbackData contentFeedback
Information about the feedback provided.
String targetId
The identifier of the feedback target.
String targetType
The type of the feedback target.
String assistantId
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Integer maxResults
The maximum number of results to return per page.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
List<E> queryCondition
Information about how to query content.
String queryText
The text to search for.
String sessionId
The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.
QueryConditionItem single
The condition for the query.
String text
The text associated with the recommendation trigger.
String content
The content of the quick response.
QuickResponseContentProvider markdown
QuickResponseContentProvider plainText
List<E> channels
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
Chat.
String contentType
The media type of the quick response content.
Use application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
QuickResponseContents contents
The contents of the quick response.
Date createdTime
The timestamp when the quick response was created.
String description
The description of the quick response.
GroupingConfiguration groupingConfiguration
The configuration information of the user groups that the quick response is accessible to.
Boolean isActive
Whether the quick response is active.
String knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
String knowledgeBaseId
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
String language
The language code value for the language in which the quick response is written.
String lastModifiedBy
The Amazon Resource Name (ARN) of the user who last updated the quick response data.
Date lastModifiedTime
The timestamp when the quick response data was last modified.
String name
The name of the quick response.
String quickResponseArn
The Amazon Resource Name (ARN) of the quick response.
String quickResponseId
The identifier of the quick response.
String shortcutKey
The shortcut key of the quick response. The value should be unique across the knowledge base.
String status
The status of the quick response data.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String content
The content of the quick response.
Boolean includeNoExistence
Whether to treat null value as a match for the attribute field.
String name
The name of the attribute field to filter the quick responses by.
String operator
The operator to use for filtering.
List<E> values
The values of attribute field to filter the quick response by.
Boolean allowFuzziness
Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.
String name
The name of the attribute to query the quick responses by.
String operator
The operator to use for matching attribute field values in the query.
String priority
The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
List<E> values
The values of the attribute to query the quick responses by.
List<E> filters
The configuration of filtering rules applied to quick response query results.
QuickResponseOrderField orderOnField
The quick response attribute fields on which the query results are ordered.
List<E> queries
The quick response query expressions.
List<E> attributesInterpolated
The user defined contact attributes that are resolved when the search result is returned.
List<E> attributesNotInterpolated
The user defined contact attributes that are not resolved when the search result is returned.
List<E> channels
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
Chat.
String contentType
The media type of the quick response content.
Use application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
QuickResponseContents contents
The contents of the quick response.
Date createdTime
The timestamp when the quick response was created.
String description
The description of the quick response.
GroupingConfiguration groupingConfiguration
The configuration information of the user groups that the quick response is accessible to.
Boolean isActive
Whether the quick response is active.
String knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
String knowledgeBaseId
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
String language
The language code value for the language in which the quick response is written.
String lastModifiedBy
The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.
Date lastModifiedTime
The timestamp when the quick response search result data was last modified.
String name
The name of the quick response.
String quickResponseArn
The Amazon Resource Name (ARN) of the quick response.
String quickResponseId
The identifier of the quick response.
String shortcutKey
The shortcut key of the quick response. The value should be unique across the knowledge base.
String status
The resource status of the quick response.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
List<E> channels
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
Chat.
String contentType
The media type of the quick response content.
Use application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
Date createdTime
The timestamp when the quick response was created.
String description
The description of the quick response.
Boolean isActive
Whether the quick response is active.
String knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
String knowledgeBaseId
The identifier of the knowledge base.
String lastModifiedBy
The Amazon Resource Name (ARN) of the user who last updated the quick response data.
Date lastModifiedTime
The timestamp when the quick response summary was last modified.
String name
The name of the quick response.
String quickResponseArn
The Amazon Resource Name (ARN) of the quick response.
String quickResponseId
The identifier of the quick response.
String status
The resource status of the quick response.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
DataSummary data
Summary of the recommended content.
Document document
The recommended document.
String recommendationId
The identifier of the recommendation.
String relevanceLevel
The relevance level of the recommendation.
Double relevanceScore
The relevance score of the recommendation.
String type
The type of recommendation.
RecommendationTriggerData data
A union type containing information related to the trigger.
String id
The identifier of the recommendation trigger.
List<E> recommendationIds
The identifiers of the recommendations.
String source
The source of the recommendation trigger.
ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.
RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.
String type
The type of recommendation trigger.
QueryRecommendationTriggerData query
Data associated with the QUERY RecommendationTriggerType.
String knowledgeBaseId
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
String templateUri
A URI template containing exactly one variable in ${variableName} format. This can only be set for
EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the
following:
Salesforce: Id, ArticleNumber, VersionNumber, Title,
PublishStatus, or IsDeleted
ServiceNow: number, short_description, sys_mod_count,
workflow_state, or active
Zendesk: id, title, updated_at, or draft
The variable is replaced with the actual value for a piece of content when calling GetContent.
String resourceName
The specified resource name.
DataSummary data
Summary of the recommended content.
Document document
The document.
Double relevanceScore
The relevance score of the results.
String resultId
The identifier of the result data.
String type
The type of the query result.
String knowledgeBaseId
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Integer maxResults
The maximum number of results to return per page.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
SearchExpression searchExpression
The search expression to filter results.
Map<K,V> attributes
The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
String knowledgeBaseId
The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Integer maxResults
The maximum number of results to return per page.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
QuickResponseSearchExpression searchExpression
The search expression for querying the quick response.
String assistantId
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Integer maxResults
The maximum number of results to return per page.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
SearchExpression searchExpression
The search expression to filter results.
String kmsKeyId
The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
String description
The description of the session.
SessionIntegrationConfiguration integrationConfiguration
The configuration information for the session integration.
String name
The name of the session.
String sessionArn
The Amazon Resource Name (ARN) of the session.
String sessionId
The identifier of the session.
TagFilter tagFilter
An object that can be used to specify Tag conditions.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String topicIntegrationArn
The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
String assistantArn
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
String assistantId
The identifier of the Amazon Q in Connect assistant.
String sessionArn
The Amazon Resource Name (ARN) of the session.
String sessionId
The identifier of the session.
AppIntegrationsConfiguration appIntegrations
Configuration information for Amazon AppIntegrations to automatically ingest content.
String id
The identifier of the source content.
RankingData rankingData
Details about the source content ranking data.
TextData textData
Details about the source content text data.
String type
The type of the source content.
String contentType
The type of content to upload.
String knowledgeBaseId
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Integer presignedUrlTimeToLive
The expected expiration time of the generated presigned URL, specified in minutes.
String clientToken
The tags used to organize, track, or control access for this resource.
ExternalSourceConfiguration externalSourceConfiguration
The configuration information of the external source that the resource data are imported from.
String importJobType
The type of the import job.
For importing quick response resource, set the value to QUICK_RESPONSES.
String knowledgeBaseId
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
For importing Amazon Q in Connect quick responses, this should be a QUICK_RESPONSES type knowledge
base.
Map<K,V> metadata
The metadata fields of the imported Amazon Q in Connect resources.
String uploadId
A pointer to the uploaded asset. This value is returned by StartContentUpload.
ImportJobData importJob
The import job.
List<E> andConditions
A list of conditions which would be applied together with an AND condition.
List<E> orConditions
A list of conditions which would be applied together with an OR condition.
TagCondition tagCondition
A leaf node condition which can be used to specify a tag condition.
DocumentText excerpt
DocumentText title
String resourceName
The specified resource name.
String contentId
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
String knowledgeBaseId
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN
Map<K,V> metadata
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
String overrideLinkOutUri
The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this
piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set
removeOverrideLinkOutUri to true.
Boolean removeOverrideLinkOutUri
Unset the existing overrideLinkOutUri if it exists.
String revisionId
The revisionId of the content resource to update, taken from an earlier call to
GetContent, GetContentSummary, SearchContent, or ListContents
. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last
read. If it has been modified, this API throws a PreconditionFailedException.
String title
The title of the content.
String uploadId
A pointer to the uploaded asset. This value is returned by StartContentUpload.
ContentData content
The content.
KnowledgeBaseData knowledgeBase
The knowledge base to update.
List<E> channels
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
Chat.
QuickResponseDataProvider content
The updated content of the quick response.
String contentType
The media type of the quick response content.
Use application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
String description
The updated description of the quick response.
GroupingConfiguration groupingConfiguration
The updated grouping configuration of the quick response.
Boolean isActive
Whether the quick response is active.
String knowledgeBaseId
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
String language
The language code value for the language in which the quick response is written. The supported language codes
include de_DE, en_US, es_ES, fr_FR, id_ID,
it_IT, ja_JP, ko_KR, pt_BR, zh_CN,
zh_TW
String name
The name of the quick response.
String quickResponseId
The identifier of the quick response.
Boolean removeDescription
Whether to remove the description from the quick response.
Boolean removeGroupingConfiguration
Whether to remove the grouping configuration of the quick response.
Boolean removeShortcutKey
Whether to remove the shortcut key of the quick response.
String shortcutKey
The shortcut key of the quick response. The value should be unique across the knowledge base.
QuickResponseData quickResponse
The quick response.
String assistantId
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
String description
The description.
String sessionId
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
TagFilter tagFilter
An object that can be used to specify Tag conditions.
SessionData session
Copyright © 2024. All rights reserved.