Query Assistant

connectwisdomservice_query_assistant

R Documentation

Performs a manual search against the specified assistant

Description

Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use get_recommendations.

Usage

connectwisdomservice_query_assistant(assistantId, maxResults, nextToken,
  queryText)

Arguments

assistantId

[required] The identifier of the Wisdom assistant. 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.

queryText

[required] The text to search for.

Value

A list with the following syntax:

list(
  nextToken = "string",
  results = list(
    list(
      document = list(
        contentReference = list(
          contentArn = "string",
          contentId = "string",
          knowledgeBaseArn = "string",
          knowledgeBaseId = "string"
        ),
        excerpt = list(
          highlights = list(
            list(
              beginOffsetInclusive = 123,
              endOffsetExclusive = 123
            )
          ),
          text = "string"
        ),
        title = list(
          highlights = list(
            list(
              beginOffsetInclusive = 123,
              endOffsetExclusive = 123
            )
          ),
          text = "string"
        )
      ),
      relevanceScore = 123.0,
      resultId = "string"
    )
  )
)

Request syntax

svc$query_assistant(
  assistantId = "string",
  maxResults = 123,
  nextToken = "string",
  queryText = "string"
)