Interface InstructionCollection.Builder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    InstructionCollection.Builder
    customInstructions(String customInstructions)
    Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation.
    InstructionCollection.Builder
    examples(String examples)
    Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries.
    InstructionCollection.Builder
    identity(String identity)
    Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization.
    InstructionCollection.Builder
    outputStyle(String outputStyle)
    Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by-step instructions, or other organizational formats that enhance readability and comprehension.
    InstructionCollection.Builder
    perspective(String perspective)
    Determines the point of view or perspective from which Amazon Q Business generates responses, such as first-person, second-person, or third-person perspective, affecting how information is presented to users.
    InstructionCollection.Builder
    responseLength(String responseLength)
    Specifies the desired length of responses generated by Amazon Q Business.
    InstructionCollection.Builder
    targetAudience(String targetAudience)
    Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately.
    InstructionCollection.Builder
    tone(String tone)
    Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations.

    Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

    copy

    Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

    applyMutation, build

    Methods inherited from interface software.amazon.awssdk.core.SdkPojo

    equalsBySdkFields, sdkFieldNameToField, sdkFields

  • Method Details

    • responseLength

      InstructionCollection.Builder responseLength(String responseLength)

      Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive.

      Parameters:
      responseLength - Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetAudience

      InstructionCollection.Builder targetAudience(String targetAudience)

      Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge.

      Parameters:
      targetAudience - Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • perspective

      InstructionCollection.Builder perspective(String perspective)

      Determines the point of view or perspective from which Amazon Q Business generates responses, such as first-person, second-person, or third-person perspective, affecting how information is presented to users.

      Parameters:
      perspective - Determines the point of view or perspective from which Amazon Q Business generates responses, such as first-person, second-person, or third-person perspective, affecting how information is presented to users.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputStyle

      InstructionCollection.Builder outputStyle(String outputStyle)

      Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by-step instructions, or other organizational formats that enhance readability and comprehension.

      Parameters:
      outputStyle - Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by-step instructions, or other organizational formats that enhance readability and comprehension.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identity

      InstructionCollection.Builder identity(String identity)

      Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization.

      Parameters:
      identity - Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tone

      InstructionCollection.Builder tone(String tone)

      Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations.

      Parameters:
      tone - Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customInstructions

      InstructionCollection.Builder customInstructions(String customInstructions)

      Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation.

      Parameters:
      customInstructions - Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • examples

      InstructionCollection.Builder examples(String examples)

      Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries.

      Parameters:
      examples - Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries.
      Returns:
      Returns a reference to this object so that method calls can be chained together.