Module: Aws::Bedrock::Types

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

Defined Under Namespace

Classes: AccessDeniedException, AutomatedEvaluationConfig, 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, CustomModelSummary, CustomizationConfig, 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, EvaluationModelConfig, EvaluationOutputDataConfig, 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, 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, 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_allArray<Types::RetrievalFilter>

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

Returns:


6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6409

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

#automatedTypes::AutomatedEvaluationConfig

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


1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1421

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_modelsArray<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:


1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1693

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_modelTypes::EvaluationBedrockModel

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


1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1587

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

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

#copy_fromString

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

Returns:

  • (String)

4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 4218

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

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

#distillation_configTypes::DistillationConfig

The distillation configuration for the custom model.


1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1166

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

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

#equalsTypes::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" }


6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6409

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

#greater_thanTypes::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 }


6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6579

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_equalsTypes::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 }


6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6579

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

#humanTypes::HumanEvaluationConfig

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


1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1421

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

#inTypes::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"] }


6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6579

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_configTypes::KnowledgeBaseConfig

Contains configuration details for knowledge base retrieval and response generation.


6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6320

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

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

#less_thanTypes::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 }


6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6579

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_equalsTypes::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 }


6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6579

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_containsTypes::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" }


6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6579

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

#modelsArray<Types::EvaluationModelConfig>

Specifies the inference models.

Returns:


1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1561

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_equalsTypes::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" }


6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6409

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_inTypes::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"] }


6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6579

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_allArray<Types::RetrievalFilter>

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

Returns:


6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6409

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

#rag_configsArray<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:


1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1561

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_configTypes::RetrieveAndGenerateConfiguration

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


4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 4389

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_configTypes::RetrieveConfig

Contains configuration details for retrieving information from a knowledge base.


4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 4389

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

#s3_data_sourceTypes::S3DataSource

The Amazon S3 data source of the imported model.

Returns:


5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5732

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_configTypes::ModelInvocationJobS3InputDataConfig

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


5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5804

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_configTypes::ModelInvocationJobS3OutputDataConfig

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


5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5827

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_uriString

The URI of an invocation log in a bucket.

Returns:

  • (String)

1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1471

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_makerTypes::SageMakerEndpoint

The configuration specific to Amazon SageMaker for the endpoint.


1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1351

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_withTypes::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" }


6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6579

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_containsTypes::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" }


6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6579

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