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, CreateProvisionedModelThroughputRequest, CreateProvisionedModelThroughputResponse, CustomModelSummary, CustomizationConfig, DeleteCustomModelRequest, DeleteCustomModelResponse, DeleteGuardrailRequest, DeleteGuardrailResponse, DeleteImportedModelRequest, DeleteImportedModelResponse, DeleteInferenceProfileRequest, DeleteInferenceProfileResponse, DeleteMarketplaceModelEndpointRequest, DeleteMarketplaceModelEndpointResponse, DeleteModelInvocationLoggingConfigurationResponse, 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_all ⇒ Array<Types::RetrievalFilter>

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

Returns:



6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6321

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:



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1339

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:



1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1611

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:



1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1505

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_from ⇒ String

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

Returns:

  • (String) 


4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 4136

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_config ⇒ Types::DistillationConfig

The distillation configuration for the custom model.

Returns:



1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1100

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:



6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6321

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



6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6491

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:



6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6491

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:



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1339

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:



6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6491

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:



6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6232

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



6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6491

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:



6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6491

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:



6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6491

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:



1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1479

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:



6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6321

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:



6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6491

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:



6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6321

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



1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1479

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:



4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 4307

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_config ⇒ Types::RetrieveConfig

Contains configuration details for retrieving information from a knowledge base.

Returns:



4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 4307

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_source ⇒ Types::S3DataSource

The Amazon S3 data source of the imported model.

Returns:



5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5644

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:



5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5716

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:



5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 5739

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) 


1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1389

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:



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 1269

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:



6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6491

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:



6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 6491

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