Module: Aws::Bedrock::Types

Defined in:
gems/aws-sdk-bedrock/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, DataProcessingDetails, DeleteCustomModelRequest, DeleteCustomModelResponse, DeleteGuardrailRequest, DeleteGuardrailResponse, DeleteImportedModelRequest, DeleteImportedModelResponse, DeleteInferenceProfileRequest, DeleteInferenceProfileResponse, DeleteMarketplaceModelEndpointRequest, DeleteMarketplaceModelEndpointResponse, 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, GetModelInvocationLoggingConfigurationResponse, GetPromptRouterRequest, GetPromptRouterResponse, GetProvisionedModelThroughputRequest, GetProvisionedModelThroughputResponse, GuardrailConfiguration, GuardrailContentFilter, GuardrailContentFilterConfig, GuardrailContentPolicy, GuardrailContentPolicyConfig, GuardrailContextualGroundingFilter, GuardrailContextualGroundingFilterConfig, GuardrailContextualGroundingPolicy, GuardrailContextualGroundingPolicyConfig, GuardrailCrossRegionConfig, GuardrailCrossRegionDetails, 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, StatusDetails, StopEvaluationJobRequest, StopEvaluationJobResponse, StopModelCustomizationJobRequest, StopModelCustomizationJobResponse, StopModelInvocationJobRequest, StopModelInvocationJobResponse, Tag, TagResourceRequest, TagResourceResponse, TeacherModelConfig, TextInferenceConfig, ThrottlingException, TooManyTagsException, TrainingDataConfig, TrainingDetails, TrainingMetrics, UntagResourceRequest, UntagResourceResponse, UpdateGuardrailRequest, UpdateGuardrailResponse, UpdateMarketplaceModelEndpointRequest, UpdateMarketplaceModelEndpointResponse, UpdateProvisionedModelThroughputRequest, UpdateProvisionedModelThroughputResponse, ValidationDataConfig, ValidationDetails, 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:



7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7441

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:



1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1639

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:



2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 2090

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:



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

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) 


5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5186

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 'gems/aws-sdk-bedrock/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:



1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1359

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:



7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7441

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) 


7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7350

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:



7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7611

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:



7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7611

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:



1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1639

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:



7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7611

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:



7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7298

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:



7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7611

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:



7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7611

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:



7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7611

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:



1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1779

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:



7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7441

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:



7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7611

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:



7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7441

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:



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

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:



7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7298

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:



1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1779

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:



5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5357

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:



1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1925

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:



5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5357

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:



1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1925

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:



6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6705

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:



6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6777

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:



6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6800

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) 


1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1689

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:



1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1569

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:



7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7611

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:



7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7611

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) 


7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7350

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