Module: Aws::Bedrock::Types

Defined in:
lib/aws-sdk-bedrock/types.rb

Defined Under Namespace

Classes: AccessDeniedException, AutomatedEvaluationConfig, AutomatedEvaluationCustomMetricConfig, AutomatedEvaluationCustomMetricSource, BatchDeleteEvaluationJobError, BatchDeleteEvaluationJobItem, BatchDeleteEvaluationJobRequest, BatchDeleteEvaluationJobResponse, BedrockEvaluatorModel, ByteContentDoc, CloudWatchConfig, ConflictException, CreateEvaluationJobRequest, CreateEvaluationJobResponse, CreateGuardrailRequest, CreateGuardrailResponse, CreateGuardrailVersionRequest, CreateGuardrailVersionResponse, CreateInferenceProfileRequest, CreateInferenceProfileResponse, CreateMarketplaceModelEndpointRequest, CreateMarketplaceModelEndpointResponse, CreateModelCopyJobRequest, CreateModelCopyJobResponse, CreateModelCustomizationJobRequest, CreateModelCustomizationJobResponse, CreateModelImportJobRequest, CreateModelImportJobResponse, CreateModelInvocationJobRequest, CreateModelInvocationJobResponse, CreatePromptRouterRequest, CreatePromptRouterResponse, CreateProvisionedModelThroughputRequest, CreateProvisionedModelThroughputResponse, CustomMetricBedrockEvaluatorModel, CustomMetricDefinition, CustomMetricEvaluatorModelConfig, CustomModelSummary, CustomModelUnits, CustomizationConfig, DeleteCustomModelRequest, DeleteCustomModelResponse, DeleteGuardrailRequest, DeleteGuardrailResponse, DeleteImportedModelRequest, DeleteImportedModelResponse, DeleteInferenceProfileRequest, DeleteInferenceProfileResponse, DeleteMarketplaceModelEndpointRequest, DeleteMarketplaceModelEndpointResponse, DeleteModelInvocationLoggingConfigurationRequest, DeleteModelInvocationLoggingConfigurationResponse, DeletePromptRouterRequest, DeletePromptRouterResponse, DeleteProvisionedModelThroughputRequest, DeleteProvisionedModelThroughputResponse, DeregisterMarketplaceModelEndpointRequest, DeregisterMarketplaceModelEndpointResponse, DistillationConfig, EndpointConfig, EvaluationBedrockModel, EvaluationConfig, EvaluationDataset, EvaluationDatasetLocation, EvaluationDatasetMetricConfig, EvaluationInferenceConfig, EvaluationInferenceConfigSummary, EvaluationModelConfig, EvaluationModelConfigSummary, EvaluationOutputDataConfig, EvaluationPrecomputedInferenceSource, EvaluationPrecomputedRagSourceConfig, EvaluationPrecomputedRetrieveAndGenerateSourceConfig, EvaluationPrecomputedRetrieveSourceConfig, EvaluationRagConfigSummary, EvaluationSummary, EvaluatorModelConfig, ExternalSource, ExternalSourcesGenerationConfiguration, ExternalSourcesRetrieveAndGenerateConfiguration, FilterAttribute, FoundationModelDetails, FoundationModelLifecycle, FoundationModelSummary, GenerationConfiguration, GetCustomModelRequest, GetCustomModelResponse, GetEvaluationJobRequest, GetEvaluationJobResponse, GetFoundationModelRequest, GetFoundationModelResponse, GetGuardrailRequest, GetGuardrailResponse, GetImportedModelRequest, GetImportedModelResponse, GetInferenceProfileRequest, GetInferenceProfileResponse, GetMarketplaceModelEndpointRequest, GetMarketplaceModelEndpointResponse, GetModelCopyJobRequest, GetModelCopyJobResponse, GetModelCustomizationJobRequest, GetModelCustomizationJobResponse, GetModelImportJobRequest, GetModelImportJobResponse, GetModelInvocationJobRequest, GetModelInvocationJobResponse, GetModelInvocationLoggingConfigurationRequest, GetModelInvocationLoggingConfigurationResponse, GetPromptRouterRequest, GetPromptRouterResponse, GetProvisionedModelThroughputRequest, GetProvisionedModelThroughputResponse, GuardrailConfiguration, GuardrailContentFilter, GuardrailContentFilterConfig, GuardrailContentPolicy, GuardrailContentPolicyConfig, GuardrailContextualGroundingFilter, GuardrailContextualGroundingFilterConfig, GuardrailContextualGroundingPolicy, GuardrailContextualGroundingPolicyConfig, GuardrailManagedWords, GuardrailManagedWordsConfig, GuardrailPiiEntity, GuardrailPiiEntityConfig, GuardrailRegex, GuardrailRegexConfig, GuardrailSensitiveInformationPolicy, GuardrailSensitiveInformationPolicyConfig, GuardrailSummary, GuardrailTopic, GuardrailTopicConfig, GuardrailTopicPolicy, GuardrailTopicPolicyConfig, GuardrailWord, GuardrailWordConfig, GuardrailWordPolicy, GuardrailWordPolicyConfig, HumanEvaluationConfig, HumanEvaluationCustomMetric, HumanWorkflowConfig, ImportedModelSummary, InferenceProfileModel, InferenceProfileModelSource, InferenceProfileSummary, InternalServerException, InvocationLogSource, InvocationLogsConfig, KbInferenceConfig, KnowledgeBaseConfig, KnowledgeBaseRetrievalConfiguration, KnowledgeBaseRetrieveAndGenerateConfiguration, KnowledgeBaseVectorSearchConfiguration, ListCustomModelsRequest, ListCustomModelsResponse, ListEvaluationJobsRequest, ListEvaluationJobsResponse, ListFoundationModelsRequest, ListFoundationModelsResponse, ListGuardrailsRequest, ListGuardrailsResponse, ListImportedModelsRequest, ListImportedModelsResponse, ListInferenceProfilesRequest, ListInferenceProfilesResponse, ListMarketplaceModelEndpointsRequest, ListMarketplaceModelEndpointsResponse, ListModelCopyJobsRequest, ListModelCopyJobsResponse, ListModelCustomizationJobsRequest, ListModelCustomizationJobsResponse, ListModelImportJobsRequest, ListModelImportJobsResponse, ListModelInvocationJobsRequest, ListModelInvocationJobsResponse, ListPromptRoutersRequest, ListPromptRoutersResponse, ListProvisionedModelThroughputsRequest, ListProvisionedModelThroughputsResponse, ListTagsForResourceRequest, ListTagsForResourceResponse, LoggingConfig, MarketplaceModelEndpoint, MarketplaceModelEndpointSummary, ModelCopyJobSummary, ModelCustomizationJobSummary, ModelDataSource, ModelImportJobSummary, ModelInvocationJobInputDataConfig, ModelInvocationJobOutputDataConfig, ModelInvocationJobS3InputDataConfig, ModelInvocationJobS3OutputDataConfig, ModelInvocationJobSummary, OrchestrationConfiguration, OutputDataConfig, PerformanceConfiguration, PromptRouterSummary, PromptRouterTargetModel, PromptTemplate, ProvisionedModelSummary, PutModelInvocationLoggingConfigurationRequest, PutModelInvocationLoggingConfigurationResponse, QueryTransformationConfiguration, RAGConfig, RatingScaleItem, RatingScaleItemValue, RegisterMarketplaceModelEndpointRequest, RegisterMarketplaceModelEndpointResponse, RequestMetadataBaseFilters, RequestMetadataFilters, ResourceNotFoundException, RetrievalFilter, RetrieveAndGenerateConfiguration, RetrieveConfig, RoutingCriteria, S3Config, S3DataSource, S3ObjectDoc, SageMakerEndpoint, ServiceQuotaExceededException, ServiceUnavailableException, StopEvaluationJobRequest, StopEvaluationJobResponse, StopModelCustomizationJobRequest, StopModelCustomizationJobResponse, StopModelInvocationJobRequest, StopModelInvocationJobResponse, Tag, TagResourceRequest, TagResourceResponse, TeacherModelConfig, TextInferenceConfig, ThrottlingException, TooManyTagsException, TrainingDataConfig, TrainingMetrics, UntagResourceRequest, UntagResourceResponse, UpdateGuardrailRequest, UpdateGuardrailResponse, UpdateMarketplaceModelEndpointRequest, UpdateMarketplaceModelEndpointResponse, UpdateProvisionedModelThroughputRequest, UpdateProvisionedModelThroughputResponse, ValidationDataConfig, ValidationException, Validator, ValidatorMetric, VpcConfig

