Module Values.AIPromptDataSource

The data for the AI Prompt

Sourcetype nonrec t = {
  1. assistantId : Uuid.t option;
    (*

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

    *)
  2. assistantArn : Arn.t option;
    (*

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

    *)
  3. aiPromptId : Uuid.t option;
    (*

    The identifier of the Amazon Q in Connect AI prompt.

    *)
  4. aiPromptArn : Arn.t option;
    (*

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

    *)
  5. name : Name.t option;
    (*

    The name of the AI Prompt

    *)
  6. type_ : AIPromptType.t option;
    (*

    The type of this AI Prompt.

    *)
  7. templateType : AIPromptTemplateType.t option;
    (*

    The type of the prompt template for this AI Prompt.

    *)
  8. modelId : AIPromptModelIdentifier.t option;
    (*

    The identifier of the model used for this AI Prompt. The following model Ids are supported: anthropic.claude-3-haiku--v1:0 apac.amazon.nova-lite-v1:0 apac.amazon.nova-micro-v1:0 apac.amazon.nova-pro-v1:0 apac.anthropic.claude-3-5-sonnet--v2:0 apac.anthropic.claude-3-haiku-20240307-v1:0 eu.amazon.nova-lite-v1:0 eu.amazon.nova-micro-v1:0 eu.amazon.nova-pro-v1:0 eu.anthropic.claude-3-7-sonnet-20250219-v1:0 eu.anthropic.claude-3-haiku-20240307-v1:0 us.amazon.nova-lite-v1:0 us.amazon.nova-micro-v1:0 us.amazon.nova-pro-v1:0 us.anthropic.claude-3-5-haiku-20241022-v1:0 us.anthropic.claude-3-7-sonnet-20250219-v1:0 us.anthropic.claude-3-haiku-20240307-v1:0

    *)
  9. apiFormat : AIPromptAPIFormat.t option;
    (*

    The API format used for this AI Prompt.

    *)
  10. templateConfiguration : AIPromptTemplateConfiguration.t option;
    (*

    The configuration of the prompt template for this AI Prompt.

    *)
  11. inferenceConfiguration : AIPromptInferenceConfiguration.t option;
    (*

    The configuration for inference parameters when using the AI Prompt.

    *)
  12. modifiedTime : Timestamp.t option;
    (*

    The time the AI Prompt was last modified.

    *)
  13. description : Description.t option;
    (*

    The description of the AI Prompt.

    *)
  14. visibilityStatus : VisibilityStatus.t option;
    (*

    The visibility status of the AI Prompt.

    *)
  15. tags : Tags.t option;
    (*

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

    *)
  16. origin : Origin.t option;
    (*

    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.

    *)
  17. status : Status.t option;
    (*

    The status of the AI Prompt.

    *)
}
Sourceval make : ?assistantId:??? -> ?assistantArn:??? -> ?aiPromptId:??? -> ?aiPromptArn:??? -> ?name:??? -> ?type_:??? -> ?templateType:??? -> ?modelId:??? -> ?apiFormat:??? -> ?templateConfiguration:??? -> ?inferenceConfiguration:??? -> ?modifiedTime:??? -> ?description:??? -> ?visibilityStatus:??? -> ?tags:??? -> ?origin:??? -> ?status:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Map of ([> `String of TagKey.t ] * [> `String of TagValue.t ]) list | `String of Uuid.t | `Structure of (string * [> `Float of Probability.t | `Integer of TopK.t | `Structure of (string * [> `String of TextAIPrompt.t ]) list ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t