From 86058349432246d5511feb855a366acfd77551be Mon Sep 17 00:00:00 2001 From: svc-excavator-bot Date: Fri, 16 Jan 2026 19:14:08 +0000 Subject: [PATCH] Excavator: Upgrade API Version --- README.md | 54 ++ docs-snippets-npm/package.json | 2 +- docs-snippets-npm/src/index.ts | 19 +- docs/v1/Core/models/UnsupportedType.md | 1 + .../v1/Core/models/UnsupportedTypeParamKey.md | 11 + .../Core/models/UnsupportedTypeParamValue.md | 11 + docs/v1/Ontologies/models/PropertyValue.md | 1 + docs/v2/Core/models/UnsupportedType.md | 1 + .../v2/Core/models/UnsupportedTypeParamKey.md | 11 + .../Core/models/UnsupportedTypeParamValue.md | 11 + docs/v2/Datasets/models/ViewBackingDataset.md | 2 +- docs/v2/MediaSets/MediaSet.md | 61 ++ docs/v2/MediaSets/models/AffineTransform.md | 16 + docs/v2/MediaSets/models/AudioDecodeFormat.md | 17 + .../models/AudioMediaItemMetadata.md | 14 + .../v2/MediaSets/models/AudioSpecification.md | 13 + docs/v2/MediaSets/models/BandInfo.md | 14 + .../MediaSets/models/ColorInterpretation.md | 26 + .../models/CommonDicomDataElements.md | 18 + .../models/CoordinateReferenceSystem.md | 11 + docs/v2/MediaSets/models/DataType.md | 24 + .../MediaSets/models/DicomDataElementKey.md | 11 + .../models/DicomMediaItemMetadata.md | 16 + docs/v2/MediaSets/models/DicomMediaType.md | 13 + .../MediaSets/models/DicomMetaInformation.md | 11 + .../models/DicomMetaInformationV1.md | 14 + docs/v2/MediaSets/models/Dimensions.md | 12 + .../MediaSets/models/DocumentDecodeFormat.md | 13 + .../models/DocumentMediaItemMetadata.md | 16 + docs/v2/MediaSets/models/FlipAxis.md | 12 + docs/v2/MediaSets/models/GcpList.md | 11 + docs/v2/MediaSets/models/GeoMetadata.md | 14 + docs/v2/MediaSets/models/GpsMetadata.md | 13 + .../v2/MediaSets/models/GroundControlPoint.md | 15 + .../MediaSets/models/ImageAttributeDomain.md | 11 + docs/v2/MediaSets/models/ImageAttributeKey.md | 11 + .../MediaSets/models/ImageryDecodeFormat.md | 16 + .../models/ImageryMediaItemMetadata.md | 20 + docs/v2/MediaSets/models/MediaItemMetadata.md | 23 + docs/v2/MediaSets/models/Modality.md | 99 ++++ docs/v2/MediaSets/models/Orientation.md | 12 + .../MediaSets/models/PaletteInterpretation.md | 14 + docs/v2/MediaSets/models/RotationAngle.md | 13 + .../models/SpreadsheetDecodeFormat.md | 10 + .../models/SpreadsheetMediaItemMetadata.md | 16 + .../v2/MediaSets/models/UnitInterpretation.md | 13 + .../models/UntypedMediaItemMetadata.md | 12 + docs/v2/MediaSets/models/VideoDecodeFormat.md | 13 + .../models/VideoMediaItemMetadata.md | 14 + .../v2/MediaSets/models/VideoSpecification.md | 12 + docs/v2/Ontologies/OntologyObject.md | 30 +- docs/v2/Ontologies/OntologyObjectSet.md | 115 ++-- .../models/ConjunctiveMarkingSummary.md | 13 + .../ContainerConjunctiveMarkingSummary.md | 16 + .../ContainerDisjunctiveMarkingSummary.md | 20 + .../models/DisjunctiveMarkingSummary.md | 16 + .../models/ErrorComputingSecurity.md | 11 + docs/v2/Ontologies/models/InQuery.md | 4 +- .../models/LoadObjectSetRequestV2.md | 23 +- .../models/LoadObjectSetResponseV2.md | 1 + ...adObjectSetV2MultipleObjectTypesRequest.md | 23 +- ...dObjectSetV2MultipleObjectTypesResponse.md | 1 + ...adObjectSetV2ObjectsOrInterfacesRequest.md | 20 +- docs/v2/Ontologies/models/MarkingId.md | 11 + .../models/PropertyMarkingSummary.md | 15 + .../Ontologies/models/PropertySecurities.md | 12 + docs/v2/Ontologies/models/PropertySecurity.md | 17 + docs/v2/Ontologies/models/PropertyValue.md | 1 + .../models/SearchObjectsRequestV2.md | 20 +- .../v2/Ontologies/models/UnsupportedPolicy.md | 11 + docs/v2/SqlQueries/SqlQuery.md | 12 +- foundry_sdk/_core/api_client.py | 2 +- foundry_sdk/_versions.py | 2 +- foundry_sdk/v1/core/models.py | 11 + foundry_sdk/v1/ontologies/models.py | 1 + foundry_sdk/v2/cli.py | 69 +++ foundry_sdk/v2/connectivity/errors.py | 2 +- foundry_sdk/v2/core/models.py | 11 + foundry_sdk/v2/datasets/models.py | 4 +- foundry_sdk/v2/media_sets/errors.py | 14 + foundry_sdk/v2/media_sets/media_set.py | 116 ++++ foundry_sdk/v2/media_sets/models.py | 530 ++++++++++++++++++ foundry_sdk/v2/ontologies/models.py | 132 ++++- foundry_sdk/v2/ontologies/ontology_object.py | 9 +- .../v2/ontologies/ontology_object_set.py | 49 +- foundry_sdk/v2/sql_queries/errors.py | 6 +- foundry_sdk/v2/sql_queries/sql_query.py | 12 +- tests/test_api_client.py | 36 +- 88 files changed, 2039 insertions(+), 177 deletions(-) create mode 100644 docs/v1/Core/models/UnsupportedTypeParamKey.md create mode 100644 docs/v1/Core/models/UnsupportedTypeParamValue.md create mode 100644 docs/v2/Core/models/UnsupportedTypeParamKey.md create mode 100644 docs/v2/Core/models/UnsupportedTypeParamValue.md create mode 100644 docs/v2/MediaSets/models/AffineTransform.md create mode 100644 docs/v2/MediaSets/models/AudioDecodeFormat.md create mode 100644 docs/v2/MediaSets/models/AudioMediaItemMetadata.md create mode 100644 docs/v2/MediaSets/models/AudioSpecification.md create mode 100644 docs/v2/MediaSets/models/BandInfo.md create mode 100644 docs/v2/MediaSets/models/ColorInterpretation.md create mode 100644 docs/v2/MediaSets/models/CommonDicomDataElements.md create mode 100644 docs/v2/MediaSets/models/CoordinateReferenceSystem.md create mode 100644 docs/v2/MediaSets/models/DataType.md create mode 100644 docs/v2/MediaSets/models/DicomDataElementKey.md create mode 100644 docs/v2/MediaSets/models/DicomMediaItemMetadata.md create mode 100644 docs/v2/MediaSets/models/DicomMediaType.md create mode 100644 docs/v2/MediaSets/models/DicomMetaInformation.md create mode 100644 docs/v2/MediaSets/models/DicomMetaInformationV1.md create mode 100644 docs/v2/MediaSets/models/Dimensions.md create mode 100644 docs/v2/MediaSets/models/DocumentDecodeFormat.md create mode 100644 docs/v2/MediaSets/models/DocumentMediaItemMetadata.md create mode 100644 docs/v2/MediaSets/models/FlipAxis.md create mode 100644 docs/v2/MediaSets/models/GcpList.md create mode 100644 docs/v2/MediaSets/models/GeoMetadata.md create mode 100644 docs/v2/MediaSets/models/GpsMetadata.md create mode 100644 docs/v2/MediaSets/models/GroundControlPoint.md create mode 100644 docs/v2/MediaSets/models/ImageAttributeDomain.md create mode 100644 docs/v2/MediaSets/models/ImageAttributeKey.md create mode 100644 docs/v2/MediaSets/models/ImageryDecodeFormat.md create mode 100644 docs/v2/MediaSets/models/ImageryMediaItemMetadata.md create mode 100644 docs/v2/MediaSets/models/MediaItemMetadata.md create mode 100644 docs/v2/MediaSets/models/Modality.md create mode 100644 docs/v2/MediaSets/models/Orientation.md create mode 100644 docs/v2/MediaSets/models/PaletteInterpretation.md create mode 100644 docs/v2/MediaSets/models/RotationAngle.md create mode 100644 docs/v2/MediaSets/models/SpreadsheetDecodeFormat.md create mode 100644 docs/v2/MediaSets/models/SpreadsheetMediaItemMetadata.md create mode 100644 docs/v2/MediaSets/models/UnitInterpretation.md create mode 100644 docs/v2/MediaSets/models/UntypedMediaItemMetadata.md create mode 100644 docs/v2/MediaSets/models/VideoDecodeFormat.md create mode 100644 docs/v2/MediaSets/models/VideoMediaItemMetadata.md create mode 100644 docs/v2/MediaSets/models/VideoSpecification.md create mode 100644 docs/v2/Ontologies/models/ConjunctiveMarkingSummary.md create mode 100644 docs/v2/Ontologies/models/ContainerConjunctiveMarkingSummary.md create mode 100644 docs/v2/Ontologies/models/ContainerDisjunctiveMarkingSummary.md create mode 100644 docs/v2/Ontologies/models/DisjunctiveMarkingSummary.md create mode 100644 docs/v2/Ontologies/models/ErrorComputingSecurity.md create mode 100644 docs/v2/Ontologies/models/MarkingId.md create mode 100644 docs/v2/Ontologies/models/PropertyMarkingSummary.md create mode 100644 docs/v2/Ontologies/models/PropertySecurities.md create mode 100644 docs/v2/Ontologies/models/PropertySecurity.md create mode 100644 docs/v2/Ontologies/models/UnsupportedPolicy.md diff --git a/README.md b/README.md index 16ecad230..4b007172f 100644 --- a/README.md +++ b/README.md @@ -811,6 +811,7 @@ Namespace | Resource | Operation | HTTP request | **MediaSets** | MediaSet | [**create**](docs/v2/MediaSets/MediaSet.md#create) | **POST** /v2/mediasets/{mediaSetRid}/transactions | **MediaSets** | MediaSet | [**get_rid_by_path**](docs/v2/MediaSets/MediaSet.md#get_rid_by_path) | **GET** /v2/mediasets/{mediaSetRid}/items/getRidByPath | **MediaSets** | MediaSet | [**info**](docs/v2/MediaSets/MediaSet.md#info) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid} | +**MediaSets** | MediaSet | [**metadata**](docs/v2/MediaSets/MediaSet.md#metadata) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/metadata | **MediaSets** | MediaSet | [**read**](docs/v2/MediaSets/MediaSet.md#read) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/content | **MediaSets** | MediaSet | [**read_original**](docs/v2/MediaSets/MediaSet.md#read_original) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/original | **MediaSets** | MediaSet | [**reference**](docs/v2/MediaSets/MediaSet.md#reference) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/reference | @@ -1380,6 +1381,8 @@ Namespace | Name | Import | **Core** | [TraceParent](docs/v2/Core/models/TraceParent.md) | `from foundry_sdk.v2.core.models import TraceParent` | **Core** | [TraceState](docs/v2/Core/models/TraceState.md) | `from foundry_sdk.v2.core.models import TraceState` | **Core** | [UnsupportedType](docs/v2/Core/models/UnsupportedType.md) | `from foundry_sdk.v2.core.models import UnsupportedType` | +**Core** | [UnsupportedTypeParamKey](docs/v2/Core/models/UnsupportedTypeParamKey.md) | `from foundry_sdk.v2.core.models import UnsupportedTypeParamKey` | +**Core** | [UnsupportedTypeParamValue](docs/v2/Core/models/UnsupportedTypeParamValue.md) | `from foundry_sdk.v2.core.models import UnsupportedTypeParamValue` | **Core** | [UpdatedBy](docs/v2/Core/models/UpdatedBy.md) | `from foundry_sdk.v2.core.models import UpdatedBy` | **Core** | [UpdatedTime](docs/v2/Core/models/UpdatedTime.md) | `from foundry_sdk.v2.core.models import UpdatedTime` | **Core** | [UserId](docs/v2/Core/models/UserId.md) | `from foundry_sdk.v2.core.models import UserId` | @@ -1707,19 +1710,57 @@ Namespace | Name | Import | **LanguageModels** | [OpenAiEmbeddingsResponse](docs/v2/LanguageModels/models/OpenAiEmbeddingsResponse.md) | `from foundry_sdk.v2.language_models.models import OpenAiEmbeddingsResponse` | **LanguageModels** | [OpenAiEmbeddingTokenUsage](docs/v2/LanguageModels/models/OpenAiEmbeddingTokenUsage.md) | `from foundry_sdk.v2.language_models.models import OpenAiEmbeddingTokenUsage` | **LanguageModels** | [OpenAiEncodingFormat](docs/v2/LanguageModels/models/OpenAiEncodingFormat.md) | `from foundry_sdk.v2.language_models.models import OpenAiEncodingFormat` | +**MediaSets** | [AffineTransform](docs/v2/MediaSets/models/AffineTransform.md) | `from foundry_sdk.v2.media_sets.models import AffineTransform` | +**MediaSets** | [AudioDecodeFormat](docs/v2/MediaSets/models/AudioDecodeFormat.md) | `from foundry_sdk.v2.media_sets.models import AudioDecodeFormat` | +**MediaSets** | [AudioMediaItemMetadata](docs/v2/MediaSets/models/AudioMediaItemMetadata.md) | `from foundry_sdk.v2.media_sets.models import AudioMediaItemMetadata` | +**MediaSets** | [AudioSpecification](docs/v2/MediaSets/models/AudioSpecification.md) | `from foundry_sdk.v2.media_sets.models import AudioSpecification` | +**MediaSets** | [BandInfo](docs/v2/MediaSets/models/BandInfo.md) | `from foundry_sdk.v2.media_sets.models import BandInfo` | **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** | [ColorInterpretation](docs/v2/MediaSets/models/ColorInterpretation.md) | `from foundry_sdk.v2.media_sets.models import ColorInterpretation` | +**MediaSets** | [CommonDicomDataElements](docs/v2/MediaSets/models/CommonDicomDataElements.md) | `from foundry_sdk.v2.media_sets.models import CommonDicomDataElements` | +**MediaSets** | [CoordinateReferenceSystem](docs/v2/MediaSets/models/CoordinateReferenceSystem.md) | `from foundry_sdk.v2.media_sets.models import CoordinateReferenceSystem` | +**MediaSets** | [DataType](docs/v2/MediaSets/models/DataType.md) | `from foundry_sdk.v2.media_sets.models import DataType` | +**MediaSets** | [DicomDataElementKey](docs/v2/MediaSets/models/DicomDataElementKey.md) | `from foundry_sdk.v2.media_sets.models import DicomDataElementKey` | +**MediaSets** | [DicomMediaItemMetadata](docs/v2/MediaSets/models/DicomMediaItemMetadata.md) | `from foundry_sdk.v2.media_sets.models import DicomMediaItemMetadata` | +**MediaSets** | [DicomMediaType](docs/v2/MediaSets/models/DicomMediaType.md) | `from foundry_sdk.v2.media_sets.models import DicomMediaType` | +**MediaSets** | [DicomMetaInformation](docs/v2/MediaSets/models/DicomMetaInformation.md) | `from foundry_sdk.v2.media_sets.models import DicomMetaInformation` | +**MediaSets** | [DicomMetaInformationV1](docs/v2/MediaSets/models/DicomMetaInformationV1.md) | `from foundry_sdk.v2.media_sets.models import DicomMetaInformationV1` | +**MediaSets** | [Dimensions](docs/v2/MediaSets/models/Dimensions.md) | `from foundry_sdk.v2.media_sets.models import Dimensions` | +**MediaSets** | [DocumentDecodeFormat](docs/v2/MediaSets/models/DocumentDecodeFormat.md) | `from foundry_sdk.v2.media_sets.models import DocumentDecodeFormat` | +**MediaSets** | [DocumentMediaItemMetadata](docs/v2/MediaSets/models/DocumentMediaItemMetadata.md) | `from foundry_sdk.v2.media_sets.models import DocumentMediaItemMetadata` | +**MediaSets** | [FlipAxis](docs/v2/MediaSets/models/FlipAxis.md) | `from foundry_sdk.v2.media_sets.models import FlipAxis` | +**MediaSets** | [GcpList](docs/v2/MediaSets/models/GcpList.md) | `from foundry_sdk.v2.media_sets.models import GcpList` | +**MediaSets** | [GeoMetadata](docs/v2/MediaSets/models/GeoMetadata.md) | `from foundry_sdk.v2.media_sets.models import GeoMetadata` | **MediaSets** | [GetMediaItemInfoResponse](docs/v2/MediaSets/models/GetMediaItemInfoResponse.md) | `from foundry_sdk.v2.media_sets.models import GetMediaItemInfoResponse` | **MediaSets** | [GetMediaItemRidByPathResponse](docs/v2/MediaSets/models/GetMediaItemRidByPathResponse.md) | `from foundry_sdk.v2.media_sets.models import GetMediaItemRidByPathResponse` | +**MediaSets** | [GpsMetadata](docs/v2/MediaSets/models/GpsMetadata.md) | `from foundry_sdk.v2.media_sets.models import GpsMetadata` | +**MediaSets** | [GroundControlPoint](docs/v2/MediaSets/models/GroundControlPoint.md) | `from foundry_sdk.v2.media_sets.models import GroundControlPoint` | +**MediaSets** | [ImageAttributeDomain](docs/v2/MediaSets/models/ImageAttributeDomain.md) | `from foundry_sdk.v2.media_sets.models import ImageAttributeDomain` | +**MediaSets** | [ImageAttributeKey](docs/v2/MediaSets/models/ImageAttributeKey.md) | `from foundry_sdk.v2.media_sets.models import ImageAttributeKey` | +**MediaSets** | [ImageryDecodeFormat](docs/v2/MediaSets/models/ImageryDecodeFormat.md) | `from foundry_sdk.v2.media_sets.models import ImageryDecodeFormat` | +**MediaSets** | [ImageryMediaItemMetadata](docs/v2/MediaSets/models/ImageryMediaItemMetadata.md) | `from foundry_sdk.v2.media_sets.models import ImageryMediaItemMetadata` | **MediaSets** | [LogicalTimestamp](docs/v2/MediaSets/models/LogicalTimestamp.md) | `from foundry_sdk.v2.media_sets.models import LogicalTimestamp` | **MediaSets** | [MediaAttribution](docs/v2/MediaSets/models/MediaAttribution.md) | `from foundry_sdk.v2.media_sets.models import MediaAttribution` | +**MediaSets** | [MediaItemMetadata](docs/v2/MediaSets/models/MediaItemMetadata.md) | `from foundry_sdk.v2.media_sets.models import MediaItemMetadata` | **MediaSets** | [MediaItemXmlFormat](docs/v2/MediaSets/models/MediaItemXmlFormat.md) | `from foundry_sdk.v2.media_sets.models import MediaItemXmlFormat` | +**MediaSets** | [Modality](docs/v2/MediaSets/models/Modality.md) | `from foundry_sdk.v2.media_sets.models import Modality` | +**MediaSets** | [Orientation](docs/v2/MediaSets/models/Orientation.md) | `from foundry_sdk.v2.media_sets.models import Orientation` | +**MediaSets** | [PaletteInterpretation](docs/v2/MediaSets/models/PaletteInterpretation.md) | `from foundry_sdk.v2.media_sets.models import PaletteInterpretation` | **MediaSets** | [PutMediaItemResponse](docs/v2/MediaSets/models/PutMediaItemResponse.md) | `from foundry_sdk.v2.media_sets.models import PutMediaItemResponse` | +**MediaSets** | [RotationAngle](docs/v2/MediaSets/models/RotationAngle.md) | `from foundry_sdk.v2.media_sets.models import RotationAngle` | +**MediaSets** | [SpreadsheetDecodeFormat](docs/v2/MediaSets/models/SpreadsheetDecodeFormat.md) | `from foundry_sdk.v2.media_sets.models import SpreadsheetDecodeFormat` | +**MediaSets** | [SpreadsheetMediaItemMetadata](docs/v2/MediaSets/models/SpreadsheetMediaItemMetadata.md) | `from foundry_sdk.v2.media_sets.models import SpreadsheetMediaItemMetadata` | **MediaSets** | [TrackedTransformationFailedResponse](docs/v2/MediaSets/models/TrackedTransformationFailedResponse.md) | `from foundry_sdk.v2.media_sets.models import TrackedTransformationFailedResponse` | **MediaSets** | [TrackedTransformationPendingResponse](docs/v2/MediaSets/models/TrackedTransformationPendingResponse.md) | `from foundry_sdk.v2.media_sets.models import TrackedTransformationPendingResponse` | **MediaSets** | [TrackedTransformationResponse](docs/v2/MediaSets/models/TrackedTransformationResponse.md) | `from foundry_sdk.v2.media_sets.models import TrackedTransformationResponse` | **MediaSets** | [TrackedTransformationSuccessfulResponse](docs/v2/MediaSets/models/TrackedTransformationSuccessfulResponse.md) | `from foundry_sdk.v2.media_sets.models import TrackedTransformationSuccessfulResponse` | **MediaSets** | [TransactionId](docs/v2/MediaSets/models/TransactionId.md) | `from foundry_sdk.v2.media_sets.models import TransactionId` | +**MediaSets** | [UnitInterpretation](docs/v2/MediaSets/models/UnitInterpretation.md) | `from foundry_sdk.v2.media_sets.models import UnitInterpretation` | +**MediaSets** | [UntypedMediaItemMetadata](docs/v2/MediaSets/models/UntypedMediaItemMetadata.md) | `from foundry_sdk.v2.media_sets.models import UntypedMediaItemMetadata` | +**MediaSets** | [VideoDecodeFormat](docs/v2/MediaSets/models/VideoDecodeFormat.md) | `from foundry_sdk.v2.media_sets.models import VideoDecodeFormat` | +**MediaSets** | [VideoMediaItemMetadata](docs/v2/MediaSets/models/VideoMediaItemMetadata.md) | `from foundry_sdk.v2.media_sets.models import VideoMediaItemMetadata` | +**MediaSets** | [VideoSpecification](docs/v2/MediaSets/models/VideoSpecification.md) | `from foundry_sdk.v2.media_sets.models import VideoSpecification` | **Models** | [CreateModelRequest](docs/v2/Models/models/CreateModelRequest.md) | `from foundry_sdk.v2.models.models import CreateModelRequest` | **Models** | [CreateModelVersionRequest](docs/v2/Models/models/CreateModelVersionRequest.md) | `from foundry_sdk.v2.models.models import CreateModelVersionRequest` | **Models** | [DillModelFiles](docs/v2/Models/models/DillModelFiles.md) | `from foundry_sdk.v2.models.models import DillModelFiles` | @@ -1813,6 +1854,9 @@ Namespace | Name | Import | **Ontologies** | [BoundingBoxValue](docs/v2/Ontologies/models/BoundingBoxValue.md) | `from foundry_sdk.v2.ontologies.models import BoundingBoxValue` | **Ontologies** | [CenterPoint](docs/v2/Ontologies/models/CenterPoint.md) | `from foundry_sdk.v2.ontologies.models import CenterPoint` | **Ontologies** | [CenterPointTypes](docs/v2/Ontologies/models/CenterPointTypes.md) | `from foundry_sdk.v2.ontologies.models import CenterPointTypes` | +**Ontologies** | [ConjunctiveMarkingSummary](docs/v2/Ontologies/models/ConjunctiveMarkingSummary.md) | `from foundry_sdk.v2.ontologies.models import ConjunctiveMarkingSummary` | +**Ontologies** | [ContainerConjunctiveMarkingSummary](docs/v2/Ontologies/models/ContainerConjunctiveMarkingSummary.md) | `from foundry_sdk.v2.ontologies.models import ContainerConjunctiveMarkingSummary` | +**Ontologies** | [ContainerDisjunctiveMarkingSummary](docs/v2/Ontologies/models/ContainerDisjunctiveMarkingSummary.md) | `from foundry_sdk.v2.ontologies.models import ContainerDisjunctiveMarkingSummary` | **Ontologies** | [ContainsAllTermsInOrderPrefixLastTerm](docs/v2/Ontologies/models/ContainsAllTermsInOrderPrefixLastTerm.md) | `from foundry_sdk.v2.ontologies.models import ContainsAllTermsInOrderPrefixLastTerm` | **Ontologies** | [ContainsAllTermsInOrderQuery](docs/v2/Ontologies/models/ContainsAllTermsInOrderQuery.md) | `from foundry_sdk.v2.ontologies.models import ContainsAllTermsInOrderQuery` | **Ontologies** | [ContainsAllTermsQuery](docs/v2/Ontologies/models/ContainsAllTermsQuery.md) | `from foundry_sdk.v2.ontologies.models import ContainsAllTermsQuery` | @@ -1855,6 +1899,7 @@ Namespace | Name | Import | **Ontologies** | [DeprecatedPropertyTypeStatus](docs/v2/Ontologies/models/DeprecatedPropertyTypeStatus.md) | `from foundry_sdk.v2.ontologies.models import DeprecatedPropertyTypeStatus` | **Ontologies** | [DerivedPropertyApiName](docs/v2/Ontologies/models/DerivedPropertyApiName.md) | `from foundry_sdk.v2.ontologies.models import DerivedPropertyApiName` | **Ontologies** | [DerivedPropertyDefinition](docs/v2/Ontologies/models/DerivedPropertyDefinition.md) | `from foundry_sdk.v2.ontologies.models import DerivedPropertyDefinition` | +**Ontologies** | [DisjunctiveMarkingSummary](docs/v2/Ontologies/models/DisjunctiveMarkingSummary.md) | `from foundry_sdk.v2.ontologies.models import DisjunctiveMarkingSummary` | **Ontologies** | [DividePropertyExpression](docs/v2/Ontologies/models/DividePropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import DividePropertyExpression` | **Ontologies** | [DoesNotIntersectBoundingBoxQuery](docs/v2/Ontologies/models/DoesNotIntersectBoundingBoxQuery.md) | `from foundry_sdk.v2.ontologies.models import DoesNotIntersectBoundingBoxQuery` | **Ontologies** | [DoesNotIntersectPolygonQuery](docs/v2/Ontologies/models/DoesNotIntersectPolygonQuery.md) | `from foundry_sdk.v2.ontologies.models import DoesNotIntersectPolygonQuery` | @@ -1865,6 +1910,7 @@ Namespace | Name | Import | **Ontologies** | [EntrySetType](docs/v2/Ontologies/models/EntrySetType.md) | `from foundry_sdk.v2.ontologies.models import EntrySetType` | **Ontologies** | [EnumConstraint](docs/v2/Ontologies/models/EnumConstraint.md) | `from foundry_sdk.v2.ontologies.models import EnumConstraint` | **Ontologies** | [EqualsQueryV2](docs/v2/Ontologies/models/EqualsQueryV2.md) | `from foundry_sdk.v2.ontologies.models import EqualsQueryV2` | +**Ontologies** | [ErrorComputingSecurity](docs/v2/Ontologies/models/ErrorComputingSecurity.md) | `from foundry_sdk.v2.ontologies.models import ErrorComputingSecurity` | **Ontologies** | [ExactDistinctAggregationV2](docs/v2/Ontologies/models/ExactDistinctAggregationV2.md) | `from foundry_sdk.v2.ontologies.models import ExactDistinctAggregationV2` | **Ontologies** | [ExamplePropertyTypeStatus](docs/v2/Ontologies/models/ExamplePropertyTypeStatus.md) | `from foundry_sdk.v2.ontologies.models import ExamplePropertyTypeStatus` | **Ontologies** | [ExecuteQueryRequest](docs/v2/Ontologies/models/ExecuteQueryRequest.md) | `from foundry_sdk.v2.ontologies.models import ExecuteQueryRequest` | @@ -1957,6 +2003,7 @@ Namespace | Name | Import | **Ontologies** | [LogicRuleArgument](docs/v2/Ontologies/models/LogicRuleArgument.md) | `from foundry_sdk.v2.ontologies.models import LogicRuleArgument` | **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** | [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` | **Ontologies** | [MediaMetadata](docs/v2/Ontologies/models/MediaMetadata.md) | `from foundry_sdk.v2.ontologies.models import MediaMetadata` | @@ -2071,9 +2118,12 @@ Namespace | Name | Import | **Ontologies** | [PropertyImplementation](docs/v2/Ontologies/models/PropertyImplementation.md) | `from foundry_sdk.v2.ontologies.models import PropertyImplementation` | **Ontologies** | [PropertyKnownTypeFormattingRule](docs/v2/Ontologies/models/PropertyKnownTypeFormattingRule.md) | `from foundry_sdk.v2.ontologies.models import PropertyKnownTypeFormattingRule` | **Ontologies** | [PropertyLoadLevel](docs/v2/Ontologies/models/PropertyLoadLevel.md) | `from foundry_sdk.v2.ontologies.models import PropertyLoadLevel` | +**Ontologies** | [PropertyMarkingSummary](docs/v2/Ontologies/models/PropertyMarkingSummary.md) | `from foundry_sdk.v2.ontologies.models import PropertyMarkingSummary` | **Ontologies** | [PropertyNumberFormattingRule](docs/v2/Ontologies/models/PropertyNumberFormattingRule.md) | `from foundry_sdk.v2.ontologies.models import PropertyNumberFormattingRule` | **Ontologies** | [PropertyNumberFormattingRuleType](docs/v2/Ontologies/models/PropertyNumberFormattingRuleType.md) | `from foundry_sdk.v2.ontologies.models import PropertyNumberFormattingRuleType` | **Ontologies** | [PropertyOrStructFieldOfPropertyImplementation](docs/v2/Ontologies/models/PropertyOrStructFieldOfPropertyImplementation.md) | `from foundry_sdk.v2.ontologies.models import PropertyOrStructFieldOfPropertyImplementation` | +**Ontologies** | [PropertySecurities](docs/v2/Ontologies/models/PropertySecurities.md) | `from foundry_sdk.v2.ontologies.models import PropertySecurities` | +**Ontologies** | [PropertySecurity](docs/v2/Ontologies/models/PropertySecurity.md) | `from foundry_sdk.v2.ontologies.models import PropertySecurity` | **Ontologies** | [PropertyTimestampFormattingRule](docs/v2/Ontologies/models/PropertyTimestampFormattingRule.md) | `from foundry_sdk.v2.ontologies.models import PropertyTimestampFormattingRule` | **Ontologies** | [PropertyTypeApiName](docs/v2/Ontologies/models/PropertyTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import PropertyTypeApiName` | **Ontologies** | [PropertyTypeReference](docs/v2/Ontologies/models/PropertyTypeReference.md) | `from foundry_sdk.v2.ontologies.models import PropertyTypeReference` | @@ -2192,6 +2242,7 @@ Namespace | Name | Import | **Ontologies** | [UniqueIdentifierArgument](docs/v2/Ontologies/models/UniqueIdentifierArgument.md) | `from foundry_sdk.v2.ontologies.models import UniqueIdentifierArgument` | **Ontologies** | [UniqueIdentifierLinkId](docs/v2/Ontologies/models/UniqueIdentifierLinkId.md) | `from foundry_sdk.v2.ontologies.models import UniqueIdentifierLinkId` | **Ontologies** | [UniqueIdentifierValue](docs/v2/Ontologies/models/UniqueIdentifierValue.md) | `from foundry_sdk.v2.ontologies.models import UniqueIdentifierValue` | +**Ontologies** | [UnsupportedPolicy](docs/v2/Ontologies/models/UnsupportedPolicy.md) | `from foundry_sdk.v2.ontologies.models import UnsupportedPolicy` | **Ontologies** | [UuidConstraint](docs/v2/Ontologies/models/UuidConstraint.md) | `from foundry_sdk.v2.ontologies.models import UuidConstraint` | **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` | @@ -2398,6 +2449,8 @@ Namespace | Name | Import | **Core** | [TraceParent](docs/v1/Core/models/TraceParent.md) | `from foundry_sdk.v1.core.models import TraceParent` | **Core** | [TraceState](docs/v1/Core/models/TraceState.md) | `from foundry_sdk.v1.core.models import TraceState` | **Core** | [UnsupportedType](docs/v1/Core/models/UnsupportedType.md) | `from foundry_sdk.v1.core.models import UnsupportedType` | +**Core** | [UnsupportedTypeParamKey](docs/v1/Core/models/UnsupportedTypeParamKey.md) | `from foundry_sdk.v1.core.models import UnsupportedTypeParamKey` | +**Core** | [UnsupportedTypeParamValue](docs/v1/Core/models/UnsupportedTypeParamValue.md) | `from foundry_sdk.v1.core.models import UnsupportedTypeParamValue` | **Datasets** | [Branch](docs/v1/Datasets/models/Branch.md) | `from foundry_sdk.v1.datasets.models import Branch` | **Datasets** | [BranchId](docs/v1/Datasets/models/BranchId.md) | `from foundry_sdk.v1.datasets.models import BranchId` | **Datasets** | [CreateBranchRequest](docs/v1/Datasets/models/CreateBranchRequest.md) | `from foundry_sdk.v1.datasets.models import CreateBranchRequest` | @@ -2937,6 +2990,7 @@ Namespace | Name | Import | **MediaSets** | TemporaryMediaUploadInsufficientPermissions | `from foundry_sdk.v2.media_sets.errors import TemporaryMediaUploadInsufficientPermissions` | **MediaSets** | TemporaryMediaUploadUnknownFailure | `from foundry_sdk.v2.media_sets.errors import TemporaryMediaUploadUnknownFailure` | **MediaSets** | TransformedMediaItemNotFound | `from foundry_sdk.v2.media_sets.errors import TransformedMediaItemNotFound` | +**MediaSets** | UnexpectedMetadataType | `from foundry_sdk.v2.media_sets.errors import UnexpectedMetadataType` | **Models** | CondaSolveFailureForProvidedPackages | `from foundry_sdk.v2.models.errors import CondaSolveFailureForProvidedPackages` | **Models** | CreateModelPermissionDenied | `from foundry_sdk.v2.models.errors import CreateModelPermissionDenied` | **Models** | CreateModelVersionPermissionDenied | `from foundry_sdk.v2.models.errors import CreateModelVersionPermissionDenied` | diff --git a/docs-snippets-npm/package.json b/docs-snippets-npm/package.json index 16cac5570..16e42b060 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.1416.1", + "minVersion": "1.1429.1", "maxVersion": "1.x.x", "optional": false } diff --git a/docs-snippets-npm/src/index.ts b/docs-snippets-npm/src/index.ts index 8ef7ac4c3..f85145583 100644 --- a/docs-snippets-npm/src/index.ts +++ b/docs-snippets-npm/src/index.ts @@ -1108,6 +1108,11 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets value | {"firstName": "Alex", "lastName": "Karp"} | diff --git a/docs/v2/Core/models/UnsupportedType.md b/docs/v2/Core/models/UnsupportedType.md index 271fa007b..b427538dd 100644 --- a/docs/v2/Core/models/UnsupportedType.md +++ b/docs/v2/Core/models/UnsupportedType.md @@ -6,6 +6,7 @@ UnsupportedType | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **unsupported_type** | str | Yes | | +**params** | Dict[UnsupportedTypeParamKey, UnsupportedTypeParamValue] | Yes | | **type** | Literal["unsupported"] | Yes | None | diff --git a/docs/v2/Core/models/UnsupportedTypeParamKey.md b/docs/v2/Core/models/UnsupportedTypeParamKey.md new file mode 100644 index 000000000..3dde6af29 --- /dev/null +++ b/docs/v2/Core/models/UnsupportedTypeParamKey.md @@ -0,0 +1,11 @@ +# UnsupportedTypeParamKey + +UnsupportedTypeParamKey + +## 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/Core/models/UnsupportedTypeParamValue.md b/docs/v2/Core/models/UnsupportedTypeParamValue.md new file mode 100644 index 000000000..386599fde --- /dev/null +++ b/docs/v2/Core/models/UnsupportedTypeParamValue.md @@ -0,0 +1,11 @@ +# UnsupportedTypeParamValue + +UnsupportedTypeParamValue + +## 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/Datasets/models/ViewBackingDataset.md b/docs/v2/Datasets/models/ViewBackingDataset.md index 5ce3b00c0..a7884deff 100644 --- a/docs/v2/Datasets/models/ViewBackingDataset.md +++ b/docs/v2/Datasets/models/ViewBackingDataset.md @@ -5,7 +5,7 @@ One of the Datasets backing a View. ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**branch** | BranchName | Yes | | +**branch** | Optional[BranchName] | No | The branch of the backing dataset. If not specified, defaults to the branch of the View. | **dataset_rid** | DatasetRid | Yes | | diff --git a/docs/v2/MediaSets/MediaSet.md b/docs/v2/MediaSets/MediaSet.md index 218237f88..36dca2d8f 100644 --- a/docs/v2/MediaSets/MediaSet.md +++ b/docs/v2/MediaSets/MediaSet.md @@ -8,6 +8,7 @@ Method | HTTP request | Release Stage | [**create**](#create) | **POST** /v2/mediasets/{mediaSetRid}/transactions | Public Beta | [**get_rid_by_path**](#get_rid_by_path) | **GET** /v2/mediasets/{mediaSetRid}/items/getRidByPath | Public Beta | [**info**](#info) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid} | Public Beta | +[**metadata**](#metadata) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/metadata | Public Beta | [**read**](#read) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/content | Public Beta | [**read_original**](#read_original) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/original | Public Beta | [**reference**](#reference) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/reference | Public Beta | @@ -367,6 +368,66 @@ 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) +# **metadata** +Gets detailed metadata about the media item, including type-specific information +such as dimensions for images, duration for audio/video, page count for documents, etc. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**media_set_rid** | MediaSetRid | The RID of the media set. | | +**media_item_rid** | MediaItemRid | The RID of the media item. | | +**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | +**read_token** | Optional[MediaItemReadToken] | | [optional] | + +### Return type +**MediaItemMetadata** + +### Example + +```python +from foundry_sdk import FoundryClient +import foundry_sdk +from pprint import pprint + +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") + +# MediaSetRid | The RID of the media set. +media_set_rid = None +# MediaItemRid | The RID of the media item. +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 +# Optional[MediaItemReadToken] +read_token = None + + +try: + api_response = client.media_sets.MediaSet.metadata( + media_set_rid, media_item_rid, preview=preview, read_token=read_token + ) + print("The metadata response:\n") + pprint(api_response) +except foundry_sdk.PalantirRPCException as e: + print("HTTP error when calling MediaSet.metadata: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | MediaItemMetadata | | application/json | + +[[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) + # **read** Gets the content of a media item. diff --git a/docs/v2/MediaSets/models/AffineTransform.md b/docs/v2/MediaSets/models/AffineTransform.md new file mode 100644 index 000000000..a4f46c071 --- /dev/null +++ b/docs/v2/MediaSets/models/AffineTransform.md @@ -0,0 +1,16 @@ +# AffineTransform + +An affine transformation for geo-referencing. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**x_translate** | Optional[float] | No | | +**x_scale** | Optional[float] | No | | +**x_shear** | Optional[float] | No | | +**y_translate** | Optional[float] | No | | +**y_shear** | Optional[float] | No | | +**y_scale** | Optional[float] | 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/MediaSets/models/AudioDecodeFormat.md b/docs/v2/MediaSets/models/AudioDecodeFormat.md new file mode 100644 index 000000000..e12593749 --- /dev/null +++ b/docs/v2/MediaSets/models/AudioDecodeFormat.md @@ -0,0 +1,17 @@ +# AudioDecodeFormat + +The format of an audio media item. + +| **Value** | +| --------- | +| `"FLAC"` | +| `"MP2"` | +| `"MP3"` | +| `"MP4"` | +| `"NIST_SPHERE"` | +| `"OGG"` | +| `"WAV"` | +| `"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/AudioMediaItemMetadata.md b/docs/v2/MediaSets/models/AudioMediaItemMetadata.md new file mode 100644 index 000000000..5d02b6d1b --- /dev/null +++ b/docs/v2/MediaSets/models/AudioMediaItemMetadata.md @@ -0,0 +1,14 @@ +# AudioMediaItemMetadata + +Metadata for audio media items. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**format** | AudioDecodeFormat | Yes | | +**specification** | AudioSpecification | Yes | | +**size_bytes** | int | Yes | The size of the media item in bytes. | +**type** | Literal["audio"] | 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/AudioSpecification.md b/docs/v2/MediaSets/models/AudioSpecification.md new file mode 100644 index 000000000..7c201619a --- /dev/null +++ b/docs/v2/MediaSets/models/AudioSpecification.md @@ -0,0 +1,13 @@ +# AudioSpecification + +Technical specifications for audio media items. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**bit_rate** | int | Yes | Approximate (average) bits per second of the audio, rounded up in case of a fractional average bits per second. | +**duration_seconds** | float | Yes | Approximate duration of the audio, in seconds with up to two decimal digits (rounded up). | +**number_of_channels** | Optional[int] | No | Number of audio channels in the audio stream. | + + +[[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/BandInfo.md b/docs/v2/MediaSets/models/BandInfo.md new file mode 100644 index 000000000..9d8924409 --- /dev/null +++ b/docs/v2/MediaSets/models/BandInfo.md @@ -0,0 +1,14 @@ +# BandInfo + +Information about a band in an image. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data_type** | Optional[DataType] | No | | +**color_interpretation** | Optional[ColorInterpretation] | No | | +**palette_interpretation** | Optional[PaletteInterpretation] | No | | +**unit_interpretation** | Optional[UnitInterpretation] | 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/MediaSets/models/ColorInterpretation.md b/docs/v2/MediaSets/models/ColorInterpretation.md new file mode 100644 index 000000000..3b9e6de1f --- /dev/null +++ b/docs/v2/MediaSets/models/ColorInterpretation.md @@ -0,0 +1,26 @@ +# ColorInterpretation + +The color interpretation of a band. + +| **Value** | +| --------- | +| `"UNDEFINED"` | +| `"GRAY"` | +| `"PALETTE_INDEX"` | +| `"RED"` | +| `"GREEN"` | +| `"BLUE"` | +| `"ALPHA"` | +| `"HUE"` | +| `"SATURATION"` | +| `"LIGHTNESS"` | +| `"CYAN"` | +| `"MAGENTA"` | +| `"YELLOW"` | +| `"BLACK"` | +| `"Y_CB_CR_SPACE_Y"` | +| `"Y_CB_CR_SPACE_CB"` | +| `"Y_CB_CR_SPACE_CR"` | + + +[[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/CommonDicomDataElements.md b/docs/v2/MediaSets/models/CommonDicomDataElements.md new file mode 100644 index 000000000..e910a1433 --- /dev/null +++ b/docs/v2/MediaSets/models/CommonDicomDataElements.md @@ -0,0 +1,18 @@ +# CommonDicomDataElements + +Common DICOM data elements. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**number_frames** | Optional[int] | No | The number of frames in the DICOM file. | +**modality** | Optional[Modality] | No | | +**patient_id** | Optional[str] | No | The patient ID. | +**study_id** | Optional[str] | No | The study ID. | +**study_uid** | Optional[str] | No | The study UID. | +**series_uid** | Optional[str] | No | The series UID. | +**study_time** | Optional[datetime] | No | The study time. | +**series_time** | Optional[datetime] | No | The series time. | + + +[[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/CoordinateReferenceSystem.md b/docs/v2/MediaSets/models/CoordinateReferenceSystem.md new file mode 100644 index 000000000..040cebe44 --- /dev/null +++ b/docs/v2/MediaSets/models/CoordinateReferenceSystem.md @@ -0,0 +1,11 @@ +# CoordinateReferenceSystem + +The coordinate reference system for geo-referenced imagery. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**wkt** | Optional[str] | No | The Well-Known Text representation of the CRS. | + + +[[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/DataType.md b/docs/v2/MediaSets/models/DataType.md new file mode 100644 index 000000000..5340571cc --- /dev/null +++ b/docs/v2/MediaSets/models/DataType.md @@ -0,0 +1,24 @@ +# DataType + +The data type of a band. + +| **Value** | +| --------- | +| `"UNDEFINED"` | +| `"BYTE"` | +| `"UINT16"` | +| `"INT16"` | +| `"UINT32"` | +| `"INT32"` | +| `"FLOAT32"` | +| `"FLOAT64"` | +| `"COMPLEX_INT16"` | +| `"COMPLEX_INT32"` | +| `"COMPLEX_FLOAT32"` | +| `"COMPLEX_FLOAT64"` | +| `"UINT64"` | +| `"INT64"` | +| `"INT8"` | + + +[[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/DicomDataElementKey.md b/docs/v2/MediaSets/models/DicomDataElementKey.md new file mode 100644 index 000000000..c8acccdba --- /dev/null +++ b/docs/v2/MediaSets/models/DicomDataElementKey.md @@ -0,0 +1,11 @@ +# DicomDataElementKey + +The key of a DICOM data element. + +## 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/MediaSets/models/DicomMediaItemMetadata.md b/docs/v2/MediaSets/models/DicomMediaItemMetadata.md new file mode 100644 index 000000000..a9c6802a6 --- /dev/null +++ b/docs/v2/MediaSets/models/DicomMediaItemMetadata.md @@ -0,0 +1,16 @@ +# DicomMediaItemMetadata + +Metadata for DICOM (Digital Imaging and Communications in Medicine) media items. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**meta_information** | DicomMetaInformation | Yes | | +**media_type** | DicomMediaType | Yes | | +**common_data_elements** | CommonDicomDataElements | Yes | | +**other_data_elements** | Dict[DicomDataElementKey, Any] | Yes | The data elements for a particular DICOM file outside of the media contained within it and the data elements within the commonDataElements field. | +**size_bytes** | int | Yes | The size of the media item in bytes. | +**type** | Literal["dicom"] | 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/DicomMediaType.md b/docs/v2/MediaSets/models/DicomMediaType.md new file mode 100644 index 000000000..9213ab56d --- /dev/null +++ b/docs/v2/MediaSets/models/DicomMediaType.md @@ -0,0 +1,13 @@ +# DicomMediaType + +The type of DICOM media. + +| **Value** | +| --------- | +| `"IMAGE"` | +| `"MULTI_FRAME_IMAGE"` | +| `"VIDEO"` | +| `"STRUCTURED_REPORT"` | + + +[[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/DicomMetaInformation.md b/docs/v2/MediaSets/models/DicomMetaInformation.md new file mode 100644 index 000000000..d9abf9775 --- /dev/null +++ b/docs/v2/MediaSets/models/DicomMetaInformation.md @@ -0,0 +1,11 @@ +# DicomMetaInformation + +DICOM meta information. + +## Type +```python +DicomMetaInformationV1 +``` + + +[[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/DicomMetaInformationV1.md b/docs/v2/MediaSets/models/DicomMetaInformationV1.md new file mode 100644 index 000000000..c18438718 --- /dev/null +++ b/docs/v2/MediaSets/models/DicomMetaInformationV1.md @@ -0,0 +1,14 @@ +# DicomMetaInformationV1 + +DICOM meta information version 1. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**media_storage_sop** | str | Yes | The Media Storage SOP (Service-Object Pair) Class UID, which identifies the type of DICOM object stored (e.g., CT Image, MR Image). | +**media_storage_sop_instance** | str | Yes | The Media Storage SOP Instance UID. | +**transfer_syntax** | str | Yes | The Transfer Syntax UID, which specifies how the DICOM data is encoded (e.g., compression method, byte ordering). | +**type** | Literal["v1"] | 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/Dimensions.md b/docs/v2/MediaSets/models/Dimensions.md new file mode 100644 index 000000000..7e85fa6b6 --- /dev/null +++ b/docs/v2/MediaSets/models/Dimensions.md @@ -0,0 +1,12 @@ +# Dimensions + +The dimensions of an image. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**width** | int | Yes | The width of the image in pixels. | +**height** | int | Yes | The height of the image in pixels. | + + +[[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/DocumentDecodeFormat.md b/docs/v2/MediaSets/models/DocumentDecodeFormat.md new file mode 100644 index 000000000..cb0adeef8 --- /dev/null +++ b/docs/v2/MediaSets/models/DocumentDecodeFormat.md @@ -0,0 +1,13 @@ +# DocumentDecodeFormat + +The format of a document media item. + +| **Value** | +| --------- | +| `"PDF"` | +| `"DOCX"` | +| `"TXT"` | +| `"PPTX"` | + + +[[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/DocumentMediaItemMetadata.md b/docs/v2/MediaSets/models/DocumentMediaItemMetadata.md new file mode 100644 index 000000000..7b1366c97 --- /dev/null +++ b/docs/v2/MediaSets/models/DocumentMediaItemMetadata.md @@ -0,0 +1,16 @@ +# DocumentMediaItemMetadata + +Metadata for document media items. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**format** | DocumentDecodeFormat | Yes | | +**pages** | Optional[int] | No | The number of pages in the document. | +**size_bytes** | int | Yes | The size of the media item in bytes. | +**title** | Optional[str] | No | The title of the document, if available. | +**author** | Optional[str] | No | The author of the document, if available. | +**type** | Literal["document"] | 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/FlipAxis.md b/docs/v2/MediaSets/models/FlipAxis.md new file mode 100644 index 000000000..b7894b872 --- /dev/null +++ b/docs/v2/MediaSets/models/FlipAxis.md @@ -0,0 +1,12 @@ +# FlipAxis + +The flip axis from EXIF orientation. + +| **Value** | +| --------- | +| `"HORIZONTAL"` | +| `"VERTICAL"` | +| `"UNKNOWN"` | + + +[[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/GcpList.md b/docs/v2/MediaSets/models/GcpList.md new file mode 100644 index 000000000..70e530ad5 --- /dev/null +++ b/docs/v2/MediaSets/models/GcpList.md @@ -0,0 +1,11 @@ +# GcpList + +A list of ground control points for geo-referencing. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**gcps** | List[GroundControlPoint] | 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/MediaSets/models/GeoMetadata.md b/docs/v2/MediaSets/models/GeoMetadata.md new file mode 100644 index 000000000..c4145f2d7 --- /dev/null +++ b/docs/v2/MediaSets/models/GeoMetadata.md @@ -0,0 +1,14 @@ +# GeoMetadata + +Embedded geo-referencing data for an image. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**crs** | Optional[CoordinateReferenceSystem] | No | | +**geotransform** | Optional[AffineTransform] | No | | +**gcp_info** | Optional[GcpList] | No | | +**gps_data** | Optional[GpsMetadata] | 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/MediaSets/models/GpsMetadata.md b/docs/v2/MediaSets/models/GpsMetadata.md new file mode 100644 index 000000000..ffe447972 --- /dev/null +++ b/docs/v2/MediaSets/models/GpsMetadata.md @@ -0,0 +1,13 @@ +# GpsMetadata + +GPS location metadata extracted from EXIF data embedded in the image. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**latitude** | Optional[float] | No | | +**longitude** | Optional[float] | No | | +**altitude** | Optional[float] | 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/MediaSets/models/GroundControlPoint.md b/docs/v2/MediaSets/models/GroundControlPoint.md new file mode 100644 index 000000000..d669ce572 --- /dev/null +++ b/docs/v2/MediaSets/models/GroundControlPoint.md @@ -0,0 +1,15 @@ +# GroundControlPoint + +A ground control point for geo-referencing. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**pix_x** | Optional[float] | No | The pixel X coordinate. | +**pix_y** | Optional[float] | No | The pixel Y coordinate. | +**proj_x** | Optional[float] | No | The projected X coordinate. | +**proj_y** | Optional[float] | No | The projected Y coordinate. | +**proj_z** | Optional[float] | No | The projected Z coordinate. | + + +[[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/ImageAttributeDomain.md b/docs/v2/MediaSets/models/ImageAttributeDomain.md new file mode 100644 index 000000000..824630448 --- /dev/null +++ b/docs/v2/MediaSets/models/ImageAttributeDomain.md @@ -0,0 +1,11 @@ +# ImageAttributeDomain + +The domain of an image attribute. + +## 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/MediaSets/models/ImageAttributeKey.md b/docs/v2/MediaSets/models/ImageAttributeKey.md new file mode 100644 index 000000000..06230e1c0 --- /dev/null +++ b/docs/v2/MediaSets/models/ImageAttributeKey.md @@ -0,0 +1,11 @@ +# ImageAttributeKey + +The key of an image attribute within a domain. + +## 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/MediaSets/models/ImageryDecodeFormat.md b/docs/v2/MediaSets/models/ImageryDecodeFormat.md new file mode 100644 index 000000000..1778e0864 --- /dev/null +++ b/docs/v2/MediaSets/models/ImageryDecodeFormat.md @@ -0,0 +1,16 @@ +# ImageryDecodeFormat + +The format of an imagery media item. + +| **Value** | +| --------- | +| `"BMP"` | +| `"TIFF"` | +| `"NITF"` | +| `"JP2K"` | +| `"JPG"` | +| `"PNG"` | +| `"WEBP"` | + + +[[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/ImageryMediaItemMetadata.md b/docs/v2/MediaSets/models/ImageryMediaItemMetadata.md new file mode 100644 index 000000000..a3f85a0fa --- /dev/null +++ b/docs/v2/MediaSets/models/ImageryMediaItemMetadata.md @@ -0,0 +1,20 @@ +# ImageryMediaItemMetadata + +Metadata for imagery (image) media items. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**format** | ImageryDecodeFormat | Yes | | +**dimensions** | Optional[Dimensions] | No | | +**bands** | List[BandInfo] | Yes | Information about the bands of the image, if available. | +**attributes** | Dict[ImageAttributeDomain, Dict[ImageAttributeKey, str]] | Yes | The metadata attributes described in the image header in the form of a map >. For the default domain, or when the domain is not specified, the domain key will be the empty string (""). | +**icc_profile** | Optional[str] | No | The base64-encoded ICC profile for the image, if available. | +**geo** | Optional[GeoMetadata] | No | | +**pages** | Optional[int] | No | The number of pages associated with this image. Usually 1, but may be more for some formats (multi-page TIFFs, for example). | +**orientation** | Optional[Orientation] | No | | +**size_bytes** | int | Yes | The size of the media item in bytes. | +**type** | Literal["imagery"] | 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/MediaItemMetadata.md b/docs/v2/MediaSets/models/MediaItemMetadata.md new file mode 100644 index 000000000..6bc751f27 --- /dev/null +++ b/docs/v2/MediaSets/models/MediaItemMetadata.md @@ -0,0 +1,23 @@ +# MediaItemMetadata + +Detailed metadata about a media item, including type-specific information such as dimensions for images, +duration for audio/video, page count for documents, etc. + + +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 +| ------------ | ------------- +DocumentMediaItemMetadata | document +ImageryMediaItemMetadata | imagery +SpreadsheetMediaItemMetadata | spreadsheet +UntypedMediaItemMetadata | untyped +AudioMediaItemMetadata | audio +VideoMediaItemMetadata | video +DicomMediaItemMetadata | dicom + + +[[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/Modality.md b/docs/v2/MediaSets/models/Modality.md new file mode 100644 index 000000000..86f6fe107 --- /dev/null +++ b/docs/v2/MediaSets/models/Modality.md @@ -0,0 +1,99 @@ +# Modality + +DICOM modality code. A list of modalities and their meanings can be found in the DICOM specification. +https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.3.html#sect_C.7.3.1.1.1 + + +| **Value** | +| --------- | +| `"AR"` | +| `"ASMT"` | +| `"AU"` | +| `"BDUS"` | +| `"BI"` | +| `"BMD"` | +| `"CR"` | +| `"CT"` | +| `"CTPROTOCOL"` | +| `"DG"` | +| `"DOC"` | +| `"DX"` | +| `"ECG"` | +| `"EPS"` | +| `"ES"` | +| `"FID"` | +| `"GM"` | +| `"HC"` | +| `"HD"` | +| `"IO"` | +| `"IOL"` | +| `"IVOCT"` | +| `"IVUS"` | +| `"KER"` | +| `"KO"` | +| `"LEN"` | +| `"LS"` | +| `"MG"` | +| `"MR"` | +| `"M3D"` | +| `"NM"` | +| `"OAM"` | +| `"OCT"` | +| `"OP"` | +| `"OPM"` | +| `"OPT"` | +| `"OPTBSV"` | +| `"OPTENF"` | +| `"OPV"` | +| `"OSS"` | +| `"OT"` | +| `"PLAN"` | +| `"PR"` | +| `"PT"` | +| `"PX"` | +| `"REG"` | +| `"RESP"` | +| `"RF"` | +| `"RG"` | +| `"RTDOSE"` | +| `"RTIMAGE"` | +| `"RTINTENT"` | +| `"RTPLAN"` | +| `"RTRAD"` | +| `"RTRECORD"` | +| `"RTSEGANN"` | +| `"RTSTRUCT"` | +| `"RWV"` | +| `"SEG"` | +| `"SM"` | +| `"SMR"` | +| `"SR"` | +| `"SRF"` | +| `"STAIN"` | +| `"TEXTUREMAP"` | +| `"TG"` | +| `"US"` | +| `"VA"` | +| `"XA"` | +| `"XC"` | +| `"AS"` | +| `"CD"` | +| `"CF"` | +| `"CP"` | +| `"CS"` | +| `"DD"` | +| `"DF"` | +| `"DM"` | +| `"DS"` | +| `"EC"` | +| `"FA"` | +| `"FS"` | +| `"LP"` | +| `"MA"` | +| `"MS"` | +| `"OPR"` | +| `"ST"` | +| `"VF"` | + + +[[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/Orientation.md b/docs/v2/MediaSets/models/Orientation.md new file mode 100644 index 000000000..03a06edc6 --- /dev/null +++ b/docs/v2/MediaSets/models/Orientation.md @@ -0,0 +1,12 @@ +# Orientation + +The orientation information as encoded in EXIF metadata. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rotation_angle** | Optional[RotationAngle] | No | | +**flip_axis** | Optional[FlipAxis] | 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/MediaSets/models/PaletteInterpretation.md b/docs/v2/MediaSets/models/PaletteInterpretation.md new file mode 100644 index 000000000..10af1eda8 --- /dev/null +++ b/docs/v2/MediaSets/models/PaletteInterpretation.md @@ -0,0 +1,14 @@ +# PaletteInterpretation + +The palette interpretation of a band. + +| **Value** | +| --------- | +| `"GRAY"` | +| `"RGB"` | +| `"RGBA"` | +| `"CMYK"` | +| `"HLS"` | + + +[[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/RotationAngle.md b/docs/v2/MediaSets/models/RotationAngle.md new file mode 100644 index 000000000..918edef8f --- /dev/null +++ b/docs/v2/MediaSets/models/RotationAngle.md @@ -0,0 +1,13 @@ +# RotationAngle + +The rotation angle from EXIF orientation. + +| **Value** | +| --------- | +| `"DEGREE_90"` | +| `"DEGREE_180"` | +| `"DEGREE_270"` | +| `"UNKNOWN"` | + + +[[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/SpreadsheetDecodeFormat.md b/docs/v2/MediaSets/models/SpreadsheetDecodeFormat.md new file mode 100644 index 000000000..5a4a1e933 --- /dev/null +++ b/docs/v2/MediaSets/models/SpreadsheetDecodeFormat.md @@ -0,0 +1,10 @@ +# SpreadsheetDecodeFormat + +The format of a spreadsheet media item. + +| **Value** | +| --------- | +| `"XLSX"` | + + +[[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/SpreadsheetMediaItemMetadata.md b/docs/v2/MediaSets/models/SpreadsheetMediaItemMetadata.md new file mode 100644 index 000000000..f5e0fbdc9 --- /dev/null +++ b/docs/v2/MediaSets/models/SpreadsheetMediaItemMetadata.md @@ -0,0 +1,16 @@ +# SpreadsheetMediaItemMetadata + +Metadata for spreadsheet media items. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**format** | SpreadsheetDecodeFormat | Yes | | +**sheet_names** | List[str] | Yes | The names of the sheets in the spreadsheet. | +**size_bytes** | int | Yes | The size of the media item in bytes. | +**title** | Optional[str] | No | The title of the spreadsheet, if available. | +**author** | Optional[str] | No | The author of the spreadsheet, if available. | +**type** | Literal["spreadsheet"] | 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/UnitInterpretation.md b/docs/v2/MediaSets/models/UnitInterpretation.md new file mode 100644 index 000000000..bd7fb96d5 --- /dev/null +++ b/docs/v2/MediaSets/models/UnitInterpretation.md @@ -0,0 +1,13 @@ +# UnitInterpretation + +The unit interpretation for a band. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**unit** | Optional[str] | No | | +**scale** | Optional[float] | No | | +**offset** | Optional[float] | 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/MediaSets/models/UntypedMediaItemMetadata.md b/docs/v2/MediaSets/models/UntypedMediaItemMetadata.md new file mode 100644 index 000000000..e5cc3a0c5 --- /dev/null +++ b/docs/v2/MediaSets/models/UntypedMediaItemMetadata.md @@ -0,0 +1,12 @@ +# UntypedMediaItemMetadata + +Metadata for untyped media items (media items without a recognized type). + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**size_bytes** | int | Yes | The size of the media item in bytes. | +**type** | Literal["untyped"] | 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/VideoDecodeFormat.md b/docs/v2/MediaSets/models/VideoDecodeFormat.md new file mode 100644 index 000000000..fb9278410 --- /dev/null +++ b/docs/v2/MediaSets/models/VideoDecodeFormat.md @@ -0,0 +1,13 @@ +# VideoDecodeFormat + +The format of a video media item. + +| **Value** | +| --------- | +| `"MP4"` | +| `"MKV"` | +| `"MOV"` | +| `"TS"` | + + +[[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/VideoMediaItemMetadata.md b/docs/v2/MediaSets/models/VideoMediaItemMetadata.md new file mode 100644 index 000000000..a108062b3 --- /dev/null +++ b/docs/v2/MediaSets/models/VideoMediaItemMetadata.md @@ -0,0 +1,14 @@ +# VideoMediaItemMetadata + +Metadata for video media items. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**format** | VideoDecodeFormat | Yes | | +**specification** | VideoSpecification | Yes | | +**size_bytes** | int | Yes | The size of the media item in bytes. | +**type** | Literal["video"] | 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/VideoSpecification.md b/docs/v2/MediaSets/models/VideoSpecification.md new file mode 100644 index 000000000..3a219c946 --- /dev/null +++ b/docs/v2/MediaSets/models/VideoSpecification.md @@ -0,0 +1,12 @@ +# VideoSpecification + +Technical specifications for video media items. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**bit_rate** | int | Yes | Approximate (average) bits per second of the video, rounded up in case of a fractional average bits per second. | +**duration_seconds** | float | Yes | Approximate duration of the video, in seconds with up to two decimal digits (rounded up). | + + +[[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 4af9f644d..cc22a8d11 100644 --- a/docs/v2/Ontologies/OntologyObject.md +++ b/docs/v2/Ontologies/OntologyObject.md @@ -373,21 +373,21 @@ Partial terms are not matched by terms filters except where explicitly noted. ### Parameters -Name | Type | Description | Notes | -------------- |------------------------------------| ------------- | ------------- | -**ontology** | OntologyIdentifier | | | -**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. | | -**select_v2** | Optional[List[PropertyIdentifier]] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | | -**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] | -**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] | -**order_by** | Optional[SearchOrderByV2] | | [optional] | -**page_size** | Optional[PageSize] | | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | -**sdk_version** | Optional[SdkVersion] | The version of the generated SDK. | [optional] | -**snapshot** | Optional[bool] | 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. | [optional] | -**where** | Optional[SearchJsonQueryV2] | | [optional] | +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | | | +**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. | | +**select_v2** | List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | | +**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] | +**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] | +**order_by** | Optional[SearchOrderByV2] | | [optional] | +**page_size** | Optional[PageSize] | | [optional] | +**page_token** | Optional[PageToken] | | [optional] | +**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | +**sdk_version** | Optional[SdkVersion] | The version of the generated SDK. | [optional] | +**snapshot** | Optional[bool] | 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. | [optional] | +**where** | Optional[SearchJsonQueryV2] | | [optional] | ### Return type **SearchObjectsResponseV2** diff --git a/docs/v2/Ontologies/OntologyObjectSet.md b/docs/v2/Ontologies/OntologyObjectSet.md index 848a09a1e..0030873e6 100644 --- a/docs/v2/Ontologies/OntologyObjectSet.md +++ b/docs/v2/Ontologies/OntologyObjectSet.md @@ -116,6 +116,7 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | | | **object_set** | ObjectSet | | | +**branch** | Optional[FoundryBranch] | The Foundry branch to reference. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. | [optional] | **sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | **sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | @@ -135,6 +136,8 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa ontology = "palantir" # ObjectSet object_set = {"type": "base", "objectType": "Employee"} +# Optional[FoundryBranch] | The Foundry branch to reference. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. +branch = None # Optional[SdkPackageRid] | The package rid of the generated SDK. sdk_package_rid = None # Optional[SdkVersion] | The package version of the generated SDK. @@ -143,7 +146,11 @@ sdk_version = None try: api_response = client.ontologies.OntologyObjectSet.create_temporary( - ontology, object_set=object_set, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version + ontology, + object_set=object_set, + branch=branch, + sdk_package_rid=sdk_package_rid, + sdk_version=sdk_version, ) print("The create_temporary response:\n") pprint(api_response) @@ -229,22 +236,23 @@ Vector properties will not be returned unless included in the `select` parameter ### Parameters -Name | Type | Description | Notes | -------------- |------------------------------------| ------------- | ------------- | -**ontology** | OntologyIdentifier | | | -**object_set** | ObjectSet | | | -**select** | List[SelectedPropertyApiName] | | | -**select_v2** | Optional[List[PropertyIdentifier]] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | | -**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] | -**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] | -**include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] | -**order_by** | Optional[SearchOrderByV2] | | [optional] | -**page_size** | Optional[PageSize] | | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | -**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | -**snapshot** | Optional[bool] | 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. | [optional] | -**transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. | [optional] | +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | | | +**object_set** | ObjectSet | | | +**select** | List[SelectedPropertyApiName] | | | +**select_v2** | List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | | +**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] | +**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] | +**include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] | +**load_property_securities** | Optional[bool] | A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. | [optional] | +**order_by** | Optional[SearchOrderByV2] | | [optional] | +**page_size** | Optional[PageSize] | | [optional] | +**page_token** | Optional[PageToken] | | [optional] | +**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | +**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | +**snapshot** | Optional[bool] | 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. | [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] | ### Return type **LoadObjectSetResponseV2** @@ -272,6 +280,8 @@ branch = None exclude_rid = None # Optional[IncludeComputeUsage] include_compute_usage = None +# Optional[bool] | A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. +load_property_securities = None # Optional[SearchOrderByV2] order_by = None # Optional[PageSize] @@ -297,6 +307,7 @@ try: branch=branch, exclude_rid=exclude_rid, include_compute_usage=include_compute_usage, + load_property_securities=load_property_securities, order_by=order_by, page_size=page_size, page_token=page_token, @@ -438,23 +449,24 @@ Vector properties will not be returned unless included in the `select` parameter ### Parameters -Name | Type | Description | Notes | -------------- |------------------------------------| ------------- | ------------- | -**ontology** | OntologyIdentifier | | | -**object_set** | ObjectSet | | | -**select** | List[SelectedPropertyApiName] | | | -**select_v2** | Optional[List[PropertyIdentifier]] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | | -**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] | -**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] | -**include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] | -**order_by** | Optional[SearchOrderByV2] | | [optional] | -**page_size** | Optional[PageSize] | | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | -**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | -**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | -**snapshot** | Optional[bool] | 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. | [optional] | -**transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. | [optional] | +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | | | +**object_set** | ObjectSet | | | +**select** | List[SelectedPropertyApiName] | | | +**select_v2** | List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | | +**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] | +**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] | +**include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] | +**load_property_securities** | Optional[bool] | A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. | [optional] | +**order_by** | Optional[SearchOrderByV2] | | [optional] | +**page_size** | Optional[PageSize] | | [optional] | +**page_token** | Optional[PageToken] | | [optional] | +**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | +**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | +**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | +**snapshot** | Optional[bool] | 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. | [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] | ### Return type **LoadObjectSetV2MultipleObjectTypesResponse** @@ -482,6 +494,8 @@ branch = None exclude_rid = None # Optional[IncludeComputeUsage] include_compute_usage = None +# Optional[bool] | A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. +load_property_securities = None # Optional[SearchOrderByV2] order_by = None # Optional[PageSize] @@ -509,6 +523,7 @@ try: branch=branch, exclude_rid=exclude_rid, include_compute_usage=include_compute_usage, + load_property_securities=load_property_securities, order_by=order_by, page_size=page_size, page_token=page_token, @@ -558,21 +573,21 @@ Vector properties will not be returned unless included in the `select` parameter ### Parameters -Name | Type | Description | Notes | -------------- |------------------------------------| ------------- | ------------- | -**ontology** | OntologyIdentifier | | | -**object_set** | ObjectSet | | | -**select** | List[SelectedPropertyApiName] | | | -**select_v2** | Optional[List[PropertyIdentifier]] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | | -**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] | -**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] | -**order_by** | Optional[SearchOrderByV2] | | [optional] | -**page_size** | Optional[PageSize] | | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | -**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | -**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | -**snapshot** | Optional[bool] | 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. | [optional] | +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | | | +**object_set** | ObjectSet | | | +**select** | List[SelectedPropertyApiName] | | | +**select_v2** | List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | | +**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] | +**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] | +**order_by** | Optional[SearchOrderByV2] | | [optional] | +**page_size** | Optional[PageSize] | | [optional] | +**page_token** | Optional[PageToken] | | [optional] | +**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | +**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | +**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | +**snapshot** | Optional[bool] | 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. | [optional] | ### Return type **LoadObjectSetV2ObjectsOrInterfacesResponse** @@ -589,7 +604,7 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # OntologyIdentifier ontology = "palantir" # ObjectSet -object_set = {"type": "base", "interfaceBase": "Person"} +object_set = {"type": "interfaceBase", "interfaceType": "Person"} # List[SelectedPropertyApiName] select = None # List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. diff --git a/docs/v2/Ontologies/models/ConjunctiveMarkingSummary.md b/docs/v2/Ontologies/models/ConjunctiveMarkingSummary.md new file mode 100644 index 000000000..f901bc6ec --- /dev/null +++ b/docs/v2/Ontologies/models/ConjunctiveMarkingSummary.md @@ -0,0 +1,13 @@ +# ConjunctiveMarkingSummary + +The conjunctive set of markings required to access the property value. +All markings from a conjunctive set must be met for access. + + +## Type +```python +List[MarkingId] +``` + + +[[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/ContainerConjunctiveMarkingSummary.md b/docs/v2/Ontologies/models/ContainerConjunctiveMarkingSummary.md new file mode 100644 index 000000000..4ba122dc2 --- /dev/null +++ b/docs/v2/Ontologies/models/ContainerConjunctiveMarkingSummary.md @@ -0,0 +1,16 @@ +# ContainerConjunctiveMarkingSummary + +The conjunctive set of markings for the container of this property value, +such as the project of a dataset. These markings may differ from the marking +on the actual property value, but still must be satisfied for accessing the property + +All markings from a conjunctive set must be met for access. + + +## Type +```python +List[MarkingId] +``` + + +[[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/ContainerDisjunctiveMarkingSummary.md b/docs/v2/Ontologies/models/ContainerDisjunctiveMarkingSummary.md new file mode 100644 index 000000000..16d5edccc --- /dev/null +++ b/docs/v2/Ontologies/models/ContainerDisjunctiveMarkingSummary.md @@ -0,0 +1,20 @@ +# ContainerDisjunctiveMarkingSummary + +The disjunctive set of markings for the container of this property value, +such as the project of a dataset. These markings may differ from the marking +on the actual property value, but still must be satisfied for accessing the property +All markings from a conjunctive set must be met for access. + +Disjunctive markings are represented as a conjunctive list of disjunctive sets. +The top-level set is a conjunction of sets, where each inner set should be +treated as a unit where any marking within the set can satisfy the set. +All sets within the top level set should be satisfied. + + +## Type +```python +List[List[MarkingId]] +``` + + +[[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/DisjunctiveMarkingSummary.md b/docs/v2/Ontologies/models/DisjunctiveMarkingSummary.md new file mode 100644 index 000000000..da80c5fb4 --- /dev/null +++ b/docs/v2/Ontologies/models/DisjunctiveMarkingSummary.md @@ -0,0 +1,16 @@ +# DisjunctiveMarkingSummary + +The disjunctive set of markings required to access the property value. +Disjunctive markings are represented as a conjunctive list of disjunctive sets. +The top-level set is a conjunction of sets, where each inner set should be +treated as a unit where any marking within the set can satisfy the set. +All sets within the top level set should be satisfied. + + +## Type +```python +List[List[MarkingId]] +``` + + +[[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/ErrorComputingSecurity.md b/docs/v2/Ontologies/models/ErrorComputingSecurity.md new file mode 100644 index 000000000..923a75beb --- /dev/null +++ b/docs/v2/Ontologies/models/ErrorComputingSecurity.md @@ -0,0 +1,11 @@ +# ErrorComputingSecurity + +Indicates the server was not able to load the securities of the property. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["errorComputingSecurity"] | 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/InQuery.md b/docs/v2/Ontologies/models/InQuery.md index aaa3afc50..b3d88ebf1 100644 --- a/docs/v2/Ontologies/models/InQuery.md +++ b/docs/v2/Ontologies/models/InQuery.md @@ -1,8 +1,8 @@ # InQuery Returns objects where the specified field equals any of the provided values. Allows you to -specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, -but not both. +specify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects +in the object set. Either `field` or `propertyIdentifier` must be supplied, but not both. ## Properties diff --git a/docs/v2/Ontologies/models/LoadObjectSetRequestV2.md b/docs/v2/Ontologies/models/LoadObjectSetRequestV2.md index d891f763d..31acdc9ef 100644 --- a/docs/v2/Ontologies/models/LoadObjectSetRequestV2.md +++ b/docs/v2/Ontologies/models/LoadObjectSetRequestV2.md @@ -3,17 +3,18 @@ Represents the API POST body when loading an `ObjectSet`. ## Properties -| Name | Type | Required | Description | -| ------------ |------------------------------------|----------| ------------- | -**object_set** | ObjectSet | Yes | | -**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. | -**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. | -**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. | -**include_compute_usage** | Optional[IncludeComputeUsage] | No | | +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_set** | ObjectSet | Yes | | +**order_by** | Optional[SearchOrderByV2] | No | | +**select** | List[SelectedPropertyApiName] | Yes | | +**select_v2** | List[PropertyIdentifier] | Yes | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | +**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. | +**load_property_securities** | Optional[bool] | No | A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. | +**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. | +**include_compute_usage** | Optional[IncludeComputeUsage] | 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/LoadObjectSetResponseV2.md b/docs/v2/Ontologies/models/LoadObjectSetResponseV2.md index 8934b4abe..70d4e608e 100644 --- a/docs/v2/Ontologies/models/LoadObjectSetResponseV2.md +++ b/docs/v2/Ontologies/models/LoadObjectSetResponseV2.md @@ -9,6 +9,7 @@ Represents the API response when loading an `ObjectSet`. **next_page_token** | Optional[PageToken] | No | | **total_count** | TotalCount | Yes | | **compute_usage** | Optional[ComputeSeconds] | No | | +**property_securities** | List[PropertySecurities] | 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/LoadObjectSetV2MultipleObjectTypesRequest.md b/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesRequest.md index af45d3ffa..33102ec65 100644 --- a/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesRequest.md +++ b/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesRequest.md @@ -4,17 +4,18 @@ Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObje ## Properties -| Name | Type | Required | Description | -| ------------ |------------------------------------|----------| ------------- | -**object_set** | ObjectSet | Yes | | -**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. | -**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. | -**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. | -**include_compute_usage** | Optional[IncludeComputeUsage] | No | | +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_set** | ObjectSet | Yes | | +**order_by** | Optional[SearchOrderByV2] | No | | +**select** | List[SelectedPropertyApiName] | Yes | | +**select_v2** | List[PropertyIdentifier] | Yes | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | +**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. | +**load_property_securities** | Optional[bool] | No | A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. | +**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. | +**include_compute_usage** | Optional[IncludeComputeUsage] | 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/LoadObjectSetV2MultipleObjectTypesResponse.md b/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponse.md index 074814580..c42a21a8e 100644 --- a/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponse.md +++ b/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponse.md @@ -23,6 +23,7 @@ implementations of both properties backed by SharedPropertyTypes as well as prop **interface_to_object_type_mappings** | Dict[InterfaceTypeApiName, InterfaceToObjectTypeMappings] | Yes | | **interface_to_object_type_mappings_v2** | Dict[InterfaceTypeApiName, InterfaceToObjectTypeMappingsV2] | Yes | | **compute_usage** | Optional[ComputeSeconds] | No | | +**property_securities** | List[PropertySecurities] | 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/LoadObjectSetV2ObjectsOrInterfacesRequest.md b/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesRequest.md index 580ea9a87..2335be3a1 100644 --- a/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesRequest.md +++ b/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesRequest.md @@ -4,16 +4,16 @@ Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObje ## Properties -| Name | Type | Required | Description | -| ------------ |------------------------------------|----------| ------------- | -**object_set** | ObjectSet | Yes | | -**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. | -**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. | -**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. | +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_set** | ObjectSet | Yes | | +**order_by** | Optional[SearchOrderByV2] | No | | +**select** | List[SelectedPropertyApiName] | Yes | | +**select_v2** | List[PropertyIdentifier] | Yes | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | +**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. | +**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. | [[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/MarkingId.md b/docs/v2/Ontologies/models/MarkingId.md new file mode 100644 index 000000000..b53b07b20 --- /dev/null +++ b/docs/v2/Ontologies/models/MarkingId.md @@ -0,0 +1,11 @@ +# MarkingId + +The id of a classification or mandatory marking. + +## 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/PropertyMarkingSummary.md b/docs/v2/Ontologies/models/PropertyMarkingSummary.md new file mode 100644 index 000000000..0d5ff17b4 --- /dev/null +++ b/docs/v2/Ontologies/models/PropertyMarkingSummary.md @@ -0,0 +1,15 @@ +# PropertyMarkingSummary + +All marking requirements applicable to a property value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**conjunctive** | Optional[ConjunctiveMarkingSummary] | No | | +**disjunctive** | Optional[DisjunctiveMarkingSummary] | No | | +**container_conjunctive** | Optional[ContainerConjunctiveMarkingSummary] | No | | +**container_disjunctive** | Optional[ContainerDisjunctiveMarkingSummary] | No | | +**type** | Literal["propertyMarkingSummary"] | 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/PropertySecurities.md b/docs/v2/Ontologies/models/PropertySecurities.md new file mode 100644 index 000000000..3d1eb90b5 --- /dev/null +++ b/docs/v2/Ontologies/models/PropertySecurities.md @@ -0,0 +1,12 @@ +# PropertySecurities + +A disjunctive set of security results for a property value. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**disjunction** | List[PropertySecurity] | 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/PropertySecurity.md b/docs/v2/Ontologies/models/PropertySecurity.md new file mode 100644 index 000000000..154f4ba23 --- /dev/null +++ b/docs/v2/Ontologies/models/PropertySecurity.md @@ -0,0 +1,17 @@ +# PropertySecurity + +PropertySecurity + +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 +| ------------ | ------------- +PropertyMarkingSummary | propertyMarkingSummary +UnsupportedPolicy | unsupportedPolicy +ErrorComputingSecurity | errorComputingSecurity + + +[[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/PropertyValue.md b/docs/v2/Ontologies/models/PropertyValue.md index cb86253ee..a55337edb 100644 --- a/docs/v2/Ontologies/models/PropertyValue.md +++ b/docs/v2/Ontologies/models/PropertyValue.md @@ -18,6 +18,7 @@ Represents the value of a property in the following format. | Integer | number | `238940` | | Long | string | `"58319870951433"` | | [MediaReference](https://palantir.com/docs/foundry/api/v2/ontologies-v2-resources/media-reference-properties/media-reference-property-basics/)| JSON encoded `MediaReference` object | `{"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}}` | +| Secured Property Value | JSON encoded `SecuredPropertyValue` object | `{"value": 10, "propertySecurityIndex" : 5}` | | Short | number | `8739` | | String | string | `"Call me Ishmael"` | | Struct | JSON object of struct field API name -> value | {"firstName": "Alex", "lastName": "Karp"} | diff --git a/docs/v2/Ontologies/models/SearchObjectsRequestV2.md b/docs/v2/Ontologies/models/SearchObjectsRequestV2.md index 17bdf31f8..a8d0f1053 100644 --- a/docs/v2/Ontologies/models/SearchObjectsRequestV2.md +++ b/docs/v2/Ontologies/models/SearchObjectsRequestV2.md @@ -3,16 +3,16 @@ SearchObjectsRequestV2 ## Properties -| Name | Type | Required | Description | -| ------------ |------------------------------------|----------| ------------- | -**where** | Optional[SearchJsonQueryV2] | No | | -**order_by** | Optional[SearchOrderByV2] | No | | -**page_size** | Optional[PageSize] | No | | -**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. | -**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. | +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**where** | Optional[SearchJsonQueryV2] | No | | +**order_by** | Optional[SearchOrderByV2] | No | | +**page_size** | Optional[PageSize] | No | | +**page_token** | Optional[PageToken] | No | | +**select** | List[PropertyApiName] | Yes | The API names of the object type properties to include in the response. | +**select_v2** | List[PropertyIdentifier] | Yes | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | +**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. | [[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/UnsupportedPolicy.md b/docs/v2/Ontologies/models/UnsupportedPolicy.md new file mode 100644 index 000000000..a644c47c9 --- /dev/null +++ b/docs/v2/Ontologies/models/UnsupportedPolicy.md @@ -0,0 +1,11 @@ +# UnsupportedPolicy + +Indicates the property is backed by a restricted view that does not support property securities. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["unsupportedPolicy"] | 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/SqlQueries/SqlQuery.md b/docs/v2/SqlQueries/SqlQuery.md index a91a4bdbb..8e329b280 100644 --- a/docs/v2/SqlQueries/SqlQuery.md +++ b/docs/v2/SqlQueries/SqlQuery.md @@ -15,7 +15,7 @@ Cancels a query. If the query is no longer running this is effectively a no-op. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**sql_query_id** | SqlQueryId | The id of a query. | | +**sql_query_id** | SqlQueryId | The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -30,7 +30,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# SqlQueryId | The id of a query. +# SqlQueryId | The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. sql_query_id = None # Optional[PreviewMode] | Enables the use of preview functionality. preview = None @@ -128,7 +128,7 @@ retried while the query is still running. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**sql_query_id** | SqlQueryId | The id of a query. | | +**sql_query_id** | SqlQueryId | The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -165,7 +165,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# SqlQueryId | The id of a query. +# SqlQueryId | The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. sql_query_id = None # Optional[PreviewMode] | Enables the use of preview functionality. preview = None @@ -201,7 +201,7 @@ Gets the status of a query. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**sql_query_id** | SqlQueryId | The id of a query. | | +**sql_query_id** | SqlQueryId | The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -216,7 +216,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# SqlQueryId | The id of a query. +# SqlQueryId | The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. sql_query_id = None # Optional[PreviewMode] | Enables the use of preview functionality. preview = None diff --git a/foundry_sdk/_core/api_client.py b/foundry_sdk/_core/api_client.py index 2cd44c823..a84c9682c 100644 --- a/foundry_sdk/_core/api_client.py +++ b/foundry_sdk/_core/api_client.py @@ -425,7 +425,7 @@ def __init__( elif not isinstance(auth, Auth): raise TypeError( "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or " - "PublicClientAuth, not an instance of {type(auth)}." + f"PublicClientAuth, not an instance of {type(auth).__name__}." ) assert_non_empty_string(hostname, "hostname") diff --git a/foundry_sdk/_versions.py b/foundry_sdk/_versions.py index 7c2768971..9e8eed119 100644 --- a/foundry_sdk/_versions.py +++ b/foundry_sdk/_versions.py @@ -17,4 +17,4 @@ # using the autorelease bot __version__ = "0.0.0" -__openapi_document_version__ = "1.1416.1" +__openapi_document_version__ = "1.1429.1" diff --git a/foundry_sdk/v1/core/models.py b/foundry_sdk/v1/core/models.py index 8931ecd22..b54eb02f8 100644 --- a/foundry_sdk/v1/core/models.py +++ b/foundry_sdk/v1/core/models.py @@ -234,9 +234,18 @@ class UnsupportedType(core.ModelBase): """UnsupportedType""" unsupported_type: str = pydantic.Field(alias=str("unsupportedType")) # type: ignore[literal-required] + params: typing.Dict[UnsupportedTypeParamKey, UnsupportedTypeParamValue] type: typing.Literal["unsupported"] = "unsupported" +UnsupportedTypeParamKey = str +"""UnsupportedTypeParamKey""" + + +UnsupportedTypeParamValue = str +"""UnsupportedTypeParamValue""" + + __all__ = [ "AnyType", "AttachmentType", @@ -276,4 +285,6 @@ class UnsupportedType(core.ModelBase): "TraceParent", "TraceState", "UnsupportedType", + "UnsupportedTypeParamKey", + "UnsupportedTypeParamValue", ] diff --git a/foundry_sdk/v1/ontologies/models.py b/foundry_sdk/v1/ontologies/models.py index b5bc3f361..2f6f3155e 100644 --- a/foundry_sdk/v1/ontologies/models.py +++ b/foundry_sdk/v1/ontologies/models.py @@ -1051,6 +1051,7 @@ class Property(core.ModelBase): | Integer | number | `238940` | | Long | string | `"58319870951433"` | | [MediaReference](https://palantir.com/docs/foundry/api/v2/ontologies-v2-resources/media-reference-properties/media-reference-property-basics/)| JSON encoded `MediaReference` object | `{"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}}` | +| Secured Property Value | JSON encoded `SecuredPropertyValue` object | `{"value": 10, "propertySecurityIndex" : 5}` | | Short | number | `8739` | | String | string | `"Call me Ishmael"` | | Struct | JSON object of struct field API name -> value | {"firstName": "Alex", "lastName": "Karp"} | diff --git a/foundry_sdk/v2/cli.py b/foundry_sdk/v2/cli.py index b9ddbc202..1886d1984 100644 --- a/foundry_sdk/v2/cli.py +++ b/foundry_sdk/v2/cli.py @@ -5940,6 +5940,39 @@ def media_sets_media_set_op_info( click.echo(repr(result)) +@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], +): + """ + Gets detailed metadata about the media item, including type-specific information + such as dimensions for images, duration for audio/video, page count for documents, etc. + + """ + 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)) + + @media_sets_media_set.command("read") @click.argument("media_set_rid", type=str, required=True) @click.argument("media_item_rid", type=str, required=True) @@ -6868,6 +6901,14 @@ def ontologies_ontology_object_set_op_aggregate( @ontologies_ontology_object_set.command("create_temporary") @click.argument("ontology", type=str, required=True) @click.option("--object_set", type=str, required=True, help="""""") +@click.option( + "--branch", + type=str, + required=False, + help="""The Foundry branch to reference. If not specified, the default branch will be used. +Branches are an experimental feature and not all workflows are supported. +""", +) @click.option( "--sdk_package_rid", type=str, @@ -6887,6 +6928,7 @@ def ontologies_ontology_object_set_op_create_temporary( client: FoundryClient, ontology: str, object_set: str, + branch: typing.Optional[str], sdk_package_rid: typing.Optional[str], sdk_version: typing.Optional[str], ): @@ -6897,6 +6939,7 @@ def ontologies_ontology_object_set_op_create_temporary( result = client.ontologies.OntologyObjectSet.create_temporary( ontology=ontology, object_set=json.loads(object_set), + branch=branch, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version, ) @@ -6952,6 +6995,17 @@ def ontologies_ontology_object_set_op_get( """, ) @click.option("--include_compute_usage", type=bool, required=False, help="""""") +@click.option( + "--load_property_securities", + type=bool, + required=False, + help="""A flag to load the securities for all properties. +Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. +Returned objects will return all properties as Secured Property Values, which provide the property data +as well an index into the `propertySecurities` list. +This feature is experimental and not yet generally available. +""", +) @click.option("--order_by", type=str, required=False, help="""""") @click.option("--page_size", type=int, required=False, help="""""") @click.option("--page_token", type=str, required=False, help="""""") @@ -6997,6 +7051,7 @@ def ontologies_ontology_object_set_op_load( branch: typing.Optional[str], exclude_rid: typing.Optional[bool], include_compute_usage: typing.Optional[bool], + load_property_securities: typing.Optional[bool], order_by: typing.Optional[str], page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -7024,6 +7079,7 @@ def ontologies_ontology_object_set_op_load( branch=branch, exclude_rid=exclude_rid, include_compute_usage=include_compute_usage, + load_property_securities=load_property_securities, order_by=None if order_by is None else json.loads(order_by), page_size=page_size, page_token=page_token, @@ -7143,6 +7199,17 @@ def ontologies_ontology_object_set_op_load_links( """, ) @click.option("--include_compute_usage", type=bool, required=False, help="""""") +@click.option( + "--load_property_securities", + type=bool, + required=False, + help="""A flag to load the securities for all properties. +Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. +Returned objects will return all properties as Secured Property Values, which provide the property data +as well an index into the `propertySecurities` list. +This feature is experimental and not yet generally available. +""", +) @click.option("--order_by", type=str, required=False, help="""""") @click.option("--page_size", type=int, required=False, help="""""") @click.option("--page_token", type=str, required=False, help="""""") @@ -7195,6 +7262,7 @@ def ontologies_ontology_object_set_op_load_multiple_object_types( branch: typing.Optional[str], exclude_rid: typing.Optional[bool], include_compute_usage: typing.Optional[bool], + load_property_securities: typing.Optional[bool], order_by: typing.Optional[str], page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -7228,6 +7296,7 @@ def ontologies_ontology_object_set_op_load_multiple_object_types( branch=branch, exclude_rid=exclude_rid, include_compute_usage=include_compute_usage, + load_property_securities=load_property_securities, order_by=None if order_by is None else json.loads(order_by), page_size=page_size, page_token=page_token, diff --git a/foundry_sdk/v2/connectivity/errors.py b/foundry_sdk/v2/connectivity/errors.py index 049d472c7..9a29ad00d 100644 --- a/foundry_sdk/v2/connectivity/errors.py +++ b/foundry_sdk/v2/connectivity/errors.py @@ -441,7 +441,7 @@ class HostNameCannotHaveProtocolOrPort(errors.BadRequestError): class InvalidShareNameParameters(typing_extensions.TypedDict): - """The share name is invalid. Share names cannot contain the following characters: \ / : * ? " < > |""" + """The share name is invalid. Share names cannot contain the following characters: \\ / : * ? " < > |""" __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry_sdk/v2/core/models.py b/foundry_sdk/v2/core/models.py index a5d3935e1..74b45c68d 100644 --- a/foundry_sdk/v2/core/models.py +++ b/foundry_sdk/v2/core/models.py @@ -830,9 +830,18 @@ class UnsupportedType(core.ModelBase): """UnsupportedType""" unsupported_type: str = pydantic.Field(alias=str("unsupportedType")) # type: ignore[literal-required] + params: typing.Dict[UnsupportedTypeParamKey, UnsupportedTypeParamValue] type: typing.Literal["unsupported"] = "unsupported" +UnsupportedTypeParamKey = str +"""UnsupportedTypeParamKey""" + + +UnsupportedTypeParamValue = str +"""UnsupportedTypeParamValue""" + + UpdatedTime = core.AwareDatetime """The time at which the resource was most recently updated.""" @@ -1025,6 +1034,8 @@ class VectorType(core.ModelBase): "TraceParent", "TraceState", "UnsupportedType", + "UnsupportedTypeParamKey", + "UnsupportedTypeParamValue", "UpdatedBy", "UpdatedTime", "UserId", diff --git a/foundry_sdk/v2/datasets/models.py b/foundry_sdk/v2/datasets/models.py index b16747c73..6eda965a1 100644 --- a/foundry_sdk/v2/datasets/models.py +++ b/foundry_sdk/v2/datasets/models.py @@ -366,7 +366,9 @@ class View(core.ModelBase): class ViewBackingDataset(core.ModelBase): """One of the Datasets backing a View.""" - branch: BranchName + branch: typing.Optional[BranchName] = None + """The branch of the backing dataset. If not specified, defaults to the branch of the View.""" + dataset_rid: DatasetRid = pydantic.Field(alias=str("datasetRid")) # type: ignore[literal-required] diff --git a/foundry_sdk/v2/media_sets/errors.py b/foundry_sdk/v2/media_sets/errors.py index 9cb6a0b83..4723463fb 100644 --- a/foundry_sdk/v2/media_sets/errors.py +++ b/foundry_sdk/v2/media_sets/errors.py @@ -255,6 +255,19 @@ class TransformedMediaItemNotFound(errors.NotFoundError): error_instance_id: str +class UnexpectedMetadataTypeParameters(typing_extensions.TypedDict): + """Received an unexpected metadata type, this particular media item may use features that are not yet fully supported in the public API.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + +@dataclass +class UnexpectedMetadataType(errors.InternalServerError): + name: typing.Literal["UnexpectedMetadataType"] + parameters: UnexpectedMetadataTypeParameters + error_instance_id: str + + __all__ = [ "ConflictingMediaSetIdentifiers", "GetMediaItemRidByPathPermissionDenied", @@ -271,4 +284,5 @@ class TransformedMediaItemNotFound(errors.NotFoundError): "TemporaryMediaUploadInsufficientPermissions", "TemporaryMediaUploadUnknownFailure", "TransformedMediaItemNotFound", + "UnexpectedMetadataType", ] diff --git a/foundry_sdk/v2/media_sets/media_set.py b/foundry_sdk/v2/media_sets/media_set.py index c568f66d6..e48118e39 100644 --- a/foundry_sdk/v2/media_sets/media_set.py +++ b/foundry_sdk/v2/media_sets/media_set.py @@ -357,6 +357,60 @@ def info( ), ) + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def metadata( + self, + 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 = {}, + ) -> media_sets_models.MediaItemMetadata: + """ + Gets detailed metadata about the media item, including type-specific information + such as dimensions for images, duration for audio/video, page count for documents, etc. + + :param media_set_rid: The RID of the media set. + :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. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: media_sets_models.MediaItemMetadata + """ + + return self._api_client.call_api( + core.RequestInfo( + method="GET", + resource_path="/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/metadata", + query_params={ + "preview": preview, + }, + path_params={ + "mediaSetRid": media_set_rid, + "mediaItemRid": media_item_rid, + }, + header_params={ + "ReadToken": read_token, + "Accept": "application/json", + }, + body=None, + response_type=media_sets_models.MediaItemMetadata, + request_timeout=request_timeout, + throwable_errors={}, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -708,6 +762,7 @@ def commit(_: None): ... def create(_: media_sets_models.TransactionId): ... def get_rid_by_path(_: media_sets_models.GetMediaItemRidByPathResponse): ... def info(_: media_sets_models.GetMediaItemInfoResponse): ... + def metadata(_: media_sets_models.MediaItemMetadata): ... def read(_: bytes): ... def read_original(_: bytes): ... def reference(_: core_models.MediaReference): ... @@ -721,6 +776,7 @@ def upload_media(_: core_models.MediaReference): ... self.create = core.with_raw_response(create, client.create) self.get_rid_by_path = core.with_raw_response(get_rid_by_path, client.get_rid_by_path) self.info = core.with_raw_response(info, client.info) + self.metadata = core.with_raw_response(metadata, client.metadata) self.read = core.with_raw_response(read, client.read) self.read_original = core.with_raw_response(read_original, client.read_original) self.reference = core.with_raw_response(reference, client.reference) @@ -735,6 +791,7 @@ def calculate(_: media_sets_models.TrackedTransformationResponse): ... def create(_: media_sets_models.TransactionId): ... def get_rid_by_path(_: media_sets_models.GetMediaItemRidByPathResponse): ... def info(_: media_sets_models.GetMediaItemInfoResponse): ... + def metadata(_: media_sets_models.MediaItemMetadata): ... def read(_: bytes): ... def read_original(_: bytes): ... def reference(_: core_models.MediaReference): ... @@ -746,6 +803,7 @@ def upload_media(_: core_models.MediaReference): ... self.create = core.with_streaming_response(create, client.create) self.get_rid_by_path = core.with_streaming_response(get_rid_by_path, client.get_rid_by_path) self.info = core.with_streaming_response(info, client.info) + self.metadata = core.with_streaming_response(metadata, client.metadata) self.read = core.with_streaming_response(read, client.read) self.read_original = core.with_streaming_response(read_original, client.read_original) self.reference = core.with_streaming_response(reference, client.reference) @@ -1087,6 +1145,60 @@ def info( ), ) + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def metadata( + self, + 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 = {}, + ) -> typing.Awaitable[media_sets_models.MediaItemMetadata]: + """ + Gets detailed metadata about the media item, including type-specific information + such as dimensions for images, duration for audio/video, page count for documents, etc. + + :param media_set_rid: The RID of the media set. + :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. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: typing.Awaitable[media_sets_models.MediaItemMetadata] + """ + + return self._api_client.call_api( + core.RequestInfo( + method="GET", + resource_path="/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/metadata", + query_params={ + "preview": preview, + }, + path_params={ + "mediaSetRid": media_set_rid, + "mediaItemRid": media_item_rid, + }, + header_params={ + "ReadToken": read_token, + "Accept": "application/json", + }, + body=None, + response_type=media_sets_models.MediaItemMetadata, + request_timeout=request_timeout, + throwable_errors={}, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -1438,6 +1550,7 @@ def commit(_: None): ... def create(_: media_sets_models.TransactionId): ... def get_rid_by_path(_: media_sets_models.GetMediaItemRidByPathResponse): ... def info(_: media_sets_models.GetMediaItemInfoResponse): ... + def metadata(_: media_sets_models.MediaItemMetadata): ... def read(_: bytes): ... def read_original(_: bytes): ... def reference(_: core_models.MediaReference): ... @@ -1451,6 +1564,7 @@ def upload_media(_: core_models.MediaReference): ... self.create = core.async_with_raw_response(create, client.create) self.get_rid_by_path = core.async_with_raw_response(get_rid_by_path, client.get_rid_by_path) self.info = core.async_with_raw_response(info, client.info) + self.metadata = core.async_with_raw_response(metadata, client.metadata) self.read = core.async_with_raw_response(read, client.read) self.read_original = core.async_with_raw_response(read_original, client.read_original) self.reference = core.async_with_raw_response(reference, client.reference) @@ -1465,6 +1579,7 @@ def calculate(_: media_sets_models.TrackedTransformationResponse): ... def create(_: media_sets_models.TransactionId): ... def get_rid_by_path(_: media_sets_models.GetMediaItemRidByPathResponse): ... def info(_: media_sets_models.GetMediaItemInfoResponse): ... + def metadata(_: media_sets_models.MediaItemMetadata): ... def read(_: bytes): ... def read_original(_: bytes): ... def reference(_: core_models.MediaReference): ... @@ -1478,6 +1593,7 @@ def upload_media(_: core_models.MediaReference): ... get_rid_by_path, client.get_rid_by_path ) self.info = core.async_with_streaming_response(info, client.info) + self.metadata = core.async_with_streaming_response(metadata, client.metadata) self.read = core.async_with_streaming_response(read, client.read) self.read_original = core.async_with_streaming_response(read_original, client.read_original) self.reference = core.async_with_streaming_response(reference, client.reference) diff --git a/foundry_sdk/v2/media_sets/models.py b/foundry_sdk/v2/media_sets/models.py index 8b2bf3add..6519722e3 100644 --- a/foundry_sdk/v2/media_sets/models.py +++ b/foundry_sdk/v2/media_sets/models.py @@ -23,6 +23,55 @@ from foundry_sdk import _core as core from foundry_sdk.v2.core import models as core_models + +class AffineTransform(core.ModelBase): + """An affine transformation for geo-referencing.""" + + x_translate: typing.Optional[float] = pydantic.Field(alias=str("xTranslate"), default=None) # type: ignore[literal-required] + x_scale: typing.Optional[float] = pydantic.Field(alias=str("xScale"), default=None) # type: ignore[literal-required] + x_shear: typing.Optional[float] = pydantic.Field(alias=str("xShear"), default=None) # type: ignore[literal-required] + y_translate: typing.Optional[float] = pydantic.Field(alias=str("yTranslate"), default=None) # type: ignore[literal-required] + y_shear: typing.Optional[float] = pydantic.Field(alias=str("yShear"), default=None) # type: ignore[literal-required] + y_scale: typing.Optional[float] = pydantic.Field(alias=str("yScale"), default=None) # type: ignore[literal-required] + + +AudioDecodeFormat = typing.Literal["FLAC", "MP2", "MP3", "MP4", "NIST_SPHERE", "OGG", "WAV", "WEBM"] +"""The format of an audio media item.""" + + +class AudioMediaItemMetadata(core.ModelBase): + """Metadata for audio media items.""" + + format: AudioDecodeFormat + specification: AudioSpecification + size_bytes: int = pydantic.Field(alias=str("sizeBytes")) # type: ignore[literal-required] + """The size of the media item in bytes.""" + + type: typing.Literal["audio"] = "audio" + + +class AudioSpecification(core.ModelBase): + """Technical specifications for audio media items.""" + + bit_rate: int = pydantic.Field(alias=str("bitRate")) # type: ignore[literal-required] + """Approximate (average) bits per second of the audio, rounded up in case of a fractional average bits per second.""" + + duration_seconds: float = pydantic.Field(alias=str("durationSeconds")) # type: ignore[literal-required] + """Approximate duration of the audio, in seconds with up to two decimal digits (rounded up).""" + + number_of_channels: typing.Optional[int] = pydantic.Field(alias=str("numberOfChannels"), default=None) # type: ignore[literal-required] + """Number of audio channels in the audio stream.""" + + +class BandInfo(core.ModelBase): + """Information about a band in an image.""" + + data_type: typing.Optional[DataType] = pydantic.Field(alias=str("dataType"), default=None) # type: ignore[literal-required] + color_interpretation: typing.Optional[ColorInterpretation] = pydantic.Field(alias=str("colorInterpretation"), default=None) # type: ignore[literal-required] + palette_interpretation: typing.Optional[PaletteInterpretation] = pydantic.Field(alias=str("paletteInterpretation"), default=None) # type: ignore[literal-required] + unit_interpretation: typing.Optional[UnitInterpretation] = pydantic.Field(alias=str("unitInterpretation"), default=None) # type: ignore[literal-required] + + BranchName = str """ A name for a media set branch. Valid branch names must be (a) non-empty, (b) less than 256 characters, and @@ -34,6 +83,180 @@ """A resource identifier that identifies a branch of a media set.""" +ColorInterpretation = typing.Literal[ + "UNDEFINED", + "GRAY", + "PALETTE_INDEX", + "RED", + "GREEN", + "BLUE", + "ALPHA", + "HUE", + "SATURATION", + "LIGHTNESS", + "CYAN", + "MAGENTA", + "YELLOW", + "BLACK", + "Y_CB_CR_SPACE_Y", + "Y_CB_CR_SPACE_CB", + "Y_CB_CR_SPACE_CR", +] +"""The color interpretation of a band.""" + + +class CommonDicomDataElements(core.ModelBase): + """Common DICOM data elements.""" + + number_frames: typing.Optional[int] = pydantic.Field(alias=str("numberFrames"), default=None) # type: ignore[literal-required] + """The number of frames in the DICOM file.""" + + modality: typing.Optional[Modality] = None + patient_id: typing.Optional[str] = pydantic.Field(alias=str("patientId"), default=None) # type: ignore[literal-required] + """The patient ID.""" + + study_id: typing.Optional[str] = pydantic.Field(alias=str("studyId"), default=None) # type: ignore[literal-required] + """The study ID.""" + + study_uid: typing.Optional[str] = pydantic.Field(alias=str("studyUid"), default=None) # type: ignore[literal-required] + """The study UID.""" + + series_uid: typing.Optional[str] = pydantic.Field(alias=str("seriesUid"), default=None) # type: ignore[literal-required] + """The series UID.""" + + study_time: typing.Optional[core.AwareDatetime] = pydantic.Field(alias=str("studyTime"), default=None) # type: ignore[literal-required] + """The study time.""" + + series_time: typing.Optional[core.AwareDatetime] = pydantic.Field(alias=str("seriesTime"), default=None) # type: ignore[literal-required] + """The series time.""" + + +class CoordinateReferenceSystem(core.ModelBase): + """The coordinate reference system for geo-referenced imagery.""" + + wkt: typing.Optional[str] = None + """The Well-Known Text representation of the CRS.""" + + +DataType = typing.Literal[ + "UNDEFINED", + "BYTE", + "UINT16", + "INT16", + "UINT32", + "INT32", + "FLOAT32", + "FLOAT64", + "COMPLEX_INT16", + "COMPLEX_INT32", + "COMPLEX_FLOAT32", + "COMPLEX_FLOAT64", + "UINT64", + "INT64", + "INT8", +] +"""The data type of a band.""" + + +DicomDataElementKey = str +"""The key of a DICOM data element.""" + + +class DicomMediaItemMetadata(core.ModelBase): + """Metadata for DICOM (Digital Imaging and Communications in Medicine) media items.""" + + meta_information: DicomMetaInformation = pydantic.Field(alias=str("metaInformation")) # type: ignore[literal-required] + media_type: DicomMediaType = pydantic.Field(alias=str("mediaType")) # type: ignore[literal-required] + common_data_elements: CommonDicomDataElements = pydantic.Field(alias=str("commonDataElements")) # type: ignore[literal-required] + other_data_elements: typing.Dict[DicomDataElementKey, typing.Any] = pydantic.Field(alias=str("otherDataElements")) # type: ignore[literal-required] + """ + The data elements for a particular DICOM file outside of the media contained within it and the + data elements within the commonDataElements field. + """ + + size_bytes: int = pydantic.Field(alias=str("sizeBytes")) # type: ignore[literal-required] + """The size of the media item in bytes.""" + + type: typing.Literal["dicom"] = "dicom" + + +DicomMediaType = typing.Literal["IMAGE", "MULTI_FRAME_IMAGE", "VIDEO", "STRUCTURED_REPORT"] +"""The type of DICOM media.""" + + +class DicomMetaInformationV1(core.ModelBase): + """DICOM meta information version 1.""" + + media_storage_sop: str = pydantic.Field(alias=str("mediaStorageSop")) # type: ignore[literal-required] + """ + The Media Storage SOP (Service-Object Pair) Class UID, which identifies + the type of DICOM object stored (e.g., CT Image, MR Image). + """ + + media_storage_sop_instance: str = pydantic.Field(alias=str("mediaStorageSopInstance")) # type: ignore[literal-required] + """The Media Storage SOP Instance UID.""" + + transfer_syntax: str = pydantic.Field(alias=str("transferSyntax")) # type: ignore[literal-required] + """ + The Transfer Syntax UID, which specifies how the DICOM data is encoded + (e.g., compression method, byte ordering). + """ + + type: typing.Literal["v1"] = "v1" + + +class Dimensions(core.ModelBase): + """The dimensions of an image.""" + + width: int + """The width of the image in pixels.""" + + height: int + """The height of the image in pixels.""" + + +DocumentDecodeFormat = typing.Literal["PDF", "DOCX", "TXT", "PPTX"] +"""The format of a document media item.""" + + +class DocumentMediaItemMetadata(core.ModelBase): + """Metadata for document media items.""" + + format: DocumentDecodeFormat + pages: typing.Optional[int] = None + """The number of pages in the document.""" + + size_bytes: int = pydantic.Field(alias=str("sizeBytes")) # type: ignore[literal-required] + """The size of the media item in bytes.""" + + title: typing.Optional[str] = None + """The title of the document, if available.""" + + author: typing.Optional[str] = None + """The author of the document, if available.""" + + type: typing.Literal["document"] = "document" + + +FlipAxis = typing.Literal["HORIZONTAL", "VERTICAL", "UNKNOWN"] +"""The flip axis from EXIF orientation.""" + + +class GcpList(core.ModelBase): + """A list of ground control points for geo-referencing.""" + + gcps: typing.List[GroundControlPoint] + + +class GeoMetadata(core.ModelBase): + """Embedded geo-referencing data for an image.""" + + crs: typing.Optional[CoordinateReferenceSystem] = None + geotransform: typing.Optional[AffineTransform] = None + gcp_info: typing.Optional[GcpList] = pydantic.Field(alias=str("gcpInfo"), default=None) # type: ignore[literal-required] + gps_data: typing.Optional[GpsMetadata] = pydantic.Field(alias=str("gpsData"), default=None) # type: ignore[literal-required] + + class GetMediaItemInfoResponse(core.ModelBase): """GetMediaItemInfoResponse""" @@ -49,6 +272,76 @@ class GetMediaItemRidByPathResponse(core.ModelBase): media_item_rid: typing.Optional[core_models.MediaItemRid] = pydantic.Field(alias=str("mediaItemRid"), default=None) # type: ignore[literal-required] +class GpsMetadata(core.ModelBase): + """GPS location metadata extracted from EXIF data embedded in the image.""" + + latitude: typing.Optional[float] = None + longitude: typing.Optional[float] = None + altitude: typing.Optional[float] = None + + +class GroundControlPoint(core.ModelBase): + """A ground control point for geo-referencing.""" + + pix_x: typing.Optional[float] = pydantic.Field(alias=str("pixX"), default=None) # type: ignore[literal-required] + """The pixel X coordinate.""" + + pix_y: typing.Optional[float] = pydantic.Field(alias=str("pixY"), default=None) # type: ignore[literal-required] + """The pixel Y coordinate.""" + + proj_x: typing.Optional[float] = pydantic.Field(alias=str("projX"), default=None) # type: ignore[literal-required] + """The projected X coordinate.""" + + proj_y: typing.Optional[float] = pydantic.Field(alias=str("projY"), default=None) # type: ignore[literal-required] + """The projected Y coordinate.""" + + proj_z: typing.Optional[float] = pydantic.Field(alias=str("projZ"), default=None) # type: ignore[literal-required] + """The projected Z coordinate.""" + + +ImageAttributeDomain = str +"""The domain of an image attribute.""" + + +ImageAttributeKey = str +"""The key of an image attribute within a domain.""" + + +ImageryDecodeFormat = typing.Literal["BMP", "TIFF", "NITF", "JP2K", "JPG", "PNG", "WEBP"] +"""The format of an imagery media item.""" + + +class ImageryMediaItemMetadata(core.ModelBase): + """Metadata for imagery (image) media items.""" + + format: ImageryDecodeFormat + dimensions: typing.Optional[Dimensions] = None + bands: typing.List[BandInfo] + """Information about the bands of the image, if available.""" + + attributes: typing.Dict[ImageAttributeDomain, typing.Dict[ImageAttributeKey, str]] + """ + The metadata attributes described in the image header in the form of a map >. + For the default domain, or when the domain is not specified, the domain key will be the empty string (""). + """ + + icc_profile: typing.Optional[str] = pydantic.Field(alias=str("iccProfile"), default=None) # type: ignore[literal-required] + """The base64-encoded ICC profile for the image, if available.""" + + geo: typing.Optional[GeoMetadata] = None + pages: typing.Optional[int] = None + """ + The number of pages associated with this image. Usually 1, but may be more for some formats + (multi-page TIFFs, for example). + """ + + orientation: typing.Optional[Orientation] = None + size_bytes: int = pydantic.Field(alias=str("sizeBytes")) # type: ignore[literal-required] + """The size of the media item in bytes.""" + + type: typing.Literal["imagery"] = "imagery" + + LogicalTimestamp = core.Long """ A number representing a logical ordering to be used for transactions, etc. @@ -67,16 +360,168 @@ class MediaAttribution(core.ModelBase): """The timestamp when the media item was created, in ISO 8601 timestamp format.""" +MediaItemMetadata = typing_extensions.Annotated[ + typing.Union[ + "DocumentMediaItemMetadata", + "ImageryMediaItemMetadata", + "SpreadsheetMediaItemMetadata", + "UntypedMediaItemMetadata", + "AudioMediaItemMetadata", + "VideoMediaItemMetadata", + "DicomMediaItemMetadata", + ], + pydantic.Field(discriminator="type"), +] +""" +Detailed metadata about a media item, including type-specific information such as dimensions for images, +duration for audio/video, page count for documents, etc. +""" + + MediaItemXmlFormat = typing.Literal["DOCX", "XLSX", "PPTX"] """Format of the media item attempted to be decoded based on the XML structure.""" +Modality = typing.Literal[ + "AR", + "ASMT", + "AU", + "BDUS", + "BI", + "BMD", + "CR", + "CT", + "CTPROTOCOL", + "DG", + "DOC", + "DX", + "ECG", + "EPS", + "ES", + "FID", + "GM", + "HC", + "HD", + "IO", + "IOL", + "IVOCT", + "IVUS", + "KER", + "KO", + "LEN", + "LS", + "MG", + "MR", + "M3D", + "NM", + "OAM", + "OCT", + "OP", + "OPM", + "OPT", + "OPTBSV", + "OPTENF", + "OPV", + "OSS", + "OT", + "PLAN", + "PR", + "PT", + "PX", + "REG", + "RESP", + "RF", + "RG", + "RTDOSE", + "RTIMAGE", + "RTINTENT", + "RTPLAN", + "RTRAD", + "RTRECORD", + "RTSEGANN", + "RTSTRUCT", + "RWV", + "SEG", + "SM", + "SMR", + "SR", + "SRF", + "STAIN", + "TEXTUREMAP", + "TG", + "US", + "VA", + "XA", + "XC", + "AS", + "CD", + "CF", + "CP", + "CS", + "DD", + "DF", + "DM", + "DS", + "EC", + "FA", + "FS", + "LP", + "MA", + "MS", + "OPR", + "ST", + "VF", +] +""" +DICOM modality code. A list of modalities and their meanings can be found in the DICOM specification. +https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.3.html#sect_C.7.3.1.1.1 +""" + + +class Orientation(core.ModelBase): + """The orientation information as encoded in EXIF metadata.""" + + rotation_angle: typing.Optional[RotationAngle] = pydantic.Field(alias=str("rotationAngle"), default=None) # type: ignore[literal-required] + flip_axis: typing.Optional[FlipAxis] = pydantic.Field(alias=str("flipAxis"), default=None) # type: ignore[literal-required] + + +PaletteInterpretation = typing.Literal["GRAY", "RGB", "RGBA", "CMYK", "HLS"] +"""The palette interpretation of a band.""" + + class PutMediaItemResponse(core.ModelBase): """PutMediaItemResponse""" media_item_rid: core_models.MediaItemRid = pydantic.Field(alias=str("mediaItemRid")) # type: ignore[literal-required] +RotationAngle = typing.Literal["DEGREE_90", "DEGREE_180", "DEGREE_270", "UNKNOWN"] +"""The rotation angle from EXIF orientation.""" + + +SpreadsheetDecodeFormat = typing.Literal["XLSX"] +"""The format of a spreadsheet media item.""" + + +class SpreadsheetMediaItemMetadata(core.ModelBase): + """Metadata for spreadsheet media items.""" + + format: SpreadsheetDecodeFormat + sheet_names: typing.List[str] = pydantic.Field(alias=str("sheetNames")) # type: ignore[literal-required] + """The names of the sheets in the spreadsheet.""" + + size_bytes: int = pydantic.Field(alias=str("sizeBytes")) # type: ignore[literal-required] + """The size of the media item in bytes.""" + + title: typing.Optional[str] = None + """The title of the spreadsheet, if available.""" + + author: typing.Optional[str] = None + """The author of the spreadsheet, if available.""" + + type: typing.Literal["spreadsheet"] = "spreadsheet" + + class TrackedTransformationFailedResponse(core.ModelBase): """TrackedTransformationFailedResponse""" @@ -110,20 +555,105 @@ class TrackedTransformationSuccessfulResponse(core.ModelBase): """An identifier which represents a transaction on a media set.""" +class UnitInterpretation(core.ModelBase): + """The unit interpretation for a band.""" + + unit: typing.Optional[str] = None + scale: typing.Optional[float] = None + offset: typing.Optional[float] = None + + +class UntypedMediaItemMetadata(core.ModelBase): + """Metadata for untyped media items (media items without a recognized type).""" + + size_bytes: int = pydantic.Field(alias=str("sizeBytes")) # type: ignore[literal-required] + """The size of the media item in bytes.""" + + type: typing.Literal["untyped"] = "untyped" + + +VideoDecodeFormat = typing.Literal["MP4", "MKV", "MOV", "TS"] +"""The format of a video media item.""" + + +class VideoMediaItemMetadata(core.ModelBase): + """Metadata for video media items.""" + + format: VideoDecodeFormat + specification: VideoSpecification + size_bytes: int = pydantic.Field(alias=str("sizeBytes")) # type: ignore[literal-required] + """The size of the media item in bytes.""" + + type: typing.Literal["video"] = "video" + + +class VideoSpecification(core.ModelBase): + """Technical specifications for video media items.""" + + bit_rate: int = pydantic.Field(alias=str("bitRate")) # type: ignore[literal-required] + """Approximate (average) bits per second of the video, rounded up in case of a fractional average bits per second.""" + + duration_seconds: float = pydantic.Field(alias=str("durationSeconds")) # type: ignore[literal-required] + """Approximate duration of the video, in seconds with up to two decimal digits (rounded up).""" + + +DicomMetaInformation = DicomMetaInformationV1 +"""DICOM meta information.""" + + +core.resolve_forward_references(MediaItemMetadata, globalns=globals(), localns=locals()) core.resolve_forward_references(TrackedTransformationResponse, globalns=globals(), localns=locals()) __all__ = [ + "AffineTransform", + "AudioDecodeFormat", + "AudioMediaItemMetadata", + "AudioSpecification", + "BandInfo", "BranchName", "BranchRid", + "ColorInterpretation", + "CommonDicomDataElements", + "CoordinateReferenceSystem", + "DataType", + "DicomDataElementKey", + "DicomMediaItemMetadata", + "DicomMediaType", + "DicomMetaInformation", + "DicomMetaInformationV1", + "Dimensions", + "DocumentDecodeFormat", + "DocumentMediaItemMetadata", + "FlipAxis", + "GcpList", + "GeoMetadata", "GetMediaItemInfoResponse", "GetMediaItemRidByPathResponse", + "GpsMetadata", + "GroundControlPoint", + "ImageAttributeDomain", + "ImageAttributeKey", + "ImageryDecodeFormat", + "ImageryMediaItemMetadata", "LogicalTimestamp", "MediaAttribution", + "MediaItemMetadata", "MediaItemXmlFormat", + "Modality", + "Orientation", + "PaletteInterpretation", "PutMediaItemResponse", + "RotationAngle", + "SpreadsheetDecodeFormat", + "SpreadsheetMediaItemMetadata", "TrackedTransformationFailedResponse", "TrackedTransformationPendingResponse", "TrackedTransformationResponse", "TrackedTransformationSuccessfulResponse", "TransactionId", + "UnitInterpretation", + "UntypedMediaItemMetadata", + "VideoDecodeFormat", + "VideoMediaItemMetadata", + "VideoSpecification", ] diff --git a/foundry_sdk/v2/ontologies/models.py b/foundry_sdk/v2/ontologies/models.py index e1813d5f0..015f3d246 100644 --- a/foundry_sdk/v2/ontologies/models.py +++ b/foundry_sdk/v2/ontologies/models.py @@ -616,6 +616,37 @@ class CenterPoint(core.ModelBase): distance: core_models.Distance +ConjunctiveMarkingSummary = typing.List["MarkingId"] +""" +The conjunctive set of markings required to access the property value. +All markings from a conjunctive set must be met for access. +""" + + +ContainerConjunctiveMarkingSummary = typing.List["MarkingId"] +""" +The conjunctive set of markings for the container of this property value, +such as the project of a dataset. These markings may differ from the marking +on the actual property value, but still must be satisfied for accessing the property + +All markings from a conjunctive set must be met for access. +""" + + +ContainerDisjunctiveMarkingSummary = typing.List[typing.List["MarkingId"]] +""" +The disjunctive set of markings for the container of this property value, +such as the project of a dataset. These markings may differ from the marking +on the actual property value, but still must be satisfied for accessing the property +All markings from a conjunctive set must be met for access. + +Disjunctive markings are represented as a conjunctive list of disjunctive sets. +The top-level set is a conjunction of sets, where each inner set should be +treated as a unit where any marking within the set can satisfy the set. +All sets within the top level set should be satisfied. +""" + + class ContainsAllTermsInOrderPrefixLastTerm(core.ModelBase): """ Returns objects where the specified field contains all of the terms in the order provided, @@ -1018,6 +1049,16 @@ class DeprecatedPropertyTypeStatus(core.ModelBase): """Definition of a derived property.""" +DisjunctiveMarkingSummary = typing.List[typing.List["MarkingId"]] +""" +The disjunctive set of markings required to access the property value. +Disjunctive markings are represented as a conjunctive list of disjunctive sets. +The top-level set is a conjunction of sets, where each inner set should be +treated as a unit where any marking within the set can satisfy the set. +All sets within the top level set should be satisfied. +""" + + class DividePropertyExpression(core.ModelBase): """Divides the left numeric value by the right numeric value.""" @@ -1103,6 +1144,12 @@ class EqualsQueryV2(core.ModelBase): type: typing.Literal["eq"] = "eq" +class ErrorComputingSecurity(core.ModelBase): + """Indicates the server was not able to load the securities of the property.""" + + type: typing.Literal["errorComputingSecurity"] = "errorComputingSecurity" + + class ExactDistinctAggregationV2(core.ModelBase): """Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.""" @@ -1257,8 +1304,8 @@ class HumanReadableFormat(core.ModelBase): class InQuery(core.ModelBase): """ Returns objects where the specified field equals any of the provided values. Allows you to - specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, - but not both. + specify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects + in the object set. Either `field` or `propertyIdentifier` must be supplied, but not both. """ field: typing.Optional[PropertyApiName] = None @@ -1810,7 +1857,7 @@ class LoadObjectSetRequestV2(core.ModelBase): object_set: ObjectSet = pydantic.Field(alias=str("objectSet")) # type: ignore[literal-required] order_by: typing.Optional[SearchOrderByV2] = pydantic.Field(alias=str("orderBy"), default=None) # type: ignore[literal-required] select: typing.List[SelectedPropertyApiName] - select_v2: typing.Optional[typing.List[PropertyIdentifier]] = pydantic.Field(alias=str("selectV2"), default=None) # type: ignore[literal-required] + select_v2: typing.List[PropertyIdentifier] = pydantic.Field(alias=str("selectV2")) # type: ignore[literal-required] """ The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. @@ -1824,6 +1871,15 @@ class LoadObjectSetRequestV2(core.ModelBase): Setting this to true may improve performance of this endpoint for object types in OSV2. """ + load_property_securities: typing.Optional[bool] = pydantic.Field(alias=str("loadPropertySecurities"), default=None) # type: ignore[literal-required] + """ + A flag to load the securities for all properties. + Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. + Returned objects will return all properties as Secured Property Values, which provide the property data + as well an index into the `propertySecurities` list. + This feature is experimental and not yet generally available. + """ + snapshot: typing.Optional[bool] = None """ A flag to use snapshot consistency when paging. @@ -1844,6 +1900,7 @@ class LoadObjectSetResponseV2(core.ModelBase): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] total_count: core_models.TotalCount = pydantic.Field(alias=str("totalCount")) # type: ignore[literal-required] compute_usage: typing.Optional[core_models.ComputeSeconds] = pydantic.Field(alias=str("computeUsage"), default=None) # type: ignore[literal-required] + property_securities: typing.List[PropertySecurities] = pydantic.Field(alias=str("propertySecurities")) # type: ignore[literal-required] class LoadObjectSetV2MultipleObjectTypesRequest(core.ModelBase): @@ -1852,7 +1909,7 @@ class LoadObjectSetV2MultipleObjectTypesRequest(core.ModelBase): object_set: ObjectSet = pydantic.Field(alias=str("objectSet")) # type: ignore[literal-required] order_by: typing.Optional[SearchOrderByV2] = pydantic.Field(alias=str("orderBy"), default=None) # type: ignore[literal-required] select: typing.List[SelectedPropertyApiName] - select_v2: typing.Optional[typing.List[PropertyIdentifier]] = pydantic.Field(alias=str("selectV2"), default=None) # type: ignore[literal-required] + select_v2: typing.List[PropertyIdentifier] = pydantic.Field(alias=str("selectV2")) # type: ignore[literal-required] """ The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. @@ -1866,6 +1923,15 @@ class LoadObjectSetV2MultipleObjectTypesRequest(core.ModelBase): Setting this to true may improve performance of this endpoint for object types in OSV2. """ + load_property_securities: typing.Optional[bool] = pydantic.Field(alias=str("loadPropertySecurities"), default=None) # type: ignore[literal-required] + """ + A flag to load the securities for all properties. + Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. + Returned objects will return all properties as Secured Property Values, which provide the property data + as well an index into the `propertySecurities` list. + This feature is experimental and not yet generally available. + """ + snapshot: typing.Optional[bool] = None """ A flag to use snapshot consistency when paging. @@ -1901,6 +1967,7 @@ class LoadObjectSetV2MultipleObjectTypesResponse(core.ModelBase): interface_to_object_type_mappings: typing.Dict[InterfaceTypeApiName, InterfaceToObjectTypeMappings] = pydantic.Field(alias=str("interfaceToObjectTypeMappings")) # type: ignore[literal-required] interface_to_object_type_mappings_v2: typing.Dict[InterfaceTypeApiName, InterfaceToObjectTypeMappingsV2] = pydantic.Field(alias=str("interfaceToObjectTypeMappingsV2")) # type: ignore[literal-required] compute_usage: typing.Optional[core_models.ComputeSeconds] = pydantic.Field(alias=str("computeUsage"), default=None) # type: ignore[literal-required] + property_securities: typing.List[PropertySecurities] = pydantic.Field(alias=str("propertySecurities")) # type: ignore[literal-required] class LoadObjectSetV2ObjectsOrInterfacesRequest(core.ModelBase): @@ -1909,7 +1976,7 @@ class LoadObjectSetV2ObjectsOrInterfacesRequest(core.ModelBase): object_set: ObjectSet = pydantic.Field(alias=str("objectSet")) # type: ignore[literal-required] order_by: typing.Optional[SearchOrderByV2] = pydantic.Field(alias=str("orderBy"), default=None) # type: ignore[literal-required] select: typing.List[SelectedPropertyApiName] - select_v2: typing.Optional[typing.List[PropertyIdentifier]] = pydantic.Field(alias=str("selectV2"), default=None) # type: ignore[literal-required] + select_v2: typing.List[PropertyIdentifier] = pydantic.Field(alias=str("selectV2")) # type: ignore[literal-required] """ The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. @@ -2011,6 +2078,10 @@ class LteQueryV2(core.ModelBase): type: typing.Literal["lte"] = "lte" +MarkingId = str +"""The id of a classification or mandatory marking.""" + + class MatchRule(core.ModelBase): """Matches intervals containing the terms in the query""" @@ -3120,6 +3191,16 @@ class PropertyKnownTypeFormattingRule(core.ModelBase): """ +class PropertyMarkingSummary(core.ModelBase): + """All marking requirements applicable to a property value.""" + + conjunctive: typing.Optional[ConjunctiveMarkingSummary] = None + disjunctive: typing.Optional[DisjunctiveMarkingSummary] = None + container_conjunctive: typing.Optional[ContainerConjunctiveMarkingSummary] = pydantic.Field(alias=str("containerConjunctive"), default=None) # type: ignore[literal-required] + container_disjunctive: typing.Optional[ContainerDisjunctiveMarkingSummary] = pydantic.Field(alias=str("containerDisjunctive"), default=None) # type: ignore[literal-required] + type: typing.Literal["propertyMarkingSummary"] = "propertyMarkingSummary" + + class PropertyNumberFormattingRule(core.ModelBase): """Wrapper for numeric formatting options.""" @@ -3151,6 +3232,19 @@ class PropertyNumberFormattingRule(core.ModelBase): """PropertyOrStructFieldOfPropertyImplementation""" +class PropertySecurities(core.ModelBase): + """A disjunctive set of security results for a property value.""" + + disjunction: typing.List[PropertySecurity] + + +PropertySecurity = typing_extensions.Annotated[ + typing.Union["PropertyMarkingSummary", "UnsupportedPolicy", "ErrorComputingSecurity"], + pydantic.Field(discriminator="type"), +] +"""PropertySecurity""" + + class PropertyTimestampFormattingRule(core.ModelBase): """Formatting configuration for timestamp property values.""" @@ -3231,6 +3325,7 @@ class PropertyV2(core.ModelBase): | Integer | number | `238940` | | Long | string | `"58319870951433"` | | [MediaReference](https://palantir.com/docs/foundry/api/v2/ontologies-v2-resources/media-reference-properties/media-reference-property-basics/)| JSON encoded `MediaReference` object | `{"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}}` | +| Secured Property Value | JSON encoded `SecuredPropertyValue` object | `{"value": 10, "propertySecurityIndex" : 5}` | | Short | number | `8739` | | String | string | `"Call me Ishmael"` | | Struct | JSON object of struct field API name -> value | {"firstName": "Alex", "lastName": "Karp"} | @@ -3703,7 +3798,7 @@ class SearchObjectsRequestV2(core.ModelBase): select: typing.List[PropertyApiName] """The API names of the object type properties to include in the response.""" - select_v2: typing.Optional[typing.List[PropertyIdentifier]] = pydantic.Field(alias=str("selectV2"), default=None) # type: ignore[literal-required] + select_v2: typing.List[PropertyIdentifier] = pydantic.Field(alias=str("selectV2")) # type: ignore[literal-required] """ The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. @@ -4371,6 +4466,12 @@ class UniqueIdentifierArgument(core.ModelBase): """ +class UnsupportedPolicy(core.ModelBase): + """Indicates the property is backed by a restricted view that does not support property securities.""" + + type: typing.Literal["unsupportedPolicy"] = "unsupportedPolicy" + + class UuidConstraint(core.ModelBase): """The string must be a valid UUID (Universally Unique Identifier).""" @@ -4625,9 +4726,17 @@ class WithinPolygonQuery(core.ModelBase): core.resolve_forward_references(AttachmentMetadataResponse, globalns=globals(), localns=locals()) core.resolve_forward_references(BatchActionObjectEdit, globalns=globals(), localns=locals()) core.resolve_forward_references(BatchActionResults, globalns=globals(), localns=locals()) +core.resolve_forward_references(ConjunctiveMarkingSummary, globalns=globals(), localns=locals()) +core.resolve_forward_references( + ContainerConjunctiveMarkingSummary, globalns=globals(), localns=locals() +) +core.resolve_forward_references( + ContainerDisjunctiveMarkingSummary, globalns=globals(), localns=locals() +) core.resolve_forward_references(DatetimeFormat, globalns=globals(), localns=locals()) core.resolve_forward_references(DatetimeTimezone, globalns=globals(), localns=locals()) core.resolve_forward_references(DerivedPropertyDefinition, globalns=globals(), localns=locals()) +core.resolve_forward_references(DisjunctiveMarkingSummary, globalns=globals(), localns=locals()) core.resolve_forward_references(DurationFormatStyle, globalns=globals(), localns=locals()) core.resolve_forward_references( InterfaceLinkTypeLinkedEntityApiName, globalns=globals(), localns=locals() @@ -4668,6 +4777,7 @@ class WithinPolygonQuery(core.ModelBase): core.resolve_forward_references( PropertyOrStructFieldOfPropertyImplementation, globalns=globals(), localns=locals() ) +core.resolve_forward_references(PropertySecurity, globalns=globals(), localns=locals()) core.resolve_forward_references( PropertyTypeReferenceOrStringConstant, globalns=globals(), localns=locals() ) @@ -4765,6 +4875,9 @@ class WithinPolygonQuery(core.ModelBase): "BoundingBoxValue", "CenterPoint", "CenterPointTypes", + "ConjunctiveMarkingSummary", + "ContainerConjunctiveMarkingSummary", + "ContainerDisjunctiveMarkingSummary", "ContainsAllTermsInOrderPrefixLastTerm", "ContainsAllTermsInOrderQuery", "ContainsAllTermsQuery", @@ -4807,6 +4920,7 @@ class WithinPolygonQuery(core.ModelBase): "DeprecatedPropertyTypeStatus", "DerivedPropertyApiName", "DerivedPropertyDefinition", + "DisjunctiveMarkingSummary", "DividePropertyExpression", "DoesNotIntersectBoundingBoxQuery", "DoesNotIntersectPolygonQuery", @@ -4817,6 +4931,7 @@ class WithinPolygonQuery(core.ModelBase): "EntrySetType", "EnumConstraint", "EqualsQueryV2", + "ErrorComputingSecurity", "ExactDistinctAggregationV2", "ExamplePropertyTypeStatus", "ExecuteQueryRequest", @@ -4909,6 +5024,7 @@ class WithinPolygonQuery(core.ModelBase): "LogicRuleArgument", "LtQueryV2", "LteQueryV2", + "MarkingId", "MatchRule", "MaxAggregationV2", "MediaMetadata", @@ -5023,9 +5139,12 @@ class WithinPolygonQuery(core.ModelBase): "PropertyImplementation", "PropertyKnownTypeFormattingRule", "PropertyLoadLevel", + "PropertyMarkingSummary", "PropertyNumberFormattingRule", "PropertyNumberFormattingRuleType", "PropertyOrStructFieldOfPropertyImplementation", + "PropertySecurities", + "PropertySecurity", "PropertyTimestampFormattingRule", "PropertyTypeApiName", "PropertyTypeReference", @@ -5144,6 +5263,7 @@ class WithinPolygonQuery(core.ModelBase): "UniqueIdentifierArgument", "UniqueIdentifierLinkId", "UniqueIdentifierValue", + "UnsupportedPolicy", "UuidConstraint", "ValidateActionResponseV2", "ValidationResult", diff --git a/foundry_sdk/v2/ontologies/ontology_object.py b/foundry_sdk/v2/ontologies/ontology_object.py index d162fbfc6..ab01fb7cc 100644 --- a/foundry_sdk/v2/ontologies/ontology_object.py +++ b/foundry_sdk/v2/ontologies/ontology_object.py @@ -16,6 +16,7 @@ import typing import pydantic +import typing_extensions from foundry_sdk import _core as core from foundry_sdk import _errors as errors @@ -349,7 +350,7 @@ def search( object_type: ontologies_models.ObjectTypeApiName, *, select: typing.List[ontologies_models.PropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, @@ -394,7 +395,7 @@ def search( :param select: The API names of the object type properties to include in the response. :type select: List[PropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :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 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. @@ -810,7 +811,7 @@ def search( object_type: ontologies_models.ObjectTypeApiName, *, select: typing.List[ontologies_models.PropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, @@ -855,7 +856,7 @@ def search( :param select: The API names of the object type properties to include in the response. :type select: List[PropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :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 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. diff --git a/foundry_sdk/v2/ontologies/ontology_object_set.py b/foundry_sdk/v2/ontologies/ontology_object_set.py index 4ac4224f9..4f0bf1ab1 100644 --- a/foundry_sdk/v2/ontologies/ontology_object_set.py +++ b/foundry_sdk/v2/ontologies/ontology_object_set.py @@ -16,6 +16,7 @@ import typing import pydantic +import typing_extensions from foundry_sdk import _core as core from foundry_sdk import _errors as errors @@ -133,6 +134,7 @@ def create_temporary( ontology: ontologies_models.OntologyIdentifier, *, object_set: ontologies_models.ObjectSet, + branch: typing.Optional[core_models.FoundryBranch] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -145,6 +147,8 @@ def create_temporary( :type ontology: OntologyIdentifier :param object_set: :type object_set: ObjectSet + :param branch: The Foundry branch to reference. 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 sdk_package_rid: The package rid of the generated SDK. :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The package version of the generated SDK. @@ -160,6 +164,7 @@ def create_temporary( method="POST", resource_path="/v2/ontologies/{ontology}/objectSets/createTemporary", query_params={ + "branch": branch, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, }, @@ -233,10 +238,11 @@ def load( *, object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = None, + load_property_securities: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -264,13 +270,15 @@ def load( :param select: :type select: List[SelectedPropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :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 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 include_compute_usage: :type include_compute_usage: Optional[IncludeComputeUsage] + :param load_property_securities: A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. + :type load_property_securities: Optional[bool] :param order_by: :type order_by: Optional[SearchOrderByV2] :param page_size: @@ -316,6 +324,7 @@ def load( page_token=page_token, page_size=page_size, exclude_rid=exclude_rid, + load_property_securities=load_property_securities, snapshot=snapshot, include_compute_usage=include_compute_usage, ), @@ -423,10 +432,11 @@ def load_multiple_object_types( *, object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = None, + load_property_securities: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -460,13 +470,15 @@ def load_multiple_object_types( :param select: :type select: List[SelectedPropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :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 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 include_compute_usage: :type include_compute_usage: Optional[IncludeComputeUsage] + :param load_property_securities: A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. + :type load_property_securities: Optional[bool] :param order_by: :type order_by: Optional[SearchOrderByV2] :param page_size: @@ -515,6 +527,7 @@ def load_multiple_object_types( page_token=page_token, page_size=page_size, exclude_rid=exclude_rid, + load_property_securities=load_property_securities, snapshot=snapshot, include_compute_usage=include_compute_usage, ), @@ -534,7 +547,7 @@ def load_objects_or_interfaces( *, object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, @@ -571,7 +584,7 @@ def load_objects_or_interfaces( :param select: :type select: List[SelectedPropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :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 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. @@ -797,6 +810,7 @@ def create_temporary( ontology: ontologies_models.OntologyIdentifier, *, object_set: ontologies_models.ObjectSet, + branch: typing.Optional[core_models.FoundryBranch] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -809,6 +823,8 @@ def create_temporary( :type ontology: OntologyIdentifier :param object_set: :type object_set: ObjectSet + :param branch: The Foundry branch to reference. 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 sdk_package_rid: The package rid of the generated SDK. :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The package version of the generated SDK. @@ -824,6 +840,7 @@ def create_temporary( method="POST", resource_path="/v2/ontologies/{ontology}/objectSets/createTemporary", query_params={ + "branch": branch, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, }, @@ -897,10 +914,11 @@ def load( *, object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = None, + load_property_securities: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -928,13 +946,15 @@ def load( :param select: :type select: List[SelectedPropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :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 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 include_compute_usage: :type include_compute_usage: Optional[IncludeComputeUsage] + :param load_property_securities: A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. + :type load_property_securities: Optional[bool] :param order_by: :type order_by: Optional[SearchOrderByV2] :param page_size: @@ -980,6 +1000,7 @@ def load( page_token=page_token, page_size=page_size, exclude_rid=exclude_rid, + load_property_securities=load_property_securities, snapshot=snapshot, include_compute_usage=include_compute_usage, ), @@ -1087,10 +1108,11 @@ def load_multiple_object_types( *, object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = None, + load_property_securities: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -1124,13 +1146,15 @@ def load_multiple_object_types( :param select: :type select: List[SelectedPropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :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 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 include_compute_usage: :type include_compute_usage: Optional[IncludeComputeUsage] + :param load_property_securities: A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. + :type load_property_securities: Optional[bool] :param order_by: :type order_by: Optional[SearchOrderByV2] :param page_size: @@ -1179,6 +1203,7 @@ def load_multiple_object_types( page_token=page_token, page_size=page_size, exclude_rid=exclude_rid, + load_property_securities=load_property_securities, snapshot=snapshot, include_compute_usage=include_compute_usage, ), @@ -1198,7 +1223,7 @@ def load_objects_or_interfaces( *, object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, @@ -1235,7 +1260,7 @@ def load_objects_or_interfaces( :param select: :type select: List[SelectedPropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :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 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. diff --git a/foundry_sdk/v2/sql_queries/errors.py b/foundry_sdk/v2/sql_queries/errors.py index fcb5a3ae9..3d996d5ca 100644 --- a/foundry_sdk/v2/sql_queries/errors.py +++ b/foundry_sdk/v2/sql_queries/errors.py @@ -29,7 +29,7 @@ class CancelSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore sqlQueryId: sql_queries_models.SqlQueryId - """The id of a query.""" + """The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints.""" @dataclass @@ -58,7 +58,7 @@ class GetResultsSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore sqlQueryId: sql_queries_models.SqlQueryId - """The id of a query.""" + """The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints.""" @dataclass @@ -74,7 +74,7 @@ class GetStatusSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore sqlQueryId: sql_queries_models.SqlQueryId - """The id of a query.""" + """The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints.""" @dataclass diff --git a/foundry_sdk/v2/sql_queries/sql_query.py b/foundry_sdk/v2/sql_queries/sql_query.py index 541b12d4d..0ef43a68f 100644 --- a/foundry_sdk/v2/sql_queries/sql_query.py +++ b/foundry_sdk/v2/sql_queries/sql_query.py @@ -63,7 +63,7 @@ def cancel( """ Cancels a query. If the query is no longer running this is effectively a no-op. - :param sql_query_id: The id of a query. + :param sql_query_id: The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -194,7 +194,7 @@ def get_results( This endpoint implements long polling and requests will time out after one minute. They can be safely retried while the query is still running. - :param sql_query_id: The id of a query. + :param sql_query_id: The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -256,7 +256,7 @@ def get_status( """ Gets the status of a query. - :param sql_query_id: The id of a query. + :param sql_query_id: The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -365,7 +365,7 @@ def cancel( """ Cancels a query. If the query is no longer running this is effectively a no-op. - :param sql_query_id: The id of a query. + :param sql_query_id: The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -496,7 +496,7 @@ def get_results( This endpoint implements long polling and requests will time out after one minute. They can be safely retried while the query is still running. - :param sql_query_id: The id of a query. + :param sql_query_id: The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -558,7 +558,7 @@ def get_status( """ Gets the status of a query. - :param sql_query_id: The id of a query. + :param sql_query_id: The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] diff --git a/tests/test_api_client.py b/tests/test_api_client.py index 8ea89d13c..acc5cb9b4 100644 --- a/tests/test_api_client.py +++ b/tests/test_api_client.py @@ -430,51 +430,51 @@ def test_ssl_error(): def test_passing_in_str_auth(): with pytest.raises(TypeError) as e: ApiClient(auth="foo", hostname="localhost:8123") # type: ignore - assert str(e.value).startswith( - "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not a string." - ) + assert str(e.value).startswith( + "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not a string." + ) with pytest.raises(TypeError) as e: AsyncApiClient(auth="foo", hostname="localhost:8123") # type: ignore - assert str(e.value).startswith( - "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not a string." - ) + assert str(e.value).startswith( + "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not a string." + ) def test_passing_in_int_to_auth(): with pytest.raises(TypeError) as e: ApiClient(auth=2, hostname="localhost:8123") # type: ignore - assert ( - str(e.value) - == "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not an instance of int." - ) + assert ( + str(e.value) + == "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not an instance of int." + ) with pytest.raises(TypeError) as e: AsyncApiClient(auth=2, hostname="localhost:8123") # type: ignore - assert ( - str(e.value) - == "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not an instance of int." - ) + assert ( + str(e.value) + == "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not an instance of int." + ) def test_passing_in_int_to_hostname(): with pytest.raises(TypeError) as e: ApiClient(auth=UserTokenAuth(token="foo"), hostname=2) # type: ignore - assert str(e.value) == "hostname must be a string, not int." + assert str(e.value) == "The hostname must be a string, not ." with pytest.raises(TypeError) as e: AsyncApiClient(auth=UserTokenAuth(token="foo"), hostname=2) # type: ignore - assert str(e.value) == "hostname must be a string, not int." + assert str(e.value) == "The hostname must be a string, not ." def test_passing_in_int_to_config(): with pytest.raises(TypeError) as e: ApiClient(auth=UserTokenAuth(token="foo"), hostname="localhost:1234", config=2) # type: ignore - assert str(e.value) == "config must be an instance of Config, not int." + assert str(e.value) == "config must be an instance of Config, not ." with pytest.raises(TypeError) as e: AsyncApiClient(auth=UserTokenAuth(token="foo"), hostname="localhost:1234", config=2) # type: ignore - assert str(e.value) == "config must be an instance of Config, not int." + assert str(e.value) == "config must be an instance of Config, not ." def test_config_shared_with_auth():