Interface AIPromptData.Builder

    • Method Detail

      • aiPromptArn

        AIPromptData.Builder aiPromptArn​(String aiPromptArn)

        The Amazon Resource Name (ARN) of the AI Prompt.

        Parameters:
        aiPromptArn - The Amazon Resource Name (ARN) of the AI Prompt.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • aiPromptId

        AIPromptData.Builder aiPromptId​(String aiPromptId)

        The identifier of the Amazon Q in Connect AI prompt.

        Parameters:
        aiPromptId - The identifier of the Amazon Q in Connect AI prompt.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • apiFormat

        AIPromptData.Builder apiFormat​(String apiFormat)

        The API format used for this AI Prompt.

        Parameters:
        apiFormat - The API format used for this AI Prompt.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AIPromptAPIFormat, AIPromptAPIFormat
      • assistantArn

        AIPromptData.Builder assistantArn​(String assistantArn)

        The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

        Parameters:
        assistantArn - The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • assistantId

        AIPromptData.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.
      • description

        AIPromptData.Builder description​(String description)

        The description of the AI Prompt.

        Parameters:
        description - The description of the AI Prompt.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • modelId

        AIPromptData.Builder modelId​(String modelId)

        The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1.

        Parameters:
        modelId - The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • modifiedTime

        AIPromptData.Builder modifiedTime​(Instant modifiedTime)

        The time the AI Prompt was last modified.

        Parameters:
        modifiedTime - The time the AI Prompt was last modified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • name

        AIPromptData.Builder name​(String name)

        The name of the AI Prompt

        Parameters:
        name - The name of the AI Prompt
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • origin

        AIPromptData.Builder origin​(String origin)

        The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.

        Parameters:
        origin - The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Origin, Origin
      • origin

        AIPromptData.Builder origin​(Origin origin)

        The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.

        Parameters:
        origin - The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Origin, Origin
      • status

        AIPromptData.Builder status​(String status)

        The status of the AI Prompt.

        Parameters:
        status - The status of the AI Prompt.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Status, Status
      • status

        AIPromptData.Builder status​(Status status)

        The status of the AI Prompt.

        Parameters:
        status - The status of the AI Prompt.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Status, Status
      • tags

        AIPromptData.Builder tags​(Map<String,​String> tags)

        The tags used to organize, track, or control access for this resource.

        Parameters:
        tags - The tags used to organize, track, or control access for this resource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • templateConfiguration

        AIPromptData.Builder templateConfiguration​(AIPromptTemplateConfiguration templateConfiguration)

        The configuration of the prompt template for this AI Prompt.

        Parameters:
        templateConfiguration - The configuration of the prompt template for this AI Prompt.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • templateType

        AIPromptData.Builder templateType​(String templateType)

        The type of the prompt template for this AI Prompt.

        Parameters:
        templateType - The type of the prompt template for this AI Prompt.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AIPromptTemplateType, AIPromptTemplateType
      • type

        AIPromptData.Builder type​(String type)

        The type of this AI Prompt.

        Parameters:
        type - The type of this AI Prompt.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AIPromptType, AIPromptType
      • visibilityStatus

        AIPromptData.Builder visibilityStatus​(String visibilityStatus)

        The visibility status of the AI Prompt.

        Parameters:
        visibilityStatus - The visibility status of the AI Prompt.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        VisibilityStatus, VisibilityStatus
      • visibilityStatus

        AIPromptData.Builder visibilityStatus​(VisibilityStatus visibilityStatus)

        The visibility status of the AI Prompt.

        Parameters:
        visibilityStatus - The visibility status of the AI Prompt.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        VisibilityStatus, VisibilityStatus