String appIntegrationArn
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
List<E> objectFields
The fields from the source that are made available to your agents in Wisdom.
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.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
String assistantArn
The Amazon Resource Name (ARN) of the Wisdom 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 Wisdom 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.
KnowledgeBaseAssociationData knowledgeBaseAssociation
The knowledge base where output data is sent.
String assistantArn
The Amazon Resource Name (ARN) of the Wisdom 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 Wisdom 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 assistantArn
The Amazon Resource Name (ARN) of the Wisdom assistant.
String assistantId
The identifier of the Wisdom assistant.
String description
The description.
String name
The name.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The KMS key used for encryption.
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 assistantArn
The Amazon Resource Name (ARN) of the Wisdom assistant.
String assistantId
The identifier of the Wisdom assistant.
String description
The description of the assistant.
String name
The name of the assistant.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The KMS key used for encryption.
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.
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 Wisdom, 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.
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.
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.
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 Wisdom, 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 Wisdom 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.
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.
String description
The description of the assistant.
String name
The name of the assistant.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The KMS key used for encryption.
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.
String knowledgeBaseId
The identifier of the 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 Wisdom, 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.
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 KMS key used for encryption.
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.
String assistantId
The identifier of the Wisdom 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.
String description
The description.
String name
The name of the session.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
SessionData session
The session.
String assistantId
The identifier of the Wisdom 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.
AssistantAssociationData assistantAssociation
The assistant association.
String assistantId
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
AssistantData assistant
Information about the assistant.
ContentData content
The content.
ContentSummary contentSummary
The content summary.
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.
String assistantId
The identifier of the Wisdom 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 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 KMS key used for encryption.
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 KMS key used for encryption.
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 Wisdom 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. 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 Wisdom 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.
String assistantId
The identifier of the Wisdom 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 queryText
The text to search for.
String text
The text associated with the recommendation trigger.
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 and ServiceNow, 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
<p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html">GetContent</a>. </p>
String resourceName
The specified resource name.
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.
SearchExpression searchExpression
The search expression to filter results.
String assistantId
The identifier of the Wisdom 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 KMS key. For information about valid ID values, see Key identifiers (KeyId).
String description
The description of the session.
String name
The name of the session.
String sessionArn
The Amazon Resource Name (ARN) of the session.
String sessionId
The identifier of the session.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
AppIntegrationsConfiguration appIntegrations
Configuration information for Amazon AppIntegrations to automatically ingest content.
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. 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 Wisdom, 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.
Copyright © 2022. All rights reserved.