Interface QueryAssistantRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<QueryAssistantRequest.Builder,QueryAssistantRequest>, QConnectRequest.Builder, SdkBuilder<QueryAssistantRequest.Builder,QueryAssistantRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
QueryAssistantRequest
@Mutable @NotThreadSafe public static interface QueryAssistantRequest.Builder extends QConnectRequest.Builder, SdkPojo, CopyableBuilder<QueryAssistantRequest.Builder,QueryAssistantRequest>

  • Method Details

    • assistantId

      QueryAssistantRequest.Builder assistantId(String assistantId)

      The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

      Parameters:
      assistantId - The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryText

      QueryAssistantRequest.Builder queryText(String queryText)

      The text to search for.

      Parameters:
      queryText - The text to search for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      QueryAssistantRequest.Builder nextToken(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      QueryAssistantRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return per page.

      Parameters:
      maxResults - The maximum number of results to return per page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionId

      QueryAssistantRequest.Builder sessionId(String sessionId)

      The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.

      Parameters:
      sessionId - The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryCondition

      QueryAssistantRequest.Builder queryCondition(Collection<QueryCondition> queryCondition)

      Information about how to query content.

      Parameters:
      queryCondition - Information about how to query content.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryCondition

      QueryAssistantRequest.Builder queryCondition(QueryCondition... queryCondition)

      Information about how to query content.

      Parameters:
      queryCondition - Information about how to query content.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryCondition

      QueryAssistantRequest.Builder queryCondition(Consumer<QueryCondition.Builder>... queryCondition)

      Information about how to query content.

      This is a convenience method that creates an instance of the QueryCondition.Builder avoiding the need to create one manually via QueryCondition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queryCondition(List<QueryCondition>).

      Parameters:
      queryCondition - a consumer that will call methods on QueryCondition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • queryInputData

      QueryAssistantRequest.Builder queryInputData(QueryInputData queryInputData)

      Information about the query.

      Parameters:
      queryInputData - Information about the query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryInputData

      default QueryAssistantRequest.Builder queryInputData(Consumer<QueryInputData.Builder> queryInputData)

      Information about the query.

      This is a convenience method that creates an instance of the QueryInputData.Builder avoiding the need to create one manually via QueryInputData.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queryInputData(QueryInputData).

      Parameters:
      queryInputData - a consumer that will call methods on QueryInputData.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideKnowledgeBaseSearchType

      QueryAssistantRequest.Builder overrideKnowledgeBaseSearchType(String overrideKnowledgeBaseSearchType)

      The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text.

      Parameters:
      overrideKnowledgeBaseSearchType - The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideKnowledgeBaseSearchType

      QueryAssistantRequest.Builder overrideKnowledgeBaseSearchType(KnowledgeBaseSearchType overrideKnowledgeBaseSearchType)

      The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text.

      Parameters:
      overrideKnowledgeBaseSearchType - The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      QueryAssistantRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      QueryAssistantRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.