AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Implementation for accessing Bedrock
Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.Namespace: Amazon.Bedrock
Assembly: AWSSDK.Bedrock.dll
Version: 3.x.y.z
public class AmazonBedrockClient : AmazonServiceClient IAmazonBedrock, IAmazonService, IDisposable
The AmazonBedrockClient type exposes the following members
Name | Description | |
---|---|---|
AmazonBedrockClient() |
Constructs AmazonBedrockClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonBedrockClient(RegionEndpoint) |
Constructs AmazonBedrockClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonBedrockClient(AmazonBedrockConfig) |
Constructs AmazonBedrockClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonBedrockClient(AWSCredentials) |
Constructs AmazonBedrockClient with AWS Credentials |
|
AmazonBedrockClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonBedrockClient with AWS Credentials |
|
AmazonBedrockClient(AWSCredentials, AmazonBedrockConfig) |
Constructs AmazonBedrockClient with AWS Credentials and an AmazonBedrockClient Configuration object. |
|
AmazonBedrockClient(string, string) |
Constructs AmazonBedrockClient with AWS Access Key ID and AWS Secret Key |
|
AmazonBedrockClient(string, string, RegionEndpoint) |
Constructs AmazonBedrockClient with AWS Access Key ID and AWS Secret Key |
|
AmazonBedrockClient(string, string, AmazonBedrockConfig) |
Constructs AmazonBedrockClient with AWS Access Key ID, AWS Secret Key and an AmazonBedrockClient Configuration object. |
|
AmazonBedrockClient(string, string, string) |
Constructs AmazonBedrockClient with AWS Access Key ID and AWS Secret Key |
|
AmazonBedrockClient(string, string, string, RegionEndpoint) |
Constructs AmazonBedrockClient with AWS Access Key ID and AWS Secret Key |
|
AmazonBedrockClient(string, string, string, AmazonBedrockConfig) |
Constructs AmazonBedrockClient with AWS Access Key ID, AWS Secret Key and an AmazonBedrockClient Configuration object. |
Name | Type | Description | |
---|---|---|---|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. | |
Paginators | Amazon.Bedrock.Model.IBedrockPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
CreateEvaluationJob(CreateEvaluationJobRequest) |
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. |
|
CreateEvaluationJobAsync(CreateEvaluationJobRequest, CancellationToken) |
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. |
|
CreateGuardrail(CreateGuardrailRequest) |
Creates a guardrail to block topics and to filter out harmful content.
|
|
CreateGuardrailAsync(CreateGuardrailRequest, CancellationToken) |
Creates a guardrail to block topics and to filter out harmful content.
|
|
CreateGuardrailVersion(CreateGuardrailVersionRequest) |
Creates 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. |
|
CreateGuardrailVersionAsync(CreateGuardrailVersionRequest, CancellationToken) |
Creates 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. |
|
CreateModelCustomizationJob(CreateModelCustomizationJobRequest) |
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 For more information, see Custom models in the Amazon Bedrock User Guide. |
|
CreateModelCustomizationJobAsync(CreateModelCustomizationJobRequest, CancellationToken) |
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 For more information, see Custom models in the Amazon Bedrock User Guide. |
|
CreateProvisionedModelThroughput(CreateProvisionedModelThroughputRequest) |
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. |
|
CreateProvisionedModelThroughputAsync(CreateProvisionedModelThroughputRequest, CancellationToken) |
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. |
|
DeleteCustomModel(DeleteCustomModelRequest) |
Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide. |
|
DeleteCustomModelAsync(DeleteCustomModelRequest, CancellationToken) |
Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide. |
|
DeleteGuardrail(DeleteGuardrailRequest) |
Deletes a guardrail.
|
|
DeleteGuardrailAsync(DeleteGuardrailRequest, CancellationToken) |
Deletes a guardrail.
|
|
DeleteModelInvocationLoggingConfiguration(DeleteModelInvocationLoggingConfigurationRequest) |
Delete the invocation logging. |
|
DeleteModelInvocationLoggingConfigurationAsync(DeleteModelInvocationLoggingConfigurationRequest, CancellationToken) |
Delete the invocation logging. |
|
DeleteProvisionedModelThroughput(DeleteProvisionedModelThroughputRequest) |
Deletes 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. |
|
DeleteProvisionedModelThroughputAsync(DeleteProvisionedModelThroughputRequest, CancellationToken) |
Deletes 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. |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
GetCustomModel(GetCustomModelRequest) |
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. |
|
GetCustomModelAsync(GetCustomModelRequest, CancellationToken) |
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. |
|
GetEvaluationJob(GetEvaluationJobRequest) |
Retrieves the properties associated with a model evaluation job, including the status of the job. For more information, see Model evaluations. |
|
GetEvaluationJobAsync(GetEvaluationJobRequest, CancellationToken) |
Retrieves the properties associated with a model evaluation job, including the status of the job. For more information, see Model evaluations. |
|
GetFoundationModel(GetFoundationModelRequest) |
Get details about a Amazon Bedrock foundation model. |
|
GetFoundationModelAsync(GetFoundationModelRequest, CancellationToken) |
Get details about a Amazon Bedrock foundation model. |
|
GetGuardrail(GetGuardrailRequest) |
Gets details about a guardrail. If you don't specify a version, the response returns
details for the |
|
GetGuardrailAsync(GetGuardrailRequest, CancellationToken) |
Gets details about a guardrail. If you don't specify a version, the response returns
details for the |
|
GetModelCustomizationJob(GetModelCustomizationJobRequest) |
Retrieves 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. |
|
GetModelCustomizationJobAsync(GetModelCustomizationJobRequest, CancellationToken) |
Retrieves 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. |
|
GetModelInvocationLoggingConfiguration(GetModelInvocationLoggingConfigurationRequest) |
Get the current configuration values for model invocation logging. |
|
GetModelInvocationLoggingConfigurationAsync(GetModelInvocationLoggingConfigurationRequest, CancellationToken) |
Get the current configuration values for model invocation logging. |
|
GetProvisionedModelThroughput(GetProvisionedModelThroughputRequest) |
Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide. |
|
GetProvisionedModelThroughputAsync(GetProvisionedModelThroughputRequest, CancellationToken) |
Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide. |
|
ListCustomModels(ListCustomModelsRequest) |
Returns a list of the custom models that you have created with the For more information, see Custom models in the Amazon Bedrock User Guide. |
|
ListCustomModelsAsync(ListCustomModelsRequest, CancellationToken) |
Returns a list of the custom models that you have created with the For more information, see Custom models in the Amazon Bedrock User Guide. |
|
ListEvaluationJobs(ListEvaluationJobsRequest) |
Lists model evaluation jobs. |
|
ListEvaluationJobsAsync(ListEvaluationJobsRequest, CancellationToken) |
Lists model evaluation jobs. |
|
ListFoundationModels(ListFoundationModelsRequest) |
Lists 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. |
|
ListFoundationModelsAsync(ListFoundationModelsRequest, CancellationToken) |
Lists 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. |
|
ListGuardrails(ListGuardrailsRequest) |
Lists details about all the guardrails in an account. To list the
You can set the maximum number of results to return in a response in the |
|
ListGuardrailsAsync(ListGuardrailsRequest, CancellationToken) |
Lists details about all the guardrails in an account. To list the
You can set the maximum number of results to return in a response in the |
|
ListModelCustomizationJobs(ListModelCustomizationJobsRequest) |
Returns 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. |
|
ListModelCustomizationJobsAsync(ListModelCustomizationJobsRequest, CancellationToken) |
Returns 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. |
|
ListProvisionedModelThroughputs(ListProvisionedModelThroughputsRequest) |
Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide. |
|
ListProvisionedModelThroughputsAsync(ListProvisionedModelThroughputsRequest, CancellationToken) |
Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide. |
|
ListTagsForResource(ListTagsForResourceRequest) |
List the tags associated with the specified resource. For more information, see Tagging resources in the Amazon Bedrock User Guide. |
|
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) |
List the tags associated with the specified resource. For more information, see Tagging resources in the Amazon Bedrock User Guide. |
|
PutModelInvocationLoggingConfiguration(PutModelInvocationLoggingConfigurationRequest) |
Set the configuration values for model invocation logging. |
|
PutModelInvocationLoggingConfigurationAsync(PutModelInvocationLoggingConfigurationRequest, CancellationToken) |
Set the configuration values for model invocation logging. |
|
StopEvaluationJob(StopEvaluationJobRequest) |
Stops an in progress model evaluation job. |
|
StopEvaluationJobAsync(StopEvaluationJobRequest, CancellationToken) |
Stops an in progress model evaluation job. |
|
StopModelCustomizationJob(StopModelCustomizationJobRequest) |
Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide. |
|
StopModelCustomizationJobAsync(StopModelCustomizationJobRequest, CancellationToken) |
Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide. |
|
TagResource(TagResourceRequest) |
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide. |
|
TagResourceAsync(TagResourceRequest, CancellationToken) |
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide. |
|
UntagResource(UntagResourceRequest) |
Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide. |
|
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide. |
|
UpdateGuardrail(UpdateGuardrailRequest) |
Updates a guardrail with the values you specify.
|
|
UpdateGuardrailAsync(UpdateGuardrailRequest, CancellationToken) |
Updates a guardrail with the values you specify.
|
|
UpdateProvisionedModelThroughput(UpdateProvisionedModelThroughputRequest) |
Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide. |
|
UpdateProvisionedModelThroughputAsync(UpdateProvisionedModelThroughputRequest, CancellationToken) |
Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5