Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/bedrock.ts?docs=full";

§Classes

Bedrock

§Interfaces

AutomatedEvaluationConfig

Use to specify a automatic model evaluation job. The EvaluationDatasetMetricConfig object is used to specify the prompt datasets, task type, and metric names.

BatchDeleteEvaluationJobError

A JSON array that provides the status of the model evaluation jobs being deleted.

BatchDeleteEvaluationJobItem

An array of model evaluation jobs to be deleted, and their associated statuses.

BatchDeleteEvaluationJobRequest
BatchDeleteEvaluationJobResponse
CloudWatchConfig

CloudWatch logging configuration.

CreateEvaluationJobRequest
CreateEvaluationJobResponse
CreateGuardrailRequest
CreateGuardrailResponse
CreateGuardrailVersionRequest
CreateGuardrailVersionResponse
CreateModelCopyJobRequest
CreateModelCopyJobResponse
CreateModelCustomizationJobRequest
CreateModelCustomizationJobResponse
CreateModelImportJobRequest
CreateModelImportJobResponse
CreateModelInvocationJobRequest
CreateModelInvocationJobResponse
CreateProvisionedModelThroughputRequest
CreateProvisionedModelThroughputResponse
CustomModelSummary

Summary information for a custom model.

DeleteCustomModelRequest
DeleteGuardrailRequest
DeleteImportedModelRequest
DeleteProvisionedModelThroughputRequest
EvaluationBedrockModel

Contains the ARN of the Amazon Bedrock models specified in your model evaluation job. Each Amazon Bedrock model supports different inferenceParams. To learn more about supported inference parameters for Amazon Bedrock models, see Inference parameters for foundation models.

EvaluationConfig

Used to specify either a AutomatedEvaluationConfig or HumanEvaluationConfig object.

EvaluationDataset

Used to specify the name of a built-in prompt dataset and optionally, the Amazon S3 bucket where a custom prompt dataset is saved.

EvaluationDatasetLocation

The location in Amazon S3 where your prompt dataset is stored.

EvaluationDatasetMetricConfig

Defines the built-in prompt datasets, built-in metric names and custom metric names, and the task type.

EvaluationInferenceConfig

Used to define the models you want used in your model evaluation job. Automated model evaluation jobs support only a single model. In a human-based model evaluation job, your annotator can compare the responses for up to two different models.

EvaluationModelConfig

Defines the models used in the model evaluation job.

EvaluationOutputDataConfig

The Amazon S3 location where the results of your model evaluation job are saved.

EvaluationSummary

A summary of the model evaluation job.

FoundationModelDetails

Information about a foundation model.

FoundationModelLifecycle

Details about whether a model version is available or deprecated.

FoundationModelSummary

Summary information for a foundation model.

GetCustomModelRequest
GetCustomModelResponse
GetEvaluationJobRequest
GetEvaluationJobResponse
GetFoundationModelRequest
GetFoundationModelResponse
GetGuardrailRequest
GetGuardrailResponse
GetImportedModelRequest
GetImportedModelResponse
GetInferenceProfileRequest
GetInferenceProfileResponse
GetModelCopyJobRequest
GetModelCopyJobResponse
GetModelCustomizationJobRequest
GetModelCustomizationJobResponse
GetModelImportJobRequest
GetModelImportJobResponse
GetModelInvocationJobRequest
GetModelInvocationJobResponse
GetModelInvocationLoggingConfigurationResponse
GetProvisionedModelThroughputRequest
GetProvisionedModelThroughputResponse
GuardrailContentFilter

Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.

GuardrailContentFilterConfig

Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.

GuardrailContentPolicy

Contains details about how to handle harmful content.

GuardrailContentPolicyConfig

Contains details about how to handle harmful content.

GuardrailContextualGroundingFilter

The details for the guardrails contextual grounding filter.

GuardrailContextualGroundingFilterConfig

The filter configuration details for the guardrails contextual grounding filter.

GuardrailContextualGroundingPolicy

The details for the guardrails contextual grounding policy.

GuardrailContextualGroundingPolicyConfig

The policy configuration details for the guardrails contextual grounding policy.

GuardrailManagedWords

The managed word list that was configured for the guardrail. (This is a list of words that are pre-defined and managed by guardrails only.)

GuardrailManagedWordsConfig

The managed word list to configure for the guardrail.

GuardrailPiiEntity

The PII entity configured for the guardrail.

GuardrailPiiEntityConfig

The PII entity to configure for the guardrail.

GuardrailRegex

The regular expression configured for the guardrail.

GuardrailRegexConfig

The regular expression to configure for the guardrail.

GuardrailSensitiveInformationPolicy

Contains details about PII entities and regular expressions configured for the guardrail.

