diff --git a/README.md b/README.md index 1520185a..1929026a 100644 --- a/README.md +++ b/README.md @@ -1647,9 +1647,14 @@ Namespace | Name | Import | **DataHealth** | [ReplacePercentageCheckConfig](docs/v2/DataHealth/models/ReplacePercentageCheckConfig.md) | `from foundry_sdk.v2.data_health.models import ReplacePercentageCheckConfig` | **DataHealth** | [ReplacePrimaryKeyCheckConfig](docs/v2/DataHealth/models/ReplacePrimaryKeyCheckConfig.md) | `from foundry_sdk.v2.data_health.models import ReplacePrimaryKeyCheckConfig` | **DataHealth** | [ReplacePrimaryKeyConfig](docs/v2/DataHealth/models/ReplacePrimaryKeyConfig.md) | `from foundry_sdk.v2.data_health.models import ReplacePrimaryKeyConfig` | +**DataHealth** | [ReplaceScheduleDurationCheckConfig](docs/v2/DataHealth/models/ReplaceScheduleDurationCheckConfig.md) | `from foundry_sdk.v2.data_health.models import ReplaceScheduleDurationCheckConfig` | +**DataHealth** | [ReplaceScheduleStatusCheckConfig](docs/v2/DataHealth/models/ReplaceScheduleStatusCheckConfig.md) | `from foundry_sdk.v2.data_health.models import ReplaceScheduleStatusCheckConfig` | **DataHealth** | [ReplaceSchemaComparisonCheckConfig](docs/v2/DataHealth/models/ReplaceSchemaComparisonCheckConfig.md) | `from foundry_sdk.v2.data_health.models import ReplaceSchemaComparisonCheckConfig` | **DataHealth** | [ReplaceTimeSinceLastUpdatedCheckConfig](docs/v2/DataHealth/models/ReplaceTimeSinceLastUpdatedCheckConfig.md) | `from foundry_sdk.v2.data_health.models import ReplaceTimeSinceLastUpdatedCheckConfig` | **DataHealth** | [ReplaceTotalColumnCountCheckConfig](docs/v2/DataHealth/models/ReplaceTotalColumnCountCheckConfig.md) | `from foundry_sdk.v2.data_health.models import ReplaceTotalColumnCountCheckConfig` | +**DataHealth** | [ScheduleDurationCheckConfig](docs/v2/DataHealth/models/ScheduleDurationCheckConfig.md) | `from foundry_sdk.v2.data_health.models import ScheduleDurationCheckConfig` | +**DataHealth** | [ScheduleStatusCheckConfig](docs/v2/DataHealth/models/ScheduleStatusCheckConfig.md) | `from foundry_sdk.v2.data_health.models import ScheduleStatusCheckConfig` | +**DataHealth** | [ScheduleSubject](docs/v2/DataHealth/models/ScheduleSubject.md) | `from foundry_sdk.v2.data_health.models import ScheduleSubject` | **DataHealth** | [SchemaComparisonCheckConfig](docs/v2/DataHealth/models/SchemaComparisonCheckConfig.md) | `from foundry_sdk.v2.data_health.models import SchemaComparisonCheckConfig` | **DataHealth** | [SchemaComparisonConfig](docs/v2/DataHealth/models/SchemaComparisonConfig.md) | `from foundry_sdk.v2.data_health.models import SchemaComparisonConfig` | **DataHealth** | [SchemaComparisonType](docs/v2/DataHealth/models/SchemaComparisonType.md) | `from foundry_sdk.v2.data_health.models import SchemaComparisonType` | @@ -1739,6 +1744,7 @@ Namespace | Name | Import | **Filesystem** | [GetByPathResourcesBatchResponse](docs/v2/Filesystem/models/GetByPathResourcesBatchResponse.md) | `from foundry_sdk.v2.filesystem.models import GetByPathResourcesBatchResponse` | **Filesystem** | [GetFoldersBatchRequestElement](docs/v2/Filesystem/models/GetFoldersBatchRequestElement.md) | `from foundry_sdk.v2.filesystem.models import GetFoldersBatchRequestElement` | **Filesystem** | [GetFoldersBatchResponse](docs/v2/Filesystem/models/GetFoldersBatchResponse.md) | `from foundry_sdk.v2.filesystem.models import GetFoldersBatchResponse` | +**Filesystem** | [GetRecentlyViewedResponse](docs/v2/Filesystem/models/GetRecentlyViewedResponse.md) | `from foundry_sdk.v2.filesystem.models import GetRecentlyViewedResponse` | **Filesystem** | [GetResourcesBatchRequestElement](docs/v2/Filesystem/models/GetResourcesBatchRequestElement.md) | `from foundry_sdk.v2.filesystem.models import GetResourcesBatchRequestElement` | **Filesystem** | [GetResourcesBatchResponse](docs/v2/Filesystem/models/GetResourcesBatchResponse.md) | `from foundry_sdk.v2.filesystem.models import GetResourcesBatchResponse` | **Filesystem** | [IsDirectlyApplied](docs/v2/Filesystem/models/IsDirectlyApplied.md) | `from foundry_sdk.v2.filesystem.models import IsDirectlyApplied` | @@ -1764,6 +1770,8 @@ Namespace | Name | Import | **Filesystem** | [ProjectTemplateRid](docs/v2/Filesystem/models/ProjectTemplateRid.md) | `from foundry_sdk.v2.filesystem.models import ProjectTemplateRid` | **Filesystem** | [ProjectTemplateVariableId](docs/v2/Filesystem/models/ProjectTemplateVariableId.md) | `from foundry_sdk.v2.filesystem.models import ProjectTemplateVariableId` | **Filesystem** | [ProjectTemplateVariableValue](docs/v2/Filesystem/models/ProjectTemplateVariableValue.md) | `from foundry_sdk.v2.filesystem.models import ProjectTemplateVariableValue` | +**Filesystem** | [RecentlyViewedLimit](docs/v2/Filesystem/models/RecentlyViewedLimit.md) | `from foundry_sdk.v2.filesystem.models import RecentlyViewedLimit` | +**Filesystem** | [RecentlyViewedResource](docs/v2/Filesystem/models/RecentlyViewedResource.md) | `from foundry_sdk.v2.filesystem.models import RecentlyViewedResource` | **Filesystem** | [RemoveMarkingsRequest](docs/v2/Filesystem/models/RemoveMarkingsRequest.md) | `from foundry_sdk.v2.filesystem.models import RemoveMarkingsRequest` | **Filesystem** | [RemoveOrganizationsRequest](docs/v2/Filesystem/models/RemoveOrganizationsRequest.md) | `from foundry_sdk.v2.filesystem.models import RemoveOrganizationsRequest` | **Filesystem** | [RemoveProjectResourceReferencesRequest](docs/v2/Filesystem/models/RemoveProjectResourceReferencesRequest.md) | `from foundry_sdk.v2.filesystem.models import RemoveProjectResourceReferencesRequest` | @@ -1806,6 +1814,8 @@ Namespace | Name | Import | **Functions** | [GetByRidQueriesBatchResponse](docs/v2/Functions/models/GetByRidQueriesBatchResponse.md) | `from foundry_sdk.v2.functions.models import GetByRidQueriesBatchResponse` | **Functions** | [GetExecutionResultResponse](docs/v2/Functions/models/GetExecutionResultResponse.md) | `from foundry_sdk.v2.functions.models import GetExecutionResultResponse` | **Functions** | [GetResultExecutionRequest](docs/v2/Functions/models/GetResultExecutionRequest.md) | `from foundry_sdk.v2.functions.models import GetResultExecutionRequest` | +**Functions** | [IncludePrerelease](docs/v2/Functions/models/IncludePrerelease.md) | `from foundry_sdk.v2.functions.models import IncludePrerelease` | +**Functions** | [LatestVersionResolution](docs/v2/Functions/models/LatestVersionResolution.md) | `from foundry_sdk.v2.functions.models import LatestVersionResolution` | **Functions** | [LengthConstraint](docs/v2/Functions/models/LengthConstraint.md) | `from foundry_sdk.v2.functions.models import LengthConstraint` | **Functions** | [MapConstraint](docs/v2/Functions/models/MapConstraint.md) | `from foundry_sdk.v2.functions.models import MapConstraint` | **Functions** | [NullableConstraint](docs/v2/Functions/models/NullableConstraint.md) | `from foundry_sdk.v2.functions.models import NullableConstraint` | @@ -2212,6 +2222,7 @@ Namespace | Name | Import | **Models** | [InvalidMapFormatError](docs/v2/Models/models/InvalidMapFormatError.md) | `from foundry_sdk.v2.models.models import InvalidMapFormatError` | **Models** | [InvalidResourceConfigurationError](docs/v2/Models/models/InvalidResourceConfigurationError.md) | `from foundry_sdk.v2.models.models import InvalidResourceConfigurationError` | **Models** | [InvalidTabularFormatError](docs/v2/Models/models/InvalidTabularFormatError.md) | `from foundry_sdk.v2.models.models import InvalidTabularFormatError` | +**Models** | [InvalidWorkerConfigInputTypeError](docs/v2/Models/models/InvalidWorkerConfigInputTypeError.md) | `from foundry_sdk.v2.models.models import InvalidWorkerConfigInputTypeError` | **Models** | [JsonSchemaValidationError](docs/v2/Models/models/JsonSchemaValidationError.md) | `from foundry_sdk.v2.models.models import JsonSchemaValidationError` | **Models** | [ListLiveDeploymentsResponse](docs/v2/Models/models/ListLiveDeploymentsResponse.md) | `from foundry_sdk.v2.models.models import ListLiveDeploymentsResponse` | **Models** | [ListModelStudioConfigVersionsResponse](docs/v2/Models/models/ListModelStudioConfigVersionsResponse.md) | `from foundry_sdk.v2.models.models import ListModelStudioConfigVersionsResponse` | @@ -2335,6 +2346,7 @@ Namespace | Name | Import | **Models** | [TypeMismatchError](docs/v2/Models/models/TypeMismatchError.md) | `from foundry_sdk.v2.models.models import TypeMismatchError` | **Models** | [UnknownColumnSpecIdInConfigColumnMappingError](docs/v2/Models/models/UnknownColumnSpecIdInConfigColumnMappingError.md) | `from foundry_sdk.v2.models.models import UnknownColumnSpecIdInConfigColumnMappingError` | **Models** | [UnknownInputNameError](docs/v2/Models/models/UnknownInputNameError.md) | `from foundry_sdk.v2.models.models import UnknownInputNameError` | +**Models** | [UnsupportedDatasetFieldTypeError](docs/v2/Models/models/UnsupportedDatasetFieldTypeError.md) | `from foundry_sdk.v2.models.models import UnsupportedDatasetFieldTypeError` | **Models** | [UnsupportedTypeError](docs/v2/Models/models/UnsupportedTypeError.md) | `from foundry_sdk.v2.models.models import UnsupportedTypeError` | **Ontologies** | [AbsoluteTimeRange](docs/v2/Ontologies/models/AbsoluteTimeRange.md) | `from foundry_sdk.v2.ontologies.models import AbsoluteTimeRange` | **Ontologies** | [AbsoluteValuePropertyExpression](docs/v2/Ontologies/models/AbsoluteValuePropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import AbsoluteValuePropertyExpression` | @@ -2344,6 +2356,8 @@ Namespace | Name | Import | **Ontologies** | [ActionParameterRid](docs/v2/Ontologies/models/ActionParameterRid.md) | `from foundry_sdk.v2.ontologies.models import ActionParameterRid` | **Ontologies** | [ActionParameterType](docs/v2/Ontologies/models/ActionParameterType.md) | `from foundry_sdk.v2.ontologies.models import ActionParameterType` | **Ontologies** | [ActionParameterV2](docs/v2/Ontologies/models/ActionParameterV2.md) | `from foundry_sdk.v2.ontologies.models import ActionParameterV2` | +**Ontologies** | [ActionParameterValidation](docs/v2/Ontologies/models/ActionParameterValidation.md) | `from foundry_sdk.v2.ontologies.models import ActionParameterValidation` | +**Ontologies** | [ActionParameterValidationBlock](docs/v2/Ontologies/models/ActionParameterValidationBlock.md) | `from foundry_sdk.v2.ontologies.models import ActionParameterValidationBlock` | **Ontologies** | [ActionResults](docs/v2/Ontologies/models/ActionResults.md) | `from foundry_sdk.v2.ontologies.models import ActionResults` | **Ontologies** | [ActionRid](docs/v2/Ontologies/models/ActionRid.md) | `from foundry_sdk.v2.ontologies.models import ActionRid` | **Ontologies** | [ActionSectionRid](docs/v2/Ontologies/models/ActionSectionRid.md) | `from foundry_sdk.v2.ontologies.models import ActionSectionRid` | @@ -2410,6 +2424,7 @@ Namespace | Name | Import | **Ontologies** | [ArrayEvaluatedConstraint](docs/v2/Ontologies/models/ArrayEvaluatedConstraint.md) | `from foundry_sdk.v2.ontologies.models import ArrayEvaluatedConstraint` | **Ontologies** | [ArraySizeConstraint](docs/v2/Ontologies/models/ArraySizeConstraint.md) | `from foundry_sdk.v2.ontologies.models import ArraySizeConstraint` | **Ontologies** | [ArtifactRepositoryRid](docs/v2/Ontologies/models/ArtifactRepositoryRid.md) | `from foundry_sdk.v2.ontologies.models import ArtifactRepositoryRid` | +**Ontologies** | [AttachmentAllowedValues](docs/v2/Ontologies/models/AttachmentAllowedValues.md) | `from foundry_sdk.v2.ontologies.models import AttachmentAllowedValues` | **Ontologies** | [AttachmentMetadataResponse](docs/v2/Ontologies/models/AttachmentMetadataResponse.md) | `from foundry_sdk.v2.ontologies.models import AttachmentMetadataResponse` | **Ontologies** | [AttachmentRid](docs/v2/Ontologies/models/AttachmentRid.md) | `from foundry_sdk.v2.ontologies.models import AttachmentRid` | **Ontologies** | [AttachmentV2](docs/v2/Ontologies/models/AttachmentV2.md) | `from foundry_sdk.v2.ontologies.models import AttachmentV2` | @@ -2463,6 +2478,7 @@ Namespace | Name | Import | **Ontologies** | [DatasourceBranchId](docs/v2/Ontologies/models/DatasourceBranchId.md) | `from foundry_sdk.v2.ontologies.models import DatasourceBranchId` | **Ontologies** | [DatasourceRid](docs/v2/Ontologies/models/DatasourceRid.md) | `from foundry_sdk.v2.ontologies.models import DatasourceRid` | **Ontologies** | [DataValue](docs/v2/Ontologies/models/DataValue.md) | `from foundry_sdk.v2.ontologies.models import DataValue` | +**Ontologies** | [DatetimeAllowedValues](docs/v2/Ontologies/models/DatetimeAllowedValues.md) | `from foundry_sdk.v2.ontologies.models import DatetimeAllowedValues` | **Ontologies** | [DatetimeFormat](docs/v2/Ontologies/models/DatetimeFormat.md) | `from foundry_sdk.v2.ontologies.models import DatetimeFormat` | **Ontologies** | [DatetimeLocalizedFormat](docs/v2/Ontologies/models/DatetimeLocalizedFormat.md) | `from foundry_sdk.v2.ontologies.models import DatetimeLocalizedFormat` | **Ontologies** | [DatetimeLocalizedFormatType](docs/v2/Ontologies/models/DatetimeLocalizedFormatType.md) | `from foundry_sdk.v2.ontologies.models import DatetimeLocalizedFormatType` | @@ -2519,6 +2535,7 @@ Namespace | Name | Import | **Ontologies** | [ExtractMainValueLoadLevel](docs/v2/Ontologies/models/ExtractMainValueLoadLevel.md) | `from foundry_sdk.v2.ontologies.models import ExtractMainValueLoadLevel` | **Ontologies** | [ExtractPropertyExpression](docs/v2/Ontologies/models/ExtractPropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import ExtractPropertyExpression` | **Ontologies** | [FilterValue](docs/v2/Ontologies/models/FilterValue.md) | `from foundry_sdk.v2.ontologies.models import FilterValue` | +**Ontologies** | [FixedDatetimeValue](docs/v2/Ontologies/models/FixedDatetimeValue.md) | `from foundry_sdk.v2.ontologies.models import FixedDatetimeValue` | **Ontologies** | [FixedValuesMapKey](docs/v2/Ontologies/models/FixedValuesMapKey.md) | `from foundry_sdk.v2.ontologies.models import FixedValuesMapKey` | **Ontologies** | [FullTextStringContainsPredicate](docs/v2/Ontologies/models/FullTextStringContainsPredicate.md) | `from foundry_sdk.v2.ontologies.models import FullTextStringContainsPredicate` | **Ontologies** | [FullTextStringExactPredicate](docs/v2/Ontologies/models/FullTextStringExactPredicate.md) | `from foundry_sdk.v2.ontologies.models import FullTextStringExactPredicate` | @@ -2642,6 +2659,7 @@ Namespace | Name | Import | **Ontologies** | [LongValue](docs/v2/Ontologies/models/LongValue.md) | `from foundry_sdk.v2.ontologies.models import LongValue` | **Ontologies** | [LteQueryV2](docs/v2/Ontologies/models/LteQueryV2.md) | `from foundry_sdk.v2.ontologies.models import LteQueryV2` | **Ontologies** | [LtQueryV2](docs/v2/Ontologies/models/LtQueryV2.md) | `from foundry_sdk.v2.ontologies.models import LtQueryV2` | +**Ontologies** | [MarkdownAllowedValues](docs/v2/Ontologies/models/MarkdownAllowedValues.md) | `from foundry_sdk.v2.ontologies.models import MarkdownAllowedValues` | **Ontologies** | [MarkingId](docs/v2/Ontologies/models/MarkingId.md) | `from foundry_sdk.v2.ontologies.models import MarkingId` | **Ontologies** | [MatchRule](docs/v2/Ontologies/models/MatchRule.md) | `from foundry_sdk.v2.ontologies.models import MatchRule` | **Ontologies** | [MaxAggregationV2](docs/v2/Ontologies/models/MaxAggregationV2.md) | `from foundry_sdk.v2.ontologies.models import MaxAggregationV2` | @@ -2656,12 +2674,15 @@ Namespace | Name | Import | **Ontologies** | [ModifyObjectLogicRule](docs/v2/Ontologies/models/ModifyObjectLogicRule.md) | `from foundry_sdk.v2.ontologies.models import ModifyObjectLogicRule` | **Ontologies** | [ModifyObjectRule](docs/v2/Ontologies/models/ModifyObjectRule.md) | `from foundry_sdk.v2.ontologies.models import ModifyObjectRule` | **Ontologies** | [MultiplyPropertyExpression](docs/v2/Ontologies/models/MultiplyPropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import MultiplyPropertyExpression` | +**Ontologies** | [MustBeEmptyAllowedValues](docs/v2/Ontologies/models/MustBeEmptyAllowedValues.md) | `from foundry_sdk.v2.ontologies.models import MustBeEmptyAllowedValues` | **Ontologies** | [NearestNeighborsQuery](docs/v2/Ontologies/models/NearestNeighborsQuery.md) | `from foundry_sdk.v2.ontologies.models import NearestNeighborsQuery` | **Ontologies** | [NearestNeighborsQueryText](docs/v2/Ontologies/models/NearestNeighborsQueryText.md) | `from foundry_sdk.v2.ontologies.models import NearestNeighborsQueryText` | **Ontologies** | [NegatePropertyExpression](docs/v2/Ontologies/models/NegatePropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import NegatePropertyExpression` | **Ontologies** | [NestedInterfacePropertyTypeImplementation](docs/v2/Ontologies/models/NestedInterfacePropertyTypeImplementation.md) | `from foundry_sdk.v2.ontologies.models import NestedInterfacePropertyTypeImplementation` | **Ontologies** | [NestedQueryAggregation](docs/v2/Ontologies/models/NestedQueryAggregation.md) | `from foundry_sdk.v2.ontologies.models import NestedQueryAggregation` | +**Ontologies** | [NoLoadLevel](docs/v2/Ontologies/models/NoLoadLevel.md) | `from foundry_sdk.v2.ontologies.models import NoLoadLevel` | **Ontologies** | [NotQueryV2](docs/v2/Ontologies/models/NotQueryV2.md) | `from foundry_sdk.v2.ontologies.models import NotQueryV2` | +**Ontologies** | [NowDatetimeValue](docs/v2/Ontologies/models/NowDatetimeValue.md) | `from foundry_sdk.v2.ontologies.models import NowDatetimeValue` | **Ontologies** | [NumberFormatAffix](docs/v2/Ontologies/models/NumberFormatAffix.md) | `from foundry_sdk.v2.ontologies.models import NumberFormatAffix` | **Ontologies** | [NumberFormatCurrency](docs/v2/Ontologies/models/NumberFormatCurrency.md) | `from foundry_sdk.v2.ontologies.models import NumberFormatCurrency` | **Ontologies** | [NumberFormatCurrencyStyle](docs/v2/Ontologies/models/NumberFormatCurrencyStyle.md) | `from foundry_sdk.v2.ontologies.models import NumberFormatCurrencyStyle` | @@ -2737,6 +2758,7 @@ Namespace | Name | Import | **Ontologies** | [ObjectTypeV2](docs/v2/Ontologies/models/ObjectTypeV2.md) | `from foundry_sdk.v2.ontologies.models import ObjectTypeV2` | **Ontologies** | [ObjectTypeVisibility](docs/v2/Ontologies/models/ObjectTypeVisibility.md) | `from foundry_sdk.v2.ontologies.models import ObjectTypeVisibility` | **Ontologies** | [ObjectUpdate](docs/v2/Ontologies/models/ObjectUpdate.md) | `from foundry_sdk.v2.ontologies.models import ObjectUpdate` | +**Ontologies** | [OneOfAllowedValues](docs/v2/Ontologies/models/OneOfAllowedValues.md) | `from foundry_sdk.v2.ontologies.models import OneOfAllowedValues` | **Ontologies** | [OneOfConstraint](docs/v2/Ontologies/models/OneOfConstraint.md) | `from foundry_sdk.v2.ontologies.models import OneOfConstraint` | **Ontologies** | [OntologyApiName](docs/v2/Ontologies/models/OntologyApiName.md) | `from foundry_sdk.v2.ontologies.models import OntologyApiName` | **Ontologies** | [OntologyArrayType](docs/v2/Ontologies/models/OntologyArrayType.md) | `from foundry_sdk.v2.ontologies.models import OntologyArrayType` | @@ -2767,6 +2789,11 @@ Namespace | Name | Import | **Ontologies** | [OrderBy](docs/v2/Ontologies/models/OrderBy.md) | `from foundry_sdk.v2.ontologies.models import OrderBy` | **Ontologies** | [OrderByDirection](docs/v2/Ontologies/models/OrderByDirection.md) | `from foundry_sdk.v2.ontologies.models import OrderByDirection` | **Ontologies** | [OrQueryV2](docs/v2/Ontologies/models/OrQueryV2.md) | `from foundry_sdk.v2.ontologies.models import OrQueryV2` | +**Ontologies** | [ParameterAllowedValueOption](docs/v2/Ontologies/models/ParameterAllowedValueOption.md) | `from foundry_sdk.v2.ontologies.models import ParameterAllowedValueOption` | +**Ontologies** | [ParameterAllowedValues](docs/v2/Ontologies/models/ParameterAllowedValues.md) | `from foundry_sdk.v2.ontologies.models import ParameterAllowedValues` | +**Ontologies** | [ParameterArraySize](docs/v2/Ontologies/models/ParameterArraySize.md) | `from foundry_sdk.v2.ontologies.models import ParameterArraySize` | +**Ontologies** | [ParameterConstraintValue](docs/v2/Ontologies/models/ParameterConstraintValue.md) | `from foundry_sdk.v2.ontologies.models import ParameterConstraintValue` | +**Ontologies** | [ParameterDatetimeValue](docs/v2/Ontologies/models/ParameterDatetimeValue.md) | `from foundry_sdk.v2.ontologies.models import ParameterDatetimeValue` | **Ontologies** | [ParameterEvaluatedConstraint](docs/v2/Ontologies/models/ParameterEvaluatedConstraint.md) | `from foundry_sdk.v2.ontologies.models import ParameterEvaluatedConstraint` | **Ontologies** | [ParameterEvaluationResult](docs/v2/Ontologies/models/ParameterEvaluationResult.md) | `from foundry_sdk.v2.ontologies.models import ParameterEvaluationResult` | **Ontologies** | [ParameterId](docs/v2/Ontologies/models/ParameterId.md) | `from foundry_sdk.v2.ontologies.models import ParameterId` | @@ -2833,6 +2860,7 @@ Namespace | Name | Import | **Ontologies** | [QueryTypeReferenceType](docs/v2/Ontologies/models/QueryTypeReferenceType.md) | `from foundry_sdk.v2.ontologies.models import QueryTypeReferenceType` | **Ontologies** | [QueryTypeV2](docs/v2/Ontologies/models/QueryTypeV2.md) | `from foundry_sdk.v2.ontologies.models import QueryTypeV2` | **Ontologies** | [QueryUnionType](docs/v2/Ontologies/models/QueryUnionType.md) | `from foundry_sdk.v2.ontologies.models import QueryUnionType` | +**Ontologies** | [RangeAllowedValues](docs/v2/Ontologies/models/RangeAllowedValues.md) | `from foundry_sdk.v2.ontologies.models import RangeAllowedValues` | **Ontologies** | [RangeConstraint](docs/v2/Ontologies/models/RangeConstraint.md) | `from foundry_sdk.v2.ontologies.models import RangeConstraint` | **Ontologies** | [RangesConstraint](docs/v2/Ontologies/models/RangesConstraint.md) | `from foundry_sdk.v2.ontologies.models import RangesConstraint` | **Ontologies** | [Reason](docs/v2/Ontologies/models/Reason.md) | `from foundry_sdk.v2.ontologies.models import Reason` | @@ -2845,6 +2873,10 @@ Namespace | Name | Import | **Ontologies** | [RegexQuery](docs/v2/Ontologies/models/RegexQuery.md) | `from foundry_sdk.v2.ontologies.models import RegexQuery` | **Ontologies** | [RelativeDateRangeBound](docs/v2/Ontologies/models/RelativeDateRangeBound.md) | `from foundry_sdk.v2.ontologies.models import RelativeDateRangeBound` | **Ontologies** | [RelativeDateRangeQuery](docs/v2/Ontologies/models/RelativeDateRangeQuery.md) | `from foundry_sdk.v2.ontologies.models import RelativeDateRangeQuery` | +**Ontologies** | [RelativeDatetimeDuration](docs/v2/Ontologies/models/RelativeDatetimeDuration.md) | `from foundry_sdk.v2.ontologies.models import RelativeDatetimeDuration` | +**Ontologies** | [RelativeDatetimeTense](docs/v2/Ontologies/models/RelativeDatetimeTense.md) | `from foundry_sdk.v2.ontologies.models import RelativeDatetimeTense` | +**Ontologies** | [RelativeDatetimeUnit](docs/v2/Ontologies/models/RelativeDatetimeUnit.md) | `from foundry_sdk.v2.ontologies.models import RelativeDatetimeUnit` | +**Ontologies** | [RelativeDatetimeValue](docs/v2/Ontologies/models/RelativeDatetimeValue.md) | `from foundry_sdk.v2.ontologies.models import RelativeDatetimeValue` | **Ontologies** | [RelativePointInTime](docs/v2/Ontologies/models/RelativePointInTime.md) | `from foundry_sdk.v2.ontologies.models import RelativePointInTime` | **Ontologies** | [RelativeTime](docs/v2/Ontologies/models/RelativeTime.md) | `from foundry_sdk.v2.ontologies.models import RelativeTime` | **Ontologies** | [RelativeTimeRange](docs/v2/Ontologies/models/RelativeTimeRange.md) | `from foundry_sdk.v2.ontologies.models import RelativeTimeRange` | @@ -2891,6 +2923,7 @@ Namespace | Name | Import | **Ontologies** | [SpatialFilterMode](docs/v2/Ontologies/models/SpatialFilterMode.md) | `from foundry_sdk.v2.ontologies.models import SpatialFilterMode` | **Ontologies** | [StartsWithQuery](docs/v2/Ontologies/models/StartsWithQuery.md) | `from foundry_sdk.v2.ontologies.models import StartsWithQuery` | **Ontologies** | [StaticArgument](docs/v2/Ontologies/models/StaticArgument.md) | `from foundry_sdk.v2.ontologies.models import StaticArgument` | +**Ontologies** | [StaticConstraintValue](docs/v2/Ontologies/models/StaticConstraintValue.md) | `from foundry_sdk.v2.ontologies.models import StaticConstraintValue` | **Ontologies** | [StatusActionTypesQueryV2](docs/v2/Ontologies/models/StatusActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import StatusActionTypesQueryV2` | **Ontologies** | [StreamingOutputFormat](docs/v2/Ontologies/models/StreamingOutputFormat.md) | `from foundry_sdk.v2.ontologies.models import StreamingOutputFormat` | **Ontologies** | [StreamMessage](docs/v2/Ontologies/models/StreamMessage.md) | `from foundry_sdk.v2.ontologies.models import StreamMessage` | @@ -2929,6 +2962,7 @@ Namespace | Name | Import | **Ontologies** | [SyncApplyActionResponseV2](docs/v2/Ontologies/models/SyncApplyActionResponseV2.md) | `from foundry_sdk.v2.ontologies.models import SyncApplyActionResponseV2` | **Ontologies** | [SynchronousWebhookOutputArgument](docs/v2/Ontologies/models/SynchronousWebhookOutputArgument.md) | `from foundry_sdk.v2.ontologies.models import SynchronousWebhookOutputArgument` | **Ontologies** | [TableRid](docs/v2/Ontologies/models/TableRid.md) | `from foundry_sdk.v2.ontologies.models import TableRid` | +**Ontologies** | [TextAllowedValues](docs/v2/Ontologies/models/TextAllowedValues.md) | `from foundry_sdk.v2.ontologies.models import TextAllowedValues` | **Ontologies** | [ThreeDimensionalAggregation](docs/v2/Ontologies/models/ThreeDimensionalAggregation.md) | `from foundry_sdk.v2.ontologies.models import ThreeDimensionalAggregation` | **Ontologies** | [TimeCodeFormat](docs/v2/Ontologies/models/TimeCodeFormat.md) | `from foundry_sdk.v2.ontologies.models import TimeCodeFormat` | **Ontologies** | [TimeRange](docs/v2/Ontologies/models/TimeRange.md) | `from foundry_sdk.v2.ontologies.models import TimeRange` | @@ -2960,6 +2994,7 @@ Namespace | Name | Import | **Ontologies** | [ValidateActionResponseV2](docs/v2/Ontologies/models/ValidateActionResponseV2.md) | `from foundry_sdk.v2.ontologies.models import ValidateActionResponseV2` | **Ontologies** | [ValidationResult](docs/v2/Ontologies/models/ValidationResult.md) | `from foundry_sdk.v2.ontologies.models import ValidationResult` | **Ontologies** | [ValueType](docs/v2/Ontologies/models/ValueType.md) | `from foundry_sdk.v2.ontologies.models import ValueType` | +**Ontologies** | [ValueTypeAllowedValues](docs/v2/Ontologies/models/ValueTypeAllowedValues.md) | `from foundry_sdk.v2.ontologies.models import ValueTypeAllowedValues` | **Ontologies** | [ValueTypeApiName](docs/v2/Ontologies/models/ValueTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import ValueTypeApiName` | **Ontologies** | [ValueTypeArrayType](docs/v2/Ontologies/models/ValueTypeArrayType.md) | `from foundry_sdk.v2.ontologies.models import ValueTypeArrayType` | **Ontologies** | [ValueTypeConstraint](docs/v2/Ontologies/models/ValueTypeConstraint.md) | `from foundry_sdk.v2.ontologies.models import ValueTypeConstraint` | @@ -2973,6 +3008,7 @@ Namespace | Name | Import | **Ontologies** | [ValueTypeStructField](docs/v2/Ontologies/models/ValueTypeStructField.md) | `from foundry_sdk.v2.ontologies.models import ValueTypeStructField` | **Ontologies** | [ValueTypeStructType](docs/v2/Ontologies/models/ValueTypeStructType.md) | `from foundry_sdk.v2.ontologies.models import ValueTypeStructType` | **Ontologies** | [ValueTypeUnionType](docs/v2/Ontologies/models/ValueTypeUnionType.md) | `from foundry_sdk.v2.ontologies.models import ValueTypeUnionType` | +**Ontologies** | [ValueTypeVersionId](docs/v2/Ontologies/models/ValueTypeVersionId.md) | `from foundry_sdk.v2.ontologies.models import ValueTypeVersionId` | **Ontologies** | [VersionedQueryTypeApiName](docs/v2/Ontologies/models/VersionedQueryTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import VersionedQueryTypeApiName` | **Ontologies** | [WebhookRid](docs/v2/Ontologies/models/WebhookRid.md) | `from foundry_sdk.v2.ontologies.models import WebhookRid` | **Ontologies** | [WebhookRidActionTypesQueryV2](docs/v2/Ontologies/models/WebhookRidActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import WebhookRidActionTypesQueryV2` | @@ -3726,6 +3762,7 @@ Namespace | Name | Import | **Filesystem** | ForbiddenOperationOnHiddenResource | `from foundry_sdk.v2.filesystem.errors import ForbiddenOperationOnHiddenResource` | **Filesystem** | GetAccessRequirementsPermissionDenied | `from foundry_sdk.v2.filesystem.errors import GetAccessRequirementsPermissionDenied` | **Filesystem** | GetByPathPermissionDenied | `from foundry_sdk.v2.filesystem.errors import GetByPathPermissionDenied` | +**Filesystem** | GetRecentlyViewedPermissionDenied | `from foundry_sdk.v2.filesystem.errors import GetRecentlyViewedPermissionDenied` | **Filesystem** | GetRootFolderNotSupported | `from foundry_sdk.v2.filesystem.errors import GetRootFolderNotSupported` | **Filesystem** | GetSpaceResourceNotSupported | `from foundry_sdk.v2.filesystem.errors import GetSpaceResourceNotSupported` | **Filesystem** | InvalidDefaultRoles | `from foundry_sdk.v2.filesystem.errors import InvalidDefaultRoles` | @@ -3756,6 +3793,7 @@ Namespace | Name | Import | **Filesystem** | ProjectNameAlreadyExists | `from foundry_sdk.v2.filesystem.errors import ProjectNameAlreadyExists` | **Filesystem** | ProjectNotFound | `from foundry_sdk.v2.filesystem.errors import ProjectNotFound` | **Filesystem** | ProjectTemplateNotFound | `from foundry_sdk.v2.filesystem.errors import ProjectTemplateNotFound` | +**Filesystem** | RecentlyViewedLimitBelowMinimum | `from foundry_sdk.v2.filesystem.errors import RecentlyViewedLimitBelowMinimum` | **Filesystem** | RemoveMarkingsPermissionDenied | `from foundry_sdk.v2.filesystem.errors import RemoveMarkingsPermissionDenied` | **Filesystem** | RemoveOrganizationsPermissionDenied | `from foundry_sdk.v2.filesystem.errors import RemoveOrganizationsPermissionDenied` | **Filesystem** | RemoveProjectResourceReferencesPermissionDenied | `from foundry_sdk.v2.filesystem.errors import RemoveProjectResourceReferencesPermissionDenied` | @@ -3803,6 +3841,7 @@ Namespace | Name | Import | **Functions** | GetResultExecutionPermissionDenied | `from foundry_sdk.v2.functions.errors import GetResultExecutionPermissionDenied` | **Functions** | InvalidQueryOutputValue | `from foundry_sdk.v2.functions.errors import InvalidQueryOutputValue` | **Functions** | InvalidQueryParameterValue | `from foundry_sdk.v2.functions.errors import InvalidQueryParameterValue` | +**Functions** | InvalidVersionResolutionParameters | `from foundry_sdk.v2.functions.errors import InvalidVersionResolutionParameters` | **Functions** | MissingParameter | `from foundry_sdk.v2.functions.errors import MissingParameter` | **Functions** | QueryEncounteredUserFacingError | `from foundry_sdk.v2.functions.errors import QueryEncounteredUserFacingError` | **Functions** | QueryMemoryExceededLimit | `from foundry_sdk.v2.functions.errors import QueryMemoryExceededLimit` | @@ -4002,6 +4041,7 @@ Namespace | Name | Import | **Ontologies** | ObjectSetNotFound | `from foundry_sdk.v2.ontologies.errors import ObjectSetNotFound` | **Ontologies** | ObjectsExceededLimit | `from foundry_sdk.v2.ontologies.errors import ObjectsExceededLimit` | **Ontologies** | ObjectsModifiedConcurrently | `from foundry_sdk.v2.ontologies.errors import ObjectsModifiedConcurrently` | +**Ontologies** | ObjectTypeDerivedPropertyNotSupported | `from foundry_sdk.v2.ontologies.errors import ObjectTypeDerivedPropertyNotSupported` | **Ontologies** | ObjectTypeNotFound | `from foundry_sdk.v2.ontologies.errors import ObjectTypeNotFound` | **Ontologies** | ObjectTypeNotSynced | `from foundry_sdk.v2.ontologies.errors import ObjectTypeNotSynced` | **Ontologies** | ObjectTypesNotSynced | `from foundry_sdk.v2.ontologies.errors import ObjectTypesNotSynced` | @@ -4336,6 +4376,7 @@ Namespace | Name | Import | **Ontologies** | ObjectSetNotFound | `from foundry_sdk.v1.ontologies.errors import ObjectSetNotFound` | **Ontologies** | ObjectsExceededLimit | `from foundry_sdk.v1.ontologies.errors import ObjectsExceededLimit` | **Ontologies** | ObjectsModifiedConcurrently | `from foundry_sdk.v1.ontologies.errors import ObjectsModifiedConcurrently` | +**Ontologies** | ObjectTypeDerivedPropertyNotSupported | `from foundry_sdk.v1.ontologies.errors import ObjectTypeDerivedPropertyNotSupported` | **Ontologies** | ObjectTypeNotFound | `from foundry_sdk.v1.ontologies.errors import ObjectTypeNotFound` | **Ontologies** | ObjectTypeNotSynced | `from foundry_sdk.v1.ontologies.errors import ObjectTypeNotSynced` | **Ontologies** | ObjectTypesNotSynced | `from foundry_sdk.v1.ontologies.errors import ObjectTypesNotSynced` | diff --git a/docs-snippets-npm/package.json b/docs-snippets-npm/package.json index 3d17458e..72c8f6ad 100644 --- a/docs-snippets-npm/package.json +++ b/docs-snippets-npm/package.json @@ -24,7 +24,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1697.0", + "minVersion": "1.1716.0", "maxVersion": "1.x.x", "optional": false } diff --git a/docs-snippets-npm/src/index.ts b/docs-snippets-npm/src/index.ts index e46a0b2b..d1ba6e28 100644 --- a/docs-snippets-npm/src/index.ts +++ b/docs-snippets-npm/src/index.ts @@ -1073,6 +1073,11 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets filesystem_models.GetRecentlyViewedResponse: + """ + Get the resources most recently viewed by the calling user. If a resource is now inaccessible or has + been trashed, it will not be included in the response. + + :param limit: The maximum number of recently viewed resources to return. Defaults to 100, with a maximum of 100. Values above 100 are clamped to 100. + :type limit: Optional[RecentlyViewedLimit] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: filesystem_models.GetRecentlyViewedResponse + + :raises GetRecentlyViewedPermissionDenied: Could not getRecentlyViewed the Resource. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="GET", + resource_path="/v2/filesystem/resources/getRecentlyViewed", + query_params={ + "limit": limit, + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + response_type=filesystem_models.GetRecentlyViewedResponse, + request_timeout=request_timeout, + throwable_errors={ + "GetRecentlyViewedPermissionDenied": filesystem_errors.GetRecentlyViewedPermissionDenied, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -641,6 +690,7 @@ def get_access_requirements(_: filesystem_models.AccessRequirements): ... def get_batch(_: filesystem_models.GetResourcesBatchResponse): ... def get_by_path(_: filesystem_models.Resource): ... def get_by_path_batch(_: filesystem_models.GetByPathResourcesBatchResponse): ... + def get_recently_viewed(_: filesystem_models.GetRecentlyViewedResponse): ... def markings(_: filesystem_models.ListMarkingsOfResourceResponse): ... def permanently_delete(_: None): ... def remove_markings(_: None): ... @@ -655,6 +705,9 @@ def restore(_: None): ... self.get_batch = core.with_raw_response(get_batch, client.get_batch) self.get_by_path = core.with_raw_response(get_by_path, client.get_by_path) self.get_by_path_batch = core.with_raw_response(get_by_path_batch, client.get_by_path_batch) + self.get_recently_viewed = core.with_raw_response( + get_recently_viewed, client.get_recently_viewed + ) self.markings = core.with_raw_response(markings, client.markings) self.permanently_delete = core.with_raw_response( permanently_delete, client.permanently_delete @@ -670,6 +723,7 @@ def get_access_requirements(_: filesystem_models.AccessRequirements): ... def get_batch(_: filesystem_models.GetResourcesBatchResponse): ... def get_by_path(_: filesystem_models.Resource): ... def get_by_path_batch(_: filesystem_models.GetByPathResourcesBatchResponse): ... + def get_recently_viewed(_: filesystem_models.GetRecentlyViewedResponse): ... def markings(_: filesystem_models.ListMarkingsOfResourceResponse): ... self.get = core.with_streaming_response(get, client.get) @@ -681,6 +735,9 @@ def markings(_: filesystem_models.ListMarkingsOfResourceResponse): ... self.get_by_path_batch = core.with_streaming_response( get_by_path_batch, client.get_by_path_batch ) + self.get_recently_viewed = core.with_streaming_response( + get_recently_viewed, client.get_recently_viewed + ) self.markings = core.with_streaming_response(markings, client.markings) @@ -1082,6 +1139,55 @@ def get_by_path_batch( ), ) + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def get_recently_viewed( + self, + *, + limit: typing.Optional[filesystem_models.RecentlyViewedLimit] = None, + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> typing.Awaitable[filesystem_models.GetRecentlyViewedResponse]: + """ + Get the resources most recently viewed by the calling user. If a resource is now inaccessible or has + been trashed, it will not be included in the response. + + :param limit: The maximum number of recently viewed resources to return. Defaults to 100, with a maximum of 100. Values above 100 are clamped to 100. + :type limit: Optional[RecentlyViewedLimit] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: typing.Awaitable[filesystem_models.GetRecentlyViewedResponse] + + :raises GetRecentlyViewedPermissionDenied: Could not getRecentlyViewed the Resource. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="GET", + resource_path="/v2/filesystem/resources/getRecentlyViewed", + query_params={ + "limit": limit, + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + response_type=filesystem_models.GetRecentlyViewedResponse, + request_timeout=request_timeout, + throwable_errors={ + "GetRecentlyViewedPermissionDenied": filesystem_errors.GetRecentlyViewedPermissionDenied, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -1298,6 +1404,7 @@ def get_access_requirements(_: filesystem_models.AccessRequirements): ... def get_batch(_: filesystem_models.GetResourcesBatchResponse): ... def get_by_path(_: filesystem_models.Resource): ... def get_by_path_batch(_: filesystem_models.GetByPathResourcesBatchResponse): ... + def get_recently_viewed(_: filesystem_models.GetRecentlyViewedResponse): ... def markings(_: filesystem_models.ListMarkingsOfResourceResponse): ... def permanently_delete(_: None): ... def remove_markings(_: None): ... @@ -1314,6 +1421,9 @@ def restore(_: None): ... self.get_by_path_batch = core.async_with_raw_response( get_by_path_batch, client.get_by_path_batch ) + self.get_recently_viewed = core.async_with_raw_response( + get_recently_viewed, client.get_recently_viewed + ) self.markings = core.async_with_raw_response(markings, client.markings) self.permanently_delete = core.async_with_raw_response( permanently_delete, client.permanently_delete @@ -1329,6 +1439,7 @@ def get_access_requirements(_: filesystem_models.AccessRequirements): ... def get_batch(_: filesystem_models.GetResourcesBatchResponse): ... def get_by_path(_: filesystem_models.Resource): ... def get_by_path_batch(_: filesystem_models.GetByPathResourcesBatchResponse): ... + def get_recently_viewed(_: filesystem_models.GetRecentlyViewedResponse): ... def markings(_: filesystem_models.ListMarkingsOfResourceResponse): ... self.get = core.async_with_streaming_response(get, client.get) @@ -1340,4 +1451,7 @@ def markings(_: filesystem_models.ListMarkingsOfResourceResponse): ... self.get_by_path_batch = core.async_with_streaming_response( get_by_path_batch, client.get_by_path_batch ) + self.get_recently_viewed = core.async_with_streaming_response( + get_recently_viewed, client.get_recently_viewed + ) self.markings = core.async_with_streaming_response(markings, client.markings) diff --git a/foundry_sdk/v2/functions/errors.py b/foundry_sdk/v2/functions/errors.py index f730ed5b..5b61ab69 100644 --- a/foundry_sdk/v2/functions/errors.py +++ b/foundry_sdk/v2/functions/errors.py @@ -144,7 +144,7 @@ class AsyncQueryTimeExceededLimitParameters(typing_extensions.TypedDict): @dataclass -class AsyncQueryTimeExceededLimit(errors.InternalServerError): +class AsyncQueryTimeExceededLimit(errors.BadRequestError): name: typing.Literal["AsyncQueryTimeExceededLimit"] parameters: AsyncQueryTimeExceededLimitParameters error_instance_id: str @@ -361,6 +361,24 @@ class InvalidQueryParameterValue(errors.BadRequestError): error_instance_id: str +class InvalidVersionResolutionParametersParameters(typing_extensions.TypedDict): + """ + The combination of `version`, `latestVersionResolution`, and `includePrerelease` provided is not + supported. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + message: str + + +@dataclass +class InvalidVersionResolutionParameters(errors.BadRequestError): + name: typing.Literal["InvalidVersionResolutionParameters"] + parameters: InvalidVersionResolutionParametersParameters + error_instance_id: str + + class MissingParameterParameters(typing_extensions.TypedDict): """ Required parameters are missing. Please look at the `parameters` field to see which required parameters are @@ -459,7 +477,7 @@ class QueryTimeExceededLimitParameters(typing_extensions.TypedDict): @dataclass -class QueryTimeExceededLimit(errors.InternalServerError): +class QueryTimeExceededLimit(errors.BadRequestError): name: typing.Literal["QueryTimeExceededLimit"] parameters: QueryTimeExceededLimitParameters error_instance_id: str @@ -582,6 +600,7 @@ class VersionIdNotFound(errors.NotFoundError): "GetResultExecutionPermissionDenied", "InvalidQueryOutputValue", "InvalidQueryParameterValue", + "InvalidVersionResolutionParameters", "MissingParameter", "QueryEncounteredUserFacingError", "QueryMemoryExceededLimit", diff --git a/foundry_sdk/v2/functions/models.py b/foundry_sdk/v2/functions/models.py index 235add46..45e56f4e 100644 --- a/foundry_sdk/v2/functions/models.py +++ b/foundry_sdk/v2/functions/models.py @@ -95,6 +95,9 @@ class ExecuteAsyncQueryRequest(core.ModelBase): When provided with `version`, the specified version must exist on the branch. """ + latest_version_resolution: typing.Optional[LatestVersionResolution] = pydantic.Field(alias=str("latestVersionResolution"), default=None) # type: ignore[literal-required] + include_prerelease: typing.Optional[IncludePrerelease] = pydantic.Field(alias=str("includePrerelease"), default=None) # type: ignore[literal-required] + ExecuteQueryAsyncResponse: typing_extensions.TypeAlias = typing_extensions.Annotated[ typing.Union["ExecutionSubmitted", "ExecutionCompleted"], pydantic.Field(discriminator="type") @@ -116,6 +119,9 @@ class ExecuteQueryRequest(core.ModelBase): When provided with `version`, the specified version must exist on the branch. """ + latest_version_resolution: typing.Optional[LatestVersionResolution] = pydantic.Field(alias=str("latestVersionResolution"), default=None) # type: ignore[literal-required] + include_prerelease: typing.Optional[IncludePrerelease] = pydantic.Field(alias=str("includePrerelease"), default=None) # type: ignore[literal-required] + class ExecuteQueryResponse(core.ModelBase): """ExecuteQueryResponse""" @@ -194,6 +200,19 @@ class GetResultExecutionRequest(core.ModelBase): """ +IncludePrerelease: typing_extensions.TypeAlias = bool +""" +When resolving the latest version, whether prerelease versions are considered. Defaults to `false`, +except when `latestVersionResolution` is `PUBLISH_TIME`. Not supported together with `version`. +""" + + +LatestVersionResolution: typing_extensions.TypeAlias = typing.Literal[ + "PUBLISH_TIME", "SEMANTIC_VERSION" +] +"""Controls how latest version is resolved when `version` is omitted. Defaults to `SEMANTIC_VERSION`.""" + + class LengthConstraint(core.ModelBase): """LengthConstraint""" @@ -421,6 +440,9 @@ class StreamingExecuteEventsQueryRequest(core.ModelBase): When provided with `version`, the specified version must exist on the branch. """ + latest_version_resolution: typing.Optional[LatestVersionResolution] = pydantic.Field(alias=str("latestVersionResolution"), default=None) # type: ignore[literal-required] + include_prerelease: typing.Optional[IncludePrerelease] = pydantic.Field(alias=str("includePrerelease"), default=None) # type: ignore[literal-required] + class StreamingExecuteQueryRequest(core.ModelBase): """StreamingExecuteQueryRequest""" @@ -442,6 +464,9 @@ class StreamingExecuteQueryRequest(core.ModelBase): When provided with `version`, the specified version must exist on the branch. """ + latest_version_resolution: typing.Optional[LatestVersionResolution] = pydantic.Field(alias=str("latestVersionResolution"), default=None) # type: ignore[literal-required] + include_prerelease: typing.Optional[IncludePrerelease] = pydantic.Field(alias=str("includePrerelease"), default=None) # type: ignore[literal-required] + StreamingExecuteQueryResponse: typing_extensions.TypeAlias = typing_extensions.Annotated[ typing.Union["StreamingQueryData", "StreamingQueryError"], pydantic.Field(discriminator="type") @@ -775,6 +800,8 @@ class VersionId(core.ModelBase): "GetByRidQueriesBatchResponse", "GetExecutionResultResponse", "GetResultExecutionRequest", + "IncludePrerelease", + "LatestVersionResolution", "LengthConstraint", "MapConstraint", "NullableConstraint", diff --git a/foundry_sdk/v2/functions/query.py b/foundry_sdk/v2/functions/query.py index 49adc14c..0947261e 100644 --- a/foundry_sdk/v2/functions/query.py +++ b/foundry_sdk/v2/functions/query.py @@ -68,6 +68,8 @@ def execute( ], attribution: typing.Optional[core_models.Attribution] = None, branch: typing.Optional[core_models.FoundryBranch] = None, + include_prerelease: typing.Optional[functions_models.IncludePrerelease] = None, + latest_version_resolution: typing.Optional[functions_models.LatestVersionResolution] = None, preview: typing.Optional[core_models.PreviewMode] = None, trace_parent: typing.Optional[core_models.TraceParent] = None, trace_state: typing.Optional[core_models.TraceState] = None, @@ -78,8 +80,9 @@ def execute( ) -> functions_models.ExecuteQueryResponse: """ Executes a Query and returns the result as a single JSON object. By default, this executes - the latest version of the query. The latest version is the one that was most recently - published, which may be a pre-release version. + the highest semantic version of the query, excluding pre-release versions. To resolve the + most recently published version instead, including pre-release versions, set + `latestVersionResolution` to `PUBLISH_TIME`. This endpoint executes global (non-ontology-scoped) query functions. For ontology-scoped functions, use the equivalent endpoint under @@ -94,6 +97,10 @@ def execute( :type attribution: Optional[Attribution] :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. :type branch: Optional[FoundryBranch] + :param include_prerelease: + :type include_prerelease: Optional[IncludePrerelease] + :param latest_version_resolution: + :type latest_version_resolution: Optional[LatestVersionResolution] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param trace_parent: @@ -134,6 +141,8 @@ def execute( parameters=parameters, version=version, branch=branch, + latest_version_resolution=latest_version_resolution, + include_prerelease=include_prerelease, ), response_type=functions_models.ExecuteQueryResponse, request_timeout=request_timeout, @@ -156,6 +165,8 @@ def execute_async( ], attribution: typing.Optional[core_models.Attribution] = None, branch: typing.Optional[core_models.FoundryBranch] = None, + include_prerelease: typing.Optional[functions_models.IncludePrerelease] = None, + latest_version_resolution: typing.Optional[functions_models.LatestVersionResolution] = None, ontology: typing.Optional[ontologies_models.OntologyIdentifier] = None, preview: typing.Optional[core_models.PreviewMode] = None, trace_parent: typing.Optional[core_models.TraceParent] = None, @@ -180,6 +191,10 @@ def execute_async( :type attribution: Optional[Attribution] :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. :type branch: Optional[FoundryBranch] + :param include_prerelease: + :type include_prerelease: Optional[IncludePrerelease] + :param latest_version_resolution: + :type latest_version_resolution: Optional[LatestVersionResolution] :param ontology: Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function. :type ontology: Optional[OntologyIdentifier] :param preview: Enables the use of preview functionality. @@ -223,6 +238,8 @@ def execute_async( parameters=parameters, version=version, branch=branch, + latest_version_resolution=latest_version_resolution, + include_prerelease=include_prerelease, ), response_type=functions_models.ExecuteQueryAsyncResponse, request_timeout=request_timeout, @@ -240,16 +257,24 @@ def get( self, query_api_name: functions_models.QueryApiName, *, + include_prerelease: typing.Optional[functions_models.IncludePrerelease] = None, + latest_version_resolution: typing.Optional[functions_models.LatestVersionResolution] = None, preview: typing.Optional[core_models.PreviewMode] = None, version: typing.Optional[functions_models.FunctionVersion] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> functions_models.Query: """ - Gets a specific query type with the given API name. By default, this gets the latest version of the query. + Gets a specific query type with the given API name. By default, this returns the highest semantic + version of the query, excluding pre-release versions. To resolve the most recently published version + instead, including pre-release versions, set `latestVersionResolution` to `PUBLISH_TIME`. :param query_api_name: :type query_api_name: QueryApiName + :param include_prerelease: + :type include_prerelease: Optional[IncludePrerelease] + :param latest_version_resolution: + :type latest_version_resolution: Optional[LatestVersionResolution] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param version: @@ -267,6 +292,8 @@ def get( method="GET", resource_path="/v2/functions/queries/{queryApiName}", query_params={ + "includePrerelease": include_prerelease, + "latestVersionResolution": latest_version_resolution, "preview": preview, "version": version, }, @@ -405,6 +432,8 @@ def streaming_execute( ], attribution: typing.Optional[core_models.Attribution] = None, branch: typing.Optional[core_models.FoundryBranch] = None, + include_prerelease: typing.Optional[functions_models.IncludePrerelease] = None, + latest_version_resolution: typing.Optional[functions_models.LatestVersionResolution] = None, ontology: typing.Optional[ontologies_models.OntologyIdentifier] = None, preview: typing.Optional[core_models.PreviewMode] = None, trace_parent: typing.Optional[core_models.TraceParent] = None, @@ -416,8 +445,9 @@ def streaming_execute( ) -> core.SseContextManager[functions_models.StreamingExecuteQueryResponse]: """ Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream. - By default, this executes the latest version of the query. The latest version is the one - that was most recently published, which may be a pre-release version. + By default, this executes the highest semantic version of the query, excluding pre-release + versions. To resolve the most recently published version instead, including pre-release + versions, set `latestVersionResolution` to `PUBLISH_TIME`. This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more @@ -442,6 +472,10 @@ def streaming_execute( :type attribution: Optional[Attribution] :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. :type branch: Optional[FoundryBranch] + :param include_prerelease: + :type include_prerelease: Optional[IncludePrerelease] + :param latest_version_resolution: + :type latest_version_resolution: Optional[LatestVersionResolution] :param ontology: Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function. :type ontology: Optional[OntologyIdentifier] :param preview: Enables the use of preview functionality. @@ -485,6 +519,8 @@ def streaming_execute( parameters=parameters, version=version, branch=branch, + latest_version_resolution=latest_version_resolution, + include_prerelease=include_prerelease, ), response_type=functions_models.StreamingExecuteQueryResponse, request_timeout=request_timeout, @@ -507,6 +543,8 @@ def streaming_execute_events( ], attribution: typing.Optional[core_models.Attribution] = None, branch: typing.Optional[core_models.FoundryBranch] = None, + include_prerelease: typing.Optional[functions_models.IncludePrerelease] = None, + latest_version_resolution: typing.Optional[functions_models.LatestVersionResolution] = None, ontology: typing.Optional[ontologies_models.OntologyIdentifier] = None, preview: typing.Optional[core_models.PreviewMode] = None, trace_parent: typing.Optional[core_models.TraceParent] = None, @@ -518,8 +556,9 @@ def streaming_execute_events( ) -> core.SseContextManager[functions_models.StreamingExecuteQueryResponse]: """ Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream. - By default, this executes the latest version of the query. The latest version is the one - that was most recently published, which may be a pre-release version. + By default, this executes the highest semantic version of the query, excluding pre-release + versions. To resolve the most recently published version instead, including pre-release + versions, set `latestVersionResolution` to `PUBLISH_TIME`. This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more @@ -544,6 +583,10 @@ def streaming_execute_events( :type attribution: Optional[Attribution] :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. :type branch: Optional[FoundryBranch] + :param include_prerelease: + :type include_prerelease: Optional[IncludePrerelease] + :param latest_version_resolution: + :type latest_version_resolution: Optional[LatestVersionResolution] :param ontology: Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function. :type ontology: Optional[OntologyIdentifier] :param preview: Enables the use of preview functionality. @@ -587,6 +630,8 @@ def streaming_execute_events( parameters=parameters, version=version, branch=branch, + latest_version_resolution=latest_version_resolution, + include_prerelease=include_prerelease, ), response_type=functions_models.StreamingExecuteQueryResponse, request_timeout=request_timeout, @@ -683,6 +728,8 @@ def execute( ], attribution: typing.Optional[core_models.Attribution] = None, branch: typing.Optional[core_models.FoundryBranch] = None, + include_prerelease: typing.Optional[functions_models.IncludePrerelease] = None, + latest_version_resolution: typing.Optional[functions_models.LatestVersionResolution] = None, preview: typing.Optional[core_models.PreviewMode] = None, trace_parent: typing.Optional[core_models.TraceParent] = None, trace_state: typing.Optional[core_models.TraceState] = None, @@ -693,8 +740,9 @@ def execute( ) -> typing.Awaitable[functions_models.ExecuteQueryResponse]: """ Executes a Query and returns the result as a single JSON object. By default, this executes - the latest version of the query. The latest version is the one that was most recently - published, which may be a pre-release version. + the highest semantic version of the query, excluding pre-release versions. To resolve the + most recently published version instead, including pre-release versions, set + `latestVersionResolution` to `PUBLISH_TIME`. This endpoint executes global (non-ontology-scoped) query functions. For ontology-scoped functions, use the equivalent endpoint under @@ -709,6 +757,10 @@ def execute( :type attribution: Optional[Attribution] :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. :type branch: Optional[FoundryBranch] + :param include_prerelease: + :type include_prerelease: Optional[IncludePrerelease] + :param latest_version_resolution: + :type latest_version_resolution: Optional[LatestVersionResolution] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param trace_parent: @@ -749,6 +801,8 @@ def execute( parameters=parameters, version=version, branch=branch, + latest_version_resolution=latest_version_resolution, + include_prerelease=include_prerelease, ), response_type=functions_models.ExecuteQueryResponse, request_timeout=request_timeout, @@ -771,6 +825,8 @@ def execute_async( ], attribution: typing.Optional[core_models.Attribution] = None, branch: typing.Optional[core_models.FoundryBranch] = None, + include_prerelease: typing.Optional[functions_models.IncludePrerelease] = None, + latest_version_resolution: typing.Optional[functions_models.LatestVersionResolution] = None, ontology: typing.Optional[ontologies_models.OntologyIdentifier] = None, preview: typing.Optional[core_models.PreviewMode] = None, trace_parent: typing.Optional[core_models.TraceParent] = None, @@ -795,6 +851,10 @@ def execute_async( :type attribution: Optional[Attribution] :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. :type branch: Optional[FoundryBranch] + :param include_prerelease: + :type include_prerelease: Optional[IncludePrerelease] + :param latest_version_resolution: + :type latest_version_resolution: Optional[LatestVersionResolution] :param ontology: Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function. :type ontology: Optional[OntologyIdentifier] :param preview: Enables the use of preview functionality. @@ -838,6 +898,8 @@ def execute_async( parameters=parameters, version=version, branch=branch, + latest_version_resolution=latest_version_resolution, + include_prerelease=include_prerelease, ), response_type=functions_models.ExecuteQueryAsyncResponse, request_timeout=request_timeout, @@ -855,16 +917,24 @@ def get( self, query_api_name: functions_models.QueryApiName, *, + include_prerelease: typing.Optional[functions_models.IncludePrerelease] = None, + latest_version_resolution: typing.Optional[functions_models.LatestVersionResolution] = None, preview: typing.Optional[core_models.PreviewMode] = None, version: typing.Optional[functions_models.FunctionVersion] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[functions_models.Query]: """ - Gets a specific query type with the given API name. By default, this gets the latest version of the query. + Gets a specific query type with the given API name. By default, this returns the highest semantic + version of the query, excluding pre-release versions. To resolve the most recently published version + instead, including pre-release versions, set `latestVersionResolution` to `PUBLISH_TIME`. :param query_api_name: :type query_api_name: QueryApiName + :param include_prerelease: + :type include_prerelease: Optional[IncludePrerelease] + :param latest_version_resolution: + :type latest_version_resolution: Optional[LatestVersionResolution] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param version: @@ -882,6 +952,8 @@ def get( method="GET", resource_path="/v2/functions/queries/{queryApiName}", query_params={ + "includePrerelease": include_prerelease, + "latestVersionResolution": latest_version_resolution, "preview": preview, "version": version, }, @@ -1020,6 +1092,8 @@ def streaming_execute( ], attribution: typing.Optional[core_models.Attribution] = None, branch: typing.Optional[core_models.FoundryBranch] = None, + include_prerelease: typing.Optional[functions_models.IncludePrerelease] = None, + latest_version_resolution: typing.Optional[functions_models.LatestVersionResolution] = None, ontology: typing.Optional[ontologies_models.OntologyIdentifier] = None, preview: typing.Optional[core_models.PreviewMode] = None, trace_parent: typing.Optional[core_models.TraceParent] = None, @@ -1031,8 +1105,9 @@ def streaming_execute( ) -> core.AsyncSseContextManager[functions_models.StreamingExecuteQueryResponse]: """ Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream. - By default, this executes the latest version of the query. The latest version is the one - that was most recently published, which may be a pre-release version. + By default, this executes the highest semantic version of the query, excluding pre-release + versions. To resolve the most recently published version instead, including pre-release + versions, set `latestVersionResolution` to `PUBLISH_TIME`. This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more @@ -1057,6 +1132,10 @@ def streaming_execute( :type attribution: Optional[Attribution] :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. :type branch: Optional[FoundryBranch] + :param include_prerelease: + :type include_prerelease: Optional[IncludePrerelease] + :param latest_version_resolution: + :type latest_version_resolution: Optional[LatestVersionResolution] :param ontology: Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function. :type ontology: Optional[OntologyIdentifier] :param preview: Enables the use of preview functionality. @@ -1100,6 +1179,8 @@ def streaming_execute( parameters=parameters, version=version, branch=branch, + latest_version_resolution=latest_version_resolution, + include_prerelease=include_prerelease, ), response_type=functions_models.StreamingExecuteQueryResponse, request_timeout=request_timeout, @@ -1122,6 +1203,8 @@ def streaming_execute_events( ], attribution: typing.Optional[core_models.Attribution] = None, branch: typing.Optional[core_models.FoundryBranch] = None, + include_prerelease: typing.Optional[functions_models.IncludePrerelease] = None, + latest_version_resolution: typing.Optional[functions_models.LatestVersionResolution] = None, ontology: typing.Optional[ontologies_models.OntologyIdentifier] = None, preview: typing.Optional[core_models.PreviewMode] = None, trace_parent: typing.Optional[core_models.TraceParent] = None, @@ -1133,8 +1216,9 @@ def streaming_execute_events( ) -> core.AsyncSseContextManager[functions_models.StreamingExecuteQueryResponse]: """ Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream. - By default, this executes the latest version of the query. The latest version is the one - that was most recently published, which may be a pre-release version. + By default, this executes the highest semantic version of the query, excluding pre-release + versions. To resolve the most recently published version instead, including pre-release + versions, set `latestVersionResolution` to `PUBLISH_TIME`. This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more @@ -1159,6 +1243,10 @@ def streaming_execute_events( :type attribution: Optional[Attribution] :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. :type branch: Optional[FoundryBranch] + :param include_prerelease: + :type include_prerelease: Optional[IncludePrerelease] + :param latest_version_resolution: + :type latest_version_resolution: Optional[LatestVersionResolution] :param ontology: Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function. :type ontology: Optional[OntologyIdentifier] :param preview: Enables the use of preview functionality. @@ -1202,6 +1290,8 @@ def streaming_execute_events( parameters=parameters, version=version, branch=branch, + latest_version_resolution=latest_version_resolution, + include_prerelease=include_prerelease, ), response_type=functions_models.StreamingExecuteQueryResponse, request_timeout=request_timeout, diff --git a/foundry_sdk/v2/models/models.py b/foundry_sdk/v2/models/models.py index d0fbda1d..01d277b8 100644 --- a/foundry_sdk/v2/models/models.py +++ b/foundry_sdk/v2/models/models.py @@ -59,11 +59,13 @@ class ChangelogTooLongError(core.ModelBase): "MissingRequiredDatasetColumnError", "MultiplePropertiesNotAllowedForTrainerError", "FieldValidationError", + "UnsupportedDatasetFieldTypeError", "ChangelogTooLongError", "UnknownColumnSpecIdInConfigColumnMappingError", "MultipleColumnsNotAllowedForTrainerError", "MissingWorkerConfigInputDatasetColumnMappingError", "DatasetSchemaNotFoundError", + "InvalidWorkerConfigInputTypeError", "MissingWorkerConfigInputError", "MissingWorkerConfigInputObjectSetPropertyMappingError", "OutputResourceNotFoundError", @@ -412,6 +414,21 @@ class InvalidTabularFormatError(core.ModelBase): type: typing.Literal["invalidTabularFormat"] = "invalidTabularFormat" +class InvalidWorkerConfigInputTypeError(core.ModelBase): + """A worker config input was provided with a type that does not match the expected type.""" + + input_alias: InputAlias = pydantic.Field(alias=str("inputAlias")) # type: ignore[literal-required] + """The alias of the input with the mismatched type.""" + + expected_type: str = pydantic.Field(alias=str("expectedType")) # type: ignore[literal-required] + """The type the trainer expected for the input.""" + + actual_type: str = pydantic.Field(alias=str("actualType")) # type: ignore[literal-required] + """The type that was actually provided.""" + + type: typing.Literal["invalidWorkerConfigInputType"] = "invalidWorkerConfigInputType" + + class JsonSchemaValidationError(core.ModelBase): """The custom configuration failed JSON schema validation.""" @@ -1508,6 +1525,21 @@ class UnknownInputNameError(core.ModelBase): type: typing.Literal["unknownInputName"] = "unknownInputName" +class UnsupportedDatasetFieldTypeError(core.ModelBase): + """A dataset field has a type that is not supported by the trainer.""" + + dataset_rid: core_models.DatasetRid = pydantic.Field(alias=str("datasetRid")) # type: ignore[literal-required] + """The RID of the dataset containing the unsupported field.""" + + field_name: typing.Optional[str] = pydantic.Field(alias=str("fieldName"), default=None) # type: ignore[literal-required] + """The name of the dataset field, if known.""" + + field_type: str = pydantic.Field(alias=str("fieldType")) # type: ignore[literal-required] + """The unsupported field type.""" + + type: typing.Literal["unsupportedDatasetFieldType"] = "unsupportedDatasetFieldType" + + class UnsupportedTypeError(core.ModelBase): """Input contains an unsupported data type.""" @@ -1597,6 +1629,7 @@ class UnsupportedTypeError(core.ModelBase): "InvalidMapFormatError", "InvalidResourceConfigurationError", "InvalidTabularFormatError", + "InvalidWorkerConfigInputTypeError", "JsonSchemaValidationError", "ListLiveDeploymentsResponse", "ListModelStudioConfigVersionsResponse", @@ -1720,5 +1753,6 @@ class UnsupportedTypeError(core.ModelBase): "TypeMismatchError", "UnknownColumnSpecIdInConfigColumnMappingError", "UnknownInputNameError", + "UnsupportedDatasetFieldTypeError", "UnsupportedTypeError", ] diff --git a/foundry_sdk/v2/ontologies/errors.py b/foundry_sdk/v2/ontologies/errors.py index 7358cde9..cb5a17c5 100644 --- a/foundry_sdk/v2/ontologies/errors.py +++ b/foundry_sdk/v2/ontologies/errors.py @@ -562,7 +562,7 @@ class FunctionExecutionTimedOutParameters(typing_extensions.TypedDict): @dataclass -class FunctionExecutionTimedOut(errors.InternalServerError): +class FunctionExecutionTimedOut(errors.BadRequestError): name: typing.Literal["FunctionExecutionTimedOut"] parameters: FunctionExecutionTimedOutParameters error_instance_id: str @@ -1761,6 +1761,26 @@ class ObjectSetNotFound(errors.NotFoundError): error_instance_id: str +class ObjectTypeDerivedPropertyNotSupportedParameters(typing_extensions.TypedDict): + """ + The request uses an object type derived property in a way that is not supported. This occurs when results + are sorted by the derived property, when the object set is filtered on the derived property, or when the + derived property is returned only because the request asked for all properties of the object type (rather + than naming it explicitly). To resolve this, remove the derived property from the sort ordering and from any + filters, and select only the specific properties you need - you may select the derived property itself by + name. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + +@dataclass +class ObjectTypeDerivedPropertyNotSupported(errors.BadRequestError): + name: typing.Literal["ObjectTypeDerivedPropertyNotSupported"] + parameters: ObjectTypeDerivedPropertyNotSupportedParameters + error_instance_id: str + + class ObjectTypeNotFoundParameters(typing_extensions.TypedDict): """The requested object type is not found, or the client token does not have access to it.""" @@ -2373,7 +2393,7 @@ class QueryTimeExceededLimitParameters(typing_extensions.TypedDict): @dataclass -class QueryTimeExceededLimit(errors.InternalServerError): +class QueryTimeExceededLimit(errors.BadRequestError): name: typing.Literal["QueryTimeExceededLimit"] parameters: QueryTimeExceededLimitParameters error_instance_id: str @@ -2710,6 +2730,7 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): "ObjectEditMissingPrimaryKey", "ObjectNotFound", "ObjectSetNotFound", + "ObjectTypeDerivedPropertyNotSupported", "ObjectTypeNotFound", "ObjectTypeNotSynced", "ObjectTypesNotSynced", diff --git a/foundry_sdk/v2/ontologies/models.py b/foundry_sdk/v2/ontologies/models.py index 142bc64b..521e1302 100644 --- a/foundry_sdk/v2/ontologies/models.py +++ b/foundry_sdk/v2/ontologies/models.py @@ -116,6 +116,20 @@ class ActionParameterV2(core.ModelBase): data_type: ActionParameterType = pydantic.Field(alias=str("dataType")) # type: ignore[literal-required] required: bool type_classes: typing.Optional[typing.List[TypeClass]] = pydantic.Field(alias=str("typeClasses"), default=None) # type: ignore[literal-required] + validation: typing.Optional[ActionParameterValidation] = None + + +class ActionParameterValidation(core.ModelBase): + """Validation metadata surfaced for a parameter.""" + + default_validation: ActionParameterValidationBlock = pydantic.Field(alias=str("defaultValidation")) # type: ignore[literal-required] + + +class ActionParameterValidationBlock(core.ModelBase): + """Validation constraints for a parameter.""" + + allowed_values: typing.Optional[ParameterAllowedValues] = pydantic.Field(alias=str("allowedValues"), default=None) # type: ignore[literal-required] + array_size: typing.Optional[ParameterArraySize] = pydantic.Field(alias=str("arraySize"), default=None) # type: ignore[literal-required] ActionResults: typing_extensions.TypeAlias = typing_extensions.Annotated[ @@ -725,6 +739,13 @@ class ArraySizeConstraint(core.ModelBase): """ArtifactRepositoryRid""" +class AttachmentAllowedValues(core.ModelBase): + """The parameter value (an attachment rid) must reference an attachment within the configured size limit.""" + + max_size_bytes: typing.Optional[core_models.SizeBytes] = pydantic.Field(alias=str("maxSizeBytes"), default=None) # type: ignore[literal-required] + type: typing.Literal["attachment"] = "attachment" + + AttachmentMetadataResponse: typing_extensions.TypeAlias = typing_extensions.Annotated[ typing.Union["AttachmentV2", "ListAttachmentsResponseV2"], pydantic.Field(discriminator="type") ] @@ -1194,6 +1215,16 @@ class DateValue(core.ModelBase): type: typing.Literal["dateValue"] = "dateValue" +class DatetimeAllowedValues(core.ModelBase): + """The parameter value must fall within the specified date or timestamp range.""" + + gt: typing.Optional[ParameterDatetimeValue] = None + gte: typing.Optional[ParameterDatetimeValue] = None + lt: typing.Optional[ParameterDatetimeValue] = None + lte: typing.Optional[ParameterDatetimeValue] = None + type: typing.Literal["datetime"] = "datetime" + + DatetimeFormat: typing_extensions.TypeAlias = typing_extensions.Annotated[ typing.Union["DatetimeStringFormat", "DatetimeLocalizedFormat"], pydantic.Field(discriminator="type"), @@ -1637,6 +1668,13 @@ class ExtractPropertyExpression(core.ModelBase): """ +class FixedDatetimeValue(core.ModelBase): + """An absolute datetime bound (ISO 8601 timestamp or date string).""" + + value: ParameterConstraintValue + type: typing.Literal["fixed"] = "fixed" + + FixedValuesMapKey: typing_extensions.TypeAlias = int """Integer key for fixed value mapping.""" @@ -2645,6 +2683,7 @@ class LoadObjectSetRequestV2(core.ModelBase): but not both. """ + default_load_level: typing.Optional[PropertyLoadLevel] = pydantic.Field(alias=str("defaultLoadLevel"), default=None) # type: ignore[literal-required] page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("pageToken"), default=None) # type: ignore[literal-required] page_size: typing.Optional[core_models.PageSize] = pydantic.Field(alias=str("pageSize"), default=None) # type: ignore[literal-required] exclude_rid: typing.Optional[bool] = pydantic.Field(alias=str("excludeRid"), default=None) # type: ignore[literal-required] @@ -2698,6 +2737,7 @@ class LoadObjectSetV2MultipleObjectTypesRequest(core.ModelBase): but not both. """ + default_load_level: typing.Optional[PropertyLoadLevel] = pydantic.Field(alias=str("defaultLoadLevel"), default=None) # type: ignore[literal-required] page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("pageToken"), default=None) # type: ignore[literal-required] page_size: typing.Optional[core_models.PageSize] = pydantic.Field(alias=str("pageSize"), default=None) # type: ignore[literal-required] exclude_rid: typing.Optional[bool] = pydantic.Field(alias=str("excludeRid"), default=None) # type: ignore[literal-required] @@ -2766,6 +2806,7 @@ class LoadObjectSetV2ObjectsOrInterfacesRequest(core.ModelBase): but not both. """ + default_load_level: typing.Optional[PropertyLoadLevel] = pydantic.Field(alias=str("defaultLoadLevel"), default=None) # type: ignore[literal-required] page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("pageToken"), default=None) # type: ignore[literal-required] page_size: typing.Optional[core_models.PageSize] = pydantic.Field(alias=str("pageSize"), default=None) # type: ignore[literal-required] exclude_rid: typing.Optional[bool] = pydantic.Field(alias=str("excludeRid"), default=None) # type: ignore[literal-required] @@ -2880,6 +2921,18 @@ class LteQueryV2(core.ModelBase): type: typing.Literal["lte"] = "lte" +class MarkdownAllowedValues(core.ModelBase): + """The parameter value (a markdown-formatted string) must satisfy the configured length bounds.""" + + gte: typing.Optional[int] = None + """Character length greater than or equal.""" + + lte: typing.Optional[int] = None + """Character length less than or equal.""" + + type: typing.Literal["markdown"] = "markdown" + + MarkingId: typing_extensions.TypeAlias = str """The id of a classification or mandatory marking.""" @@ -3005,6 +3058,12 @@ class MultiplyPropertyExpression(core.ModelBase): type: typing.Literal["multiply"] = "multiply" +class MustBeEmptyAllowedValues(core.ModelBase): + """The parameter must be omitted or empty.""" + + type: typing.Literal["mustBeEmpty"] = "mustBeEmpty" + + NearestNeighborsQuery: typing_extensions.TypeAlias = typing_extensions.Annotated[ typing.Union["DoubleVector", "NearestNeighborsQueryText"], pydantic.Field(discriminator="type") ] @@ -3051,6 +3110,16 @@ class NestedQueryAggregation(core.ModelBase): groups: typing.List[QueryAggregation] +class NoLoadLevel(core.ModelBase): + """ + Returns the property as-is, without applying reducers or extracting a struct main value. Useful as an + explicit per-property load level (via `PropertyWithLoadLevelSelector`) to opt a property out of a + `defaultLoadLevel`. + """ + + type: typing.Literal["noLoadLevel"] = "noLoadLevel" + + class NotQueryV2(core.ModelBase): """Returns objects where the query is not satisfied.""" @@ -3058,6 +3127,12 @@ class NotQueryV2(core.ModelBase): type: typing.Literal["not"] = "not" +class NowDatetimeValue(core.ModelBase): + """The current evaluation time itself. Carries no fields.""" + + type: typing.Literal["now"] = "now" + + class NumberFormatAffix(core.ModelBase): """ Attach arbitrary text before and/or after the formatted number. @@ -3920,6 +3995,18 @@ class ObjectUpdate(core.ModelBase): type: typing.Literal["object"] = "object" +class OneOfAllowedValues(core.ModelBase): + """The parameter value must be one of a fixed set of labelled options.""" + + options: typing.List[ParameterAllowedValueOption] + """The predefined set of options.""" + + other_values_allowed: bool = pydantic.Field(alias=str("otherValuesAllowed")) # type: ignore[literal-required] + """Whether values outside `options` are allowed.""" + + type: typing.Literal["oneOf"] = "oneOf" + + class OneOfConstraint(core.ModelBase): """The parameter has a manually predefined set of options.""" @@ -4166,6 +4253,46 @@ class OrQueryV2(core.ModelBase): """OrderByDirection""" +class ParameterAllowedValueOption(core.ModelBase): + """A possible value for the parameter.""" + + display_name: core_models.DisplayName = pydantic.Field(alias=str("displayName")) # type: ignore[literal-required] + value: DataValue + + +ParameterAllowedValues: typing_extensions.TypeAlias = typing_extensions.Annotated[ + typing.Union[ + "OneOfAllowedValues", + "DatetimeAllowedValues", + "AttachmentAllowedValues", + "ValueTypeAllowedValues", + "MarkdownAllowedValues", + "RangeAllowedValues", + "MustBeEmptyAllowedValues", + "TextAllowedValues", + ], + pydantic.Field(discriminator="type"), +] +"""The allowed-values constraint configured on an action parameter.""" + + +class ParameterArraySize(core.ModelBase): + """Bounds on the size of an array-typed parameter.""" + + gte: typing.Optional[int] = None + """Greater than or equal.""" + + lte: typing.Optional[int] = None + """Less than or equal.""" + + +ParameterDatetimeValue: typing_extensions.TypeAlias = typing_extensions.Annotated[ + typing.Union["NowDatetimeValue", "FixedDatetimeValue", "RelativeDatetimeValue"], + pydantic.Field(discriminator="type"), +] +"""A datetime bound value.""" + + ParameterEvaluatedConstraint: typing_extensions.TypeAlias = typing_extensions.Annotated[ typing.Union[ "StructEvaluatedConstraint", @@ -4211,6 +4338,8 @@ class ParameterEvaluationResult(core.ModelBase): required: bool """Represents whether the parameter is a required input to the action.""" + default_value: typing.Optional[DataValue] = pydantic.Field(alias=str("defaultValue"), default=None) # type: ignore[literal-required] + ParameterId: typing_extensions.TypeAlias = str """ @@ -4422,6 +4551,7 @@ class PropertyKnownTypeFormattingRule(core.ModelBase): "ApplyReducersAndExtractMainValueLoadLevel", "ApplyReducersLoadLevel", "ExtractMainValueLoadLevel", + "NoLoadLevel", ], pydantic.Field(discriminator="type"), ] @@ -4430,6 +4560,7 @@ class PropertyKnownTypeFormattingRule(core.ModelBase): - APPLY_REDUCERS: Returns a single value of an array as configured in the ontology. - EXTRACT_MAIN_VALUE: Returns the main value of a struct as configured in the ontology. - APPLY_REDUCERS_AND_EXTRACT_MAIN_VALUE: Performs both to return the reduced main value. +- NO_LOAD_LEVEL: Returns the property as-is, without applying reducers or extracting a struct main value. """ @@ -4807,6 +4938,16 @@ class QueryUnionType(core.ModelBase): type: typing.Literal["union"] = "union" +class RangeAllowedValues(core.ModelBase): + """The parameter value must fall within the specified numeric range.""" + + gt: typing.Optional[ParameterConstraintValue] = None + gte: typing.Optional[ParameterConstraintValue] = None + lt: typing.Optional[ParameterConstraintValue] = None + lte: typing.Optional[ParameterConstraintValue] = None + type: typing.Literal["range"] = "range" + + class RangeConstraint(core.ModelBase): """The parameter value must be within the defined range.""" @@ -4954,6 +5095,29 @@ class RelativeDateRangeQuery(core.ModelBase): type: typing.Literal["relativeDateRange"] = "relativeDateRange" +RelativeDatetimeDuration: typing_extensions.TypeAlias = core.Long +"""The magnitude of a relative datetime offset.""" + + +RelativeDatetimeTense: typing_extensions.TypeAlias = typing.Literal["FUTURE", "PAST"] +"""Direction of a relative datetime offset.""" + + +RelativeDatetimeUnit: typing_extensions.TypeAlias = typing.Literal[ + "SECOND", "MINUTE", "HOUR", "DAY", "WEEK" +] +"""Time unit for relative datetime offsets.""" + + +class RelativeDatetimeValue(core.ModelBase): + """A datetime expressed as an offset from the current time.""" + + duration: RelativeDatetimeDuration + unit: RelativeDatetimeUnit + tense: RelativeDatetimeTense + type: typing.Literal["relative"] = "relative" + + class RelativePointInTime(core.ModelBase): """A point in time specified relative to query execution time.""" @@ -5197,6 +5361,7 @@ class SearchObjectsRequestV2(core.ModelBase): but not both. """ + default_load_level: typing.Optional[PropertyLoadLevel] = pydantic.Field(alias=str("defaultLoadLevel"), default=None) # type: ignore[literal-required] exclude_rid: typing.Optional[bool] = pydantic.Field(alias=str("excludeRid"), default=None) # type: ignore[literal-required] """ A flag to exclude the retrieval of the `__rid` property. @@ -5463,6 +5628,13 @@ class StaticArgument(core.ModelBase): type: typing.Literal["staticValue"] = "staticValue" +class StaticConstraintValue(core.ModelBase): + """A literal constraint value.""" + + value: DataValue + type: typing.Literal["static"] = "static" + + class StatusActionTypesQueryV2(core.ModelBase): """Returns action types with the given status.""" @@ -5789,6 +5961,27 @@ class SynchronousWebhookOutputArgument(core.ModelBase): """The RID of a Foundry table.""" +class TextAllowedValues(core.ModelBase): + """ + The parameter value (a string) must satisfy the configured length bounds and/or regex + pattern. + """ + + gte: typing.Optional[int] = None + """Character length greater than or equal.""" + + lte: typing.Optional[int] = None + """Character length less than or equal.""" + + regex: typing.Optional[str] = None + """The regular expression. Format and supported syntax match Elasticsearch regex semantics.""" + + configured_failure_message: typing.Optional[str] = pydantic.Field(alias=str("configuredFailureMessage"), default=None) # type: ignore[literal-required] + """Message returned when the value does not match the pattern.""" + + type: typing.Literal["text"] = "text" + + class ThreeDimensionalAggregation(core.ModelBase): """ThreeDimensionalAggregation""" @@ -6085,6 +6278,15 @@ class ValidateActionResponseV2(core.ModelBase): """ +class ValueTypeAllowedValues(core.ModelBase): + """The parameter value must conform to the referenced value type.""" + + api_name: ValueTypeApiName = pydantic.Field(alias=str("apiName")) # type: ignore[literal-required] + rid: ValueTypeRid + version_id: ValueTypeVersionId = pydantic.Field(alias=str("versionId")) # type: ignore[literal-required] + type: typing.Literal["valueType"] = "valueType" + + ValueTypeApiName: typing_extensions.TypeAlias = str """The name of the value type in the API in camelCase format.""" @@ -6195,6 +6397,10 @@ class ValueTypeUnionType(core.ModelBase): type: typing.Literal["union"] = "union" +ValueTypeVersionId: typing_extensions.TypeAlias = core.UUID +"""ValueTypeVersionId""" + + VersionedQueryTypeApiName: typing_extensions.TypeAlias = str """ The name of the Query in the API and an optional version identifier separated by a colon. @@ -6288,6 +6494,10 @@ class WithinPolygonQuery(core.ModelBase): """The base used to initialize a scenario.""" +ParameterConstraintValue: typing_extensions.TypeAlias = StaticConstraintValue +"""The source of a constraint bound value.""" + + PolygonValue: typing_extensions.TypeAlias = geo_models.Polygon """PolygonValue""" @@ -6315,6 +6525,8 @@ class WithinPolygonQuery(core.ModelBase): "ActionParameterRid", "ActionParameterType", "ActionParameterV2", + "ActionParameterValidation", + "ActionParameterValidationBlock", "ActionResults", "ActionRid", "ActionSectionRid", @@ -6381,6 +6593,7 @@ class WithinPolygonQuery(core.ModelBase): "ArrayEvaluatedConstraint", "ArraySizeConstraint", "ArtifactRepositoryRid", + "AttachmentAllowedValues", "AttachmentMetadataResponse", "AttachmentRid", "AttachmentV2", @@ -6435,6 +6648,7 @@ class WithinPolygonQuery(core.ModelBase): "DatasourceBranchId", "DatasourceRid", "DateValue", + "DatetimeAllowedValues", "DatetimeFormat", "DatetimeLocalizedFormat", "DatetimeLocalizedFormatType", @@ -6490,6 +6704,7 @@ class WithinPolygonQuery(core.ModelBase): "ExtractMainValueLoadLevel", "ExtractPropertyExpression", "FilterValue", + "FixedDatetimeValue", "FixedValuesMapKey", "FullTextStringContainsPredicate", "FullTextStringExactPredicate", @@ -6613,6 +6828,7 @@ class WithinPolygonQuery(core.ModelBase): "LongValue", "LtQueryV2", "LteQueryV2", + "MarkdownAllowedValues", "MarkingId", "MatchRule", "MaxAggregationV2", @@ -6627,12 +6843,15 @@ class WithinPolygonQuery(core.ModelBase): "ModifyObjectLogicRule", "ModifyObjectRule", "MultiplyPropertyExpression", + "MustBeEmptyAllowedValues", "NearestNeighborsQuery", "NearestNeighborsQueryText", "NegatePropertyExpression", "NestedInterfacePropertyTypeImplementation", "NestedQueryAggregation", + "NoLoadLevel", "NotQueryV2", + "NowDatetimeValue", "NumberFormatAffix", "NumberFormatCurrency", "NumberFormatCurrencyStyle", @@ -6708,6 +6927,7 @@ class WithinPolygonQuery(core.ModelBase): "ObjectTypeV2", "ObjectTypeVisibility", "ObjectUpdate", + "OneOfAllowedValues", "OneOfConstraint", "OntologyApiName", "OntologyArrayType", @@ -6738,6 +6958,11 @@ class WithinPolygonQuery(core.ModelBase): "OrQueryV2", "OrderBy", "OrderByDirection", + "ParameterAllowedValueOption", + "ParameterAllowedValues", + "ParameterArraySize", + "ParameterConstraintValue", + "ParameterDatetimeValue", "ParameterEvaluatedConstraint", "ParameterEvaluationResult", "ParameterId", @@ -6804,6 +7029,7 @@ class WithinPolygonQuery(core.ModelBase): "QueryTypeReferenceType", "QueryTypeV2", "QueryUnionType", + "RangeAllowedValues", "RangeConstraint", "RangesConstraint", "Reason", @@ -6816,6 +7042,10 @@ class WithinPolygonQuery(core.ModelBase): "RegexQuery", "RelativeDateRangeBound", "RelativeDateRangeQuery", + "RelativeDatetimeDuration", + "RelativeDatetimeTense", + "RelativeDatetimeUnit", + "RelativeDatetimeValue", "RelativePointInTime", "RelativeTime", "RelativeTimeRange", @@ -6862,6 +7092,7 @@ class WithinPolygonQuery(core.ModelBase): "SpatialFilterMode", "StartsWithQuery", "StaticArgument", + "StaticConstraintValue", "StatusActionTypesQueryV2", "StreamMessage", "StreamRid", @@ -6900,6 +7131,7 @@ class WithinPolygonQuery(core.ModelBase): "SyncApplyActionResponseV2", "SynchronousWebhookOutputArgument", "TableRid", + "TextAllowedValues", "ThreeDimensionalAggregation", "TimeCodeFormat", "TimeRange", @@ -6931,6 +7163,7 @@ class WithinPolygonQuery(core.ModelBase): "ValidateActionResponseV2", "ValidationResult", "ValueType", + "ValueTypeAllowedValues", "ValueTypeApiName", "ValueTypeArrayType", "ValueTypeConstraint", @@ -6944,6 +7177,7 @@ class WithinPolygonQuery(core.ModelBase): "ValueTypeStructField", "ValueTypeStructType", "ValueTypeUnionType", + "ValueTypeVersionId", "VersionedQueryTypeApiName", "WebhookRid", "WebhookRidActionTypesQueryV2", diff --git a/foundry_sdk/v2/ontologies/ontology_object.py b/foundry_sdk/v2/ontologies/ontology_object.py index df3b2af4..9dad7afe 100644 --- a/foundry_sdk/v2/ontologies/ontology_object.py +++ b/foundry_sdk/v2/ontologies/ontology_object.py @@ -361,6 +361,7 @@ def search( *, select: typing.List[ontologies_models.PropertyApiName], branch: typing.Optional[core_models.FoundryBranch] = None, + default_load_level: typing.Optional[ontologies_models.PropertyLoadLevel] = None, exclude_rid: typing.Optional[bool] = None, execute_in_memory_only: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, @@ -410,6 +411,8 @@ def search( :type select: List[PropertyApiName] :param branch: The Foundry branch to search objects from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. :type branch: Optional[FoundryBranch] + :param default_load_level: + :type default_load_level: Optional[PropertyLoadLevel] :param exclude_rid: A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. :type exclude_rid: Optional[bool] :param execute_in_memory_only: If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false. @@ -463,6 +466,7 @@ def search( page_token=page_token, select=select, select_v2=select_v2, + default_load_level=default_load_level, exclude_rid=exclude_rid, snapshot=snapshot, reference_signing_options=reference_signing_options, @@ -842,6 +846,7 @@ def search( *, select: typing.List[ontologies_models.PropertyApiName], branch: typing.Optional[core_models.FoundryBranch] = None, + default_load_level: typing.Optional[ontologies_models.PropertyLoadLevel] = None, exclude_rid: typing.Optional[bool] = None, execute_in_memory_only: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, @@ -891,6 +896,8 @@ def search( :type select: List[PropertyApiName] :param branch: The Foundry branch to search objects from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. :type branch: Optional[FoundryBranch] + :param default_load_level: + :type default_load_level: Optional[PropertyLoadLevel] :param exclude_rid: A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. :type exclude_rid: Optional[bool] :param execute_in_memory_only: If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false. @@ -944,6 +951,7 @@ def search( page_token=page_token, select=select, select_v2=select_v2, + default_load_level=default_load_level, exclude_rid=exclude_rid, snapshot=snapshot, reference_signing_options=reference_signing_options, diff --git a/foundry_sdk/v2/ontologies/ontology_object_set.py b/foundry_sdk/v2/ontologies/ontology_object_set.py index 00dc3472..2cc810de 100644 --- a/foundry_sdk/v2/ontologies/ontology_object_set.py +++ b/foundry_sdk/v2/ontologies/ontology_object_set.py @@ -278,6 +278,7 @@ def load( object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], branch: typing.Optional[core_models.FoundryBranch] = None, + default_load_level: typing.Optional[ontologies_models.PropertyLoadLevel] = None, exclude_rid: typing.Optional[bool] = None, execute_in_memory_only: typing.Optional[bool] = None, include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = None, @@ -317,6 +318,8 @@ def load( :type select: List[SelectedPropertyApiName] :param branch: The Foundry branch to load the object set from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. :type branch: Optional[FoundryBranch] + :param default_load_level: + :type default_load_level: Optional[PropertyLoadLevel] :param exclude_rid: A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. :type exclude_rid: Optional[bool] :param execute_in_memory_only: If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false. @@ -381,6 +384,7 @@ def load( order_by=order_by, select=select, select_v2=select_v2, + default_load_level=default_load_level, page_token=page_token, page_size=page_size, exclude_rid=exclude_rid, @@ -506,6 +510,7 @@ def load_multiple_object_types( object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], branch: typing.Optional[core_models.FoundryBranch] = None, + default_load_level: typing.Optional[ontologies_models.PropertyLoadLevel] = None, exclude_rid: typing.Optional[bool] = None, execute_in_memory_only: typing.Optional[bool] = None, include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = None, @@ -551,6 +556,8 @@ def load_multiple_object_types( :type select: List[SelectedPropertyApiName] :param branch: The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. :type branch: Optional[FoundryBranch] + :param default_load_level: + :type default_load_level: Optional[PropertyLoadLevel] :param exclude_rid: A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. :type exclude_rid: Optional[bool] :param execute_in_memory_only: If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false. @@ -618,6 +625,7 @@ def load_multiple_object_types( order_by=order_by, select=select, select_v2=select_v2, + default_load_level=default_load_level, page_token=page_token, page_size=page_size, exclude_rid=exclude_rid, @@ -643,6 +651,7 @@ def load_objects_or_interfaces( object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], branch: typing.Optional[core_models.FoundryBranch] = None, + default_load_level: typing.Optional[ontologies_models.PropertyLoadLevel] = None, exclude_rid: typing.Optional[bool] = None, execute_in_memory_only: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, @@ -688,6 +697,8 @@ def load_objects_or_interfaces( :type select: List[SelectedPropertyApiName] :param branch: The Foundry branch to load the objects or interfaces from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. :type branch: Optional[FoundryBranch] + :param default_load_level: + :type default_load_level: Optional[PropertyLoadLevel] :param exclude_rid: A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. :type exclude_rid: Optional[bool] :param execute_in_memory_only: If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false. @@ -751,6 +762,7 @@ def load_objects_or_interfaces( order_by=order_by, select=select, select_v2=select_v2, + default_load_level=default_load_level, page_token=page_token, page_size=page_size, exclude_rid=exclude_rid, @@ -1075,6 +1087,7 @@ def load( object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], branch: typing.Optional[core_models.FoundryBranch] = None, + default_load_level: typing.Optional[ontologies_models.PropertyLoadLevel] = None, exclude_rid: typing.Optional[bool] = None, execute_in_memory_only: typing.Optional[bool] = None, include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = None, @@ -1114,6 +1127,8 @@ def load( :type select: List[SelectedPropertyApiName] :param branch: The Foundry branch to load the object set from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. :type branch: Optional[FoundryBranch] + :param default_load_level: + :type default_load_level: Optional[PropertyLoadLevel] :param exclude_rid: A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. :type exclude_rid: Optional[bool] :param execute_in_memory_only: If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false. @@ -1178,6 +1193,7 @@ def load( order_by=order_by, select=select, select_v2=select_v2, + default_load_level=default_load_level, page_token=page_token, page_size=page_size, exclude_rid=exclude_rid, @@ -1303,6 +1319,7 @@ def load_multiple_object_types( object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], branch: typing.Optional[core_models.FoundryBranch] = None, + default_load_level: typing.Optional[ontologies_models.PropertyLoadLevel] = None, exclude_rid: typing.Optional[bool] = None, execute_in_memory_only: typing.Optional[bool] = None, include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = None, @@ -1348,6 +1365,8 @@ def load_multiple_object_types( :type select: List[SelectedPropertyApiName] :param branch: The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. :type branch: Optional[FoundryBranch] + :param default_load_level: + :type default_load_level: Optional[PropertyLoadLevel] :param exclude_rid: A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. :type exclude_rid: Optional[bool] :param execute_in_memory_only: If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false. @@ -1415,6 +1434,7 @@ def load_multiple_object_types( order_by=order_by, select=select, select_v2=select_v2, + default_load_level=default_load_level, page_token=page_token, page_size=page_size, exclude_rid=exclude_rid, @@ -1440,6 +1460,7 @@ def load_objects_or_interfaces( object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], branch: typing.Optional[core_models.FoundryBranch] = None, + default_load_level: typing.Optional[ontologies_models.PropertyLoadLevel] = None, exclude_rid: typing.Optional[bool] = None, execute_in_memory_only: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, @@ -1485,6 +1506,8 @@ def load_objects_or_interfaces( :type select: List[SelectedPropertyApiName] :param branch: The Foundry branch to load the objects or interfaces from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. :type branch: Optional[FoundryBranch] + :param default_load_level: + :type default_load_level: Optional[PropertyLoadLevel] :param exclude_rid: A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. :type exclude_rid: Optional[bool] :param execute_in_memory_only: If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false. @@ -1548,6 +1571,7 @@ def load_objects_or_interfaces( order_by=order_by, select=select, select_v2=select_v2, + default_load_level=default_load_level, page_token=page_token, page_size=page_size, exclude_rid=exclude_rid, diff --git a/foundry_sdk/v2/ontologies/query.py b/foundry_sdk/v2/ontologies/query.py index 74367eae..2c7e5c16 100644 --- a/foundry_sdk/v2/ontologies/query.py +++ b/foundry_sdk/v2/ontologies/query.py @@ -104,7 +104,7 @@ def execute( :type trace_state: Optional[TraceState] :param transaction_id: The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[OntologyTransactionId] - :param version: The version of the Query to execute. When used with `branch`, the specified version must exist on the branch. + :param version: The version of the Query to execute. If not specified, the latest version is used. The latest version is the one that was most recently published, including pre-release versions. When used with `branch`, the specified version must exist on the branch. :type version: Optional[FunctionVersion] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] @@ -240,7 +240,7 @@ def execute( :type trace_state: Optional[TraceState] :param transaction_id: The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[OntologyTransactionId] - :param version: The version of the Query to execute. When used with `branch`, the specified version must exist on the branch. + :param version: The version of the Query to execute. If not specified, the latest version is used. The latest version is the one that was most recently published, including pre-release versions. When used with `branch`, the specified version must exist on the branch. :type version: Optional[FunctionVersion] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] diff --git a/foundry_sdk/v2/ontologies/query_type.py b/foundry_sdk/v2/ontologies/query_type.py index ba32f7ff..a2196b2f 100644 --- a/foundry_sdk/v2/ontologies/query_type.py +++ b/foundry_sdk/v2/ontologies/query_type.py @@ -79,7 +79,7 @@ def get( :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The version of the generated SDK. :type sdk_version: Optional[SdkVersion] - :param version: The version of the Query to get. + :param version: The version of the Query to get. If not specified, the latest version is used. The latest version is the one that was most recently published, including pre-release versions. :type version: Optional[FunctionVersion] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] @@ -190,6 +190,9 @@ def list( """ Lists the query types for the given Ontology. + Each query type is returned at its latest version. The latest version is the one that was most recently + published, which may be a pre-release version. + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more results available, at least one result will be present in the response. @@ -309,7 +312,7 @@ def get( :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The version of the generated SDK. :type sdk_version: Optional[SdkVersion] - :param version: The version of the Query to get. + :param version: The version of the Query to get. If not specified, the latest version is used. The latest version is the one that was most recently published, including pre-release versions. :type version: Optional[FunctionVersion] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] @@ -420,6 +423,9 @@ def list( """ Lists the query types for the given Ontology. + Each query type is returned at its latest version. The latest version is the one that was most recently + published, which may be a pre-release version. + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more results available, at least one result will be present in the response.