From ab14aae3562a2870a276b92d3092f33d639ecc71 Mon Sep 17 00:00:00 2001 From: svc-excavator-bot Date: Mon, 3 Aug 2026 17:44:49 +0000 Subject: [PATCH] Excavator: Upgrade API Version --- README.md | 56 ++++ docs-snippets-npm/package.json | 2 +- docs-snippets-npm/src/index.ts | 41 +-- .../models/ParameterEvaluationResult.md | 1 + docs/v2/DataHealth/models/CheckConfig.md | 2 + .../DataHealth/models/ReplaceCheckConfig.md | 2 + .../ReplaceScheduleDurationCheckConfig.md | 12 + .../ReplaceScheduleStatusCheckConfig.md | 12 + .../models/ScheduleDurationCheckConfig.md | 13 + .../models/ScheduleStatusCheckConfig.md | 13 + docs/v2/DataHealth/models/ScheduleSubject.md | 11 + docs/v2/Filesystem/Resource.md | 53 ++++ .../models/GetRecentlyViewedResponse.md | 11 + .../Filesystem/models/RecentlyViewedLimit.md | 14 + .../models/RecentlyViewedResource.md | 12 + docs/v2/Functions/Query.md | 65 ++++- .../models/ExecuteAsyncQueryRequest.md | 2 + .../Functions/models/ExecuteQueryRequest.md | 2 + docs/v2/Functions/models/IncludePrerelease.md | 13 + .../models/LatestVersionResolution.md | 12 + .../StreamingExecuteEventsQueryRequest.md | 2 + .../models/StreamingExecuteQueryRequest.md | 2 + docs/v2/MediaSets/MediaSet.md | 39 +-- docs/v2/MediaSets/models/CadDecodeFormat.md | 10 + .../MediaSets/models/CadMediaItemMetadata.md | 14 + docs/v2/MediaSets/models/CadUnits.md | 11 + .../models/ExtractVlmTextOperation.md | 2 +- docs/v2/MediaSets/models/MediaItemMetadata.md | 1 + docs/v2/MediaSets/models/MediaSchema.md | 1 + docs/v2/MediaSets/models/VideoDecodeFormat.md | 1 + docs/v2/MediaSets/models/VlmOutputFormat.md | 10 + docs/v2/Models/LiveDeployment.md | 2 + .../CreateConfigValidationFailureReason.md | 2 + .../InvalidWorkerConfigInputTypeError.md | 14 + .../LiveDeploymentRuntimeConfiguration.md | 1 + .../UnsupportedDatasetFieldTypeError.md | 14 + docs/v2/Ontologies/OntologyObject.md | 4 + docs/v2/Ontologies/OntologyObjectSet.md | 12 + docs/v2/Ontologies/Query.md | 4 +- docs/v2/Ontologies/QueryType.md | 9 +- .../v2/Ontologies/models/ActionParameterV2.md | 1 + .../models/ActionParameterValidation.md | 11 + .../models/ActionParameterValidationBlock.md | 12 + .../models/AttachmentAllowedValues.md | 12 + .../models/DatetimeAllowedValues.md | 15 ++ .../Ontologies/models/FixedDatetimeValue.md | 12 + .../InterfaceActionTypeConstraintApiName.md | 13 + .../models/LoadObjectSetRequestV2.md | 1 + ...adObjectSetV2MultipleObjectTypesRequest.md | 1 + ...adObjectSetV2ObjectsOrInterfacesRequest.md | 1 + .../models/MarkdownAllowedValues.md | 13 + .../models/MustBeEmptyAllowedValues.md | 11 + docs/v2/Ontologies/models/NoLoadLevel.md | 14 + docs/v2/Ontologies/models/NowDatetimeValue.md | 11 + .../models/ObjectSetStreamSubscribeRequest.md | 6 +- .../ObjectTypeInterfaceImplementation.md | 1 + .../Ontologies/models/OneOfAllowedValues.md | 13 + .../models/ParameterAllowedValueOption.md | 12 + .../models/ParameterAllowedValues.md | 22 ++ .../Ontologies/models/ParameterArraySize.md | 12 + .../models/ParameterConstraintValue.md | 11 + .../models/ParameterDatetimeValue.md | 17 ++ .../models/ParameterEvaluationResult.md | 1 + .../v2/Ontologies/models/PropertyLoadLevel.md | 2 + .../Ontologies/models/RangeAllowedValues.md | 16 ++ .../models/RelativeDatetimeDuration.md | 11 + .../models/RelativeDatetimeTense.md | 11 + .../Ontologies/models/RelativeDatetimeUnit.md | 14 + .../models/RelativeDatetimeValue.md | 14 + .../models/SearchObjectsRequestV2.md | 1 + .../models/StaticConstraintValue.md | 12 + .../v2/Ontologies/models/TextAllowedValues.md | 17 ++ .../models/ValueTypeAllowedValues.md | 14 + .../Ontologies/models/ValueTypeVersionId.md | 11 + foundry_sdk/_version.py | 2 +- foundry_sdk/v1/ontologies/errors.py | 25 +- foundry_sdk/v1/ontologies/models.py | 2 + foundry_sdk/v2/cli.py | 171 ++++++++---- foundry_sdk/v2/data_health/models.py | 45 ++++ foundry_sdk/v2/filesystem/errors.py | 34 +++ foundry_sdk/v2/filesystem/models.py | 27 ++ foundry_sdk/v2/filesystem/resource.py | 114 ++++++++ foundry_sdk/v2/functions/errors.py | 23 +- foundry_sdk/v2/functions/models.py | 27 ++ foundry_sdk/v2/functions/query.py | 118 +++++++- foundry_sdk/v2/media_sets/errors.py | 157 +++++++++++ foundry_sdk/v2/media_sets/media_set.py | 64 +---- foundry_sdk/v2/media_sets/models.py | 39 ++- foundry_sdk/v2/models/models.py | 37 +++ foundry_sdk/v2/ontologies/errors.py | 25 +- foundry_sdk/v2/ontologies/models.py | 255 +++++++++++++++++- foundry_sdk/v2/ontologies/ontology_object.py | 8 + .../v2/ontologies/ontology_object_set.py | 24 ++ foundry_sdk/v2/ontologies/query.py | 4 +- foundry_sdk/v2/ontologies/query_type.py | 10 +- 95 files changed, 1860 insertions(+), 201 deletions(-) create mode 100644 docs/v2/DataHealth/models/ReplaceScheduleDurationCheckConfig.md create mode 100644 docs/v2/DataHealth/models/ReplaceScheduleStatusCheckConfig.md create mode 100644 docs/v2/DataHealth/models/ScheduleDurationCheckConfig.md create mode 100644 docs/v2/DataHealth/models/ScheduleStatusCheckConfig.md create mode 100644 docs/v2/DataHealth/models/ScheduleSubject.md create mode 100644 docs/v2/Filesystem/models/GetRecentlyViewedResponse.md create mode 100644 docs/v2/Filesystem/models/RecentlyViewedLimit.md create mode 100644 docs/v2/Filesystem/models/RecentlyViewedResource.md create mode 100644 docs/v2/Functions/models/IncludePrerelease.md create mode 100644 docs/v2/Functions/models/LatestVersionResolution.md create mode 100644 docs/v2/MediaSets/models/CadDecodeFormat.md create mode 100644 docs/v2/MediaSets/models/CadMediaItemMetadata.md create mode 100644 docs/v2/MediaSets/models/CadUnits.md create mode 100644 docs/v2/MediaSets/models/VlmOutputFormat.md create mode 100644 docs/v2/Models/models/InvalidWorkerConfigInputTypeError.md create mode 100644 docs/v2/Models/models/UnsupportedDatasetFieldTypeError.md create mode 100644 docs/v2/Ontologies/models/ActionParameterValidation.md create mode 100644 docs/v2/Ontologies/models/ActionParameterValidationBlock.md create mode 100644 docs/v2/Ontologies/models/AttachmentAllowedValues.md create mode 100644 docs/v2/Ontologies/models/DatetimeAllowedValues.md create mode 100644 docs/v2/Ontologies/models/FixedDatetimeValue.md create mode 100644 docs/v2/Ontologies/models/InterfaceActionTypeConstraintApiName.md create mode 100644 docs/v2/Ontologies/models/MarkdownAllowedValues.md create mode 100644 docs/v2/Ontologies/models/MustBeEmptyAllowedValues.md create mode 100644 docs/v2/Ontologies/models/NoLoadLevel.md create mode 100644 docs/v2/Ontologies/models/NowDatetimeValue.md create mode 100644 docs/v2/Ontologies/models/OneOfAllowedValues.md create mode 100644 docs/v2/Ontologies/models/ParameterAllowedValueOption.md create mode 100644 docs/v2/Ontologies/models/ParameterAllowedValues.md create mode 100644 docs/v2/Ontologies/models/ParameterArraySize.md create mode 100644 docs/v2/Ontologies/models/ParameterConstraintValue.md create mode 100644 docs/v2/Ontologies/models/ParameterDatetimeValue.md create mode 100644 docs/v2/Ontologies/models/RangeAllowedValues.md create mode 100644 docs/v2/Ontologies/models/RelativeDatetimeDuration.md create mode 100644 docs/v2/Ontologies/models/RelativeDatetimeTense.md create mode 100644 docs/v2/Ontologies/models/RelativeDatetimeUnit.md create mode 100644 docs/v2/Ontologies/models/RelativeDatetimeValue.md create mode 100644 docs/v2/Ontologies/models/StaticConstraintValue.md create mode 100644 docs/v2/Ontologies/models/TextAllowedValues.md create mode 100644 docs/v2/Ontologies/models/ValueTypeAllowedValues.md create mode 100644 docs/v2/Ontologies/models/ValueTypeVersionId.md diff --git a/README.md b/README.md index 1520185a7..693c0051d 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` | @@ -1970,6 +1980,9 @@ Namespace | Name | Import | **MediaSets** | [BoundingBoxGeometry](docs/v2/MediaSets/models/BoundingBoxGeometry.md) | `from foundry_sdk.v2.media_sets.models import BoundingBoxGeometry` | **MediaSets** | [BranchName](docs/v2/MediaSets/models/BranchName.md) | `from foundry_sdk.v2.media_sets.models import BranchName` | **MediaSets** | [BranchRid](docs/v2/MediaSets/models/BranchRid.md) | `from foundry_sdk.v2.media_sets.models import BranchRid` | +**MediaSets** | [CadDecodeFormat](docs/v2/MediaSets/models/CadDecodeFormat.md) | `from foundry_sdk.v2.media_sets.models import CadDecodeFormat` | +**MediaSets** | [CadMediaItemMetadata](docs/v2/MediaSets/models/CadMediaItemMetadata.md) | `from foundry_sdk.v2.media_sets.models import CadMediaItemMetadata` | +**MediaSets** | [CadUnits](docs/v2/MediaSets/models/CadUnits.md) | `from foundry_sdk.v2.media_sets.models import CadUnits` | **MediaSets** | [ChatLlmSpec](docs/v2/MediaSets/models/ChatLlmSpec.md) | `from foundry_sdk.v2.media_sets.models import ChatLlmSpec` | **MediaSets** | [ChatLlmSpecWrapper](docs/v2/MediaSets/models/ChatLlmSpecWrapper.md) | `from foundry_sdk.v2.media_sets.models import ChatLlmSpecWrapper` | **MediaSets** | [Color](docs/v2/MediaSets/models/Color.md) | `from foundry_sdk.v2.media_sets.models import Color` | @@ -2166,6 +2179,7 @@ Namespace | Name | Import | **MediaSets** | [VideoToTextOperation](docs/v2/MediaSets/models/VideoToTextOperation.md) | `from foundry_sdk.v2.media_sets.models import VideoToTextOperation` | **MediaSets** | [VideoToTextTransformation](docs/v2/MediaSets/models/VideoToTextTransformation.md) | `from foundry_sdk.v2.media_sets.models import VideoToTextTransformation` | **MediaSets** | [VideoTransformation](docs/v2/MediaSets/models/VideoTransformation.md) | `from foundry_sdk.v2.media_sets.models import VideoTransformation` | +**MediaSets** | [VlmOutputFormat](docs/v2/MediaSets/models/VlmOutputFormat.md) | `from foundry_sdk.v2.media_sets.models import VlmOutputFormat` | **MediaSets** | [VlmPreprocessingConfig](docs/v2/MediaSets/models/VlmPreprocessingConfig.md) | `from foundry_sdk.v2.media_sets.models import VlmPreprocessingConfig` | **MediaSets** | [WaveformOperation](docs/v2/MediaSets/models/WaveformOperation.md) | `from foundry_sdk.v2.media_sets.models import WaveformOperation` | **MediaSets** | [WavEncodeFormat](docs/v2/MediaSets/models/WavEncodeFormat.md) | `from foundry_sdk.v2.media_sets.models import WavEncodeFormat` | @@ -2212,6 +2226,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 +2350,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 +2360,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 +2428,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 +2482,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 +2539,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` | @@ -2563,6 +2584,7 @@ Namespace | Name | Import | **Ontologies** | [InputObjectTypeRidActionTypesQueryV2](docs/v2/Ontologies/models/InputObjectTypeRidActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import InputObjectTypeRidActionTypesQueryV2` | **Ontologies** | [InQuery](docs/v2/Ontologies/models/InQuery.md) | `from foundry_sdk.v2.ontologies.models import InQuery` | **Ontologies** | [IntegerValue](docs/v2/Ontologies/models/IntegerValue.md) | `from foundry_sdk.v2.ontologies.models import IntegerValue` | +**Ontologies** | [InterfaceActionTypeConstraintApiName](docs/v2/Ontologies/models/InterfaceActionTypeConstraintApiName.md) | `from foundry_sdk.v2.ontologies.models import InterfaceActionTypeConstraintApiName` | **Ontologies** | [InterfaceDefinedPropertyType](docs/v2/Ontologies/models/InterfaceDefinedPropertyType.md) | `from foundry_sdk.v2.ontologies.models import InterfaceDefinedPropertyType` | **Ontologies** | [InterfaceLinkType](docs/v2/Ontologies/models/InterfaceLinkType.md) | `from foundry_sdk.v2.ontologies.models import InterfaceLinkType` | **Ontologies** | [InterfaceLinkTypeApiName](docs/v2/Ontologies/models/InterfaceLinkTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import InterfaceLinkTypeApiName` | @@ -2642,6 +2664,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 +2679,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 +2763,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 +2794,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 +2865,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 +2878,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 +2928,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 +2967,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 +2999,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 +3013,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 +3767,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 +3798,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 +3846,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` | @@ -3840,12 +3884,22 @@ Namespace | Name | Import | **MediaSets** | MissingMediaItemPath | `from foundry_sdk.v2.media_sets.errors import MissingMediaItemPath` | **MediaSets** | TemporaryMediaUploadInsufficientPermissions | `from foundry_sdk.v2.media_sets.errors import TemporaryMediaUploadInsufficientPermissions` | **MediaSets** | TemporaryMediaUploadUnknownFailure | `from foundry_sdk.v2.media_sets.errors import TemporaryMediaUploadUnknownFailure` | +**MediaSets** | TransformationDocumentExtractError | `from foundry_sdk.v2.media_sets.errors import TransformationDocumentExtractError` | **MediaSets** | TransformationImageTooLargeForOcr | `from foundry_sdk.v2.media_sets.errors import TransformationImageTooLargeForOcr` | +**MediaSets** | TransformationInputTooLarge | `from foundry_sdk.v2.media_sets.errors import TransformationInputTooLarge` | +**MediaSets** | TransformationInvalidPageRange | `from foundry_sdk.v2.media_sets.errors import TransformationInvalidPageRange` | +**MediaSets** | TransformationMediaSizeExceeded | `from foundry_sdk.v2.media_sets.errors import TransformationMediaSizeExceeded` | **MediaSets** | TransformationModelContextWindowExceeded | `from foundry_sdk.v2.media_sets.errors import TransformationModelContextWindowExceeded` | **MediaSets** | TransformationModelNotAvailable | `from foundry_sdk.v2.media_sets.errors import TransformationModelNotAvailable` | **MediaSets** | TransformationModelNotSupported | `from foundry_sdk.v2.media_sets.errors import TransformationModelNotSupported` | **MediaSets** | TransformationNotFound | `from foundry_sdk.v2.media_sets.errors import TransformationNotFound` | +**MediaSets** | TransformationPermissionDenied | `from foundry_sdk.v2.media_sets.errors import TransformationPermissionDenied` | **MediaSets** | TransformationUnavailable | `from foundry_sdk.v2.media_sets.errors import TransformationUnavailable` | +**MediaSets** | TransformationVlmError | `from foundry_sdk.v2.media_sets.errors import TransformationVlmError` | +**MediaSets** | TransformationVlmLayoutModelFailure | `from foundry_sdk.v2.media_sets.errors import TransformationVlmLayoutModelFailure` | +**MediaSets** | TransformationVlmMultiPageRequestUnsupported | `from foundry_sdk.v2.media_sets.errors import TransformationVlmMultiPageRequestUnsupported` | +**MediaSets** | TransformationVlmPageRangeRequired | `from foundry_sdk.v2.media_sets.errors import TransformationVlmPageRangeRequired` | +**MediaSets** | TransformationVlmResponseParseError | `from foundry_sdk.v2.media_sets.errors import TransformationVlmResponseParseError` | **MediaSets** | TransformedMediaItemNotFound | `from foundry_sdk.v2.media_sets.errors import TransformedMediaItemNotFound` | **MediaSets** | UnexpectedMetadataType | `from foundry_sdk.v2.media_sets.errors import UnexpectedMetadataType` | **MediaSets** | UnsupportedMetadata | `from foundry_sdk.v2.media_sets.errors import UnsupportedMetadata` | @@ -4002,6 +4056,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 +4391,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 3d17458e7..93fd67953 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.1732.0", "maxVersion": "1.x.x", "optional": false } diff --git a/docs-snippets-npm/src/index.ts b/docs-snippets-npm/src/index.ts index e46a0b2b5..031a9f65d 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.media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID.\nmedia_item_rid = None\n# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.\npreview = None\n\n\ntry:\n api_response = client.media_sets.MediaSet.upload_media(\n body,\n filename=filename,\n attribution=attribution,\n media_item_rid=media_item_rid,\n preview=preview,\n )\n print(\"The upload_media response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling MediaSet.upload_media: %s\\n\" % e)" + "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# bytes | Body of the request\nbody = None\n# MediaItemPath | A user-defined label for a media item within a media set. Required if the backing media set requires paths. Uploading multiple files to the same path will result in only the most recent file being associated with the path.\nfilename = \"my-file.png\"\n# Optional[Attribution] | used for passing through usage attribution\nattribution = None\n# Optional[MediaItemRid] | An optional RID to use for the media item to create. If omitted, the server will automatically generate a RID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your workflow strictly requires deterministic or client-controlled identifiers. The RID must be in the format of `ri.mio..media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID.\nmedia_item_rid = None\n\n\ntry:\n api_response = client.media_sets.MediaSet.upload_media(\n body, filename=filename, attribution=attribution, media_item_rid=media_item_rid\n )\n print(\"The upload_media response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling MediaSet.upload_media: %s\\n\" % e)" } ], "v2.getExperiment": [ @@ -1340,7 +1345,7 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets.media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. | [optional] | -**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | ### Return type **MediaReference** @@ -1206,17 +1193,11 @@ filename = "my-file.png" attribution = None # Optional[MediaItemRid] | An optional RID to use for the media item to create. If omitted, the server will automatically generate a RID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your workflow strictly requires deterministic or client-controlled identifiers. The RID must be in the format of `ri.mio..media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. media_item_rid = None -# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. -preview = None try: api_response = client.media_sets.MediaSet.upload_media( - body, - filename=filename, - attribution=attribution, - media_item_rid=media_item_rid, - preview=preview, + body, filename=filename, attribution=attribution, media_item_rid=media_item_rid ) print("The upload_media response:\n") pprint(api_response) diff --git a/docs/v2/MediaSets/models/CadDecodeFormat.md b/docs/v2/MediaSets/models/CadDecodeFormat.md new file mode 100644 index 000000000..87fafa335 --- /dev/null +++ b/docs/v2/MediaSets/models/CadDecodeFormat.md @@ -0,0 +1,10 @@ +# CadDecodeFormat + +The format of a CAD media item. + +| **Value** | +| --------- | +| `"STEP"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/MediaSets/models/CadMediaItemMetadata.md b/docs/v2/MediaSets/models/CadMediaItemMetadata.md new file mode 100644 index 000000000..32610a62f --- /dev/null +++ b/docs/v2/MediaSets/models/CadMediaItemMetadata.md @@ -0,0 +1,14 @@ +# CadMediaItemMetadata + +Metadata for CAD media items. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**format** | CadDecodeFormat | Yes | | +**size_bytes** | int | Yes | The size of the media item in bytes. | +**units** | Optional[CadUnits] | No | | +**type** | Literal["cad"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/MediaSets/models/CadUnits.md b/docs/v2/MediaSets/models/CadUnits.md new file mode 100644 index 000000000..ca3437c37 --- /dev/null +++ b/docs/v2/MediaSets/models/CadUnits.md @@ -0,0 +1,11 @@ +# CadUnits + +Units declared in a CAD file. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**length_unit** | Optional[str] | No | Raw declared length unit name, for example MILLIMETRE, METRE, INCH, or FOOT. Consumers should match case-insensitively and tolerate unknown values. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/MediaSets/models/ExtractVlmTextOperation.md b/docs/v2/MediaSets/models/ExtractVlmTextOperation.md index b1bf9a673..58b15c2fa 100644 --- a/docs/v2/MediaSets/models/ExtractVlmTextOperation.md +++ b/docs/v2/MediaSets/models/ExtractVlmTextOperation.md @@ -10,7 +10,7 @@ VLMs can understand document layout and structure more intelligently than tradit **llm_spec** | LlmSpec | Yes | | **preprocessing_configuration** | Optional[VlmPreprocessingConfig] | No | | **image_spec** | Optional[ImageSpec] | No | | -**output_format** | TextOutputFormat | Yes | | +**output_format** | VlmOutputFormat | Yes | | **page_range** | Optional[PageRange] | No | | **type** | Literal["extractVlmText"] | Yes | None | diff --git a/docs/v2/MediaSets/models/MediaItemMetadata.md b/docs/v2/MediaSets/models/MediaItemMetadata.md index dc10b61dc..42594f6ed 100644 --- a/docs/v2/MediaSets/models/MediaItemMetadata.md +++ b/docs/v2/MediaSets/models/MediaItemMetadata.md @@ -11,6 +11,7 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- +CadMediaItemMetadata | cad DocumentMediaItemMetadata | document ImageryMediaItemMetadata | imagery SpreadsheetMediaItemMetadata | spreadsheet diff --git a/docs/v2/MediaSets/models/MediaSchema.md b/docs/v2/MediaSets/models/MediaSchema.md index a52ad6bd3..6d340a929 100644 --- a/docs/v2/MediaSets/models/MediaSchema.md +++ b/docs/v2/MediaSets/models/MediaSchema.md @@ -5,6 +5,7 @@ The schema type of a media set, indicating what type of media items it can conta | **Value** | | --------- | | `"AUDIO"` | +| `"CAD"` | | `"DICOM"` | | `"DOCUMENT"` | | `"IMAGERY"` | diff --git a/docs/v2/MediaSets/models/VideoDecodeFormat.md b/docs/v2/MediaSets/models/VideoDecodeFormat.md index fb9278410..d12ec0679 100644 --- a/docs/v2/MediaSets/models/VideoDecodeFormat.md +++ b/docs/v2/MediaSets/models/VideoDecodeFormat.md @@ -8,6 +8,7 @@ The format of a video media item. | `"MKV"` | | `"MOV"` | | `"TS"` | +| `"WEBM"` | [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/MediaSets/models/VlmOutputFormat.md b/docs/v2/MediaSets/models/VlmOutputFormat.md new file mode 100644 index 000000000..1626ec52f --- /dev/null +++ b/docs/v2/MediaSets/models/VlmOutputFormat.md @@ -0,0 +1,10 @@ +# VlmOutputFormat + +Format in which to return text extracted by vision language models. + +| **Value** | +| --------- | +| `"MARKDOWN"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/LiveDeployment.md b/docs/v2/Models/LiveDeployment.md index d739a0c21..64daf8841 100644 --- a/docs/v2/Models/LiveDeployment.md +++ b/docs/v2/Models/LiveDeployment.md @@ -41,6 +41,7 @@ runtime_configuration = { "cpu": 1.0, "memory": "256MiB", "threadCount": 32, + "environmentVariables": {"LOG_LEVEL": "INFO"}, } # Optional[PreviewMode] | Enables the use of preview functionality. preview = None @@ -212,6 +213,7 @@ runtime_configuration = { "cpu": 1.0, "memory": "256MiB", "threadCount": 32, + "environmentVariables": {"LOG_LEVEL": "INFO"}, } # Optional[PreviewMode] | Enables the use of preview functionality. preview = None diff --git a/docs/v2/Models/models/CreateConfigValidationFailureReason.md b/docs/v2/Models/models/CreateConfigValidationFailureReason.md index 1651704a5..8cd62030f 100644 --- a/docs/v2/Models/models/CreateConfigValidationFailureReason.md +++ b/docs/v2/Models/models/CreateConfigValidationFailureReason.md @@ -16,11 +16,13 @@ MissingWorkerConfigOutputError | missingWorkerConfigOutput MissingRequiredDatasetColumnError | missingRequiredDatasetColumn MultiplePropertiesNotAllowedForTrainerError | multiplePropertiesNotAllowedForTrainer FieldValidationError | fieldValidationFailure +UnsupportedDatasetFieldTypeError | unsupportedDatasetFieldType ChangelogTooLongError | changelogTooLong UnknownColumnSpecIdInConfigColumnMappingError | unknownColumnSpecIdInConfigColumnMapping MultipleColumnsNotAllowedForTrainerError | multipleColumnsNotAllowedForTrainer MissingWorkerConfigInputDatasetColumnMappingError | missingWorkerConfigInputDatasetColumnMapping DatasetSchemaNotFoundError | datasetSchemaNotFound +InvalidWorkerConfigInputTypeError | invalidWorkerConfigInputType MissingWorkerConfigInputError | missingWorkerConfigInput MissingWorkerConfigInputObjectSetPropertyMappingError | missingWorkerConfigInputObjectSetPropertyMapping OutputResourceNotFoundError | outputResourceNotFound diff --git a/docs/v2/Models/models/InvalidWorkerConfigInputTypeError.md b/docs/v2/Models/models/InvalidWorkerConfigInputTypeError.md new file mode 100644 index 000000000..8c70fb7eb --- /dev/null +++ b/docs/v2/Models/models/InvalidWorkerConfigInputTypeError.md @@ -0,0 +1,14 @@ +# InvalidWorkerConfigInputTypeError + +A worker config input was provided with a type that does not match the expected type. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**input_alias** | InputAlias | Yes | The alias of the input with the mismatched type. | +**expected_type** | str | Yes | The type the trainer expected for the input. | +**actual_type** | str | Yes | The type that was actually provided. | +**type** | Literal["invalidWorkerConfigInputType"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/LiveDeploymentRuntimeConfiguration.md b/docs/v2/Models/models/LiveDeploymentRuntimeConfiguration.md index 72ee421e7..2bd21caab 100644 --- a/docs/v2/Models/models/LiveDeploymentRuntimeConfiguration.md +++ b/docs/v2/Models/models/LiveDeploymentRuntimeConfiguration.md @@ -13,6 +13,7 @@ The compute resource configuration for a live deployment, controlling replica sc **gpu** | Optional[LiveDeploymentGpu] | No | Optional GPU resources for the deployment. | **thread_count** | Optional[int] | No | The number of threads used for query handling. Defaults to 32 if not specified. Also affects how many concurrent requests will be sent to a single replica. | **scaling_configuration** | Optional[LiveDeploymentScalingConfiguration] | No | Autoscaling configuration for the deployment. Controls how the deployment scales replicas up and down based on load. | +**environment_variables** | Dict[str, str] | Yes | User-supplied environment variables to set on the deployment container, keyed by variable name. | [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/UnsupportedDatasetFieldTypeError.md b/docs/v2/Models/models/UnsupportedDatasetFieldTypeError.md new file mode 100644 index 000000000..3ef77bcc8 --- /dev/null +++ b/docs/v2/Models/models/UnsupportedDatasetFieldTypeError.md @@ -0,0 +1,14 @@ +# UnsupportedDatasetFieldTypeError + +A dataset field has a type that is not supported by the trainer. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | Yes | The RID of the dataset containing the unsupported field. | +**field_name** | Optional[str] | No | The name of the dataset field, if known. | +**field_type** | str | Yes | The unsupported field type. | +**type** | Literal["unsupportedDatasetFieldType"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/OntologyObject.md b/docs/v2/Ontologies/OntologyObject.md index ec1aeab18..84aa502e4 100644 --- a/docs/v2/Ontologies/OntologyObject.md +++ b/docs/v2/Ontologies/OntologyObject.md @@ -383,6 +383,7 @@ Name | Type | Description | Notes | **object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. | | **select** | List[PropertyApiName] | The API names of the object type properties to include in the response. | | **branch** | Optional[FoundryBranch] | 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. | [optional] | +**default_load_level** | Optional[PropertyLoadLevel] | | [optional] | **exclude_rid** | Optional[bool] | 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. | [optional] | **execute_in_memory_only** | Optional[bool] | 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. | [optional] | **order_by** | Optional[SearchOrderByV2] | | [optional] | @@ -415,6 +416,8 @@ object_type = "employee" select = None # Optional[FoundryBranch] | 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. branch = None +# Optional[PropertyLoadLevel] +default_load_level = None # Optional[bool] | 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. exclude_rid = None # Optional[bool] | 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. @@ -445,6 +448,7 @@ try: object_type, select=select, branch=branch, + default_load_level=default_load_level, exclude_rid=exclude_rid, execute_in_memory_only=execute_in_memory_only, order_by=order_by, diff --git a/docs/v2/Ontologies/OntologyObjectSet.md b/docs/v2/Ontologies/OntologyObjectSet.md index 2c7c1fadf..33e538c96 100644 --- a/docs/v2/Ontologies/OntologyObjectSet.md +++ b/docs/v2/Ontologies/OntologyObjectSet.md @@ -275,6 +275,7 @@ Name | Type | Description | Notes | **object_set** | ObjectSet | | | **select** | List[SelectedPropertyApiName] | | | **branch** | Optional[FoundryBranch] | 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. | [optional] | +**default_load_level** | Optional[PropertyLoadLevel] | | [optional] | **exclude_rid** | Optional[bool] | 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. | [optional] | **execute_in_memory_only** | Optional[bool] | 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. | [optional] | **include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] | @@ -312,6 +313,8 @@ object_set = {"type": "base", "objectType": "Employee"} select = None # Optional[FoundryBranch] | 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. branch = None +# Optional[PropertyLoadLevel] +default_load_level = None # Optional[bool] | 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. exclude_rid = None # Optional[bool] | 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. @@ -352,6 +355,7 @@ try: object_set=object_set, select=select, branch=branch, + default_load_level=default_load_level, exclude_rid=exclude_rid, execute_in_memory_only=execute_in_memory_only, include_compute_usage=include_compute_usage, @@ -520,6 +524,7 @@ Name | Type | Description | Notes | **object_set** | ObjectSet | | | **select** | List[SelectedPropertyApiName] | | | **branch** | Optional[FoundryBranch] | 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. | [optional] | +**default_load_level** | Optional[PropertyLoadLevel] | | [optional] | **exclude_rid** | Optional[bool] | 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. | [optional] | **execute_in_memory_only** | Optional[bool] | 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. | [optional] | **include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] | @@ -558,6 +563,8 @@ object_set = {"type": "base", "objectType": "Employee"} select = None # Optional[FoundryBranch] | 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. branch = None +# Optional[PropertyLoadLevel] +default_load_level = None # Optional[bool] | 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. exclude_rid = None # Optional[bool] | 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. @@ -600,6 +607,7 @@ try: object_set=object_set, select=select, branch=branch, + default_load_level=default_load_level, exclude_rid=exclude_rid, execute_in_memory_only=execute_in_memory_only, include_compute_usage=include_compute_usage, @@ -664,6 +672,7 @@ Name | Type | Description | Notes | **object_set** | ObjectSet | | | **select** | List[SelectedPropertyApiName] | | | **branch** | Optional[FoundryBranch] | 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. | [optional] | +**default_load_level** | Optional[PropertyLoadLevel] | | [optional] | **exclude_rid** | Optional[bool] | 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. | [optional] | **execute_in_memory_only** | Optional[bool] | 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. | [optional] | **order_by** | Optional[SearchOrderByV2] | | [optional] | @@ -700,6 +709,8 @@ object_set = {"type": "interfaceBase", "interfaceType": "Person"} select = None # Optional[FoundryBranch] | 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. branch = None +# Optional[PropertyLoadLevel] +default_load_level = None # Optional[bool] | 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. exclude_rid = None # Optional[bool] | 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. @@ -738,6 +749,7 @@ try: object_set=object_set, select=select, branch=branch, + default_load_level=default_load_level, exclude_rid=exclude_rid, execute_in_memory_only=execute_in_memory_only, order_by=order_by, diff --git a/docs/v2/Ontologies/Query.md b/docs/v2/Ontologies/Query.md index 49823239e..7ed4b1b90 100644 --- a/docs/v2/Ontologies/Query.md +++ b/docs/v2/Ontologies/Query.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes | **trace_parent** | Optional[TraceParent] | The W3C trace parent header included in the request. | [optional] | **trace_state** | Optional[TraceState] | The W3C trace state header included in the request. | [optional] | **transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. | [optional] | -**version** | Optional[FunctionVersion] | The version of the Query to execute. When used with `branch`, the specified version must exist on the branch. | [optional] | +**version** | Optional[FunctionVersion] | 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. | [optional] | ### Return type **ExecuteQueryResponse** @@ -62,7 +62,7 @@ trace_parent = None trace_state = None # Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. transaction_id = None -# Optional[FunctionVersion] | The version of the Query to execute. When used with `branch`, the specified version must exist on the branch. +# Optional[FunctionVersion] | 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. version = None diff --git a/docs/v2/Ontologies/QueryType.md b/docs/v2/Ontologies/QueryType.md index b5f720761..7fb7aa825 100644 --- a/docs/v2/Ontologies/QueryType.md +++ b/docs/v2/Ontologies/QueryType.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes | **query_api_name** | QueryApiName | The API name of the query type. To find the API name, use the **List query types** endpoint or check the **Ontology Manager**. | | **sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | **sdk_version** | Optional[SdkVersion] | The version of the generated SDK. | [optional] | -**version** | Optional[FunctionVersion] | The version of the Query to get. | [optional] | +**version** | Optional[FunctionVersion] | 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. | [optional] | ### Return type **QueryTypeV2** @@ -40,7 +40,7 @@ query_api_name = "getEmployeesInCity" sdk_package_rid = None # Optional[SdkVersion] | The version of the generated SDK. sdk_version = None -# Optional[FunctionVersion] | The version of the Query to get. +# Optional[FunctionVersion] | 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. version = None @@ -137,7 +137,10 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) # **list** -Lists the query types for the given Ontology. +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. diff --git a/docs/v2/Ontologies/models/ActionParameterV2.md b/docs/v2/Ontologies/models/ActionParameterV2.md index 18c762de5..ca77ff62f 100644 --- a/docs/v2/Ontologies/models/ActionParameterV2.md +++ b/docs/v2/Ontologies/models/ActionParameterV2.md @@ -10,6 +10,7 @@ Details about a parameter of an action. **data_type** | ActionParameterType | Yes | | **required** | bool | Yes | | **type_classes** | Optional[List[TypeClass]] | No | | +**validation** | Optional[ActionParameterValidation] | No | | [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ActionParameterValidation.md b/docs/v2/Ontologies/models/ActionParameterValidation.md new file mode 100644 index 000000000..0231a3679 --- /dev/null +++ b/docs/v2/Ontologies/models/ActionParameterValidation.md @@ -0,0 +1,11 @@ +# ActionParameterValidation + +Validation metadata surfaced for a parameter. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**default_validation** | ActionParameterValidationBlock | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ActionParameterValidationBlock.md b/docs/v2/Ontologies/models/ActionParameterValidationBlock.md new file mode 100644 index 000000000..d4c09c082 --- /dev/null +++ b/docs/v2/Ontologies/models/ActionParameterValidationBlock.md @@ -0,0 +1,12 @@ +# ActionParameterValidationBlock + +Validation constraints for a parameter. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**allowed_values** | Optional[ParameterAllowedValues] | No | | +**array_size** | Optional[ParameterArraySize] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AttachmentAllowedValues.md b/docs/v2/Ontologies/models/AttachmentAllowedValues.md new file mode 100644 index 000000000..fd0a08643 --- /dev/null +++ b/docs/v2/Ontologies/models/AttachmentAllowedValues.md @@ -0,0 +1,12 @@ +# AttachmentAllowedValues + +The parameter value (an attachment rid) must reference an attachment within the configured size limit. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**max_size_bytes** | Optional[SizeBytes] | No | | +**type** | Literal["attachment"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/DatetimeAllowedValues.md b/docs/v2/Ontologies/models/DatetimeAllowedValues.md new file mode 100644 index 000000000..52a945a82 --- /dev/null +++ b/docs/v2/Ontologies/models/DatetimeAllowedValues.md @@ -0,0 +1,15 @@ +# DatetimeAllowedValues + +The parameter value must fall within the specified date or timestamp range. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**gt** | Optional[ParameterDatetimeValue] | No | | +**gte** | Optional[ParameterDatetimeValue] | No | | +**lt** | Optional[ParameterDatetimeValue] | No | | +**lte** | Optional[ParameterDatetimeValue] | No | | +**type** | Literal["datetime"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/FixedDatetimeValue.md b/docs/v2/Ontologies/models/FixedDatetimeValue.md new file mode 100644 index 000000000..3715744de --- /dev/null +++ b/docs/v2/Ontologies/models/FixedDatetimeValue.md @@ -0,0 +1,12 @@ +# FixedDatetimeValue + +An absolute datetime bound (ISO 8601 timestamp or date string). + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | ParameterConstraintValue | Yes | | +**type** | Literal["fixed"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/InterfaceActionTypeConstraintApiName.md b/docs/v2/Ontologies/models/InterfaceActionTypeConstraintApiName.md new file mode 100644 index 000000000..896bc3b3c --- /dev/null +++ b/docs/v2/Ontologies/models/InterfaceActionTypeConstraintApiName.md @@ -0,0 +1,13 @@ +# InterfaceActionTypeConstraintApiName + +The name in the API of an action defined on an interface that implementing object types provide a concrete +action type for. + + +## Type +```python +str +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/LoadObjectSetRequestV2.md b/docs/v2/Ontologies/models/LoadObjectSetRequestV2.md index 30f511f09..9f3b5918a 100644 --- a/docs/v2/Ontologies/models/LoadObjectSetRequestV2.md +++ b/docs/v2/Ontologies/models/LoadObjectSetRequestV2.md @@ -9,6 +9,7 @@ Represents the API POST body when loading an `ObjectSet`. **order_by** | Optional[SearchOrderByV2] | No | | **select** | List[SelectedPropertyApiName] | Yes | | **select_v2** | Optional[List[PropertyIdentifier]] | No | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | +**default_load_level** | Optional[PropertyLoadLevel] | No | | **page_token** | Optional[PageToken] | No | | **page_size** | Optional[PageSize] | No | | **exclude_rid** | Optional[bool] | No | 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. | diff --git a/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesRequest.md b/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesRequest.md index 2e6f34c6f..254c7d056 100644 --- a/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesRequest.md +++ b/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesRequest.md @@ -10,6 +10,7 @@ Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObje **order_by** | Optional[SearchOrderByV2] | No | | **select** | List[SelectedPropertyApiName] | Yes | | **select_v2** | Optional[List[PropertyIdentifier]] | No | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | +**default_load_level** | Optional[PropertyLoadLevel] | No | | **page_token** | Optional[PageToken] | No | | **page_size** | Optional[PageSize] | No | | **exclude_rid** | Optional[bool] | No | 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. | diff --git a/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesRequest.md b/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesRequest.md index 7d328986b..2bb167a61 100644 --- a/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesRequest.md +++ b/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesRequest.md @@ -10,6 +10,7 @@ Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObje **order_by** | Optional[SearchOrderByV2] | No | | **select** | List[SelectedPropertyApiName] | Yes | | **select_v2** | Optional[List[PropertyIdentifier]] | No | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | +**default_load_level** | Optional[PropertyLoadLevel] | No | | **page_token** | Optional[PageToken] | No | | **page_size** | Optional[PageSize] | No | | **exclude_rid** | Optional[bool] | No | 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. | diff --git a/docs/v2/Ontologies/models/MarkdownAllowedValues.md b/docs/v2/Ontologies/models/MarkdownAllowedValues.md new file mode 100644 index 000000000..5f6ee0985 --- /dev/null +++ b/docs/v2/Ontologies/models/MarkdownAllowedValues.md @@ -0,0 +1,13 @@ +# MarkdownAllowedValues + +The parameter value (a markdown-formatted string) must satisfy the configured length bounds. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**gte** | Optional[int] | No | Character length greater than or equal. | +**lte** | Optional[int] | No | Character length less than or equal. | +**type** | Literal["markdown"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/MustBeEmptyAllowedValues.md b/docs/v2/Ontologies/models/MustBeEmptyAllowedValues.md new file mode 100644 index 000000000..5765cc8ed --- /dev/null +++ b/docs/v2/Ontologies/models/MustBeEmptyAllowedValues.md @@ -0,0 +1,11 @@ +# MustBeEmptyAllowedValues + +The parameter must be omitted or empty. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["mustBeEmpty"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/NoLoadLevel.md b/docs/v2/Ontologies/models/NoLoadLevel.md new file mode 100644 index 000000000..8a01008d0 --- /dev/null +++ b/docs/v2/Ontologies/models/NoLoadLevel.md @@ -0,0 +1,14 @@ +# NoLoadLevel + +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`. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["noLoadLevel"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/NowDatetimeValue.md b/docs/v2/Ontologies/models/NowDatetimeValue.md new file mode 100644 index 000000000..32d7219d2 --- /dev/null +++ b/docs/v2/Ontologies/models/NowDatetimeValue.md @@ -0,0 +1,11 @@ +# NowDatetimeValue + +The current evaluation time itself. Carries no fields. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["now"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetStreamSubscribeRequest.md b/docs/v2/Ontologies/models/ObjectSetStreamSubscribeRequest.md index fa3a63475..03ea9c12e 100644 --- a/docs/v2/Ontologies/models/ObjectSetStreamSubscribeRequest.md +++ b/docs/v2/Ontologies/models/ObjectSetStreamSubscribeRequest.md @@ -1,11 +1,15 @@ # ObjectSetStreamSubscribeRequest -ObjectSetStreamSubscribeRequest +`branch` identifies the Foundry branch. `scenarioRid` identifies the Ontology Scenario. +If a scenario is based on a non-default branch, `branch` must identify that non-default base branch. + ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **object_set** | ObjectSet | Yes | | +**branch** | Optional[FoundryBranch] | No | | +**scenario_rid** | Optional[OntologyScenarioRid] | No | | **property_set** | List[SelectedPropertyApiName] | Yes | | **reference_set** | List[SelectedPropertyApiName] | Yes | | **object_loading_response_options** | Optional[ObjectLoadingResponseOptions] | No | | diff --git a/docs/v2/Ontologies/models/ObjectTypeInterfaceImplementation.md b/docs/v2/Ontologies/models/ObjectTypeInterfaceImplementation.md index b1f53df43..41bd54588 100644 --- a/docs/v2/Ontologies/models/ObjectTypeInterfaceImplementation.md +++ b/docs/v2/Ontologies/models/ObjectTypeInterfaceImplementation.md @@ -10,6 +10,7 @@ ObjectTypeInterfaceImplementation **properties** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | | **properties_v2** | Dict[InterfacePropertyApiName, InterfacePropertyTypeImplementation] | Yes | | **links** | Dict[InterfaceLinkTypeApiName, List[LinkTypeApiName]] | Yes | | +**action_types** | Dict[InterfaceActionTypeConstraintApiName, ActionTypeApiName] | Yes | A map from interface action type constraint API name to the API name of the concrete action type on this object type that implements it. Action types the caller is not authorized to access are omitted, so this map may not cover every action type constraint declared on the interface. | [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OneOfAllowedValues.md b/docs/v2/Ontologies/models/OneOfAllowedValues.md new file mode 100644 index 000000000..4221ed0c4 --- /dev/null +++ b/docs/v2/Ontologies/models/OneOfAllowedValues.md @@ -0,0 +1,13 @@ +# OneOfAllowedValues + +The parameter value must be one of a fixed set of labelled options. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**options** | List[ParameterAllowedValueOption] | Yes | The predefined set of options. | +**other_values_allowed** | bool | Yes | Whether values outside `options` are allowed. | +**type** | Literal["oneOf"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ParameterAllowedValueOption.md b/docs/v2/Ontologies/models/ParameterAllowedValueOption.md new file mode 100644 index 000000000..601c649b1 --- /dev/null +++ b/docs/v2/Ontologies/models/ParameterAllowedValueOption.md @@ -0,0 +1,12 @@ +# ParameterAllowedValueOption + +A possible value for the parameter. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**display_name** | DisplayName | Yes | | +**value** | DataValue | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ParameterAllowedValues.md b/docs/v2/Ontologies/models/ParameterAllowedValues.md new file mode 100644 index 000000000..9062fe05b --- /dev/null +++ b/docs/v2/Ontologies/models/ParameterAllowedValues.md @@ -0,0 +1,22 @@ +# ParameterAllowedValues + +The allowed-values constraint configured on an action parameter. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +OneOfAllowedValues | oneOf +DatetimeAllowedValues | datetime +AttachmentAllowedValues | attachment +ValueTypeAllowedValues | valueType +MarkdownAllowedValues | markdown +RangeAllowedValues | range +MustBeEmptyAllowedValues | mustBeEmpty +TextAllowedValues | text + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ParameterArraySize.md b/docs/v2/Ontologies/models/ParameterArraySize.md new file mode 100644 index 000000000..bb6454e9d --- /dev/null +++ b/docs/v2/Ontologies/models/ParameterArraySize.md @@ -0,0 +1,12 @@ +# ParameterArraySize + +Bounds on the size of an array-typed parameter. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**gte** | Optional[int] | No | Greater than or equal. | +**lte** | Optional[int] | No | Less than or equal. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ParameterConstraintValue.md b/docs/v2/Ontologies/models/ParameterConstraintValue.md new file mode 100644 index 000000000..e7da81ecc --- /dev/null +++ b/docs/v2/Ontologies/models/ParameterConstraintValue.md @@ -0,0 +1,11 @@ +# ParameterConstraintValue + +The source of a constraint bound value. + +## Type +```python +StaticConstraintValue +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ParameterDatetimeValue.md b/docs/v2/Ontologies/models/ParameterDatetimeValue.md new file mode 100644 index 000000000..3fe67d7db --- /dev/null +++ b/docs/v2/Ontologies/models/ParameterDatetimeValue.md @@ -0,0 +1,17 @@ +# ParameterDatetimeValue + +A datetime bound value. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +NowDatetimeValue | now +FixedDatetimeValue | fixed +RelativeDatetimeValue | relative + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ParameterEvaluationResult.md b/docs/v2/Ontologies/models/ParameterEvaluationResult.md index 0881520b3..09d12aeb5 100644 --- a/docs/v2/Ontologies/models/ParameterEvaluationResult.md +++ b/docs/v2/Ontologies/models/ParameterEvaluationResult.md @@ -8,6 +8,7 @@ Represents the validity of a parameter against the configured constraints. **result** | ValidationResult | Yes | | **evaluated_constraints** | List[ParameterEvaluatedConstraint] | Yes | | **required** | bool | Yes | Represents whether the parameter is a required input to the action. | +**default_value** | Optional[DataValue] | No | | [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/PropertyLoadLevel.md b/docs/v2/Ontologies/models/PropertyLoadLevel.md index ae8ce4d3c..ebb828925 100644 --- a/docs/v2/Ontologies/models/PropertyLoadLevel.md +++ b/docs/v2/Ontologies/models/PropertyLoadLevel.md @@ -4,6 +4,7 @@ The load level of the property: - 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. This is a discriminator type and does not contain any fields. Instead, it is a union @@ -16,6 +17,7 @@ This discriminator class uses the `type` field to differentiate between classes. ApplyReducersAndExtractMainValueLoadLevel | applyReducersAndExtractMainValue ApplyReducersLoadLevel | applyReducers ExtractMainValueLoadLevel | extractMainValue +NoLoadLevel | noLoadLevel [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/RangeAllowedValues.md b/docs/v2/Ontologies/models/RangeAllowedValues.md new file mode 100644 index 000000000..b6eb4a52e --- /dev/null +++ b/docs/v2/Ontologies/models/RangeAllowedValues.md @@ -0,0 +1,16 @@ +# RangeAllowedValues + +The parameter value must fall within the specified numeric range. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**gt** | Optional[ParameterConstraintValue] | No | | +**gte** | Optional[ParameterConstraintValue] | No | | +**lt** | Optional[ParameterConstraintValue] | No | | +**lte** | Optional[ParameterConstraintValue] | No | | +**type** | Literal["range"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/RelativeDatetimeDuration.md b/docs/v2/Ontologies/models/RelativeDatetimeDuration.md new file mode 100644 index 000000000..5efd4c127 --- /dev/null +++ b/docs/v2/Ontologies/models/RelativeDatetimeDuration.md @@ -0,0 +1,11 @@ +# RelativeDatetimeDuration + +The magnitude of a relative datetime offset. + +## Type +```python +Long +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/RelativeDatetimeTense.md b/docs/v2/Ontologies/models/RelativeDatetimeTense.md new file mode 100644 index 000000000..294a9d0f0 --- /dev/null +++ b/docs/v2/Ontologies/models/RelativeDatetimeTense.md @@ -0,0 +1,11 @@ +# RelativeDatetimeTense + +Direction of a relative datetime offset. + +| **Value** | +| --------- | +| `"FUTURE"` | +| `"PAST"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/RelativeDatetimeUnit.md b/docs/v2/Ontologies/models/RelativeDatetimeUnit.md new file mode 100644 index 000000000..5f31ccb1a --- /dev/null +++ b/docs/v2/Ontologies/models/RelativeDatetimeUnit.md @@ -0,0 +1,14 @@ +# RelativeDatetimeUnit + +Time unit for relative datetime offsets. + +| **Value** | +| --------- | +| `"SECOND"` | +| `"MINUTE"` | +| `"HOUR"` | +| `"DAY"` | +| `"WEEK"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/RelativeDatetimeValue.md b/docs/v2/Ontologies/models/RelativeDatetimeValue.md new file mode 100644 index 000000000..586705f5c --- /dev/null +++ b/docs/v2/Ontologies/models/RelativeDatetimeValue.md @@ -0,0 +1,14 @@ +# RelativeDatetimeValue + +A datetime expressed as an offset from the current time. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**duration** | RelativeDatetimeDuration | Yes | | +**unit** | RelativeDatetimeUnit | Yes | | +**tense** | RelativeDatetimeTense | Yes | | +**type** | Literal["relative"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SearchObjectsRequestV2.md b/docs/v2/Ontologies/models/SearchObjectsRequestV2.md index 33e158a3a..2b3216a77 100644 --- a/docs/v2/Ontologies/models/SearchObjectsRequestV2.md +++ b/docs/v2/Ontologies/models/SearchObjectsRequestV2.md @@ -11,6 +11,7 @@ SearchObjectsRequestV2 **page_token** | Optional[PageToken] | No | | **select** | List[PropertyApiName] | Yes | The API names of the object type properties to include in the response. | **select_v2** | Optional[List[PropertyIdentifier]] | No | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | +**default_load_level** | Optional[PropertyLoadLevel] | No | | **exclude_rid** | Optional[bool] | No | 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. | **snapshot** | Optional[bool] | No | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. | **reference_signing_options** | Optional[ReferenceSigningOptions] | No | | diff --git a/docs/v2/Ontologies/models/StaticConstraintValue.md b/docs/v2/Ontologies/models/StaticConstraintValue.md new file mode 100644 index 000000000..584dcaef4 --- /dev/null +++ b/docs/v2/Ontologies/models/StaticConstraintValue.md @@ -0,0 +1,12 @@ +# StaticConstraintValue + +A literal constraint value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | DataValue | Yes | | +**type** | Literal["static"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/TextAllowedValues.md b/docs/v2/Ontologies/models/TextAllowedValues.md new file mode 100644 index 000000000..8a54c1633 --- /dev/null +++ b/docs/v2/Ontologies/models/TextAllowedValues.md @@ -0,0 +1,17 @@ +# TextAllowedValues + +The parameter value (a string) must satisfy the configured length bounds and/or regex +pattern. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**gte** | Optional[int] | No | Character length greater than or equal. | +**lte** | Optional[int] | No | Character length less than or equal. | +**regex** | Optional[str] | No | The regular expression. Format and supported syntax match Elasticsearch regex semantics. | +**configured_failure_message** | Optional[str] | No | Message returned when the value does not match the pattern. | +**type** | Literal["text"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ValueTypeAllowedValues.md b/docs/v2/Ontologies/models/ValueTypeAllowedValues.md new file mode 100644 index 000000000..18e4f1220 --- /dev/null +++ b/docs/v2/Ontologies/models/ValueTypeAllowedValues.md @@ -0,0 +1,14 @@ +# ValueTypeAllowedValues + +The parameter value must conform to the referenced value type. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**api_name** | ValueTypeApiName | Yes | | +**rid** | ValueTypeRid | Yes | | +**version_id** | ValueTypeVersionId | Yes | | +**type** | Literal["valueType"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ValueTypeVersionId.md b/docs/v2/Ontologies/models/ValueTypeVersionId.md new file mode 100644 index 000000000..ec4127e82 --- /dev/null +++ b/docs/v2/Ontologies/models/ValueTypeVersionId.md @@ -0,0 +1,11 @@ +# ValueTypeVersionId + +ValueTypeVersionId + +## Type +```python +UUID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/foundry_sdk/_version.py b/foundry_sdk/_version.py index d8a578b08..64fb828c6 100644 --- a/foundry_sdk/_version.py +++ b/foundry_sdk/_version.py @@ -17,4 +17,4 @@ # using the autorelease bot __version__ = "0.0.0" -__openapi_document_version__ = "1.1697.0" +__openapi_document_version__ = "1.1732.0" diff --git a/foundry_sdk/v1/ontologies/errors.py b/foundry_sdk/v1/ontologies/errors.py index afbf3228f..38a784a06 100644 --- a/foundry_sdk/v1/ontologies/errors.py +++ b/foundry_sdk/v1/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/v1/ontologies/models.py b/foundry_sdk/v1/ontologies/models.py index f5ebb870e..e897a8483 100644 --- a/foundry_sdk/v1/ontologies/models.py +++ b/foundry_sdk/v1/ontologies/models.py @@ -975,6 +975,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 """ diff --git a/foundry_sdk/v2/cli.py b/foundry_sdk/v2/cli.py index 314ca8072..f7a16b055 100644 --- a/foundry_sdk/v2/cli.py +++ b/foundry_sdk/v2/cli.py @@ -4998,6 +4998,36 @@ def filesystem_resource_op_get_by_path_batch( click.echo(repr(result)) +@filesystem_resource.command("get_recently_viewed") +@click.option( + "--limit", + type=int, + required=False, + help="""The maximum number of recently viewed resources to return. Defaults to 100, +with a maximum of 100. Values above 100 are clamped to 100. +""", +) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) +@click.pass_obj +def filesystem_resource_op_get_recently_viewed( + client: FoundryClient, + limit: typing.Optional[int], + preview: typing.Optional[bool], +): + """ + 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. + + """ + result = client.filesystem.Resource.get_recently_viewed( + limit=limit, + preview=preview, + ) + click.echo(repr(result)) + + @filesystem_resource.command("markings") @click.argument("resource_rid", type=str, required=True) @click.option( @@ -5748,6 +5778,13 @@ def functions_query(): When provided with `version`, the specified version must exist on the branch. """, ) +@click.option("--include_prerelease", type=bool, required=False, help="""""") +@click.option( + "--latest_version_resolution", + type=click.Choice(["PUBLISH_TIME", "SEMANTIC_VERSION"]), + required=False, + help="""""", +) @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @@ -5773,6 +5810,8 @@ def functions_query_op_execute( parameters: str, attribution: typing.Optional[str], branch: typing.Optional[str], + include_prerelease: typing.Optional[bool], + latest_version_resolution: typing.Optional[typing.Literal["PUBLISH_TIME", "SEMANTIC_VERSION"]], preview: typing.Optional[bool], trace_parent: typing.Optional[str], trace_state: typing.Optional[str], @@ -5781,8 +5820,9 @@ def functions_query_op_execute( ): """ 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 @@ -5795,6 +5835,8 @@ def functions_query_op_execute( parameters=json.loads(parameters), attribution=attribution, branch=branch, + include_prerelease=include_prerelease, + latest_version_resolution=latest_version_resolution, preview=preview, trace_parent=trace_parent, trace_state=trace_state, @@ -5817,6 +5859,13 @@ def functions_query_op_execute( When provided with `version`, the specified version must exist on the branch. """, ) +@click.option("--include_prerelease", type=bool, required=False, help="""""") +@click.option( + "--latest_version_resolution", + type=click.Choice(["PUBLISH_TIME", "SEMANTIC_VERSION"]), + required=False, + help="""""", +) @click.option( "--ontology", type=str, @@ -5850,6 +5899,8 @@ def functions_query_op_execute_async( parameters: str, attribution: typing.Optional[str], branch: typing.Optional[str], + include_prerelease: typing.Optional[bool], + latest_version_resolution: typing.Optional[typing.Literal["PUBLISH_TIME", "SEMANTIC_VERSION"]], ontology: typing.Optional[str], preview: typing.Optional[bool], trace_parent: typing.Optional[str], @@ -5870,6 +5921,8 @@ def functions_query_op_execute_async( parameters=json.loads(parameters), attribution=attribution, branch=branch, + include_prerelease=include_prerelease, + latest_version_resolution=latest_version_resolution, ontology=ontology, preview=preview, trace_parent=trace_parent, @@ -5882,6 +5935,13 @@ def functions_query_op_execute_async( @functions_query.command("get") @click.argument("query_api_name", type=str, required=True) +@click.option("--include_prerelease", type=bool, required=False, help="""""") +@click.option( + "--latest_version_resolution", + type=click.Choice(["PUBLISH_TIME", "SEMANTIC_VERSION"]), + required=False, + help="""""", +) @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @@ -5890,15 +5950,21 @@ def functions_query_op_execute_async( def functions_query_op_get( client: FoundryClient, query_api_name: str, + include_prerelease: typing.Optional[bool], + latest_version_resolution: typing.Optional[typing.Literal["PUBLISH_TIME", "SEMANTIC_VERSION"]], preview: typing.Optional[bool], version: typing.Optional[str], ): """ - 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`. """ result = client.functions.Query.get( query_api_name=query_api_name, + include_prerelease=include_prerelease, + latest_version_resolution=latest_version_resolution, preview=preview, version=version, ) @@ -5982,6 +6048,13 @@ def functions_query_op_get_by_rid_batch( When provided with `version`, the specified version must exist on the branch. """, ) +@click.option("--include_prerelease", type=bool, required=False, help="""""") +@click.option( + "--latest_version_resolution", + type=click.Choice(["PUBLISH_TIME", "SEMANTIC_VERSION"]), + required=False, + help="""""", +) @click.option( "--ontology", type=str, @@ -6015,6 +6088,8 @@ def functions_query_op_streaming_execute( parameters: str, attribution: typing.Optional[str], branch: typing.Optional[str], + include_prerelease: typing.Optional[bool], + latest_version_resolution: typing.Optional[typing.Literal["PUBLISH_TIME", "SEMANTIC_VERSION"]], ontology: typing.Optional[str], preview: typing.Optional[bool], trace_parent: typing.Optional[str], @@ -6024,8 +6099,9 @@ def functions_query_op_streaming_execute( ): """ 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 @@ -6048,6 +6124,8 @@ def functions_query_op_streaming_execute( parameters=json.loads(parameters), attribution=attribution, branch=branch, + include_prerelease=include_prerelease, + latest_version_resolution=latest_version_resolution, ontology=ontology, preview=preview, trace_parent=trace_parent, @@ -6071,6 +6149,13 @@ def functions_query_op_streaming_execute( When provided with `version`, the specified version must exist on the branch. """, ) +@click.option("--include_prerelease", type=bool, required=False, help="""""") +@click.option( + "--latest_version_resolution", + type=click.Choice(["PUBLISH_TIME", "SEMANTIC_VERSION"]), + required=False, + help="""""", +) @click.option( "--ontology", type=str, @@ -6104,6 +6189,8 @@ def functions_query_op_streaming_execute_events( parameters: str, attribution: typing.Optional[str], branch: typing.Optional[str], + include_prerelease: typing.Optional[bool], + latest_version_resolution: typing.Optional[typing.Literal["PUBLISH_TIME", "SEMANTIC_VERSION"]], ontology: typing.Optional[str], preview: typing.Optional[bool], trace_parent: typing.Optional[str], @@ -6113,8 +6200,9 @@ def functions_query_op_streaming_execute_events( ): """ 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 @@ -6137,6 +6225,8 @@ def functions_query_op_streaming_execute_events( parameters=json.loads(parameters), attribution=attribution, branch=branch, + include_prerelease=include_prerelease, + latest_version_resolution=latest_version_resolution, ontology=ontology, preview=preview, trace_parent=trace_parent, @@ -6770,20 +6860,12 @@ def media_sets_media_set_op_get_status( @media_sets_media_set.command("info") @click.argument("media_set_rid", type=str, required=True) @click.argument("media_item_rid", type=str, required=True) -@click.option( - "--preview", - type=bool, - required=False, - help="""A boolean flag that, when set to true, enables the use of beta features in preview mode. -""", -) @click.option("--read_token", type=str, required=False, help="""""") @click.pass_obj def media_sets_media_set_op_info( client: FoundryClient, media_set_rid: str, media_item_rid: str, - preview: typing.Optional[bool], read_token: typing.Optional[str], ): """ @@ -6793,7 +6875,6 @@ def media_sets_media_set_op_info( result = client.media_sets.MediaSet.info( media_set_rid=media_set_rid, media_item_rid=media_item_rid, - preview=preview, read_token=read_token, ) click.echo(repr(result)) @@ -6802,20 +6883,12 @@ def media_sets_media_set_op_info( @media_sets_media_set.command("metadata") @click.argument("media_set_rid", type=str, required=True) @click.argument("media_item_rid", type=str, required=True) -@click.option( - "--preview", - type=bool, - required=False, - help="""A boolean flag that, when set to true, enables the use of beta features in preview mode. -""", -) @click.option("--read_token", type=str, required=False, help="""""") @click.pass_obj def media_sets_media_set_op_metadata( client: FoundryClient, media_set_rid: str, media_item_rid: str, - preview: typing.Optional[bool], read_token: typing.Optional[str], ): """ @@ -6826,7 +6899,6 @@ def media_sets_media_set_op_metadata( result = client.media_sets.MediaSet.metadata( media_set_rid=media_set_rid, media_item_rid=media_item_rid, - preview=preview, read_token=read_token, ) click.echo(repr(result)) @@ -6835,20 +6907,12 @@ def media_sets_media_set_op_metadata( @media_sets_media_set.command("read") @click.argument("media_set_rid", type=str, required=True) @click.argument("media_item_rid", type=str, required=True) -@click.option( - "--preview", - type=bool, - required=False, - help="""A boolean flag that, when set to true, enables the use of beta features in preview mode. -""", -) @click.option("--read_token", type=str, required=False, help="""""") @click.pass_obj def media_sets_media_set_op_read( client: FoundryClient, media_set_rid: str, media_item_rid: str, - preview: typing.Optional[bool], read_token: typing.Optional[str], ): """ @@ -6858,7 +6922,6 @@ def media_sets_media_set_op_read( result = client.media_sets.MediaSet.read( media_set_rid=media_set_rid, media_item_rid=media_item_rid, - preview=preview, read_token=read_token, ) click.echo(result) @@ -6867,20 +6930,12 @@ def media_sets_media_set_op_read( @media_sets_media_set.command("read_original") @click.argument("media_set_rid", type=str, required=True) @click.argument("media_item_rid", type=str, required=True) -@click.option( - "--preview", - type=bool, - required=False, - help="""A boolean flag that, when set to true, enables the use of beta features in preview mode. -""", -) @click.option("--read_token", type=str, required=False, help="""""") @click.pass_obj def media_sets_media_set_op_read_original( client: FoundryClient, media_set_rid: str, media_item_rid: str, - preview: typing.Optional[bool], read_token: typing.Optional[str], ): """ @@ -6890,7 +6945,6 @@ def media_sets_media_set_op_read_original( result = client.media_sets.MediaSet.read_original( media_set_rid=media_set_rid, media_item_rid=media_item_rid, - preview=preview, read_token=read_token, ) click.echo(result) @@ -7185,13 +7239,6 @@ def media_sets_media_set_op_upload( A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. """, ) -@click.option( - "--preview", - type=bool, - required=False, - help="""A boolean flag that, when set to true, enables the use of beta features in preview mode. -""", -) @click.pass_obj def media_sets_media_set_op_upload_media( client: FoundryClient, @@ -7199,7 +7246,6 @@ def media_sets_media_set_op_upload_media( filename: str, attribution: typing.Optional[str], media_item_rid: typing.Optional[str], - preview: typing.Optional[bool], ): """ Uploads a temporary media item. If the media item isn't persisted within 1 hour, the item will be deleted. @@ -7215,7 +7261,6 @@ def media_sets_media_set_op_upload_media( filename=filename, attribution=attribution, media_item_rid=media_item_rid, - preview=preview, ) click.echo(repr(result)) @@ -8583,7 +8628,9 @@ def ontologies_query(): "--version", type=str, required=False, - help="""The version of the Query to execute. When used with `branch`, the specified version must exist on the branch. + help="""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. """, ) @click.pass_obj @@ -9278,6 +9325,7 @@ def ontologies_ontology_object_set_op_get( Branches are an experimental feature and not all workflows are supported. """, ) +@click.option("--default_load_level", type=str, required=False, help="""""") @click.option( "--exclude_rid", type=bool, @@ -9381,6 +9429,7 @@ def ontologies_ontology_object_set_op_load( object_set: str, select: str, branch: typing.Optional[str], + default_load_level: typing.Optional[str], exclude_rid: typing.Optional[bool], execute_in_memory_only: typing.Optional[bool], include_compute_usage: typing.Optional[bool], @@ -9414,6 +9463,7 @@ def ontologies_ontology_object_set_op_load( object_set=json.loads(object_set), select=json.loads(select), branch=branch, + default_load_level=None if default_load_level is None else json.loads(default_load_level), exclude_rid=exclude_rid, execute_in_memory_only=execute_in_memory_only, include_compute_usage=include_compute_usage, @@ -9558,6 +9608,7 @@ def ontologies_ontology_object_set_op_load_links( Branches are an experimental feature and not all workflows are supported. """, ) +@click.option("--default_load_level", type=str, required=False, help="""""") @click.option( "--exclude_rid", type=bool, @@ -9668,6 +9719,7 @@ def ontologies_ontology_object_set_op_load_multiple_object_types( object_set: str, select: str, branch: typing.Optional[str], + default_load_level: typing.Optional[str], exclude_rid: typing.Optional[bool], execute_in_memory_only: typing.Optional[bool], include_compute_usage: typing.Optional[bool], @@ -9707,6 +9759,7 @@ def ontologies_ontology_object_set_op_load_multiple_object_types( object_set=json.loads(object_set), select=json.loads(select), branch=branch, + default_load_level=None if default_load_level is None else json.loads(default_load_level), exclude_rid=exclude_rid, execute_in_memory_only=execute_in_memory_only, include_compute_usage=include_compute_usage, @@ -9742,6 +9795,7 @@ def ontologies_ontology_object_set_op_load_multiple_object_types( Branches are an experimental feature and not all workflows are supported. """, ) +@click.option("--default_load_level", type=str, required=False, help="""""") @click.option( "--exclude_rid", type=bool, @@ -9840,6 +9894,7 @@ def ontologies_ontology_object_set_op_load_objects_or_interfaces( object_set: str, select: str, branch: typing.Optional[str], + default_load_level: typing.Optional[str], exclude_rid: typing.Optional[bool], execute_in_memory_only: typing.Optional[bool], order_by: typing.Optional[str], @@ -9879,6 +9934,7 @@ def ontologies_ontology_object_set_op_load_objects_or_interfaces( object_set=json.loads(object_set), select=json.loads(select), branch=branch, + default_load_level=None if default_load_level is None else json.loads(default_load_level), exclude_rid=exclude_rid, execute_in_memory_only=execute_in_memory_only, order_by=None if order_by is None else json.loads(order_by), @@ -10224,6 +10280,7 @@ def ontologies_ontology_object_op_list( Branches are an experimental feature and not all workflows are supported. """, ) +@click.option("--default_load_level", type=str, required=False, help="""""") @click.option( "--exclude_rid", type=bool, @@ -10287,6 +10344,7 @@ def ontologies_ontology_object_op_search( object_type: str, select: str, branch: typing.Optional[str], + default_load_level: typing.Optional[str], exclude_rid: typing.Optional[bool], execute_in_memory_only: typing.Optional[bool], order_by: typing.Optional[str], @@ -10330,6 +10388,7 @@ def ontologies_ontology_object_op_search( object_type=object_type, select=json.loads(select), branch=branch, + default_load_level=None if default_load_level is None else json.loads(default_load_level), exclude_rid=exclude_rid, execute_in_memory_only=execute_in_memory_only, order_by=None if order_by is None else json.loads(order_by), @@ -11115,7 +11174,8 @@ def ontologies_ontology_query_type(): "--version", type=str, required=False, - help="""The version of the Query to get. + help="""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. """, ) @click.pass_obj @@ -11215,6 +11275,9 @@ def ontologies_ontology_query_type_op_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. diff --git a/foundry_sdk/v2/data_health/models.py b/foundry_sdk/v2/data_health/models.py index 85c11e82e..688be9fd4 100644 --- a/foundry_sdk/v2/data_health/models.py +++ b/foundry_sdk/v2/data_health/models.py @@ -92,7 +92,9 @@ class Check(core.ModelBase): "ColumnTypeCheckConfig", "AllowedColumnValuesCheckConfig", "TimeSinceLastUpdatedCheckConfig", + "ScheduleStatusCheckConfig", "NullPercentageCheckConfig", + "ScheduleDurationCheckConfig", "TotalColumnCountCheckConfig", "NumericColumnMedianCheckConfig", "BuildDurationCheckConfig", @@ -441,7 +443,9 @@ class ReplaceBuildStatusCheckConfig(core.ModelBase): "ReplaceColumnTypeCheckConfig", "ReplaceAllowedColumnValuesCheckConfig", "ReplaceTimeSinceLastUpdatedCheckConfig", + "ReplaceScheduleStatusCheckConfig", "ReplaceNullPercentageCheckConfig", + "ReplaceScheduleDurationCheckConfig", "ReplaceTotalColumnCountCheckConfig", "ReplaceNumericColumnMedianCheckConfig", "ReplaceBuildDurationCheckConfig", @@ -550,6 +554,20 @@ class ReplacePrimaryKeyConfig(core.ModelBase): severity: SeverityLevel +class ReplaceScheduleDurationCheckConfig(core.ModelBase): + """ReplaceScheduleDurationCheckConfig""" + + time_check_config: TimeCheckConfig = pydantic.Field(alias=str("timeCheckConfig")) # type: ignore[literal-required] + type: typing.Literal["scheduleDuration"] = "scheduleDuration" + + +class ReplaceScheduleStatusCheckConfig(core.ModelBase): + """ReplaceScheduleStatusCheckConfig""" + + status_check_config: StatusCheckConfig = pydantic.Field(alias=str("statusCheckConfig")) # type: ignore[literal-required] + type: typing.Literal["scheduleStatus"] = "scheduleStatus" + + class ReplaceSchemaComparisonCheckConfig(core.ModelBase): """ReplaceSchemaComparisonCheckConfig""" @@ -571,6 +589,28 @@ class ReplaceTotalColumnCountCheckConfig(core.ModelBase): type: typing.Literal["totalColumnCount"] = "totalColumnCount" +class ScheduleDurationCheckConfig(core.ModelBase): + """Checks the total time a schedule takes to complete.""" + + subject: ScheduleSubject + time_check_config: TimeCheckConfig = pydantic.Field(alias=str("timeCheckConfig")) # type: ignore[literal-required] + type: typing.Literal["scheduleDuration"] = "scheduleDuration" + + +class ScheduleStatusCheckConfig(core.ModelBase): + """Checks the status of the most recent schedule run.""" + + subject: ScheduleSubject + status_check_config: StatusCheckConfig = pydantic.Field(alias=str("statusCheckConfig")) # type: ignore[literal-required] + type: typing.Literal["scheduleStatus"] = "scheduleStatus" + + +class ScheduleSubject(core.ModelBase): + """A schedule resource type.""" + + schedule_rid: core_models.ScheduleRid = pydantic.Field(alias=str("scheduleRid")) # type: ignore[literal-required] + + class SchemaComparisonCheckConfig(core.ModelBase): """Checks the dataset schema against an expected schema.""" @@ -763,9 +803,14 @@ class TrendConfig(core.ModelBase): "ReplacePercentageCheckConfig", "ReplacePrimaryKeyCheckConfig", "ReplacePrimaryKeyConfig", + "ReplaceScheduleDurationCheckConfig", + "ReplaceScheduleStatusCheckConfig", "ReplaceSchemaComparisonCheckConfig", "ReplaceTimeSinceLastUpdatedCheckConfig", "ReplaceTotalColumnCountCheckConfig", + "ScheduleDurationCheckConfig", + "ScheduleStatusCheckConfig", + "ScheduleSubject", "SchemaComparisonCheckConfig", "SchemaComparisonConfig", "SchemaComparisonType", diff --git a/foundry_sdk/v2/filesystem/errors.py b/foundry_sdk/v2/filesystem/errors.py index 66e33de19..85888637e 100644 --- a/foundry_sdk/v2/filesystem/errors.py +++ b/foundry_sdk/v2/filesystem/errors.py @@ -355,6 +355,19 @@ class GetByPathPermissionDenied(errors.PermissionDeniedError): error_instance_id: str +class GetRecentlyViewedPermissionDeniedParameters(typing_extensions.TypedDict): + """Could not getRecentlyViewed the Resource.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + +@dataclass +class GetRecentlyViewedPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["GetRecentlyViewedPermissionDenied"] + parameters: GetRecentlyViewedPermissionDeniedParameters + error_instance_id: str + + class GetRootFolderNotSupportedParameters(typing_extensions.TypedDict): """Getting the root folder as a resource is not supported.""" @@ -820,6 +833,25 @@ class ProjectTemplateNotFound(errors.NotFoundError): error_instance_id: str +class RecentlyViewedLimitBelowMinimumParameters(typing_extensions.TypedDict): + """RecentlyViewedLimit must be greater than or equal to 1""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: int + """The value that was provided.""" + + minInclusive: int + """The minimum value allowed.""" + + +@dataclass +class RecentlyViewedLimitBelowMinimum(errors.BadRequestError): + name: typing.Literal["RecentlyViewedLimitBelowMinimum"] + parameters: RecentlyViewedLimitBelowMinimumParameters + error_instance_id: str + + class RemoveMarkingsPermissionDeniedParameters(typing_extensions.TypedDict): """Could not removeMarkings the Resource.""" @@ -1240,6 +1272,7 @@ class UsageAccountServiceIsNotPresent(errors.InternalServerError): "ForbiddenOperationOnHiddenResource", "GetAccessRequirementsPermissionDenied", "GetByPathPermissionDenied", + "GetRecentlyViewedPermissionDenied", "GetRootFolderNotSupported", "GetSpaceResourceNotSupported", "InvalidDefaultRoles", @@ -1270,6 +1303,7 @@ class UsageAccountServiceIsNotPresent(errors.InternalServerError): "ProjectNameAlreadyExists", "ProjectNotFound", "ProjectTemplateNotFound", + "RecentlyViewedLimitBelowMinimum", "RemoveMarkingsPermissionDenied", "RemoveOrganizationsPermissionDenied", "RemoveProjectResourceReferencesPermissionDenied", diff --git a/foundry_sdk/v2/filesystem/models.py b/foundry_sdk/v2/filesystem/models.py index bfd8f33e7..16ed210f4 100644 --- a/foundry_sdk/v2/filesystem/models.py +++ b/foundry_sdk/v2/filesystem/models.py @@ -243,6 +243,13 @@ class GetFoldersBatchResponse(core.ModelBase): data: typing.Dict[FolderRid, Folder] +class GetRecentlyViewedResponse(core.ModelBase): + """Response containing the resources most recently viewed by the calling user.""" + + data: typing.List[RecentlyViewedResource] + """The list of recently viewed resources, ordered from most to least recently viewed.""" + + class GetResourcesBatchRequestElement(core.ModelBase): """GetResourcesBatchRequestElement""" @@ -449,6 +456,23 @@ class ProjectResourceReference(core.ModelBase): """The value assigned to a variable used in a project template.""" +RecentlyViewedLimit: typing_extensions.TypeAlias = int +""" +The maximum number of recently viewed resources to return. + +Validation rules: + * must be greater than or equal to 1 +""" + + +class RecentlyViewedResource(core.ModelBase): + """A resource that was recently viewed by the calling user, along with when it was last viewed.""" + + resource: Resource + last_viewed: core.AwareDatetime = pydantic.Field(alias=str("lastViewed")) # type: ignore[literal-required] + """The timestamp at which the calling user last viewed this resource.""" + + class RemoveMarkingsRequest(core.ModelBase): """RemoveMarkingsRequest""" @@ -792,6 +816,7 @@ class Space(core.ModelBase): "GetByPathResourcesBatchResponse", "GetFoldersBatchRequestElement", "GetFoldersBatchResponse", + "GetRecentlyViewedResponse", "GetResourcesBatchRequestElement", "GetResourcesBatchResponse", "IsDirectlyApplied", @@ -817,6 +842,8 @@ class Space(core.ModelBase): "ProjectTemplateRid", "ProjectTemplateVariableId", "ProjectTemplateVariableValue", + "RecentlyViewedLimit", + "RecentlyViewedResource", "RemoveMarkingsRequest", "RemoveOrganizationsRequest", "RemoveProjectResourceReferencesRequest", diff --git a/foundry_sdk/v2/filesystem/resource.py b/foundry_sdk/v2/filesystem/resource.py index c8c96bc57..658460c34 100644 --- a/foundry_sdk/v2/filesystem/resource.py +++ b/foundry_sdk/v2/filesystem/resource.py @@ -425,6 +425,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 = {}, + ) -> 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 f730ed5bc..5b61ab691 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 235add460..45e56f4e2 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 49adc14c6..0947261ef 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/media_sets/errors.py b/foundry_sdk/v2/media_sets/errors.py index 32babf3cc..9bc68c57e 100644 --- a/foundry_sdk/v2/media_sets/errors.py +++ b/foundry_sdk/v2/media_sets/errors.py @@ -18,6 +18,7 @@ import typing_extensions +from foundry_sdk import _core as core from foundry_sdk import _errors as errors from foundry_sdk.v2.core import models as core_models from foundry_sdk.v2.media_sets import models as media_sets_models @@ -273,6 +274,19 @@ class TemporaryMediaUploadUnknownFailure(errors.InternalServerError): error_instance_id: str +class TransformationDocumentExtractErrorParameters(typing_extensions.TypedDict): + """Document extraction failed. This covers any failure during extraction, from a malformed document to a server-side error.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + +@dataclass +class TransformationDocumentExtractError(errors.InternalServerError): + name: typing.Literal["TransformationDocumentExtractError"] + parameters: TransformationDocumentExtractErrorParameters + error_instance_id: str + + class TransformationImageTooLargeForOcrParameters(typing_extensions.TypedDict): """The image or document page dimensions exceeded the maximum supported by the OCR model.""" @@ -286,6 +300,52 @@ class TransformationImageTooLargeForOcr(errors.BadRequestError): error_instance_id: str +class TransformationInputTooLargeParameters(typing_extensions.TypedDict): + """The transformation input is too large for the underlying model.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + +@dataclass +class TransformationInputTooLarge(errors.RequestEntityTooLargeError): + name: typing.Literal["TransformationInputTooLarge"] + parameters: TransformationInputTooLargeParameters + error_instance_id: str + + +class TransformationInvalidPageRangeParameters(typing_extensions.TypedDict): + """The supplied page range is invalid.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + startPageInclusive: typing_extensions.NotRequired[int] + endPageExclusive: typing_extensions.NotRequired[int] + documentLength: typing_extensions.NotRequired[int] + + +@dataclass +class TransformationInvalidPageRange(errors.BadRequestError): + name: typing.Literal["TransformationInvalidPageRange"] + parameters: TransformationInvalidPageRangeParameters + error_instance_id: str + + +class TransformationMediaSizeExceededParameters(typing_extensions.TypedDict): + """The media item exceeds the maximum size supported by the transformation.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + sizeInBytes: typing_extensions.NotRequired[core.Long] + maxSizeInBytes: typing_extensions.NotRequired[core.Long] + + +@dataclass +class TransformationMediaSizeExceeded(errors.RequestEntityTooLargeError): + name: typing.Literal["TransformationMediaSizeExceeded"] + parameters: TransformationMediaSizeExceededParameters + error_instance_id: str + + class TransformationModelContextWindowExceededParameters(typing_extensions.TypedDict): """The transformation input exceeded the model's maximum context window.""" @@ -343,6 +403,22 @@ class TransformationNotFound(errors.NotFoundError): error_instance_id: str +class TransformationPermissionDeniedParameters(typing_extensions.TypedDict): + """The caller does not have permission to run this media transformation.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + underlyingErrorType: str + code: str + + +@dataclass +class TransformationPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["TransformationPermissionDenied"] + parameters: TransformationPermissionDeniedParameters + error_instance_id: str + + class TransformationUnavailableParameters(typing_extensions.TypedDict): """The requested transformation is not currently available.""" @@ -356,6 +432,77 @@ class TransformationUnavailable(errors.BadRequestError): error_instance_id: str +class TransformationVlmErrorParameters(typing_extensions.TypedDict): + """A language model call failed during a media transformation.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + underlyingErrorType: str + code: str + + +@dataclass +class TransformationVlmError(errors.BadRequestError): + name: typing.Literal["TransformationVlmError"] + parameters: TransformationVlmErrorParameters + error_instance_id: str + + +class TransformationVlmLayoutModelFailureParameters(typing_extensions.TypedDict): + """The layout or OCR model used as preprocessing for document extraction failed.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + +@dataclass +class TransformationVlmLayoutModelFailure(errors.InternalServerError): + name: typing.Literal["TransformationVlmLayoutModelFailure"] + parameters: TransformationVlmLayoutModelFailureParameters + error_instance_id: str + + +class TransformationVlmMultiPageRequestUnsupportedParameters(typing_extensions.TypedDict): + """Document extraction only supports a single page per request.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + requestedPages: typing_extensions.NotRequired[int] + maxValidPageCount: typing_extensions.NotRequired[int] + + +@dataclass +class TransformationVlmMultiPageRequestUnsupported(errors.BadRequestError): + name: typing.Literal["TransformationVlmMultiPageRequestUnsupported"] + parameters: TransformationVlmMultiPageRequestUnsupportedParameters + error_instance_id: str + + +class TransformationVlmPageRangeRequiredParameters(typing_extensions.TypedDict): + """Document extraction requires an explicit page range with both startPageInclusive and endPageExclusive set.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + +@dataclass +class TransformationVlmPageRangeRequired(errors.BadRequestError): + name: typing.Literal["TransformationVlmPageRangeRequired"] + parameters: TransformationVlmPageRangeRequiredParameters + error_instance_id: str + + +class TransformationVlmResponseParseErrorParameters(typing_extensions.TypedDict): + """The model response could not be parsed during document extraction.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + +@dataclass +class TransformationVlmResponseParseError(errors.InternalServerError): + name: typing.Literal["TransformationVlmResponseParseError"] + parameters: TransformationVlmResponseParseErrorParameters + error_instance_id: str + + class TransformedMediaItemNotFoundParameters(typing_extensions.TypedDict): """The requested media item could not be found, or the client token does not have access to it.""" @@ -415,12 +562,22 @@ class UnsupportedMetadata(errors.InternalServerError): "MissingMediaItemPath", "TemporaryMediaUploadInsufficientPermissions", "TemporaryMediaUploadUnknownFailure", + "TransformationDocumentExtractError", "TransformationImageTooLargeForOcr", + "TransformationInputTooLarge", + "TransformationInvalidPageRange", + "TransformationMediaSizeExceeded", "TransformationModelContextWindowExceeded", "TransformationModelNotAvailable", "TransformationModelNotSupported", "TransformationNotFound", + "TransformationPermissionDenied", "TransformationUnavailable", + "TransformationVlmError", + "TransformationVlmLayoutModelFailure", + "TransformationVlmMultiPageRequestUnsupported", + "TransformationVlmPageRangeRequired", + "TransformationVlmResponseParseError", "TransformedMediaItemNotFound", "UnexpectedMetadataType", "UnsupportedMetadata", diff --git a/foundry_sdk/v2/media_sets/media_set.py b/foundry_sdk/v2/media_sets/media_set.py index e9c6df141..efa5b11be 100644 --- a/foundry_sdk/v2/media_sets/media_set.py +++ b/foundry_sdk/v2/media_sets/media_set.py @@ -548,7 +548,6 @@ def info( media_set_rid: core_models.MediaSetRid, media_item_rid: core_models.MediaItemRid, *, - preview: typing.Optional[core_models.PreviewMode] = None, read_token: typing.Optional[core_models.MediaItemReadToken] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -560,8 +559,6 @@ def info( :type media_set_rid: MediaSetRid :param media_item_rid: The RID of the media item. :type media_item_rid: MediaItemRid - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] :param read_token: :type read_token: Optional[MediaItemReadToken] :param request_timeout: timeout setting for this request in seconds. @@ -574,9 +571,7 @@ def info( core.RequestInfo( method="GET", resource_path="/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}", - query_params={ - "preview": preview, - }, + query_params={}, path_params={ "mediaSetRid": media_set_rid, "mediaItemRid": media_item_rid, @@ -601,7 +596,6 @@ def metadata( media_set_rid: core_models.MediaSetRid, media_item_rid: core_models.MediaItemRid, *, - preview: typing.Optional[core_models.PreviewMode] = None, read_token: typing.Optional[core_models.MediaItemReadToken] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -614,8 +608,6 @@ def metadata( :type media_set_rid: MediaSetRid :param media_item_rid: The RID of the media item. :type media_item_rid: MediaItemRid - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] :param read_token: :type read_token: Optional[MediaItemReadToken] :param request_timeout: timeout setting for this request in seconds. @@ -628,9 +620,7 @@ def metadata( core.RequestInfo( method="GET", resource_path="/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/metadata", - query_params={ - "preview": preview, - }, + query_params={}, path_params={ "mediaSetRid": media_set_rid, "mediaItemRid": media_item_rid, @@ -655,7 +645,6 @@ def read( media_set_rid: core_models.MediaSetRid, media_item_rid: core_models.MediaItemRid, *, - preview: typing.Optional[core_models.PreviewMode] = None, read_token: typing.Optional[core_models.MediaItemReadToken] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -667,8 +656,6 @@ def read( :type media_set_rid: MediaSetRid :param media_item_rid: :type media_item_rid: MediaItemRid - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] :param read_token: :type read_token: Optional[MediaItemReadToken] :param request_timeout: timeout setting for this request in seconds. @@ -681,9 +668,7 @@ def read( core.RequestInfo( method="GET", resource_path="/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/content", - query_params={ - "preview": preview, - }, + query_params={}, path_params={ "mediaSetRid": media_set_rid, "mediaItemRid": media_item_rid, @@ -708,7 +693,6 @@ def read_original( media_set_rid: core_models.MediaSetRid, media_item_rid: core_models.MediaItemRid, *, - preview: typing.Optional[core_models.PreviewMode] = None, read_token: typing.Optional[core_models.MediaItemReadToken] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -720,8 +704,6 @@ def read_original( :type media_set_rid: MediaSetRid :param media_item_rid: :type media_item_rid: MediaItemRid - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] :param read_token: :type read_token: Optional[MediaItemReadToken] :param request_timeout: timeout setting for this request in seconds. @@ -734,9 +716,7 @@ def read_original( core.RequestInfo( method="GET", resource_path="/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/original", - query_params={ - "preview": preview, - }, + query_params={}, path_params={ "mediaSetRid": media_set_rid, "mediaItemRid": media_item_rid, @@ -1082,7 +1062,6 @@ def upload_media( filename: core_models.MediaItemPath, attribution: typing.Optional[core_models.Attribution] = None, media_item_rid: typing.Optional[core_models.MediaItemRid] = None, - preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> core_models.MediaReference: @@ -1102,8 +1081,6 @@ def upload_media( :type attribution: Optional[Attribution] :param media_item_rid: An optional RID to use for the media item to create. If omitted, the server will automatically generate a RID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your workflow strictly requires deterministic or client-controlled identifiers. The RID must be in the format of `ri.mio..media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. :type media_item_rid: Optional[MediaItemRid] - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -1117,7 +1094,6 @@ def upload_media( query_params={ "filename": filename, "mediaItemRid": media_item_rid, - "preview": preview, }, path_params={}, header_params={ @@ -1738,7 +1714,6 @@ def info( media_set_rid: core_models.MediaSetRid, media_item_rid: core_models.MediaItemRid, *, - preview: typing.Optional[core_models.PreviewMode] = None, read_token: typing.Optional[core_models.MediaItemReadToken] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -1750,8 +1725,6 @@ def info( :type media_set_rid: MediaSetRid :param media_item_rid: The RID of the media item. :type media_item_rid: MediaItemRid - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] :param read_token: :type read_token: Optional[MediaItemReadToken] :param request_timeout: timeout setting for this request in seconds. @@ -1764,9 +1737,7 @@ def info( core.RequestInfo( method="GET", resource_path="/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}", - query_params={ - "preview": preview, - }, + query_params={}, path_params={ "mediaSetRid": media_set_rid, "mediaItemRid": media_item_rid, @@ -1791,7 +1762,6 @@ def metadata( media_set_rid: core_models.MediaSetRid, media_item_rid: core_models.MediaItemRid, *, - preview: typing.Optional[core_models.PreviewMode] = None, read_token: typing.Optional[core_models.MediaItemReadToken] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -1804,8 +1774,6 @@ def metadata( :type media_set_rid: MediaSetRid :param media_item_rid: The RID of the media item. :type media_item_rid: MediaItemRid - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] :param read_token: :type read_token: Optional[MediaItemReadToken] :param request_timeout: timeout setting for this request in seconds. @@ -1818,9 +1786,7 @@ def metadata( core.RequestInfo( method="GET", resource_path="/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/metadata", - query_params={ - "preview": preview, - }, + query_params={}, path_params={ "mediaSetRid": media_set_rid, "mediaItemRid": media_item_rid, @@ -1845,7 +1811,6 @@ def read( media_set_rid: core_models.MediaSetRid, media_item_rid: core_models.MediaItemRid, *, - preview: typing.Optional[core_models.PreviewMode] = None, read_token: typing.Optional[core_models.MediaItemReadToken] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -1857,8 +1822,6 @@ def read( :type media_set_rid: MediaSetRid :param media_item_rid: :type media_item_rid: MediaItemRid - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] :param read_token: :type read_token: Optional[MediaItemReadToken] :param request_timeout: timeout setting for this request in seconds. @@ -1871,9 +1834,7 @@ def read( core.RequestInfo( method="GET", resource_path="/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/content", - query_params={ - "preview": preview, - }, + query_params={}, path_params={ "mediaSetRid": media_set_rid, "mediaItemRid": media_item_rid, @@ -1898,7 +1859,6 @@ def read_original( media_set_rid: core_models.MediaSetRid, media_item_rid: core_models.MediaItemRid, *, - preview: typing.Optional[core_models.PreviewMode] = None, read_token: typing.Optional[core_models.MediaItemReadToken] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -1910,8 +1870,6 @@ def read_original( :type media_set_rid: MediaSetRid :param media_item_rid: :type media_item_rid: MediaItemRid - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] :param read_token: :type read_token: Optional[MediaItemReadToken] :param request_timeout: timeout setting for this request in seconds. @@ -1924,9 +1882,7 @@ def read_original( core.RequestInfo( method="GET", resource_path="/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/original", - query_params={ - "preview": preview, - }, + query_params={}, path_params={ "mediaSetRid": media_set_rid, "mediaItemRid": media_item_rid, @@ -2272,7 +2228,6 @@ def upload_media( filename: core_models.MediaItemPath, attribution: typing.Optional[core_models.Attribution] = None, media_item_rid: typing.Optional[core_models.MediaItemRid] = None, - preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[core_models.MediaReference]: @@ -2292,8 +2247,6 @@ def upload_media( :type attribution: Optional[Attribution] :param media_item_rid: An optional RID to use for the media item to create. If omitted, the server will automatically generate a RID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your workflow strictly requires deterministic or client-controlled identifiers. The RID must be in the format of `ri.mio..media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. :type media_item_rid: Optional[MediaItemRid] - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -2307,7 +2260,6 @@ def upload_media( query_params={ "filename": filename, "mediaItemRid": media_item_rid, - "preview": preview, }, path_params={}, header_params={ diff --git a/foundry_sdk/v2/media_sets/models.py b/foundry_sdk/v2/media_sets/models.py index 06c514259..23303aa77 100644 --- a/foundry_sdk/v2/media_sets/models.py +++ b/foundry_sdk/v2/media_sets/models.py @@ -211,6 +211,31 @@ class BoundingBoxGeometry(core.ModelBase): """A resource identifier that identifies a branch of a media set.""" +CadDecodeFormat: typing_extensions.TypeAlias = typing.Literal["STEP"] +"""The format of a CAD media item.""" + + +class CadMediaItemMetadata(core.ModelBase): + """Metadata for CAD media items.""" + + format: CadDecodeFormat + size_bytes: int = pydantic.Field(alias=str("sizeBytes")) # type: ignore[literal-required] + """The size of the media item in bytes.""" + + units: typing.Optional[CadUnits] = None + type: typing.Literal["cad"] = "cad" + + +class CadUnits(core.ModelBase): + """Units declared in a CAD file.""" + + length_unit: typing.Optional[str] = pydantic.Field(alias=str("lengthUnit"), default=None) # type: ignore[literal-required] + """ + Raw declared length unit name, for example MILLIMETRE, METRE, INCH, or FOOT. Consumers should match + case-insensitively and tolerate unknown values. + """ + + class ChatLlmSpec(core.ModelBase): """Standard chat-based LLM specification with system and user prompts.""" @@ -809,7 +834,7 @@ class ExtractVlmTextOperation(core.ModelBase): llm_spec: LlmSpec = pydantic.Field(alias=str("llmSpec")) # type: ignore[literal-required] preprocessing_configuration: typing.Optional[VlmPreprocessingConfig] = pydantic.Field(alias=str("preprocessingConfiguration"), default=None) # type: ignore[literal-required] image_spec: typing.Optional[ImageSpec] = pydantic.Field(alias=str("imageSpec"), default=None) # type: ignore[literal-required] - output_format: TextOutputFormat = pydantic.Field(alias=str("outputFormat")) # type: ignore[literal-required] + output_format: VlmOutputFormat = pydantic.Field(alias=str("outputFormat")) # type: ignore[literal-required] page_range: typing.Optional[PageRange] = pydantic.Field(alias=str("pageRange"), default=None) # type: ignore[literal-required] type: typing.Literal["extractVlmText"] = "extractVlmText" @@ -1188,6 +1213,7 @@ class MediaAttribution(core.ModelBase): MediaItemMetadata: typing_extensions.TypeAlias = typing_extensions.Annotated[ typing.Union[ + "CadMediaItemMetadata", "DocumentMediaItemMetadata", "ImageryMediaItemMetadata", "SpreadsheetMediaItemMetadata", @@ -1212,6 +1238,7 @@ class MediaAttribution(core.ModelBase): MediaSchema: typing_extensions.TypeAlias = typing.Literal[ "AUDIO", + "CAD", "DICOM", "DOCUMENT", "IMAGERY", @@ -2275,7 +2302,7 @@ class VideoChunkOperation(core.ModelBase): type: typing.Literal["chunk"] = "chunk" -VideoDecodeFormat: typing_extensions.TypeAlias = typing.Literal["MP4", "MKV", "MOV", "TS"] +VideoDecodeFormat: typing_extensions.TypeAlias = typing.Literal["MP4", "MKV", "MOV", "TS", "WEBM"] """The format of a video media item.""" @@ -2364,6 +2391,10 @@ class VideoTransformation(core.ModelBase): type: typing.Literal["video"] = "video" +VlmOutputFormat: typing_extensions.TypeAlias = typing.Literal["MARKDOWN"] +"""Format in which to return text extracted by vision language models.""" + + VlmPreprocessingConfig: typing_extensions.TypeAlias = typing_extensions.Annotated[ typing.Union["LayoutAwarePreprocessingWrapper", "ExtractTextPreprocessingWrapper"], pydantic.Field(discriminator="type"), @@ -2490,6 +2521,9 @@ class WebpFormat(core.ModelBase): "BoundingBoxGeometry", "BranchName", "BranchRid", + "CadDecodeFormat", + "CadMediaItemMetadata", + "CadUnits", "ChatLlmSpec", "ChatLlmSpecWrapper", "Color", @@ -2686,6 +2720,7 @@ class WebpFormat(core.ModelBase): "VideoToTextOperation", "VideoToTextTransformation", "VideoTransformation", + "VlmOutputFormat", "VlmPreprocessingConfig", "WavEncodeFormat", "WaveformOperation", diff --git a/foundry_sdk/v2/models/models.py b/foundry_sdk/v2/models/models.py index d0fbda1d5..e87aa41bc 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.""" @@ -519,6 +536,9 @@ class LiveDeploymentRuntimeConfiguration(core.ModelBase): scaling_configuration: typing.Optional[LiveDeploymentScalingConfiguration] = pydantic.Field(alias=str("scalingConfiguration"), default=None) # type: ignore[literal-required] """Autoscaling configuration for the deployment. Controls how the deployment scales replicas up and down based on load.""" + environment_variables: typing.Dict[str, str] = pydantic.Field(alias=str("environmentVariables")) # type: ignore[literal-required] + """User-supplied environment variables to set on the deployment container, keyed by variable name.""" + class LiveDeploymentScalingConfiguration(core.ModelBase): """Autoscaling configuration that controls how the deployment scales replicas based on load thresholds and cooldown delays.""" @@ -1508,6 +1528,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 +1632,7 @@ class UnsupportedTypeError(core.ModelBase): "InvalidMapFormatError", "InvalidResourceConfigurationError", "InvalidTabularFormatError", + "InvalidWorkerConfigInputTypeError", "JsonSchemaValidationError", "ListLiveDeploymentsResponse", "ListModelStudioConfigVersionsResponse", @@ -1720,5 +1756,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 7358cde9e..cb5a17c5a 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 142bc64b3..5dee839f9 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.""" @@ -1986,6 +2024,13 @@ class IntegerValue(core.ModelBase): type: typing.Literal["integerValue"] = "integerValue" +InterfaceActionTypeConstraintApiName: typing_extensions.TypeAlias = str +""" +The name in the API of an action defined on an interface that implementing object types provide a concrete +action type for. +""" + + class InterfaceDefinedPropertyType(core.ModelBase): """ An interface property type with an additional field to indicate constraints that need to be satisfied by @@ -2645,6 +2690,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 +2744,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 +2813,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 +2928,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 +3065,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 +3117,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 +3134,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. @@ -3522,9 +3604,14 @@ class ObjectSetStaticType(core.ModelBase): class ObjectSetStreamSubscribeRequest(core.ModelBase): - """ObjectSetStreamSubscribeRequest""" + """ + `branch` identifies the Foundry branch. `scenarioRid` identifies the Ontology Scenario. + If a scenario is based on a non-default branch, `branch` must identify that non-default base branch. + """ object_set: ObjectSet = pydantic.Field(alias=str("objectSet")) # type: ignore[literal-required] + branch: typing.Optional[core_models.FoundryBranch] = None + scenario_rid: typing.Optional[OntologyScenarioRid] = pydantic.Field(alias=str("scenarioRid"), default=None) # type: ignore[literal-required] property_set: typing.List[SelectedPropertyApiName] = pydantic.Field(alias=str("propertySet")) # type: ignore[literal-required] reference_set: typing.List[SelectedPropertyApiName] = pydantic.Field(alias=str("referenceSet")) # type: ignore[literal-required] object_loading_response_options: typing.Optional[ObjectLoadingResponseOptions] = pydantic.Field(alias=str("objectLoadingResponseOptions"), default=None) # type: ignore[literal-required] @@ -3775,6 +3862,12 @@ class ObjectTypeInterfaceImplementation(core.ModelBase): properties: typing.Dict[SharedPropertyTypeApiName, PropertyApiName] properties_v2: typing.Dict[InterfacePropertyApiName, InterfacePropertyTypeImplementation] = pydantic.Field(alias=str("propertiesV2")) # type: ignore[literal-required] links: typing.Dict[InterfaceLinkTypeApiName, typing.List[LinkTypeApiName]] + action_types: typing.Dict[InterfaceActionTypeConstraintApiName, ActionTypeApiName] = pydantic.Field(alias=str("actionTypes")) # type: ignore[literal-required] + """ + A map from interface action type constraint API name to the API name of the concrete action type on this + object type that implements it. Action types the caller is not authorized to access are omitted, so this + map may not cover every action type constraint declared on the interface. + """ class ObjectTypeLinkTypeApiNameMapping(core.ModelBase): @@ -3920,6 +4013,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 +4271,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 +4356,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 +4569,7 @@ class PropertyKnownTypeFormattingRule(core.ModelBase): "ApplyReducersAndExtractMainValueLoadLevel", "ApplyReducersLoadLevel", "ExtractMainValueLoadLevel", + "NoLoadLevel", ], pydantic.Field(discriminator="type"), ] @@ -4430,6 +4578,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 +4956,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 +5113,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 +5379,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 +5646,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 +5979,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 +6296,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 +6415,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 +6512,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 +6543,8 @@ class WithinPolygonQuery(core.ModelBase): "ActionParameterRid", "ActionParameterType", "ActionParameterV2", + "ActionParameterValidation", + "ActionParameterValidationBlock", "ActionResults", "ActionRid", "ActionSectionRid", @@ -6381,6 +6611,7 @@ class WithinPolygonQuery(core.ModelBase): "ArrayEvaluatedConstraint", "ArraySizeConstraint", "ArtifactRepositoryRid", + "AttachmentAllowedValues", "AttachmentMetadataResponse", "AttachmentRid", "AttachmentV2", @@ -6435,6 +6666,7 @@ class WithinPolygonQuery(core.ModelBase): "DatasourceBranchId", "DatasourceRid", "DateValue", + "DatetimeAllowedValues", "DatetimeFormat", "DatetimeLocalizedFormat", "DatetimeLocalizedFormatType", @@ -6490,6 +6722,7 @@ class WithinPolygonQuery(core.ModelBase): "ExtractMainValueLoadLevel", "ExtractPropertyExpression", "FilterValue", + "FixedDatetimeValue", "FixedValuesMapKey", "FullTextStringContainsPredicate", "FullTextStringExactPredicate", @@ -6534,6 +6767,7 @@ class WithinPolygonQuery(core.ModelBase): "InQuery", "InputObjectTypeRidActionTypesQueryV2", "IntegerValue", + "InterfaceActionTypeConstraintApiName", "InterfaceDefinedPropertyType", "InterfaceLinkType", "InterfaceLinkTypeApiName", @@ -6613,6 +6847,7 @@ class WithinPolygonQuery(core.ModelBase): "LongValue", "LtQueryV2", "LteQueryV2", + "MarkdownAllowedValues", "MarkingId", "MatchRule", "MaxAggregationV2", @@ -6627,12 +6862,15 @@ class WithinPolygonQuery(core.ModelBase): "ModifyObjectLogicRule", "ModifyObjectRule", "MultiplyPropertyExpression", + "MustBeEmptyAllowedValues", "NearestNeighborsQuery", "NearestNeighborsQueryText", "NegatePropertyExpression", "NestedInterfacePropertyTypeImplementation", "NestedQueryAggregation", + "NoLoadLevel", "NotQueryV2", + "NowDatetimeValue", "NumberFormatAffix", "NumberFormatCurrency", "NumberFormatCurrencyStyle", @@ -6708,6 +6946,7 @@ class WithinPolygonQuery(core.ModelBase): "ObjectTypeV2", "ObjectTypeVisibility", "ObjectUpdate", + "OneOfAllowedValues", "OneOfConstraint", "OntologyApiName", "OntologyArrayType", @@ -6738,6 +6977,11 @@ class WithinPolygonQuery(core.ModelBase): "OrQueryV2", "OrderBy", "OrderByDirection", + "ParameterAllowedValueOption", + "ParameterAllowedValues", + "ParameterArraySize", + "ParameterConstraintValue", + "ParameterDatetimeValue", "ParameterEvaluatedConstraint", "ParameterEvaluationResult", "ParameterId", @@ -6804,6 +7048,7 @@ class WithinPolygonQuery(core.ModelBase): "QueryTypeReferenceType", "QueryTypeV2", "QueryUnionType", + "RangeAllowedValues", "RangeConstraint", "RangesConstraint", "Reason", @@ -6816,6 +7061,10 @@ class WithinPolygonQuery(core.ModelBase): "RegexQuery", "RelativeDateRangeBound", "RelativeDateRangeQuery", + "RelativeDatetimeDuration", + "RelativeDatetimeTense", + "RelativeDatetimeUnit", + "RelativeDatetimeValue", "RelativePointInTime", "RelativeTime", "RelativeTimeRange", @@ -6862,6 +7111,7 @@ class WithinPolygonQuery(core.ModelBase): "SpatialFilterMode", "StartsWithQuery", "StaticArgument", + "StaticConstraintValue", "StatusActionTypesQueryV2", "StreamMessage", "StreamRid", @@ -6900,6 +7150,7 @@ class WithinPolygonQuery(core.ModelBase): "SyncApplyActionResponseV2", "SynchronousWebhookOutputArgument", "TableRid", + "TextAllowedValues", "ThreeDimensionalAggregation", "TimeCodeFormat", "TimeRange", @@ -6931,6 +7182,7 @@ class WithinPolygonQuery(core.ModelBase): "ValidateActionResponseV2", "ValidationResult", "ValueType", + "ValueTypeAllowedValues", "ValueTypeApiName", "ValueTypeArrayType", "ValueTypeConstraint", @@ -6944,6 +7196,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 df3b2af4a..9dad7afe0 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 00dc3472a..2cc810dee 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 74367eae5..2c7e5c16e 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 ba32f7ff9..a2196b2f1 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.