@aws-sdk/client-sagemaker 3.181.0 → 3.182.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist-cjs/commands/CreateFlowDefinitionCommand.js +3 -3
  3. package/dist-cjs/commands/CreateHumanTaskUiCommand.js +3 -3
  4. package/dist-cjs/commands/DescribeEndpointConfigCommand.js +2 -1
  5. package/dist-cjs/commands/DescribeExperimentCommand.js +3 -3
  6. package/dist-cjs/commands/DescribeFeatureGroupCommand.js +1 -2
  7. package/dist-cjs/commands/ListModelsCommand.js +3 -3
  8. package/dist-cjs/commands/ListMonitoringExecutionsCommand.js +3 -3
  9. package/dist-cjs/commands/ListMonitoringSchedulesCommand.js +1 -2
  10. package/dist-cjs/models/models_0.js +104 -41
  11. package/dist-cjs/models/models_1.js +43 -51
  12. package/dist-cjs/models/models_2.js +50 -46
  13. package/dist-cjs/models/models_3.js +44 -4
  14. package/dist-cjs/protocols/Aws_json1_1.js +181 -0
  15. package/dist-es/commands/CreateFlowDefinitionCommand.js +1 -1
  16. package/dist-es/commands/CreateHumanTaskUiCommand.js +1 -1
  17. package/dist-es/commands/DescribeEndpointConfigCommand.js +2 -1
  18. package/dist-es/commands/DescribeExperimentCommand.js +1 -1
  19. package/dist-es/commands/DescribeFeatureGroupCommand.js +1 -2
  20. package/dist-es/commands/ListModelsCommand.js +1 -1
  21. package/dist-es/commands/ListMonitoringExecutionsCommand.js +1 -1
  22. package/dist-es/commands/ListMonitoringSchedulesCommand.js +1 -2
  23. package/dist-es/models/models_0.js +81 -9
  24. package/dist-es/models/models_1.js +9 -26
  25. package/dist-es/models/models_2.js +26 -19
  26. package/dist-es/models/models_3.js +19 -0
  27. package/dist-es/protocols/Aws_json1_1.js +151 -2
  28. package/dist-types/commands/CreateFlowDefinitionCommand.d.ts +1 -1
  29. package/dist-types/commands/CreateHumanTaskUiCommand.d.ts +1 -1
  30. package/dist-types/commands/DescribeEndpointConfigCommand.d.ts +2 -1
  31. package/dist-types/commands/DescribeExperimentCommand.d.ts +1 -1
  32. package/dist-types/commands/DescribeFeatureGroupCommand.d.ts +1 -2
  33. package/dist-types/commands/ListModelsCommand.d.ts +1 -1
  34. package/dist-types/commands/ListMonitoringExecutionsCommand.d.ts +1 -1
  35. package/dist-types/commands/ListMonitoringSchedulesCommand.d.ts +1 -2
  36. package/dist-types/models/models_0.d.ts +348 -528
  37. package/dist-types/models/models_1.d.ts +529 -155
  38. package/dist-types/models/models_2.d.ts +160 -274
  39. package/dist-types/models/models_3.d.ts +279 -3
  40. package/dist-types/ts3.4/commands/CreateFlowDefinitionCommand.d.ts +1 -1
  41. package/dist-types/ts3.4/commands/CreateHumanTaskUiCommand.d.ts +1 -1
  42. package/dist-types/ts3.4/commands/DescribeEndpointConfigCommand.d.ts +2 -4
  43. package/dist-types/ts3.4/commands/DescribeExperimentCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/DescribeFeatureGroupCommand.d.ts +4 -2
  45. package/dist-types/ts3.4/commands/ListModelsCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/ListMonitoringExecutionsCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/ListMonitoringSchedulesCommand.d.ts +4 -2
  48. package/dist-types/ts3.4/models/models_0.d.ts +128 -75
  49. package/dist-types/ts3.4/models/models_1.d.ts +80 -73
  50. package/dist-types/ts3.4/models/models_2.d.ts +78 -100
  51. package/dist-types/ts3.4/models/models_3.d.ts +100 -2
  52. package/package.json +1 -1
@@ -4706,6 +4706,316 @@ export interface ClarifyCheckStepMetadata {
4706
4706
  */
4707
4707
  RegisterNewBaseline?: boolean;
4708
4708
  }
