Documentation ¶
Index ¶
- type AccessDeniedException
- type AutomatedEvaluationConfig
- type CloudWatchConfig
- type CommitmentDuration
- type ConflictException
- type CustomModelSummary
- type CustomizationType
- type EvaluationBedrockModel
- type EvaluationConfig
- type EvaluationConfigMemberAutomated
- type EvaluationConfigMemberHuman
- type EvaluationDataset
- type EvaluationDatasetLocation
- type EvaluationDatasetLocationMemberS3Uri
- type EvaluationDatasetMetricConfig
- type EvaluationInferenceConfig
- type EvaluationInferenceConfigMemberModels
- type EvaluationJobStatus
- type EvaluationJobType
- type EvaluationModelConfig
- type EvaluationModelConfigMemberBedrockModel
- type EvaluationOutputDataConfig
- type EvaluationSummary
- type EvaluationTaskType
- type FineTuningJobStatus
- type FoundationModelDetails
- type FoundationModelLifecycle
- type FoundationModelLifecycleStatus
- type FoundationModelSummary
- type GuardrailContentFilter
- type GuardrailContentFilterConfig
- type GuardrailContentFilterType
- type GuardrailContentPolicy
- type GuardrailContentPolicyConfig
- type GuardrailFilterStrength
- type GuardrailManagedWords
- type GuardrailManagedWordsConfig
- type GuardrailManagedWordsType
- type GuardrailPiiEntity
- type GuardrailPiiEntityConfig
- type GuardrailPiiEntityType
- type GuardrailRegex
- type GuardrailRegexConfig
- type GuardrailSensitiveInformationAction
- type GuardrailSensitiveInformationPolicy
- type GuardrailSensitiveInformationPolicyConfig
- type GuardrailStatus
- type GuardrailSummary
- type GuardrailTopic
- type GuardrailTopicConfig
- type GuardrailTopicPolicy
- type GuardrailTopicPolicyConfig
- type GuardrailTopicType
- type GuardrailWord
- type GuardrailWordConfig
- type GuardrailWordPolicy
- type GuardrailWordPolicyConfig
- type HumanEvaluationConfig
- type HumanEvaluationCustomMetric
- type HumanWorkflowConfig
- type InferenceType
- type InternalServerException
- type LoggingConfig
- type ModelCustomization
- type ModelCustomizationJobStatus
- type ModelCustomizationJobSummary
- type ModelModality
- type OutputDataConfig
- type ProvisionedModelStatus
- type ProvisionedModelSummary
- type ResourceNotFoundException
- type S3Config
- type ServiceQuotaExceededException
- type SortByProvisionedModels
- type SortJobsBy
- type SortModelsBy
- type SortOrder
- type Tag
- type ThrottlingException
- type TooManyTagsException
- type TrainingDataConfig
- type TrainingMetrics
- type UnknownUnionMember
- type ValidationDataConfig
- type ValidationException
- type Validator
- type ValidatorMetric
- type VpcConfig
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request is denied because of missing access permissions.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type AutomatedEvaluationConfig ¶ added in v1.8.0
type AutomatedEvaluationConfig struct { // Specifies the required elements for an automatic model evaluation job. // // This member is required. DatasetMetricConfigs []EvaluationDatasetMetricConfig // contains filtered or unexported fields }
Use to specify a automatic model evaluation job. The EvaluationDatasetMetricConfig object is used to specify the prompt datasets, task type, and metric names.
type CloudWatchConfig ¶
type CloudWatchConfig struct { // The log group name. // // This member is required. LogGroupName *string // The role Amazon Resource Name (ARN). // // This member is required. RoleArn *string // S3 configuration for delivering a large amount of data. LargeDataDeliveryS3Config *S3Config // contains filtered or unexported fields }
CloudWatch logging configuration.
type CommitmentDuration ¶ added in v1.1.0
type CommitmentDuration string
const ( CommitmentDurationOneMonth CommitmentDuration = "OneMonth" CommitmentDurationSixMonths CommitmentDuration = "SixMonths" )
Enum values for CommitmentDuration
func (CommitmentDuration) Values ¶ added in v1.1.0
func (CommitmentDuration) Values() []CommitmentDuration
Values returns all known values for CommitmentDuration. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ConflictException ¶
type ConflictException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
Error occurred because of a conflict while performing an operation.
func (*ConflictException) Error ¶
func (e *ConflictException) Error() string
func (*ConflictException) ErrorCode ¶
func (e *ConflictException) ErrorCode() string
func (*ConflictException) ErrorFault ¶
func (e *ConflictException) ErrorFault() smithy.ErrorFault
func (*ConflictException) ErrorMessage ¶
func (e *ConflictException) ErrorMessage() string
type CustomModelSummary ¶
type CustomModelSummary struct { // The base model Amazon Resource Name (ARN). // // This member is required. BaseModelArn *string // The base model name. // // This member is required. BaseModelName *string // Creation time of the model. // // This member is required. CreationTime *time.Time // The Amazon Resource Name (ARN) of the custom model. // // This member is required. ModelArn *string // The name of the custom model. // // This member is required. ModelName *string // Specifies whether to carry out continued pre-training of a model or whether to // fine-tune it. For more information, see Custom models (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) // . CustomizationType CustomizationType // contains filtered or unexported fields }
Summary information for a custom model.
type CustomizationType ¶ added in v1.4.0
type CustomizationType string
const ( CustomizationTypeFineTuning CustomizationType = "FINE_TUNING" CustomizationTypeContinuedPreTraining CustomizationType = "CONTINUED_PRE_TRAINING" )
Enum values for CustomizationType
func (CustomizationType) Values ¶ added in v1.4.0
func (CustomizationType) Values() []CustomizationType
Values returns all known values for CustomizationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationBedrockModel ¶ added in v1.8.0
type EvaluationBedrockModel struct { // Each Amazon Bedrock support different inference parameters that change how the // model behaves during inference. // // This member is required. InferenceParams *string // The ARN of the Amazon Bedrock model specified. // // This member is required. ModelIdentifier *string // contains filtered or unexported fields }
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 (https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-prompt-datasets-custom.html) . The inferenceParams are specified using JSON. To successfully insert JSON as string make sure that all quotations are properly escaped. For example, "temperature":"0.25" key value pair would need to be formatted as \"temperature\":\"0.25\" to successfully accepted in the request.
type EvaluationConfig ¶ added in v1.8.0
type EvaluationConfig interface {
// contains filtered or unexported methods
}
Used to specify either a AutomatedEvaluationConfig or HumanEvaluationConfig object.
The following types satisfy this interface:
EvaluationConfigMemberAutomated EvaluationConfigMemberHuman
Example (OutputUsage) ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/bedrock/types" ) func main() { var union types.EvaluationConfig // type switches can be used to check the union value switch v := union.(type) { case *types.EvaluationConfigMemberAutomated: _ = v.Value // Value is types.AutomatedEvaluationConfig case *types.EvaluationConfigMemberHuman: _ = v.Value // Value is types.HumanEvaluationConfig case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
Output:
type EvaluationConfigMemberAutomated ¶ added in v1.8.0
type EvaluationConfigMemberAutomated struct { Value AutomatedEvaluationConfig // contains filtered or unexported fields }
Used to specify an automated model evaluation job. See AutomatedEvaluationConfig to view the required parameters.
type EvaluationConfigMemberHuman ¶ added in v1.8.0
type EvaluationConfigMemberHuman struct { Value HumanEvaluationConfig // contains filtered or unexported fields }
Used to specify a model evaluation job that uses human workers.See HumanEvaluationConfig to view the required parameters.
type EvaluationDataset ¶ added in v1.8.0
type EvaluationDataset struct { // Used to specify supported built-in prompt datasets. Valid values are // Builtin.Bold , Builtin.BoolQ , Builtin.NaturalQuestions , Builtin.Gigaword , // Builtin.RealToxicityPrompts , Builtin.TriviaQa , Builtin.T-Rex , // Builtin.WomensEcommerceClothingReviews and Builtin.Wikitext2 . // // This member is required. Name *string // For custom prompt datasets, you must specify the location in Amazon S3 where // the prompt dataset is saved. DatasetLocation EvaluationDatasetLocation // contains filtered or unexported fields }
Used to specify the name of a built-in prompt dataset and optionally, the Amazon S3 bucket where a custom prompt dataset is saved.
type EvaluationDatasetLocation ¶ added in v1.8.0
type EvaluationDatasetLocation interface {
// contains filtered or unexported methods
}
The location in Amazon S3 where your prompt dataset is stored.
The following types satisfy this interface:
EvaluationDatasetLocationMemberS3Uri
Example (OutputUsage) ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/bedrock/types" ) func main() { var union types.EvaluationDatasetLocation // type switches can be used to check the union value switch v := union.(type) { case *types.EvaluationDatasetLocationMemberS3Uri: _ = v.Value // Value is string case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
Output:
type EvaluationDatasetLocationMemberS3Uri ¶ added in v1.8.0
type EvaluationDatasetLocationMemberS3Uri struct { Value string // contains filtered or unexported fields }
The S3 URI of the S3 bucket specified in the job.
type EvaluationDatasetMetricConfig ¶ added in v1.8.0
type EvaluationDatasetMetricConfig struct { // Specifies the prompt dataset. // // This member is required. Dataset *EvaluationDataset // The names of the metrics used. For automated model evaluation jobs valid values // are "Builtin.Accuracy" , "Builtin.Robustness" , and "Builtin.Toxicity" . In // human-based model evaluation jobs the array of strings must match the name // parameter specified in HumanEvaluationCustomMetric . // // This member is required. MetricNames []string // The task type you want the model to carry out. // // This member is required. TaskType EvaluationTaskType // contains filtered or unexported fields }
Defines the built-in prompt datasets, built-in metric names and custom metric names, and the task type.
type EvaluationInferenceConfig ¶ added in v1.8.0
type EvaluationInferenceConfig interface {
// contains filtered or unexported methods
}
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.
The following types satisfy this interface:
EvaluationInferenceConfigMemberModels
Example (OutputUsage) ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/bedrock/types" ) func main() { var union types.EvaluationInferenceConfig // type switches can be used to check the union value switch v := union.(type) { case *types.EvaluationInferenceConfigMemberModels: _ = v.Value // Value is []types.EvaluationModelConfig case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
Output:
type EvaluationInferenceConfigMemberModels ¶ added in v1.8.0
type EvaluationInferenceConfigMemberModels struct { Value []EvaluationModelConfig // contains filtered or unexported fields }
Used to specify the models.
type EvaluationJobStatus ¶ added in v1.8.0
type EvaluationJobStatus string
const ( EvaluationJobStatusInProgress EvaluationJobStatus = "InProgress" EvaluationJobStatusCompleted EvaluationJobStatus = "Completed" EvaluationJobStatusFailed EvaluationJobStatus = "Failed" EvaluationJobStatusStopping EvaluationJobStatus = "Stopping" EvaluationJobStatusStopped EvaluationJobStatus = "Stopped" )
Enum values for EvaluationJobStatus
func (EvaluationJobStatus) Values ¶ added in v1.8.0
func (EvaluationJobStatus) Values() []EvaluationJobStatus
Values returns all known values for EvaluationJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationJobType ¶ added in v1.8.0
type EvaluationJobType string
const ( EvaluationJobTypeHuman EvaluationJobType = "Human" EvaluationJobTypeAutomated EvaluationJobType = "Automated" )
Enum values for EvaluationJobType
func (EvaluationJobType) Values ¶ added in v1.8.0
func (EvaluationJobType) Values() []EvaluationJobType
Values returns all known values for EvaluationJobType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationModelConfig ¶ added in v1.8.0
type EvaluationModelConfig interface {
// contains filtered or unexported methods
}
Defines the models used in the model evaluation job.
The following types satisfy this interface:
EvaluationModelConfigMemberBedrockModel
Example (OutputUsage) ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/bedrock/types" ) func main() { var union types.EvaluationModelConfig // type switches can be used to check the union value switch v := union.(type) { case *types.EvaluationModelConfigMemberBedrockModel: _ = v.Value // Value is types.EvaluationBedrockModel case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
Output:
type EvaluationModelConfigMemberBedrockModel ¶ added in v1.8.0
type EvaluationModelConfigMemberBedrockModel struct { Value EvaluationBedrockModel // contains filtered or unexported fields }
Defines the Amazon Bedrock model and inference parameters you want used.
type EvaluationOutputDataConfig ¶ added in v1.8.0
type EvaluationOutputDataConfig struct { // The Amazon S3 URI where the results of model evaluation job are saved. // // This member is required. S3Uri *string // contains filtered or unexported fields }
The Amazon S3 location where the results of your model evaluation job are saved.
type EvaluationSummary ¶ added in v1.8.0
type EvaluationSummary struct { // When the model evaluation job was created. // // This member is required. CreationTime *time.Time // What task type was used in the model evaluation job. // // This member is required. EvaluationTaskTypes []EvaluationTaskType // The Amazon Resource Name (ARN) of the model evaluation job. // // This member is required. JobArn *string // The name of the model evaluation job. // // This member is required. JobName *string // The type, either human or automatic, of model evaluation job. // // This member is required. JobType EvaluationJobType // The Amazon Resource Names (ARNs) of the model(s) used in the model evaluation // job. // // This member is required. ModelIdentifiers []string // The current status of the model evaluation job. // // This member is required. Status EvaluationJobStatus // contains filtered or unexported fields }
A summary of the model evaluation job.
type EvaluationTaskType ¶ added in v1.8.0
type EvaluationTaskType string
const ( EvaluationTaskTypeSummarization EvaluationTaskType = "Summarization" EvaluationTaskTypeClassification EvaluationTaskType = "Classification" EvaluationTaskTypeQuestionAndAnswer EvaluationTaskType = "QuestionAndAnswer" EvaluationTaskTypeGeneration EvaluationTaskType = "Generation" EvaluationTaskTypeCustom EvaluationTaskType = "Custom" )
Enum values for EvaluationTaskType
func (EvaluationTaskType) Values ¶ added in v1.8.0
func (EvaluationTaskType) Values() []EvaluationTaskType
Values returns all known values for EvaluationTaskType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type FineTuningJobStatus ¶
type FineTuningJobStatus string
const ( FineTuningJobStatusInProgress FineTuningJobStatus = "InProgress" FineTuningJobStatusCompleted FineTuningJobStatus = "Completed" FineTuningJobStatusFailed FineTuningJobStatus = "Failed" FineTuningJobStatusStopping FineTuningJobStatus = "Stopping" FineTuningJobStatusStopped FineTuningJobStatus = "Stopped" )
Enum values for FineTuningJobStatus
func (FineTuningJobStatus) Values ¶
func (FineTuningJobStatus) Values() []FineTuningJobStatus
Values returns all known values for FineTuningJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type FoundationModelDetails ¶
type FoundationModelDetails struct { // The model Amazon Resource Name (ARN). // // This member is required. ModelArn *string // The model identifier. // // This member is required. ModelId *string // The customization that the model supports. CustomizationsSupported []ModelCustomization // The inference types that the model supports. InferenceTypesSupported []InferenceType // The input modalities that the model supports. InputModalities []ModelModality // Contains details about whether a model version is available or deprecated ModelLifecycle *FoundationModelLifecycle // The model name. ModelName *string // The output modalities that the model supports. OutputModalities []ModelModality // The model's provider name. ProviderName *string // Indicates whether the model supports streaming. ResponseStreamingSupported *bool // contains filtered or unexported fields }
Information about a foundation model.
type FoundationModelLifecycle ¶ added in v1.4.0
type FoundationModelLifecycle struct { // Specifies whether a model version is available ( ACTIVE ) or deprecated ( LEGACY // . // // This member is required. Status FoundationModelLifecycleStatus // contains filtered or unexported fields }
Details about whether a model version is available or deprecated.
type FoundationModelLifecycleStatus ¶ added in v1.4.0
type FoundationModelLifecycleStatus string
const ( FoundationModelLifecycleStatusActive FoundationModelLifecycleStatus = "ACTIVE" FoundationModelLifecycleStatusLegacy FoundationModelLifecycleStatus = "LEGACY" )
Enum values for FoundationModelLifecycleStatus
func (FoundationModelLifecycleStatus) Values ¶ added in v1.4.0
func (FoundationModelLifecycleStatus) Values() []FoundationModelLifecycleStatus
Values returns all known values for FoundationModelLifecycleStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type FoundationModelSummary ¶
type FoundationModelSummary struct { // The Amazon Resource Name (ARN) of the foundation model. // // This member is required. ModelArn *string // The model ID of the foundation model. // // This member is required. ModelId *string // Whether the model supports fine-tuning or continual pre-training. CustomizationsSupported []ModelCustomization // The inference types that the model supports. InferenceTypesSupported []InferenceType // The input modalities that the model supports. InputModalities []ModelModality // Contains details about whether a model version is available or deprecated. ModelLifecycle *FoundationModelLifecycle // The name of the model. ModelName *string // The output modalities that the model supports. OutputModalities []ModelModality // The model's provider name. ProviderName *string // Indicates whether the model supports streaming. ResponseStreamingSupported *bool // contains filtered or unexported fields }
Summary information for a foundation model.
type GuardrailContentFilter ¶ added in v1.8.0
type GuardrailContentFilter struct { // The strength of the content filter to apply to prompts. As you increase the // filter strength, the likelihood of filtering harmful content increases and the // probability of seeing harmful content in your application reduces. // // This member is required. InputStrength GuardrailFilterStrength // The strength of the content filter to apply to model responses. As you increase // the filter strength, the likelihood of filtering harmful content increases and // the probability of seeing harmful content in your application reduces. // // This member is required. OutputStrength GuardrailFilterStrength // The harmful category that the content filter is applied to. // // This member is required. Type GuardrailContentFilterType // contains filtered or unexported fields }
Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
- Hate – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
- Insults – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
- Sexual – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
- Violence – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.
Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as Hate with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence. For more information, see Guardrails content filters (https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html) . This data type is used in the following API operations:
- GetGuardrail response body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax)
type GuardrailContentFilterConfig ¶ added in v1.8.0
type GuardrailContentFilterConfig struct { // The strength of the content filter to apply to prompts. As you increase the // filter strength, the likelihood of filtering harmful content increases and the // probability of seeing harmful content in your application reduces. // // This member is required. InputStrength GuardrailFilterStrength // The strength of the content filter to apply to model responses. As you increase // the filter strength, the likelihood of filtering harmful content increases and // the probability of seeing harmful content in your application reduces. // // This member is required. OutputStrength GuardrailFilterStrength // The harmful category that the content filter is applied to. // // This member is required. Type GuardrailContentFilterType // contains filtered or unexported fields }
Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
- Hate – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
- Insults – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
- Sexual – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
- Violence – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.
Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as Hate with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence. For more information, see Guardrails content filters (https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html) . This data type is used in the following API operations:
- CreateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax)
- UpdateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax)
type GuardrailContentFilterType ¶ added in v1.8.0
type GuardrailContentFilterType string
const ( GuardrailContentFilterTypeSexual GuardrailContentFilterType = "SEXUAL" GuardrailContentFilterTypeViolence GuardrailContentFilterType = "VIOLENCE" GuardrailContentFilterTypeHate GuardrailContentFilterType = "HATE" GuardrailContentFilterTypeInsults GuardrailContentFilterType = "INSULTS" GuardrailContentFilterTypeMisconduct GuardrailContentFilterType = "MISCONDUCT" GuardrailContentFilterTypePromptAttack GuardrailContentFilterType = "PROMPT_ATTACK" )
Enum values for GuardrailContentFilterType
func (GuardrailContentFilterType) Values ¶ added in v1.8.0
func (GuardrailContentFilterType) Values() []GuardrailContentFilterType
Values returns all known values for GuardrailContentFilterType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type GuardrailContentPolicy ¶ added in v1.8.0
type GuardrailContentPolicy struct { // Contains the type of the content filter and how strongly it should apply to // prompts and model responses. Filters []GuardrailContentFilter // contains filtered or unexported fields }
Contains details about how to handle harmful content. This data type is used in the following API operations:
- GetGuardrail response body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax)
type GuardrailContentPolicyConfig ¶ added in v1.8.0
type GuardrailContentPolicyConfig struct { // Contains the type of the content filter and how strongly it should apply to // prompts and model responses. // // This member is required. FiltersConfig []GuardrailContentFilterConfig // contains filtered or unexported fields }
Contains details about how to handle harmful content. This data type is used in the following API operations:
- CreateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax)
- UpdateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax)
type GuardrailFilterStrength ¶ added in v1.8.0
type GuardrailFilterStrength string
const ( GuardrailFilterStrengthNone GuardrailFilterStrength = "NONE" GuardrailFilterStrengthLow GuardrailFilterStrength = "LOW" GuardrailFilterStrengthMedium GuardrailFilterStrength = "MEDIUM" GuardrailFilterStrengthHigh GuardrailFilterStrength = "HIGH" )
Enum values for GuardrailFilterStrength
func (GuardrailFilterStrength) Values ¶ added in v1.8.0
func (GuardrailFilterStrength) Values() []GuardrailFilterStrength
Values returns all known values for GuardrailFilterStrength. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type GuardrailManagedWords ¶ added in v1.8.0
type GuardrailManagedWords struct { // ManagedWords$type The managed word type that was configured for the guardrail. // (For now, we only offer profanity word list) // // This member is required. Type GuardrailManagedWordsType // contains filtered or unexported fields }
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.)
type GuardrailManagedWordsConfig ¶ added in v1.8.0
type GuardrailManagedWordsConfig struct { // The managed word type to configure for the guardrail. // // This member is required. Type GuardrailManagedWordsType // contains filtered or unexported fields }
The managed word list to configure for the guardrail.
type GuardrailManagedWordsType ¶ added in v1.8.0
type GuardrailManagedWordsType string
const (
GuardrailManagedWordsTypeProfanity GuardrailManagedWordsType = "PROFANITY"
)
Enum values for GuardrailManagedWordsType
func (GuardrailManagedWordsType) Values ¶ added in v1.8.0
func (GuardrailManagedWordsType) Values() []GuardrailManagedWordsType
Values returns all known values for GuardrailManagedWordsType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type GuardrailPiiEntity ¶ added in v1.8.0
type GuardrailPiiEntity struct { // The configured guardrail action when PII entity is detected. // // This member is required. Action GuardrailSensitiveInformationAction // The type of PII entity. For example, Social Security Number. // // This member is required. Type GuardrailPiiEntityType // contains filtered or unexported fields }
The PII entity configured for the guardrail.
type GuardrailPiiEntityConfig ¶ added in v1.8.0
type GuardrailPiiEntityConfig struct { // Configure guardrail action when the PII entity is detected. // // This member is required. Action GuardrailSensitiveInformationAction // Configure guardrail type when the PII entity is detected. // // This member is required. Type GuardrailPiiEntityType // contains filtered or unexported fields }
The PII entity to configure for the guardrail.
type GuardrailPiiEntityType ¶ added in v1.8.0
type GuardrailPiiEntityType string
const ( GuardrailPiiEntityTypeAddress GuardrailPiiEntityType = "ADDRESS" GuardrailPiiEntityTypeAge GuardrailPiiEntityType = "AGE" GuardrailPiiEntityTypeAwsAccessKey GuardrailPiiEntityType = "AWS_ACCESS_KEY" GuardrailPiiEntityTypeAwsSecretKey GuardrailPiiEntityType = "AWS_SECRET_KEY" GuardrailPiiEntityTypeCaHealthNumber GuardrailPiiEntityType = "CA_HEALTH_NUMBER" GuardrailPiiEntityTypeCaSocialInsuranceNumber GuardrailPiiEntityType = "CA_SOCIAL_INSURANCE_NUMBER" GuardrailPiiEntityTypeCreditDebitCardCvv GuardrailPiiEntityType = "CREDIT_DEBIT_CARD_CVV" GuardrailPiiEntityTypeCreditDebitCardExpiry GuardrailPiiEntityType = "CREDIT_DEBIT_CARD_EXPIRY" GuardrailPiiEntityTypeCreditDebitCardNumber GuardrailPiiEntityType = "CREDIT_DEBIT_CARD_NUMBER" GuardrailPiiEntityTypeDriverId GuardrailPiiEntityType = "DRIVER_ID" GuardrailPiiEntityTypeEmail GuardrailPiiEntityType = "EMAIL" GuardrailPiiEntityTypeInternationalBankAccountNumber GuardrailPiiEntityType = "INTERNATIONAL_BANK_ACCOUNT_NUMBER" GuardrailPiiEntityTypeIpAddress GuardrailPiiEntityType = "IP_ADDRESS" GuardrailPiiEntityTypeLicensePlate GuardrailPiiEntityType = "LICENSE_PLATE" GuardrailPiiEntityTypeMacAddress GuardrailPiiEntityType = "MAC_ADDRESS" GuardrailPiiEntityTypeName GuardrailPiiEntityType = "NAME" GuardrailPiiEntityTypePassword GuardrailPiiEntityType = "PASSWORD" GuardrailPiiEntityTypePhone GuardrailPiiEntityType = "PHONE" GuardrailPiiEntityTypePin GuardrailPiiEntityType = "PIN" GuardrailPiiEntityTypeSwiftCode GuardrailPiiEntityType = "SWIFT_CODE" GuardrailPiiEntityTypeUkNationalHealthServiceNumber GuardrailPiiEntityType = "UK_NATIONAL_HEALTH_SERVICE_NUMBER" GuardrailPiiEntityTypeUkNationalInsuranceNumber GuardrailPiiEntityType = "UK_NATIONAL_INSURANCE_NUMBER" GuardrailPiiEntityTypeUkUniqueTaxpayerReferenceNumber GuardrailPiiEntityType = "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" GuardrailPiiEntityTypeUrl GuardrailPiiEntityType = "URL" GuardrailPiiEntityTypeUsername GuardrailPiiEntityType = "USERNAME" GuardrailPiiEntityTypeUsBankAccountNumber GuardrailPiiEntityType = "US_BANK_ACCOUNT_NUMBER" GuardrailPiiEntityTypeUsBankRoutingNumber GuardrailPiiEntityType = "US_BANK_ROUTING_NUMBER" GuardrailPiiEntityTypeUsIndividualTaxIdentificationNumber GuardrailPiiEntityType = "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" GuardrailPiiEntityTypeUsPassportNumber GuardrailPiiEntityType = "US_PASSPORT_NUMBER" GuardrailPiiEntityTypeUsSocialSecurityNumber GuardrailPiiEntityType = "US_SOCIAL_SECURITY_NUMBER" GuardrailPiiEntityTypeVehicleIdentificationNumber GuardrailPiiEntityType = "VEHICLE_IDENTIFICATION_NUMBER" )
Enum values for GuardrailPiiEntityType
func (GuardrailPiiEntityType) Values ¶ added in v1.8.0
func (GuardrailPiiEntityType) Values() []GuardrailPiiEntityType
Values returns all known values for GuardrailPiiEntityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type GuardrailRegex ¶ added in v1.8.0
type GuardrailRegex struct { // The action taken when a match to the regular expression is detected. // // This member is required. Action GuardrailSensitiveInformationAction // The name of the regular expression for the guardrail. // // This member is required. Name *string // The pattern of the regular expression configured for the guardrail. // // This member is required. Pattern *string // The description of the regular expression for the guardrail. Description *string // contains filtered or unexported fields }
The regular expression configured for the guardrail.
type GuardrailRegexConfig ¶ added in v1.8.0
type GuardrailRegexConfig struct { // The guardrail action to configure when matching regular expression is detected. // // This member is required. Action GuardrailSensitiveInformationAction // The name of the regular expression to configure for the guardrail. // // This member is required. Name *string // The regular expression pattern to configure for the guardrail. // // This member is required. Pattern *string // The description of the regular expression to configure for the guardrail. Description *string // contains filtered or unexported fields }
The regular expression to configure for the guardrail.
type GuardrailSensitiveInformationAction ¶ added in v1.8.0
type GuardrailSensitiveInformationAction string
const ( GuardrailSensitiveInformationActionBlock GuardrailSensitiveInformationAction = "BLOCK" GuardrailSensitiveInformationActionAnonymize GuardrailSensitiveInformationAction = "ANONYMIZE" )
Enum values for GuardrailSensitiveInformationAction
func (GuardrailSensitiveInformationAction) Values ¶ added in v1.8.0
func (GuardrailSensitiveInformationAction) Values() []GuardrailSensitiveInformationAction
Values returns all known values for GuardrailSensitiveInformationAction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type GuardrailSensitiveInformationPolicy ¶ added in v1.8.0
type GuardrailSensitiveInformationPolicy struct { // The list of PII entities configured for the guardrail. PiiEntities []GuardrailPiiEntity // The list of regular expressions configured for the guardrail. Regexes []GuardrailRegex // contains filtered or unexported fields }
Contains details about PII entities and regular expressions configured for the guardrail.
type GuardrailSensitiveInformationPolicyConfig ¶ added in v1.8.0
type GuardrailSensitiveInformationPolicyConfig struct { // A list of PII entities to configure to the guardrail. PiiEntitiesConfig []GuardrailPiiEntityConfig // A list of regular expressions to configure to the guardrail. RegexesConfig []GuardrailRegexConfig // contains filtered or unexported fields }
Contains details about PII entities and regular expressions to configure for the guardrail.
type GuardrailStatus ¶ added in v1.8.0
type GuardrailStatus string
const ( GuardrailStatusCreating GuardrailStatus = "CREATING" GuardrailStatusUpdating GuardrailStatus = "UPDATING" GuardrailStatusVersioning GuardrailStatus = "VERSIONING" GuardrailStatusReady GuardrailStatus = "READY" GuardrailStatusFailed GuardrailStatus = "FAILED" GuardrailStatusDeleting GuardrailStatus = "DELETING" )
Enum values for GuardrailStatus
func (GuardrailStatus) Values ¶ added in v1.8.0
func (GuardrailStatus) Values() []GuardrailStatus
Values returns all known values for GuardrailStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type GuardrailSummary ¶ added in v1.8.0
type GuardrailSummary struct { // The ARN of the guardrail. // // This member is required. Arn *string // The date and time at which the guardrail was created. // // This member is required. CreatedAt *time.Time // The unique identifier of the guardrail. // // This member is required. Id *string // The name of the guardrail. // // This member is required. Name *string // The status of the guardrail. // // This member is required. Status GuardrailStatus // The date and time at which the guardrail was last updated. // // This member is required. UpdatedAt *time.Time // The version of the guardrail. // // This member is required. Version *string // A description of the guardrail. Description *string // contains filtered or unexported fields }
Contains details about a guardrail. This data type is used in the following API operations:
- ListGuardrails response body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListGuardrails.html#API_ListGuardrails_ResponseSyntax)
type GuardrailTopic ¶ added in v1.8.0
type GuardrailTopic struct { // A definition of the topic to deny. // // This member is required. Definition *string // The name of the topic to deny. // // This member is required. Name *string // A list of prompts, each of which is an example of a prompt that can be // categorized as belonging to the topic. Examples []string // Specifies to deny the topic. Type GuardrailTopicType // contains filtered or unexported fields }
Details about topics for the guardrail to identify and deny. This data type is used in the following API operations:
- GetGuardrail response body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax)
type GuardrailTopicConfig ¶ added in v1.8.0
type GuardrailTopicConfig struct { // A definition of the topic to deny. // // This member is required. Definition *string // The name of the topic to deny. // // This member is required. Name *string // Specifies to deny the topic. // // This member is required. Type GuardrailTopicType // A list of prompts, each of which is an example of a prompt that can be // categorized as belonging to the topic. Examples []string // contains filtered or unexported fields }
Details about topics for the guardrail to identify and deny. This data type is used in the following API operations:
- CreateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax)
- UpdateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax)
type GuardrailTopicPolicy ¶ added in v1.8.0
type GuardrailTopicPolicy struct { // A list of policies related to topics that the guardrail should deny. // // This member is required. Topics []GuardrailTopic // contains filtered or unexported fields }
Contains details about topics that the guardrail should identify and deny. This data type is used in the following API operations:
- GetGuardrail response body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax)
type GuardrailTopicPolicyConfig ¶ added in v1.8.0
type GuardrailTopicPolicyConfig struct { // A list of policies related to topics that the guardrail should deny. // // This member is required. TopicsConfig []GuardrailTopicConfig // contains filtered or unexported fields }
Contains details about topics that the guardrail should identify and deny. This data type is used in the following API operations:
- CreateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax)
- UpdateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax)
type GuardrailTopicType ¶ added in v1.8.0
type GuardrailTopicType string
const (
GuardrailTopicTypeDeny GuardrailTopicType = "DENY"
)
Enum values for GuardrailTopicType
func (GuardrailTopicType) Values ¶ added in v1.8.0
func (GuardrailTopicType) Values() []GuardrailTopicType
Values returns all known values for GuardrailTopicType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type GuardrailWord ¶ added in v1.8.0
type GuardrailWord struct { // Text of the word configured for the guardrail to block. // // This member is required. Text *string // contains filtered or unexported fields }
A word configured for the guardrail.
type GuardrailWordConfig ¶ added in v1.8.0
type GuardrailWordConfig struct { // Text of the word configured for the guardrail to block. // // This member is required. Text *string // contains filtered or unexported fields }
A word to configure for the guardrail.
type GuardrailWordPolicy ¶ added in v1.8.0
type GuardrailWordPolicy struct { // A list of managed words configured for the guardrail. ManagedWordLists []GuardrailManagedWords // A list of words configured for the guardrail. Words []GuardrailWord // contains filtered or unexported fields }
Contains details about the word policy configured for the guardrail.
type GuardrailWordPolicyConfig ¶ added in v1.8.0
type GuardrailWordPolicyConfig struct { // A list of managed words to configure for the guardrail. ManagedWordListsConfig []GuardrailManagedWordsConfig // A list of words to configure for the guardrail. WordsConfig []GuardrailWordConfig // contains filtered or unexported fields }
Contains details about the word policy to configured for the guardrail.
type HumanEvaluationConfig ¶ added in v1.8.0
type HumanEvaluationConfig struct { // Use to specify the metrics, task, and prompt dataset to be used in your model // evaluation job. // // This member is required. DatasetMetricConfigs []EvaluationDatasetMetricConfig // A HumanEvaluationCustomMetric object. It contains the names the metrics, how // the metrics are to be evaluated, an optional description. CustomMetrics []HumanEvaluationCustomMetric // The parameters of the human workflow. HumanWorkflowConfig *HumanWorkflowConfig // contains filtered or unexported fields }
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 (https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-prompt-datasets-custom.html) . When you create custom metrics in HumanEvaluationCustomMetric you must specify the metric's name . The list of names specified in the HumanEvaluationCustomMetric array, must match the metricNames array of strings specified in EvaluationDatasetMetricConfig . For example, if in the HumanEvaluationCustomMetric array your specified the names "accuracy", "toxicity", "readability" as custom metrics then the metricNames array would need to look like the following ["accuracy", "toxicity", "readability"] in EvaluationDatasetMetricConfig .
type HumanEvaluationCustomMetric ¶ added in v1.8.0
type HumanEvaluationCustomMetric struct { // The name of the metric. Your human evaluators will see this name in the // evaluation UI. // // This member is required. Name *string // Choose how you want your human workers to evaluation your model. Valid values // for rating methods are ThumbsUpDown , IndividualLikertScale , // ComparisonLikertScale , ComparisonChoice , and ComparisonRank // // This member is required. RatingMethod *string // An optional description of the metric. Use this parameter to provide more // details about the metric. Description *string // contains filtered or unexported fields }
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.
type HumanWorkflowConfig ¶ added in v1.8.0
type HumanWorkflowConfig struct { // The Amazon Resource Number (ARN) for the flow definition // // This member is required. FlowDefinitionArn *string // Instructions for the flow definition Instructions *string // contains filtered or unexported fields }
Contains SageMakerFlowDefinition object. The object is used to specify the prompt dataset, task type, rating method and metric names.
type InferenceType ¶
type InferenceType string
const ( InferenceTypeOnDemand InferenceType = "ON_DEMAND" InferenceTypeProvisioned InferenceType = "PROVISIONED" )
Enum values for InferenceType
func (InferenceType) Values ¶
func (InferenceType) Values() []InferenceType
Values returns all known values for InferenceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type InternalServerException ¶
type InternalServerException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
An internal server error occurred. Retry your request.
func (*InternalServerException) Error ¶
func (e *InternalServerException) Error() string
func (*InternalServerException) ErrorCode ¶
func (e *InternalServerException) ErrorCode() string
func (*InternalServerException) ErrorFault ¶
func (e *InternalServerException) ErrorFault() smithy.ErrorFault
func (*InternalServerException) ErrorMessage ¶
func (e *InternalServerException) ErrorMessage() string
type LoggingConfig ¶
type LoggingConfig struct { // CloudWatch logging configuration. CloudWatchConfig *CloudWatchConfig // Set to include embeddings data in the log delivery. EmbeddingDataDeliveryEnabled *bool // Set to include image data in the log delivery. ImageDataDeliveryEnabled *bool // S3 configuration for storing log data. S3Config *S3Config // Set to include text data in the log delivery. TextDataDeliveryEnabled *bool // contains filtered or unexported fields }
Configuration fields for invocation logging.
type ModelCustomization ¶
type ModelCustomization string
const ( ModelCustomizationFineTuning ModelCustomization = "FINE_TUNING" ModelCustomizationContinuedPreTraining ModelCustomization = "CONTINUED_PRE_TRAINING" )
Enum values for ModelCustomization
func (ModelCustomization) Values ¶
func (ModelCustomization) Values() []ModelCustomization
Values returns all known values for ModelCustomization. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ModelCustomizationJobStatus ¶
type ModelCustomizationJobStatus string
const ( ModelCustomizationJobStatusInProgress ModelCustomizationJobStatus = "InProgress" ModelCustomizationJobStatusCompleted ModelCustomizationJobStatus = "Completed" ModelCustomizationJobStatusFailed ModelCustomizationJobStatus = "Failed" ModelCustomizationJobStatusStopping ModelCustomizationJobStatus = "Stopping" ModelCustomizationJobStatusStopped ModelCustomizationJobStatus = "Stopped" )
Enum values for ModelCustomizationJobStatus
func (ModelCustomizationJobStatus) Values ¶
func (ModelCustomizationJobStatus) Values() []ModelCustomizationJobStatus
Values returns all known values for ModelCustomizationJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ModelCustomizationJobSummary ¶
type ModelCustomizationJobSummary struct { // Amazon Resource Name (ARN) of the base model. // // This member is required. BaseModelArn *string // Creation time of the custom model. // // This member is required. CreationTime *time.Time // Amazon Resource Name (ARN) of the customization job. // // This member is required. JobArn *string // Name of the customization job. // // This member is required. JobName *string // Status of the customization job. // // This member is required. Status ModelCustomizationJobStatus // Amazon Resource Name (ARN) of the custom model. CustomModelArn *string // Name of the custom model. CustomModelName *string // Specifies whether to carry out continued pre-training of a model or whether to // fine-tune it. For more information, see Custom models (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) // . CustomizationType CustomizationType // Time that the customization job ended. EndTime *time.Time // Time that the customization job was last modified. LastModifiedTime *time.Time // contains filtered or unexported fields }
Information about one customization job
type ModelModality ¶
type ModelModality string
const ( ModelModalityText ModelModality = "TEXT" ModelModalityImage ModelModality = "IMAGE" ModelModalityEmbedding ModelModality = "EMBEDDING" )
Enum values for ModelModality
func (ModelModality) Values ¶
func (ModelModality) Values() []ModelModality
Values returns all known values for ModelModality. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type OutputDataConfig ¶
type OutputDataConfig struct { // The S3 URI where the output data is stored. // // This member is required. S3Uri *string // contains filtered or unexported fields }
S3 Location of the output data.
type ProvisionedModelStatus ¶ added in v1.1.0
type ProvisionedModelStatus string
const ( ProvisionedModelStatusCreating ProvisionedModelStatus = "Creating" ProvisionedModelStatusInService ProvisionedModelStatus = "InService" ProvisionedModelStatusUpdating ProvisionedModelStatus = "Updating" ProvisionedModelStatusFailed ProvisionedModelStatus = "Failed" )
Enum values for ProvisionedModelStatus
func (ProvisionedModelStatus) Values ¶ added in v1.1.0
func (ProvisionedModelStatus) Values() []ProvisionedModelStatus
Values returns all known values for ProvisionedModelStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ProvisionedModelSummary ¶ added in v1.1.0
type ProvisionedModelSummary struct { // The time that the Provisioned Throughput was created. // // This member is required. CreationTime *time.Time // The Amazon Resource Name (ARN) of the model requested to be associated to this // Provisioned Throughput. This value differs from the modelArn if updating hasn't // completed. // // This member is required. DesiredModelArn *string // The number of model units that was requested to be allocated to the Provisioned // Throughput. // // This member is required. DesiredModelUnits *int32 // The Amazon Resource Name (ARN) of the base model for which the Provisioned // Throughput was created, or of the base model that the custom model for which the // Provisioned Throughput was created was customized. // // This member is required. FoundationModelArn *string // The time that the Provisioned Throughput was last modified. // // This member is required. LastModifiedTime *time.Time // The Amazon Resource Name (ARN) of the model associated with the Provisioned // Throughput. // // This member is required. ModelArn *string // The number of model units allocated to the Provisioned Throughput. // // This member is required. ModelUnits *int32 // The Amazon Resource Name (ARN) of the Provisioned Throughput. // // This member is required. ProvisionedModelArn *string // The name of the Provisioned Throughput. // // This member is required. ProvisionedModelName *string // The status of the Provisioned Throughput. // // This member is required. Status ProvisionedModelStatus // The duration for which the Provisioned Throughput was committed. CommitmentDuration CommitmentDuration // The timestamp for when the commitment term of the Provisioned Throughput // expires. CommitmentExpirationTime *time.Time // contains filtered or unexported fields }
A summary of information about a Provisioned Throughput. This data type is used in the following API operations:
- ListProvisionedThroughputs response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListProvisionedModelThroughputs.html#API_ListProvisionedModelThroughputs_ResponseSyntax)
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type S3Config ¶
type S3Config struct { // S3 bucket name. // // This member is required. BucketName *string // S3 prefix. KeyPrefix *string // contains filtered or unexported fields }
S3 configuration for storing log data.
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The number of requests exceeds the service quota. Resubmit your request later.
func (*ServiceQuotaExceededException) Error ¶
func (e *ServiceQuotaExceededException) Error() string
func (*ServiceQuotaExceededException) ErrorCode ¶
func (e *ServiceQuotaExceededException) ErrorCode() string
func (*ServiceQuotaExceededException) ErrorFault ¶
func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault
func (*ServiceQuotaExceededException) ErrorMessage ¶
func (e *ServiceQuotaExceededException) ErrorMessage() string
type SortByProvisionedModels ¶ added in v1.1.0
type SortByProvisionedModels string
const (
SortByProvisionedModelsCreationTime SortByProvisionedModels = "CreationTime"
)
Enum values for SortByProvisionedModels
func (SortByProvisionedModels) Values ¶ added in v1.1.0
func (SortByProvisionedModels) Values() []SortByProvisionedModels
Values returns all known values for SortByProvisionedModels. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type SortJobsBy ¶
type SortJobsBy string
const (
SortJobsByCreationTime SortJobsBy = "CreationTime"
)
Enum values for SortJobsBy
func (SortJobsBy) Values ¶
func (SortJobsBy) Values() []SortJobsBy
Values returns all known values for SortJobsBy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type SortModelsBy ¶
type SortModelsBy string
const (
SortModelsByCreationTime SortModelsBy = "CreationTime"
)
Enum values for SortModelsBy
func (SortModelsBy) Values ¶
func (SortModelsBy) Values() []SortModelsBy
Values returns all known values for SortModelsBy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type Tag ¶
type Tag struct { // Key for the tag. // // This member is required. Key *string // Value for the tag. // // This member is required. Value *string // contains filtered or unexported fields }
Definition of the key/value pair for a tag.
type ThrottlingException ¶
type ThrottlingException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The number of requests exceeds the limit. Resubmit your request later.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
type TooManyTagsException ¶
type TooManyTagsException struct { Message *string ErrorCodeOverride *string ResourceName *string // contains filtered or unexported fields }
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
func (*TooManyTagsException) Error ¶
func (e *TooManyTagsException) Error() string
func (*TooManyTagsException) ErrorCode ¶
func (e *TooManyTagsException) ErrorCode() string
func (*TooManyTagsException) ErrorFault ¶
func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault
func (*TooManyTagsException) ErrorMessage ¶
func (e *TooManyTagsException) ErrorMessage() string
type TrainingDataConfig ¶
type TrainingDataConfig struct { // The S3 URI where the training data is stored. // // This member is required. S3Uri *string // contains filtered or unexported fields }
S3 Location of the training data.
type TrainingMetrics ¶
type TrainingMetrics struct { // Loss metric associated with the custom job. TrainingLoss *float32 // contains filtered or unexported fields }
Metrics associated with the custom job.
type UnknownUnionMember ¶ added in v1.8.0
type UnknownUnionMember struct { Tag string Value []byte // contains filtered or unexported fields }
UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.
type ValidationDataConfig ¶
type ValidationDataConfig struct { // Information about the validators. // // This member is required. Validators []Validator // contains filtered or unexported fields }
Array of up to 10 validators.
type ValidationException ¶
type ValidationException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
Input validation failed. Check your request parameters and retry the request.
func (*ValidationException) Error ¶
func (e *ValidationException) Error() string
func (*ValidationException) ErrorCode ¶
func (e *ValidationException) ErrorCode() string
func (*ValidationException) ErrorFault ¶
func (e *ValidationException) ErrorFault() smithy.ErrorFault
func (*ValidationException) ErrorMessage ¶
func (e *ValidationException) ErrorMessage() string
type Validator ¶
type Validator struct { // The S3 URI where the validation data is stored. // // This member is required. S3Uri *string // contains filtered or unexported fields }
Information about a validator.
type ValidatorMetric ¶
type ValidatorMetric struct { // The validation loss associated with this validator. ValidationLoss *float32 // contains filtered or unexported fields }
The metric for the validator.