Interface QQueryCardInput.Builder

  • Method Details

    • title

      The title or label of the query card.

      Parameters:
      title - The title or label of the query card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • id

      The unique identifier of the query card.

      Parameters:
      id - The unique identifier of the query card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • type

      The type of the card.

      Parameters:
      type - The type of the card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • type

      The type of the card.

      Parameters:
      type - The type of the card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • prompt

      The prompt or instructions displayed for the query card.

      Parameters:
      prompt - The prompt or instructions displayed for the query card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • outputSource

      QQueryCardInput.Builder outputSource(String outputSource)

      The source or type of output to generate for the query card.

      Parameters:
      outputSource - The source or type of output to generate for the query card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • outputSource

      QQueryCardInput.Builder outputSource(CardOutputSource outputSource)

      The source or type of output to generate for the query card.

      Parameters:
      outputSource - The source or type of output to generate for the query card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • attributeFilter

      QQueryCardInput.Builder attributeFilter(AttributeFilter attributeFilter)

      Turns on filtering of responses based on document attributes or metadata fields.

      Parameters:
      attributeFilter - Turns on filtering of responses based on document attributes or metadata fields.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • attributeFilter

      default QQueryCardInput.Builder attributeFilter(Consumer<AttributeFilter.Builder> attributeFilter)

      Turns on filtering of responses based on document attributes or metadata fields.

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

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

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