Search Quick Responses

connectwisdomservice_search_quick_responses

R Documentation

Searches existing Wisdom quick responses in a Wisdom knowledge base

Description

Searches existing Wisdom quick responses in a Wisdom knowledge base.

Usage

connectwisdomservice_search_quick_responses(attributes, knowledgeBaseId,
  maxResults, nextToken, searchExpression)

Arguments

attributes

The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

knowledgeBaseId

[required] 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.

maxResults

The maximum number of results to return per page.

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

[required] The search expression for querying the quick response.

Value

A list with the following syntax:

list(
  nextToken = "string",
  results = list(
    list(
      attributesInterpolated = list(
        "string"
      ),
      attributesNotInterpolated = list(
        "string"
      ),
      channels = list(
        "string"
      ),
      contentType = "string",
      contents = list(
        markdown = list(
          content = "string"
        ),
        plainText = list(
          content = "string"
        )
      ),
      createdTime = as.POSIXct(
        "2015-01-01"
      ),
      description = "string",
      groupingConfiguration = list(
        criteria = "string",
        values = list(
          "string"
        )
      ),
      isActive = TRUE|FALSE,
      knowledgeBaseArn = "string",
      knowledgeBaseId = "string",
      language = "string",
      lastModifiedBy = "string",
      lastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      name = "string",
      quickResponseArn = "string",
      quickResponseId = "string",
      shortcutKey = "string",
      status = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"CREATED"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETED"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED",
      tags = list(
        "string"
      )
    )
  )
)

Request syntax

svc$search_quick_responses(
  attributes = list(
    "string"
  ),
  knowledgeBaseId = "string",
  maxResults = 123,
  nextToken = "string",
  searchExpression = list(
    filters = list(
      list(
        includeNoExistence = TRUE|FALSE,
        name = "string",
        operator = "EQUALS"|"PREFIX",
        values = list(
          "string"
        )
      )
    ),
    orderOnField = list(
      name = "string",
      order = "ASC"|"DESC"
    ),
    queries = list(
      list(
        allowFuzziness = TRUE|FALSE,
        name = "string",
        operator = "CONTAINS"|"CONTAINS_AND_PREFIX",
        priority = "HIGH"|"MEDIUM"|"LOW",
        values = list(
          "string"
        )
      )
    )
  )
)