GuardrailSensitiveInformationPolicyConfig

Contains details about PII entities and regular expressions to configure for the guardrail.

GuardrailSummary

Contains details about a guardrail.

GuardrailTopic

Details about topics for the guardrail to identify and deny.

GuardrailTopicConfig

Details about topics for the guardrail to identify and deny.

GuardrailTopicPolicy

Contains details about topics that the guardrail should identify and deny.

GuardrailTopicPolicyConfig

Contains details about topics that the guardrail should identify and deny.

GuardrailWord

A word configured for the guardrail.

GuardrailWordConfig

A word to configure for the guardrail.

GuardrailWordPolicy

Contains details about the word policy configured for the guardrail.

GuardrailWordPolicyConfig

Contains details about the word policy to configured for the guardrail.

HumanEvaluationConfig

Specifies the custom metrics, how tasks will be rated, the flow definition ARN, and your custom prompt datasets. Model evaluation jobs use human workers only support the use of custom prompt datasets. To learn more about custom prompt datasets and the required format, see Custom prompt datasets.

HumanEvaluationCustomMetric

In a model evaluation job that uses human workers you must define the name of the metric, and how you want that metric rated ratingMethod, and an optional description of the metric.

HumanWorkflowConfig

Contains SageMakerFlowDefinition object. The object is used to specify the prompt dataset, task type, rating method and metric names.

ImportedModelSummary

Information about tne imported model.

InferenceProfileModel

Contains information about a model.

InferenceProfileSummary

Contains information about an inference profile.

ListCustomModelsRequest
ListCustomModelsResponse
ListEvaluationJobsRequest
ListEvaluationJobsResponse
ListFoundationModelsRequest
ListFoundationModelsResponse
ListGuardrailsRequest
ListGuardrailsResponse
ListImportedModelsRequest
ListImportedModelsResponse
ListInferenceProfilesRequest
ListInferenceProfilesResponse
ListModelCopyJobsRequest
ListModelCopyJobsResponse
ListModelCustomizationJobsRequest
ListModelCustomizationJobsResponse
ListModelImportJobsRequest
ListModelImportJobsResponse
ListModelInvocationJobsRequest
ListModelInvocationJobsResponse
ListProvisionedModelThroughputsRequest
ListProvisionedModelThroughputsResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
LoggingConfig

Configuration fields for invocation logging.

ModelCopyJobSummary

Contains details about each model copy job.

ModelCustomizationJobSummary

Information about one customization job

ModelDataSource

Data source for the imported model.

ModelImportJobSummary

Information about the import job.

ModelInvocationJobInputDataConfig

Details about the location of the input to the batch inference job.

ModelInvocationJobOutputDataConfig

Contains the configuration of the S3 location of the output data.

ModelInvocationJobS3InputDataConfig

Contains the configuration of the S3 location of the output data.

ModelInvocationJobS3OutputDataConfig

Contains the configuration of the S3 location of the output data.

ModelInvocationJobSummary

A summary of a batch inference job.

OutputDataConfig

S3 Location of the output data.

ProvisionedModelSummary

A summary of information about a Provisioned Throughput.

PutModelInvocationLoggingConfigurationRequest
S3Config

S3 configuration for storing log data.

S3DataSource

The Amazon S3 data source of the imported job.

StopEvaluationJobRequest
StopModelCustomizationJobRequest
StopModelInvocationJobRequest
Tag

Definition of the key/value pair for a tag.

TagResourceRequest
TrainingDataConfig

S3 Location of the training data.

TrainingMetrics

Metrics associated with the custom job.

UntagResourceRequest
UpdateGuardrailRequest
UpdateGuardrailResponse
UpdateProvisionedModelThroughputRequest
ValidationDataConfig

Array of up to 10 validators.

Validator

Information about a validator.

ValidatorMetric

The metric for the validator.

VpcConfig

VPC configuration.

§Type Aliases

CommitmentDuration
CustomizationType
EvaluationJobStatus
EvaluationJobType
EvaluationTaskType
FineTuningJobStatus
FoundationModelLifecycleStatus
GuardrailContentFilterType
GuardrailContextualGroundingFilterType
GuardrailFilterStrength
GuardrailManagedWordsType
GuardrailPiiEntityType
GuardrailSensitiveInformationAction
GuardrailStatus
GuardrailTopicType
InferenceProfileStatus
InferenceProfileType
InferenceType
ModelCopyJobStatus
ModelCustomization
ModelCustomizationJobStatus
ModelImportJobStatus
ModelInvocationJobStatus
ModelModality
ProvisionedModelStatus
S3InputFormat
SortByProvisionedModels
SortJobsBy
SortModelsBy
SortOrder