Interface CreateAiPromptRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateAiPromptRequest.Builder,CreateAiPromptRequest>, QConnectRequest.Builder, SdkBuilder<CreateAiPromptRequest.Builder,CreateAiPromptRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateAiPromptRequest

@Mutable
@NotThreadSafe
public static interface CreateAiPromptRequest.Builder
extends QConnectRequest.Builder, SdkPojo, CopyableBuilder<CreateAiPromptRequest.Builder,CreateAiPromptRequest>

Method Summary

Modifier and Type	Method	Description
CreateAiPromptRequest.Builder	apiFormat(String apiFormat)	The API Format of the AI Prompt.
CreateAiPromptRequest.Builder	apiFormat(AIPromptAPIFormat apiFormat)	The API Format of the AI Prompt.
CreateAiPromptRequest.Builder	assistantId(String assistantId)	The identifier of the Amazon Q in Connect assistant.
CreateAiPromptRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateAiPromptRequest.Builder	description(String description)	The description of the AI Prompt.
CreateAiPromptRequest.Builder	modelId(String modelId)	The identifier of the model used for this AI Prompt.
CreateAiPromptRequest.Builder	name(String name)	The name of the AI Prompt.
CreateAiPromptRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateAiPromptRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateAiPromptRequest.Builder	tags(Map<String,String> tags)	The tags used to organize, track, or control access for this resource.
default CreateAiPromptRequest.Builder	templateConfiguration(Consumer<AIPromptTemplateConfiguration.Builder> templateConfiguration)	The configuration of the prompt template for this AI Prompt.
CreateAiPromptRequest.Builder	templateConfiguration(AIPromptTemplateConfiguration templateConfiguration)	The configuration of the prompt template for this AI Prompt.
CreateAiPromptRequest.Builder	templateType(String templateType)	The type of the prompt template for this AI Prompt.
CreateAiPromptRequest.Builder	templateType(AIPromptTemplateType templateType)	The type of the prompt template for this AI Prompt.
CreateAiPromptRequest.Builder	type(String type)	The type of this AI Prompt.
CreateAiPromptRequest.Builder	type(AIPromptType type)	The type of this AI Prompt.
CreateAiPromptRequest.Builder	visibilityStatus(String visibilityStatus)	The visibility status of the AI Prompt.
CreateAiPromptRequest.Builder	visibilityStatus(VisibilityStatus visibilityStatus)	The visibility status of the AI Prompt.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.qconnect.model.QConnectRequest.Builder

build

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

clientToken

CreateAiPromptRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

Returns:

Returns a reference to this object so that method calls can be chained together.

assistantId

CreateAiPromptRequest.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.

name

CreateAiPromptRequest.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.

type

CreateAiPromptRequest.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

type

CreateAiPromptRequest.Builder type(AIPromptType 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

templateConfiguration

CreateAiPromptRequest.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.

templateConfiguration

default CreateAiPromptRequest.Builder templateConfiguration(Consumer<AIPromptTemplateConfiguration.Builder> templateConfiguration)

The configuration of the prompt template for this AI Prompt.

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

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

Parameters:

templateConfiguration - a consumer that will call methods on AIPromptTemplateConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• templateConfiguration(AIPromptTemplateConfiguration)

visibilityStatus

CreateAiPromptRequest.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

CreateAiPromptRequest.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

templateType

CreateAiPromptRequest.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

templateType

CreateAiPromptRequest.Builder templateType(AIPromptTemplateType 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

modelId

CreateAiPromptRequest.Builder modelId(String modelId)

The identifier of the model used for this AI Prompt.

Parameters:

modelId - The identifier of the model used for this AI Prompt.

Returns:

Returns a reference to this object so that method calls can be chained together.

apiFormat

CreateAiPromptRequest.Builder apiFormat(String apiFormat)

The API Format of the AI Prompt.

Recommended values: MESSAGES | TEXT_COMPLETIONS

The values ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS will be deprecated.

Parameters:

apiFormat - The API Format of the AI Prompt.

Recommended values: MESSAGES | TEXT_COMPLETIONS

The values ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS will be deprecated.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• AIPromptAPIFormat
• AIPromptAPIFormat

apiFormat

CreateAiPromptRequest.Builder apiFormat(AIPromptAPIFormat apiFormat)

The API Format of the AI Prompt.

Recommended values: MESSAGES | TEXT_COMPLETIONS

The values ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS will be deprecated.

Parameters:

apiFormat - The API Format of the AI Prompt.

Recommended values: MESSAGES | TEXT_COMPLETIONS

The values ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS will be deprecated.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• AIPromptAPIFormat
• AIPromptAPIFormat

tags

CreateAiPromptRequest.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.

description

CreateAiPromptRequest.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.

overrideConfiguration

CreateAiPromptRequest.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

CreateAiPromptRequest.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.