Instance Attribute Summary collapse

Instance Attribute Details

#and_all ⇒ Array<Types::RetrievalFilter>

Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

Returns:



7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7312

class RequestMetadataFilters < Struct.new(
  :equals,
  :not_equals,
  :and_all,
  :or_all,
  :unknown)
  SENSITIVE = [:equals, :not_equals]
  include Aws::Structure
  include Aws::Structure::Union

  class Equals < RequestMetadataFilters; end
  class NotEquals < RequestMetadataFilters; end
  class AndAll < RequestMetadataFilters; end
  class OrAll < RequestMetadataFilters; end
  class Unknown < RequestMetadataFilters; end
end

#automated ⇒ Types::AutomatedEvaluationConfig

Contains the configuration details of an automated evaluation job that computes metrics.

Returns:



1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
 
# File 'lib/aws-sdk-bedrock/types.rb', line 1600

class EvaluationConfig < Struct.new(
  :automated,
  :human,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Automated < EvaluationConfig; end
  class Human < EvaluationConfig; end
  class Unknown < EvaluationConfig; end
end

#bedrock_evaluator_models ⇒ Array<Types::BedrockEvaluatorModel>

The evaluator model used in knowledge base evaluation job or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

Returns:



2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
 
# File 'lib/aws-sdk-bedrock/types.rb', line 2051

class EvaluatorModelConfig < Struct.new(
  :bedrock_evaluator_models,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BedrockEvaluatorModels < EvaluatorModelConfig; end
  class Unknown < EvaluatorModelConfig; end
end

#bedrock_model ⇒ Types::EvaluationBedrockModel

Defines the Amazon Bedrock model or inference profile and inference parameters you want used.

Returns:



1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
 
# File 'lib/aws-sdk-bedrock/types.rb', line 1798

class EvaluationModelConfig < Struct.new(
  :bedrock_model,
  :precomputed_inference_source,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BedrockModel < EvaluationModelConfig; end
  class PrecomputedInferenceSource < EvaluationModelConfig; end
  class Unknown < EvaluationModelConfig; end
end

#copy_from ⇒ String

The ARN of the model or system-defined inference profile that is the source for the inference profile.

Returns:

  • (String) 


5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
 
# File 'lib/aws-sdk-bedrock/types.rb', line 5062

class InferenceProfileModelSource < Struct.new(
  :copy_from,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class CopyFrom < InferenceProfileModelSource; end
  class Unknown < InferenceProfileModelSource; end
end

#custom_metric_definition ⇒ Types::CustomMetricDefinition

The definition of a custom metric for use in an Amazon Bedrock evaluation job.

Returns:



101
102
103
104
105
106
107
108
109
110
 
# File 'lib/aws-sdk-bedrock/types.rb', line 101

class AutomatedEvaluationCustomMetricSource < Struct.new(
  :custom_metric_definition,
  :unknown)
  SENSITIVE = [:custom_metric_definition]
  include Aws::Structure
  include Aws::Structure::Union

  class CustomMetricDefinition < AutomatedEvaluationCustomMetricSource; end
  class Unknown < AutomatedEvaluationCustomMetricSource; end
end

#distillation_config ⇒ Types::DistillationConfig

The distillation configuration for the custom model.

Returns:



1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
 
# File 'lib/aws-sdk-bedrock/types.rb', line 1345

class CustomizationConfig < Struct.new(
  :distillation_config,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class DistillationConfig < CustomizationConfig; end
  class Unknown < CustomizationConfig; end
end

#equals ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.

The following example would return data sources with an animal attribute whose value is ‘cat’: ‘“equals”: { “key”: “animal”, “value”: “cat” }`

Returns:



7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7312

class RequestMetadataFilters < Struct.new(
  :equals,
  :not_equals,
  :and_all,
  :or_all,
  :unknown)
  SENSITIVE = [:equals, :not_equals]
  include Aws::Structure
  include Aws::Structure::Union

  class Equals < RequestMetadataFilters; end
  class NotEquals < RequestMetadataFilters; end
  class AndAll < RequestMetadataFilters; end
  class OrAll < RequestMetadataFilters; end
  class Unknown < RequestMetadataFilters; end
end

#float_value ⇒ Float

A floating point number representing the value for a rating in a custom metric rating scale.

Returns:

  • (Float) 


7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7221

class RatingScaleItemValue < Struct.new(
  :string_value,
  :float_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class StringValue < RatingScaleItemValue; end
  class FloatValue < RatingScaleItemValue; end
  class Unknown < RatingScaleItemValue; end
end

#greater_than ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.

The following example would return data sources with an year attribute whose value is greater than ‘1989’: ‘“greaterThan”: { “key”: “year”, “value”: 1989 }`

Returns:



7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7482

class RetrievalFilter < Struct.new(
  :equals,
  :not_equals,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals,
  :in,
  :not_in,
  :starts_with,
  :list_contains,
  :string_contains,
  :and_all,
  :or_all,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class Equals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class AndAll < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#greater_than_or_equals ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.

The following example would return data sources with an year attribute whose value is greater than or equal to ‘1989’: ‘“greaterThanOrEquals”: { “key”: “year”, “value”: 1989 }`

Returns:



7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7482

class RetrievalFilter < Struct.new(
  :equals,
  :not_equals,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals,
  :in,
  :not_in,
  :starts_with,
  :list_contains,
  :string_contains,
  :and_all,
  :or_all,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class Equals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class AndAll < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#human ⇒ Types::HumanEvaluationConfig

Contains the configuration details of an evaluation job that uses human workers.

Returns:



1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
 
# File 'lib/aws-sdk-bedrock/types.rb', line 1600

class EvaluationConfig < Struct.new(
  :automated,
  :human,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Automated < EvaluationConfig; end
  class Human < EvaluationConfig; end
  class Unknown < EvaluationConfig; end
end

#in ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.

The following example would return data sources with an animal attribute that is either ‘cat’ or ‘dog’: ‘“in”: { “key”: “animal”, “value”: [“cat”, “dog”] }`

Returns:



7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7482

class RetrievalFilter < Struct.new(
  :equals,
  :not_equals,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals,
  :in,
  :not_in,
  :starts_with,
  :list_contains,
  :string_contains,
  :and_all,
  :or_all,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class Equals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class AndAll < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#knowledge_base_config ⇒ Types::KnowledgeBaseConfig

Contains configuration details for knowledge base retrieval and response generation.

Returns:



7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7169

class RAGConfig < Struct.new(
  :knowledge_base_config,
  :precomputed_rag_source_config,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class KnowledgeBaseConfig < RAGConfig; end
  class PrecomputedRagSourceConfig < RAGConfig; end
  class Unknown < RAGConfig; end
end

#less_than ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.

The following example would return data sources with an year attribute whose value is less than to ‘1989’: ‘“lessThan”: { “key”: “year”, “value”: 1989 }`

Returns:



7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7482

class RetrievalFilter < Struct.new(
  :equals,
  :not_equals,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals,
  :in,
  :not_in,
  :starts_with,
  :list_contains,
  :string_contains,
  :and_all,
  :or_all,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class Equals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class AndAll < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#less_than_or_equals ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.

The following example would return data sources with an year attribute whose value is less than or equal to ‘1989’: ‘“lessThanOrEquals”: { “key”: “year”, “value”: 1989 }`

Returns:



7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7482

class RetrievalFilter < Struct.new(
  :equals,
  :not_equals,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals,
  :in,
  :not_in,
  :starts_with,
  :list_contains,
  :string_contains,
  :and_all,
  :or_all,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class Equals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class AndAll < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#list_contains ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.

The following example would return data sources with an animals attribute that is a list containing a cat member (for example, ‘[“dog”, “cat”]`): `“listContains”: { “key”: “animals”, “value”: “cat” }`

Returns:



7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7482

class RetrievalFilter < Struct.new(
  :equals,
  :not_equals,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals,
  :in,
  :not_in,
  :starts_with,
  :list_contains,
  :string_contains,
  :and_all,
  :or_all,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class Equals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class AndAll < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#models ⇒ Array<Types::EvaluationModelConfig>

Specifies the inference models.

Returns:



1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
 
# File 'lib/aws-sdk-bedrock/types.rb', line 1740

class EvaluationInferenceConfig < Struct.new(
  :models,
  :rag_configs,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Models < EvaluationInferenceConfig; end
  class RagConfigs < EvaluationInferenceConfig; end
  class Unknown < EvaluationInferenceConfig; end
end

#not_equals ⇒ Types::FilterAttribute

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn’t match the value in this object are returned.

The following example would return data sources that don’t contain an animal attribute whose value is ‘cat’: ‘“notEquals”: { “key”: “animal”, “value”: “cat” }`

Returns:



7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7312

class RequestMetadataFilters < Struct.new(
  :equals,
  :not_equals,
  :and_all,
  :or_all,
  :unknown)
  SENSITIVE = [:equals, :not_equals]
  include Aws::Structure
  include Aws::Structure::Union

  class Equals < RequestMetadataFilters; end
  class NotEquals < RequestMetadataFilters; end
  class AndAll < RequestMetadataFilters; end
  class OrAll < RequestMetadataFilters; end
  class Unknown < RequestMetadataFilters; end
end

#not_in ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn’t in the list specified in the value in this object.

The following example would return data sources whose animal attribute is neither ‘cat’ nor ‘dog’: ‘“notIn”: { “key”: “animal”, “value”: [“cat”, “dog”] }`

Returns:



7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7482

class RetrievalFilter < Struct.new(
  :equals,
  :not_equals,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals,
  :in,
  :not_in,
  :starts_with,
  :list_contains,
  :string_contains,
  :and_all,
  :or_all,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class Equals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class AndAll < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#or_all ⇒ Array<Types::RetrievalFilter>

Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

Returns:



7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7312

class RequestMetadataFilters < Struct.new(
  :equals,
  :not_equals,
  :and_all,
  :or_all,
  :unknown)
  SENSITIVE = [:equals, :not_equals]
  include Aws::Structure
  include Aws::Structure::Union

  class Equals < RequestMetadataFilters; end
  class NotEquals < RequestMetadataFilters; end
  class AndAll < RequestMetadataFilters; end
  class OrAll < RequestMetadataFilters; end
  class Unknown < RequestMetadataFilters; end
end

#precomputed_inference_source ⇒ Types::EvaluationPrecomputedInferenceSource

Defines the model used to generate inference response data for a model evaluation job where you provide your own inference response data.

Returns:



1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
 
# File 'lib/aws-sdk-bedrock/types.rb', line 1798

class EvaluationModelConfig < Struct.new(
  :bedrock_model,
  :precomputed_inference_source,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BedrockModel < EvaluationModelConfig; end
  class PrecomputedInferenceSource < EvaluationModelConfig; end
  class Unknown < EvaluationModelConfig; end
end

#precomputed_rag_source_config ⇒ Types::EvaluationPrecomputedRagSourceConfig

Contains configuration details about the RAG source used to generate inference response data for a Knowledge Base evaluation job.

Returns:



7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7169

class RAGConfig < Struct.new(
  :knowledge_base_config,
  :precomputed_rag_source_config,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class KnowledgeBaseConfig < RAGConfig; end
  class PrecomputedRagSourceConfig < RAGConfig; end
  class Unknown < RAGConfig; end
end

#rag_configs ⇒ Array<Types::RAGConfig>

Contains the configuration details of the inference for a knowledge base evaluation job, including either the retrieval only configuration or the retrieval with response generation configuration.

Returns:



1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
 
# File 'lib/aws-sdk-bedrock/types.rb', line 1740

class EvaluationInferenceConfig < Struct.new(
  :models,
  :rag_configs,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Models < EvaluationInferenceConfig; end
  class RagConfigs < EvaluationInferenceConfig; end
  class Unknown < EvaluationInferenceConfig; end
end

#retrieve_and_generate_config ⇒ Types::RetrieveAndGenerateConfiguration

Contains configuration details for retrieving information from a knowledge base and generating responses.

Returns:



5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
 
# File 'lib/aws-sdk-bedrock/types.rb', line 5233

class KnowledgeBaseConfig < Struct.new(
  :retrieve_config,
  :retrieve_and_generate_config,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class RetrieveConfig < KnowledgeBaseConfig; end
  class RetrieveAndGenerateConfig < KnowledgeBaseConfig; end
  class Unknown < KnowledgeBaseConfig; end
end

#retrieve_and_generate_source_config ⇒ Types::EvaluationPrecomputedRetrieveAndGenerateSourceConfig

A summary of a RAG source used for a retrieve-and-generate Knowledge Base evaluation job where you provide your own inference response data.

Returns:



1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
 
# File 'lib/aws-sdk-bedrock/types.rb', line 1886

class EvaluationPrecomputedRagSourceConfig < Struct.new(
  :retrieve_source_config,
  :retrieve_and_generate_source_config,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class RetrieveSourceConfig < EvaluationPrecomputedRagSourceConfig; end
  class RetrieveAndGenerateSourceConfig < EvaluationPrecomputedRagSourceConfig; end
  class Unknown < EvaluationPrecomputedRagSourceConfig; end
end

#retrieve_config ⇒ Types::RetrieveConfig

Contains configuration details for retrieving information from a knowledge base.

Returns:



5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
 
# File 'lib/aws-sdk-bedrock/types.rb', line 5233

class KnowledgeBaseConfig < Struct.new(
  :retrieve_config,
  :retrieve_and_generate_config,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class RetrieveConfig < KnowledgeBaseConfig; end
  class RetrieveAndGenerateConfig < KnowledgeBaseConfig; end
  class Unknown < KnowledgeBaseConfig; end
end

#retrieve_source_config ⇒ Types::EvaluationPrecomputedRetrieveSourceConfig

A summary of a RAG source used for a retrieve-only Knowledge Base evaluation job where you provide your own inference response data.

Returns:



1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
 
# File 'lib/aws-sdk-bedrock/types.rb', line 1886

class EvaluationPrecomputedRagSourceConfig < Struct.new(
  :retrieve_source_config,
  :retrieve_and_generate_source_config,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class RetrieveSourceConfig < EvaluationPrecomputedRagSourceConfig; end
  class RetrieveAndGenerateSourceConfig < EvaluationPrecomputedRagSourceConfig; end
  class Unknown < EvaluationPrecomputedRagSourceConfig; end
end

#s3_data_source ⇒ Types::S3DataSource

The Amazon S3 data source of the imported model.

Returns:



6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
 
# File 'lib/aws-sdk-bedrock/types.rb', line 6576

class ModelDataSource < Struct.new(
  :s3_data_source,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class S3DataSource < ModelDataSource; end
  class Unknown < ModelDataSource; end
end

#s3_input_data_config ⇒ Types::ModelInvocationJobS3InputDataConfig

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

Returns:



6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
 
# File 'lib/aws-sdk-bedrock/types.rb', line 6648

class ModelInvocationJobInputDataConfig < Struct.new(
  :s3_input_data_config,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class S3InputDataConfig < ModelInvocationJobInputDataConfig; end
  class Unknown < ModelInvocationJobInputDataConfig; end
end

#s3_output_data_config ⇒ Types::ModelInvocationJobS3OutputDataConfig

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

Returns:



6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
 
# File 'lib/aws-sdk-bedrock/types.rb', line 6671

class ModelInvocationJobOutputDataConfig < Struct.new(
  :s3_output_data_config,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class S3OutputDataConfig < ModelInvocationJobOutputDataConfig; end
  class Unknown < ModelInvocationJobOutputDataConfig; end
end

#s3_uri ⇒ String

The URI of an invocation log in a bucket.

Returns:

  • (String) 


1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
 
# File 'lib/aws-sdk-bedrock/types.rb', line 1650

class EvaluationDatasetLocation < Struct.new(
  :s3_uri,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class S3Uri < EvaluationDatasetLocation; end
  class Unknown < EvaluationDatasetLocation; end
end

#sage_maker ⇒ Types::SageMakerEndpoint

The configuration specific to Amazon SageMaker for the endpoint.

Returns:



1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
 
# File 'lib/aws-sdk-bedrock/types.rb', line 1530

class EndpointConfig < Struct.new(
  :sage_maker,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class SageMaker < EndpointConfig; end
  class Unknown < EndpointConfig; end
end

#starts_with ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.

The following example would return data sources with an animal attribute starts with ‘ca’ (for example, ‘cat’ or ‘camel’). ‘“startsWith”: { “key”: “animal”, “value”: “ca” }`

Returns:



7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7482

class RetrievalFilter < Struct.new(
  :equals,
  :not_equals,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals,
  :in,
  :not_in,
  :starts_with,
  :list_contains,
  :string_contains,
  :and_all,
  :or_all,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class Equals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class AndAll < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#string_contains ⇒ Types::FilterAttribute

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:

A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example, ‘cat’): ‘“stringContains”: { “key”: “animal”, “value”: “at” }`

A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example, ‘[“dog”, “cat”]`): `“stringContains”: { “key”: “animals”, “value”: “at” }`

Returns:



7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7482

class RetrievalFilter < Struct.new(
  :equals,
  :not_equals,
  :greater_than,
  :greater_than_or_equals,
  :less_than,
  :less_than_or_equals,
  :in,
  :not_in,
  :starts_with,
  :list_contains,
  :string_contains,
  :and_all,
  :or_all,
  :unknown)
  SENSITIVE = [:and_all, :or_all]
  include Aws::Structure
  include Aws::Structure::Union

  class Equals < RetrievalFilter; end
  class NotEquals < RetrievalFilter; end
  class GreaterThan < RetrievalFilter; end
  class GreaterThanOrEquals < RetrievalFilter; end
  class LessThan < RetrievalFilter; end
  class LessThanOrEquals < RetrievalFilter; end
  class In < RetrievalFilter; end
  class NotIn < RetrievalFilter; end
  class StartsWith < RetrievalFilter; end
  class ListContains < RetrievalFilter; end
  class StringContains < RetrievalFilter; end
  class AndAll < RetrievalFilter; end
  class OrAll < RetrievalFilter; end
  class Unknown < RetrievalFilter; end
end

#string_value ⇒ String

A string representing the value for a rating in a custom metric rating scale.

Returns:

  • (String) 


7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
 
# File 'lib/aws-sdk-bedrock/types.rb', line 7221

class RatingScaleItemValue < Struct.new(
  :string_value,
  :float_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class StringValue < RatingScaleItemValue; end
  class FloatValue < RatingScaleItemValue; end
  class Unknown < RatingScaleItemValue; end
end