Amazon Connect Wisdom Service 2020-10-19
- Client: Aws\ConnectWisdomService\ConnectWisdomServiceClient
- Service ID: wisdom
- Version: 2020-10-19
This page describes the parameters and results for the operations of the Amazon Connect Wisdom Service (2020-10-19), and shows how to use the Aws\ConnectWisdomService\ConnectWisdomServiceClient object to call the described operations. This documentation is specific to the 2020-10-19 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateAssistant ( array $params = [] )
Creates an Amazon Connect Wisdom assistant.
- CreateAssistantAssociation ( array $params = [] )
Creates an association between an Amazon Connect Wisdom assistant and another resource.
- CreateContent ( array $params = [] )
Creates Wisdom content.
- CreateKnowledgeBase ( array $params = [] )
Creates a knowledge base.
- CreateSession ( array $params = [] )
Creates a session.
- DeleteAssistant ( array $params = [] )
Deletes an assistant.
- DeleteAssistantAssociation ( array $params = [] )
Deletes an assistant association.
- DeleteContent ( array $params = [] )
Deletes the content.
- DeleteKnowledgeBase ( array $params = [] )
Deletes the knowledge base.
- GetAssistant ( array $params = [] )
Retrieves information about an assistant.
- GetAssistantAssociation ( array $params = [] )
Retrieves information about an assistant association.
- GetContent ( array $params = [] )
Retrieves content, including a pre-signed URL to download the content.
- GetContentSummary ( array $params = [] )
Retrieves summary information about the content.
- GetKnowledgeBase ( array $params = [] )
Retrieves information about the knowledge base.
- GetRecommendations ( array $params = [] )
Retrieves recommendations for the specified session.
- GetSession ( array $params = [] )
Retrieves information for a specified session.
- ListAssistantAssociations ( array $params = [] )
Lists information about assistant associations.
- ListAssistants ( array $params = [] )
Lists information about assistants.
- ListContents ( array $params = [] )
Lists the content.
- ListKnowledgeBases ( array $params = [] )
Lists the knowledge bases.
- ListTagsForResource ( array $params = [] )
Lists the tags for the specified resource.
- NotifyRecommendationsReceived ( array $params = [] )
Removes the specified recommendations from the specified assistant's queue of newly available recommendations.
- QueryAssistant ( array $params = [] )
Performs a manual search against the specified assistant.
- RemoveKnowledgeBaseTemplateUri ( array $params = [] )
Removes a URI template from a knowledge base.
- SearchContent ( array $params = [] )
Searches for content in a specified knowledge base.
- SearchSessions ( array $params = [] )
Searches for sessions.
- StartContentUpload ( array $params = [] )
Get a URL to upload content to a knowledge base.
- TagResource ( array $params = [] )
Adds the specified tags to the specified resource.
- UntagResource ( array $params = [] )
Removes the specified tags from the specified resource.
- UpdateContent ( array $params = [] )
Updates information about the content.
- UpdateKnowledgeBaseTemplateUri ( array $params = [] )
Updates the template URI of a knowledge base.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateAssistant
$result = $client->createAssistant([/* ... */]); $promise = $client->createAssistantAsync([/* ... */]);
Creates an Amazon Connect Wisdom assistant.
Parameter Syntax
$result = $client->createAssistant([
'clientToken' => '<string>',
'description' => '<string>',
'name' => '<string>', // REQUIRED
'serverSideEncryptionConfiguration' => [
'kmsKeyId' => '<string>',
],
'tags' => ['<string>', ...],
'type' => 'AGENT', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
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.
- description
-
- Type: string
The description of the assistant.
- name
-
- Required: Yes
- Type: string
The name of the assistant.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
The KMS key used for encryption.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- type
-
- Required: Yes
- Type: string
The type of assistant.
Result Syntax
[
'assistant' => [
'assistantArn' => '<string>',
'assistantId' => '<string>',
'description' => '<string>',
'name' => '<string>',
'serverSideEncryptionConfiguration' => [
'kmsKeyId' => '<string>',
],
'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
'tags' => ['<string>', ...],
'type' => 'AGENT',
],
]
Result Details
Members
- assistant
-
- Type: AssistantData structure
Information about the assistant.
Errors
-
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a
CreateAPI (such asCreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. -
The input fails to satisfy the constraints specified by a service.
-
ServiceQuotaExceededException:
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.
-
You do not have sufficient access to perform this action.
CreateAssistantAssociation
$result = $client->createAssistantAssociation([/* ... */]); $promise = $client->createAssistantAssociationAsync([/* ... */]);
Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
Parameter Syntax
$result = $client->createAssistantAssociation([
'assistantId' => '<string>', // REQUIRED
'association' => [ // REQUIRED
'knowledgeBaseId' => '<string>',
],
'associationType' => 'KNOWLEDGE_BASE', // REQUIRED
'clientToken' => '<string>',
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- association
-
- Required: Yes
- Type: AssistantAssociationInputData structure
The identifier of the associated resource.
- associationType
-
- Required: Yes
- Type: string
The type of association.
- clientToken
-
- Type: string
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.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
Result Syntax
[
'assistantAssociation' => [
'assistantArn' => '<string>',
'assistantAssociationArn' => '<string>',
'assistantAssociationId' => '<string>',
'assistantId' => '<string>',
'associationData' => [
'knowledgeBaseAssociation' => [
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
],
],
'associationType' => 'KNOWLEDGE_BASE',
'tags' => ['<string>', ...],
],
]
Result Details
Members
- assistantAssociation
-
- Type: AssistantAssociationData structure
The assistant association.
Errors
-
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a
CreateAPI (such asCreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. -
The input fails to satisfy the constraints specified by a service.
-
ServiceQuotaExceededException:
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.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
CreateContent
$result = $client->createContent([/* ... */]); $promise = $client->createContentAsync([/* ... */]);
Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.
Parameter Syntax
$result = $client->createContent([
'clientToken' => '<string>',
'knowledgeBaseId' => '<string>', // REQUIRED
'metadata' => ['<string>', ...],
'name' => '<string>', // REQUIRED
'overrideLinkOutUri' => '<string>',
'tags' => ['<string>', ...],
'title' => '<string>',
'uploadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
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.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- metadata
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
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.
- name
-
- Required: Yes
- Type: string
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.
- overrideLinkOutUri
-
- Type: string
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.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- title
-
- Type: string
The title of the content. If not set, the title is equal to the name.
- uploadId
-
- Required: Yes
- Type: string
A pointer to the uploaded asset. This value is returned by StartContentUpload.
Result Syntax
[
'content' => [
'contentArn' => '<string>',
'contentId' => '<string>',
'contentType' => '<string>',
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
'linkOutUri' => '<string>',
'metadata' => ['<string>', ...],
'name' => '<string>',
'revisionId' => '<string>',
'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_FAILED',
'tags' => ['<string>', ...],
'title' => '<string>',
'url' => '<string>',
'urlExpiry' => <DateTime>,
],
]
Result Details
Members
- content
-
- Type: ContentData structure
The content.
Errors
-
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a
CreateAPI (such asCreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. -
The input fails to satisfy the constraints specified by a service.
-
ServiceQuotaExceededException:
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.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
CreateKnowledgeBase
$result = $client->createKnowledgeBase([/* ... */]); $promise = $client->createKnowledgeBaseAsync([/* ... */]);
Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.
For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
-
Call DeleteKnowledgeBase.
-
Call DeleteDataIntegration.
-
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
-
Call CreateKnowledgeBase.
Parameter Syntax
$result = $client->createKnowledgeBase([
'clientToken' => '<string>',
'description' => '<string>',
'knowledgeBaseType' => 'EXTERNAL|CUSTOM', // REQUIRED
'name' => '<string>', // REQUIRED
'renderingConfiguration' => [
'templateUri' => '<string>',
],
'serverSideEncryptionConfiguration' => [
'kmsKeyId' => '<string>',
],
'sourceConfiguration' => [
'appIntegrations' => [
'appIntegrationArn' => '<string>', // REQUIRED
'objectFields' => ['<string>', ...],
],
],
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- clientToken
-
- Type: string
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.
- description
-
- Type: string
The description.
- knowledgeBaseType
-
- Required: Yes
- Type: string
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.
- name
-
- Required: Yes
- Type: string
The name of the knowledge base.
- renderingConfiguration
-
- Type: RenderingConfiguration structure
Information about how to render the content.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
The KMS key used for encryption.
- sourceConfiguration
-
- Type: SourceConfiguration structure
The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
Result Syntax
[
'knowledgeBase' => [
'description' => '<string>',
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
'knowledgeBaseType' => 'EXTERNAL|CUSTOM',
'lastContentModificationTime' => <DateTime>,
'name' => '<string>',
'renderingConfiguration' => [
'templateUri' => '<string>',
],
'serverSideEncryptionConfiguration' => [
'kmsKeyId' => '<string>',
],
'sourceConfiguration' => [
'appIntegrations' => [
'appIntegrationArn' => '<string>',
'objectFields' => ['<string>', ...],
],
],
'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
'tags' => ['<string>', ...],
],
]
Result Details
Members
- knowledgeBase
-
- Type: KnowledgeBaseData structure
The knowledge base.
Errors
-
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a
CreateAPI (such asCreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. -
The input fails to satisfy the constraints specified by a service.
-
ServiceQuotaExceededException:
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.
-
You do not have sufficient access to perform this action.
CreateSession
$result = $client->createSession([/* ... */]); $promise = $client->createSessionAsync([/* ... */]);
Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.
Parameter Syntax
$result = $client->createSession([
'assistantId' => '<string>', // REQUIRED
'clientToken' => '<string>',
'description' => '<string>',
'name' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- clientToken
-
- Type: string
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.
- description
-
- Type: string
The description.
- name
-
- Required: Yes
- Type: string
The name of the session.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
Result Syntax
[
'session' => [
'description' => '<string>',
'name' => '<string>',
'sessionArn' => '<string>',
'sessionId' => '<string>',
'tags' => ['<string>', ...],
],
]
Result Details
Members
- session
-
- Type: SessionData structure
The session.
Errors
-
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a
CreateAPI (such asCreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. -
The input fails to satisfy the constraints specified by a service.
-
The specified resource does not exist.
DeleteAssistant
$result = $client->deleteAssistant([/* ... */]); $promise = $client->deleteAssistantAsync([/* ... */]);
Deletes an assistant.
Parameter Syntax
$result = $client->deleteAssistant([
'assistantId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[]
Result Details
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
DeleteAssistantAssociation
$result = $client->deleteAssistantAssociation([/* ... */]); $promise = $client->deleteAssistantAssociationAsync([/* ... */]);
Deletes an assistant association.
Parameter Syntax
$result = $client->deleteAssistantAssociation([
'assistantAssociationId' => '<string>', // REQUIRED
'assistantId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- assistantAssociationId
-
- Required: Yes
- Type: string
The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[]
Result Details
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
DeleteContent
$result = $client->deleteContent([/* ... */]); $promise = $client->deleteContentAsync([/* ... */]);
Deletes the content.
Parameter Syntax
$result = $client->deleteContent([
'contentId' => '<string>', // REQUIRED
'knowledgeBaseId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- contentId
-
- Required: Yes
- Type: string
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[]
Result Details
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
DeleteKnowledgeBase
$result = $client->deleteKnowledgeBase([/* ... */]); $promise = $client->deleteKnowledgeBaseAsync([/* ... */]);
Deletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
Parameter Syntax
$result = $client->deleteKnowledgeBase([
'knowledgeBaseId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[]
Result Details
Errors
-
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a
CreateAPI (such asCreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. -
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
GetAssistant
$result = $client->getAssistant([/* ... */]); $promise = $client->getAssistantAsync([/* ... */]);
Retrieves information about an assistant.
Parameter Syntax
$result = $client->getAssistant([
'assistantId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[
'assistant' => [
'assistantArn' => '<string>',
'assistantId' => '<string>',
'description' => '<string>',
'name' => '<string>',
'serverSideEncryptionConfiguration' => [
'kmsKeyId' => '<string>',
],
'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
'tags' => ['<string>', ...],
'type' => 'AGENT',
],
]
Result Details
Members
- assistant
-
- Type: AssistantData structure
Information about the assistant.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
GetAssistantAssociation
$result = $client->getAssistantAssociation([/* ... */]); $promise = $client->getAssistantAssociationAsync([/* ... */]);
Retrieves information about an assistant association.
Parameter Syntax
$result = $client->getAssistantAssociation([
'assistantAssociationId' => '<string>', // REQUIRED
'assistantId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- assistantAssociationId
-
- Required: Yes
- Type: string
The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[
'assistantAssociation' => [
'assistantArn' => '<string>',
'assistantAssociationArn' => '<string>',
'assistantAssociationId' => '<string>',
'assistantId' => '<string>',
'associationData' => [
'knowledgeBaseAssociation' => [
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
],
],
'associationType' => 'KNOWLEDGE_BASE',
'tags' => ['<string>', ...],
],
]
Result Details
Members
- assistantAssociation
-
- Type: AssistantAssociationData structure
The assistant association.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
GetContent
$result = $client->getContent([/* ... */]); $promise = $client->getContentAsync([/* ... */]);
Retrieves content, including a pre-signed URL to download the content.
Parameter Syntax
$result = $client->getContent([
'contentId' => '<string>', // REQUIRED
'knowledgeBaseId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- contentId
-
- Required: Yes
- Type: string
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[
'content' => [
'contentArn' => '<string>',
'contentId' => '<string>',
'contentType' => '<string>',
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
'linkOutUri' => '<string>',
'metadata' => ['<string>', ...],
'name' => '<string>',
'revisionId' => '<string>',
'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_FAILED',
'tags' => ['<string>', ...],
'title' => '<string>',
'url' => '<string>',
'urlExpiry' => <DateTime>,
],
]
Result Details
Members
- content
-
- Type: ContentData structure
The content.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
GetContentSummary
$result = $client->getContentSummary([/* ... */]); $promise = $client->getContentSummaryAsync([/* ... */]);
Retrieves summary information about the content.
Parameter Syntax
$result = $client->getContentSummary([
'contentId' => '<string>', // REQUIRED
'knowledgeBaseId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- contentId
-
- Required: Yes
- Type: string
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[
'contentSummary' => [
'contentArn' => '<string>',
'contentId' => '<string>',
'contentType' => '<string>',
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
'metadata' => ['<string>', ...],
'name' => '<string>',
'revisionId' => '<string>',
'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_FAILED',
'tags' => ['<string>', ...],
'title' => '<string>',
],
]
Result Details
Members
- contentSummary
-
- Type: ContentSummary structure
The content summary.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
GetKnowledgeBase
$result = $client->getKnowledgeBase([/* ... */]); $promise = $client->getKnowledgeBaseAsync([/* ... */]);
Retrieves information about the knowledge base.
Parameter Syntax
$result = $client->getKnowledgeBase([
'knowledgeBaseId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[
'knowledgeBase' => [
'description' => '<string>',
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
'knowledgeBaseType' => 'EXTERNAL|CUSTOM',
'lastContentModificationTime' => <DateTime>,
'name' => '<string>',
'renderingConfiguration' => [
'templateUri' => '<string>',
],
'serverSideEncryptionConfiguration' => [
'kmsKeyId' => '<string>',
],
'sourceConfiguration' => [
'appIntegrations' => [
'appIntegrationArn' => '<string>',
'objectFields' => ['<string>', ...],
],
],
'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
'tags' => ['<string>', ...],
],
]
Result Details
Members
- knowledgeBase
-
- Type: KnowledgeBaseData structure
The knowledge base.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
GetRecommendations
$result = $client->getRecommendations([/* ... */]); $promise = $client->getRecommendationsAsync([/* ... */]);
Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.
Parameter Syntax
$result = $client->getRecommendations([
'assistantId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'sessionId' => '<string>', // REQUIRED
'waitTimeSeconds' => <integer>,
]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- sessionId
-
- Required: Yes
- Type: string
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
- waitTimeSeconds
-
- Type: int
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.
Result Syntax
[
'recommendations' => [
[
'document' => [
'contentReference' => [
'contentArn' => '<string>',
'contentId' => '<string>',
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
],
'excerpt' => [
'highlights' => [
[
'beginOffsetInclusive' => <integer>,
'endOffsetExclusive' => <integer>,
],
// ...
],
'text' => '<string>',
],
'title' => [
'highlights' => [
[
'beginOffsetInclusive' => <integer>,
'endOffsetExclusive' => <integer>,
],
// ...
],
'text' => '<string>',
],
],
'recommendationId' => '<string>',
'relevanceLevel' => 'HIGH|MEDIUM|LOW',
'relevanceScore' => <float>,
'type' => 'KNOWLEDGE_CONTENT',
],
// ...
],
'triggers' => [
[
'data' => [
'query' => [
'text' => '<string>',
],
],
'id' => '<string>',
'recommendationIds' => ['<string>', ...],
'source' => 'ISSUE_DETECTION|RULE_EVALUATION|OTHER',
'type' => 'QUERY',
],
// ...
],
]
Result Details
Members
- recommendations
-
- Required: Yes
- Type: Array of RecommendationData structures
The recommendations.
- triggers
-
- Type: Array of RecommendationTrigger structures
The triggers corresponding to recommendations.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
GetSession
$result = $client->getSession([/* ... */]); $promise = $client->getSessionAsync([/* ... */]);
Retrieves information for a specified session.
Parameter Syntax
$result = $client->getSession([
'assistantId' => '<string>', // REQUIRED
'sessionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- sessionId
-
- Required: Yes
- Type: string
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[
'session' => [
'description' => '<string>',
'name' => '<string>',
'sessionArn' => '<string>',
'sessionId' => '<string>',
'tags' => ['<string>', ...],
],
]
Result Details
Members
- session
-
- Type: SessionData structure
The session.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
ListAssistantAssociations
$result = $client->listAssistantAssociations([/* ... */]); $promise = $client->listAssistantAssociationsAsync([/* ... */]);
Lists information about assistant associations.
Parameter Syntax
$result = $client->listAssistantAssociations([
'assistantId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
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.
Result Syntax
[
'assistantAssociationSummaries' => [
[
'assistantArn' => '<string>',
'assistantAssociationArn' => '<string>',
'assistantAssociationId' => '<string>',
'assistantId' => '<string>',
'associationData' => [
'knowledgeBaseAssociation' => [
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
],
],
'associationType' => 'KNOWLEDGE_BASE',
'tags' => ['<string>', ...],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- assistantAssociationSummaries
-
- Required: Yes
- Type: Array of AssistantAssociationSummary structures
Summary information about assistant associations.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
ListAssistants
$result = $client->listAssistants([/* ... */]); $promise = $client->listAssistantsAsync([/* ... */]);
Lists information about assistants.
Parameter Syntax
$result = $client->listAssistants([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
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.
Result Syntax
[
'assistantSummaries' => [
[
'assistantArn' => '<string>',
'assistantId' => '<string>',
'description' => '<string>',
'name' => '<string>',
'serverSideEncryptionConfiguration' => [
'kmsKeyId' => '<string>',
],
'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
'tags' => ['<string>', ...],
'type' => 'AGENT',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- assistantSummaries
-
- Required: Yes
- Type: Array of AssistantSummary structures
Information about the assistants.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
ListContents
$result = $client->listContents([/* ... */]); $promise = $client->listContentsAsync([/* ... */]);
Lists the content.
Parameter Syntax
$result = $client->listContents([
'knowledgeBaseId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
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.
Result Syntax
[
'contentSummaries' => [
[
'contentArn' => '<string>',
'contentId' => '<string>',
'contentType' => '<string>',
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
'metadata' => ['<string>', ...],
'name' => '<string>',
'revisionId' => '<string>',
'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_FAILED',
'tags' => ['<string>', ...],
'title' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- contentSummaries
-
- Required: Yes
- Type: Array of ContentSummary structures
Information about the content.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
ListKnowledgeBases
$result = $client->listKnowledgeBases([/* ... */]); $promise = $client->listKnowledgeBasesAsync([/* ... */]);
Lists the knowledge bases.
Parameter Syntax
$result = $client->listKnowledgeBases([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
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.
Result Syntax
[
'knowledgeBaseSummaries' => [
[
'description' => '<string>',
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
'knowledgeBaseType' => 'EXTERNAL|CUSTOM',
'name' => '<string>',
'renderingConfiguration' => [
'templateUri' => '<string>',
],
'serverSideEncryptionConfiguration' => [
'kmsKeyId' => '<string>',
],
'sourceConfiguration' => [
'appIntegrations' => [
'appIntegrationArn' => '<string>',
'objectFields' => ['<string>', ...],
],
],
'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
'tags' => ['<string>', ...],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- knowledgeBaseSummaries
-
- Required: Yes
- Type: Array of KnowledgeBaseSummary structures
Information about the knowledge bases.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags for the specified resource.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource.
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
Errors
-
The specified resource does not exist.
NotifyRecommendationsReceived
$result = $client->notifyRecommendationsReceived([/* ... */]); $promise = $client->notifyRecommendationsReceivedAsync([/* ... */]);
Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.
Parameter Syntax
$result = $client->notifyRecommendationsReceived([
'assistantId' => '<string>', // REQUIRED
'recommendationIds' => ['<string>', ...], // REQUIRED
'sessionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- recommendationIds
-
- Required: Yes
- Type: Array of strings
The identifiers of the recommendations.
- sessionId
-
- Required: Yes
- Type: string
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[
'errors' => [
[
'message' => '<string>',
'recommendationId' => '<string>',
],
// ...
],
'recommendationIds' => ['<string>', ...],
]
Result Details
Members
- errors
-
- Type: Array of NotifyRecommendationsReceivedError structures
The identifiers of recommendations that are causing errors.
- recommendationIds
-
- Type: Array of strings
The identifiers of the recommendations.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
QueryAssistant
$result = $client->queryAssistant([/* ... */]); $promise = $client->queryAssistantAsync([/* ... */]);
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
Parameter Syntax
$result = $client->queryAssistant([
'assistantId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
'queryText' => '<string>', // REQUIRED
]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
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.
- queryText
-
- Required: Yes
- Type: string
The text to search for.
Result Syntax
[
'nextToken' => '<string>',
'results' => [
[
'document' => [
'contentReference' => [
'contentArn' => '<string>',
'contentId' => '<string>',
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
],
'excerpt' => [
'highlights' => [
[
'beginOffsetInclusive' => <integer>,
'endOffsetExclusive' => <integer>,
],
// ...
],
'text' => '<string>',
],
'title' => [
'highlights' => [
[
'beginOffsetInclusive' => <integer>,
'endOffsetExclusive' => <integer>,
],
// ...
],
'text' => '<string>',
],
],
'relevanceScore' => <float>,
'resultId' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
- results
-
- Required: Yes
- Type: Array of ResultData structures
The results of the query.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
RemoveKnowledgeBaseTemplateUri
$result = $client->removeKnowledgeBaseTemplateUri([/* ... */]); $promise = $client->removeKnowledgeBaseTemplateUriAsync([/* ... */]);
Removes a URI template from a knowledge base.
Parameter Syntax
$result = $client->removeKnowledgeBaseTemplateUri([
'knowledgeBaseId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[]
Result Details
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
SearchContent
$result = $client->searchContent([/* ... */]); $promise = $client->searchContentAsync([/* ... */]);
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
Parameter Syntax
$result = $client->searchContent([
'knowledgeBaseId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
'searchExpression' => [ // REQUIRED
'filters' => [ // REQUIRED
[
'field' => 'NAME', // REQUIRED
'operator' => 'EQUALS', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
],
]);
Parameter Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
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
-
- Required: Yes
- Type: SearchExpression structure
The search expression to filter results.
Result Syntax
[
'contentSummaries' => [
[
'contentArn' => '<string>',
'contentId' => '<string>',
'contentType' => '<string>',
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
'metadata' => ['<string>', ...],
'name' => '<string>',
'revisionId' => '<string>',
'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_FAILED',
'tags' => ['<string>', ...],
'title' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- contentSummaries
-
- Required: Yes
- Type: Array of ContentSummary structures
Summary information about the content.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
SearchSessions
$result = $client->searchSessions([/* ... */]); $promise = $client->searchSessionsAsync([/* ... */]);
Searches for sessions.
Parameter Syntax
$result = $client->searchSessions([
'assistantId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
'searchExpression' => [ // REQUIRED
'filters' => [ // REQUIRED
[
'field' => 'NAME', // REQUIRED
'operator' => 'EQUALS', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
],
]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
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
-
- Required: Yes
- Type: SearchExpression structure
The search expression to filter results.
Result Syntax
[
'nextToken' => '<string>',
'sessionSummaries' => [
[
'assistantArn' => '<string>',
'assistantId' => '<string>',
'sessionArn' => '<string>',
'sessionId' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
- sessionSummaries
-
- Required: Yes
- Type: Array of SessionSummary structures
Summary information about the sessions.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
StartContentUpload
$result = $client->startContentUpload([/* ... */]); $promise = $client->startContentUploadAsync([/* ... */]);
Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
Parameter Syntax
$result = $client->startContentUpload([
'contentType' => '<string>', // REQUIRED
'knowledgeBaseId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- contentType
-
- Required: Yes
- Type: string
The type of content to upload.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[
'headersToInclude' => ['<string>', ...],
'uploadId' => '<string>',
'url' => '<string>',
'urlExpiry' => <DateTime>,
]
Result Details
Members
- headersToInclude
-
- Required: Yes
- Type: Associative array of custom strings keys (NonEmptyString) to strings
The headers to include in the upload.
- uploadId
-
- Required: Yes
- Type: string
The identifier of the upload.
- url
-
- Required: Yes
- Type: string
The URL of the upload.
- urlExpiry
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The expiration time of the URL as an epoch timestamp.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds the specified tags to the specified resource.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
Result Syntax
[]
Result Details
Errors
-
Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.
-
The specified resource does not exist.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes the specified tags from the specified resource.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource.
- tagKeys
-
- Required: Yes
- Type: Array of strings
The tag keys.
Result Syntax
[]
Result Details
Errors
-
The specified resource does not exist.
UpdateContent
$result = $client->updateContent([/* ... */]); $promise = $client->updateContentAsync([/* ... */]);
Updates information about the content.
Parameter Syntax
$result = $client->updateContent([
'contentId' => '<string>', // REQUIRED
'knowledgeBaseId' => '<string>', // REQUIRED
'metadata' => ['<string>', ...],
'overrideLinkOutUri' => '<string>',
'removeOverrideLinkOutUri' => true || false,
'revisionId' => '<string>',
'title' => '<string>',
'uploadId' => '<string>',
]);
Parameter Details
Members
- contentId
-
- Required: Yes
- Type: string
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN
- metadata
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
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.
- overrideLinkOutUri
-
- Type: string
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 setremoveOverrideLinkOutUrito true. - removeOverrideLinkOutUri
-
- Type: boolean
Unset the existing
overrideLinkOutUriif it exists. - revisionId
-
- Type: string
The
revisionIdof the content resource to update, taken from an earlier call toGetContent,GetContentSummary,SearchContent, orListContents. 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 aPreconditionFailedException. - title
-
- Type: string
The title of the content.
- uploadId
-
- Type: string
A pointer to the uploaded asset. This value is returned by StartContentUpload.
Result Syntax
[
'content' => [
'contentArn' => '<string>',
'contentId' => '<string>',
'contentType' => '<string>',
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
'linkOutUri' => '<string>',
'metadata' => ['<string>', ...],
'name' => '<string>',
'revisionId' => '<string>',
'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_FAILED',
'tags' => ['<string>', ...],
'title' => '<string>',
'url' => '<string>',
'urlExpiry' => <DateTime>,
],
]
Result Details
Members
- content
-
- Type: ContentData structure
The content.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The provided
revisionIddoes not match, indicating the content has been modified since it was last read. -
The specified resource does not exist.
UpdateKnowledgeBaseTemplateUri
$result = $client->updateKnowledgeBaseTemplateUri([/* ... */]); $promise = $client->updateKnowledgeBaseTemplateUriAsync([/* ... */]);
Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.
Parameter Syntax
$result = $client->updateKnowledgeBaseTemplateUri([
'knowledgeBaseId' => '<string>', // REQUIRED
'templateUri' => '<string>', // REQUIRED
]);
Parameter Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- templateUri
-
- Required: Yes
- Type: string
The template URI to update.
Result Syntax
[
'knowledgeBase' => [
'description' => '<string>',
'knowledgeBaseArn' => '<string>',
'knowledgeBaseId' => '<string>',
'knowledgeBaseType' => 'EXTERNAL|CUSTOM',
'lastContentModificationTime' => <DateTime>,
'name' => '<string>',
'renderingConfiguration' => [
'templateUri' => '<string>',
],
'serverSideEncryptionConfiguration' => [
'kmsKeyId' => '<string>',
],
'sourceConfiguration' => [
'appIntegrations' => [
'appIntegrationArn' => '<string>',
'objectFields' => ['<string>', ...],
],
],
'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
'tags' => ['<string>', ...],
],
]
Result Details
Members
- knowledgeBase
-
- Type: KnowledgeBaseData structure
The knowledge base to update.
Errors
-
The input fails to satisfy the constraints specified by a service.
-
You do not have sufficient access to perform this action.
-
The specified resource does not exist.
Shapes
AccessDeniedException
Description
You do not have sufficient access to perform this action.
Members
- message
-
- Type: string
AppIntegrationsConfiguration
Description
Configuration information for Amazon AppIntegrations to automatically ingest content.
Members
- appIntegrationArn
-
- Required: Yes
- Type: string
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, andIsDeletedas 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, andactiveas source fields. -
For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if
objectFieldsis not provided, including at leastid,title,updated_at, anddraftas source fields. -
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among
docx,pdf,html,htm, andtxt.
- objectFields
-
- Type: Array of strings
The fields from the source that are made available to your agents in Wisdom. Optional if ObjectConfiguration is included in the provided DataIntegration.
-
For Salesforce, you must include at least
Id,ArticleNumber,VersionNumber,Title,PublishStatus, andIsDeleted. -
For ServiceNow, you must include at least
number,short_description,sys_mod_count,workflow_state, andactive. -
For Zendesk, you must include at least
id,title,updated_at, anddraft.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
AssistantAssociationData
Description
Information about the assistant association.
Members
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Wisdom assistant.
- assistantAssociationArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the assistant association.
- assistantAssociationId
-
- Required: Yes
- Type: string
The identifier of the assistant association.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant.
- associationData
-
- Required: Yes
- Type: AssistantAssociationOutputData structure
A union type that currently has a single argument, the knowledge base ID.
- associationType
-
- Required: Yes
- Type: string
The type of association.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
AssistantAssociationInputData
Description
The data that is input into Wisdom as a result of the assistant association.
Members
- knowledgeBaseId
-
- Type: string
The identifier of the knowledge base.
AssistantAssociationOutputData
Description
The data that is output as a result of the assistant association.
Members
- knowledgeBaseAssociation
-
- Type: KnowledgeBaseAssociationData structure
The knowledge base where output data is sent.
AssistantAssociationSummary
Description
Summary information about the assistant association.
Members
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Wisdom assistant.
- assistantAssociationArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the assistant association.
- assistantAssociationId
-
- Required: Yes
- Type: string
The identifier of the assistant association.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant.
- associationData
-
- Required: Yes
- Type: AssistantAssociationOutputData structure
The association data.
- associationType
-
- Required: Yes
- Type: string
The type of association.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
AssistantData
Description
The assistant data.
Members
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Wisdom assistant.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant.
- description
-
- Type: string
The description.
- name
-
- Required: Yes
- Type: string
The name.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
The KMS key used for encryption.
- status
-
- Required: Yes
- Type: string
The status of the assistant.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- type
-
- Required: Yes
- Type: string
The type of assistant.
AssistantSummary
Description
Summary information about the assistant.
Members
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Wisdom assistant.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant.
- description
-
- Type: string
The description of the assistant.
- name
-
- Required: Yes
- Type: string
The name of the assistant.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
The KMS key used for encryption.
- status
-
- Required: Yes
- Type: string
The status of the assistant.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- type
-
- Required: Yes
- Type: string
The type of the assistant.
ConflictException
Description
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.
Members
- message
-
- Type: string
ContentData
Description
Information about the content.
Members
- contentArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the content.
- contentId
-
- Required: Yes
- Type: string
The identifier of the content.
- contentType
-
- Required: Yes
- Type: string
The media type of the content.
- knowledgeBaseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
- linkOutUri
-
- Type: string
The URI of the content.
- metadata
-
- Required: Yes
- Type: Associative array of custom strings keys (NonEmptyString) to strings
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.
- name
-
- Required: Yes
- Type: string
The name of the content.
- revisionId
-
- Required: Yes
- Type: string
The identifier of the content revision.
- status
-
- Required: Yes
- Type: string
The status of the content.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- title
-
- Required: Yes
- Type: string
The title of the content.
- url
-
- Required: Yes
- Type: string
The URL of the content.
- urlExpiry
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The expiration time of the URL as an epoch timestamp.
ContentReference
Description
Reference information about the content.
Members
- contentArn
-
- Type: string
The Amazon Resource Name (ARN) of the content.
- contentId
-
- Type: string
The identifier of the content.
- knowledgeBaseArn
-
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Type: string
The identifier of the knowledge base.
ContentSummary
Description
Summary information about the content.
Members
- contentArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the content.
- contentId
-
- Required: Yes
- Type: string
The identifier of the content.
- contentType
-
- Required: Yes
- Type: string
The media type of the content.
- knowledgeBaseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
- metadata
-
- Required: Yes
- Type: Associative array of custom strings keys (NonEmptyString) to strings
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.
- name
-
- Required: Yes
- Type: string
The name of the content.
- revisionId
-
- Required: Yes
- Type: string
The identifier of the revision of the content.
- status
-
- Required: Yes
- Type: string
The status of the content.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- title
-
- Required: Yes
- Type: string
The title of the content.
Document
Description
The document.
Members
- contentReference
-
- Required: Yes
- Type: ContentReference structure
A reference to the content resource.
- excerpt
-
- Type: DocumentText structure
The excerpt from the document.
- title
-
- Type: DocumentText structure
The title of the document.
DocumentText
Description
The text of the document.
Members
- highlights
-
- Type: Array of Highlight structures
Highlights in the document text.
- text
-
- Type: string
Text in the document.
Filter
Description
A search filter.
Members
- field
-
- Required: Yes
- Type: string
The field on which to filter.
- operator
-
- Required: Yes
- Type: string
The operator to use for comparing the field’s value with the provided value.
- value
-
- Required: Yes
- Type: string
The desired field value on which to filter.
Highlight
Description
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
Members
- beginOffsetInclusive
-
- Type: int
The offset for the start of the highlight.
- endOffsetExclusive
-
- Type: int
The offset for the end of the highlight.
KnowledgeBaseAssociationData
Description
Association information about the knowledge base.
Members
- knowledgeBaseArn
-
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Type: string
The identifier of the knowledge base.
KnowledgeBaseData
Description
Information about the knowledge base.
Members
- description
-
- Type: string
The description.
- knowledgeBaseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
- knowledgeBaseType
-
- Required: Yes
- Type: string
The type of knowledge base.
- lastContentModificationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- name
-
- Required: Yes
- Type: string
The name of the knowledge base.
- renderingConfiguration
-
- Type: RenderingConfiguration structure
Information about how to render the content.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
The KMS key used for encryption.
- sourceConfiguration
-
- Type: SourceConfiguration structure
Source configuration information about the knowledge base.
- status
-
- Required: Yes
- Type: string
The status of the knowledge base.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
KnowledgeBaseSummary
Description
Summary information about the knowledge base.
Members
- description
-
- Type: string
The description of the knowledge base.
- knowledgeBaseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
- knowledgeBaseType
-
- Required: Yes
- Type: string
The type of knowledge base.
- name
-
- Required: Yes
- Type: string
The name of the knowledge base.
- renderingConfiguration
-
- Type: RenderingConfiguration structure
Information about how to render the content.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
The KMS key used for encryption.
- sourceConfiguration
-
- Type: SourceConfiguration structure
Configuration information about the external data source.
- status
-
- Required: Yes
- Type: string
The status of the knowledge base summary.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
NotifyRecommendationsReceivedError
Description
An error occurred when creating a recommendation.
Members
- message
-
- Type: string
A recommendation is causing an error.
- recommendationId
-
- Type: string
The identifier of the recommendation that is in error.
PreconditionFailedException
Description
The provided revisionId does not match, indicating the content has been modified since it was last read.
Members
- message
-
- Type: string
QueryRecommendationTriggerData
Description
Data associated with the QUERY RecommendationTriggerType.
Members
- text
-
- Type: string
The text associated with the recommendation trigger.
RecommendationData
Description
Information about the recommendation.
Members
- document
-
- Required: Yes
- Type: Document structure
The recommended document.
- recommendationId
-
- Required: Yes
- Type: string
The identifier of the recommendation.
- relevanceLevel
-
- Type: string
The relevance level of the recommendation.
- relevanceScore
-
- Type: double
The relevance score of the recommendation.
- type
-
- Type: string
The type of recommendation.
RecommendationTrigger
Description
A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.
Members
- data
-
- Required: Yes
- Type: RecommendationTriggerData structure
A union type containing information related to the trigger.
- id
-
- Required: Yes
- Type: string
The identifier of the recommendation trigger.
- recommendationIds
-
- Required: Yes
- Type: Array of strings
The identifiers of the recommendations.
- source
-
- Required: Yes
- Type: string
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.
- type
-
- Required: Yes
- Type: string
The type of recommendation trigger.
RecommendationTriggerData
Description
A union type containing information related to the trigger.
Members
- query
-
- Type: QueryRecommendationTriggerData structure
Data associated with the QUERY RecommendationTriggerType.
RenderingConfiguration
Description
Information about how to render the content.
Members
- templateUri
-
- Type: string
A URI template containing exactly one variable in
${variableName}format. This can only be set forEXTERNALknowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:-
Salesforce:
Id,ArticleNumber,VersionNumber,Title,PublishStatus, orIsDeleted -
ServiceNow:
number,short_description,sys_mod_count,workflow_state, oractive -
Zendesk:
id,title,updated_at, ordraft
The variable is replaced with the actual value for a piece of content when calling GetContent.
ResourceNotFoundException
Description
The specified resource does not exist.
Members
- message
-
- Type: string
- resourceName
-
- Type: string
The specified resource name.
ResultData
Description
Information about the result.
Members
- document
-
- Required: Yes
- Type: Document structure
The document.
- relevanceScore
-
- Type: double
The relevance score of the results.
- resultId
-
- Required: Yes
- Type: string
The identifier of the result data.
SearchExpression
Description
The search expression.
Members
- filters
-
- Required: Yes
- Type: Array of Filter structures
The search expression filters.
ServerSideEncryptionConfiguration
Description
The KMS key used for encryption.
Members
- kmsKeyId
-
- Type: string
The KMS key. For information about valid ID values, see Key identifiers (KeyId).
ServiceQuotaExceededException
Description
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.
Members
- message
-
- Type: string
SessionData
Description
Information about the session.
Members
- description
-
- Type: string
The description of the session.
- name
-
- Required: Yes
- Type: string
The name of the session.
- sessionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the session.
- sessionId
-
- Required: Yes
- Type: string
The identifier of the session.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
SessionSummary
Description
Summary information about the session.
Members
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Wisdom assistant.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Wisdom assistant.
- sessionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the session.
- sessionId
-
- Required: Yes
- Type: string
The identifier of the session.
SourceConfiguration
Description
Configuration information about the external data source.
Members
- appIntegrations
-
- Type: AppIntegrationsConfiguration structure
Configuration information for Amazon AppIntegrations to automatically ingest content.
TooManyTagsException
Description
Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.
Members
- message
-
- Type: string
- resourceName
-
- Type: string
The specified resource name.
ValidationException
Description
The input fails to satisfy the constraints specified by a service.
Members
- message
-
- Type: string