qconnect/aws.sdk.kotlin.services.qconnect.model/AiPromptData

AiPromptData

class AiPromptData

The data for the AI Prompt

Types

object Companion

Properties

val aiPromptArn: String

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

val aiPromptId: String

The identifier of the Amazon Q in Connect AI prompt.

val apiFormat: AiPromptApiFormat

The API format used for this AI Prompt.

val assistantArn: String

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

val assistantId: String

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

val description: String?

The description of the AI Prompt.

val modelId: String

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

val modifiedTime: Instant?

The time the AI Prompt was last modified.

val name: String

The name of the AI Prompt

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

val status: Status?

The status of the AI Prompt.

val tags: Map<String, String>?

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

templateConfiguration

val templateConfiguration: AiPromptTemplateConfiguration?

The configuration of the prompt template for this AI Prompt.

val templateType: AiPromptTemplateType

The type of the prompt template for this AI Prompt.

val type: AiPromptType

The type of this AI Prompt.

visibilityStatus

val visibilityStatus: VisibilityStatus

The visibility status of the AI Prompt.

Functions

inline fun copy(block: AiPromptData.Builder.() -> Unit = {}): AiPromptData

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String