Module: Aws::Bedrock::Types

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

Defined Under Namespace

Classes: AccessDeniedException, AgreementAvailability, AutomatedEvaluationConfig, AutomatedEvaluationCustomMetricConfig, AutomatedEvaluationCustomMetricSource, BatchDeleteEvaluationJobError, BatchDeleteEvaluationJobItem, BatchDeleteEvaluationJobRequest, BatchDeleteEvaluationJobResponse, BedrockEvaluatorModel, ByteContentDoc, CloudWatchConfig, ConflictException, CreateCustomModelRequest, CreateCustomModelResponse, CreateEvaluationJobRequest, CreateEvaluationJobResponse, CreateFoundationModelAgreementRequest, CreateFoundationModelAgreementResponse, 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, DataProcessingDetails, DeleteCustomModelRequest, DeleteCustomModelResponse, DeleteFoundationModelAgreementRequest, DeleteFoundationModelAgreementResponse, DeleteGuardrailRequest, DeleteGuardrailResponse, DeleteImportedModelRequest, DeleteImportedModelResponse, DeleteInferenceProfileRequest, DeleteInferenceProfileResponse, DeleteMarketplaceModelEndpointRequest, DeleteMarketplaceModelEndpointResponse, DeleteModelInvocationLoggingConfigurationResponse, DeletePromptRouterRequest, DeletePromptRouterResponse, DeleteProvisionedModelThroughputRequest, DeleteProvisionedModelThroughputResponse, DeregisterMarketplaceModelEndpointRequest, DeregisterMarketplaceModelEndpointResponse, DimensionalPriceRate, 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, GetFoundationModelAvailabilityRequest, GetFoundationModelAvailabilityResponse, GetFoundationModelRequest, GetFoundationModelResponse, GetGuardrailRequest, GetGuardrailResponse, GetImportedModelRequest, GetImportedModelResponse, GetInferenceProfileRequest, GetInferenceProfileResponse, GetMarketplaceModelEndpointRequest, GetMarketplaceModelEndpointResponse, GetModelCopyJobRequest, GetModelCopyJobResponse, GetModelCustomizationJobRequest, GetModelCustomizationJobResponse, GetModelImportJobRequest, GetModelImportJobResponse, GetModelInvocationJobRequest, GetModelInvocationJobResponse, GetModelInvocationLoggingConfigurationResponse, GetPromptRouterRequest, GetPromptRouterResponse, GetProvisionedModelThroughputRequest, GetProvisionedModelThroughputResponse, GetUseCaseForModelAccessResponse, GuardrailConfiguration, GuardrailContentFilter, GuardrailContentFilterConfig, GuardrailContentFiltersTier, GuardrailContentFiltersTierConfig, GuardrailContentPolicy, GuardrailContentPolicyConfig, GuardrailContextualGroundingFilter, GuardrailContextualGroundingFilterConfig, GuardrailContextualGroundingPolicy, GuardrailContextualGroundingPolicyConfig, GuardrailCrossRegionConfig, GuardrailCrossRegionDetails, GuardrailManagedWords, GuardrailManagedWordsConfig, GuardrailPiiEntity, GuardrailPiiEntityConfig, GuardrailRegex, GuardrailRegexConfig, GuardrailSensitiveInformationPolicy, GuardrailSensitiveInformationPolicyConfig, GuardrailSummary, GuardrailTopic, GuardrailTopicConfig, GuardrailTopicPolicy, GuardrailTopicPolicyConfig, GuardrailTopicsTier, GuardrailTopicsTierConfig, GuardrailWord, GuardrailWordConfig, GuardrailWordPolicy, GuardrailWordPolicyConfig, HumanEvaluationConfig, HumanEvaluationCustomMetric, HumanWorkflowConfig, ImportedModelSummary, InferenceProfileModel, InferenceProfileModelSource, InferenceProfileSummary, InternalServerException, InvocationLogSource, InvocationLogsConfig, KbInferenceConfig, KnowledgeBaseConfig, KnowledgeBaseRetrievalConfiguration, KnowledgeBaseRetrieveAndGenerateConfiguration, KnowledgeBaseVectorSearchConfiguration, LegalTerm, ListCustomModelsRequest, ListCustomModelsResponse, ListEvaluationJobsRequest, ListEvaluationJobsResponse, ListFoundationModelAgreementOffersRequest, ListFoundationModelAgreementOffersResponse, 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, Offer, OrchestrationConfiguration, OutputDataConfig, PerformanceConfiguration, PricingTerm, PromptRouterSummary, PromptRouterTargetModel, PromptTemplate, ProvisionedModelSummary, PutModelInvocationLoggingConfigurationRequest, PutModelInvocationLoggingConfigurationResponse, PutUseCaseForModelAccessRequest, PutUseCaseForModelAccessResponse, QueryTransformationConfiguration, RAGConfig, RatingScaleItem, RatingScaleItemValue, RegisterMarketplaceModelEndpointRequest, RegisterMarketplaceModelEndpointResponse, RequestMetadataBaseFilters, RequestMetadataFilters, ResourceNotFoundException, RetrievalFilter, RetrieveAndGenerateConfiguration, RetrieveConfig, RoutingCriteria, S3Config, S3DataSource, S3ObjectDoc, SageMakerEndpoint, ServiceQuotaExceededException, ServiceUnavailableException, StatusDetails, StopEvaluationJobRequest, StopEvaluationJobResponse, StopModelCustomizationJobRequest, StopModelCustomizationJobResponse, StopModelInvocationJobRequest, StopModelInvocationJobResponse, SupportTerm, Tag, TagResourceRequest, TagResourceResponse, TeacherModelConfig, TermDetails, TextInferenceConfig, ThrottlingException, TooManyTagsException, TrainingDataConfig, TrainingDetails, TrainingMetrics, UntagResourceRequest, UntagResourceResponse, UpdateGuardrailRequest, UpdateGuardrailResponse, UpdateMarketplaceModelEndpointRequest, UpdateMarketplaceModelEndpointResponse, UpdateProvisionedModelThroughputRequest, UpdateProvisionedModelThroughputResponse, ValidationDataConfig, ValidationDetails, ValidationException, Validator, ValidatorMetric, ValidityTerm, 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:



7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7972

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:



1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1835

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:



2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 2286

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:



2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 2033

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) 


5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5598

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:



120
121
122
123
124
125
126
127
128
129
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 120

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:



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1510

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:



7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7972

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) 


7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7881

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:



8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8142

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:



8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8142

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:



1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1835

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:



8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8142

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:



7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7829

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:



8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8142

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:



8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8142

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:



8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8142

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:



1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1975

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:



7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7972

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:



8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8142

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:



7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7972

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:



2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 2033

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:



7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7829

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:



1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1975

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:



5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5769

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:



2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 2121

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:



5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5769

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:



2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 2121

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 model to import.

Returns:



7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7182

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:



7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7254

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:



7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7277

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) 


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

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:



1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1765

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:



8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8142

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:



8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8142

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) 


7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7881

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