Module Values.CreateBatchInferenceJobRequestSource

Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket. To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file. For more information, see Creating a batch inference job . If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job's mode to THEME_GENERATION and specify the name of the field that contains item names in the input data. For more information about generating themes, see Batch recommendations with themes from Content Generator . You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.

Sourcetype nonrec t = {
  1. jobName : Name.t;
    (*

    The name of the batch inference job to create.

    *)
  2. solutionVersionArn : Arn.t;
    (*

    The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

    *)
  3. filterArn : Arn.t option;
    (*

    The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.

    *)
  4. numResults : NumBatchResults.t option;
    (*

    The number of recommendations to retrieve.

    *)
  5. jobInput : BatchInferenceJobInput.t;
    (*

    The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

    *)
  6. jobOutput : BatchInferenceJobOutput.t;
    (*

    The path to the Amazon S3 bucket where the job's output will be stored.

    *)
  7. roleArn : RoleArn.t;
    (*

    The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

    *)
  8. batchInferenceJobConfig : BatchInferenceJobConfig.t option;
    (*

    The configuration details of a batch inference job.

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

    A list of tags to apply to the batch inference job.

    *)
  10. batchInferenceJobMode : BatchInferenceJobMode.t option;
    (*

    The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE. When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.

    *)
  11. themeGenerationConfig : ThemeGenerationConfig.t option;
    (*

    For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.

    *)
}
Sourceval context_ : string
Sourceval make : ?filterArn:??? -> ?numResults:??? -> ?batchInferenceJobConfig:??? -> ?tags:??? -> ?batchInferenceJobMode:??? -> ?themeGenerationConfig:??? -> jobName:Name.t -> solutionVersionArn:Arn.t -> jobInput:BatchInferenceJobInput.t -> jobOutput:BatchInferenceJobOutput.t -> roleArn:RoleArn.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Integer of NumBatchResults.t | `List of [> `Structure of (string * [> `String of TagKey.t ]) list ] list | `String of Name.t | `Structure of (string * [> `Map of ([> `Enum of string | `String of ParameterName.t ] * [> `Double of RankingInfluenceWeight.t | `String of ParameterValue.t ]) list | `Structure of (string * [> `String of S3Location.t ]) list ]) list ]) 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