Type definitions#
Auto-generated documentation for Bedrock type annotations stubs module types-boto3-bedrock.
BlobTypeDef#
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
FilterAttributeUnionTypeDef#
# FilterAttributeUnionTypeDef definition
FilterAttributeUnionTypeDef = Union[
FilterAttributeTypeDef, # (1)
FilterAttributeOutputTypeDef, # (2)
]
VpcConfigUnionTypeDef#
# VpcConfigUnionTypeDef definition
VpcConfigUnionTypeDef = Union[
VpcConfigTypeDef, # (1)
VpcConfigOutputTypeDef, # (2)
]
RequestMetadataBaseFiltersUnionTypeDef#
# RequestMetadataBaseFiltersUnionTypeDef definition
RequestMetadataBaseFiltersUnionTypeDef = Union[
RequestMetadataBaseFiltersTypeDef, # (1)
RequestMetadataBaseFiltersOutputTypeDef, # (2)
]
TextInferenceConfigUnionTypeDef#
# TextInferenceConfigUnionTypeDef definition
TextInferenceConfigUnionTypeDef = Union[
TextInferenceConfigTypeDef, # (1)
TextInferenceConfigOutputTypeDef, # (2)
]
EvaluatorModelConfigUnionTypeDef#
# EvaluatorModelConfigUnionTypeDef definition
EvaluatorModelConfigUnionTypeDef = Union[
EvaluatorModelConfigTypeDef, # (1)
EvaluatorModelConfigOutputTypeDef, # (2)
]
ByteContentDocUnionTypeDef#
# ByteContentDocUnionTypeDef definition
ByteContentDocUnionTypeDef = Union[
ByteContentDocTypeDef, # (1)
ByteContentDocOutputTypeDef, # (2)
]
EvaluationDatasetMetricConfigUnionTypeDef#
# EvaluationDatasetMetricConfigUnionTypeDef definition
EvaluationDatasetMetricConfigUnionTypeDef = Union[
EvaluationDatasetMetricConfigTypeDef, # (1)
EvaluationDatasetMetricConfigOutputTypeDef, # (2)
]
RetrievalFilterUnionTypeDef#
# RetrievalFilterUnionTypeDef definition
RetrievalFilterUnionTypeDef = Union[
RetrievalFilterTypeDef, # (1)
RetrievalFilterOutputTypeDef, # (2)
]
SageMakerEndpointUnionTypeDef#
# SageMakerEndpointUnionTypeDef definition
SageMakerEndpointUnionTypeDef = Union[
SageMakerEndpointTypeDef, # (1)
SageMakerEndpointOutputTypeDef, # (2)
]
RequestMetadataFiltersUnionTypeDef#
# RequestMetadataFiltersUnionTypeDef definition
RequestMetadataFiltersUnionTypeDef = Union[
RequestMetadataFiltersTypeDef, # (1)
RequestMetadataFiltersOutputTypeDef, # (2)
]
KbInferenceConfigUnionTypeDef#
# KbInferenceConfigUnionTypeDef definition
KbInferenceConfigUnionTypeDef = Union[
KbInferenceConfigTypeDef, # (1)
KbInferenceConfigOutputTypeDef, # (2)
]
ExternalSourceUnionTypeDef#
# ExternalSourceUnionTypeDef definition
ExternalSourceUnionTypeDef = Union[
ExternalSourceTypeDef, # (1)
ExternalSourceOutputTypeDef, # (2)
]
AutomatedEvaluationConfigUnionTypeDef#
# AutomatedEvaluationConfigUnionTypeDef definition
AutomatedEvaluationConfigUnionTypeDef = Union[
AutomatedEvaluationConfigTypeDef, # (1)
AutomatedEvaluationConfigOutputTypeDef, # (2)
]
HumanEvaluationConfigUnionTypeDef#
# HumanEvaluationConfigUnionTypeDef definition
HumanEvaluationConfigUnionTypeDef = Union[
HumanEvaluationConfigTypeDef, # (1)
HumanEvaluationConfigOutputTypeDef, # (2)
]
KnowledgeBaseVectorSearchConfigurationUnionTypeDef#
# KnowledgeBaseVectorSearchConfigurationUnionTypeDef definition
KnowledgeBaseVectorSearchConfigurationUnionTypeDef = Union[
KnowledgeBaseVectorSearchConfigurationTypeDef, # (1)
KnowledgeBaseVectorSearchConfigurationOutputTypeDef, # (2)
]
- See KnowledgeBaseVectorSearchConfigurationTypeDef
- See KnowledgeBaseVectorSearchConfigurationOutputTypeDef
InvocationLogsConfigUnionTypeDef#
# InvocationLogsConfigUnionTypeDef definition
InvocationLogsConfigUnionTypeDef = Union[
InvocationLogsConfigTypeDef, # (1)
InvocationLogsConfigOutputTypeDef, # (2)
]
ExternalSourcesGenerationConfigurationUnionTypeDef#
# ExternalSourcesGenerationConfigurationUnionTypeDef definition
ExternalSourcesGenerationConfigurationUnionTypeDef = Union[
ExternalSourcesGenerationConfigurationTypeDef, # (1)
ExternalSourcesGenerationConfigurationOutputTypeDef, # (2)
]
- See ExternalSourcesGenerationConfigurationTypeDef
- See ExternalSourcesGenerationConfigurationOutputTypeDef
GenerationConfigurationUnionTypeDef#
# GenerationConfigurationUnionTypeDef definition
GenerationConfigurationUnionTypeDef = Union[
GenerationConfigurationTypeDef, # (1)
GenerationConfigurationOutputTypeDef, # (2)
]
KnowledgeBaseRetrievalConfigurationUnionTypeDef#
# KnowledgeBaseRetrievalConfigurationUnionTypeDef definition
KnowledgeBaseRetrievalConfigurationUnionTypeDef = Union[
KnowledgeBaseRetrievalConfigurationTypeDef, # (1)
KnowledgeBaseRetrievalConfigurationOutputTypeDef, # (2)
]
ExternalSourcesRetrieveAndGenerateConfigurationUnionTypeDef#
# ExternalSourcesRetrieveAndGenerateConfigurationUnionTypeDef definition
ExternalSourcesRetrieveAndGenerateConfigurationUnionTypeDef = Union[
ExternalSourcesRetrieveAndGenerateConfigurationTypeDef, # (1)
ExternalSourcesRetrieveAndGenerateConfigurationOutputTypeDef, # (2)
]
- See ExternalSourcesRetrieveAndGenerateConfigurationTypeDef
- See ExternalSourcesRetrieveAndGenerateConfigurationOutputTypeDef
KnowledgeBaseRetrieveAndGenerateConfigurationUnionTypeDef#
# KnowledgeBaseRetrieveAndGenerateConfigurationUnionTypeDef definition
KnowledgeBaseRetrieveAndGenerateConfigurationUnionTypeDef = Union[
KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef, # (1)
KnowledgeBaseRetrieveAndGenerateConfigurationOutputTypeDef, # (2)
]
- See KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef
- See KnowledgeBaseRetrieveAndGenerateConfigurationOutputTypeDef
RetrieveConfigUnionTypeDef#
# RetrieveConfigUnionTypeDef definition
RetrieveConfigUnionTypeDef = Union[
RetrieveConfigTypeDef, # (1)
RetrieveConfigOutputTypeDef, # (2)
]
RetrieveAndGenerateConfigurationUnionTypeDef#
# RetrieveAndGenerateConfigurationUnionTypeDef definition
RetrieveAndGenerateConfigurationUnionTypeDef = Union[
RetrieveAndGenerateConfigurationTypeDef, # (1)
RetrieveAndGenerateConfigurationOutputTypeDef, # (2)
]
KnowledgeBaseConfigUnionTypeDef#
# KnowledgeBaseConfigUnionTypeDef definition
KnowledgeBaseConfigUnionTypeDef = Union[
KnowledgeBaseConfigTypeDef, # (1)
KnowledgeBaseConfigOutputTypeDef, # (2)
]
RAGConfigUnionTypeDef#
# RAGConfigUnionTypeDef definition
RAGConfigUnionTypeDef = Union[
RAGConfigTypeDef, # (1)
RAGConfigOutputTypeDef, # (2)
]
BatchDeleteEvaluationJobErrorTypeDef#
# BatchDeleteEvaluationJobErrorTypeDef definition
class BatchDeleteEvaluationJobErrorTypeDef(TypedDict):
jobIdentifier: str,
code: str,
message: NotRequired[str],
BatchDeleteEvaluationJobItemTypeDef#
# BatchDeleteEvaluationJobItemTypeDef definition
class BatchDeleteEvaluationJobItemTypeDef(TypedDict):
jobIdentifier: str,
jobStatus: EvaluationJobStatusType, # (1)
BatchDeleteEvaluationJobRequestRequestTypeDef#
# BatchDeleteEvaluationJobRequestRequestTypeDef definition
class BatchDeleteEvaluationJobRequestRequestTypeDef(TypedDict):
jobIdentifiers: Sequence[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
BedrockEvaluatorModelTypeDef#
# BedrockEvaluatorModelTypeDef definition
class BedrockEvaluatorModelTypeDef(TypedDict):
modelIdentifier: str,
ByteContentDocOutputTypeDef#
# ByteContentDocOutputTypeDef definition
class ByteContentDocOutputTypeDef(TypedDict):
identifier: str,
contentType: str,
data: bytes,
S3ConfigTypeDef#
# S3ConfigTypeDef definition
class S3ConfigTypeDef(TypedDict):
bucketName: str,
keyPrefix: NotRequired[str],
EvaluationOutputDataConfigTypeDef#
# EvaluationOutputDataConfigTypeDef definition
class EvaluationOutputDataConfigTypeDef(TypedDict):
s3Uri: str,
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
key: str,
value: str,
CreateGuardrailVersionRequestRequestTypeDef#
# CreateGuardrailVersionRequestRequestTypeDef definition
class CreateGuardrailVersionRequestRequestTypeDef(TypedDict):
guardrailIdentifier: str,
description: NotRequired[str],
clientRequestToken: NotRequired[str],
InferenceProfileModelSourceTypeDef#
# InferenceProfileModelSourceTypeDef definition
class InferenceProfileModelSourceTypeDef(TypedDict):
copyFrom: NotRequired[str],
OutputDataConfigTypeDef#
# OutputDataConfigTypeDef definition
class OutputDataConfigTypeDef(TypedDict):
s3Uri: str,
VpcConfigTypeDef#
# VpcConfigTypeDef definition
class VpcConfigTypeDef(TypedDict):
subnetIds: Sequence[str],
securityGroupIds: Sequence[str],
CustomModelSummaryTypeDef#
# CustomModelSummaryTypeDef definition
class CustomModelSummaryTypeDef(TypedDict):
modelArn: str,
modelName: str,
creationTime: datetime,
baseModelArn: str,
baseModelName: str,
customizationType: NotRequired[CustomizationTypeType], # (1)
ownerAccountId: NotRequired[str],
DeleteCustomModelRequestRequestTypeDef#
# DeleteCustomModelRequestRequestTypeDef definition
class DeleteCustomModelRequestRequestTypeDef(TypedDict):
modelIdentifier: str,
DeleteGuardrailRequestRequestTypeDef#
# DeleteGuardrailRequestRequestTypeDef definition
class DeleteGuardrailRequestRequestTypeDef(TypedDict):
guardrailIdentifier: str,
guardrailVersion: NotRequired[str],
DeleteImportedModelRequestRequestTypeDef#
# DeleteImportedModelRequestRequestTypeDef definition
class DeleteImportedModelRequestRequestTypeDef(TypedDict):
modelIdentifier: str,
DeleteInferenceProfileRequestRequestTypeDef#
# DeleteInferenceProfileRequestRequestTypeDef definition
class DeleteInferenceProfileRequestRequestTypeDef(TypedDict):
inferenceProfileIdentifier: str,
DeleteMarketplaceModelEndpointRequestRequestTypeDef#
# DeleteMarketplaceModelEndpointRequestRequestTypeDef definition
class DeleteMarketplaceModelEndpointRequestRequestTypeDef(TypedDict):
endpointArn: str,
DeleteProvisionedModelThroughputRequestRequestTypeDef#
# DeleteProvisionedModelThroughputRequestRequestTypeDef definition
class DeleteProvisionedModelThroughputRequestRequestTypeDef(TypedDict):
provisionedModelId: str,
DeregisterMarketplaceModelEndpointRequestRequestTypeDef#
# DeregisterMarketplaceModelEndpointRequestRequestTypeDef definition
class DeregisterMarketplaceModelEndpointRequestRequestTypeDef(TypedDict):
endpointArn: str,
TeacherModelConfigTypeDef#
# TeacherModelConfigTypeDef definition
class TeacherModelConfigTypeDef(TypedDict):
teacherModelIdentifier: str,
maxResponseLengthForInference: NotRequired[int],
EvaluationBedrockModelTypeDef#
# EvaluationBedrockModelTypeDef definition
class EvaluationBedrockModelTypeDef(TypedDict):
modelIdentifier: str,
inferenceParams: NotRequired[str],
EvaluationDatasetLocationTypeDef#
# EvaluationDatasetLocationTypeDef definition
class EvaluationDatasetLocationTypeDef(TypedDict):
s3Uri: NotRequired[str],
EvaluationSummaryTypeDef#
# EvaluationSummaryTypeDef definition
class EvaluationSummaryTypeDef(TypedDict):
jobArn: str,
jobName: str,
status: EvaluationJobStatusType, # (1)
creationTime: datetime,
jobType: EvaluationJobTypeType, # (2)
evaluationTaskTypes: list[EvaluationTaskTypeType], # (3)
modelIdentifiers: NotRequired[list[str]],
ragIdentifiers: NotRequired[list[str]],
evaluatorModelIdentifiers: NotRequired[list[str]],
applicationType: NotRequired[ApplicationTypeType], # (4)
- See EvaluationJobStatusType
- See EvaluationJobTypeType
- See EvaluationTaskTypeType
- See ApplicationTypeType
S3ObjectDocTypeDef#
# S3ObjectDocTypeDef definition
class S3ObjectDocTypeDef(TypedDict):
uri: str,
GuardrailConfigurationTypeDef#
# GuardrailConfigurationTypeDef definition
class GuardrailConfigurationTypeDef(TypedDict):
guardrailId: str,
guardrailVersion: str,
PromptTemplateTypeDef#
# PromptTemplateTypeDef definition
class PromptTemplateTypeDef(TypedDict):
textPromptTemplate: NotRequired[str],
FilterAttributeOutputTypeDef#
# FilterAttributeOutputTypeDef definition
class FilterAttributeOutputTypeDef(TypedDict):
key: str,
value: dict[str, Any],
FilterAttributeTypeDef#
# FilterAttributeTypeDef definition
class FilterAttributeTypeDef(TypedDict):
key: str,
value: Mapping[str, Any],
FoundationModelLifecycleTypeDef#
# FoundationModelLifecycleTypeDef definition
class FoundationModelLifecycleTypeDef(TypedDict):
status: FoundationModelLifecycleStatusType, # (1)
GetCustomModelRequestRequestTypeDef#
# GetCustomModelRequestRequestTypeDef definition
class GetCustomModelRequestRequestTypeDef(TypedDict):
modelIdentifier: str,
TrainingMetricsTypeDef#
# TrainingMetricsTypeDef definition
class TrainingMetricsTypeDef(TypedDict):
trainingLoss: NotRequired[float],
ValidatorMetricTypeDef#
# ValidatorMetricTypeDef definition
class ValidatorMetricTypeDef(TypedDict):
validationLoss: NotRequired[float],
GetEvaluationJobRequestRequestTypeDef#
# GetEvaluationJobRequestRequestTypeDef definition
class GetEvaluationJobRequestRequestTypeDef(TypedDict):
jobIdentifier: str,
GetFoundationModelRequestRequestTypeDef#
# GetFoundationModelRequestRequestTypeDef definition
class GetFoundationModelRequestRequestTypeDef(TypedDict):
modelIdentifier: str,
GetGuardrailRequestRequestTypeDef#
# GetGuardrailRequestRequestTypeDef definition
class GetGuardrailRequestRequestTypeDef(TypedDict):
guardrailIdentifier: str,
guardrailVersion: NotRequired[str],
GetImportedModelRequestRequestTypeDef#
# GetImportedModelRequestRequestTypeDef definition
class GetImportedModelRequestRequestTypeDef(TypedDict):
modelIdentifier: str,
GetInferenceProfileRequestRequestTypeDef#
# GetInferenceProfileRequestRequestTypeDef definition
class GetInferenceProfileRequestRequestTypeDef(TypedDict):
inferenceProfileIdentifier: str,
InferenceProfileModelTypeDef#
# InferenceProfileModelTypeDef definition
class InferenceProfileModelTypeDef(TypedDict):
modelArn: NotRequired[str],
GetMarketplaceModelEndpointRequestRequestTypeDef#
# GetMarketplaceModelEndpointRequestRequestTypeDef definition
class GetMarketplaceModelEndpointRequestRequestTypeDef(TypedDict):
endpointArn: str,
GetModelCopyJobRequestRequestTypeDef#
# GetModelCopyJobRequestRequestTypeDef definition
class GetModelCopyJobRequestRequestTypeDef(TypedDict):
jobArn: str,
GetModelCustomizationJobRequestRequestTypeDef#
# GetModelCustomizationJobRequestRequestTypeDef definition
class GetModelCustomizationJobRequestRequestTypeDef(TypedDict):
jobIdentifier: str,
VpcConfigOutputTypeDef#
# VpcConfigOutputTypeDef definition
class VpcConfigOutputTypeDef(TypedDict):
subnetIds: list[str],
securityGroupIds: list[str],
GetModelImportJobRequestRequestTypeDef#
# GetModelImportJobRequestRequestTypeDef definition
class GetModelImportJobRequestRequestTypeDef(TypedDict):
jobIdentifier: str,
GetModelInvocationJobRequestRequestTypeDef#
# GetModelInvocationJobRequestRequestTypeDef definition
class GetModelInvocationJobRequestRequestTypeDef(TypedDict):
jobIdentifier: str,
GetPromptRouterRequestRequestTypeDef#
# GetPromptRouterRequestRequestTypeDef definition
class GetPromptRouterRequestRequestTypeDef(TypedDict):
promptRouterArn: str,
PromptRouterTargetModelTypeDef#
# PromptRouterTargetModelTypeDef definition
class PromptRouterTargetModelTypeDef(TypedDict):
modelArn: NotRequired[str],
RoutingCriteriaTypeDef#
# RoutingCriteriaTypeDef definition
class RoutingCriteriaTypeDef(TypedDict):
responseQualityDifference: float,
GetProvisionedModelThroughputRequestRequestTypeDef#
# GetProvisionedModelThroughputRequestRequestTypeDef definition
class GetProvisionedModelThroughputRequestRequestTypeDef(TypedDict):
provisionedModelId: str,
GuardrailContentFilterConfigTypeDef#
# GuardrailContentFilterConfigTypeDef definition
class GuardrailContentFilterConfigTypeDef(TypedDict):
type: GuardrailContentFilterTypeType, # (1)
inputStrength: GuardrailFilterStrengthType, # (2)
outputStrength: GuardrailFilterStrengthType, # (2)
inputModalities: NotRequired[Sequence[GuardrailModalityType]], # (4)
outputModalities: NotRequired[Sequence[GuardrailModalityType]], # (4)
- See GuardrailContentFilterTypeType
- See GuardrailFilterStrengthType
- See GuardrailFilterStrengthType
- See GuardrailModalityType
- See GuardrailModalityType
GuardrailContentFilterTypeDef#
# GuardrailContentFilterTypeDef definition
class GuardrailContentFilterTypeDef(TypedDict):
type: GuardrailContentFilterTypeType, # (1)
inputStrength: GuardrailFilterStrengthType, # (2)
outputStrength: GuardrailFilterStrengthType, # (2)
inputModalities: NotRequired[list[GuardrailModalityType]], # (4)
outputModalities: NotRequired[list[GuardrailModalityType]], # (4)
- See GuardrailContentFilterTypeType
- See GuardrailFilterStrengthType
- See GuardrailFilterStrengthType
- See GuardrailModalityType
- See GuardrailModalityType
GuardrailContextualGroundingFilterConfigTypeDef#
# GuardrailContextualGroundingFilterConfigTypeDef definition
class GuardrailContextualGroundingFilterConfigTypeDef(TypedDict):
type: GuardrailContextualGroundingFilterTypeType, # (1)
threshold: float,
GuardrailContextualGroundingFilterTypeDef#
# GuardrailContextualGroundingFilterTypeDef definition
class GuardrailContextualGroundingFilterTypeDef(TypedDict):
type: GuardrailContextualGroundingFilterTypeType, # (1)
threshold: float,
GuardrailManagedWordsConfigTypeDef#
# GuardrailManagedWordsConfigTypeDef definition
class GuardrailManagedWordsConfigTypeDef(TypedDict):
type: GuardrailManagedWordsTypeType, # (1)
GuardrailManagedWordsTypeDef#
# GuardrailManagedWordsTypeDef definition
class GuardrailManagedWordsTypeDef(TypedDict):
type: GuardrailManagedWordsTypeType, # (1)
GuardrailPiiEntityConfigTypeDef#
# GuardrailPiiEntityConfigTypeDef definition
class GuardrailPiiEntityConfigTypeDef(TypedDict):
type: GuardrailPiiEntityTypeType, # (1)
action: GuardrailSensitiveInformationActionType, # (2)
GuardrailPiiEntityTypeDef#
# GuardrailPiiEntityTypeDef definition
class GuardrailPiiEntityTypeDef(TypedDict):
type: GuardrailPiiEntityTypeType, # (1)
action: GuardrailSensitiveInformationActionType, # (2)
GuardrailRegexConfigTypeDef#
# GuardrailRegexConfigTypeDef definition
class GuardrailRegexConfigTypeDef(TypedDict):
name: str,
pattern: str,
action: GuardrailSensitiveInformationActionType, # (1)
description: NotRequired[str],
GuardrailRegexTypeDef#
# GuardrailRegexTypeDef definition
class GuardrailRegexTypeDef(TypedDict):
name: str,
pattern: str,
action: GuardrailSensitiveInformationActionType, # (1)
description: NotRequired[str],
GuardrailSummaryTypeDef#
# GuardrailSummaryTypeDef definition
class GuardrailSummaryTypeDef(TypedDict):
id: str,
arn: str,
status: GuardrailStatusType, # (1)
name: str,
version: str,
createdAt: datetime,
updatedAt: datetime,
description: NotRequired[str],
GuardrailTopicConfigTypeDef#
# GuardrailTopicConfigTypeDef definition
class GuardrailTopicConfigTypeDef(TypedDict):
name: str,
definition: str,
type: GuardrailTopicTypeType, # (1)
examples: NotRequired[Sequence[str]],
GuardrailTopicTypeDef#
# GuardrailTopicTypeDef definition
class GuardrailTopicTypeDef(TypedDict):
name: str,
definition: str,
examples: NotRequired[list[str]],
type: NotRequired[GuardrailTopicTypeType], # (1)
GuardrailWordConfigTypeDef#
# GuardrailWordConfigTypeDef definition
class GuardrailWordConfigTypeDef(TypedDict):
text: str,
GuardrailWordTypeDef#
# GuardrailWordTypeDef definition
class GuardrailWordTypeDef(TypedDict):
text: str,
HumanEvaluationCustomMetricTypeDef#
# HumanEvaluationCustomMetricTypeDef definition
class HumanEvaluationCustomMetricTypeDef(TypedDict):
name: str,
ratingMethod: str,
description: NotRequired[str],
HumanWorkflowConfigTypeDef#
# HumanWorkflowConfigTypeDef definition
class HumanWorkflowConfigTypeDef(TypedDict):
flowDefinitionArn: str,
instructions: NotRequired[str],
ImportedModelSummaryTypeDef#
# ImportedModelSummaryTypeDef definition
class ImportedModelSummaryTypeDef(TypedDict):
modelArn: str,
modelName: str,
creationTime: datetime,
instructSupported: NotRequired[bool],
modelArchitecture: NotRequired[str],
InvocationLogSourceTypeDef#
# InvocationLogSourceTypeDef definition
class InvocationLogSourceTypeDef(TypedDict):
s3Uri: NotRequired[str],
TextInferenceConfigOutputTypeDef#
# TextInferenceConfigOutputTypeDef definition
class TextInferenceConfigOutputTypeDef(TypedDict):
temperature: NotRequired[float],
topP: NotRequired[float],
maxTokens: NotRequired[int],
stopSequences: NotRequired[list[str]],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListFoundationModelsRequestRequestTypeDef#
# ListFoundationModelsRequestRequestTypeDef definition
class ListFoundationModelsRequestRequestTypeDef(TypedDict):
byProvider: NotRequired[str],
byCustomizationType: NotRequired[ModelCustomizationType], # (1)
byOutputModality: NotRequired[ModelModalityType], # (2)
byInferenceType: NotRequired[InferenceTypeType], # (3)
- See ModelCustomizationType
- See ModelModalityType
- See InferenceTypeType
ListGuardrailsRequestRequestTypeDef#
# ListGuardrailsRequestRequestTypeDef definition
class ListGuardrailsRequestRequestTypeDef(TypedDict):
guardrailIdentifier: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListInferenceProfilesRequestRequestTypeDef#
# ListInferenceProfilesRequestRequestTypeDef definition
class ListInferenceProfilesRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
typeEquals: NotRequired[InferenceProfileTypeType], # (1)
ListMarketplaceModelEndpointsRequestRequestTypeDef#
# ListMarketplaceModelEndpointsRequestRequestTypeDef definition
class ListMarketplaceModelEndpointsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
modelSourceEquals: NotRequired[str],
MarketplaceModelEndpointSummaryTypeDef#
# MarketplaceModelEndpointSummaryTypeDef definition
class MarketplaceModelEndpointSummaryTypeDef(TypedDict):
endpointArn: str,
modelSourceIdentifier: str,
createdAt: datetime,
updatedAt: datetime,
status: NotRequired[StatusType], # (1)
statusMessage: NotRequired[str],
- See StatusType
ModelCustomizationJobSummaryTypeDef#
# ModelCustomizationJobSummaryTypeDef definition
class ModelCustomizationJobSummaryTypeDef(TypedDict):
jobArn: str,
baseModelArn: str,
jobName: str,
status: ModelCustomizationJobStatusType, # (1)
creationTime: datetime,
lastModifiedTime: NotRequired[datetime],
endTime: NotRequired[datetime],
customModelArn: NotRequired[str],
customModelName: NotRequired[str],
customizationType: NotRequired[CustomizationTypeType], # (2)
ModelImportJobSummaryTypeDef#
# ModelImportJobSummaryTypeDef definition
class ModelImportJobSummaryTypeDef(TypedDict):
jobArn: str,
jobName: str,
status: ModelImportJobStatusType, # (1)
creationTime: datetime,
lastModifiedTime: NotRequired[datetime],
endTime: NotRequired[datetime],
importedModelArn: NotRequired[str],
importedModelName: NotRequired[str],
ListPromptRoutersRequestRequestTypeDef#
# ListPromptRoutersRequestRequestTypeDef definition
class ListPromptRoutersRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ProvisionedModelSummaryTypeDef#
# ProvisionedModelSummaryTypeDef definition
class ProvisionedModelSummaryTypeDef(TypedDict):
provisionedModelName: str,
provisionedModelArn: str,
modelArn: str,
desiredModelArn: str,
foundationModelArn: str,
modelUnits: int,
desiredModelUnits: int,
status: ProvisionedModelStatusType, # (1)
creationTime: datetime,
lastModifiedTime: datetime,
commitmentDuration: NotRequired[CommitmentDurationType], # (2)
commitmentExpirationTime: NotRequired[datetime],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
S3DataSourceTypeDef#
# S3DataSourceTypeDef definition
class S3DataSourceTypeDef(TypedDict):
s3Uri: str,
ModelInvocationJobS3InputDataConfigTypeDef#
# ModelInvocationJobS3InputDataConfigTypeDef definition
class ModelInvocationJobS3InputDataConfigTypeDef(TypedDict):
s3Uri: str,
s3InputFormat: NotRequired[S3InputFormatType], # (1)
s3BucketOwner: NotRequired[str],
ModelInvocationJobS3OutputDataConfigTypeDef#
# ModelInvocationJobS3OutputDataConfigTypeDef definition
class ModelInvocationJobS3OutputDataConfigTypeDef(TypedDict):
s3Uri: str,
s3EncryptionKeyId: NotRequired[str],
s3BucketOwner: NotRequired[str],
QueryTransformationConfigurationTypeDef#
# QueryTransformationConfigurationTypeDef definition
class QueryTransformationConfigurationTypeDef(TypedDict):
type: QueryTransformationTypeType, # (1)
RegisterMarketplaceModelEndpointRequestRequestTypeDef#
# RegisterMarketplaceModelEndpointRequestRequestTypeDef definition
class RegisterMarketplaceModelEndpointRequestRequestTypeDef(TypedDict):
endpointIdentifier: str,
modelSourceIdentifier: str,
RequestMetadataBaseFiltersOutputTypeDef#
# RequestMetadataBaseFiltersOutputTypeDef definition
class RequestMetadataBaseFiltersOutputTypeDef(TypedDict):
equals: NotRequired[dict[str, str]],
notEquals: NotRequired[dict[str, str]],
RequestMetadataBaseFiltersTypeDef#
# RequestMetadataBaseFiltersTypeDef definition
class RequestMetadataBaseFiltersTypeDef(TypedDict):
equals: NotRequired[Mapping[str, str]],
notEquals: NotRequired[Mapping[str, str]],
StopEvaluationJobRequestRequestTypeDef#
# StopEvaluationJobRequestRequestTypeDef definition
class StopEvaluationJobRequestRequestTypeDef(TypedDict):
jobIdentifier: str,
StopModelCustomizationJobRequestRequestTypeDef#
# StopModelCustomizationJobRequestRequestTypeDef definition
class StopModelCustomizationJobRequestRequestTypeDef(TypedDict):
jobIdentifier: str,
StopModelInvocationJobRequestRequestTypeDef#
# StopModelInvocationJobRequestRequestTypeDef definition
class StopModelInvocationJobRequestRequestTypeDef(TypedDict):
jobIdentifier: str,
TextInferenceConfigTypeDef#
# TextInferenceConfigTypeDef definition
class TextInferenceConfigTypeDef(TypedDict):
temperature: NotRequired[float],
topP: NotRequired[float],
maxTokens: NotRequired[int],
stopSequences: NotRequired[Sequence[str]],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
tagKeys: Sequence[str],
UpdateProvisionedModelThroughputRequestRequestTypeDef#
# UpdateProvisionedModelThroughputRequestRequestTypeDef definition
class UpdateProvisionedModelThroughputRequestRequestTypeDef(TypedDict):
provisionedModelId: str,
desiredProvisionedModelName: NotRequired[str],
desiredModelId: NotRequired[str],
ValidatorTypeDef#
# ValidatorTypeDef definition
class ValidatorTypeDef(TypedDict):
s3Uri: str,
BatchDeleteEvaluationJobResponseTypeDef#
# BatchDeleteEvaluationJobResponseTypeDef definition
class BatchDeleteEvaluationJobResponseTypeDef(TypedDict):
errors: list[BatchDeleteEvaluationJobErrorTypeDef], # (1)
evaluationJobs: list[BatchDeleteEvaluationJobItemTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See BatchDeleteEvaluationJobErrorTypeDef
- See BatchDeleteEvaluationJobItemTypeDef
- See ResponseMetadataTypeDef
CreateEvaluationJobResponseTypeDef#
# CreateEvaluationJobResponseTypeDef definition
class CreateEvaluationJobResponseTypeDef(TypedDict):
jobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateGuardrailResponseTypeDef#
# CreateGuardrailResponseTypeDef definition
class CreateGuardrailResponseTypeDef(TypedDict):
guardrailId: str,
guardrailArn: str,
version: str,
createdAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateGuardrailVersionResponseTypeDef#
# CreateGuardrailVersionResponseTypeDef definition
class CreateGuardrailVersionResponseTypeDef(TypedDict):
guardrailId: str,
version: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateInferenceProfileResponseTypeDef#
# CreateInferenceProfileResponseTypeDef definition
class CreateInferenceProfileResponseTypeDef(TypedDict):
inferenceProfileArn: str,
status: InferenceProfileStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateModelCopyJobResponseTypeDef#
# CreateModelCopyJobResponseTypeDef definition
class CreateModelCopyJobResponseTypeDef(TypedDict):
jobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateModelCustomizationJobResponseTypeDef#
# CreateModelCustomizationJobResponseTypeDef definition
class CreateModelCustomizationJobResponseTypeDef(TypedDict):
jobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateModelImportJobResponseTypeDef#
# CreateModelImportJobResponseTypeDef definition
class CreateModelImportJobResponseTypeDef(TypedDict):
jobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateModelInvocationJobResponseTypeDef#
# CreateModelInvocationJobResponseTypeDef definition
class CreateModelInvocationJobResponseTypeDef(TypedDict):
jobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProvisionedModelThroughputResponseTypeDef#
# CreateProvisionedModelThroughputResponseTypeDef definition
class CreateProvisionedModelThroughputResponseTypeDef(TypedDict):
provisionedModelArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetProvisionedModelThroughputResponseTypeDef#
# GetProvisionedModelThroughputResponseTypeDef definition
class GetProvisionedModelThroughputResponseTypeDef(TypedDict):
modelUnits: int,
desiredModelUnits: int,
provisionedModelName: str,
provisionedModelArn: str,
modelArn: str,
desiredModelArn: str,
foundationModelArn: str,
status: ProvisionedModelStatusType, # (1)
creationTime: datetime,
lastModifiedTime: datetime,
failureMessage: str,
commitmentDuration: CommitmentDurationType, # (2)
commitmentExpirationTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
UpdateGuardrailResponseTypeDef#
# UpdateGuardrailResponseTypeDef definition
class UpdateGuardrailResponseTypeDef(TypedDict):
guardrailId: str,
guardrailArn: str,
version: str,
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EvaluatorModelConfigOutputTypeDef#
# EvaluatorModelConfigOutputTypeDef definition
class EvaluatorModelConfigOutputTypeDef(TypedDict):
bedrockEvaluatorModels: NotRequired[list[BedrockEvaluatorModelTypeDef]], # (1)
EvaluatorModelConfigTypeDef#
# EvaluatorModelConfigTypeDef definition
class EvaluatorModelConfigTypeDef(TypedDict):
bedrockEvaluatorModels: NotRequired[Sequence[BedrockEvaluatorModelTypeDef]], # (1)
ByteContentDocTypeDef#
# ByteContentDocTypeDef definition
class ByteContentDocTypeDef(TypedDict):
identifier: str,
contentType: str,
data: BlobTypeDef,
CloudWatchConfigTypeDef#
# CloudWatchConfigTypeDef definition
class CloudWatchConfigTypeDef(TypedDict):
logGroupName: str,
roleArn: str,
largeDataDeliveryS3Config: NotRequired[S3ConfigTypeDef], # (1)
- See S3ConfigTypeDef
CreateModelCopyJobRequestRequestTypeDef#
# CreateModelCopyJobRequestRequestTypeDef definition
class CreateModelCopyJobRequestRequestTypeDef(TypedDict):
sourceModelArn: str,
targetModelName: str,
modelKmsKeyId: NotRequired[str],
targetModelTags: NotRequired[Sequence[TagTypeDef]], # (1)
clientRequestToken: NotRequired[str],
- See TagTypeDef
CreateProvisionedModelThroughputRequestRequestTypeDef#
# CreateProvisionedModelThroughputRequestRequestTypeDef definition
class CreateProvisionedModelThroughputRequestRequestTypeDef(TypedDict):
modelUnits: int,
provisionedModelName: str,
modelId: str,
clientRequestToken: NotRequired[str],
commitmentDuration: NotRequired[CommitmentDurationType], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See CommitmentDurationType
- See TagTypeDef
GetModelCopyJobResponseTypeDef#
# GetModelCopyJobResponseTypeDef definition
class GetModelCopyJobResponseTypeDef(TypedDict):
jobArn: str,
status: ModelCopyJobStatusType, # (1)
creationTime: datetime,
targetModelArn: str,
targetModelName: str,
sourceAccountId: str,
sourceModelArn: str,
targetModelKmsKeyArn: str,
targetModelTags: list[TagTypeDef], # (2)
failureMessage: str,
sourceModelName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See ModelCopyJobStatusType
- See TagTypeDef
- See ResponseMetadataTypeDef
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: list[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
ModelCopyJobSummaryTypeDef#
# ModelCopyJobSummaryTypeDef definition
class ModelCopyJobSummaryTypeDef(TypedDict):
jobArn: str,
status: ModelCopyJobStatusType, # (1)
creationTime: datetime,
targetModelArn: str,
sourceAccountId: str,
sourceModelArn: str,
targetModelName: NotRequired[str],
targetModelKmsKeyArn: NotRequired[str],
targetModelTags: NotRequired[list[TagTypeDef]], # (2)
failureMessage: NotRequired[str],
sourceModelName: NotRequired[str],
- See ModelCopyJobStatusType
- See TagTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateInferenceProfileRequestRequestTypeDef#
# CreateInferenceProfileRequestRequestTypeDef definition
class CreateInferenceProfileRequestRequestTypeDef(TypedDict):
inferenceProfileName: str,
modelSource: InferenceProfileModelSourceTypeDef, # (1)
description: NotRequired[str],
clientRequestToken: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)
ListCustomModelsResponseTypeDef#
# ListCustomModelsResponseTypeDef definition
class ListCustomModelsResponseTypeDef(TypedDict):
modelSummaries: list[CustomModelSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
DistillationConfigTypeDef#
# DistillationConfigTypeDef definition
class DistillationConfigTypeDef(TypedDict):
teacherModelConfig: TeacherModelConfigTypeDef, # (1)
EvaluationModelConfigTypeDef#
# EvaluationModelConfigTypeDef definition
class EvaluationModelConfigTypeDef(TypedDict):
bedrockModel: NotRequired[EvaluationBedrockModelTypeDef], # (1)
EvaluationDatasetTypeDef#
# EvaluationDatasetTypeDef definition
class EvaluationDatasetTypeDef(TypedDict):
name: str,
datasetLocation: NotRequired[EvaluationDatasetLocationTypeDef], # (1)
ListEvaluationJobsResponseTypeDef#
# ListEvaluationJobsResponseTypeDef definition
class ListEvaluationJobsResponseTypeDef(TypedDict):
jobSummaries: list[EvaluationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ExternalSourceOutputTypeDef#
# ExternalSourceOutputTypeDef definition
class ExternalSourceOutputTypeDef(TypedDict):
sourceType: ExternalSourceTypeType, # (1)
s3Location: NotRequired[S3ObjectDocTypeDef], # (2)
byteContent: NotRequired[ByteContentDocOutputTypeDef], # (3)
RetrievalFilterOutputTypeDef#
# RetrievalFilterOutputTypeDef definition
class RetrievalFilterOutputTypeDef(TypedDict):
equals: NotRequired[FilterAttributeOutputTypeDef], # (1)
notEquals: NotRequired[FilterAttributeOutputTypeDef], # (1)
greaterThan: NotRequired[FilterAttributeOutputTypeDef], # (1)
greaterThanOrEquals: NotRequired[FilterAttributeOutputTypeDef], # (1)
lessThan: NotRequired[FilterAttributeOutputTypeDef], # (1)
lessThanOrEquals: NotRequired[FilterAttributeOutputTypeDef], # (1)
in: NotRequired[FilterAttributeOutputTypeDef], # (1)
notIn: NotRequired[FilterAttributeOutputTypeDef], # (1)
startsWith: NotRequired[FilterAttributeOutputTypeDef], # (1)
listContains: NotRequired[FilterAttributeOutputTypeDef], # (1)
stringContains: NotRequired[FilterAttributeOutputTypeDef], # (1)
andAll: NotRequired[list[dict[str, Any]]],
orAll: NotRequired[list[dict[str, Any]]],
- See FilterAttributeOutputTypeDef
- See FilterAttributeOutputTypeDef
- See FilterAttributeOutputTypeDef
- See FilterAttributeOutputTypeDef
- See FilterAttributeOutputTypeDef
- See FilterAttributeOutputTypeDef
- See FilterAttributeOutputTypeDef
- See FilterAttributeOutputTypeDef
- See FilterAttributeOutputTypeDef
- See FilterAttributeOutputTypeDef
- See FilterAttributeOutputTypeDef
FoundationModelDetailsTypeDef#
# FoundationModelDetailsTypeDef definition
class FoundationModelDetailsTypeDef(TypedDict):
modelArn: str,
modelId: str,
modelName: NotRequired[str],
providerName: NotRequired[str],
inputModalities: NotRequired[list[ModelModalityType]], # (1)
outputModalities: NotRequired[list[ModelModalityType]], # (1)
responseStreamingSupported: NotRequired[bool],
customizationsSupported: NotRequired[list[ModelCustomizationType]], # (3)
inferenceTypesSupported: NotRequired[list[InferenceTypeType]], # (4)
modelLifecycle: NotRequired[FoundationModelLifecycleTypeDef], # (5)
- See ModelModalityType
- See ModelModalityType
- See ModelCustomizationType
- See InferenceTypeType
- See FoundationModelLifecycleTypeDef
FoundationModelSummaryTypeDef#
# FoundationModelSummaryTypeDef definition
class FoundationModelSummaryTypeDef(TypedDict):
modelArn: str,
modelId: str,
modelName: NotRequired[str],
providerName: NotRequired[str],
inputModalities: NotRequired[list[ModelModalityType]], # (1)
outputModalities: NotRequired[list[ModelModalityType]], # (1)
responseStreamingSupported: NotRequired[bool],
customizationsSupported: NotRequired[list[ModelCustomizationType]], # (3)
inferenceTypesSupported: NotRequired[list[InferenceTypeType]], # (4)
modelLifecycle: NotRequired[FoundationModelLifecycleTypeDef], # (5)
- See ModelModalityType
- See ModelModalityType
- See ModelCustomizationType
- See InferenceTypeType
- See FoundationModelLifecycleTypeDef
GetInferenceProfileResponseTypeDef#
# GetInferenceProfileResponseTypeDef definition
class GetInferenceProfileResponseTypeDef(TypedDict):
inferenceProfileName: str,
description: str,
createdAt: datetime,
updatedAt: datetime,
inferenceProfileArn: str,
models: list[InferenceProfileModelTypeDef], # (1)
inferenceProfileId: str,
status: InferenceProfileStatusType, # (2)
type: InferenceProfileTypeType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See InferenceProfileModelTypeDef
- See InferenceProfileStatusType
- See InferenceProfileTypeType
- See ResponseMetadataTypeDef
InferenceProfileSummaryTypeDef#
# InferenceProfileSummaryTypeDef definition
class InferenceProfileSummaryTypeDef(TypedDict):
inferenceProfileName: str,
inferenceProfileArn: str,
models: list[InferenceProfileModelTypeDef], # (1)
inferenceProfileId: str,
status: InferenceProfileStatusType, # (2)
type: InferenceProfileTypeType, # (3)
description: NotRequired[str],
createdAt: NotRequired[datetime],
updatedAt: NotRequired[datetime],
SageMakerEndpointOutputTypeDef#
# SageMakerEndpointOutputTypeDef definition
class SageMakerEndpointOutputTypeDef(TypedDict):
initialInstanceCount: int,
instanceType: str,
executionRole: str,
kmsEncryptionKey: NotRequired[str],
vpc: NotRequired[VpcConfigOutputTypeDef], # (1)
GetPromptRouterResponseTypeDef#
# GetPromptRouterResponseTypeDef definition
class GetPromptRouterResponseTypeDef(TypedDict):
promptRouterName: str,
routingCriteria: RoutingCriteriaTypeDef, # (1)
description: str,
createdAt: datetime,
updatedAt: datetime,
promptRouterArn: str,
models: list[PromptRouterTargetModelTypeDef], # (2)
fallbackModel: PromptRouterTargetModelTypeDef, # (3)
status: PromptRouterStatusType, # (4)
type: PromptRouterTypeType, # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See RoutingCriteriaTypeDef
- See PromptRouterTargetModelTypeDef
- See PromptRouterTargetModelTypeDef
- See PromptRouterStatusType
- See PromptRouterTypeType
- See ResponseMetadataTypeDef
PromptRouterSummaryTypeDef#
# PromptRouterSummaryTypeDef definition
class PromptRouterSummaryTypeDef(TypedDict):
promptRouterName: str,
routingCriteria: RoutingCriteriaTypeDef, # (1)
promptRouterArn: str,
models: list[PromptRouterTargetModelTypeDef], # (2)
fallbackModel: PromptRouterTargetModelTypeDef, # (3)
status: PromptRouterStatusType, # (4)
type: PromptRouterTypeType, # (5)
description: NotRequired[str],
createdAt: NotRequired[datetime],
updatedAt: NotRequired[datetime],
- See RoutingCriteriaTypeDef
- See PromptRouterTargetModelTypeDef
- See PromptRouterTargetModelTypeDef
- See PromptRouterStatusType
- See PromptRouterTypeType
GuardrailContentPolicyConfigTypeDef#
# GuardrailContentPolicyConfigTypeDef definition
class GuardrailContentPolicyConfigTypeDef(TypedDict):
filtersConfig: Sequence[GuardrailContentFilterConfigTypeDef], # (1)
GuardrailContentPolicyTypeDef#
# GuardrailContentPolicyTypeDef definition
class GuardrailContentPolicyTypeDef(TypedDict):
filters: NotRequired[list[GuardrailContentFilterTypeDef]], # (1)
GuardrailContextualGroundingPolicyConfigTypeDef#
# GuardrailContextualGroundingPolicyConfigTypeDef definition
class GuardrailContextualGroundingPolicyConfigTypeDef(TypedDict):
filtersConfig: Sequence[GuardrailContextualGroundingFilterConfigTypeDef], # (1)
GuardrailContextualGroundingPolicyTypeDef#
# GuardrailContextualGroundingPolicyTypeDef definition
class GuardrailContextualGroundingPolicyTypeDef(TypedDict):
filters: list[GuardrailContextualGroundingFilterTypeDef], # (1)
GuardrailSensitiveInformationPolicyConfigTypeDef#
# GuardrailSensitiveInformationPolicyConfigTypeDef definition
class GuardrailSensitiveInformationPolicyConfigTypeDef(TypedDict):
piiEntitiesConfig: NotRequired[Sequence[GuardrailPiiEntityConfigTypeDef]], # (1)
regexesConfig: NotRequired[Sequence[GuardrailRegexConfigTypeDef]], # (2)
GuardrailSensitiveInformationPolicyTypeDef#
# GuardrailSensitiveInformationPolicyTypeDef definition
class GuardrailSensitiveInformationPolicyTypeDef(TypedDict):
piiEntities: NotRequired[list[GuardrailPiiEntityTypeDef]], # (1)
regexes: NotRequired[list[GuardrailRegexTypeDef]], # (2)
ListGuardrailsResponseTypeDef#
# ListGuardrailsResponseTypeDef definition
class ListGuardrailsResponseTypeDef(TypedDict):
guardrails: list[GuardrailSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
GuardrailTopicPolicyConfigTypeDef#
# GuardrailTopicPolicyConfigTypeDef definition
class GuardrailTopicPolicyConfigTypeDef(TypedDict):
topicsConfig: Sequence[GuardrailTopicConfigTypeDef], # (1)
GuardrailTopicPolicyTypeDef#
# GuardrailTopicPolicyTypeDef definition
class GuardrailTopicPolicyTypeDef(TypedDict):
topics: list[GuardrailTopicTypeDef], # (1)
GuardrailWordPolicyConfigTypeDef#
# GuardrailWordPolicyConfigTypeDef definition
class GuardrailWordPolicyConfigTypeDef(TypedDict):
wordsConfig: NotRequired[Sequence[GuardrailWordConfigTypeDef]], # (1)
managedWordListsConfig: NotRequired[Sequence[GuardrailManagedWordsConfigTypeDef]], # (2)
GuardrailWordPolicyTypeDef#
# GuardrailWordPolicyTypeDef definition
class GuardrailWordPolicyTypeDef(TypedDict):
words: NotRequired[list[GuardrailWordTypeDef]], # (1)
managedWordLists: NotRequired[list[GuardrailManagedWordsTypeDef]], # (2)
ListImportedModelsResponseTypeDef#
# ListImportedModelsResponseTypeDef definition
class ListImportedModelsResponseTypeDef(TypedDict):
modelSummaries: list[ImportedModelSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
KbInferenceConfigOutputTypeDef#
# KbInferenceConfigOutputTypeDef definition
class KbInferenceConfigOutputTypeDef(TypedDict):
textInferenceConfig: NotRequired[TextInferenceConfigOutputTypeDef], # (1)
ListGuardrailsRequestPaginateTypeDef#
# ListGuardrailsRequestPaginateTypeDef definition
class ListGuardrailsRequestPaginateTypeDef(TypedDict):
guardrailIdentifier: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListInferenceProfilesRequestPaginateTypeDef#
# ListInferenceProfilesRequestPaginateTypeDef definition
class ListInferenceProfilesRequestPaginateTypeDef(TypedDict):
typeEquals: NotRequired[InferenceProfileTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListMarketplaceModelEndpointsRequestPaginateTypeDef#
# ListMarketplaceModelEndpointsRequestPaginateTypeDef definition
class ListMarketplaceModelEndpointsRequestPaginateTypeDef(TypedDict):
modelSourceEquals: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPromptRoutersRequestPaginateTypeDef#
# ListPromptRoutersRequestPaginateTypeDef definition
class ListPromptRoutersRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListCustomModelsRequestPaginateTypeDef#
# ListCustomModelsRequestPaginateTypeDef definition
class ListCustomModelsRequestPaginateTypeDef(TypedDict):
creationTimeBefore: NotRequired[TimestampTypeDef],
creationTimeAfter: NotRequired[TimestampTypeDef],
nameContains: NotRequired[str],
baseModelArnEquals: NotRequired[str],
foundationModelArnEquals: NotRequired[str],
sortBy: NotRequired[SortModelsByType], # (1)
sortOrder: NotRequired[SortOrderType], # (2)
isOwned: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
- See SortModelsByType
- See SortOrderType
- See PaginatorConfigTypeDef
ListCustomModelsRequestRequestTypeDef#
# ListCustomModelsRequestRequestTypeDef definition
class ListCustomModelsRequestRequestTypeDef(TypedDict):
creationTimeBefore: NotRequired[TimestampTypeDef],
creationTimeAfter: NotRequired[TimestampTypeDef],
nameContains: NotRequired[str],
baseModelArnEquals: NotRequired[str],
foundationModelArnEquals: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortBy: NotRequired[SortModelsByType], # (1)
sortOrder: NotRequired[SortOrderType], # (2)
isOwned: NotRequired[bool],
- See SortModelsByType
- See SortOrderType
ListEvaluationJobsRequestPaginateTypeDef#
# ListEvaluationJobsRequestPaginateTypeDef definition
class ListEvaluationJobsRequestPaginateTypeDef(TypedDict):
creationTimeAfter: NotRequired[TimestampTypeDef],
creationTimeBefore: NotRequired[TimestampTypeDef],
statusEquals: NotRequired[EvaluationJobStatusType], # (1)
applicationTypeEquals: NotRequired[ApplicationTypeType], # (2)
nameContains: NotRequired[str],
sortBy: NotRequired[SortJobsByType], # (3)
sortOrder: NotRequired[SortOrderType], # (4)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (5)
- See EvaluationJobStatusType
- See ApplicationTypeType
- See SortJobsByType
- See SortOrderType
- See PaginatorConfigTypeDef
ListEvaluationJobsRequestRequestTypeDef#
# ListEvaluationJobsRequestRequestTypeDef definition
class ListEvaluationJobsRequestRequestTypeDef(TypedDict):
creationTimeAfter: NotRequired[TimestampTypeDef],
creationTimeBefore: NotRequired[TimestampTypeDef],
statusEquals: NotRequired[EvaluationJobStatusType], # (1)
applicationTypeEquals: NotRequired[ApplicationTypeType], # (2)
nameContains: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortBy: NotRequired[SortJobsByType], # (3)
sortOrder: NotRequired[SortOrderType], # (4)
- See EvaluationJobStatusType
- See ApplicationTypeType
- See SortJobsByType
- See SortOrderType
ListImportedModelsRequestPaginateTypeDef#
# ListImportedModelsRequestPaginateTypeDef definition
class ListImportedModelsRequestPaginateTypeDef(TypedDict):
creationTimeBefore: NotRequired[TimestampTypeDef],
creationTimeAfter: NotRequired[TimestampTypeDef],
nameContains: NotRequired[str],
sortBy: NotRequired[SortModelsByType], # (1)
sortOrder: NotRequired[SortOrderType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
- See SortModelsByType
- See SortOrderType
- See PaginatorConfigTypeDef
ListImportedModelsRequestRequestTypeDef#
# ListImportedModelsRequestRequestTypeDef definition
class ListImportedModelsRequestRequestTypeDef(TypedDict):
creationTimeBefore: NotRequired[TimestampTypeDef],
creationTimeAfter: NotRequired[TimestampTypeDef],
nameContains: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortBy: NotRequired[SortModelsByType], # (1)
sortOrder: NotRequired[SortOrderType], # (2)
- See SortModelsByType
- See SortOrderType
ListModelCopyJobsRequestPaginateTypeDef#
# ListModelCopyJobsRequestPaginateTypeDef definition
class ListModelCopyJobsRequestPaginateTypeDef(TypedDict):
creationTimeAfter: NotRequired[TimestampTypeDef],
creationTimeBefore: NotRequired[TimestampTypeDef],
statusEquals: NotRequired[ModelCopyJobStatusType], # (1)
sourceAccountEquals: NotRequired[str],
sourceModelArnEquals: NotRequired[str],
targetModelNameContains: NotRequired[str],
sortBy: NotRequired[SortJobsByType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See ModelCopyJobStatusType
- See SortJobsByType
- See SortOrderType
- See PaginatorConfigTypeDef
ListModelCopyJobsRequestRequestTypeDef#
# ListModelCopyJobsRequestRequestTypeDef definition
class ListModelCopyJobsRequestRequestTypeDef(TypedDict):
creationTimeAfter: NotRequired[TimestampTypeDef],
creationTimeBefore: NotRequired[TimestampTypeDef],
statusEquals: NotRequired[ModelCopyJobStatusType], # (1)
sourceAccountEquals: NotRequired[str],
sourceModelArnEquals: NotRequired[str],
targetModelNameContains: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortBy: NotRequired[SortJobsByType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
- See ModelCopyJobStatusType
- See SortJobsByType
- See SortOrderType
ListModelCustomizationJobsRequestPaginateTypeDef#
# ListModelCustomizationJobsRequestPaginateTypeDef definition
class ListModelCustomizationJobsRequestPaginateTypeDef(TypedDict):
creationTimeAfter: NotRequired[TimestampTypeDef],
creationTimeBefore: NotRequired[TimestampTypeDef],
statusEquals: NotRequired[FineTuningJobStatusType], # (1)
nameContains: NotRequired[str],
sortBy: NotRequired[SortJobsByType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See FineTuningJobStatusType
- See SortJobsByType
- See SortOrderType
- See PaginatorConfigTypeDef
ListModelCustomizationJobsRequestRequestTypeDef#
# ListModelCustomizationJobsRequestRequestTypeDef definition
class ListModelCustomizationJobsRequestRequestTypeDef(TypedDict):
creationTimeAfter: NotRequired[TimestampTypeDef],
creationTimeBefore: NotRequired[TimestampTypeDef],
statusEquals: NotRequired[FineTuningJobStatusType], # (1)
nameContains: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortBy: NotRequired[SortJobsByType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
- See FineTuningJobStatusType
- See SortJobsByType
- See SortOrderType
ListModelImportJobsRequestPaginateTypeDef#
# ListModelImportJobsRequestPaginateTypeDef definition
class ListModelImportJobsRequestPaginateTypeDef(TypedDict):
creationTimeAfter: NotRequired[TimestampTypeDef],
creationTimeBefore: NotRequired[TimestampTypeDef],
statusEquals: NotRequired[ModelImportJobStatusType], # (1)
nameContains: NotRequired[str],
sortBy: NotRequired[SortJobsByType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See ModelImportJobStatusType
- See SortJobsByType
- See SortOrderType
- See PaginatorConfigTypeDef
ListModelImportJobsRequestRequestTypeDef#
# ListModelImportJobsRequestRequestTypeDef definition
class ListModelImportJobsRequestRequestTypeDef(TypedDict):
creationTimeAfter: NotRequired[TimestampTypeDef],
creationTimeBefore: NotRequired[TimestampTypeDef],
statusEquals: NotRequired[ModelImportJobStatusType], # (1)
nameContains: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortBy: NotRequired[SortJobsByType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
- See ModelImportJobStatusType
- See SortJobsByType
- See SortOrderType
ListModelInvocationJobsRequestPaginateTypeDef#
# ListModelInvocationJobsRequestPaginateTypeDef definition
class ListModelInvocationJobsRequestPaginateTypeDef(TypedDict):
submitTimeAfter: NotRequired[TimestampTypeDef],
submitTimeBefore: NotRequired[TimestampTypeDef],
statusEquals: NotRequired[ModelInvocationJobStatusType], # (1)
nameContains: NotRequired[str],
sortBy: NotRequired[SortJobsByType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
ListModelInvocationJobsRequestRequestTypeDef#
# ListModelInvocationJobsRequestRequestTypeDef definition
class ListModelInvocationJobsRequestRequestTypeDef(TypedDict):
submitTimeAfter: NotRequired[TimestampTypeDef],
submitTimeBefore: NotRequired[TimestampTypeDef],
statusEquals: NotRequired[ModelInvocationJobStatusType], # (1)
nameContains: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortBy: NotRequired[SortJobsByType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
- See ModelInvocationJobStatusType
- See SortJobsByType
- See SortOrderType
ListProvisionedModelThroughputsRequestPaginateTypeDef#
# ListProvisionedModelThroughputsRequestPaginateTypeDef definition
class ListProvisionedModelThroughputsRequestPaginateTypeDef(TypedDict):
creationTimeAfter: NotRequired[TimestampTypeDef],
creationTimeBefore: NotRequired[TimestampTypeDef],
statusEquals: NotRequired[ProvisionedModelStatusType], # (1)
modelArnEquals: NotRequired[str],
nameContains: NotRequired[str],
sortBy: NotRequired[SortByProvisionedModelsType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See ProvisionedModelStatusType
- See SortByProvisionedModelsType
- See SortOrderType
- See PaginatorConfigTypeDef
ListProvisionedModelThroughputsRequestRequestTypeDef#
# ListProvisionedModelThroughputsRequestRequestTypeDef definition
class ListProvisionedModelThroughputsRequestRequestTypeDef(TypedDict):
creationTimeAfter: NotRequired[TimestampTypeDef],
creationTimeBefore: NotRequired[TimestampTypeDef],
statusEquals: NotRequired[ProvisionedModelStatusType], # (1)
modelArnEquals: NotRequired[str],
nameContains: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortBy: NotRequired[SortByProvisionedModelsType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
ListMarketplaceModelEndpointsResponseTypeDef#
# ListMarketplaceModelEndpointsResponseTypeDef definition
class ListMarketplaceModelEndpointsResponseTypeDef(TypedDict):
marketplaceModelEndpoints: list[MarketplaceModelEndpointSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListModelCustomizationJobsResponseTypeDef#
# ListModelCustomizationJobsResponseTypeDef definition
class ListModelCustomizationJobsResponseTypeDef(TypedDict):
modelCustomizationJobSummaries: list[ModelCustomizationJobSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListModelImportJobsResponseTypeDef#
# ListModelImportJobsResponseTypeDef definition
class ListModelImportJobsResponseTypeDef(TypedDict):
modelImportJobSummaries: list[ModelImportJobSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListProvisionedModelThroughputsResponseTypeDef#
# ListProvisionedModelThroughputsResponseTypeDef definition
class ListProvisionedModelThroughputsResponseTypeDef(TypedDict):
provisionedModelSummaries: list[ProvisionedModelSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ModelDataSourceTypeDef#
# ModelDataSourceTypeDef definition
class ModelDataSourceTypeDef(TypedDict):
s3DataSource: NotRequired[S3DataSourceTypeDef], # (1)
ModelInvocationJobInputDataConfigTypeDef#
# ModelInvocationJobInputDataConfigTypeDef definition
class ModelInvocationJobInputDataConfigTypeDef(TypedDict):
s3InputDataConfig: NotRequired[ModelInvocationJobS3InputDataConfigTypeDef], # (1)
ModelInvocationJobOutputDataConfigTypeDef#
# ModelInvocationJobOutputDataConfigTypeDef definition
class ModelInvocationJobOutputDataConfigTypeDef(TypedDict):
s3OutputDataConfig: NotRequired[ModelInvocationJobS3OutputDataConfigTypeDef], # (1)
OrchestrationConfigurationTypeDef#
# OrchestrationConfigurationTypeDef definition
class OrchestrationConfigurationTypeDef(TypedDict):
queryTransformationConfiguration: QueryTransformationConfigurationTypeDef, # (1)
RequestMetadataFiltersOutputTypeDef#
# RequestMetadataFiltersOutputTypeDef definition
class RequestMetadataFiltersOutputTypeDef(TypedDict):
equals: NotRequired[dict[str, str]],
notEquals: NotRequired[dict[str, str]],
andAll: NotRequired[list[RequestMetadataBaseFiltersOutputTypeDef]], # (1)
orAll: NotRequired[list[RequestMetadataBaseFiltersOutputTypeDef]], # (1)
ValidationDataConfigOutputTypeDef#
# ValidationDataConfigOutputTypeDef definition
class ValidationDataConfigOutputTypeDef(TypedDict):
validators: list[ValidatorTypeDef], # (1)
- See ValidatorTypeDef
ValidationDataConfigTypeDef#
# ValidationDataConfigTypeDef definition
class ValidationDataConfigTypeDef(TypedDict):
validators: Sequence[ValidatorTypeDef], # (1)
- See ValidatorTypeDef
LoggingConfigTypeDef#
# LoggingConfigTypeDef definition
class LoggingConfigTypeDef(TypedDict):
cloudWatchConfig: NotRequired[CloudWatchConfigTypeDef], # (1)
s3Config: NotRequired[S3ConfigTypeDef], # (2)
textDataDeliveryEnabled: NotRequired[bool],
imageDataDeliveryEnabled: NotRequired[bool],
embeddingDataDeliveryEnabled: NotRequired[bool],
videoDataDeliveryEnabled: NotRequired[bool],
ListModelCopyJobsResponseTypeDef#
# ListModelCopyJobsResponseTypeDef definition
class ListModelCopyJobsResponseTypeDef(TypedDict):
modelCopyJobSummaries: list[ModelCopyJobSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
CustomizationConfigTypeDef#
# CustomizationConfigTypeDef definition
class CustomizationConfigTypeDef(TypedDict):
distillationConfig: NotRequired[DistillationConfigTypeDef], # (1)
EvaluationDatasetMetricConfigOutputTypeDef#
# EvaluationDatasetMetricConfigOutputTypeDef definition
class EvaluationDatasetMetricConfigOutputTypeDef(TypedDict):
taskType: EvaluationTaskTypeType, # (1)
dataset: EvaluationDatasetTypeDef, # (2)
metricNames: list[str],
EvaluationDatasetMetricConfigTypeDef#
# EvaluationDatasetMetricConfigTypeDef definition
class EvaluationDatasetMetricConfigTypeDef(TypedDict):
taskType: EvaluationTaskTypeType, # (1)
dataset: EvaluationDatasetTypeDef, # (2)
metricNames: Sequence[str],
KnowledgeBaseVectorSearchConfigurationOutputTypeDef#
# KnowledgeBaseVectorSearchConfigurationOutputTypeDef definition
class KnowledgeBaseVectorSearchConfigurationOutputTypeDef(TypedDict):
numberOfResults: NotRequired[int],
overrideSearchType: NotRequired[SearchTypeType], # (1)
filter: NotRequired[RetrievalFilterOutputTypeDef], # (2)
RetrievalFilterTypeDef#
# RetrievalFilterTypeDef definition
class RetrievalFilterTypeDef(TypedDict):
equals: NotRequired[FilterAttributeUnionTypeDef], # (1)
notEquals: NotRequired[FilterAttributeUnionTypeDef], # (1)
greaterThan: NotRequired[FilterAttributeUnionTypeDef], # (1)
greaterThanOrEquals: NotRequired[FilterAttributeUnionTypeDef], # (1)
lessThan: NotRequired[FilterAttributeUnionTypeDef], # (1)
lessThanOrEquals: NotRequired[FilterAttributeUnionTypeDef], # (1)
in: NotRequired[FilterAttributeUnionTypeDef], # (1)
notIn: NotRequired[FilterAttributeUnionTypeDef], # (1)
startsWith: NotRequired[FilterAttributeUnionTypeDef], # (1)
listContains: NotRequired[FilterAttributeUnionTypeDef], # (1)
stringContains: NotRequired[FilterAttributeUnionTypeDef], # (1)
andAll: NotRequired[Sequence[Mapping[str, Any]]],
orAll: NotRequired[Sequence[Mapping[str, Any]]],
- See FilterAttributeTypeDef FilterAttributeOutputTypeDef
- See FilterAttributeTypeDef FilterAttributeOutputTypeDef
- See FilterAttributeTypeDef FilterAttributeOutputTypeDef
- See FilterAttributeTypeDef FilterAttributeOutputTypeDef
- See FilterAttributeTypeDef FilterAttributeOutputTypeDef
- See FilterAttributeTypeDef FilterAttributeOutputTypeDef
- See FilterAttributeTypeDef FilterAttributeOutputTypeDef
- See FilterAttributeTypeDef FilterAttributeOutputTypeDef
- See FilterAttributeTypeDef FilterAttributeOutputTypeDef
- See FilterAttributeTypeDef FilterAttributeOutputTypeDef
- See FilterAttributeTypeDef FilterAttributeOutputTypeDef
GetFoundationModelResponseTypeDef#
# GetFoundationModelResponseTypeDef definition
class GetFoundationModelResponseTypeDef(TypedDict):
modelDetails: FoundationModelDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListFoundationModelsResponseTypeDef#
# ListFoundationModelsResponseTypeDef definition
class ListFoundationModelsResponseTypeDef(TypedDict):
modelSummaries: list[FoundationModelSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListInferenceProfilesResponseTypeDef#
# ListInferenceProfilesResponseTypeDef definition
class ListInferenceProfilesResponseTypeDef(TypedDict):
inferenceProfileSummaries: list[InferenceProfileSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
EndpointConfigOutputTypeDef#
# EndpointConfigOutputTypeDef definition
class EndpointConfigOutputTypeDef(TypedDict):
sageMaker: NotRequired[SageMakerEndpointOutputTypeDef], # (1)
SageMakerEndpointTypeDef#
# SageMakerEndpointTypeDef definition
class SageMakerEndpointTypeDef(TypedDict):
initialInstanceCount: int,
instanceType: str,
executionRole: str,
kmsEncryptionKey: NotRequired[str],
vpc: NotRequired[VpcConfigUnionTypeDef], # (1)
ListPromptRoutersResponseTypeDef#
# ListPromptRoutersResponseTypeDef definition
class ListPromptRoutersResponseTypeDef(TypedDict):
promptRouterSummaries: list[PromptRouterSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
CreateGuardrailRequestRequestTypeDef#
# CreateGuardrailRequestRequestTypeDef definition
class CreateGuardrailRequestRequestTypeDef(TypedDict):
name: str,
blockedInputMessaging: str,
blockedOutputsMessaging: str,
description: NotRequired[str],
topicPolicyConfig: NotRequired[GuardrailTopicPolicyConfigTypeDef], # (1)
contentPolicyConfig: NotRequired[GuardrailContentPolicyConfigTypeDef], # (2)
wordPolicyConfig: NotRequired[GuardrailWordPolicyConfigTypeDef], # (3)
sensitiveInformationPolicyConfig: NotRequired[GuardrailSensitiveInformationPolicyConfigTypeDef], # (4)
contextualGroundingPolicyConfig: NotRequired[GuardrailContextualGroundingPolicyConfigTypeDef], # (5)
kmsKeyId: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (6)
clientRequestToken: NotRequired[str],
- See GuardrailTopicPolicyConfigTypeDef
- See GuardrailContentPolicyConfigTypeDef
- See GuardrailWordPolicyConfigTypeDef
- See GuardrailSensitiveInformationPolicyConfigTypeDef
- See GuardrailContextualGroundingPolicyConfigTypeDef
- See TagTypeDef
UpdateGuardrailRequestRequestTypeDef#
# UpdateGuardrailRequestRequestTypeDef definition
class UpdateGuardrailRequestRequestTypeDef(TypedDict):
guardrailIdentifier: str,
name: str,
blockedInputMessaging: str,
blockedOutputsMessaging: str,
description: NotRequired[str],
topicPolicyConfig: NotRequired[GuardrailTopicPolicyConfigTypeDef], # (1)
contentPolicyConfig: NotRequired[GuardrailContentPolicyConfigTypeDef], # (2)
wordPolicyConfig: NotRequired[GuardrailWordPolicyConfigTypeDef], # (3)
sensitiveInformationPolicyConfig: NotRequired[GuardrailSensitiveInformationPolicyConfigTypeDef], # (4)
contextualGroundingPolicyConfig: NotRequired[GuardrailContextualGroundingPolicyConfigTypeDef], # (5)
kmsKeyId: NotRequired[str],
- See GuardrailTopicPolicyConfigTypeDef
- See GuardrailContentPolicyConfigTypeDef
- See GuardrailWordPolicyConfigTypeDef
- See GuardrailSensitiveInformationPolicyConfigTypeDef
- See GuardrailContextualGroundingPolicyConfigTypeDef
GetGuardrailResponseTypeDef#
# GetGuardrailResponseTypeDef definition
class GetGuardrailResponseTypeDef(TypedDict):
name: str,
description: str,
guardrailId: str,
guardrailArn: str,
version: str,
status: GuardrailStatusType, # (1)
topicPolicy: GuardrailTopicPolicyTypeDef, # (2)
contentPolicy: GuardrailContentPolicyTypeDef, # (3)
wordPolicy: GuardrailWordPolicyTypeDef, # (4)
sensitiveInformationPolicy: GuardrailSensitiveInformationPolicyTypeDef, # (5)
contextualGroundingPolicy: GuardrailContextualGroundingPolicyTypeDef, # (6)
createdAt: datetime,
updatedAt: datetime,
statusReasons: list[str],
failureRecommendations: list[str],
blockedInputMessaging: str,
blockedOutputsMessaging: str,
kmsKeyArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (7)
- See GuardrailStatusType
- See GuardrailTopicPolicyTypeDef
- See GuardrailContentPolicyTypeDef
- See GuardrailWordPolicyTypeDef
- See GuardrailSensitiveInformationPolicyTypeDef
- See GuardrailContextualGroundingPolicyTypeDef
- See ResponseMetadataTypeDef
ExternalSourcesGenerationConfigurationOutputTypeDef#
# ExternalSourcesGenerationConfigurationOutputTypeDef definition
class ExternalSourcesGenerationConfigurationOutputTypeDef(TypedDict):
promptTemplate: NotRequired[PromptTemplateTypeDef], # (1)
guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef], # (2)
kbInferenceConfig: NotRequired[KbInferenceConfigOutputTypeDef], # (3)
additionalModelRequestFields: NotRequired[dict[str, dict[str, Any]]],
GenerationConfigurationOutputTypeDef#
# GenerationConfigurationOutputTypeDef definition
class GenerationConfigurationOutputTypeDef(TypedDict):
promptTemplate: NotRequired[PromptTemplateTypeDef], # (1)
guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef], # (2)
kbInferenceConfig: NotRequired[KbInferenceConfigOutputTypeDef], # (3)
additionalModelRequestFields: NotRequired[dict[str, dict[str, Any]]],
CreateModelImportJobRequestRequestTypeDef#
# CreateModelImportJobRequestRequestTypeDef definition
class CreateModelImportJobRequestRequestTypeDef(TypedDict):
jobName: str,
importedModelName: str,
roleArn: str,
modelDataSource: ModelDataSourceTypeDef, # (1)
jobTags: NotRequired[Sequence[TagTypeDef]], # (2)
importedModelTags: NotRequired[Sequence[TagTypeDef]], # (2)
clientRequestToken: NotRequired[str],
vpcConfig: NotRequired[VpcConfigTypeDef], # (4)
importedModelKmsKeyId: NotRequired[str],
- See ModelDataSourceTypeDef
- See TagTypeDef
- See TagTypeDef
- See VpcConfigTypeDef
GetImportedModelResponseTypeDef#
# GetImportedModelResponseTypeDef definition
class GetImportedModelResponseTypeDef(TypedDict):
modelArn: str,
modelName: str,
jobName: str,
jobArn: str,
modelDataSource: ModelDataSourceTypeDef, # (1)
creationTime: datetime,
modelArchitecture: str,
modelKmsKeyArn: str,
instructSupported: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetModelImportJobResponseTypeDef#
# GetModelImportJobResponseTypeDef definition
class GetModelImportJobResponseTypeDef(TypedDict):
jobArn: str,
jobName: str,
importedModelName: str,
importedModelArn: str,
roleArn: str,
modelDataSource: ModelDataSourceTypeDef, # (1)
status: ModelImportJobStatusType, # (2)
failureMessage: str,
creationTime: datetime,
lastModifiedTime: datetime,
endTime: datetime,
vpcConfig: VpcConfigOutputTypeDef, # (3)
importedModelKmsKeyArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ModelDataSourceTypeDef
- See ModelImportJobStatusType
- See VpcConfigOutputTypeDef
- See ResponseMetadataTypeDef
CreateModelInvocationJobRequestRequestTypeDef#
# CreateModelInvocationJobRequestRequestTypeDef definition
class CreateModelInvocationJobRequestRequestTypeDef(TypedDict):
jobName: str,
roleArn: str,
modelId: str,
inputDataConfig: ModelInvocationJobInputDataConfigTypeDef, # (1)
outputDataConfig: ModelInvocationJobOutputDataConfigTypeDef, # (2)
clientRequestToken: NotRequired[str],
vpcConfig: NotRequired[VpcConfigTypeDef], # (3)
timeoutDurationInHours: NotRequired[int],
tags: NotRequired[Sequence[TagTypeDef]], # (4)
- See ModelInvocationJobInputDataConfigTypeDef
- See ModelInvocationJobOutputDataConfigTypeDef
- See VpcConfigTypeDef
- See TagTypeDef
GetModelInvocationJobResponseTypeDef#
# GetModelInvocationJobResponseTypeDef definition
class GetModelInvocationJobResponseTypeDef(TypedDict):
jobArn: str,
jobName: str,
modelId: str,
clientRequestToken: str,
roleArn: str,
status: ModelInvocationJobStatusType, # (1)
message: str,
submitTime: datetime,
lastModifiedTime: datetime,
endTime: datetime,
inputDataConfig: ModelInvocationJobInputDataConfigTypeDef, # (2)
outputDataConfig: ModelInvocationJobOutputDataConfigTypeDef, # (3)
vpcConfig: VpcConfigOutputTypeDef, # (4)
timeoutDurationInHours: int,
jobExpirationTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See ModelInvocationJobStatusType
- See ModelInvocationJobInputDataConfigTypeDef
- See ModelInvocationJobOutputDataConfigTypeDef
- See VpcConfigOutputTypeDef
- See ResponseMetadataTypeDef
ModelInvocationJobSummaryTypeDef#
# ModelInvocationJobSummaryTypeDef definition
class ModelInvocationJobSummaryTypeDef(TypedDict):
jobArn: str,
jobName: str,
modelId: str,
roleArn: str,
submitTime: datetime,
inputDataConfig: ModelInvocationJobInputDataConfigTypeDef, # (2)
outputDataConfig: ModelInvocationJobOutputDataConfigTypeDef, # (3)
clientRequestToken: NotRequired[str],
status: NotRequired[ModelInvocationJobStatusType], # (1)
message: NotRequired[str],
lastModifiedTime: NotRequired[datetime],
endTime: NotRequired[datetime],
vpcConfig: NotRequired[VpcConfigOutputTypeDef], # (4)
timeoutDurationInHours: NotRequired[int],
jobExpirationTime: NotRequired[datetime],
- See ModelInvocationJobStatusType
- See ModelInvocationJobInputDataConfigTypeDef
- See ModelInvocationJobOutputDataConfigTypeDef
- See VpcConfigOutputTypeDef
InvocationLogsConfigOutputTypeDef#
# InvocationLogsConfigOutputTypeDef definition
class InvocationLogsConfigOutputTypeDef(TypedDict):
invocationLogSource: InvocationLogSourceTypeDef, # (1)
usePromptResponse: NotRequired[bool],
requestMetadataFilters: NotRequired[RequestMetadataFiltersOutputTypeDef], # (2)
RequestMetadataFiltersTypeDef#
# RequestMetadataFiltersTypeDef definition
class RequestMetadataFiltersTypeDef(TypedDict):
equals: NotRequired[Mapping[str, str]],
notEquals: NotRequired[Mapping[str, str]],
andAll: NotRequired[Sequence[RequestMetadataBaseFiltersUnionTypeDef]], # (1)
orAll: NotRequired[Sequence[RequestMetadataBaseFiltersTypeDef]], # (2)
- See RequestMetadataBaseFiltersTypeDef RequestMetadataBaseFiltersOutputTypeDef
- See RequestMetadataBaseFiltersTypeDef
KbInferenceConfigTypeDef#
# KbInferenceConfigTypeDef definition
class KbInferenceConfigTypeDef(TypedDict):
textInferenceConfig: NotRequired[TextInferenceConfigUnionTypeDef], # (1)
ExternalSourceTypeDef#
# ExternalSourceTypeDef definition
class ExternalSourceTypeDef(TypedDict):
sourceType: ExternalSourceTypeType, # (1)
s3Location: NotRequired[S3ObjectDocTypeDef], # (2)
byteContent: NotRequired[ByteContentDocUnionTypeDef], # (3)
- See ExternalSourceTypeType
- See S3ObjectDocTypeDef
- See ByteContentDocTypeDef ByteContentDocOutputTypeDef
GetModelInvocationLoggingConfigurationResponseTypeDef#
# GetModelInvocationLoggingConfigurationResponseTypeDef definition
class GetModelInvocationLoggingConfigurationResponseTypeDef(TypedDict):
loggingConfig: LoggingConfigTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutModelInvocationLoggingConfigurationRequestRequestTypeDef#
# PutModelInvocationLoggingConfigurationRequestRequestTypeDef definition
class PutModelInvocationLoggingConfigurationRequestRequestTypeDef(TypedDict):
loggingConfig: LoggingConfigTypeDef, # (1)
AutomatedEvaluationConfigOutputTypeDef#
# AutomatedEvaluationConfigOutputTypeDef definition
class AutomatedEvaluationConfigOutputTypeDef(TypedDict):
datasetMetricConfigs: list[EvaluationDatasetMetricConfigOutputTypeDef], # (1)
evaluatorModelConfig: NotRequired[EvaluatorModelConfigOutputTypeDef], # (2)
HumanEvaluationConfigOutputTypeDef#
# HumanEvaluationConfigOutputTypeDef definition
class HumanEvaluationConfigOutputTypeDef(TypedDict):
datasetMetricConfigs: list[EvaluationDatasetMetricConfigOutputTypeDef], # (3)
humanWorkflowConfig: NotRequired[HumanWorkflowConfigTypeDef], # (1)
customMetrics: NotRequired[list[HumanEvaluationCustomMetricTypeDef]], # (2)
- See HumanWorkflowConfigTypeDef
- See HumanEvaluationCustomMetricTypeDef
- See EvaluationDatasetMetricConfigOutputTypeDef
AutomatedEvaluationConfigTypeDef#
# AutomatedEvaluationConfigTypeDef definition
class AutomatedEvaluationConfigTypeDef(TypedDict):
datasetMetricConfigs: Sequence[EvaluationDatasetMetricConfigTypeDef], # (1)
evaluatorModelConfig: NotRequired[EvaluatorModelConfigUnionTypeDef], # (2)
- See EvaluationDatasetMetricConfigTypeDef
- See EvaluatorModelConfigTypeDef EvaluatorModelConfigOutputTypeDef
KnowledgeBaseRetrievalConfigurationOutputTypeDef#
# KnowledgeBaseRetrievalConfigurationOutputTypeDef definition
class KnowledgeBaseRetrievalConfigurationOutputTypeDef(TypedDict):
vectorSearchConfiguration: KnowledgeBaseVectorSearchConfigurationOutputTypeDef, # (1)
MarketplaceModelEndpointTypeDef#
# MarketplaceModelEndpointTypeDef definition
class MarketplaceModelEndpointTypeDef(TypedDict):
endpointArn: str,
modelSourceIdentifier: str,
createdAt: datetime,
updatedAt: datetime,
endpointConfig: EndpointConfigOutputTypeDef, # (2)
endpointStatus: str,
status: NotRequired[StatusType], # (1)
statusMessage: NotRequired[str],
endpointStatusMessage: NotRequired[str],
ExternalSourcesRetrieveAndGenerateConfigurationOutputTypeDef#
# ExternalSourcesRetrieveAndGenerateConfigurationOutputTypeDef definition
class ExternalSourcesRetrieveAndGenerateConfigurationOutputTypeDef(TypedDict):
modelArn: str,
sources: list[ExternalSourceOutputTypeDef], # (1)
generationConfiguration: NotRequired[ExternalSourcesGenerationConfigurationOutputTypeDef], # (2)
ListModelInvocationJobsResponseTypeDef#
# ListModelInvocationJobsResponseTypeDef definition
class ListModelInvocationJobsResponseTypeDef(TypedDict):
invocationJobSummaries: list[ModelInvocationJobSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
TrainingDataConfigOutputTypeDef#
# TrainingDataConfigOutputTypeDef definition
class TrainingDataConfigOutputTypeDef(TypedDict):
s3Uri: NotRequired[str],
invocationLogsConfig: NotRequired[InvocationLogsConfigOutputTypeDef], # (1)
EvaluationConfigOutputTypeDef#
# EvaluationConfigOutputTypeDef definition
class EvaluationConfigOutputTypeDef(TypedDict):
automated: NotRequired[AutomatedEvaluationConfigOutputTypeDef], # (1)
human: NotRequired[HumanEvaluationConfigOutputTypeDef], # (2)
HumanEvaluationConfigTypeDef#
# HumanEvaluationConfigTypeDef definition
class HumanEvaluationConfigTypeDef(TypedDict):
datasetMetricConfigs: Sequence[EvaluationDatasetMetricConfigUnionTypeDef], # (3)
humanWorkflowConfig: NotRequired[HumanWorkflowConfigTypeDef], # (1)
customMetrics: NotRequired[Sequence[HumanEvaluationCustomMetricTypeDef]], # (2)
- See HumanWorkflowConfigTypeDef
- See HumanEvaluationCustomMetricTypeDef
- See EvaluationDatasetMetricConfigTypeDef EvaluationDatasetMetricConfigOutputTypeDef
KnowledgeBaseRetrieveAndGenerateConfigurationOutputTypeDef#
# KnowledgeBaseRetrieveAndGenerateConfigurationOutputTypeDef definition
class KnowledgeBaseRetrieveAndGenerateConfigurationOutputTypeDef(TypedDict):
knowledgeBaseId: str,
modelArn: str,
retrievalConfiguration: NotRequired[KnowledgeBaseRetrievalConfigurationOutputTypeDef], # (1)
generationConfiguration: NotRequired[GenerationConfigurationOutputTypeDef], # (2)
orchestrationConfiguration: NotRequired[OrchestrationConfigurationTypeDef], # (3)
- See KnowledgeBaseRetrievalConfigurationOutputTypeDef
- See GenerationConfigurationOutputTypeDef
- See OrchestrationConfigurationTypeDef
RetrieveConfigOutputTypeDef#
# RetrieveConfigOutputTypeDef definition
class RetrieveConfigOutputTypeDef(TypedDict):
knowledgeBaseId: str,
knowledgeBaseRetrievalConfiguration: KnowledgeBaseRetrievalConfigurationOutputTypeDef, # (1)
KnowledgeBaseVectorSearchConfigurationTypeDef#
# KnowledgeBaseVectorSearchConfigurationTypeDef definition
class KnowledgeBaseVectorSearchConfigurationTypeDef(TypedDict):
numberOfResults: NotRequired[int],
overrideSearchType: NotRequired[SearchTypeType], # (1)
filter: NotRequired[RetrievalFilterUnionTypeDef], # (2)
CreateMarketplaceModelEndpointResponseTypeDef#
# CreateMarketplaceModelEndpointResponseTypeDef definition
class CreateMarketplaceModelEndpointResponseTypeDef(TypedDict):
marketplaceModelEndpoint: MarketplaceModelEndpointTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetMarketplaceModelEndpointResponseTypeDef#
# GetMarketplaceModelEndpointResponseTypeDef definition
class GetMarketplaceModelEndpointResponseTypeDef(TypedDict):
marketplaceModelEndpoint: MarketplaceModelEndpointTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RegisterMarketplaceModelEndpointResponseTypeDef#
# RegisterMarketplaceModelEndpointResponseTypeDef definition
class RegisterMarketplaceModelEndpointResponseTypeDef(TypedDict):
marketplaceModelEndpoint: MarketplaceModelEndpointTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateMarketplaceModelEndpointResponseTypeDef#
# UpdateMarketplaceModelEndpointResponseTypeDef definition
class UpdateMarketplaceModelEndpointResponseTypeDef(TypedDict):
marketplaceModelEndpoint: MarketplaceModelEndpointTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EndpointConfigTypeDef#
# EndpointConfigTypeDef definition
class EndpointConfigTypeDef(TypedDict):
sageMaker: NotRequired[SageMakerEndpointUnionTypeDef], # (1)
GetCustomModelResponseTypeDef#
# GetCustomModelResponseTypeDef definition
class GetCustomModelResponseTypeDef(TypedDict):
modelArn: str,
modelName: str,
jobName: str,
jobArn: str,
baseModelArn: str,
customizationType: CustomizationTypeType, # (1)
modelKmsKeyArn: str,
hyperParameters: dict[str, str],
trainingDataConfig: TrainingDataConfigOutputTypeDef, # (2)
validationDataConfig: ValidationDataConfigOutputTypeDef, # (3)
outputDataConfig: OutputDataConfigTypeDef, # (4)
trainingMetrics: TrainingMetricsTypeDef, # (5)
validationMetrics: list[ValidatorMetricTypeDef], # (6)
creationTime: datetime,
customizationConfig: CustomizationConfigTypeDef, # (7)
ResponseMetadata: ResponseMetadataTypeDef, # (8)
- See CustomizationTypeType
- See TrainingDataConfigOutputTypeDef
- See ValidationDataConfigOutputTypeDef
- See OutputDataConfigTypeDef
- See TrainingMetricsTypeDef
- See ValidatorMetricTypeDef
- See CustomizationConfigTypeDef
- See ResponseMetadataTypeDef
GetModelCustomizationJobResponseTypeDef#
# GetModelCustomizationJobResponseTypeDef definition
class GetModelCustomizationJobResponseTypeDef(TypedDict):
jobArn: str,
jobName: str,
outputModelName: str,
outputModelArn: str,
clientRequestToken: str,
roleArn: str,
status: ModelCustomizationJobStatusType, # (1)
failureMessage: str,
creationTime: datetime,
lastModifiedTime: datetime,
endTime: datetime,
baseModelArn: str,
hyperParameters: dict[str, str],
trainingDataConfig: TrainingDataConfigOutputTypeDef, # (2)
validationDataConfig: ValidationDataConfigOutputTypeDef, # (3)
outputDataConfig: OutputDataConfigTypeDef, # (4)
customizationType: CustomizationTypeType, # (5)
outputModelKmsKeyArn: str,
trainingMetrics: TrainingMetricsTypeDef, # (6)
validationMetrics: list[ValidatorMetricTypeDef], # (7)
vpcConfig: VpcConfigOutputTypeDef, # (8)
customizationConfig: CustomizationConfigTypeDef, # (9)
ResponseMetadata: ResponseMetadataTypeDef, # (10)
- See ModelCustomizationJobStatusType
- See TrainingDataConfigOutputTypeDef
- See ValidationDataConfigOutputTypeDef
- See OutputDataConfigTypeDef
- See CustomizationTypeType
- See TrainingMetricsTypeDef
- See ValidatorMetricTypeDef
- See VpcConfigOutputTypeDef
- See CustomizationConfigTypeDef
- See ResponseMetadataTypeDef
InvocationLogsConfigTypeDef#
# InvocationLogsConfigTypeDef definition
class InvocationLogsConfigTypeDef(TypedDict):
invocationLogSource: InvocationLogSourceTypeDef, # (1)
usePromptResponse: NotRequired[bool],
requestMetadataFilters: NotRequired[RequestMetadataFiltersUnionTypeDef], # (2)
- See InvocationLogSourceTypeDef
- See RequestMetadataFiltersTypeDef RequestMetadataFiltersOutputTypeDef
ExternalSourcesGenerationConfigurationTypeDef#
# ExternalSourcesGenerationConfigurationTypeDef definition
class ExternalSourcesGenerationConfigurationTypeDef(TypedDict):
promptTemplate: NotRequired[PromptTemplateTypeDef], # (1)
guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef], # (2)
kbInferenceConfig: NotRequired[KbInferenceConfigUnionTypeDef], # (3)
additionalModelRequestFields: NotRequired[Mapping[str, Mapping[str, Any]]],
- See PromptTemplateTypeDef
- See GuardrailConfigurationTypeDef
- See KbInferenceConfigTypeDef KbInferenceConfigOutputTypeDef
GenerationConfigurationTypeDef#
# GenerationConfigurationTypeDef definition
class GenerationConfigurationTypeDef(TypedDict):
promptTemplate: NotRequired[PromptTemplateTypeDef], # (1)
guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef], # (2)
kbInferenceConfig: NotRequired[KbInferenceConfigUnionTypeDef], # (3)
additionalModelRequestFields: NotRequired[Mapping[str, Mapping[str, Any]]],
- See PromptTemplateTypeDef
- See GuardrailConfigurationTypeDef
- See KbInferenceConfigTypeDef KbInferenceConfigOutputTypeDef
RetrieveAndGenerateConfigurationOutputTypeDef#
# RetrieveAndGenerateConfigurationOutputTypeDef definition
class RetrieveAndGenerateConfigurationOutputTypeDef(TypedDict):
type: RetrieveAndGenerateTypeType, # (1)
knowledgeBaseConfiguration: NotRequired[KnowledgeBaseRetrieveAndGenerateConfigurationOutputTypeDef], # (2)
externalSourcesConfiguration: NotRequired[ExternalSourcesRetrieveAndGenerateConfigurationOutputTypeDef], # (3)
- See RetrieveAndGenerateTypeType
- See KnowledgeBaseRetrieveAndGenerateConfigurationOutputTypeDef
- See ExternalSourcesRetrieveAndGenerateConfigurationOutputTypeDef
CreateMarketplaceModelEndpointRequestRequestTypeDef#
# CreateMarketplaceModelEndpointRequestRequestTypeDef definition
class CreateMarketplaceModelEndpointRequestRequestTypeDef(TypedDict):
modelSourceIdentifier: str,
endpointConfig: EndpointConfigTypeDef, # (1)
endpointName: str,
acceptEula: NotRequired[bool],
clientRequestToken: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See EndpointConfigTypeDef
- See TagTypeDef
UpdateMarketplaceModelEndpointRequestRequestTypeDef#
# UpdateMarketplaceModelEndpointRequestRequestTypeDef definition
class UpdateMarketplaceModelEndpointRequestRequestTypeDef(TypedDict):
endpointArn: str,
endpointConfig: EndpointConfigTypeDef, # (1)
clientRequestToken: NotRequired[str],
EvaluationConfigTypeDef#
# EvaluationConfigTypeDef definition
class EvaluationConfigTypeDef(TypedDict):
automated: NotRequired[AutomatedEvaluationConfigUnionTypeDef], # (1)
human: NotRequired[HumanEvaluationConfigUnionTypeDef], # (2)
- See AutomatedEvaluationConfigTypeDef AutomatedEvaluationConfigOutputTypeDef
- See HumanEvaluationConfigTypeDef HumanEvaluationConfigOutputTypeDef
KnowledgeBaseConfigOutputTypeDef#
# KnowledgeBaseConfigOutputTypeDef definition
class KnowledgeBaseConfigOutputTypeDef(TypedDict):
retrieveConfig: NotRequired[RetrieveConfigOutputTypeDef], # (1)
retrieveAndGenerateConfig: NotRequired[RetrieveAndGenerateConfigurationOutputTypeDef], # (2)
KnowledgeBaseRetrievalConfigurationTypeDef#
# KnowledgeBaseRetrievalConfigurationTypeDef definition
class KnowledgeBaseRetrievalConfigurationTypeDef(TypedDict):
vectorSearchConfiguration: KnowledgeBaseVectorSearchConfigurationUnionTypeDef, # (1)
- See KnowledgeBaseVectorSearchConfigurationTypeDef KnowledgeBaseVectorSearchConfigurationOutputTypeDef
TrainingDataConfigTypeDef#
# TrainingDataConfigTypeDef definition
class TrainingDataConfigTypeDef(TypedDict):
s3Uri: NotRequired[str],
invocationLogsConfig: NotRequired[InvocationLogsConfigUnionTypeDef], # (1)
ExternalSourcesRetrieveAndGenerateConfigurationTypeDef#
# ExternalSourcesRetrieveAndGenerateConfigurationTypeDef definition
class ExternalSourcesRetrieveAndGenerateConfigurationTypeDef(TypedDict):
modelArn: str,
sources: Sequence[ExternalSourceUnionTypeDef], # (1)
generationConfiguration: NotRequired[ExternalSourcesGenerationConfigurationUnionTypeDef], # (2)
- See ExternalSourceTypeDef ExternalSourceOutputTypeDef
- See ExternalSourcesGenerationConfigurationTypeDef ExternalSourcesGenerationConfigurationOutputTypeDef
RAGConfigOutputTypeDef#
# RAGConfigOutputTypeDef definition
class RAGConfigOutputTypeDef(TypedDict):
knowledgeBaseConfig: NotRequired[KnowledgeBaseConfigOutputTypeDef], # (1)
CreateModelCustomizationJobRequestRequestTypeDef#
# CreateModelCustomizationJobRequestRequestTypeDef definition
class CreateModelCustomizationJobRequestRequestTypeDef(TypedDict):
jobName: str,
customModelName: str,
roleArn: str,
baseModelIdentifier: str,
trainingDataConfig: TrainingDataConfigTypeDef, # (1)
outputDataConfig: OutputDataConfigTypeDef, # (2)
clientRequestToken: NotRequired[str],
customizationType: NotRequired[CustomizationTypeType], # (3)
customModelKmsKeyId: NotRequired[str],
jobTags: NotRequired[Sequence[TagTypeDef]], # (4)
customModelTags: NotRequired[Sequence[TagTypeDef]], # (4)
validationDataConfig: NotRequired[ValidationDataConfigTypeDef], # (6)
hyperParameters: NotRequired[Mapping[str, str]],
vpcConfig: NotRequired[VpcConfigTypeDef], # (7)
customizationConfig: NotRequired[CustomizationConfigTypeDef], # (8)
- See TrainingDataConfigTypeDef
- See OutputDataConfigTypeDef
- See CustomizationTypeType
- See TagTypeDef
- See TagTypeDef
- See ValidationDataConfigTypeDef
- See VpcConfigTypeDef
- See CustomizationConfigTypeDef
EvaluationInferenceConfigOutputTypeDef#
# EvaluationInferenceConfigOutputTypeDef definition
class EvaluationInferenceConfigOutputTypeDef(TypedDict):
models: NotRequired[list[EvaluationModelConfigTypeDef]], # (1)
ragConfigs: NotRequired[list[RAGConfigOutputTypeDef]], # (2)
KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef#
# KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef definition
class KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef(TypedDict):
knowledgeBaseId: str,
modelArn: str,
retrievalConfiguration: NotRequired[KnowledgeBaseRetrievalConfigurationUnionTypeDef], # (1)
generationConfiguration: NotRequired[GenerationConfigurationUnionTypeDef], # (2)
orchestrationConfiguration: NotRequired[OrchestrationConfigurationTypeDef], # (3)
- See KnowledgeBaseRetrievalConfigurationTypeDef KnowledgeBaseRetrievalConfigurationOutputTypeDef
- See GenerationConfigurationTypeDef GenerationConfigurationOutputTypeDef
- See OrchestrationConfigurationTypeDef
RetrieveConfigTypeDef#
# RetrieveConfigTypeDef definition
class RetrieveConfigTypeDef(TypedDict):
knowledgeBaseId: str,
knowledgeBaseRetrievalConfiguration: KnowledgeBaseRetrievalConfigurationUnionTypeDef, # (1)
GetEvaluationJobResponseTypeDef#
# GetEvaluationJobResponseTypeDef definition
class GetEvaluationJobResponseTypeDef(TypedDict):
jobName: str,
status: EvaluationJobStatusType, # (1)
jobArn: str,
jobDescription: str,
roleArn: str,
customerEncryptionKeyId: str,
jobType: EvaluationJobTypeType, # (2)
applicationType: ApplicationTypeType, # (3)
evaluationConfig: EvaluationConfigOutputTypeDef, # (4)
inferenceConfig: EvaluationInferenceConfigOutputTypeDef, # (5)
outputDataConfig: EvaluationOutputDataConfigTypeDef, # (6)
creationTime: datetime,
lastModifiedTime: datetime,
failureMessages: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (7)
- See EvaluationJobStatusType
- See EvaluationJobTypeType
- See ApplicationTypeType
- See EvaluationConfigOutputTypeDef
- See EvaluationInferenceConfigOutputTypeDef
- See EvaluationOutputDataConfigTypeDef
- See ResponseMetadataTypeDef
RetrieveAndGenerateConfigurationTypeDef#
# RetrieveAndGenerateConfigurationTypeDef definition
class RetrieveAndGenerateConfigurationTypeDef(TypedDict):
type: RetrieveAndGenerateTypeType, # (1)
knowledgeBaseConfiguration: NotRequired[KnowledgeBaseRetrieveAndGenerateConfigurationUnionTypeDef], # (2)
externalSourcesConfiguration: NotRequired[ExternalSourcesRetrieveAndGenerateConfigurationUnionTypeDef], # (3)
- See RetrieveAndGenerateTypeType
- See KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef KnowledgeBaseRetrieveAndGenerateConfigurationOutputTypeDef
- See ExternalSourcesRetrieveAndGenerateConfigurationTypeDef ExternalSourcesRetrieveAndGenerateConfigurationOutputTypeDef
KnowledgeBaseConfigTypeDef#
# KnowledgeBaseConfigTypeDef definition
class KnowledgeBaseConfigTypeDef(TypedDict):
retrieveConfig: NotRequired[RetrieveConfigUnionTypeDef], # (1)
retrieveAndGenerateConfig: NotRequired[RetrieveAndGenerateConfigurationUnionTypeDef], # (2)
- See RetrieveConfigTypeDef RetrieveConfigOutputTypeDef
- See RetrieveAndGenerateConfigurationTypeDef RetrieveAndGenerateConfigurationOutputTypeDef
RAGConfigTypeDef#
# RAGConfigTypeDef definition
class RAGConfigTypeDef(TypedDict):
knowledgeBaseConfig: NotRequired[KnowledgeBaseConfigUnionTypeDef], # (1)
EvaluationInferenceConfigTypeDef#
# EvaluationInferenceConfigTypeDef definition
class EvaluationInferenceConfigTypeDef(TypedDict):
models: NotRequired[Sequence[EvaluationModelConfigTypeDef]], # (1)
ragConfigs: NotRequired[Sequence[RAGConfigUnionTypeDef]], # (2)
CreateEvaluationJobRequestRequestTypeDef#
# CreateEvaluationJobRequestRequestTypeDef definition
class CreateEvaluationJobRequestRequestTypeDef(TypedDict):
jobName: str,
roleArn: str,
evaluationConfig: EvaluationConfigTypeDef, # (1)
inferenceConfig: EvaluationInferenceConfigTypeDef, # (2)
outputDataConfig: EvaluationOutputDataConfigTypeDef, # (3)
jobDescription: NotRequired[str],
clientRequestToken: NotRequired[str],
customerEncryptionKeyId: NotRequired[str],
jobTags: NotRequired[Sequence[TagTypeDef]], # (4)
applicationType: NotRequired[ApplicationTypeType], # (5)