View Source AWS.Bedrock (aws-elixir v1.0.1)
Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.
Link to this section Summary
Functions
API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers.
Creates a guardrail to block topics and to filter out harmful content.
Creates a version of the guardrail.
Creates a fine-tuning job to customize a base model.
Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify.
Deletes a custom model that you created earlier.
Deletes a guardrail.
Delete the invocation logging.
Deletes a Provisioned Throughput.
Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide.
Retrieves the properties associated with a model evaluation job, including the status of the job.
Get details about a Amazon Bedrock foundation model.
Gets details about a guardrail.
Retrieves the properties associated with a model-customization job, including the status of the job.
Get the current configuration values for model invocation logging.
Returns details for a Provisioned Throughput.
Returns a list of the custom models that you have created with the
CreateModelCustomizationJob
operation.
Lists model evaluation jobs.
Lists Amazon Bedrock foundation models that you can use.
Lists details about all the guardrails in an account.
Returns a list of model customization jobs that you have submitted.
Lists the Provisioned Throughputs in the account.
List the tags associated with the specified resource.
Set the configuration values for model invocation logging.
Stops an in progress model evaluation job.
Stops an active model customization job.
Associate tags with a resource.
Remove one or more tags from a resource.
Updates a guardrail with the values you specify.
Updates the name or associated model for a Provisioned Throughput.
Link to this section Functions
API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers.
To learn more about the requirements for creating a model evaluation job see, Model evaluations.
Creates a guardrail to block topics and to filter out harmful content.
*
Specify a name
and optional description
.
*
Specify messages for when the guardrail successfully blocks a prompt or a model
response in the blockedInputMessaging
and blockedOutputsMessaging
fields.
*
Specify topics for the guardrail to deny in the topicPolicyConfig
object. Each
GuardrailTopicConfig object in the topicsConfig
list pertains to one topic.
*
Give a name
and description
so that the guardrail can properly identify the
topic.
*
Specify DENY
in the type
field.
*
(Optional) Provide up to five prompts that you would categorize as belonging to
the topic in the examples
list.
*
Specify filter strengths for the harmful categories defined in Amazon Bedrock in
the contentPolicyConfig
object. Each
GuardrailContentFilterConfig
object in the filtersConfig
list pertains to a harmful category. For more
information, see Content filters.
For more information about the fields in a content filter, see
GuardrailContentFilterConfig.
*
Specify the category in the type
field.
*
Specify the strength of the filter for prompts in the inputStrength
field and
for model responses in the strength
field of the
GuardrailContentFilterConfig.
*
(Optional) For security, include the ARN of a KMS key in the kmsKeyId
field.
*
(Optional) Attach any tags to the guardrail in the tags
object. For more
information, see Tag resources.
create_guardrail_version(client, guardrail_identifier, input, options \\ [])
View SourceCreates a version of the guardrail.
Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.
Creates a fine-tuning job to customize a base model.
You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes.
For information on the format of training and validation data, see Prepare the datasets.
Model-customization jobs are asynchronous and the completion time depends on the
base model and the training/validation data size.
To monitor a job, use the GetModelCustomizationJob
operation to retrieve the
job status.
For more information, see Custom models in the Amazon Bedrock User Guide.
Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify.
For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
delete_custom_model(client, model_identifier, input, options \\ [])
View SourceDeletes a custom model that you created earlier.
For more information, see Custom models in the Amazon Bedrock User Guide.
delete_guardrail(client, guardrail_identifier, input, options \\ [])
View SourceDeletes a guardrail.
*
To delete a guardrail, only specify the ARN of the guardrail in the
guardrailIdentifier
field. If you delete a guardrail, all of its versions will
be deleted.
*
To delete a version of a guardrail, specify the ARN of the guardrail in the
guardrailIdentifier
field and the version in the guardrailVersion
field.
delete_model_invocation_logging_configuration(client, input, options \\ [])
View SourceDelete the invocation logging.
delete_provisioned_model_throughput(client, provisioned_model_id, input, options \\ [])
View SourceDeletes a Provisioned Throughput.
You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide.
Retrieves the properties associated with a model evaluation job, including the status of the job.
For more information, see Model evaluations.
Get details about a Amazon Bedrock foundation model.
get_guardrail(client, guardrail_identifier, guardrail_version \\ nil, options \\ [])
View SourceGets details about a guardrail.
If you don't specify a version, the response returns details for the DRAFT
version.
get_model_customization_job(client, job_identifier, options \\ [])
View SourceRetrieves the properties associated with a model-customization job, including the status of the job.
For more information, see Custom models in the Amazon Bedrock User Guide.
Get the current configuration values for model invocation logging.
get_provisioned_model_throughput(client, provisioned_model_id, options \\ [])
View SourceReturns details for a Provisioned Throughput.
For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
list_custom_models(client, base_model_arn_equals \\ nil, creation_time_after \\ nil, creation_time_before \\ nil, foundation_model_arn_equals \\ nil, max_results \\ nil, name_contains \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, options \\ [])
View SourceReturns a list of the custom models that you have created with the
CreateModelCustomizationJob
operation.
For more information, see Custom models in the Amazon Bedrock User Guide.
list_evaluation_jobs(client, creation_time_after \\ nil, creation_time_before \\ nil, max_results \\ nil, name_contains \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, status_equals \\ nil, options \\ [])
View SourceLists model evaluation jobs.
list_foundation_models(client, by_customization_type \\ nil, by_inference_type \\ nil, by_output_modality \\ nil, by_provider \\ nil, options \\ [])
View SourceLists Amazon Bedrock foundation models that you can use.
You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.
list_guardrails(client, guardrail_identifier \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists details about all the guardrails in an account.
To list the DRAFT
version of all your guardrails, don't specify the
guardrailIdentifier
field. To list all versions of a guardrail, specify the
ARN of the guardrail in the guardrailIdentifier
field.
You can set the maximum number of results to return in a response in the
maxResults
field. If there are more results than the number you set, the
response returns a nextToken
that you can send in another ListGuardrails
request to see the next batch of results.
list_model_customization_jobs(client, creation_time_after \\ nil, creation_time_before \\ nil, max_results \\ nil, name_contains \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, status_equals \\ nil, options \\ [])
View SourceReturns a list of model customization jobs that you have submitted.
You can filter the jobs to return based on one or more criteria.
For more information, see Custom models in the Amazon Bedrock User Guide.
list_provisioned_model_throughputs(client, creation_time_after \\ nil, creation_time_before \\ nil, max_results \\ nil, model_arn_equals \\ nil, name_contains \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, status_equals \\ nil, options \\ [])
View SourceLists the Provisioned Throughputs in the account.
For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
List the tags associated with the specified resource.
For more information, see Tagging resources in the Amazon Bedrock User Guide.
put_model_invocation_logging_configuration(client, input, options \\ [])
View SourceSet the configuration values for model invocation logging.
Stops an in progress model evaluation job.
stop_model_customization_job(client, job_identifier, input, options \\ [])
View SourceStops an active model customization job.
For more information, see Custom models in the Amazon Bedrock User Guide.
Associate tags with a resource.
For more information, see Tagging resources in the Amazon Bedrock User Guide.
Remove one or more tags from a resource.
For more information, see Tagging resources in the Amazon Bedrock User Guide.
update_guardrail(client, guardrail_identifier, input, options \\ [])
View SourceUpdates a guardrail with the values you specify.
*
Specify a name
and optional description
.
*
Specify messages for when the guardrail successfully blocks a prompt or a model
response in the blockedInputMessaging
and blockedOutputsMessaging
fields.
*
Specify topics for the guardrail to deny in the topicPolicyConfig
object. Each
GuardrailTopicConfig object in the topicsConfig
list pertains to one topic.
*
Give a name
and description
so that the guardrail can properly identify the
topic.
*
Specify DENY
in the type
field.
*
(Optional) Provide up to five prompts that you would categorize as belonging to
the topic in the examples
list.
*
Specify filter strengths for the harmful categories defined in Amazon Bedrock in
the contentPolicyConfig
object. Each
GuardrailContentFilterConfig
object in the filtersConfig
list pertains to a harmful category. For more
information, see Content filters.
For more information about the fields in a content filter, see
GuardrailContentFilterConfig.
*
Specify the category in the type
field.
*
Specify the strength of the filter for prompts in the inputStrength
field and
for model responses in the strength
field of the
GuardrailContentFilterConfig.
*
(Optional) For security, include the ARN of a KMS key in the kmsKeyId
field.
*
(Optional) Attach any tags to the guardrail in the tags
object. For more
information, see Tag resources.
update_provisioned_model_throughput(client, provisioned_model_id, input, options \\ [])
View SourceUpdates the name or associated model for a Provisioned Throughput.
For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.