4709
+ export declare enum ClarifyFeatureType {
4710
+ CATEGORICAL = "categorical",
4711
+ NUMERICAL = "numerical",
4712
+ TEXT = "text"
4713
+ }
4714
+ /**
4715
+ * <p>The inference configuration parameter for the model container.</p>
4716
+ */
4717
+ export interface ClarifyInferenceConfig {
4718
+ /**
4719
+ * <p>Provides the JMESPath expression to extract the features from a model container input
4720
+ * in JSON Lines format. For example, if <code>FeaturesAttribute</code> is the JMESPath
4721
+ * expression <code>'myfeatures'</code>, it extracts a list of features
4722
+ * <code>[1,2,3]</code> from request data <code>'{"myfeatures":[1,2,3}'</code>.</p>
4723
+ */
4724
+ FeaturesAttribute?: string;
4725
+ /**
4726
+ * <p>A template string used to format a JSON record into an acceptable model container
4727
+ * input. For example, a <code>ContentTemplate</code> string
4728
+ * <code>'{"myfeatures":$features}'</code> will format a list of features
4729
+ * <code>[1,2,3]</code> into the record string <code>'{"myfeatures":[1,2,3]}'</code>.
4730
+ * Required only when the model container input is in JSON Lines format.</p>
4731
+ */
4732
+ ContentTemplate?: string;
4733
+ /**
4734
+ * <p>The maximum number of records in a request that the model container can process when
4735
+ * querying the model container for the predictions of a <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-synthetic">synthetic dataset</a>. A record is a unit of input data that inference can be
4736
+ * made on, for example, a single line in CSV data. If <code>MaxRecordCount</code> is
4737
+ * <code>1</code>, the model container expects one record per request. A value of 2 or
4738
+ * greater means that the model expects batch requests, which can reduce overhead and speed
4739
+ * up the inferencing process. If this parameter is not provided, the explainer will tune
4740
+ * the record count per request according to the model container's capacity at
4741
+ * runtime.</p>
4742
+ */
4743
+ MaxRecordCount?: number;
4744
+ /**
4745
+ * <p>The maximum payload size (MB) allowed of a request from the explainer to the model
4746
+ * container. Defaults to <code>6</code> MB.</p>
4747
+ */
4748
+ MaxPayloadInMB?: number;
4749
+ /**
4750
+ * <p>A zero-based index used to extract a probability value (score) or list from model
4751
+ * container output in CSV format. If this value is not provided, the entire model
4752
+ * container output will be treated as a probability value (score) or list.</p>
4753
+ * <p>
4754
+ * <b>Example for a single class model:</b> If the model
4755
+ * container output consists of a string-formatted prediction label followed by its
4756
+ * probability: <code>'1,0.6'</code>, set <code>ProbabilityIndex</code> to <code>1</code>
4757
+ * to select the probability value <code>0.6</code>.</p>
4758
+ * <p>
4759
+ * <b>Example for a multiclass model:</b> If the model
4760
+ * container output consists of a string-formatted prediction label followed by its
4761
+ * probability: <code>'"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"'</code>, set
4762
+ * <code>ProbabilityIndex</code> to <code>1</code> to select the probability values
4763
+ * <code>[0.1,0.6,0.3]</code>.</p>
4764
+ */
4765
+ ProbabilityIndex?: number;
4766
+ /**
4767
+ * <p>A zero-based index used to extract a label header or list of label headers from model
4768
+ * container output in CSV format.</p>
4769
+ * <p>
4770
+ * <b>Example for a multiclass model:</b> If the model
4771
+ * container output consists of label headers followed by probabilities:
4772
+ * <code>'"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"'</code>, set
4773
+ * <code>LabelIndex</code> to <code>0</code> to select the label headers
4774
+ * <code>['cat','dog','fish']</code>.</p>
4775
+ */
4776
+ LabelIndex?: number;
4777
+ /**
4778
+ * <p>A JMESPath expression used to extract the probability (or score) from the model
4779
+ * container output if the model container is in JSON Lines format.</p>
4780
+ * <p>
4781
+ * <b>Example</b>: If the model container output of a single
4782
+ * request is <code>'{"predicted_label":1,"probability":0.6}'</code>, then set
4783
+ * <code>ProbabilityAttribute</code> to <code>'probability'</code>.</p>
4784
+ */
4785
+ ProbabilityAttribute?: string;
4786
+ /**
4787
+ * <p>A JMESPath expression used to locate the list of label headers in the model container
4788
+ * output.</p>
4789
+ * <p>
4790
+ * <b>Example</b>: If the model container output of a batch
4791
+ * request is <code>'{"labels":["cat","dog","fish"],"probability":[0.6,0.3,0.1]}'</code>,
4792
+ * then set <code>LabelAttribute</code> to <code>'labels'</code> to extract the list of
4793
+ * label headers <code>["cat","dog","fish"]</code>
4794
+ * </p>
4795
+ */
4796
+ LabelAttribute?: string;
4797
+ /**
4798
+ * <p>For multiclass classification problems, the label headers are the names of the
4799
+ * classes. Otherwise, the label header is the name of the predicted label. These are used
4800
+ * to help readability for the output of the <code>InvokeEndpoint</code> API. See the
4801
+ * <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response">response</a> section under <b>Invoke the endpoint</b>
4802
+ * in the Developer Guide for more information. If there are no label headers in the model
4803
+ * container output, provide them manually using this parameter.</p>
4804
+ */
4805
+ LabelHeaders?: string[];
4806
+ /**
4807
+ * <p>The names of the features. If provided, these are included in the endpoint response
4808
+ * payload to help readability of the <code>InvokeEndpoint</code> output. See the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response">Response</a> section under <b>Invoke the endpoint</b>
4809
+ * in the Developer Guide for more information.</p>
4810
+ */
4811
+ FeatureHeaders?: string[];
4812
+ /**
4813
+ * <p>A list of data types of the features (optional). Applicable only to NLP
4814
+ * explainability. If provided, <code>FeatureTypes</code> must have at least one
4815
+ * <code>'text'</code> string (for example, <code>['text']</code>). If
4816
+ * <code>FeatureTypes</code> is not provided, the explainer infers the feature types
4817
+ * based on the baseline data. The feature types are included in the endpoint response
4818
+ * payload. For additional information see the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response">response</a> section under <b>Invoke the endpoint</b>
4819
+ * in the Developer Guide for more information.</p>
4820
+ */
4821
+ FeatureTypes?: (ClarifyFeatureType | string)[];
4822
+ }
4823
+ /**
4824
+ * <p>The configuration for the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-feature-attribute-shap-baselines.html">SHAP
4825
+ * baseline</a> (also called the background or reference dataset) of the Kernal
4826
+ * SHAP algorithm.</p>
4827
+ * <note>
4828
+ * <ul>
4829
+ * <li>
4830
+ * <p>The number of records in the baseline data determines the size of the
4831
+ * synthetic dataset, which has an impact on latency of explainability
4832
+ * requests. For more information, see the <b>Synthetic
4833
+ * data</b> of <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html">Configure and create an endpoint</a>.</p>
4834
+ * </li>
4835
+ * <li>
4836
+ * <p>
4837
+ * <code>ShapBaseline</code> and <code>ShapBaselineUri</code> are mutually
4838
+ * exclusive parameters. One or the either is required to configure a SHAP
4839
+ * baseline. </p>
4840
+ * </li>
4841
+ * </ul>
4842
+ * </note>
4843
+ */
4844
+ export interface ClarifyShapBaselineConfig {
4845
+ /**
4846
+ * <p>The MIME type of the baseline data. Choose from <code>'text/csv'</code> or
4847
+ * <code>'application/jsonlines'</code>. Defaults to <code>'text/csv'</code>.</p>
4848
+ */
4849
+ MimeType?: string;
4850
+ /**
4851
+ * <p>The inline SHAP baseline data in string format. <code>ShapBaseline</code> can have one
4852
+ * or multiple records to be used as the baseline dataset. The format of the SHAP baseline
4853
+ * file should be the same format as the training dataset. For example, if the training
4854
+ * dataset is in CSV format and each record contains four features, and all features are
4855
+ * numerical, then the format of the baseline data should also share these characteristics.
4856
+ * For natural language processing (NLP) of text columns, the baseline value should be the
4857
+ * value used to replace the unit of text specified by the <code>Granularity</code> of the
4858
+ * <code>TextConfig</code> parameter. The size limit for <code>ShapBasline</code> is 4
4859
+ * KB. Use the <code>ShapBaselineUri</code> parameter if you want to provide more than 4 KB
4860
+ * of baseline data.</p>
4861
+ */
4862
+ ShapBaseline?: string;
4863
+ /**
4864
+ * <p>The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is
4865
+ * stored. The format of the SHAP baseline file should be the same format as the format of
4866
+ * the training dataset. For example, if the training dataset is in CSV format, and each
4867
+ * record in the training dataset has four features, and all features are numerical, then
4868
+ * the baseline file should also have this same format. Each record should contain only the
4869
+ * features. If you are using a virtual private cloud (VPC), the
4870
+ * <code>ShapBaselineUri</code> should be accessible to the VPC. For more information
4871
+ * about setting up endpoints with Amazon Virtual Private Cloud, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html">Give SageMaker access to
4872
+ * Resources in your Amazon Virtual Private Cloud</a>.</p>
4873
+ */
4874
+ ShapBaselineUri?: string;
4875
+ }
4876
+ export declare enum ClarifyTextGranularity {
4877
+ PARAGRAPH = "paragraph",
4878
+ SENTENCE = "sentence",
4879
+ TOKEN = "token"
4880
+ }
4881
+ export declare enum ClarifyTextLanguage {
4882
+ AFRIKAANS = "af",
4883
+ ALBANIAN = "sq",
4884
+ ARABIC = "ar",
4885
+ ARMENIAN = "hy",
4886
+ BASQUE = "eu",
4887
+ BENGALI = "bn",
4888
+ BULGARIAN = "bg",
4889
+ CATALAN = "ca",
4890
+ CHINESE = "zh",
4891
+ CROATIAN = "hr",
4892
+ CZECH = "cs",
4893
+ DANISH = "da",
4894
+ DUTCH = "nl",
4895
+ ENGLISH = "en",
4896
+ ESTONIAN = "et",
4897
+ FINNISH = "fi",
4898
+ FRENCH = "fr",
4899
+ GERMAN = "de",
4900
+ GREEK = "el",
4901
+ GUJARATI = "gu",
4902
+ HEBREW = "he",
4903
+ HINDI = "hi",
4904
+ HUNGARIAN = "hu",
4905
+ ICELANDIC = "is",
4906
+ INDONESIAN = "id",
4907
+ IRISH = "ga",
4908
+ ITALIAN = "it",
4909
+ KANNADA = "kn",
4910
+ KYRGYZ = "ky",
4911
+ LATVIAN = "lv",
4912
+ LIGURIAN = "lij",
4913
+ LITHUANIAN = "lt",
4914
+ LUXEMBOURGISH = "lb",
4915
+ MACEDONIAN = "mk",
4916
+ MALAYALAM = "ml",
4917
+ MARATHI = "mr",
4918
+ MULTI_LANGUAGE = "xx",
4919
+ NEPALI = "ne",
4920
+ NORWEGIAN_BOKMAL = "nb",
4921
+ PERSIAN = "fa",
4922
+ POLISH = "pl",
4923
+ PORTUGUESE = "pt",
4924
+ ROMANIAN = "ro",
4925
+ RUSSIAN = "ru",
4926
+ SANSKRIT = "sa",
4927
+ SERBIAN = "sr",
4928
+ SETSWANA = "tn",
4929
+ SINHALA = "si",
4930
+ SLOVAK = "sk",
4931
+ SLOVENIAN = "sl",
4932
+ SPANISH = "es",
4933
+ SWEDISH = "sv",
4934
+ TAGALOG = "tl",
4935
+ TAMIL = "ta",
4936
+ TATAR = "tt",
4937
+ TELUGU = "te",
4938
+ TURKISH = "tr",
4939
+ UKRAINIAN = "uk",
4940
+ URDU = "ur",
4941
+ YORUBA = "yo"
4942
+ }
4943
+ /**
4944
+ * <p>A parameter used to configure the SageMaker Clarify explainer to treat text features as text so
4945
+ * that explanations are provided for individual units of text. Required only for natural
4946
+ * language processing (NLP) explainability. </p>
4947
+ */
4948
+ export interface ClarifyTextConfig {
4949
+ /**
4950
+ * <p>Specifies the language of the text features in <a href=" https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO 639-1</a> or
4951
+ * <a href="https://en.wikipedia.org/wiki/ISO_639-3">ISO 639-3</a> code of a
4952
+ * supported language. </p>
4953
+ * <note>
4954
+ * <p>For a mix of multiple languages, use code <code>'xx'</code>.</p>
4955
+ * </note>
4956
+ */
4957
+ Language: ClarifyTextLanguage | string | undefined;
4958
+ /**
4959
+ * <p>The unit of granularity for the analysis of text features. For example, if the unit is
4960
+ * <code>'token'</code>, then each token (like a word in English) of the text is
4961
+ * treated as a feature. SHAP values are computed for each unit/feature.</p>
4962
+ */
4963
+ Granularity: ClarifyTextGranularity | string | undefined;
4964
+ }
4965
+ /**
4966
+ * <p>The configuration for SHAP analysis using SageMaker Clarify Explainer.</p>
4967
+ */
4968
+ export interface ClarifyShapConfig {
4969
+ /**
4970
+ * <p>The configuration for the SHAP baseline of the Kernal SHAP algorithm.</p>
4971
+ */
4972
+ ShapBaselineConfig: ClarifyShapBaselineConfig | undefined;
4973
+ /**
4974
+ * <p>The number of samples to be used for analysis by the Kernal SHAP algorithm. </p>
4975
+ * <note>
4976
+ * <p>The number of samples determines the size of the synthetic dataset, which has an
4977
+ * impact on latency of explainability requests. For more information, see the
4978
+ * <b>Synthetic data</b> of <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html">Configure and create an endpoint</a>.</p>
4979
+ * </note>
4980
+ */
4981
+ NumberOfSamples?: number;
4982
+ /**
4983
+ * <p>A Boolean toggle to indicate if you want to use the logit function (true) or log-odds
4984
+ * units (false) for model predictions. Defaults to false.</p>
4985
+ */
4986
+ UseLogit?: boolean;
4987
+ /**
4988
+ * <p>The starting value used to initialize the random number generator in the explainer.
4989
+ * Provide a value for this parameter to obtain a deterministic SHAP result.</p>
4990
+ */
4991
+ Seed?: number;
4992
+ /**
4993
+ * <p>A parameter that indicates if text features are treated as text and explanations are
4994
+ * provided for individual units of text. Required for natural language processing (NLP)
4995
+ * explainability only.</p>
4996
+ */
4997
+ TextConfig?: ClarifyTextConfig;
4998
+ }
4999
+ /**
5000
+ * <p>The configuration parameters for the SageMaker Clarify explainer.</p>
5001
+ */
5002
+ export interface ClarifyExplainerConfig {
5003
+ /**
5004
+ * <p>A JMESPath boolean expression used to filter which records to explain. Explanations
5005
+ * are activated by default. See <a href="https://docs.aws.amazon.com/sagemaker-dg/src/AWSIronmanApiDoc/build/server-root/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable">
5006
+ * <code>EnableExplanations</code>
5007
+ * </a>for additional information.</p>
5008
+ */
5009
+ EnableExplanations?: string;
5010
+ /**
5011
+ * <p>The inference configuration parameter for the model container.</p>
5012
+ */
5013
+ InferenceConfig?: ClarifyInferenceConfig;
5014
+ /**
5015
+ * <p>The configuration for SHAP analysis.</p>
5016
+ */
5017
+ ShapConfig: ClarifyShapConfig | undefined;
5018
+ }
4709
5019
  export declare enum CodeRepositorySortBy {
4710
5020
  CREATION_TIME = "CreationTime",
4711
5021
  LAST_MODIFIED_TIME = "LastModifiedTime",
@@ -7642,6 +7952,16 @@ export interface DataCaptureConfig {
7642
7952
  */
7643
7953
  CaptureContentTypeHeader?: CaptureContentTypeHeader;
7644
7954
  }
7955
+ /**
7956
+ * <p>A parameter to activate explainers.</p>
7957
+ */
7958
+ export interface ExplainerConfig {
7959
+ /**
7960
+ * <p>A member of <code>ExplainerConfig</code> that contains configuration parameters for
7961
+ * the SageMaker Clarify explainer.</p>
7962
+ */
7963
+ ClarifyExplainerConfig?: ClarifyExplainerConfig;
7964
+ }
7645
7965
  export declare enum ProductionVariantAcceleratorType {
7646
7966
  ML_EIA1_LARGE = "ml.eia1.large",
7647
7967
  ML_EIA1_MEDIUM = "ml.eia1.medium",
@@ -7854,6 +8174,10 @@ export interface CreateEndpointConfigInput {
7854
8174
  * required field in order for your Endpoint to be invoked using <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpointAsync.html">InvokeEndpointAsync</a>.</p>
7855
8175
  */
7856
8176
  AsyncInferenceConfig?: AsyncInferenceConfig;
8177
+ /**
8178
+ * <p>A member of <code>CreateEndpointConfig</code> that enables explainers.</p>
8179
+ */
8180
+ ExplainerConfig?: ExplainerConfig;
7857
8181
  }
7858
8182
  export interface CreateEndpointConfigOutput {
7859
8183
  /**
@@ -8558,498 +8882,6 @@ export interface PublicWorkforceTaskPrice {
8558
8882
  */
8559
8883
  AmountInUsd?: USD;
8560
8884
  }
8561
- /**
8562
- * <p>Describes the work to be performed by human workers.</p>
8563
- */
8564
- export interface HumanLoopConfig {
8565
- /**
8566
- * <p>Amazon Resource Name (ARN) of a team of workers. To learn more about the types of
8567
- * workforces and work teams you can create and use with Amazon A2I, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-management.html">Create
8568
- * and Manage Workforces</a>.</p>
8569
- */
8570
- WorkteamArn: string | undefined;
8571
- /**
8572
- * <p>The Amazon Resource Name (ARN) of the human task user interface.</p>
8573
- * <p>You can use standard HTML and Crowd HTML Elements to create a custom worker task
8574
- * template. You use this template to create a human task UI.</p>
8575
- * <p>To learn how to create a custom HTML template, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-custom-templates.html">Create Custom Worker
8576
- * Task Template</a>.</p>
8577
- * <p>To learn how to create a human task UI, which is a worker task template that can be used
8578
- * in a flow definition, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-worker-template-console.html">Create and Delete a Worker Task Templates</a>.</p>
8579
- */
8580
- HumanTaskUiArn: string | undefined;
8581
- /**
8582
- * <p>A title for the human worker task.</p>
8583
- */
8584
- TaskTitle: string | undefined;
8585
- /**
8586
- * <p>A description for the human worker task.</p>
8587
- */
8588
- TaskDescription: string | undefined;
8589
- /**
8590
- * <p>The number of distinct workers who will perform the same task on each object.
8591
- * For example, if <code>TaskCount</code> is set to <code>3</code> for an image classification
8592
- * labeling job, three workers will classify each input image.
8593
- * Increasing <code>TaskCount</code> can improve label accuracy.</p>
8594
- */
8595
- TaskCount: number | undefined;
8596
- /**
8597
- * <p>The length of time that a task remains available for review by human workers.</p>
8598
- */
8599
- TaskAvailabilityLifetimeInSeconds?: number;
8600
- /**
8601
- * <p>The amount of time that a worker has to complete a task. The default value is 3,600
8602
- * seconds (1 hour).</p>
8603
- */
8604
- TaskTimeLimitInSeconds?: number;
8605
- /**
8606
- * <p>Keywords used to describe the task so that workers can discover the task.</p>
8607
- */
8608
- TaskKeywords?: string[];
8609
- /**
8610
- * <p>Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed. </p>
8611
- * <p>Use one of the following prices for bounding box tasks. Prices are in US dollars and
8612
- * should be based on the complexity of the task; the longer it takes in your initial
8613
- * testing, the more you should offer.</p>
8614
- * <ul>
8615
- * <li>
8616
- * <p>0.036</p>
8617
- * </li>
8618
- * <li>
8619
- * <p>0.048</p>
8620
- * </li>
8621
- * <li>
8622
- * <p>0.060</p>
8623
- * </li>
8624
- * <li>
8625
- * <p>0.072</p>
8626
- * </li>
8627
- * <li>
8628
- * <p>0.120</p>
8629
- * </li>
8630
- * <li>
8631
- * <p>0.240</p>
8632
- * </li>
8633
- * <li>
8634
- * <p>0.360</p>
8635
- * </li>
8636
- * <li>
8637
- * <p>0.480</p>
8638
- * </li>
8639
- * <li>
8640
- * <p>0.600</p>
8641
- * </li>
8642
- * <li>
8643
- * <p>0.720</p>
8644
- * </li>
8645
- * <li>
8646
- * <p>0.840</p>
8647
- * </li>
8648
- * <li>
8649
- * <p>0.960</p>
8650
- * </li>
8651
- * <li>
8652
- * <p>1.080</p>
8653
- * </li>
8654
- * <li>
8655
- * <p>1.200</p>
8656
- * </li>
8657
- * </ul>
8658
- * <p>Use one of the following prices for image classification, text classification, and
8659
- * custom tasks. Prices are in US dollars.</p>
8660
- * <ul>
8661
- * <li>
8662
- * <p>0.012</p>
8663
- * </li>
8664
- * <li>
8665
- * <p>0.024</p>
8666
- * </li>
8667
- * <li>
8668
- * <p>0.036</p>
8669
- * </li>
8670
- * <li>
8671
- * <p>0.048</p>
8672
- * </li>
8673
- * <li>
8674
- * <p>0.060</p>
8675
- * </li>
8676
- * <li>
8677
- * <p>0.072</p>
8678
- * </li>
8679
- * <li>
8680
- * <p>0.120</p>
8681
- * </li>
8682
- * <li>
8683
- * <p>0.240</p>
8684
- * </li>
8685
- * <li>
8686
- * <p>0.360</p>
8687
- * </li>
8688
- * <li>
8689
- * <p>0.480</p>
8690
- * </li>
8691
- * <li>
8692
- * <p>0.600</p>
8693
- * </li>
8694
- * <li>
8695
- * <p>0.720</p>
8696
- * </li>
8697
- * <li>
8698
- * <p>0.840</p>
8699
- * </li>
8700
- * <li>
8701
- * <p>0.960</p>
8702
- * </li>
8703
- * <li>
8704
- * <p>1.080</p>
8705
- * </li>
8706
- * <li>
8707
- * <p>1.200</p>
8708
- * </li>
8709
- * </ul>
8710
- * <p>Use one of the following prices for semantic segmentation tasks. Prices are in US
8711
- * dollars.</p>
8712
- * <ul>
8713
- * <li>
8714
- * <p>0.840</p>
8715
- * </li>
8716
- * <li>
8717
- * <p>0.960</p>
8718
- * </li>
8719
- * <li>
8720
- * <p>1.080</p>
8721
- * </li>
8722
- * <li>
8723
- * <p>1.200</p>
8724
- * </li>
8725
- * </ul>
8726
- * <p>Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon
8727
- * Augmented AI review tasks. Prices are in US dollars.</p>
8728
- * <ul>
8729
- * <li>
8730
- * <p>2.400 </p>
8731
- * </li>
8732
- * <li>
8733
- * <p>2.280 </p>
8734
- * </li>
8735
- * <li>
8736
- * <p>2.160 </p>
8737
- * </li>
8738
- * <li>
8739
- * <p>2.040 </p>
8740
- * </li>
8741
- * <li>
8742
- * <p>1.920 </p>
8743
- * </li>
8744
- * <li>
8745
- * <p>1.800 </p>
8746
- * </li>
8747
- * <li>
8748
- * <p>1.680 </p>
8749
- * </li>
8750
- * <li>
8751
- * <p>1.560 </p>
8752
- * </li>
8753
- * <li>
8754
- * <p>1.440 </p>
8755
- * </li>
8756
- * <li>
8757
- * <p>1.320 </p>
8758
- * </li>
8759
- * <li>
8760
- * <p>1.200 </p>
8761
- * </li>
8762
- * <li>
8763
- * <p>1.080 </p>
8764
- * </li>
8765
- * <li>
8766
- * <p>0.960 </p>
8767
- * </li>
8768
- * <li>
8769
- * <p>0.840 </p>
8770
- * </li>
8771
- * <li>
8772
- * <p>0.720 </p>
8773
- * </li>
8774
- * <li>
8775
- * <p>0.600 </p>
8776
- * </li>
8777
- * <li>
8778
- * <p>0.480 </p>
8779
- * </li>
8780
- * <li>
8781
- * <p>0.360 </p>
8782
- * </li>
8783
- * <li>
8784
- * <p>0.240 </p>
8785
- * </li>
8786
- * <li>
8787
- * <p>0.120 </p>
8788
- * </li>
8789
- * <li>
8790
- * <p>0.072 </p>
8791
- * </li>
8792
- * <li>
8793
- * <p>0.060 </p>
8794
- * </li>
8795
- * <li>
8796
- * <p>0.048 </p>
8797
- * </li>
8798
- * <li>
8799
- * <p>0.036 </p>
8800
- * </li>
8801
- * <li>
8802
- * <p>0.024 </p>
8803
- * </li>
8804
- * <li>
8805
- * <p>0.012 </p>
8806
- * </li>
8807
- * </ul>
8808
- * <p>Use one of the following prices for Rekognition DetectModerationLabels Amazon
8809
- * Augmented AI review tasks. Prices are in US dollars.</p>
8810
- * <ul>
8811
- * <li>
8812
- * <p>1.200 </p>
8813
- * </li>
8814
- * <li>
8815
- * <p>1.080 </p>
8816
- * </li>
8817
- * <li>
8818
- * <p>0.960 </p>
8819
- * </li>
8820
- * <li>
8821
- * <p>0.840 </p>
8822
- * </li>
8823
- * <li>
8824
- * <p>0.720 </p>
8825
- * </li>
8826
- * <li>
8827
- * <p>0.600 </p>
8828
- * </li>
8829
- * <li>
8830
- * <p>0.480 </p>
8831
- * </li>
8832
- * <li>
8833
- * <p>0.360 </p>
8834
- * </li>
8835
- * <li>
8836
- * <p>0.240 </p>
8837
- * </li>
8838
- * <li>
8839
- * <p>0.120 </p>
8840
- * </li>
8841
- * <li>
8842
- * <p>0.072 </p>
8843
- * </li>
8844
- * <li>
8845
- * <p>0.060 </p>
8846
- * </li>
8847
- * <li>
8848
- * <p>0.048 </p>
8849
- * </li>
8850
- * <li>
8851
- * <p>0.036 </p>
8852
- * </li>
8853
- * <li>
8854
- * <p>0.024 </p>
8855
- * </li>
8856
- * <li>
8857
- * <p>0.012 </p>
8858
- * </li>
8859
- * </ul>
8860
- * <p>Use one of the following prices for Amazon Augmented AI custom human review tasks.
8861
- * Prices are in US dollars.</p>
8862
- * <ul>
8863
- * <li>
8864
- * <p>1.200 </p>
8865
- * </li>
8866
- * <li>
8867
- * <p>1.080 </p>
8868
- * </li>
8869
- * <li>
8870
- * <p>0.960 </p>
8871
- * </li>
8872
- * <li>
8873
- * <p>0.840 </p>
8874
- * </li>
8875
- * <li>
8876
- * <p>0.720 </p>
8877
- * </li>
8878
- * <li>
8879
- * <p>0.600 </p>
8880
- * </li>
8881
- * <li>
8882
- * <p>0.480 </p>
8883
- * </li>
8884
- * <li>
8885
- * <p>0.360 </p>
8886
- * </li>
8887
- * <li>
8888
- * <p>0.240 </p>
8889
- * </li>
8890
- * <li>
8891
- * <p>0.120 </p>
8892
- * </li>
8893
- * <li>
8894
- * <p>0.072 </p>
8895
- * </li>
8896
- * <li>
8897
- * <p>0.060 </p>
8898
- * </li>
8899
- * <li>
8900
- * <p>0.048 </p>
8901
- * </li>
8902
- * <li>
8903
- * <p>0.036 </p>
8904
- * </li>
8905
- * <li>
8906
- * <p>0.024 </p>
8907
- * </li>
8908
- * <li>
8909
- * <p>0.012 </p>
8910
- * </li>
8911
- * </ul>
8912
- */
8913
- PublicWorkforceTaskPrice?: PublicWorkforceTaskPrice;
8914
- }
8915
- /**
8916
- * <p>Container for configuring the source of human task requests.</p>
8917
- */
8918
- export interface HumanLoopRequestSource {
8919
- /**
8920
- * <p>Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source.
8921
- * The default field settings and JSON parsing rules are different based on the integration source. Valid values:</p>
8922
- */
8923
- AwsManagedHumanLoopRequestSource: AwsManagedHumanLoopRequestSource | string | undefined;
8924
- }
8925
- /**
8926
- * <p>Contains information about where human output will be stored.</p>
8927
- */
8928
- export interface FlowDefinitionOutputConfig {
8929
- /**
8930
- * <p>The Amazon S3 path where the object containing human output will be made available.</p>
8931
- * <p>To learn more about the format of Amazon A2I output data, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-output-data.html">Amazon A2I
8932
- * Output Data</a>.</p>
8933
- */
8934
- S3OutputPath: string | undefined;
8935
- /**
8936
- * <p>The Amazon Key Management Service (KMS) key ID for server-side encryption.</p>
8937
- */
8938
- KmsKeyId?: string;
8939
- }
8940
- export interface CreateFlowDefinitionRequest {
8941
- /**
8942
- * <p>The name of your flow definition.</p>
8943
- */
8944
- FlowDefinitionName: string | undefined;
8945
- /**
8946
- * <p>Container for configuring the source of human task requests. Use to specify if
8947
- * Amazon Rekognition or Amazon Textract is used as an integration source.</p>
8948
- */
8949
- HumanLoopRequestSource?: HumanLoopRequestSource;
8950
- /**
8951
- * <p>An object containing information about the events that trigger a human workflow.</p>
8952
- */
8953
- HumanLoopActivationConfig?: HumanLoopActivationConfig;
8954
- /**
8955
- * <p>An object containing information about the tasks the human reviewers will perform.</p>
8956
- */
8957
- HumanLoopConfig: HumanLoopConfig | undefined;
8958
- /**
8959
- * <p>An object containing information about where the human review results will be uploaded.</p>
8960
- */
8961
- OutputConfig: FlowDefinitionOutputConfig | undefined;
8962
- /**
8963
- * <p>The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, <code>arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298</code>.</p>
8964
- */
8965
- RoleArn: string | undefined;
8966
- /**
8967
- * <p>An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.</p>
8968
- */
8969
- Tags?: Tag[];
8970
- }
8971
- export interface CreateFlowDefinitionResponse {
8972
- /**
8973
- * <p>The Amazon Resource Name (ARN) of the flow definition you create.</p>
8974
- */
8975
- FlowDefinitionArn: string | undefined;
8976
- }
8977
- /**
8978
- * <p>The Liquid template for the worker user interface.</p>
8979
- */
8980
- export interface UiTemplate {
8981
- /**
8982
- * <p>The content of the Liquid template for the worker user interface.</p>
8983
- */
8984
- Content: string | undefined;
8985
- }
8986
- export interface CreateHumanTaskUiRequest {
8987
- /**
8988
- * <p>The name of the user interface you are creating.</p>
8989
- */
8990
- HumanTaskUiName: string | undefined;
8991
- /**
8992
- * <p>The Liquid template for the worker user interface.</p>
8993
- */
8994
- UiTemplate: UiTemplate | undefined;
8995
- /**
8996
- * <p>An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.</p>
8997
- */
8998
- Tags?: Tag[];
8999
- }
9000
- export interface CreateHumanTaskUiResponse {
9001
- /**
9002
- * <p>The Amazon Resource Name (ARN) of the human review workflow user interface you create.</p>
9003
- */
9004
- HumanTaskUiArn: string | undefined;
9005
- }
9006
- /**
9007
- * <p>For a hyperparameter of the integer type, specifies the range
9008
- * that
9009
- * a hyperparameter tuning job searches.</p>
9010
- */
9011
- export interface IntegerParameterRange {
9012
- /**
9013
- * <p>The name of the hyperparameter to search.</p>
9014
- */
9015
- Name: string | undefined;
9016
- /**
9017
- * <p>The minimum
9018
- * value
9019
- * of the hyperparameter to search.</p>
9020
- */
9021
- MinValue: string | undefined;
9022
- /**
9023
- * <p>The maximum
9024
- * value
9025
- * of the hyperparameter to search.</p>
9026
- */
9027
- MaxValue: string | undefined;
9028
- /**
9029
- * <p>The scale that hyperparameter tuning uses to search the hyperparameter range. For
9030
- * information about choosing a hyperparameter scale, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type">Hyperparameter Scaling</a>. One of the following values:</p>
9031
- * <dl>
9032
- * <dt>Auto</dt>
9033
- * <dd>
9034
- * <p>SageMaker hyperparameter tuning chooses the best scale for the
9035
- * hyperparameter.</p>
9036
- * </dd>
9037
- * <dt>Linear</dt>
9038
- * <dd>
9039
- * <p>Hyperparameter tuning searches the values in the hyperparameter range by
9040
- * using a linear scale.</p>
9041
- * </dd>
9042
- * <dt>Logarithmic</dt>
9043
- * <dd>
9044
- * <p>Hyperparameter tuning searches the values in the hyperparameter range by
9045
- * using a logarithmic scale.</p>
9046
- * <p>Logarithmic scaling works only for ranges that have only values greater
9047
- * than 0.</p>
9048
- * </dd>
9049
- * </dl>
9050
- */
9051
- ScalingType?: HyperParameterScalingType | string;
9052
- }
9053
8885
  /**
9054
8886
  * @internal
9055
8887
  */
@@ -9446,6 +9278,26 @@ export declare const CheckpointConfigFilterSensitiveLog: (obj: CheckpointConfig)
9446
9278
  * @internal
9447
9279
  */
9448
9280
  export declare const ClarifyCheckStepMetadataFilterSensitiveLog: (obj: ClarifyCheckStepMetadata) => any;
9281
+ /**
9282
+ * @internal
9283
+ */
9284
+ export declare const ClarifyInferenceConfigFilterSensitiveLog: (obj: ClarifyInferenceConfig) => any;
9285
+ /**
9286
+ * @internal
9287
+ */
9288
+ export declare const ClarifyShapBaselineConfigFilterSensitiveLog: (obj: ClarifyShapBaselineConfig) => any;
9289
+ /**
9290
+ * @internal
9291
+ */
9292
+ export declare const ClarifyTextConfigFilterSensitiveLog: (obj: ClarifyTextConfig) => any;
9293
+ /**
9294
+ * @internal
9295
+ */
9296
+ export declare const ClarifyShapConfigFilterSensitiveLog: (obj: ClarifyShapConfig) => any;
9297
+ /**
9298
+ * @internal
9299
+ */
9300
+ export declare const ClarifyExplainerConfigFilterSensitiveLog: (obj: ClarifyExplainerConfig) => any;
9449
9301
  /**
9450
9302
  * @internal
9451
9303
  */
@@ -9790,6 +9642,10 @@ export declare const CreateEndpointOutputFilterSensitiveLog: (obj: CreateEndpoin
9790
9642
  * @internal
9791
9643
  */
9792
9644
  export declare const DataCaptureConfigFilterSensitiveLog: (obj: DataCaptureConfig) => any;
9645
+ /**
9646
+ * @internal
9647
+ */
9648
+ export declare const ExplainerConfigFilterSensitiveLog: (obj: ExplainerConfig) => any;
9793
9649
  /**
9794
9650
  * @internal
9795
9651
  */
@@ -9866,39 +9722,3 @@ export declare const USDFilterSensitiveLog: (obj: USD) => any;
9866
9722
  * @internal
9867
9723
  */
9868
9724
  export declare const PublicWorkforceTaskPriceFilterSensitiveLog: (obj: PublicWorkforceTaskPrice) => any;
9869
- /**
9870
- * @internal
9871
- */
9872
- export declare const HumanLoopConfigFilterSensitiveLog: (obj: HumanLoopConfig) => any;
9873
- /**
9874
- * @internal
9875
- */
9876
- export declare const HumanLoopRequestSourceFilterSensitiveLog: (obj: HumanLoopRequestSource) => any;
9877
- /**
9878
- * @internal
9879
- */
9880
- export declare const FlowDefinitionOutputConfigFilterSensitiveLog: (obj: FlowDefinitionOutputConfig) => any;
9881
- /**
9882
- * @internal
9883
- */
9884
- export declare const CreateFlowDefinitionRequestFilterSensitiveLog: (obj: CreateFlowDefinitionRequest) => any;
9885
- /**
9886
- * @internal
9887
- */
9888
- export declare const CreateFlowDefinitionResponseFilterSensitiveLog: (obj: CreateFlowDefinitionResponse) => any;
9889
- /**
9890
- * @internal
9891
- */
9892
- export declare const UiTemplateFilterSensitiveLog: (obj: UiTemplate) => any;
9893
- /**
9894
- * @internal
9895
- */
9896
- export declare const CreateHumanTaskUiRequestFilterSensitiveLog: (obj: CreateHumanTaskUiRequest) => any;
9897
- /**
9898
- * @internal
9899
- */
9900
- export declare const CreateHumanTaskUiResponseFilterSensitiveLog: (obj: CreateHumanTaskUiResponse) => any;
9901
- /**
9902
- * @internal
9903
- */
9904
- export declare const IntegerParameterRangeFilterSensitiveLog: (obj: IntegerParameterRange) => any;