From 25ffc610d8525090ad73f4d6e6cb56805b7e714d Mon Sep 17 00:00:00 2001 From: svc-excavator-bot Date: Sat, 16 May 2026 05:04:44 +0000 Subject: [PATCH] Excavator: Upgrade API Version --- README.md | 463 +-- docs-snippets-npm/package.json | 2 +- docs-snippets-npm/src/index.ts | 465 +-- docs/v1/Core/models/MediaReferenceType.md | 11 - docs/v1/Core/models/VoidType.md | 11 - docs/v1/Ontologies/models/EqualsQuery.md | 3 - docs/v1/Ontologies/models/OntologyDataType.md | 1 - docs/v1/Ontologies/models/QueryDataType.md | 17 +- .../models/QueryTypeReferenceType.md | 14 - .../models/TypeReferenceIdentifier.md | 13 - docs/v2/Admin/AuthenticationProvider.md | 12 +- docs/v2/Admin/CbacBanner.md | 61 - docs/v2/Admin/CbacMarkingRestrictions.md | 58 - docs/v2/Admin/Enrollment.md | 4 +- docs/v2/Admin/EnrollmentRoleAssignment.md | 6 +- docs/v2/Admin/Group.md | 129 +- docs/v2/Admin/GroupMember.md | 13 +- docs/v2/Admin/GroupProviderInfo.md | 16 +- docs/v2/Admin/Host.md | 2 +- docs/v2/Admin/MarkingCategory.md | 76 +- docs/v2/Admin/MarkingRoleAssignment.md | 4 - docs/v2/Admin/Organization.md | 23 +- docs/v2/Admin/OrganizationGuestMember.md | 173 - docs/v2/Admin/OrganizationRoleAssignment.md | 23 +- docs/v2/Admin/User.md | 17 +- docs/v2/Admin/UserProviderInfo.md | 16 +- .../AddOrganizationGuestMembersRequest.md | 11 - docs/v2/Admin/models/CbacBanner.md | 14 - .../models/CbacBannerClassificationString.md | 11 - .../Admin/models/CbacMarkingRestrictions.md | 15 - .../models/CbacMarkingRestrictionsIsValid.md | 11 - ...arkingRestrictionsUserSatisfiesMarkings.md | 11 - .../models/ClassificationBannerDisplayType.md | 12 - docs/v2/Admin/models/GroupMember.md | 1 - .../Admin/models/ListCurrentGroupsResponse.md | 11 - .../ListOrganizationGuestMembersResponse.md | 12 - .../Admin/models/OrganizationGuestMember.md | 12 - .../RemoveOrganizationGuestMembersRequest.md | 11 - docs/v2/Admin/models/ReplaceGroupRequest.md | 14 - .../models/ReplaceMarkingCategoryRequest.md | 12 - docs/v2/AipAgents/Agent.md | 6 +- docs/v2/AipAgents/AgentVersion.md | 12 +- docs/v2/AipAgents/Content.md | 4 +- docs/v2/AipAgents/Session.md | 60 +- docs/v2/AipAgents/SessionTrace.md | 4 +- docs/v2/AipAgents/models/Agent.md | 4 +- docs/v2/AipAgents/models/AgentRid.md | 2 +- .../models/BlockingContinueSessionRequest.md | 4 +- .../models/GetRagContextForSessionRequest.md | 2 +- docs/v2/AipAgents/models/InputContext.md | 2 +- docs/v2/AipAgents/models/Parameter.md | 2 +- docs/v2/AipAgents/models/ParameterId.md | 2 +- docs/v2/AipAgents/models/ParameterValue.md | 2 +- .../AipAgents/models/ParameterValueUpdate.md | 2 +- .../AipAgents/models/SessionExchangeResult.md | 2 +- .../models/StreamingContinueSessionRequest.md | 4 +- docs/v2/Checkpoints/Record.md | 12 +- docs/v2/Checkpoints/models/CheckpointType.md | 5 - .../v2/Checkpoints/models/CheckpointedItem.md | 1 - .../Checkpoints/models/CheckpointedItemId.md | 1 - .../models/CheckpointedPeeringJob.md | 13 - .../models/CheckpointedPeeringJobId.md | 13 - .../models/CheckpointedResourceType.md | 1 - docs/v2/Checkpoints/models/RecordCreatedAt.md | 2 +- .../models/SearchCheckpointRecordsResponse.md | 2 +- docs/v2/Connectivity/Connection.md | 41 +- docs/v2/Connectivity/FileImport.md | 44 +- docs/v2/Connectivity/TableImport.md | 42 +- docs/v2/Connectivity/VirtualTable.md | 12 +- .../models/NetworkEgressPolicyRid.md | 0 docs/v2/Core/models/Color.md | 11 - docs/v2/Core/models/ColumnName.md | 11 - docs/v2/Core/models/VoidType.md | 11 - docs/v2/Datasets/Dataset.md | 36 +- docs/v2/Datasets/View.md | 41 +- docs/v2/Filesystem/Folder.md | 59 - docs/v2/Filesystem/Project.md | 4 - .../v2/Filesystem/ProjectResourceReference.md | 185 - .../AddExternalResourceReferenceRequest.md | 13 - .../AddFilesystemResourceReferenceRequest.md | 12 - .../AddProjectResourceReferencesRequest.md | 11 - .../models/AddResourceReferenceRequest.md | 16 - .../Filesystem/models/CreateProjectRequest.md | 1 - .../ListProjectResourceReferencesResponse.md | 12 - docs/v2/Filesystem/models/Project.md | 1 - .../ProjectExternalResourceReference.md | 15 - .../ProjectFilesystemResourceReference.md | 15 - .../ProjectResourceLevelRoleGrantsAllowed.md | 11 - .../models/ProjectResourceReference.md | 11 - .../models/ProjectResourceReferenceType.md | 14 - .../models/ProjectResourceReferenceUnion.md | 18 - .../RemoveProjectResourceReferencesRequest.md | 11 - .../Filesystem/models/ReplaceFolderRequest.md | 12 - docs/v2/Filesystem/models/TrashStatus.md | 6 +- docs/v2/Functions/Execution.md | 125 - docs/v2/Functions/Query.md | 167 +- .../models/CancelExecutionResponse.md | 11 - .../models/ExecuteAsyncQueryRequest.md | 14 - .../models/ExecuteQueryAsyncResponse.md | 17 - .../Functions/models/ExecuteQueryRequest.md | 3 +- .../v2/Functions/models/ExecutionCompleted.md | 13 - docs/v2/Functions/models/ExecutionId.md | 11 - .../v2/Functions/models/ExecutionSubmitted.md | 14 - .../models/GetByRidQueriesBatchResponse.md | 11 - ...stElement.md => GetByRidQueriesRequest.md} | 6 +- .../models/GetExecutionResultResponse.md | 17 - .../models/GetResultExecutionRequest.md | 11 - docs/v2/Functions/models/Parameter.md | 1 - docs/v2/Functions/models/Query.md | 1 - docs/v2/Functions/models/QueryDataType.md | 3 - .../models/QueryTypeReferenceType.md | 14 - docs/v2/Functions/models/RunningExecution.md | 11 - .../models/StreamingExecuteQueryRequest.md | 3 +- .../v2/Functions/models/SucceededExecution.md | 12 - .../models/TypeReferenceIdentifier.md | 13 - docs/v2/LanguageModels/AnthropicModel.md | 4 - .../LanguageModels/models/AnthropicEffort.md | 18 - .../models/AnthropicJsonSchemaOutputFormat.md | 12 - .../models/AnthropicMessagesRequest.md | 1 - .../models/AnthropicOutputConfig.md | 12 - .../models/AnthropicOutputFormat.md | 11 - docs/v2/MediaSets/MediaSet.md | 238 +- .../MediaSets/models/ApiNameLocatorWrapper.md | 12 - .../BatchTransactionsTransactionPolicy.md | 13 - docs/v2/MediaSets/models/ChatLlmSpec.md | 14 - .../v2/MediaSets/models/ChatLlmSpecWrapper.md | 12 - docs/v2/MediaSets/models/CropConfig.md | 11 - .../MediaSets/models/DocumentDecodeFormat.md | 2 - .../models/DocumentToTextOperation.md | 3 - .../ExtractDocumentLayoutAwareTextV2Config.md | 13 - ...tractDocumentLayoutAwareTextV2Operation.md | 15 - .../models/ExtractDocumentTextV2Config.md | 13 - .../models/ExtractDocumentTextV2Operation.md | 15 - .../models/ExtractTextPreprocessingWrapper.md | 12 - .../models/ExtractVlmTextOperation.md | 18 - .../models/GetMediaItemInfoResponse.md | 3 - .../MediaSets/models/GetMediaSetResponse.md | 15 - docs/v2/MediaSets/models/ImageSpec.md | 16 - .../MediaSets/models/LanguageModelLocator.md | 11 - ...ayoutAwareExtractionPreprocessingConfig.md | 12 - .../models/LayoutAwarePreprocessingWrapper.md | 12 - docs/v2/MediaSets/models/LlmSpec.md | 11 - docs/v2/MediaSets/models/MediaItemMetadata.md | 1 - docs/v2/MediaSets/models/MediaSchema.md | 19 - .../MediaSets/models/Model3dDecodeFormat.md | 12 - .../models/Model3dMediaItemMetadata.md | 14 - .../models/NoTransactionsTransactionPolicy.md | 13 - docs/v2/MediaSets/models/OcrMode.md | 12 - docs/v2/MediaSets/models/PageRange.md | 12 - .../MediaSets/models/PutMediaItemResponse.md | 1 - .../models/RegisterMediaItemRequest.md | 12 - .../models/RegisterMediaItemResponse.md | 12 - docs/v2/MediaSets/models/ResizingMode.md | 11 - docs/v2/MediaSets/models/TextOutputFormat.md | 12 - docs/v2/MediaSets/models/TransactionPolicy.md | 17 - .../models/VlmPreprocessingConfig.md | 16 - docs/v2/Models/Experiment.md | 133 - docs/v2/Models/ExperimentArtifactTable.md | 160 - docs/v2/Models/ExperimentSeries.md | 159 - docs/v2/Models/LiveDeployment.md | 242 -- docs/v2/Models/Model.md | 64 +- docs/v2/Models/ModelFunction.md | 192 -- docs/v2/Models/ModelStudio.md | 163 - docs/v2/Models/ModelStudioConfigVersion.md | 244 -- docs/v2/Models/ModelStudioRun.md | 70 - docs/v2/Models/ModelStudioTrainer.md | 109 - docs/v2/Models/ModelVersion.md | 13 +- docs/v2/Models/models/BooleanParameter.md | 12 - .../v2/Models/models/ChangelogTooLongError.md | 13 - docs/v2/Models/models/ColumnTypeSpecId.md | 11 - .../CreateConfigValidationFailureReason.md | 30 - .../models/CreateLiveDeploymentRequest.md | 12 - .../models/CreateLiveDeploymentTarget.md | 12 - .../models/CreateModelFunctionRequest.md | 14 - .../CreateModelStudioConfigVersionRequest.md | 15 - .../Models/models/CreateModelStudioRequest.md | 12 - docs/v2/Models/models/DatasetInput.md | 15 - .../models/DatasetSchemaNotFoundError.md | 12 - docs/v2/Models/models/DatetimeParameter.md | 12 - .../DirectCreateLiveDeploymentTarget.md | 14 - docs/v2/Models/models/DoubleParameter.md | 12 - .../Models/models/DoubleSeriesAggregations.md | 14 - docs/v2/Models/models/DoubleSeriesV1.md | 12 - docs/v2/Models/models/DoubleSeriesValueV1.md | 13 - docs/v2/Models/models/EpochMillis.md | 13 - docs/v2/Models/models/Experiment.md | 25 - .../models/ExperimentArtifactDetails.md | 11 - .../models/ExperimentArtifactMetadata.md | 14 - .../Models/models/ExperimentArtifactName.md | 11 - .../models/ExperimentAuthoringSource.md | 12 - docs/v2/Models/models/ExperimentBranch.md | 11 - .../models/ExperimentCodeWorkspaceSource.md | 13 - docs/v2/Models/models/ExperimentRid.md | 11 - docs/v2/Models/models/ExperimentSdkSource.md | 11 - docs/v2/Models/models/ExperimentSource.md | 17 - docs/v2/Models/models/ExperimentStatus.md | 12 - docs/v2/Models/models/ExperimentTagText.md | 11 - docs/v2/Models/models/FieldValidationError.md | 14 - docs/v2/Models/models/GpuType.md | 18 - .../InconsistentArrayDimensionsError.md | 13 - .../Models/models/InferenceInputErrorType.md | 24 - docs/v2/Models/models/InputAlias.md | 11 - docs/v2/Models/models/IntegerParameter.md | 12 - .../Models/models/InvalidArrayShapeError.md | 13 - .../v2/Models/models/InvalidMapFormatError.md | 11 - .../InvalidResourceConfigurationError.md | 13 - .../models/InvalidTabularFormatError.md | 12 - .../models/JsonSchemaValidationError.md | 13 - .../ListModelStudioConfigVersionsResponse.md | 12 - .../models/ListModelStudioRunsResponse.md | 12 - .../models/ListModelStudioTrainersResponse.md | 12 - docs/v2/Models/models/LiveDeployment.md | 14 - docs/v2/Models/models/LiveDeploymentGpu.md | 12 - .../models/LiveDeploymentModelVersion.md | 12 - docs/v2/Models/models/LiveDeploymentRid.md | 11 - .../LiveDeploymentRuntimeConfiguration.md | 18 - .../LiveDeploymentScalingConfiguration.md | 14 - docs/v2/Models/models/LiveDeploymentState.md | 23 - docs/v2/Models/models/LiveDeploymentStatus.md | 12 - .../MissingRequiredDatasetColumnError.md | 14 - ...kerConfigInputDatasetColumnMappingError.md | 13 - .../models/MissingWorkerConfigInputError.md | 12 - ...onfigInputObjectSetPropertyMappingError.md | 13 - .../models/MissingWorkerConfigOutputError.md | 12 - docs/v2/Models/models/ModelFunction.md | 16 - docs/v2/Models/models/ModelFunctionApiName.md | 11 - .../Models/models/ModelFunctionDisplayName.md | 11 - .../Models/models/ModelFunctionFunctionRid.md | 11 - .../models/ModelFunctionFunctionVersion.md | 11 - .../Models/models/ModelFunctionIsRowWise.md | 11 - docs/v2/Models/models/ModelOutput.md | 12 - docs/v2/Models/models/ModelStudio.md | 13 - .../Models/models/ModelStudioConfigVersion.md | 19 - .../models/ModelStudioConfigVersionName.md | 11 - .../models/ModelStudioConfigVersionNumber.md | 11 - docs/v2/Models/models/ModelStudioInput.md | 11 - docs/v2/Models/models/ModelStudioOutput.md | 11 - docs/v2/Models/models/ModelStudioRid.md | 11 - docs/v2/Models/models/ModelStudioRun.md | 18 - .../Models/models/ModelStudioRunBuildRid.md | 11 - docs/v2/Models/models/ModelStudioRunJobRid.md | 11 - .../models/ModelStudioRunModelOutput.md | 14 - docs/v2/Models/models/ModelStudioRunOutput.md | 11 - docs/v2/Models/models/ModelStudioTrainer.md | 19 - .../models/ModelStudioTrainerExperimental.md | 11 - .../Models/models/ModelStudioWorkerConfig.md | 13 - docs/v2/Models/models/ModelVersion.md | 3 - .../ModelVersionCodeRepositorySource.md | 13 - .../models/ModelVersionCodeWorkspaceSource.md | 13 - .../models/ModelVersionContainerizedSource.md | 11 - .../models/ModelVersionExternalSource.md | 11 - .../models/ModelVersionModelStudioSource.md | 12 - .../models/ModelVersionPromotedSource.md | 13 - .../v2/Models/models/ModelVersionSdkSource.md | 11 - docs/v2/Models/models/ModelVersionSource.md | 21 - ...ultipleColumnsNotAllowedForTrainerError.md | 13 - ...iplePropertiesNotAllowedForTrainerError.md | 13 - docs/v2/Models/models/OtherValidationError.md | 12 - docs/v2/Models/models/OutputAlias.md | 11 - .../OutputResourceInDifferentProjectError.md | 13 - .../models/OutputResourceNotFoundError.md | 13 - docs/v2/Models/models/Parameter.md | 12 - docs/v2/Models/models/ParameterName.md | 11 - docs/v2/Models/models/ParameterValue.md | 19 - .../models/PromoteVersionModelRequest.md | 12 - .../models/ReplaceLiveDeploymentRequest.md | 11 - .../models/ReplaceModelFunctionRequest.md | 13 - .../models/RequiredValueMissingError.md | 12 - .../v2/Models/models/ResourceConfiguration.md | 13 - docs/v2/Models/models/RunId.md | 11 - .../models/SearchExperimentsAndFilter.md | 12 - .../models/SearchExperimentsContainsFilter.md | 13 - .../SearchExperimentsContainsFilterField.md | 12 - .../models/SearchExperimentsEqualsFilter.md | 13 - .../SearchExperimentsEqualsFilterField.md | 17 - .../Models/models/SearchExperimentsFilter.md | 35 - .../models/SearchExperimentsNotFilter.md | 12 - .../SearchExperimentsNumericFilterOperator.md | 12 - .../models/SearchExperimentsOrFilter.md | 12 - .../Models/models/SearchExperimentsOrderBy.md | 12 - .../models/SearchExperimentsOrderByField.md | 11 - .../SearchExperimentsParameterFilter.md | 20 - ...earchExperimentsParameterFilterOperator.md | 13 - .../Models/models/SearchExperimentsRequest.md | 14 - .../models/SearchExperimentsResponse.md | 12 - .../models/SearchExperimentsSeriesFilter.md | 17 - .../SearchExperimentsSeriesFilterField.md | 13 - .../SearchExperimentsStartsWithFilter.md | 13 - .../SearchExperimentsStartsWithFilterField.md | 12 - .../SearchExperimentsSummaryMetricFilter.md | 17 - docs/v2/Models/models/Series.md | 11 - docs/v2/Models/models/SeriesAggregations.md | 13 - .../Models/models/SeriesAggregationsValue.md | 11 - docs/v2/Models/models/SeriesName.md | 11 - docs/v2/Models/models/StringParameter.md | 12 - docs/v2/Models/models/SummaryMetric.md | 13 - .../Models/models/SummaryMetricAggregation.md | 12 - docs/v2/Models/models/TableArtifactDetails.md | 12 - docs/v2/Models/models/TrainerDescription.md | 11 - docs/v2/Models/models/TrainerId.md | 11 - .../models/TrainerInputsSpecification.md | 12 - docs/v2/Models/models/TrainerName.md | 11 - .../models/TrainerOutputsSpecification.md | 12 - .../Models/models/TrainerSchemaDefinition.md | 11 - docs/v2/Models/models/TrainerType.md | 11 - docs/v2/Models/models/TrainerVersion.md | 11 - .../v2/Models/models/TrainerVersionLocator.md | 12 - .../TransformJsonLiveDeploymentRequest.md | 11 - .../models/TransformLiveDeploymentResponse.md | 11 - docs/v2/Models/models/TypeMismatchError.md | 13 - ...nColumnSpecIdInConfigColumnMappingError.md | 13 - .../v2/Models/models/UnknownInputNameError.md | 12 - docs/v2/Models/models/UnsupportedTypeError.md | 12 - docs/v2/Ontologies/Action.md | 8 - docs/v2/Ontologies/ActionType.md | 65 - docs/v2/Ontologies/CipherTextProperty.md | 2 +- docs/v2/Ontologies/ObjectType.md | 156 +- docs/v2/Ontologies/OntologyInterface.md | 4 - docs/v2/Ontologies/OntologyObjectSet.md | 52 - docs/v2/Ontologies/Query.md | 8 +- docs/v2/Ontologies/QueryType.md | 5 +- .../models/AggregationAccuracyRequest.md | 9 +- .../models/AggregationDurationGroupingV2.md | 4 +- .../models/AggregationExactGroupingV2.md | 7 +- .../models/AggregationFixedWidthGroupingV2.md | 5 +- .../models/AggregationRangesGroupingV2.md | 5 +- .../ApproximateDistinctAggregationV2.md | 5 +- .../ApproximatePercentileAggregationV2.md | 5 +- docs/v2/Ontologies/models/AvgAggregationV2.md | 5 +- docs/v2/Ontologies/models/BoundingBoxValue.md | 1 - .../models/ContainsAllTermsQuery.md | 2 +- .../models/EditTypeFilter.md} | 9 +- .../Ontologies/models/EditsHistoryFilter.md | 16 - ...estampFilter.md => EditsHistoryFilters.md} | 8 +- .../models/EditsHistoryOperationIdsFilter.md | 12 - docs/v2/Ontologies/models/EqualsQueryV2.md | 2 - .../models/ExactDistinctAggregationV2.md | 8 +- docs/v2/Ontologies/models/FuzzyRule.md | 16 - docs/v2/Ontologies/models/GeoJsonString.md | 12 - .../Ontologies/models/GeoShapeV2Geometry.md | 17 - docs/v2/Ontologies/models/GeoShapeV2Query.md | 18 - .../models/GetActionTypeByRidBatchRequest.md | 11 - .../GetActionTypeByRidBatchRequestElement.md | 11 - .../models/GetActionTypeByRidBatchResponse.md | 11 - .../models/GetObjectTypeByRidBatchRequest.md | 11 - .../GetObjectTypeByRidBatchRequestElement.md | 11 - .../models/GetObjectTypeByRidBatchResponse.md | 11 - ...ingLinkTypesByObjectTypeRidBatchRequest.md | 12 - ...TypesByObjectTypeRidBatchRequestElement.md | 11 - ...ngLinkTypesByObjectTypeRidBatchResponse.md | 11 - docs/v2/Ontologies/models/InQuery.md | 2 - .../v2/Ontologies/models/IntervalQueryRule.md | 1 - ...dObjectSetV2ObjectsOrInterfacesResponse.md | 1 - docs/v2/Ontologies/models/MaxAggregationV2.md | 5 +- docs/v2/Ontologies/models/MinAggregationV2.md | 5 +- .../models/ObjectEditHistoryEntry.md | 1 - .../models/ObjectTypeEditsHistoryRequest.md | 2 +- docs/v2/Ontologies/models/OntologyDataType.md | 1 - docs/v2/Ontologies/models/QueryDataType.md | 17 +- docs/v2/Ontologies/models/QueryParameterV2.md | 1 - .../models/QueryTypeReferenceType.md | 14 - docs/v2/Ontologies/models/QueryTypeV2.md | 1 - docs/v2/Ontologies/models/RegexQuery.md | 21 +- .../v2/Ontologies/models/SearchJsonQueryV2.md | 1 - .../v2/Ontologies/models/SpatialFilterMode.md | 16 - docs/v2/Ontologies/models/SumAggregationV2.md | 5 +- .../models/SyncApplyActionResponseV2.md | 1 - .../models/TypeReferenceIdentifier.md | 13 - docs/v2/Orchestration/Build.md | 6 - docs/v2/Orchestration/Job.md | 6 - docs/v2/Orchestration/Schedule.md | 16 +- docs/v2/Orchestration/models/Build.md | 1 - .../models/ScheduleRunErrorName.md | 14 +- docs/v2/SqlQueries/SqlQuery.md | 75 +- docs/v2/SqlQueries/models/AnyColumnType.md | 11 - docs/v2/SqlQueries/models/ColumnType.md | 29 - .../v2/SqlQueries/models/DecimalColumnType.md | 13 - .../models/ExecuteOntologySqlQueryRequest.md | 14 - .../models/ExecuteSqlQueryRequest.md | 1 - docs/v2/SqlQueries/models/ListColumnType.md | 12 - docs/v2/SqlQueries/models/MapColumnType.md | 13 - docs/v2/SqlQueries/models/MapParameterKey.md | 11 - .../models/NamedParameterMapping.md | 12 - .../v2/SqlQueries/models/ParameterAnyValue.md | 12 - .../models/ParameterBooleanValue.md | 12 - .../SqlQueries/models/ParameterDateValue.md | 12 - .../models/ParameterDecimalValue.md | 12 - .../SqlQueries/models/ParameterDoubleValue.md | 12 - .../SqlQueries/models/ParameterFloatValue.md | 12 - .../models/ParameterIntegerValue.md | 12 - .../SqlQueries/models/ParameterListValue.md | 14 - .../SqlQueries/models/ParameterLongValue.md | 12 - .../v2/SqlQueries/models/ParameterMapValue.md | 12 - docs/v2/SqlQueries/models/ParameterMapping.md | 11 - docs/v2/SqlQueries/models/ParameterName.md | 11 - .../SqlQueries/models/ParameterNullValue.md | 11 - .../SqlQueries/models/ParameterShortValue.md | 12 - .../SqlQueries/models/ParameterStringValue.md | 12 - .../SqlQueries/models/ParameterStructValue.md | 13 - .../models/ParameterTimestampValue.md | 12 - docs/v2/SqlQueries/models/ParameterValue.md | 29 - docs/v2/SqlQueries/models/Parameters.md | 18 - .../SqlQueries/models/SerializationFormat.md | 12 - .../models/StructColumnFieldType.md | 12 - docs/v2/SqlQueries/models/StructColumnType.md | 12 - docs/v2/SqlQueries/models/StructElement.md | 12 - .../v2/SqlQueries/models/StructElementName.md | 16 - .../SqlQueries/models/StructFieldKeyValue.md | 12 - docs/v2/SqlQueries/models/StructFieldRid.md | 12 - .../models/UnnamedParameterValues.md | 12 - docs/v2/Streams/Stream.md | 30 +- docs/v2/Streams/Subscriber.md | 441 --- .../models/CommitSubscriberOffsetsRequest.md | 12 - .../Streams/models/CreateSubscriberRequest.md | 12 - docs/v2/Streams/models/EarliestPosition.md | 13 - docs/v2/Streams/models/LatestPosition.md | 14 - docs/v2/Streams/models/PartitionOffsets.md | 12 - docs/v2/Streams/models/PartitionRecords.md | 12 - docs/v2/Streams/models/ReadPosition.md | 25 - .../ReadRecordsFromSubscriberRequest.md | 14 - .../models/ReadSubscriberRecordsResponse.md | 12 - .../models/ResetSubscriberOffsetsRequest.md | 11 - docs/v2/Streams/models/SpecificPosition.md | 14 - docs/v2/Streams/models/StreamType.md | 2 +- docs/v2/Streams/models/Subscriber.md | 17 - docs/v2/Streams/models/SubscriberId.md | 12 - docs/v2/Widgets/DevModeSettings.md | 207 ++ docs/v2/Widgets/DevModeSettingsV2.md | 124 - docs/v2/Widgets/models/DevModeSettingsV2.md | 12 - docs/v2/Widgets/models/DevModeSnapshot.md | 14 - docs/v2/Widgets/models/DevModeSnapshotId.md | 11 - .../v2/Widgets/models/OntologySdkInputSpec.md | 12 - .../Widgets/models/OntologySdkPackageRid.md | 11 - docs/v2/Widgets/models/OntologySdkVersion.md | 11 - ... => SetWidgetSetDevModeSettingsRequest.md} | 6 +- .../Widgets/models/WidgetDevModeSettingsV2.md | 14 - .../models/WidgetSetDevModeSettingsV2.md | 13 - docs/v2/Widgets/models/WidgetSetInputSpec.md | 13 - foundry_sdk/_core/hostname_supplier.py | 2 +- foundry_sdk/_version.py | 2 +- foundry_sdk/v1/core/models.py | 14 - foundry_sdk/v1/ontologies/errors.py | 102 - foundry_sdk/v1/ontologies/models.py | 43 +- foundry_sdk/v2/admin/_client.py | 32 - foundry_sdk/v2/admin/cbac_banner.py | 227 -- .../v2/admin/cbac_marking_restrictions.py | 215 -- foundry_sdk/v2/admin/errors.py | 235 -- foundry_sdk/v2/admin/group.py | 250 -- foundry_sdk/v2/admin/group_member.py | 16 +- foundry_sdk/v2/admin/group_provider_info.py | 28 +- foundry_sdk/v2/admin/marking_category.py | 154 +- .../v2/admin/marking_role_assignment.py | 16 - foundry_sdk/v2/admin/models.py | 117 - foundry_sdk/v2/admin/organization.py | 66 +- .../v2/admin/organization_guest_member.py | 455 --- .../v2/admin/organization_role_assignment.py | 42 +- foundry_sdk/v2/admin/user.py | 34 +- foundry_sdk/v2/admin/user_provider_info.py | 28 +- foundry_sdk/v2/aip_agents/agent.py | 12 +- foundry_sdk/v2/aip_agents/agent_version.py | 20 +- foundry_sdk/v2/aip_agents/content.py | 4 +- foundry_sdk/v2/aip_agents/errors.py | 32 +- foundry_sdk/v2/aip_agents/models.py | 28 +- foundry_sdk/v2/aip_agents/session.py | 88 +- foundry_sdk/v2/aip_agents/session_trace.py | 4 +- foundry_sdk/v2/checkpoints/models.py | 36 +- foundry_sdk/v2/cli.py | 3047 +++-------------- foundry_sdk/v2/connectivity/connection.py | 79 +- foundry_sdk/v2/connectivity/file_import.py | 78 +- foundry_sdk/v2/connectivity/models.py | 9 +- foundry_sdk/v2/connectivity/table_import.py | 78 +- foundry_sdk/v2/connectivity/virtual_table.py | 14 +- foundry_sdk/v2/core/models.py | 22 - foundry_sdk/v2/datasets/dataset.py | 56 +- foundry_sdk/v2/datasets/errors.py | 22 - foundry_sdk/v2/datasets/file.py | 4 - foundry_sdk/v2/datasets/view.py | 78 +- foundry_sdk/v2/filesystem/errors.py | 113 - foundry_sdk/v2/filesystem/folder.py | 156 - foundry_sdk/v2/filesystem/models.py | 142 +- foundry_sdk/v2/filesystem/project.py | 33 - .../filesystem/project_resource_reference.py | 491 --- foundry_sdk/v2/functions/_client.py | 13 - foundry_sdk/v2/functions/errors.py | 244 +- foundry_sdk/v2/functions/execution.py | 351 -- foundry_sdk/v2/functions/models.py | 154 +- foundry_sdk/v2/functions/query.py | 359 +- .../v2/language_models/anthropic_model.py | 8 - foundry_sdk/v2/language_models/errors.py | 84 - foundry_sdk/v2/language_models/models.py | 35 - foundry_sdk/v2/media_sets/errors.py | 50 - foundry_sdk/v2/media_sets/media_set.py | 416 +-- foundry_sdk/v2/media_sets/models.py | 294 +- foundry_sdk/v2/models/_client.py | 41 - foundry_sdk/v2/models/errors.py | 696 ---- foundry_sdk/v2/models/experiment.py | 418 --- .../v2/models/experiment_artifact_table.py | 387 --- foundry_sdk/v2/models/experiment_series.py | 385 --- foundry_sdk/v2/models/live_deployment.py | 642 ---- foundry_sdk/v2/models/model.py | 169 - foundry_sdk/v2/models/model_function.py | 546 --- foundry_sdk/v2/models/model_studio.py | 490 --- .../v2/models/model_studio_config_version.py | 609 ---- foundry_sdk/v2/models/model_studio_run.py | 237 -- foundry_sdk/v2/models/model_studio_trainer.py | 307 -- foundry_sdk/v2/models/model_version.py | 44 +- foundry_sdk/v2/models/models.py | 1510 +------- foundry_sdk/v2/ontologies/action.py | 16 - foundry_sdk/v2/ontologies/action_type.py | 141 - foundry_sdk/v2/ontologies/errors.py | 102 - foundry_sdk/v2/ontologies/models.py | 372 +- foundry_sdk/v2/ontologies/object_type.py | 327 +- .../v2/ontologies/ontology_interface.py | 8 - .../v2/ontologies/ontology_object_set.py | 104 - foundry_sdk/v2/ontologies/query.py | 12 +- foundry_sdk/v2/ontologies/query_type.py | 8 - foundry_sdk/v2/orchestration/build.py | 12 - foundry_sdk/v2/orchestration/job.py | 12 - foundry_sdk/v2/orchestration/models.py | 17 +- foundry_sdk/v2/orchestration/schedule.py | 32 +- foundry_sdk/v2/sql_queries/errors.py | 61 +- foundry_sdk/v2/sql_queries/models.py | 325 -- foundry_sdk/v2/sql_queries/sql_query.py | 168 +- foundry_sdk/v2/streams/errors.py | 142 - foundry_sdk/v2/streams/models.py | 193 +- foundry_sdk/v2/streams/stream.py | 71 +- foundry_sdk/v2/streams/subscriber.py | 1007 ------ .../v2/third_party_applications/errors.py | 48 - foundry_sdk/v2/widgets/_client.py | 15 - foundry_sdk/v2/widgets/dev_mode_settings.py | 398 +++ .../v2/widgets/dev_mode_settings_v2.py | 379 -- foundry_sdk/v2/widgets/errors.py | 81 +- foundry_sdk/v2/widgets/models.py | 99 +- tests/test_resource_import.py | 102 - 534 files changed, 2505 insertions(+), 26584 deletions(-) delete mode 100644 docs/v1/Core/models/MediaReferenceType.md delete mode 100644 docs/v1/Core/models/VoidType.md delete mode 100644 docs/v1/Ontologies/models/QueryTypeReferenceType.md delete mode 100644 docs/v1/Ontologies/models/TypeReferenceIdentifier.md delete mode 100644 docs/v2/Admin/CbacBanner.md delete mode 100644 docs/v2/Admin/CbacMarkingRestrictions.md delete mode 100644 docs/v2/Admin/OrganizationGuestMember.md delete mode 100644 docs/v2/Admin/models/AddOrganizationGuestMembersRequest.md delete mode 100644 docs/v2/Admin/models/CbacBanner.md delete mode 100644 docs/v2/Admin/models/CbacBannerClassificationString.md delete mode 100644 docs/v2/Admin/models/CbacMarkingRestrictions.md delete mode 100644 docs/v2/Admin/models/CbacMarkingRestrictionsIsValid.md delete mode 100644 docs/v2/Admin/models/CbacMarkingRestrictionsUserSatisfiesMarkings.md delete mode 100644 docs/v2/Admin/models/ClassificationBannerDisplayType.md delete mode 100644 docs/v2/Admin/models/ListCurrentGroupsResponse.md delete mode 100644 docs/v2/Admin/models/ListOrganizationGuestMembersResponse.md delete mode 100644 docs/v2/Admin/models/OrganizationGuestMember.md delete mode 100644 docs/v2/Admin/models/RemoveOrganizationGuestMembersRequest.md delete mode 100644 docs/v2/Admin/models/ReplaceGroupRequest.md delete mode 100644 docs/v2/Admin/models/ReplaceMarkingCategoryRequest.md delete mode 100644 docs/v2/Checkpoints/models/CheckpointedPeeringJob.md delete mode 100644 docs/v2/Checkpoints/models/CheckpointedPeeringJobId.md rename docs/v2/{Core => Connectivity}/models/NetworkEgressPolicyRid.md (100%) delete mode 100644 docs/v2/Core/models/Color.md delete mode 100644 docs/v2/Core/models/ColumnName.md delete mode 100644 docs/v2/Core/models/VoidType.md delete mode 100644 docs/v2/Filesystem/ProjectResourceReference.md delete mode 100644 docs/v2/Filesystem/models/AddExternalResourceReferenceRequest.md delete mode 100644 docs/v2/Filesystem/models/AddFilesystemResourceReferenceRequest.md delete mode 100644 docs/v2/Filesystem/models/AddProjectResourceReferencesRequest.md delete mode 100644 docs/v2/Filesystem/models/AddResourceReferenceRequest.md delete mode 100644 docs/v2/Filesystem/models/ListProjectResourceReferencesResponse.md delete mode 100644 docs/v2/Filesystem/models/ProjectExternalResourceReference.md delete mode 100644 docs/v2/Filesystem/models/ProjectFilesystemResourceReference.md delete mode 100644 docs/v2/Filesystem/models/ProjectResourceLevelRoleGrantsAllowed.md delete mode 100644 docs/v2/Filesystem/models/ProjectResourceReference.md delete mode 100644 docs/v2/Filesystem/models/ProjectResourceReferenceType.md delete mode 100644 docs/v2/Filesystem/models/ProjectResourceReferenceUnion.md delete mode 100644 docs/v2/Filesystem/models/RemoveProjectResourceReferencesRequest.md delete mode 100644 docs/v2/Filesystem/models/ReplaceFolderRequest.md delete mode 100644 docs/v2/Functions/Execution.md delete mode 100644 docs/v2/Functions/models/CancelExecutionResponse.md delete mode 100644 docs/v2/Functions/models/ExecuteAsyncQueryRequest.md delete mode 100644 docs/v2/Functions/models/ExecuteQueryAsyncResponse.md delete mode 100644 docs/v2/Functions/models/ExecutionCompleted.md delete mode 100644 docs/v2/Functions/models/ExecutionId.md delete mode 100644 docs/v2/Functions/models/ExecutionSubmitted.md delete mode 100644 docs/v2/Functions/models/GetByRidQueriesBatchResponse.md rename docs/v2/Functions/models/{GetByRidQueriesBatchRequestElement.md => GetByRidQueriesRequest.md} (90%) delete mode 100644 docs/v2/Functions/models/GetExecutionResultResponse.md delete mode 100644 docs/v2/Functions/models/GetResultExecutionRequest.md delete mode 100644 docs/v2/Functions/models/QueryTypeReferenceType.md delete mode 100644 docs/v2/Functions/models/RunningExecution.md delete mode 100644 docs/v2/Functions/models/SucceededExecution.md delete mode 100644 docs/v2/Functions/models/TypeReferenceIdentifier.md delete mode 100644 docs/v2/LanguageModels/models/AnthropicEffort.md delete mode 100644 docs/v2/LanguageModels/models/AnthropicJsonSchemaOutputFormat.md delete mode 100644 docs/v2/LanguageModels/models/AnthropicOutputConfig.md delete mode 100644 docs/v2/LanguageModels/models/AnthropicOutputFormat.md delete mode 100644 docs/v2/MediaSets/models/ApiNameLocatorWrapper.md delete mode 100644 docs/v2/MediaSets/models/BatchTransactionsTransactionPolicy.md delete mode 100644 docs/v2/MediaSets/models/ChatLlmSpec.md delete mode 100644 docs/v2/MediaSets/models/ChatLlmSpecWrapper.md delete mode 100644 docs/v2/MediaSets/models/CropConfig.md delete mode 100644 docs/v2/MediaSets/models/ExtractDocumentLayoutAwareTextV2Config.md delete mode 100644 docs/v2/MediaSets/models/ExtractDocumentLayoutAwareTextV2Operation.md delete mode 100644 docs/v2/MediaSets/models/ExtractDocumentTextV2Config.md delete mode 100644 docs/v2/MediaSets/models/ExtractDocumentTextV2Operation.md delete mode 100644 docs/v2/MediaSets/models/ExtractTextPreprocessingWrapper.md delete mode 100644 docs/v2/MediaSets/models/ExtractVlmTextOperation.md delete mode 100644 docs/v2/MediaSets/models/GetMediaSetResponse.md delete mode 100644 docs/v2/MediaSets/models/ImageSpec.md delete mode 100644 docs/v2/MediaSets/models/LanguageModelLocator.md delete mode 100644 docs/v2/MediaSets/models/LayoutAwareExtractionPreprocessingConfig.md delete mode 100644 docs/v2/MediaSets/models/LayoutAwarePreprocessingWrapper.md delete mode 100644 docs/v2/MediaSets/models/LlmSpec.md delete mode 100644 docs/v2/MediaSets/models/MediaSchema.md delete mode 100644 docs/v2/MediaSets/models/Model3dDecodeFormat.md delete mode 100644 docs/v2/MediaSets/models/Model3dMediaItemMetadata.md delete mode 100644 docs/v2/MediaSets/models/NoTransactionsTransactionPolicy.md delete mode 100644 docs/v2/MediaSets/models/OcrMode.md delete mode 100644 docs/v2/MediaSets/models/PageRange.md delete mode 100644 docs/v2/MediaSets/models/RegisterMediaItemRequest.md delete mode 100644 docs/v2/MediaSets/models/RegisterMediaItemResponse.md delete mode 100644 docs/v2/MediaSets/models/ResizingMode.md delete mode 100644 docs/v2/MediaSets/models/TextOutputFormat.md delete mode 100644 docs/v2/MediaSets/models/TransactionPolicy.md delete mode 100644 docs/v2/MediaSets/models/VlmPreprocessingConfig.md delete mode 100644 docs/v2/Models/Experiment.md delete mode 100644 docs/v2/Models/ExperimentArtifactTable.md delete mode 100644 docs/v2/Models/ExperimentSeries.md delete mode 100644 docs/v2/Models/LiveDeployment.md delete mode 100644 docs/v2/Models/ModelFunction.md delete mode 100644 docs/v2/Models/ModelStudio.md delete mode 100644 docs/v2/Models/ModelStudioConfigVersion.md delete mode 100644 docs/v2/Models/ModelStudioRun.md delete mode 100644 docs/v2/Models/ModelStudioTrainer.md delete mode 100644 docs/v2/Models/models/BooleanParameter.md delete mode 100644 docs/v2/Models/models/ChangelogTooLongError.md delete mode 100644 docs/v2/Models/models/ColumnTypeSpecId.md delete mode 100644 docs/v2/Models/models/CreateConfigValidationFailureReason.md delete mode 100644 docs/v2/Models/models/CreateLiveDeploymentRequest.md delete mode 100644 docs/v2/Models/models/CreateLiveDeploymentTarget.md delete mode 100644 docs/v2/Models/models/CreateModelFunctionRequest.md delete mode 100644 docs/v2/Models/models/CreateModelStudioConfigVersionRequest.md delete mode 100644 docs/v2/Models/models/CreateModelStudioRequest.md delete mode 100644 docs/v2/Models/models/DatasetInput.md delete mode 100644 docs/v2/Models/models/DatasetSchemaNotFoundError.md delete mode 100644 docs/v2/Models/models/DatetimeParameter.md delete mode 100644 docs/v2/Models/models/DirectCreateLiveDeploymentTarget.md delete mode 100644 docs/v2/Models/models/DoubleParameter.md delete mode 100644 docs/v2/Models/models/DoubleSeriesAggregations.md delete mode 100644 docs/v2/Models/models/DoubleSeriesV1.md delete mode 100644 docs/v2/Models/models/DoubleSeriesValueV1.md delete mode 100644 docs/v2/Models/models/EpochMillis.md delete mode 100644 docs/v2/Models/models/Experiment.md delete mode 100644 docs/v2/Models/models/ExperimentArtifactDetails.md delete mode 100644 docs/v2/Models/models/ExperimentArtifactMetadata.md delete mode 100644 docs/v2/Models/models/ExperimentArtifactName.md delete mode 100644 docs/v2/Models/models/ExperimentAuthoringSource.md delete mode 100644 docs/v2/Models/models/ExperimentBranch.md delete mode 100644 docs/v2/Models/models/ExperimentCodeWorkspaceSource.md delete mode 100644 docs/v2/Models/models/ExperimentRid.md delete mode 100644 docs/v2/Models/models/ExperimentSdkSource.md delete mode 100644 docs/v2/Models/models/ExperimentSource.md delete mode 100644 docs/v2/Models/models/ExperimentStatus.md delete mode 100644 docs/v2/Models/models/ExperimentTagText.md delete mode 100644 docs/v2/Models/models/FieldValidationError.md delete mode 100644 docs/v2/Models/models/GpuType.md delete mode 100644 docs/v2/Models/models/InconsistentArrayDimensionsError.md delete mode 100644 docs/v2/Models/models/InferenceInputErrorType.md delete mode 100644 docs/v2/Models/models/InputAlias.md delete mode 100644 docs/v2/Models/models/IntegerParameter.md delete mode 100644 docs/v2/Models/models/InvalidArrayShapeError.md delete mode 100644 docs/v2/Models/models/InvalidMapFormatError.md delete mode 100644 docs/v2/Models/models/InvalidResourceConfigurationError.md delete mode 100644 docs/v2/Models/models/InvalidTabularFormatError.md delete mode 100644 docs/v2/Models/models/JsonSchemaValidationError.md delete mode 100644 docs/v2/Models/models/ListModelStudioConfigVersionsResponse.md delete mode 100644 docs/v2/Models/models/ListModelStudioRunsResponse.md delete mode 100644 docs/v2/Models/models/ListModelStudioTrainersResponse.md delete mode 100644 docs/v2/Models/models/LiveDeployment.md delete mode 100644 docs/v2/Models/models/LiveDeploymentGpu.md delete mode 100644 docs/v2/Models/models/LiveDeploymentModelVersion.md delete mode 100644 docs/v2/Models/models/LiveDeploymentRid.md delete mode 100644 docs/v2/Models/models/LiveDeploymentRuntimeConfiguration.md delete mode 100644 docs/v2/Models/models/LiveDeploymentScalingConfiguration.md delete mode 100644 docs/v2/Models/models/LiveDeploymentState.md delete mode 100644 docs/v2/Models/models/LiveDeploymentStatus.md delete mode 100644 docs/v2/Models/models/MissingRequiredDatasetColumnError.md delete mode 100644 docs/v2/Models/models/MissingWorkerConfigInputDatasetColumnMappingError.md delete mode 100644 docs/v2/Models/models/MissingWorkerConfigInputError.md delete mode 100644 docs/v2/Models/models/MissingWorkerConfigInputObjectSetPropertyMappingError.md delete mode 100644 docs/v2/Models/models/MissingWorkerConfigOutputError.md delete mode 100644 docs/v2/Models/models/ModelFunction.md delete mode 100644 docs/v2/Models/models/ModelFunctionApiName.md delete mode 100644 docs/v2/Models/models/ModelFunctionDisplayName.md delete mode 100644 docs/v2/Models/models/ModelFunctionFunctionRid.md delete mode 100644 docs/v2/Models/models/ModelFunctionFunctionVersion.md delete mode 100644 docs/v2/Models/models/ModelFunctionIsRowWise.md delete mode 100644 docs/v2/Models/models/ModelOutput.md delete mode 100644 docs/v2/Models/models/ModelStudio.md delete mode 100644 docs/v2/Models/models/ModelStudioConfigVersion.md delete mode 100644 docs/v2/Models/models/ModelStudioConfigVersionName.md delete mode 100644 docs/v2/Models/models/ModelStudioConfigVersionNumber.md delete mode 100644 docs/v2/Models/models/ModelStudioInput.md delete mode 100644 docs/v2/Models/models/ModelStudioOutput.md delete mode 100644 docs/v2/Models/models/ModelStudioRid.md delete mode 100644 docs/v2/Models/models/ModelStudioRun.md delete mode 100644 docs/v2/Models/models/ModelStudioRunBuildRid.md delete mode 100644 docs/v2/Models/models/ModelStudioRunJobRid.md delete mode 100644 docs/v2/Models/models/ModelStudioRunModelOutput.md delete mode 100644 docs/v2/Models/models/ModelStudioRunOutput.md delete mode 100644 docs/v2/Models/models/ModelStudioTrainer.md delete mode 100644 docs/v2/Models/models/ModelStudioTrainerExperimental.md delete mode 100644 docs/v2/Models/models/ModelStudioWorkerConfig.md delete mode 100644 docs/v2/Models/models/ModelVersionCodeRepositorySource.md delete mode 100644 docs/v2/Models/models/ModelVersionCodeWorkspaceSource.md delete mode 100644 docs/v2/Models/models/ModelVersionContainerizedSource.md delete mode 100644 docs/v2/Models/models/ModelVersionExternalSource.md delete mode 100644 docs/v2/Models/models/ModelVersionModelStudioSource.md delete mode 100644 docs/v2/Models/models/ModelVersionPromotedSource.md delete mode 100644 docs/v2/Models/models/ModelVersionSdkSource.md delete mode 100644 docs/v2/Models/models/ModelVersionSource.md delete mode 100644 docs/v2/Models/models/MultipleColumnsNotAllowedForTrainerError.md delete mode 100644 docs/v2/Models/models/MultiplePropertiesNotAllowedForTrainerError.md delete mode 100644 docs/v2/Models/models/OtherValidationError.md delete mode 100644 docs/v2/Models/models/OutputAlias.md delete mode 100644 docs/v2/Models/models/OutputResourceInDifferentProjectError.md delete mode 100644 docs/v2/Models/models/OutputResourceNotFoundError.md delete mode 100644 docs/v2/Models/models/Parameter.md delete mode 100644 docs/v2/Models/models/ParameterName.md delete mode 100644 docs/v2/Models/models/ParameterValue.md delete mode 100644 docs/v2/Models/models/PromoteVersionModelRequest.md delete mode 100644 docs/v2/Models/models/ReplaceLiveDeploymentRequest.md delete mode 100644 docs/v2/Models/models/ReplaceModelFunctionRequest.md delete mode 100644 docs/v2/Models/models/RequiredValueMissingError.md delete mode 100644 docs/v2/Models/models/ResourceConfiguration.md delete mode 100644 docs/v2/Models/models/RunId.md delete mode 100644 docs/v2/Models/models/SearchExperimentsAndFilter.md delete mode 100644 docs/v2/Models/models/SearchExperimentsContainsFilter.md delete mode 100644 docs/v2/Models/models/SearchExperimentsContainsFilterField.md delete mode 100644 docs/v2/Models/models/SearchExperimentsEqualsFilter.md delete mode 100644 docs/v2/Models/models/SearchExperimentsEqualsFilterField.md delete mode 100644 docs/v2/Models/models/SearchExperimentsFilter.md delete mode 100644 docs/v2/Models/models/SearchExperimentsNotFilter.md delete mode 100644 docs/v2/Models/models/SearchExperimentsNumericFilterOperator.md delete mode 100644 docs/v2/Models/models/SearchExperimentsOrFilter.md delete mode 100644 docs/v2/Models/models/SearchExperimentsOrderBy.md delete mode 100644 docs/v2/Models/models/SearchExperimentsOrderByField.md delete mode 100644 docs/v2/Models/models/SearchExperimentsParameterFilter.md delete mode 100644 docs/v2/Models/models/SearchExperimentsParameterFilterOperator.md delete mode 100644 docs/v2/Models/models/SearchExperimentsRequest.md delete mode 100644 docs/v2/Models/models/SearchExperimentsResponse.md delete mode 100644 docs/v2/Models/models/SearchExperimentsSeriesFilter.md delete mode 100644 docs/v2/Models/models/SearchExperimentsSeriesFilterField.md delete mode 100644 docs/v2/Models/models/SearchExperimentsStartsWithFilter.md delete mode 100644 docs/v2/Models/models/SearchExperimentsStartsWithFilterField.md delete mode 100644 docs/v2/Models/models/SearchExperimentsSummaryMetricFilter.md delete mode 100644 docs/v2/Models/models/Series.md delete mode 100644 docs/v2/Models/models/SeriesAggregations.md delete mode 100644 docs/v2/Models/models/SeriesAggregationsValue.md delete mode 100644 docs/v2/Models/models/SeriesName.md delete mode 100644 docs/v2/Models/models/StringParameter.md delete mode 100644 docs/v2/Models/models/SummaryMetric.md delete mode 100644 docs/v2/Models/models/SummaryMetricAggregation.md delete mode 100644 docs/v2/Models/models/TableArtifactDetails.md delete mode 100644 docs/v2/Models/models/TrainerDescription.md delete mode 100644 docs/v2/Models/models/TrainerId.md delete mode 100644 docs/v2/Models/models/TrainerInputsSpecification.md delete mode 100644 docs/v2/Models/models/TrainerName.md delete mode 100644 docs/v2/Models/models/TrainerOutputsSpecification.md delete mode 100644 docs/v2/Models/models/TrainerSchemaDefinition.md delete mode 100644 docs/v2/Models/models/TrainerType.md delete mode 100644 docs/v2/Models/models/TrainerVersion.md delete mode 100644 docs/v2/Models/models/TrainerVersionLocator.md delete mode 100644 docs/v2/Models/models/TransformJsonLiveDeploymentRequest.md delete mode 100644 docs/v2/Models/models/TransformLiveDeploymentResponse.md delete mode 100644 docs/v2/Models/models/TypeMismatchError.md delete mode 100644 docs/v2/Models/models/UnknownColumnSpecIdInConfigColumnMappingError.md delete mode 100644 docs/v2/Models/models/UnknownInputNameError.md delete mode 100644 docs/v2/Models/models/UnsupportedTypeError.md rename docs/v2/{MediaSets/models/Model3dType.md => Ontologies/models/EditTypeFilter.md} (69%) delete mode 100644 docs/v2/Ontologies/models/EditsHistoryFilter.md rename docs/v2/Ontologies/models/{EditsHistoryTimestampFilter.md => EditsHistoryFilters.md} (54%) delete mode 100644 docs/v2/Ontologies/models/EditsHistoryOperationIdsFilter.md delete mode 100644 docs/v2/Ontologies/models/FuzzyRule.md delete mode 100644 docs/v2/Ontologies/models/GeoJsonString.md delete mode 100644 docs/v2/Ontologies/models/GeoShapeV2Geometry.md delete mode 100644 docs/v2/Ontologies/models/GeoShapeV2Query.md delete mode 100644 docs/v2/Ontologies/models/GetActionTypeByRidBatchRequest.md delete mode 100644 docs/v2/Ontologies/models/GetActionTypeByRidBatchRequestElement.md delete mode 100644 docs/v2/Ontologies/models/GetActionTypeByRidBatchResponse.md delete mode 100644 docs/v2/Ontologies/models/GetObjectTypeByRidBatchRequest.md delete mode 100644 docs/v2/Ontologies/models/GetObjectTypeByRidBatchRequestElement.md delete mode 100644 docs/v2/Ontologies/models/GetObjectTypeByRidBatchResponse.md delete mode 100644 docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchRequest.md delete mode 100644 docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement.md delete mode 100644 docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchResponse.md delete mode 100644 docs/v2/Ontologies/models/QueryTypeReferenceType.md delete mode 100644 docs/v2/Ontologies/models/SpatialFilterMode.md delete mode 100644 docs/v2/Ontologies/models/TypeReferenceIdentifier.md delete mode 100644 docs/v2/SqlQueries/models/AnyColumnType.md delete mode 100644 docs/v2/SqlQueries/models/ColumnType.md delete mode 100644 docs/v2/SqlQueries/models/DecimalColumnType.md delete mode 100644 docs/v2/SqlQueries/models/ExecuteOntologySqlQueryRequest.md delete mode 100644 docs/v2/SqlQueries/models/ListColumnType.md delete mode 100644 docs/v2/SqlQueries/models/MapColumnType.md delete mode 100644 docs/v2/SqlQueries/models/MapParameterKey.md delete mode 100644 docs/v2/SqlQueries/models/NamedParameterMapping.md delete mode 100644 docs/v2/SqlQueries/models/ParameterAnyValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterBooleanValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterDateValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterDecimalValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterDoubleValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterFloatValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterIntegerValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterListValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterLongValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterMapValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterMapping.md delete mode 100644 docs/v2/SqlQueries/models/ParameterName.md delete mode 100644 docs/v2/SqlQueries/models/ParameterNullValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterShortValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterStringValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterStructValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterTimestampValue.md delete mode 100644 docs/v2/SqlQueries/models/ParameterValue.md delete mode 100644 docs/v2/SqlQueries/models/Parameters.md delete mode 100644 docs/v2/SqlQueries/models/SerializationFormat.md delete mode 100644 docs/v2/SqlQueries/models/StructColumnFieldType.md delete mode 100644 docs/v2/SqlQueries/models/StructColumnType.md delete mode 100644 docs/v2/SqlQueries/models/StructElement.md delete mode 100644 docs/v2/SqlQueries/models/StructElementName.md delete mode 100644 docs/v2/SqlQueries/models/StructFieldKeyValue.md delete mode 100644 docs/v2/SqlQueries/models/StructFieldRid.md delete mode 100644 docs/v2/SqlQueries/models/UnnamedParameterValues.md delete mode 100644 docs/v2/Streams/Subscriber.md delete mode 100644 docs/v2/Streams/models/CommitSubscriberOffsetsRequest.md delete mode 100644 docs/v2/Streams/models/CreateSubscriberRequest.md delete mode 100644 docs/v2/Streams/models/EarliestPosition.md delete mode 100644 docs/v2/Streams/models/LatestPosition.md delete mode 100644 docs/v2/Streams/models/PartitionOffsets.md delete mode 100644 docs/v2/Streams/models/PartitionRecords.md delete mode 100644 docs/v2/Streams/models/ReadPosition.md delete mode 100644 docs/v2/Streams/models/ReadRecordsFromSubscriberRequest.md delete mode 100644 docs/v2/Streams/models/ReadSubscriberRecordsResponse.md delete mode 100644 docs/v2/Streams/models/ResetSubscriberOffsetsRequest.md delete mode 100644 docs/v2/Streams/models/SpecificPosition.md delete mode 100644 docs/v2/Streams/models/Subscriber.md delete mode 100644 docs/v2/Streams/models/SubscriberId.md delete mode 100644 docs/v2/Widgets/DevModeSettingsV2.md delete mode 100644 docs/v2/Widgets/models/DevModeSettingsV2.md delete mode 100644 docs/v2/Widgets/models/DevModeSnapshot.md delete mode 100644 docs/v2/Widgets/models/DevModeSnapshotId.md delete mode 100644 docs/v2/Widgets/models/OntologySdkInputSpec.md delete mode 100644 docs/v2/Widgets/models/OntologySdkPackageRid.md delete mode 100644 docs/v2/Widgets/models/OntologySdkVersion.md rename docs/v2/Widgets/models/{SetWidgetSetManifestDevModeSettingsV2Request.md => SetWidgetSetDevModeSettingsRequest.md} (72%) delete mode 100644 docs/v2/Widgets/models/WidgetDevModeSettingsV2.md delete mode 100644 docs/v2/Widgets/models/WidgetSetDevModeSettingsV2.md delete mode 100644 docs/v2/Widgets/models/WidgetSetInputSpec.md delete mode 100644 foundry_sdk/v2/admin/cbac_banner.py delete mode 100644 foundry_sdk/v2/admin/cbac_marking_restrictions.py delete mode 100644 foundry_sdk/v2/admin/organization_guest_member.py delete mode 100644 foundry_sdk/v2/filesystem/project_resource_reference.py delete mode 100644 foundry_sdk/v2/functions/execution.py delete mode 100644 foundry_sdk/v2/models/experiment.py delete mode 100644 foundry_sdk/v2/models/experiment_artifact_table.py delete mode 100644 foundry_sdk/v2/models/experiment_series.py delete mode 100644 foundry_sdk/v2/models/live_deployment.py delete mode 100644 foundry_sdk/v2/models/model_function.py delete mode 100644 foundry_sdk/v2/models/model_studio.py delete mode 100644 foundry_sdk/v2/models/model_studio_config_version.py delete mode 100644 foundry_sdk/v2/models/model_studio_run.py delete mode 100644 foundry_sdk/v2/models/model_studio_trainer.py delete mode 100644 foundry_sdk/v2/streams/subscriber.py delete mode 100644 foundry_sdk/v2/widgets/dev_mode_settings_v2.py diff --git a/README.md b/README.md index d04865f85..8229b4c9b 100644 --- a/README.md +++ b/README.md @@ -665,20 +665,11 @@ Namespace | Resource | Operation | HTTP request | **Admin** | AuthenticationProvider | [**list**](docs/v2/Admin/AuthenticationProvider.md#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/authenticationProviders | **Admin** | AuthenticationProvider | [**preregister_group**](docs/v2/Admin/AuthenticationProvider.md#preregister_group) | **POST** /v2/admin/enrollments/{enrollmentRid}/authenticationProviders/{authenticationProviderRid}/preregisterGroup | **Admin** | AuthenticationProvider | [**preregister_user**](docs/v2/Admin/AuthenticationProvider.md#preregister_user) | **POST** /v2/admin/enrollments/{enrollmentRid}/authenticationProviders/{authenticationProviderRid}/preregisterUser | -**Admin** | CbacBanner | [**get**](docs/v2/Admin/CbacBanner.md#get) | **GET** /v2/admin/cbacBanner | -**Admin** | CbacMarkingRestrictions | [**get**](docs/v2/Admin/CbacMarkingRestrictions.md#get) | **GET** /v2/admin/cbacMarkingRestrictions | -**Admin** | Enrollment | [**get**](docs/v2/Admin/Enrollment.md#get) | **GET** /v2/admin/enrollments/{enrollmentRid} | -**Admin** | Enrollment | [**get_current**](docs/v2/Admin/Enrollment.md#get_current) | **GET** /v2/admin/enrollments/getCurrent | -**Admin** | EnrollmentRoleAssignment | [**add**](docs/v2/Admin/EnrollmentRoleAssignment.md#add) | **POST** /v2/admin/enrollments/{enrollmentRid}/roleAssignments/add | -**Admin** | EnrollmentRoleAssignment | [**list**](docs/v2/Admin/EnrollmentRoleAssignment.md#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/roleAssignments | -**Admin** | EnrollmentRoleAssignment | [**remove**](docs/v2/Admin/EnrollmentRoleAssignment.md#remove) | **POST** /v2/admin/enrollments/{enrollmentRid}/roleAssignments/remove | **Admin** | Group | [**create**](docs/v2/Admin/Group.md#create) | **POST** /v2/admin/groups | **Admin** | Group | [**delete**](docs/v2/Admin/Group.md#delete) | **DELETE** /v2/admin/groups/{groupId} | **Admin** | Group | [**get**](docs/v2/Admin/Group.md#get) | **GET** /v2/admin/groups/{groupId} | **Admin** | Group | [**get_batch**](docs/v2/Admin/Group.md#get_batch) | **POST** /v2/admin/groups/getBatch | **Admin** | Group | [**list**](docs/v2/Admin/Group.md#list) | **GET** /v2/admin/groups | -**Admin** | Group | [**list_current**](docs/v2/Admin/Group.md#list_current) | **GET** /v2/admin/groups/listCurrent | -**Admin** | Group | [**replace**](docs/v2/Admin/Group.md#replace) | **PUT** /v2/admin/groups/{groupId} | **Admin** | Group | [**search**](docs/v2/Admin/Group.md#search) | **POST** /v2/admin/groups/search | **Admin** | GroupMember | [**add**](docs/v2/Admin/GroupMember.md#add) | **POST** /v2/admin/groups/{groupId}/groupMembers/add | **Admin** | GroupMember | [**list**](docs/v2/Admin/GroupMember.md#list) | **GET** /v2/admin/groups/{groupId}/groupMembers | @@ -688,23 +679,19 @@ Namespace | Resource | Operation | HTTP request | **Admin** | GroupMembershipExpirationPolicy | [**replace**](docs/v2/Admin/GroupMembershipExpirationPolicy.md#replace) | **PUT** /v2/admin/groups/{groupId}/membershipExpirationPolicy | **Admin** | GroupProviderInfo | [**get**](docs/v2/Admin/GroupProviderInfo.md#get) | **GET** /v2/admin/groups/{groupId}/providerInfo | **Admin** | GroupProviderInfo | [**replace**](docs/v2/Admin/GroupProviderInfo.md#replace) | **PUT** /v2/admin/groups/{groupId}/providerInfo | -**Admin** | Host | [**list**](docs/v2/Admin/Host.md#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/hosts | **Admin** | Marking | [**create**](docs/v2/Admin/Marking.md#create) | **POST** /v2/admin/markings | **Admin** | Marking | [**get**](docs/v2/Admin/Marking.md#get) | **GET** /v2/admin/markings/{markingId} | **Admin** | Marking | [**get_batch**](docs/v2/Admin/Marking.md#get_batch) | **POST** /v2/admin/markings/getBatch | **Admin** | Marking | [**list**](docs/v2/Admin/Marking.md#list) | **GET** /v2/admin/markings | **Admin** | Marking | [**replace**](docs/v2/Admin/Marking.md#replace) | **PUT** /v2/admin/markings/{markingId} | -**Admin** | MarkingCategory | [**create**](docs/v2/Admin/MarkingCategory.md#create) | **POST** /v2/admin/markingCategories | **Admin** | MarkingCategory | [**get**](docs/v2/Admin/MarkingCategory.md#get) | **GET** /v2/admin/markingCategories/{markingCategoryId} | **Admin** | MarkingCategory | [**list**](docs/v2/Admin/MarkingCategory.md#list) | **GET** /v2/admin/markingCategories | -**Admin** | MarkingCategory | [**replace**](docs/v2/Admin/MarkingCategory.md#replace) | **PUT** /v2/admin/markingCategories/{markingCategoryId} | **Admin** | MarkingMember | [**add**](docs/v2/Admin/MarkingMember.md#add) | **POST** /v2/admin/markings/{markingId}/markingMembers/add | **Admin** | MarkingMember | [**list**](docs/v2/Admin/MarkingMember.md#list) | **GET** /v2/admin/markings/{markingId}/markingMembers | **Admin** | MarkingMember | [**remove**](docs/v2/Admin/MarkingMember.md#remove) | **POST** /v2/admin/markings/{markingId}/markingMembers/remove | **Admin** | MarkingRoleAssignment | [**add**](docs/v2/Admin/MarkingRoleAssignment.md#add) | **POST** /v2/admin/markings/{markingId}/roleAssignments/add | **Admin** | MarkingRoleAssignment | [**list**](docs/v2/Admin/MarkingRoleAssignment.md#list) | **GET** /v2/admin/markings/{markingId}/roleAssignments | **Admin** | MarkingRoleAssignment | [**remove**](docs/v2/Admin/MarkingRoleAssignment.md#remove) | **POST** /v2/admin/markings/{markingId}/roleAssignments/remove | -**Admin** | Organization | [**create**](docs/v2/Admin/Organization.md#create) | **POST** /v2/admin/organizations | **Admin** | Organization | [**get**](docs/v2/Admin/Organization.md#get) | **GET** /v2/admin/organizations/{organizationRid} | **Admin** | Organization | [**list_available_roles**](docs/v2/Admin/Organization.md#list_available_roles) | **GET** /v2/admin/organizations/{organizationRid}/listAvailableRoles | **Admin** | Organization | [**replace**](docs/v2/Admin/Organization.md#replace) | **PUT** /v2/admin/organizations/{organizationRid} | @@ -739,9 +726,6 @@ Namespace | Resource | Operation | HTTP request | **AipAgents** | SessionTrace | [**get**](docs/v2/AipAgents/SessionTrace.md#get) | **GET** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/sessionTraces/{sessionTraceId} | **Audit** | LogFile | [**content**](docs/v2/Audit/LogFile.md#content) | **GET** /v2/audit/organizations/{organizationRid}/logFiles/{logFileId}/content | **Audit** | LogFile | [**list**](docs/v2/Audit/LogFile.md#list) | **GET** /v2/audit/organizations/{organizationRid}/logFiles | -**Checkpoints** | Record | [**get**](docs/v2/Checkpoints/Record.md#get) | **GET** /v2/checkpoints/records/{recordRid} | -**Checkpoints** | Record | [**get_batch**](docs/v2/Checkpoints/Record.md#get_batch) | **POST** /v2/checkpoints/records/getBatch | -**Checkpoints** | Record | [**search**](docs/v2/Checkpoints/Record.md#search) | **POST** /v2/checkpoints/records/search | **Connectivity** | Connection | [**create**](docs/v2/Connectivity/Connection.md#create) | **POST** /v2/connectivity/connections | **Connectivity** | Connection | [**get**](docs/v2/Connectivity/Connection.md#get) | **GET** /v2/connectivity/connections/{connectionRid} | **Connectivity** | Connection | [**get_configuration**](docs/v2/Connectivity/Connection.md#get_configuration) | **GET** /v2/connectivity/connections/{connectionRid}/getConfiguration | @@ -809,9 +793,6 @@ Namespace | Resource | Operation | HTTP request | **Filesystem** | Project | [**get**](docs/v2/Filesystem/Project.md#get) | **GET** /v2/filesystem/projects/{projectRid} | **Filesystem** | Project | [**organizations**](docs/v2/Filesystem/Project.md#organizations) | **GET** /v2/filesystem/projects/{projectRid}/organizations | **Filesystem** | Project | [**remove_organizations**](docs/v2/Filesystem/Project.md#remove_organizations) | **POST** /v2/filesystem/projects/{projectRid}/removeOrganizations | -**Filesystem** | ProjectResourceReference | [**add**](docs/v2/Filesystem/ProjectResourceReference.md#add) | **POST** /v2/filesystem/projects/{projectRid}/references/add | -**Filesystem** | ProjectResourceReference | [**list**](docs/v2/Filesystem/ProjectResourceReference.md#list) | **GET** /v2/filesystem/projects/{projectRid}/references | -**Filesystem** | ProjectResourceReference | [**remove**](docs/v2/Filesystem/ProjectResourceReference.md#remove) | **POST** /v2/filesystem/projects/{projectRid}/references/remove | **Filesystem** | Resource | [**add_markings**](docs/v2/Filesystem/Resource.md#add_markings) | **POST** /v2/filesystem/resources/{resourceRid}/addMarkings | **Filesystem** | Resource | [**delete**](docs/v2/Filesystem/Resource.md#delete) | **DELETE** /v2/filesystem/resources/{resourceRid} | **Filesystem** | Resource | [**get**](docs/v2/Filesystem/Resource.md#get) | **GET** /v2/filesystem/resources/{resourceRid} | @@ -828,10 +809,8 @@ Namespace | Resource | Operation | HTTP request | **Filesystem** | ResourceRole | [**remove**](docs/v2/Filesystem/ResourceRole.md#remove) | **POST** /v2/filesystem/resources/{resourceRid}/roles/remove | **Filesystem** | Space | [**list**](docs/v2/Filesystem/Space.md#list) | **GET** /v2/filesystem/spaces | **MediaSets** | MediaSet | [**abort**](docs/v2/MediaSets/MediaSet.md#abort) | **POST** /v2/mediasets/{mediaSetRid}/transactions/{transactionId}/abort | -**MediaSets** | MediaSet | [**clear**](docs/v2/MediaSets/MediaSet.md#clear) | **DELETE** /v2/mediasets/{mediaSetRid}/items/clearAtPath | **MediaSets** | MediaSet | [**commit**](docs/v2/MediaSets/MediaSet.md#commit) | **POST** /v2/mediasets/{mediaSetRid}/transactions/{transactionId}/commit | **MediaSets** | MediaSet | [**create**](docs/v2/MediaSets/MediaSet.md#create) | **POST** /v2/mediasets/{mediaSetRid}/transactions | -**MediaSets** | MediaSet | [**get**](docs/v2/MediaSets/MediaSet.md#get) | **GET** /v2/mediasets/{mediaSetRid} | **MediaSets** | MediaSet | [**get_result**](docs/v2/MediaSets/MediaSet.md#get_result) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transformationJobs/{transformationJobId}/result | **MediaSets** | MediaSet | [**get_rid_by_path**](docs/v2/MediaSets/MediaSet.md#get_rid_by_path) | **GET** /v2/mediasets/{mediaSetRid}/items/getRidByPath | **MediaSets** | MediaSet | [**get_status**](docs/v2/MediaSets/MediaSet.md#get_status) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transformationJobs/{transformationJobId} | @@ -840,21 +819,13 @@ Namespace | Resource | Operation | HTTP request | **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 | -**MediaSets** | MediaSet | [**register**](docs/v2/MediaSets/MediaSet.md#register) | **POST** /v2/mediasets/{mediaSetRid}/items/register | **MediaSets** | MediaSet | [**transform**](docs/v2/MediaSets/MediaSet.md#transform) | **POST** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transform | **MediaSets** | MediaSet | [**upload**](docs/v2/MediaSets/MediaSet.md#upload) | **POST** /v2/mediasets/{mediaSetRid}/items | **MediaSets** | MediaSet | [**upload_media**](docs/v2/MediaSets/MediaSet.md#upload_media) | **PUT** /v2/mediasets/media/upload | -**Models** | LiveDeployment | [**transform_json**](docs/v2/Models/LiveDeployment.md#transform_json) | **POST** /v2/models/liveDeployments/{liveDeploymentRid}/transformJson | -**Models** | Model | [**create**](docs/v2/Models/Model.md#create) | **POST** /v2/models | -**Models** | Model | [**get**](docs/v2/Models/Model.md#get) | **GET** /v2/models/{modelRid} | -**Models** | Model | [**promote_version**](docs/v2/Models/Model.md#promote_version) | **POST** /v2/models/{modelRid}/promoteVersion | -**Models** | ModelVersion | [**get**](docs/v2/Models/ModelVersion.md#get) | **GET** /v2/models/{modelRid}/versions/{modelVersionRid} | -**Models** | ModelVersion | [**list**](docs/v2/Models/ModelVersion.md#list) | **GET** /v2/models/{modelRid}/versions | **Ontologies** | Action | [**apply**](docs/v2/Ontologies/Action.md#apply) | **POST** /v2/ontologies/{ontology}/actions/{action}/apply | **Ontologies** | Action | [**apply_batch**](docs/v2/Ontologies/Action.md#apply_batch) | **POST** /v2/ontologies/{ontology}/actions/{action}/applyBatch | **Ontologies** | ActionType | [**get**](docs/v2/Ontologies/ActionType.md#get) | **GET** /v2/ontologies/{ontology}/actionTypes/{actionType} | **Ontologies** | ActionType | [**get_by_rid**](docs/v2/Ontologies/ActionType.md#get_by_rid) | **GET** /v2/ontologies/{ontology}/actionTypes/byRid/{actionTypeRid} | -**Ontologies** | ActionType | [**get_by_rid_batch**](docs/v2/Ontologies/ActionType.md#get_by_rid_batch) | **POST** /v2/ontologies/{ontology}/actionTypes/getByRidBatch | **Ontologies** | ActionType | [**list**](docs/v2/Ontologies/ActionType.md#list) | **GET** /v2/ontologies/{ontology}/actionTypes | **Ontologies** | Attachment | [**get**](docs/v2/Ontologies/Attachment.md#get) | **GET** /v2/ontologies/attachments/{attachmentRid} | **Ontologies** | Attachment | [**read**](docs/v2/Ontologies/Attachment.md#read) | **GET** /v2/ontologies/attachments/{attachmentRid}/content | @@ -869,11 +840,8 @@ Namespace | Resource | Operation | HTTP request | **Ontologies** | MediaReferenceProperty | [**get_media_content**](docs/v2/Ontologies/MediaReferenceProperty.md#get_media_content) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/media/{property}/content | **Ontologies** | MediaReferenceProperty | [**upload**](docs/v2/Ontologies/MediaReferenceProperty.md#upload) | **POST** /v2/ontologies/{ontology}/objectTypes/{objectType}/media/{property}/upload | **Ontologies** | ObjectType | [**get**](docs/v2/Ontologies/ObjectType.md#get) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType} | -**Ontologies** | ObjectType | [**get_by_rid_batch**](docs/v2/Ontologies/ObjectType.md#get_by_rid_batch) | **POST** /v2/ontologies/{ontology}/objectTypes/getByRidBatch | -**Ontologies** | ObjectType | [**get_edits_history**](docs/v2/Ontologies/ObjectType.md#get_edits_history) | **POST** /v2/ontologies/{ontology}/objectTypes/{objectType}/editsHistory | **Ontologies** | ObjectType | [**get_full_metadata**](docs/v2/Ontologies/ObjectType.md#get_full_metadata) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/fullMetadata | **Ontologies** | ObjectType | [**get_outgoing_link_type**](docs/v2/Ontologies/ObjectType.md#get_outgoing_link_type) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} | -**Ontologies** | ObjectType | [**get_outgoing_link_types_by_object_type_rid_batch**](docs/v2/Ontologies/ObjectType.md#get_outgoing_link_types_by_object_type_rid_batch) | **POST** /v2/ontologies/{ontology}/outgoingLinkTypes/getByRidBatch | **Ontologies** | ObjectType | [**list**](docs/v2/Ontologies/ObjectType.md#list) | **GET** /v2/ontologies/{ontology}/objectTypes | **Ontologies** | ObjectType | [**list_outgoing_link_types**](docs/v2/Ontologies/ObjectType.md#list_outgoing_link_types) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes | **Ontologies** | Ontology | [**get**](docs/v2/Ontologies/Ontology.md#get) | **GET** /v2/ontologies/{ontology} | @@ -995,7 +963,6 @@ Namespace | Name | Import | **Admin** | [AddGroupMembersRequest](docs/v2/Admin/models/AddGroupMembersRequest.md) | `from foundry_sdk.v2.admin.models import AddGroupMembersRequest` | **Admin** | [AddMarkingMembersRequest](docs/v2/Admin/models/AddMarkingMembersRequest.md) | `from foundry_sdk.v2.admin.models import AddMarkingMembersRequest` | **Admin** | [AddMarkingRoleAssignmentsRequest](docs/v2/Admin/models/AddMarkingRoleAssignmentsRequest.md) | `from foundry_sdk.v2.admin.models import AddMarkingRoleAssignmentsRequest` | -**Admin** | [AddOrganizationGuestMembersRequest](docs/v2/Admin/models/AddOrganizationGuestMembersRequest.md) | `from foundry_sdk.v2.admin.models import AddOrganizationGuestMembersRequest` | **Admin** | [AddOrganizationRoleAssignmentsRequest](docs/v2/Admin/models/AddOrganizationRoleAssignmentsRequest.md) | `from foundry_sdk.v2.admin.models import AddOrganizationRoleAssignmentsRequest` | **Admin** | [AttributeName](docs/v2/Admin/models/AttributeName.md) | `from foundry_sdk.v2.admin.models import AttributeName` | **Admin** | [AttributeValue](docs/v2/Admin/models/AttributeValue.md) | `from foundry_sdk.v2.admin.models import AttributeValue` | @@ -1005,14 +972,8 @@ Namespace | Name | Import | **Admin** | [AuthenticationProviderEnabled](docs/v2/Admin/models/AuthenticationProviderEnabled.md) | `from foundry_sdk.v2.admin.models import AuthenticationProviderEnabled` | **Admin** | [AuthenticationProviderName](docs/v2/Admin/models/AuthenticationProviderName.md) | `from foundry_sdk.v2.admin.models import AuthenticationProviderName` | **Admin** | [AuthenticationProviderRid](docs/v2/Admin/models/AuthenticationProviderRid.md) | `from foundry_sdk.v2.admin.models import AuthenticationProviderRid` | -**Admin** | [CbacBanner](docs/v2/Admin/models/CbacBanner.md) | `from foundry_sdk.v2.admin.models import CbacBanner` | -**Admin** | [CbacBannerClassificationString](docs/v2/Admin/models/CbacBannerClassificationString.md) | `from foundry_sdk.v2.admin.models import CbacBannerClassificationString` | -**Admin** | [CbacMarkingRestrictions](docs/v2/Admin/models/CbacMarkingRestrictions.md) | `from foundry_sdk.v2.admin.models import CbacMarkingRestrictions` | -**Admin** | [CbacMarkingRestrictionsIsValid](docs/v2/Admin/models/CbacMarkingRestrictionsIsValid.md) | `from foundry_sdk.v2.admin.models import CbacMarkingRestrictionsIsValid` | -**Admin** | [CbacMarkingRestrictionsUserSatisfiesMarkings](docs/v2/Admin/models/CbacMarkingRestrictionsUserSatisfiesMarkings.md) | `from foundry_sdk.v2.admin.models import CbacMarkingRestrictionsUserSatisfiesMarkings` | **Admin** | [CertificateInfo](docs/v2/Admin/models/CertificateInfo.md) | `from foundry_sdk.v2.admin.models import CertificateInfo` | **Admin** | [CertificateUsageType](docs/v2/Admin/models/CertificateUsageType.md) | `from foundry_sdk.v2.admin.models import CertificateUsageType` | -**Admin** | [ClassificationBannerDisplayType](docs/v2/Admin/models/ClassificationBannerDisplayType.md) | `from foundry_sdk.v2.admin.models import ClassificationBannerDisplayType` | **Admin** | [CreateGroupRequest](docs/v2/Admin/models/CreateGroupRequest.md) | `from foundry_sdk.v2.admin.models import CreateGroupRequest` | **Admin** | [CreateMarkingCategoryRequest](docs/v2/Admin/models/CreateMarkingCategoryRequest.md) | `from foundry_sdk.v2.admin.models import CreateMarkingCategoryRequest` | **Admin** | [CreateMarkingRequest](docs/v2/Admin/models/CreateMarkingRequest.md) | `from foundry_sdk.v2.admin.models import CreateMarkingRequest` | @@ -1041,7 +1002,6 @@ Namespace | Name | Import | **Admin** | [HostName](docs/v2/Admin/models/HostName.md) | `from foundry_sdk.v2.admin.models import HostName` | **Admin** | [ListAuthenticationProvidersResponse](docs/v2/Admin/models/ListAuthenticationProvidersResponse.md) | `from foundry_sdk.v2.admin.models import ListAuthenticationProvidersResponse` | **Admin** | [ListAvailableOrganizationRolesResponse](docs/v2/Admin/models/ListAvailableOrganizationRolesResponse.md) | `from foundry_sdk.v2.admin.models import ListAvailableOrganizationRolesResponse` | -**Admin** | [ListCurrentGroupsResponse](docs/v2/Admin/models/ListCurrentGroupsResponse.md) | `from foundry_sdk.v2.admin.models import ListCurrentGroupsResponse` | **Admin** | [ListEnrollmentRoleAssignmentsResponse](docs/v2/Admin/models/ListEnrollmentRoleAssignmentsResponse.md) | `from foundry_sdk.v2.admin.models import ListEnrollmentRoleAssignmentsResponse` | **Admin** | [ListGroupMembershipsResponse](docs/v2/Admin/models/ListGroupMembershipsResponse.md) | `from foundry_sdk.v2.admin.models import ListGroupMembershipsResponse` | **Admin** | [ListGroupMembersResponse](docs/v2/Admin/models/ListGroupMembersResponse.md) | `from foundry_sdk.v2.admin.models import ListGroupMembersResponse` | @@ -1051,7 +1011,6 @@ Namespace | Name | Import | **Admin** | [ListMarkingMembersResponse](docs/v2/Admin/models/ListMarkingMembersResponse.md) | `from foundry_sdk.v2.admin.models import ListMarkingMembersResponse` | **Admin** | [ListMarkingRoleAssignmentsResponse](docs/v2/Admin/models/ListMarkingRoleAssignmentsResponse.md) | `from foundry_sdk.v2.admin.models import ListMarkingRoleAssignmentsResponse` | **Admin** | [ListMarkingsResponse](docs/v2/Admin/models/ListMarkingsResponse.md) | `from foundry_sdk.v2.admin.models import ListMarkingsResponse` | -**Admin** | [ListOrganizationGuestMembersResponse](docs/v2/Admin/models/ListOrganizationGuestMembersResponse.md) | `from foundry_sdk.v2.admin.models import ListOrganizationGuestMembersResponse` | **Admin** | [ListOrganizationRoleAssignmentsResponse](docs/v2/Admin/models/ListOrganizationRoleAssignmentsResponse.md) | `from foundry_sdk.v2.admin.models import ListOrganizationRoleAssignmentsResponse` | **Admin** | [ListUsersResponse](docs/v2/Admin/models/ListUsersResponse.md) | `from foundry_sdk.v2.admin.models import ListUsersResponse` | **Admin** | [Marking](docs/v2/Admin/models/Marking.md) | `from foundry_sdk.v2.admin.models import Marking` | @@ -1072,7 +1031,6 @@ Namespace | Name | Import | **Admin** | [MarkingType](docs/v2/Admin/models/MarkingType.md) | `from foundry_sdk.v2.admin.models import MarkingType` | **Admin** | [OidcAuthenticationProtocol](docs/v2/Admin/models/OidcAuthenticationProtocol.md) | `from foundry_sdk.v2.admin.models import OidcAuthenticationProtocol` | **Admin** | [Organization](docs/v2/Admin/models/Organization.md) | `from foundry_sdk.v2.admin.models import Organization` | -**Admin** | [OrganizationGuestMember](docs/v2/Admin/models/OrganizationGuestMember.md) | `from foundry_sdk.v2.admin.models import OrganizationGuestMember` | **Admin** | [OrganizationName](docs/v2/Admin/models/OrganizationName.md) | `from foundry_sdk.v2.admin.models import OrganizationName` | **Admin** | [OrganizationRoleAssignment](docs/v2/Admin/models/OrganizationRoleAssignment.md) | `from foundry_sdk.v2.admin.models import OrganizationRoleAssignment` | **Admin** | [PreregisterGroupRequest](docs/v2/Admin/models/PreregisterGroupRequest.md) | `from foundry_sdk.v2.admin.models import PreregisterGroupRequest` | @@ -1083,12 +1041,9 @@ Namespace | Name | Import | **Admin** | [RemoveGroupMembersRequest](docs/v2/Admin/models/RemoveGroupMembersRequest.md) | `from foundry_sdk.v2.admin.models import RemoveGroupMembersRequest` | **Admin** | [RemoveMarkingMembersRequest](docs/v2/Admin/models/RemoveMarkingMembersRequest.md) | `from foundry_sdk.v2.admin.models import RemoveMarkingMembersRequest` | **Admin** | [RemoveMarkingRoleAssignmentsRequest](docs/v2/Admin/models/RemoveMarkingRoleAssignmentsRequest.md) | `from foundry_sdk.v2.admin.models import RemoveMarkingRoleAssignmentsRequest` | -**Admin** | [RemoveOrganizationGuestMembersRequest](docs/v2/Admin/models/RemoveOrganizationGuestMembersRequest.md) | `from foundry_sdk.v2.admin.models import RemoveOrganizationGuestMembersRequest` | **Admin** | [RemoveOrganizationRoleAssignmentsRequest](docs/v2/Admin/models/RemoveOrganizationRoleAssignmentsRequest.md) | `from foundry_sdk.v2.admin.models import RemoveOrganizationRoleAssignmentsRequest` | **Admin** | [ReplaceGroupMembershipExpirationPolicyRequest](docs/v2/Admin/models/ReplaceGroupMembershipExpirationPolicyRequest.md) | `from foundry_sdk.v2.admin.models import ReplaceGroupMembershipExpirationPolicyRequest` | **Admin** | [ReplaceGroupProviderInfoRequest](docs/v2/Admin/models/ReplaceGroupProviderInfoRequest.md) | `from foundry_sdk.v2.admin.models import ReplaceGroupProviderInfoRequest` | -**Admin** | [ReplaceGroupRequest](docs/v2/Admin/models/ReplaceGroupRequest.md) | `from foundry_sdk.v2.admin.models import ReplaceGroupRequest` | -**Admin** | [ReplaceMarkingCategoryRequest](docs/v2/Admin/models/ReplaceMarkingCategoryRequest.md) | `from foundry_sdk.v2.admin.models import ReplaceMarkingCategoryRequest` | **Admin** | [ReplaceMarkingRequest](docs/v2/Admin/models/ReplaceMarkingRequest.md) | `from foundry_sdk.v2.admin.models import ReplaceMarkingRequest` | **Admin** | [ReplaceOrganizationRequest](docs/v2/Admin/models/ReplaceOrganizationRequest.md) | `from foundry_sdk.v2.admin.models import ReplaceOrganizationRequest` | **Admin** | [ReplaceUserProviderInfoRequest](docs/v2/Admin/models/ReplaceUserProviderInfoRequest.md) | `from foundry_sdk.v2.admin.models import ReplaceUserProviderInfoRequest` | @@ -1200,8 +1155,6 @@ Namespace | Name | Import | **Checkpoints** | [CheckpointedObjectSetVersionedRid](docs/v2/Checkpoints/models/CheckpointedObjectSetVersionedRid.md) | `from foundry_sdk.v2.checkpoints.models import CheckpointedObjectSetVersionedRid` | **Checkpoints** | [CheckpointedOntology](docs/v2/Checkpoints/models/CheckpointedOntology.md) | `from foundry_sdk.v2.checkpoints.models import CheckpointedOntology` | **Checkpoints** | [CheckpointedOntologyWithObjectTypes](docs/v2/Checkpoints/models/CheckpointedOntologyWithObjectTypes.md) | `from foundry_sdk.v2.checkpoints.models import CheckpointedOntologyWithObjectTypes` | -**Checkpoints** | [CheckpointedPeeringJob](docs/v2/Checkpoints/models/CheckpointedPeeringJob.md) | `from foundry_sdk.v2.checkpoints.models import CheckpointedPeeringJob` | -**Checkpoints** | [CheckpointedPeeringJobId](docs/v2/Checkpoints/models/CheckpointedPeeringJobId.md) | `from foundry_sdk.v2.checkpoints.models import CheckpointedPeeringJobId` | **Checkpoints** | [CheckpointedPrincipal](docs/v2/Checkpoints/models/CheckpointedPrincipal.md) | `from foundry_sdk.v2.checkpoints.models import CheckpointedPrincipal` | **Checkpoints** | [CheckpointedPrincipalId](docs/v2/Checkpoints/models/CheckpointedPrincipalId.md) | `from foundry_sdk.v2.checkpoints.models import CheckpointedPrincipalId` | **Checkpoints** | [CheckpointedPrincipalRole](docs/v2/Checkpoints/models/CheckpointedPrincipalRole.md) | `from foundry_sdk.v2.checkpoints.models import CheckpointedPrincipalRole` | @@ -1350,6 +1303,7 @@ Namespace | Name | Import | **Connectivity** | [LongColumnInitialIncrementalState](docs/v2/Connectivity/models/LongColumnInitialIncrementalState.md) | `from foundry_sdk.v2.connectivity.models import LongColumnInitialIncrementalState` | **Connectivity** | [MicrosoftAccessTableImportConfig](docs/v2/Connectivity/models/MicrosoftAccessTableImportConfig.md) | `from foundry_sdk.v2.connectivity.models import MicrosoftAccessTableImportConfig` | **Connectivity** | [MicrosoftSqlServerTableImportConfig](docs/v2/Connectivity/models/MicrosoftSqlServerTableImportConfig.md) | `from foundry_sdk.v2.connectivity.models import MicrosoftSqlServerTableImportConfig` | +**Connectivity** | [NetworkEgressPolicyRid](docs/v2/Connectivity/models/NetworkEgressPolicyRid.md) | `from foundry_sdk.v2.connectivity.models import NetworkEgressPolicyRid` | **Connectivity** | [OauthMachineToMachineAuth](docs/v2/Connectivity/models/OauthMachineToMachineAuth.md) | `from foundry_sdk.v2.connectivity.models import OauthMachineToMachineAuth` | **Connectivity** | [OracleTableImportConfig](docs/v2/Connectivity/models/OracleTableImportConfig.md) | `from foundry_sdk.v2.connectivity.models import OracleTableImportConfig` | **Connectivity** | [PersonalAccessToken](docs/v2/Connectivity/models/PersonalAccessToken.md) | `from foundry_sdk.v2.connectivity.models import PersonalAccessToken` | @@ -1426,8 +1380,6 @@ Namespace | Name | Import | **Core** | [CheckReportRid](docs/v2/Core/models/CheckReportRid.md) | `from foundry_sdk.v2.core.models import CheckReportRid` | **Core** | [CheckRid](docs/v2/Core/models/CheckRid.md) | `from foundry_sdk.v2.core.models import CheckRid` | **Core** | [CipherTextType](docs/v2/Core/models/CipherTextType.md) | `from foundry_sdk.v2.core.models import CipherTextType` | -**Core** | [Color](docs/v2/Core/models/Color.md) | `from foundry_sdk.v2.core.models import Color` | -**Core** | [ColumnName](docs/v2/Core/models/ColumnName.md) | `from foundry_sdk.v2.core.models import ColumnName` | **Core** | [ComputeSeconds](docs/v2/Core/models/ComputeSeconds.md) | `from foundry_sdk.v2.core.models import ComputeSeconds` | **Core** | [ContentLength](docs/v2/Core/models/ContentLength.md) | `from foundry_sdk.v2.core.models import ContentLength` | **Core** | [ContentType](docs/v2/Core/models/ContentType.md) | `from foundry_sdk.v2.core.models import ContentType` | @@ -1497,7 +1449,6 @@ Namespace | Name | Import | **Core** | [MediaSetViewItemWrapper](docs/v2/Core/models/MediaSetViewItemWrapper.md) | `from foundry_sdk.v2.core.models import MediaSetViewItemWrapper` | **Core** | [MediaSetViewRid](docs/v2/Core/models/MediaSetViewRid.md) | `from foundry_sdk.v2.core.models import MediaSetViewRid` | **Core** | [MediaType](docs/v2/Core/models/MediaType.md) | `from foundry_sdk.v2.core.models import MediaType` | -**Core** | [NetworkEgressPolicyRid](docs/v2/Core/models/NetworkEgressPolicyRid.md) | `from foundry_sdk.v2.core.models import NetworkEgressPolicyRid` | **Core** | [NullType](docs/v2/Core/models/NullType.md) | `from foundry_sdk.v2.core.models import NullType` | **Core** | [NumericOrNonNumericType](docs/v2/Core/models/NumericOrNonNumericType.md) | `from foundry_sdk.v2.core.models import NumericOrNonNumericType` | **Core** | [Operation](docs/v2/Core/models/Operation.md) | `from foundry_sdk.v2.core.models import Operation` | @@ -1544,7 +1495,6 @@ Namespace | Name | Import | **Core** | [VectorSimilarityFunctionValue](docs/v2/Core/models/VectorSimilarityFunctionValue.md) | `from foundry_sdk.v2.core.models import VectorSimilarityFunctionValue` | **Core** | [VectorType](docs/v2/Core/models/VectorType.md) | `from foundry_sdk.v2.core.models import VectorType` | **Core** | [VersionId](docs/v2/Core/models/VersionId.md) | `from foundry_sdk.v2.core.models import VersionId` | -**Core** | [VoidType](docs/v2/Core/models/VoidType.md) | `from foundry_sdk.v2.core.models import VoidType` | **Core** | [ZoneId](docs/v2/Core/models/ZoneId.md) | `from foundry_sdk.v2.core.models import ZoneId` | **DataHealth** | [AllowedColumnValuesCheckConfig](docs/v2/DataHealth/models/AllowedColumnValuesCheckConfig.md) | `from foundry_sdk.v2.data_health.models import AllowedColumnValuesCheckConfig` | **DataHealth** | [ApproximateUniquePercentageCheckConfig](docs/v2/DataHealth/models/ApproximateUniquePercentageCheckConfig.md) | `from foundry_sdk.v2.data_health.models import ApproximateUniquePercentageCheckConfig` | @@ -1682,12 +1632,8 @@ Namespace | Name | Import | **Datasets** | [ViewPrimaryKey](docs/v2/Datasets/models/ViewPrimaryKey.md) | `from foundry_sdk.v2.datasets.models import ViewPrimaryKey` | **Datasets** | [ViewPrimaryKeyResolution](docs/v2/Datasets/models/ViewPrimaryKeyResolution.md) | `from foundry_sdk.v2.datasets.models import ViewPrimaryKeyResolution` | **Filesystem** | [AccessRequirements](docs/v2/Filesystem/models/AccessRequirements.md) | `from foundry_sdk.v2.filesystem.models import AccessRequirements` | -**Filesystem** | [AddExternalResourceReferenceRequest](docs/v2/Filesystem/models/AddExternalResourceReferenceRequest.md) | `from foundry_sdk.v2.filesystem.models import AddExternalResourceReferenceRequest` | -**Filesystem** | [AddFilesystemResourceReferenceRequest](docs/v2/Filesystem/models/AddFilesystemResourceReferenceRequest.md) | `from foundry_sdk.v2.filesystem.models import AddFilesystemResourceReferenceRequest` | **Filesystem** | [AddMarkingsRequest](docs/v2/Filesystem/models/AddMarkingsRequest.md) | `from foundry_sdk.v2.filesystem.models import AddMarkingsRequest` | **Filesystem** | [AddOrganizationsRequest](docs/v2/Filesystem/models/AddOrganizationsRequest.md) | `from foundry_sdk.v2.filesystem.models import AddOrganizationsRequest` | -**Filesystem** | [AddProjectResourceReferencesRequest](docs/v2/Filesystem/models/AddProjectResourceReferencesRequest.md) | `from foundry_sdk.v2.filesystem.models import AddProjectResourceReferencesRequest` | -**Filesystem** | [AddResourceReferenceRequest](docs/v2/Filesystem/models/AddResourceReferenceRequest.md) | `from foundry_sdk.v2.filesystem.models import AddResourceReferenceRequest` | **Filesystem** | [AddResourceRolesRequest](docs/v2/Filesystem/models/AddResourceRolesRequest.md) | `from foundry_sdk.v2.filesystem.models import AddResourceRolesRequest` | **Filesystem** | [CreateFolderRequest](docs/v2/Filesystem/models/CreateFolderRequest.md) | `from foundry_sdk.v2.filesystem.models import CreateFolderRequest` | **Filesystem** | [CreateProjectFromTemplateRequest](docs/v2/Filesystem/models/CreateProjectFromTemplateRequest.md) | `from foundry_sdk.v2.filesystem.models import CreateProjectFromTemplateRequest` | @@ -1708,7 +1654,6 @@ Namespace | Name | Import | **Filesystem** | [ListChildrenOfFolderResponse](docs/v2/Filesystem/models/ListChildrenOfFolderResponse.md) | `from foundry_sdk.v2.filesystem.models import ListChildrenOfFolderResponse` | **Filesystem** | [ListMarkingsOfResourceResponse](docs/v2/Filesystem/models/ListMarkingsOfResourceResponse.md) | `from foundry_sdk.v2.filesystem.models import ListMarkingsOfResourceResponse` | **Filesystem** | [ListOrganizationsOfProjectResponse](docs/v2/Filesystem/models/ListOrganizationsOfProjectResponse.md) | `from foundry_sdk.v2.filesystem.models import ListOrganizationsOfProjectResponse` | -**Filesystem** | [ListProjectResourceReferencesResponse](docs/v2/Filesystem/models/ListProjectResourceReferencesResponse.md) | `from foundry_sdk.v2.filesystem.models import ListProjectResourceReferencesResponse` | **Filesystem** | [ListResourceRolesResponse](docs/v2/Filesystem/models/ListResourceRolesResponse.md) | `from foundry_sdk.v2.filesystem.models import ListResourceRolesResponse` | **Filesystem** | [ListSpacesResponse](docs/v2/Filesystem/models/ListSpacesResponse.md) | `from foundry_sdk.v2.filesystem.models import ListSpacesResponse` | **Filesystem** | [Marking](docs/v2/Filesystem/models/Marking.md) | `from foundry_sdk.v2.filesystem.models import Marking` | @@ -1716,21 +1661,13 @@ Namespace | Name | Import | **Filesystem** | [PrincipalIdOnly](docs/v2/Filesystem/models/PrincipalIdOnly.md) | `from foundry_sdk.v2.filesystem.models import PrincipalIdOnly` | **Filesystem** | [PrincipalWithId](docs/v2/Filesystem/models/PrincipalWithId.md) | `from foundry_sdk.v2.filesystem.models import PrincipalWithId` | **Filesystem** | [Project](docs/v2/Filesystem/models/Project.md) | `from foundry_sdk.v2.filesystem.models import Project` | -**Filesystem** | [ProjectExternalResourceReference](docs/v2/Filesystem/models/ProjectExternalResourceReference.md) | `from foundry_sdk.v2.filesystem.models import ProjectExternalResourceReference` | -**Filesystem** | [ProjectFilesystemResourceReference](docs/v2/Filesystem/models/ProjectFilesystemResourceReference.md) | `from foundry_sdk.v2.filesystem.models import ProjectFilesystemResourceReference` | -**Filesystem** | [ProjectResourceLevelRoleGrantsAllowed](docs/v2/Filesystem/models/ProjectResourceLevelRoleGrantsAllowed.md) | `from foundry_sdk.v2.filesystem.models import ProjectResourceLevelRoleGrantsAllowed` | -**Filesystem** | [ProjectResourceReference](docs/v2/Filesystem/models/ProjectResourceReference.md) | `from foundry_sdk.v2.filesystem.models import ProjectResourceReference` | -**Filesystem** | [ProjectResourceReferenceType](docs/v2/Filesystem/models/ProjectResourceReferenceType.md) | `from foundry_sdk.v2.filesystem.models import ProjectResourceReferenceType` | -**Filesystem** | [ProjectResourceReferenceUnion](docs/v2/Filesystem/models/ProjectResourceReferenceUnion.md) | `from foundry_sdk.v2.filesystem.models import ProjectResourceReferenceUnion` | **Filesystem** | [ProjectRid](docs/v2/Filesystem/models/ProjectRid.md) | `from foundry_sdk.v2.filesystem.models import ProjectRid` | **Filesystem** | [ProjectTemplateRid](docs/v2/Filesystem/models/ProjectTemplateRid.md) | `from foundry_sdk.v2.filesystem.models import ProjectTemplateRid` | **Filesystem** | [ProjectTemplateVariableId](docs/v2/Filesystem/models/ProjectTemplateVariableId.md) | `from foundry_sdk.v2.filesystem.models import ProjectTemplateVariableId` | **Filesystem** | [ProjectTemplateVariableValue](docs/v2/Filesystem/models/ProjectTemplateVariableValue.md) | `from foundry_sdk.v2.filesystem.models import ProjectTemplateVariableValue` | **Filesystem** | [RemoveMarkingsRequest](docs/v2/Filesystem/models/RemoveMarkingsRequest.md) | `from foundry_sdk.v2.filesystem.models import RemoveMarkingsRequest` | **Filesystem** | [RemoveOrganizationsRequest](docs/v2/Filesystem/models/RemoveOrganizationsRequest.md) | `from foundry_sdk.v2.filesystem.models import RemoveOrganizationsRequest` | -**Filesystem** | [RemoveProjectResourceReferencesRequest](docs/v2/Filesystem/models/RemoveProjectResourceReferencesRequest.md) | `from foundry_sdk.v2.filesystem.models import RemoveProjectResourceReferencesRequest` | **Filesystem** | [RemoveResourceRolesRequest](docs/v2/Filesystem/models/RemoveResourceRolesRequest.md) | `from foundry_sdk.v2.filesystem.models import RemoveResourceRolesRequest` | -**Filesystem** | [ReplaceFolderRequest](docs/v2/Filesystem/models/ReplaceFolderRequest.md) | `from foundry_sdk.v2.filesystem.models import ReplaceFolderRequest` | **Filesystem** | [ReplaceProjectRequest](docs/v2/Filesystem/models/ReplaceProjectRequest.md) | `from foundry_sdk.v2.filesystem.models import ReplaceProjectRequest` | **Filesystem** | [ReplaceSpaceRequest](docs/v2/Filesystem/models/ReplaceSpaceRequest.md) | `from foundry_sdk.v2.filesystem.models import ReplaceSpaceRequest` | **Filesystem** | [Resource](docs/v2/Filesystem/models/Resource.md) | `from foundry_sdk.v2.filesystem.models import Resource` | @@ -1748,22 +1685,13 @@ Namespace | Name | Import | **Filesystem** | [TrashStatus](docs/v2/Filesystem/models/TrashStatus.md) | `from foundry_sdk.v2.filesystem.models import TrashStatus` | **Filesystem** | [UsageAccountRid](docs/v2/Filesystem/models/UsageAccountRid.md) | `from foundry_sdk.v2.filesystem.models import UsageAccountRid` | **Functions** | [ArrayConstraint](docs/v2/Functions/models/ArrayConstraint.md) | `from foundry_sdk.v2.functions.models import ArrayConstraint` | -**Functions** | [CancelExecutionResponse](docs/v2/Functions/models/CancelExecutionResponse.md) | `from foundry_sdk.v2.functions.models import CancelExecutionResponse` | **Functions** | [DataValue](docs/v2/Functions/models/DataValue.md) | `from foundry_sdk.v2.functions.models import DataValue` | **Functions** | [EnumConstraint](docs/v2/Functions/models/EnumConstraint.md) | `from foundry_sdk.v2.functions.models import EnumConstraint` | -**Functions** | [ExecuteAsyncQueryRequest](docs/v2/Functions/models/ExecuteAsyncQueryRequest.md) | `from foundry_sdk.v2.functions.models import ExecuteAsyncQueryRequest` | -**Functions** | [ExecuteQueryAsyncResponse](docs/v2/Functions/models/ExecuteQueryAsyncResponse.md) | `from foundry_sdk.v2.functions.models import ExecuteQueryAsyncResponse` | **Functions** | [ExecuteQueryRequest](docs/v2/Functions/models/ExecuteQueryRequest.md) | `from foundry_sdk.v2.functions.models import ExecuteQueryRequest` | **Functions** | [ExecuteQueryResponse](docs/v2/Functions/models/ExecuteQueryResponse.md) | `from foundry_sdk.v2.functions.models import ExecuteQueryResponse` | -**Functions** | [ExecutionCompleted](docs/v2/Functions/models/ExecutionCompleted.md) | `from foundry_sdk.v2.functions.models import ExecutionCompleted` | -**Functions** | [ExecutionId](docs/v2/Functions/models/ExecutionId.md) | `from foundry_sdk.v2.functions.models import ExecutionId` | -**Functions** | [ExecutionSubmitted](docs/v2/Functions/models/ExecutionSubmitted.md) | `from foundry_sdk.v2.functions.models import ExecutionSubmitted` | **Functions** | [FunctionRid](docs/v2/Functions/models/FunctionRid.md) | `from foundry_sdk.v2.functions.models import FunctionRid` | **Functions** | [FunctionVersion](docs/v2/Functions/models/FunctionVersion.md) | `from foundry_sdk.v2.functions.models import FunctionVersion` | -**Functions** | [GetByRidQueriesBatchRequestElement](docs/v2/Functions/models/GetByRidQueriesBatchRequestElement.md) | `from foundry_sdk.v2.functions.models import GetByRidQueriesBatchRequestElement` | -**Functions** | [GetByRidQueriesBatchResponse](docs/v2/Functions/models/GetByRidQueriesBatchResponse.md) | `from foundry_sdk.v2.functions.models import GetByRidQueriesBatchResponse` | -**Functions** | [GetExecutionResultResponse](docs/v2/Functions/models/GetExecutionResultResponse.md) | `from foundry_sdk.v2.functions.models import GetExecutionResultResponse` | -**Functions** | [GetResultExecutionRequest](docs/v2/Functions/models/GetResultExecutionRequest.md) | `from foundry_sdk.v2.functions.models import GetResultExecutionRequest` | +**Functions** | [GetByRidQueriesRequest](docs/v2/Functions/models/GetByRidQueriesRequest.md) | `from foundry_sdk.v2.functions.models import GetByRidQueriesRequest` | **Functions** | [LengthConstraint](docs/v2/Functions/models/LengthConstraint.md) | `from foundry_sdk.v2.functions.models import LengthConstraint` | **Functions** | [MapConstraint](docs/v2/Functions/models/MapConstraint.md) | `from foundry_sdk.v2.functions.models import MapConstraint` | **Functions** | [NullableConstraint](docs/v2/Functions/models/NullableConstraint.md) | `from foundry_sdk.v2.functions.models import NullableConstraint` | @@ -1782,22 +1710,18 @@ Namespace | Name | Import | **Functions** | [QuerySetType](docs/v2/Functions/models/QuerySetType.md) | `from foundry_sdk.v2.functions.models import QuerySetType` | **Functions** | [QueryStructField](docs/v2/Functions/models/QueryStructField.md) | `from foundry_sdk.v2.functions.models import QueryStructField` | **Functions** | [QueryStructType](docs/v2/Functions/models/QueryStructType.md) | `from foundry_sdk.v2.functions.models import QueryStructType` | -**Functions** | [QueryTypeReferenceType](docs/v2/Functions/models/QueryTypeReferenceType.md) | `from foundry_sdk.v2.functions.models import QueryTypeReferenceType` | **Functions** | [QueryUnionType](docs/v2/Functions/models/QueryUnionType.md) | `from foundry_sdk.v2.functions.models import QueryUnionType` | **Functions** | [RangesConstraint](docs/v2/Functions/models/RangesConstraint.md) | `from foundry_sdk.v2.functions.models import RangesConstraint` | **Functions** | [RegexConstraint](docs/v2/Functions/models/RegexConstraint.md) | `from foundry_sdk.v2.functions.models import RegexConstraint` | **Functions** | [RidConstraint](docs/v2/Functions/models/RidConstraint.md) | `from foundry_sdk.v2.functions.models import RidConstraint` | -**Functions** | [RunningExecution](docs/v2/Functions/models/RunningExecution.md) | `from foundry_sdk.v2.functions.models import RunningExecution` | **Functions** | [StreamingExecuteQueryRequest](docs/v2/Functions/models/StreamingExecuteQueryRequest.md) | `from foundry_sdk.v2.functions.models import StreamingExecuteQueryRequest` | **Functions** | [StructConstraint](docs/v2/Functions/models/StructConstraint.md) | `from foundry_sdk.v2.functions.models import StructConstraint` | **Functions** | [StructFieldApiName](docs/v2/Functions/models/StructFieldApiName.md) | `from foundry_sdk.v2.functions.models import StructFieldApiName` | **Functions** | [StructFieldName](docs/v2/Functions/models/StructFieldName.md) | `from foundry_sdk.v2.functions.models import StructFieldName` | **Functions** | [StructV1Constraint](docs/v2/Functions/models/StructV1Constraint.md) | `from foundry_sdk.v2.functions.models import StructV1Constraint` | -**Functions** | [SucceededExecution](docs/v2/Functions/models/SucceededExecution.md) | `from foundry_sdk.v2.functions.models import SucceededExecution` | **Functions** | [ThreeDimensionalAggregation](docs/v2/Functions/models/ThreeDimensionalAggregation.md) | `from foundry_sdk.v2.functions.models import ThreeDimensionalAggregation` | **Functions** | [TransactionId](docs/v2/Functions/models/TransactionId.md) | `from foundry_sdk.v2.functions.models import TransactionId` | **Functions** | [TwoDimensionalAggregation](docs/v2/Functions/models/TwoDimensionalAggregation.md) | `from foundry_sdk.v2.functions.models import TwoDimensionalAggregation` | -**Functions** | [TypeReferenceIdentifier](docs/v2/Functions/models/TypeReferenceIdentifier.md) | `from foundry_sdk.v2.functions.models import TypeReferenceIdentifier` | **Functions** | [UuidConstraint](docs/v2/Functions/models/UuidConstraint.md) | `from foundry_sdk.v2.functions.models import UuidConstraint` | **Functions** | [ValueType](docs/v2/Functions/models/ValueType.md) | `from foundry_sdk.v2.functions.models import ValueType` | **Functions** | [ValueTypeApiName](docs/v2/Functions/models/ValueTypeApiName.md) | `from foundry_sdk.v2.functions.models import ValueTypeApiName` | @@ -1863,13 +1787,11 @@ Namespace | Name | Import | **LanguageModels** | [AnthropicDocument](docs/v2/LanguageModels/models/AnthropicDocument.md) | `from foundry_sdk.v2.language_models.models import AnthropicDocument` | **LanguageModels** | [AnthropicDocumentCitations](docs/v2/LanguageModels/models/AnthropicDocumentCitations.md) | `from foundry_sdk.v2.language_models.models import AnthropicDocumentCitations` | **LanguageModels** | [AnthropicDocumentSource](docs/v2/LanguageModels/models/AnthropicDocumentSource.md) | `from foundry_sdk.v2.language_models.models import AnthropicDocumentSource` | -**LanguageModels** | [AnthropicEffort](docs/v2/LanguageModels/models/AnthropicEffort.md) | `from foundry_sdk.v2.language_models.models import AnthropicEffort` | **LanguageModels** | [AnthropicEnabledThinking](docs/v2/LanguageModels/models/AnthropicEnabledThinking.md) | `from foundry_sdk.v2.language_models.models import AnthropicEnabledThinking` | **LanguageModels** | [AnthropicEphemeralCacheControl](docs/v2/LanguageModels/models/AnthropicEphemeralCacheControl.md) | `from foundry_sdk.v2.language_models.models import AnthropicEphemeralCacheControl` | **LanguageModels** | [AnthropicImage](docs/v2/LanguageModels/models/AnthropicImage.md) | `from foundry_sdk.v2.language_models.models import AnthropicImage` | **LanguageModels** | [AnthropicImageBase64Source](docs/v2/LanguageModels/models/AnthropicImageBase64Source.md) | `from foundry_sdk.v2.language_models.models import AnthropicImageBase64Source` | **LanguageModels** | [AnthropicImageSource](docs/v2/LanguageModels/models/AnthropicImageSource.md) | `from foundry_sdk.v2.language_models.models import AnthropicImageSource` | -**LanguageModels** | [AnthropicJsonSchemaOutputFormat](docs/v2/LanguageModels/models/AnthropicJsonSchemaOutputFormat.md) | `from foundry_sdk.v2.language_models.models import AnthropicJsonSchemaOutputFormat` | **LanguageModels** | [AnthropicMediaType](docs/v2/LanguageModels/models/AnthropicMediaType.md) | `from foundry_sdk.v2.language_models.models import AnthropicMediaType` | **LanguageModels** | [AnthropicMessage](docs/v2/LanguageModels/models/AnthropicMessage.md) | `from foundry_sdk.v2.language_models.models import AnthropicMessage` | **LanguageModels** | [AnthropicMessageContent](docs/v2/LanguageModels/models/AnthropicMessageContent.md) | `from foundry_sdk.v2.language_models.models import AnthropicMessageContent` | @@ -1877,8 +1799,6 @@ Namespace | Name | Import | **LanguageModels** | [AnthropicMessagesRequest](docs/v2/LanguageModels/models/AnthropicMessagesRequest.md) | `from foundry_sdk.v2.language_models.models import AnthropicMessagesRequest` | **LanguageModels** | [AnthropicMessagesResponse](docs/v2/LanguageModels/models/AnthropicMessagesResponse.md) | `from foundry_sdk.v2.language_models.models import AnthropicMessagesResponse` | **LanguageModels** | [AnthropicNoneToolChoice](docs/v2/LanguageModels/models/AnthropicNoneToolChoice.md) | `from foundry_sdk.v2.language_models.models import AnthropicNoneToolChoice` | -**LanguageModels** | [AnthropicOutputConfig](docs/v2/LanguageModels/models/AnthropicOutputConfig.md) | `from foundry_sdk.v2.language_models.models import AnthropicOutputConfig` | -**LanguageModels** | [AnthropicOutputFormat](docs/v2/LanguageModels/models/AnthropicOutputFormat.md) | `from foundry_sdk.v2.language_models.models import AnthropicOutputFormat` | **LanguageModels** | [AnthropicRedactedThinking](docs/v2/LanguageModels/models/AnthropicRedactedThinking.md) | `from foundry_sdk.v2.language_models.models import AnthropicRedactedThinking` | **LanguageModels** | [AnthropicSystemMessage](docs/v2/LanguageModels/models/AnthropicSystemMessage.md) | `from foundry_sdk.v2.language_models.models import AnthropicSystemMessage` | **LanguageModels** | [AnthropicText](docs/v2/LanguageModels/models/AnthropicText.md) | `from foundry_sdk.v2.language_models.models import AnthropicText` | @@ -1903,7 +1823,6 @@ Namespace | Name | Import | **MediaSets** | [AnnotateGeometry](docs/v2/MediaSets/models/AnnotateGeometry.md) | `from foundry_sdk.v2.media_sets.models import AnnotateGeometry` | **MediaSets** | [AnnotateImageOperation](docs/v2/MediaSets/models/AnnotateImageOperation.md) | `from foundry_sdk.v2.media_sets.models import AnnotateImageOperation` | **MediaSets** | [Annotation](docs/v2/MediaSets/models/Annotation.md) | `from foundry_sdk.v2.media_sets.models import Annotation` | -**MediaSets** | [ApiNameLocatorWrapper](docs/v2/MediaSets/models/ApiNameLocatorWrapper.md) | `from foundry_sdk.v2.media_sets.models import ApiNameLocatorWrapper` | **MediaSets** | [ArchiveEncodeFormat](docs/v2/MediaSets/models/ArchiveEncodeFormat.md) | `from foundry_sdk.v2.media_sets.models import ArchiveEncodeFormat` | **MediaSets** | [AudioChannelLayout](docs/v2/MediaSets/models/AudioChannelLayout.md) | `from foundry_sdk.v2.media_sets.models import AudioChannelLayout` | **MediaSets** | [AudioChannelOperation](docs/v2/MediaSets/models/AudioChannelOperation.md) | `from foundry_sdk.v2.media_sets.models import AudioChannelOperation` | @@ -1918,13 +1837,10 @@ Namespace | Name | Import | **MediaSets** | [AudioTransformation](docs/v2/MediaSets/models/AudioTransformation.md) | `from foundry_sdk.v2.media_sets.models import AudioTransformation` | **MediaSets** | [AvailableEmbeddingModelIds](docs/v2/MediaSets/models/AvailableEmbeddingModelIds.md) | `from foundry_sdk.v2.media_sets.models import AvailableEmbeddingModelIds` | **MediaSets** | [BandInfo](docs/v2/MediaSets/models/BandInfo.md) | `from foundry_sdk.v2.media_sets.models import BandInfo` | -**MediaSets** | [BatchTransactionsTransactionPolicy](docs/v2/MediaSets/models/BatchTransactionsTransactionPolicy.md) | `from foundry_sdk.v2.media_sets.models import BatchTransactionsTransactionPolicy` | **MediaSets** | [BoundingBox](docs/v2/MediaSets/models/BoundingBox.md) | `from foundry_sdk.v2.media_sets.models import BoundingBox` | **MediaSets** | [BoundingBoxGeometry](docs/v2/MediaSets/models/BoundingBoxGeometry.md) | `from foundry_sdk.v2.media_sets.models import BoundingBoxGeometry` | **MediaSets** | [BranchName](docs/v2/MediaSets/models/BranchName.md) | `from foundry_sdk.v2.media_sets.models import BranchName` | **MediaSets** | [BranchRid](docs/v2/MediaSets/models/BranchRid.md) | `from foundry_sdk.v2.media_sets.models import BranchRid` | -**MediaSets** | [ChatLlmSpec](docs/v2/MediaSets/models/ChatLlmSpec.md) | `from foundry_sdk.v2.media_sets.models import ChatLlmSpec` | -**MediaSets** | [ChatLlmSpecWrapper](docs/v2/MediaSets/models/ChatLlmSpecWrapper.md) | `from foundry_sdk.v2.media_sets.models import ChatLlmSpecWrapper` | **MediaSets** | [Color](docs/v2/MediaSets/models/Color.md) | `from foundry_sdk.v2.media_sets.models import Color` | **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` | @@ -1938,7 +1854,6 @@ Namespace | Name | Import | **MediaSets** | [ConvertSheetToJsonOperation](docs/v2/MediaSets/models/ConvertSheetToJsonOperation.md) | `from foundry_sdk.v2.media_sets.models import ConvertSheetToJsonOperation` | **MediaSets** | [CoordinateReferenceSystem](docs/v2/MediaSets/models/CoordinateReferenceSystem.md) | `from foundry_sdk.v2.media_sets.models import CoordinateReferenceSystem` | **MediaSets** | [CreatePdfOperation](docs/v2/MediaSets/models/CreatePdfOperation.md) | `from foundry_sdk.v2.media_sets.models import CreatePdfOperation` | -**MediaSets** | [CropConfig](docs/v2/MediaSets/models/CropConfig.md) | `from foundry_sdk.v2.media_sets.models import CropConfig` | **MediaSets** | [CropImageOperation](docs/v2/MediaSets/models/CropImageOperation.md) | `from foundry_sdk.v2.media_sets.models import CropImageOperation` | **MediaSets** | [DataType](docs/v2/MediaSets/models/DataType.md) | `from foundry_sdk.v2.media_sets.models import DataType` | **MediaSets** | [DecryptImageOperation](docs/v2/MediaSets/models/DecryptImageOperation.md) | `from foundry_sdk.v2.media_sets.models import DecryptImageOperation` | @@ -1971,19 +1886,13 @@ Namespace | Name | Import | **MediaSets** | [EncryptImageOperation](docs/v2/MediaSets/models/EncryptImageOperation.md) | `from foundry_sdk.v2.media_sets.models import EncryptImageOperation` | **MediaSets** | [ExtractAllTextOperation](docs/v2/MediaSets/models/ExtractAllTextOperation.md) | `from foundry_sdk.v2.media_sets.models import ExtractAllTextOperation` | **MediaSets** | [ExtractAudioOperation](docs/v2/MediaSets/models/ExtractAudioOperation.md) | `from foundry_sdk.v2.media_sets.models import ExtractAudioOperation` | -**MediaSets** | [ExtractDocumentLayoutAwareTextV2Config](docs/v2/MediaSets/models/ExtractDocumentLayoutAwareTextV2Config.md) | `from foundry_sdk.v2.media_sets.models import ExtractDocumentLayoutAwareTextV2Config` | -**MediaSets** | [ExtractDocumentLayoutAwareTextV2Operation](docs/v2/MediaSets/models/ExtractDocumentLayoutAwareTextV2Operation.md) | `from foundry_sdk.v2.media_sets.models import ExtractDocumentLayoutAwareTextV2Operation` | -**MediaSets** | [ExtractDocumentTextV2Config](docs/v2/MediaSets/models/ExtractDocumentTextV2Config.md) | `from foundry_sdk.v2.media_sets.models import ExtractDocumentTextV2Config` | -**MediaSets** | [ExtractDocumentTextV2Operation](docs/v2/MediaSets/models/ExtractDocumentTextV2Operation.md) | `from foundry_sdk.v2.media_sets.models import ExtractDocumentTextV2Operation` | **MediaSets** | [ExtractFirstFrameOperation](docs/v2/MediaSets/models/ExtractFirstFrameOperation.md) | `from foundry_sdk.v2.media_sets.models import ExtractFirstFrameOperation` | **MediaSets** | [ExtractFormFieldsOperation](docs/v2/MediaSets/models/ExtractFormFieldsOperation.md) | `from foundry_sdk.v2.media_sets.models import ExtractFormFieldsOperation` | **MediaSets** | [ExtractFramesAtTimestampsOperation](docs/v2/MediaSets/models/ExtractFramesAtTimestampsOperation.md) | `from foundry_sdk.v2.media_sets.models import ExtractFramesAtTimestampsOperation` | **MediaSets** | [ExtractSceneFramesOperation](docs/v2/MediaSets/models/ExtractSceneFramesOperation.md) | `from foundry_sdk.v2.media_sets.models import ExtractSceneFramesOperation` | **MediaSets** | [ExtractTableOfContentsOperation](docs/v2/MediaSets/models/ExtractTableOfContentsOperation.md) | `from foundry_sdk.v2.media_sets.models import ExtractTableOfContentsOperation` | **MediaSets** | [ExtractTextFromPagesToArrayOperation](docs/v2/MediaSets/models/ExtractTextFromPagesToArrayOperation.md) | `from foundry_sdk.v2.media_sets.models import ExtractTextFromPagesToArrayOperation` | -**MediaSets** | [ExtractTextPreprocessingWrapper](docs/v2/MediaSets/models/ExtractTextPreprocessingWrapper.md) | `from foundry_sdk.v2.media_sets.models import ExtractTextPreprocessingWrapper` | **MediaSets** | [ExtractUnstructuredTextFromPageOperation](docs/v2/MediaSets/models/ExtractUnstructuredTextFromPageOperation.md) | `from foundry_sdk.v2.media_sets.models import ExtractUnstructuredTextFromPageOperation` | -**MediaSets** | [ExtractVlmTextOperation](docs/v2/MediaSets/models/ExtractVlmTextOperation.md) | `from foundry_sdk.v2.media_sets.models import ExtractVlmTextOperation` | **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** | [GenerateEmbeddingOperation](docs/v2/MediaSets/models/GenerateEmbeddingOperation.md) | `from foundry_sdk.v2.media_sets.models import GenerateEmbeddingOperation` | @@ -1992,7 +1901,6 @@ Namespace | Name | Import | **MediaSets** | [GetEmailBodyOperation](docs/v2/MediaSets/models/GetEmailBodyOperation.md) | `from foundry_sdk.v2.media_sets.models import GetEmailBodyOperation` | **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** | [GetMediaSetResponse](docs/v2/MediaSets/models/GetMediaSetResponse.md) | `from foundry_sdk.v2.media_sets.models import GetMediaSetResponse` | **MediaSets** | [GetPdfPageDimensionsOperation](docs/v2/MediaSets/models/GetPdfPageDimensionsOperation.md) | `from foundry_sdk.v2.media_sets.models import GetPdfPageDimensionsOperation` | **MediaSets** | [GetTimestampsForSceneFramesOperation](docs/v2/MediaSets/models/GetTimestampsForSceneFramesOperation.md) | `from foundry_sdk.v2.media_sets.models import GetTimestampsForSceneFramesOperation` | **MediaSets** | [GetTransformationJobStatusResponse](docs/v2/MediaSets/models/GetTransformationJobStatusResponse.md) | `from foundry_sdk.v2.media_sets.models import GetTransformationJobStatusResponse` | @@ -2011,7 +1919,6 @@ Namespace | Name | Import | **MediaSets** | [ImageryDecodeFormat](docs/v2/MediaSets/models/ImageryDecodeFormat.md) | `from foundry_sdk.v2.media_sets.models import ImageryDecodeFormat` | **MediaSets** | [ImageryEncodeFormat](docs/v2/MediaSets/models/ImageryEncodeFormat.md) | `from foundry_sdk.v2.media_sets.models import ImageryEncodeFormat` | **MediaSets** | [ImageryMediaItemMetadata](docs/v2/MediaSets/models/ImageryMediaItemMetadata.md) | `from foundry_sdk.v2.media_sets.models import ImageryMediaItemMetadata` | -**MediaSets** | [ImageSpec](docs/v2/MediaSets/models/ImageSpec.md) | `from foundry_sdk.v2.media_sets.models import ImageSpec` | **MediaSets** | [ImageToDocumentOperation](docs/v2/MediaSets/models/ImageToDocumentOperation.md) | `from foundry_sdk.v2.media_sets.models import ImageToDocumentOperation` | **MediaSets** | [ImageToDocumentTransformation](docs/v2/MediaSets/models/ImageToDocumentTransformation.md) | `from foundry_sdk.v2.media_sets.models import ImageToDocumentTransformation` | **MediaSets** | [ImageToEmbeddingOperation](docs/v2/MediaSets/models/ImageToEmbeddingOperation.md) | `from foundry_sdk.v2.media_sets.models import ImageToEmbeddingOperation` | @@ -2020,11 +1927,7 @@ Namespace | Name | Import | **MediaSets** | [ImageToTextTransformation](docs/v2/MediaSets/models/ImageToTextTransformation.md) | `from foundry_sdk.v2.media_sets.models import ImageToTextTransformation` | **MediaSets** | [ImageTransformation](docs/v2/MediaSets/models/ImageTransformation.md) | `from foundry_sdk.v2.media_sets.models import ImageTransformation` | **MediaSets** | [JpgFormat](docs/v2/MediaSets/models/JpgFormat.md) | `from foundry_sdk.v2.media_sets.models import JpgFormat` | -**MediaSets** | [LanguageModelLocator](docs/v2/MediaSets/models/LanguageModelLocator.md) | `from foundry_sdk.v2.media_sets.models import LanguageModelLocator` | **MediaSets** | [LayoutAwareExtractionParameters](docs/v2/MediaSets/models/LayoutAwareExtractionParameters.md) | `from foundry_sdk.v2.media_sets.models import LayoutAwareExtractionParameters` | -**MediaSets** | [LayoutAwareExtractionPreprocessingConfig](docs/v2/MediaSets/models/LayoutAwareExtractionPreprocessingConfig.md) | `from foundry_sdk.v2.media_sets.models import LayoutAwareExtractionPreprocessingConfig` | -**MediaSets** | [LayoutAwarePreprocessingWrapper](docs/v2/MediaSets/models/LayoutAwarePreprocessingWrapper.md) | `from foundry_sdk.v2.media_sets.models import LayoutAwarePreprocessingWrapper` | -**MediaSets** | [LlmSpec](docs/v2/MediaSets/models/LlmSpec.md) | `from foundry_sdk.v2.media_sets.models import LlmSpec` | **MediaSets** | [LogicalTimestamp](docs/v2/MediaSets/models/LogicalTimestamp.md) | `from foundry_sdk.v2.media_sets.models import LogicalTimestamp` | **MediaSets** | [Mailbox](docs/v2/MediaSets/models/Mailbox.md) | `from foundry_sdk.v2.media_sets.models import Mailbox` | **MediaSets** | [MailboxOrGroup](docs/v2/MediaSets/models/MailboxOrGroup.md) | `from foundry_sdk.v2.media_sets.models import MailboxOrGroup` | @@ -2032,22 +1935,16 @@ Namespace | Name | Import | **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** | [MediaSchema](docs/v2/MediaSets/models/MediaSchema.md) | `from foundry_sdk.v2.media_sets.models import MediaSchema` | **MediaSets** | [MkvVideoContainerFormat](docs/v2/MediaSets/models/MkvVideoContainerFormat.md) | `from foundry_sdk.v2.media_sets.models import MkvVideoContainerFormat` | **MediaSets** | [Modality](docs/v2/MediaSets/models/Modality.md) | `from foundry_sdk.v2.media_sets.models import Modality` | -**MediaSets** | [Model3dDecodeFormat](docs/v2/MediaSets/models/Model3dDecodeFormat.md) | `from foundry_sdk.v2.media_sets.models import Model3dDecodeFormat` | -**MediaSets** | [Model3dMediaItemMetadata](docs/v2/MediaSets/models/Model3dMediaItemMetadata.md) | `from foundry_sdk.v2.media_sets.models import Model3dMediaItemMetadata` | -**MediaSets** | [Model3dType](docs/v2/MediaSets/models/Model3dType.md) | `from foundry_sdk.v2.media_sets.models import Model3dType` | **MediaSets** | [MovVideoContainerFormat](docs/v2/MediaSets/models/MovVideoContainerFormat.md) | `from foundry_sdk.v2.media_sets.models import MovVideoContainerFormat` | **MediaSets** | [Mp3Format](docs/v2/MediaSets/models/Mp3Format.md) | `from foundry_sdk.v2.media_sets.models import Mp3Format` | **MediaSets** | [Mp4VideoContainerFormat](docs/v2/MediaSets/models/Mp4VideoContainerFormat.md) | `from foundry_sdk.v2.media_sets.models import Mp4VideoContainerFormat` | -**MediaSets** | [NoTransactionsTransactionPolicy](docs/v2/MediaSets/models/NoTransactionsTransactionPolicy.md) | `from foundry_sdk.v2.media_sets.models import NoTransactionsTransactionPolicy` | **MediaSets** | [NumberOfChannels](docs/v2/MediaSets/models/NumberOfChannels.md) | `from foundry_sdk.v2.media_sets.models import NumberOfChannels` | **MediaSets** | [OcrHocrOutputFormat](docs/v2/MediaSets/models/OcrHocrOutputFormat.md) | `from foundry_sdk.v2.media_sets.models import OcrHocrOutputFormat` | **MediaSets** | [OcrLanguage](docs/v2/MediaSets/models/OcrLanguage.md) | `from foundry_sdk.v2.media_sets.models import OcrLanguage` | **MediaSets** | [OcrLanguageOrScript](docs/v2/MediaSets/models/OcrLanguageOrScript.md) | `from foundry_sdk.v2.media_sets.models import OcrLanguageOrScript` | **MediaSets** | [OcrLanguageWrapper](docs/v2/MediaSets/models/OcrLanguageWrapper.md) | `from foundry_sdk.v2.media_sets.models import OcrLanguageWrapper` | -**MediaSets** | [OcrMode](docs/v2/MediaSets/models/OcrMode.md) | `from foundry_sdk.v2.media_sets.models import OcrMode` | **MediaSets** | [OcrOnPageOperation](docs/v2/MediaSets/models/OcrOnPageOperation.md) | `from foundry_sdk.v2.media_sets.models import OcrOnPageOperation` | **MediaSets** | [OcrOnPagesOperation](docs/v2/MediaSets/models/OcrOnPagesOperation.md) | `from foundry_sdk.v2.media_sets.models import OcrOnPagesOperation` | **MediaSets** | [OcrOutputFormat](docs/v2/MediaSets/models/OcrOutputFormat.md) | `from foundry_sdk.v2.media_sets.models import OcrOutputFormat` | @@ -2056,7 +1953,6 @@ Namespace | Name | Import | **MediaSets** | [OcrScriptWrapper](docs/v2/MediaSets/models/OcrScriptWrapper.md) | `from foundry_sdk.v2.media_sets.models import OcrScriptWrapper` | **MediaSets** | [OcrTextOutputFormat](docs/v2/MediaSets/models/OcrTextOutputFormat.md) | `from foundry_sdk.v2.media_sets.models import OcrTextOutputFormat` | **MediaSets** | [Orientation](docs/v2/MediaSets/models/Orientation.md) | `from foundry_sdk.v2.media_sets.models import Orientation` | -**MediaSets** | [PageRange](docs/v2/MediaSets/models/PageRange.md) | `from foundry_sdk.v2.media_sets.models import PageRange` | **MediaSets** | [PaletteInterpretation](docs/v2/MediaSets/models/PaletteInterpretation.md) | `from foundry_sdk.v2.media_sets.models import PaletteInterpretation` | **MediaSets** | [PdfFormat](docs/v2/MediaSets/models/PdfFormat.md) | `from foundry_sdk.v2.media_sets.models import PdfFormat` | **MediaSets** | [PerformanceMode](docs/v2/MediaSets/models/PerformanceMode.md) | `from foundry_sdk.v2.media_sets.models import PerformanceMode` | @@ -2064,14 +1960,11 @@ Namespace | Name | Import | **MediaSets** | [PngFormat](docs/v2/MediaSets/models/PngFormat.md) | `from foundry_sdk.v2.media_sets.models import PngFormat` | **MediaSets** | [Pttml](docs/v2/MediaSets/models/Pttml.md) | `from foundry_sdk.v2.media_sets.models import Pttml` | **MediaSets** | [PutMediaItemResponse](docs/v2/MediaSets/models/PutMediaItemResponse.md) | `from foundry_sdk.v2.media_sets.models import PutMediaItemResponse` | -**MediaSets** | [RegisterMediaItemRequest](docs/v2/MediaSets/models/RegisterMediaItemRequest.md) | `from foundry_sdk.v2.media_sets.models import RegisterMediaItemRequest` | -**MediaSets** | [RegisterMediaItemResponse](docs/v2/MediaSets/models/RegisterMediaItemResponse.md) | `from foundry_sdk.v2.media_sets.models import RegisterMediaItemResponse` | **MediaSets** | [RenderImageLayerOperation](docs/v2/MediaSets/models/RenderImageLayerOperation.md) | `from foundry_sdk.v2.media_sets.models import RenderImageLayerOperation` | **MediaSets** | [RenderPageOperation](docs/v2/MediaSets/models/RenderPageOperation.md) | `from foundry_sdk.v2.media_sets.models import RenderPageOperation` | **MediaSets** | [RenderPageToFitBoundingBoxOperation](docs/v2/MediaSets/models/RenderPageToFitBoundingBoxOperation.md) | `from foundry_sdk.v2.media_sets.models import RenderPageToFitBoundingBoxOperation` | **MediaSets** | [ResizeImageOperation](docs/v2/MediaSets/models/ResizeImageOperation.md) | `from foundry_sdk.v2.media_sets.models import ResizeImageOperation` | **MediaSets** | [ResizeToFitBoundingBoxOperation](docs/v2/MediaSets/models/ResizeToFitBoundingBoxOperation.md) | `from foundry_sdk.v2.media_sets.models import ResizeToFitBoundingBoxOperation` | -**MediaSets** | [ResizingMode](docs/v2/MediaSets/models/ResizingMode.md) | `from foundry_sdk.v2.media_sets.models import ResizingMode` | **MediaSets** | [RotateImageOperation](docs/v2/MediaSets/models/RotateImageOperation.md) | `from foundry_sdk.v2.media_sets.models import RotateImageOperation` | **MediaSets** | [RotationAngle](docs/v2/MediaSets/models/RotationAngle.md) | `from foundry_sdk.v2.media_sets.models import RotationAngle` | **MediaSets** | [SceneScore](docs/v2/MediaSets/models/SceneScore.md) | `from foundry_sdk.v2.media_sets.models import SceneScore` | @@ -2081,7 +1974,6 @@ Namespace | Name | Import | **MediaSets** | [SpreadsheetToTextOperation](docs/v2/MediaSets/models/SpreadsheetToTextOperation.md) | `from foundry_sdk.v2.media_sets.models import SpreadsheetToTextOperation` | **MediaSets** | [SpreadsheetToTextTransformation](docs/v2/MediaSets/models/SpreadsheetToTextTransformation.md) | `from foundry_sdk.v2.media_sets.models import SpreadsheetToTextTransformation` | **MediaSets** | [TarFormat](docs/v2/MediaSets/models/TarFormat.md) | `from foundry_sdk.v2.media_sets.models import TarFormat` | -**MediaSets** | [TextOutputFormat](docs/v2/MediaSets/models/TextOutputFormat.md) | `from foundry_sdk.v2.media_sets.models import TextOutputFormat` | **MediaSets** | [TiffFormat](docs/v2/MediaSets/models/TiffFormat.md) | `from foundry_sdk.v2.media_sets.models import TiffFormat` | **MediaSets** | [TileImageOperation](docs/v2/MediaSets/models/TileImageOperation.md) | `from foundry_sdk.v2.media_sets.models import TileImageOperation` | **MediaSets** | [TrackedTransformationFailedResponse](docs/v2/MediaSets/models/TrackedTransformationFailedResponse.md) | `from foundry_sdk.v2.media_sets.models import TrackedTransformationFailedResponse` | @@ -2089,7 +1981,6 @@ Namespace | Name | Import | **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** | [TransactionPolicy](docs/v2/MediaSets/models/TransactionPolicy.md) | `from foundry_sdk.v2.media_sets.models import TransactionPolicy` | **MediaSets** | [TranscodeOperation](docs/v2/MediaSets/models/TranscodeOperation.md) | `from foundry_sdk.v2.media_sets.models import TranscodeOperation` | **MediaSets** | [TranscribeJson](docs/v2/MediaSets/models/TranscribeJson.md) | `from foundry_sdk.v2.media_sets.models import TranscribeJson` | **MediaSets** | [TranscribeOperation](docs/v2/MediaSets/models/TranscribeOperation.md) | `from foundry_sdk.v2.media_sets.models import TranscribeOperation` | @@ -2119,71 +2010,13 @@ Namespace | Name | Import | **MediaSets** | [VideoToTextOperation](docs/v2/MediaSets/models/VideoToTextOperation.md) | `from foundry_sdk.v2.media_sets.models import VideoToTextOperation` | **MediaSets** | [VideoToTextTransformation](docs/v2/MediaSets/models/VideoToTextTransformation.md) | `from foundry_sdk.v2.media_sets.models import VideoToTextTransformation` | **MediaSets** | [VideoTransformation](docs/v2/MediaSets/models/VideoTransformation.md) | `from foundry_sdk.v2.media_sets.models import VideoTransformation` | -**MediaSets** | [VlmPreprocessingConfig](docs/v2/MediaSets/models/VlmPreprocessingConfig.md) | `from foundry_sdk.v2.media_sets.models import VlmPreprocessingConfig` | **MediaSets** | [WaveformOperation](docs/v2/MediaSets/models/WaveformOperation.md) | `from foundry_sdk.v2.media_sets.models import WaveformOperation` | **MediaSets** | [WavEncodeFormat](docs/v2/MediaSets/models/WavEncodeFormat.md) | `from foundry_sdk.v2.media_sets.models import WavEncodeFormat` | **MediaSets** | [WebpFormat](docs/v2/MediaSets/models/WebpFormat.md) | `from foundry_sdk.v2.media_sets.models import WebpFormat` | -**Models** | [BooleanParameter](docs/v2/Models/models/BooleanParameter.md) | `from foundry_sdk.v2.models.models import BooleanParameter` | -**Models** | [ChangelogTooLongError](docs/v2/Models/models/ChangelogTooLongError.md) | `from foundry_sdk.v2.models.models import ChangelogTooLongError` | -**Models** | [ColumnTypeSpecId](docs/v2/Models/models/ColumnTypeSpecId.md) | `from foundry_sdk.v2.models.models import ColumnTypeSpecId` | -**Models** | [CreateConfigValidationFailureReason](docs/v2/Models/models/CreateConfigValidationFailureReason.md) | `from foundry_sdk.v2.models.models import CreateConfigValidationFailureReason` | -**Models** | [CreateLiveDeploymentRequest](docs/v2/Models/models/CreateLiveDeploymentRequest.md) | `from foundry_sdk.v2.models.models import CreateLiveDeploymentRequest` | -**Models** | [CreateLiveDeploymentTarget](docs/v2/Models/models/CreateLiveDeploymentTarget.md) | `from foundry_sdk.v2.models.models import CreateLiveDeploymentTarget` | -**Models** | [CreateModelFunctionRequest](docs/v2/Models/models/CreateModelFunctionRequest.md) | `from foundry_sdk.v2.models.models import CreateModelFunctionRequest` | **Models** | [CreateModelRequest](docs/v2/Models/models/CreateModelRequest.md) | `from foundry_sdk.v2.models.models import CreateModelRequest` | -**Models** | [CreateModelStudioConfigVersionRequest](docs/v2/Models/models/CreateModelStudioConfigVersionRequest.md) | `from foundry_sdk.v2.models.models import CreateModelStudioConfigVersionRequest` | -**Models** | [CreateModelStudioRequest](docs/v2/Models/models/CreateModelStudioRequest.md) | `from foundry_sdk.v2.models.models import CreateModelStudioRequest` | **Models** | [CreateModelVersionRequest](docs/v2/Models/models/CreateModelVersionRequest.md) | `from foundry_sdk.v2.models.models import CreateModelVersionRequest` | -**Models** | [DatasetInput](docs/v2/Models/models/DatasetInput.md) | `from foundry_sdk.v2.models.models import DatasetInput` | -**Models** | [DatasetSchemaNotFoundError](docs/v2/Models/models/DatasetSchemaNotFoundError.md) | `from foundry_sdk.v2.models.models import DatasetSchemaNotFoundError` | -**Models** | [DatetimeParameter](docs/v2/Models/models/DatetimeParameter.md) | `from foundry_sdk.v2.models.models import DatetimeParameter` | **Models** | [DillModelFiles](docs/v2/Models/models/DillModelFiles.md) | `from foundry_sdk.v2.models.models import DillModelFiles` | -**Models** | [DirectCreateLiveDeploymentTarget](docs/v2/Models/models/DirectCreateLiveDeploymentTarget.md) | `from foundry_sdk.v2.models.models import DirectCreateLiveDeploymentTarget` | -**Models** | [DoubleParameter](docs/v2/Models/models/DoubleParameter.md) | `from foundry_sdk.v2.models.models import DoubleParameter` | -**Models** | [DoubleSeriesAggregations](docs/v2/Models/models/DoubleSeriesAggregations.md) | `from foundry_sdk.v2.models.models import DoubleSeriesAggregations` | -**Models** | [DoubleSeriesV1](docs/v2/Models/models/DoubleSeriesV1.md) | `from foundry_sdk.v2.models.models import DoubleSeriesV1` | -**Models** | [DoubleSeriesValueV1](docs/v2/Models/models/DoubleSeriesValueV1.md) | `from foundry_sdk.v2.models.models import DoubleSeriesValueV1` | -**Models** | [EpochMillis](docs/v2/Models/models/EpochMillis.md) | `from foundry_sdk.v2.models.models import EpochMillis` | -**Models** | [Experiment](docs/v2/Models/models/Experiment.md) | `from foundry_sdk.v2.models.models import Experiment` | -**Models** | [ExperimentArtifactDetails](docs/v2/Models/models/ExperimentArtifactDetails.md) | `from foundry_sdk.v2.models.models import ExperimentArtifactDetails` | -**Models** | [ExperimentArtifactMetadata](docs/v2/Models/models/ExperimentArtifactMetadata.md) | `from foundry_sdk.v2.models.models import ExperimentArtifactMetadata` | -**Models** | [ExperimentArtifactName](docs/v2/Models/models/ExperimentArtifactName.md) | `from foundry_sdk.v2.models.models import ExperimentArtifactName` | -**Models** | [ExperimentAuthoringSource](docs/v2/Models/models/ExperimentAuthoringSource.md) | `from foundry_sdk.v2.models.models import ExperimentAuthoringSource` | -**Models** | [ExperimentBranch](docs/v2/Models/models/ExperimentBranch.md) | `from foundry_sdk.v2.models.models import ExperimentBranch` | -**Models** | [ExperimentCodeWorkspaceSource](docs/v2/Models/models/ExperimentCodeWorkspaceSource.md) | `from foundry_sdk.v2.models.models import ExperimentCodeWorkspaceSource` | -**Models** | [ExperimentRid](docs/v2/Models/models/ExperimentRid.md) | `from foundry_sdk.v2.models.models import ExperimentRid` | -**Models** | [ExperimentSdkSource](docs/v2/Models/models/ExperimentSdkSource.md) | `from foundry_sdk.v2.models.models import ExperimentSdkSource` | -**Models** | [ExperimentSource](docs/v2/Models/models/ExperimentSource.md) | `from foundry_sdk.v2.models.models import ExperimentSource` | -**Models** | [ExperimentStatus](docs/v2/Models/models/ExperimentStatus.md) | `from foundry_sdk.v2.models.models import ExperimentStatus` | -**Models** | [ExperimentTagText](docs/v2/Models/models/ExperimentTagText.md) | `from foundry_sdk.v2.models.models import ExperimentTagText` | -**Models** | [FieldValidationError](docs/v2/Models/models/FieldValidationError.md) | `from foundry_sdk.v2.models.models import FieldValidationError` | -**Models** | [GpuType](docs/v2/Models/models/GpuType.md) | `from foundry_sdk.v2.models.models import GpuType` | -**Models** | [InconsistentArrayDimensionsError](docs/v2/Models/models/InconsistentArrayDimensionsError.md) | `from foundry_sdk.v2.models.models import InconsistentArrayDimensionsError` | -**Models** | [InferenceInputErrorType](docs/v2/Models/models/InferenceInputErrorType.md) | `from foundry_sdk.v2.models.models import InferenceInputErrorType` | -**Models** | [InputAlias](docs/v2/Models/models/InputAlias.md) | `from foundry_sdk.v2.models.models import InputAlias` | -**Models** | [IntegerParameter](docs/v2/Models/models/IntegerParameter.md) | `from foundry_sdk.v2.models.models import IntegerParameter` | -**Models** | [InvalidArrayShapeError](docs/v2/Models/models/InvalidArrayShapeError.md) | `from foundry_sdk.v2.models.models import InvalidArrayShapeError` | -**Models** | [InvalidMapFormatError](docs/v2/Models/models/InvalidMapFormatError.md) | `from foundry_sdk.v2.models.models import InvalidMapFormatError` | -**Models** | [InvalidResourceConfigurationError](docs/v2/Models/models/InvalidResourceConfigurationError.md) | `from foundry_sdk.v2.models.models import InvalidResourceConfigurationError` | -**Models** | [InvalidTabularFormatError](docs/v2/Models/models/InvalidTabularFormatError.md) | `from foundry_sdk.v2.models.models import InvalidTabularFormatError` | -**Models** | [JsonSchemaValidationError](docs/v2/Models/models/JsonSchemaValidationError.md) | `from foundry_sdk.v2.models.models import JsonSchemaValidationError` | -**Models** | [ListModelStudioConfigVersionsResponse](docs/v2/Models/models/ListModelStudioConfigVersionsResponse.md) | `from foundry_sdk.v2.models.models import ListModelStudioConfigVersionsResponse` | -**Models** | [ListModelStudioRunsResponse](docs/v2/Models/models/ListModelStudioRunsResponse.md) | `from foundry_sdk.v2.models.models import ListModelStudioRunsResponse` | -**Models** | [ListModelStudioTrainersResponse](docs/v2/Models/models/ListModelStudioTrainersResponse.md) | `from foundry_sdk.v2.models.models import ListModelStudioTrainersResponse` | **Models** | [ListModelVersionsResponse](docs/v2/Models/models/ListModelVersionsResponse.md) | `from foundry_sdk.v2.models.models import ListModelVersionsResponse` | -**Models** | [LiveDeployment](docs/v2/Models/models/LiveDeployment.md) | `from foundry_sdk.v2.models.models import LiveDeployment` | -**Models** | [LiveDeploymentGpu](docs/v2/Models/models/LiveDeploymentGpu.md) | `from foundry_sdk.v2.models.models import LiveDeploymentGpu` | -**Models** | [LiveDeploymentModelVersion](docs/v2/Models/models/LiveDeploymentModelVersion.md) | `from foundry_sdk.v2.models.models import LiveDeploymentModelVersion` | -**Models** | [LiveDeploymentRid](docs/v2/Models/models/LiveDeploymentRid.md) | `from foundry_sdk.v2.models.models import LiveDeploymentRid` | -**Models** | [LiveDeploymentRuntimeConfiguration](docs/v2/Models/models/LiveDeploymentRuntimeConfiguration.md) | `from foundry_sdk.v2.models.models import LiveDeploymentRuntimeConfiguration` | -**Models** | [LiveDeploymentScalingConfiguration](docs/v2/Models/models/LiveDeploymentScalingConfiguration.md) | `from foundry_sdk.v2.models.models import LiveDeploymentScalingConfiguration` | -**Models** | [LiveDeploymentState](docs/v2/Models/models/LiveDeploymentState.md) | `from foundry_sdk.v2.models.models import LiveDeploymentState` | -**Models** | [LiveDeploymentStatus](docs/v2/Models/models/LiveDeploymentStatus.md) | `from foundry_sdk.v2.models.models import LiveDeploymentStatus` | -**Models** | [MissingRequiredDatasetColumnError](docs/v2/Models/models/MissingRequiredDatasetColumnError.md) | `from foundry_sdk.v2.models.models import MissingRequiredDatasetColumnError` | -**Models** | [MissingWorkerConfigInputDatasetColumnMappingError](docs/v2/Models/models/MissingWorkerConfigInputDatasetColumnMappingError.md) | `from foundry_sdk.v2.models.models import MissingWorkerConfigInputDatasetColumnMappingError` | -**Models** | [MissingWorkerConfigInputError](docs/v2/Models/models/MissingWorkerConfigInputError.md) | `from foundry_sdk.v2.models.models import MissingWorkerConfigInputError` | -**Models** | [MissingWorkerConfigInputObjectSetPropertyMappingError](docs/v2/Models/models/MissingWorkerConfigInputObjectSetPropertyMappingError.md) | `from foundry_sdk.v2.models.models import MissingWorkerConfigInputObjectSetPropertyMappingError` | -**Models** | [MissingWorkerConfigOutputError](docs/v2/Models/models/MissingWorkerConfigOutputError.md) | `from foundry_sdk.v2.models.models import MissingWorkerConfigOutputError` | **Models** | [Model](docs/v2/Models/models/Model.md) | `from foundry_sdk.v2.models.models import Model` | **Models** | [ModelApi](docs/v2/Models/models/ModelApi.md) | `from foundry_sdk.v2.models.models import ModelApi` | **Models** | [ModelApiAnyType](docs/v2/Models/models/ModelApiAnyType.md) | `from foundry_sdk.v2.models.models import ModelApiAnyType` | @@ -2197,98 +2030,10 @@ Namespace | Name | Import | **Models** | [ModelApiTabularFormat](docs/v2/Models/models/ModelApiTabularFormat.md) | `from foundry_sdk.v2.models.models import ModelApiTabularFormat` | **Models** | [ModelApiTabularType](docs/v2/Models/models/ModelApiTabularType.md) | `from foundry_sdk.v2.models.models import ModelApiTabularType` | **Models** | [ModelFiles](docs/v2/Models/models/ModelFiles.md) | `from foundry_sdk.v2.models.models import ModelFiles` | -**Models** | [ModelFunction](docs/v2/Models/models/ModelFunction.md) | `from foundry_sdk.v2.models.models import ModelFunction` | -**Models** | [ModelFunctionApiName](docs/v2/Models/models/ModelFunctionApiName.md) | `from foundry_sdk.v2.models.models import ModelFunctionApiName` | -**Models** | [ModelFunctionDisplayName](docs/v2/Models/models/ModelFunctionDisplayName.md) | `from foundry_sdk.v2.models.models import ModelFunctionDisplayName` | -**Models** | [ModelFunctionFunctionRid](docs/v2/Models/models/ModelFunctionFunctionRid.md) | `from foundry_sdk.v2.models.models import ModelFunctionFunctionRid` | -**Models** | [ModelFunctionFunctionVersion](docs/v2/Models/models/ModelFunctionFunctionVersion.md) | `from foundry_sdk.v2.models.models import ModelFunctionFunctionVersion` | -**Models** | [ModelFunctionIsRowWise](docs/v2/Models/models/ModelFunctionIsRowWise.md) | `from foundry_sdk.v2.models.models import ModelFunctionIsRowWise` | **Models** | [ModelName](docs/v2/Models/models/ModelName.md) | `from foundry_sdk.v2.models.models import ModelName` | -**Models** | [ModelOutput](docs/v2/Models/models/ModelOutput.md) | `from foundry_sdk.v2.models.models import ModelOutput` | **Models** | [ModelRid](docs/v2/Models/models/ModelRid.md) | `from foundry_sdk.v2.models.models import ModelRid` | -**Models** | [ModelStudio](docs/v2/Models/models/ModelStudio.md) | `from foundry_sdk.v2.models.models import ModelStudio` | -**Models** | [ModelStudioConfigVersion](docs/v2/Models/models/ModelStudioConfigVersion.md) | `from foundry_sdk.v2.models.models import ModelStudioConfigVersion` | -**Models** | [ModelStudioConfigVersionName](docs/v2/Models/models/ModelStudioConfigVersionName.md) | `from foundry_sdk.v2.models.models import ModelStudioConfigVersionName` | -**Models** | [ModelStudioConfigVersionNumber](docs/v2/Models/models/ModelStudioConfigVersionNumber.md) | `from foundry_sdk.v2.models.models import ModelStudioConfigVersionNumber` | -**Models** | [ModelStudioInput](docs/v2/Models/models/ModelStudioInput.md) | `from foundry_sdk.v2.models.models import ModelStudioInput` | -**Models** | [ModelStudioOutput](docs/v2/Models/models/ModelStudioOutput.md) | `from foundry_sdk.v2.models.models import ModelStudioOutput` | -**Models** | [ModelStudioRid](docs/v2/Models/models/ModelStudioRid.md) | `from foundry_sdk.v2.models.models import ModelStudioRid` | -**Models** | [ModelStudioRun](docs/v2/Models/models/ModelStudioRun.md) | `from foundry_sdk.v2.models.models import ModelStudioRun` | -**Models** | [ModelStudioRunBuildRid](docs/v2/Models/models/ModelStudioRunBuildRid.md) | `from foundry_sdk.v2.models.models import ModelStudioRunBuildRid` | -**Models** | [ModelStudioRunJobRid](docs/v2/Models/models/ModelStudioRunJobRid.md) | `from foundry_sdk.v2.models.models import ModelStudioRunJobRid` | -**Models** | [ModelStudioRunModelOutput](docs/v2/Models/models/ModelStudioRunModelOutput.md) | `from foundry_sdk.v2.models.models import ModelStudioRunModelOutput` | -**Models** | [ModelStudioRunOutput](docs/v2/Models/models/ModelStudioRunOutput.md) | `from foundry_sdk.v2.models.models import ModelStudioRunOutput` | -**Models** | [ModelStudioTrainer](docs/v2/Models/models/ModelStudioTrainer.md) | `from foundry_sdk.v2.models.models import ModelStudioTrainer` | -**Models** | [ModelStudioTrainerExperimental](docs/v2/Models/models/ModelStudioTrainerExperimental.md) | `from foundry_sdk.v2.models.models import ModelStudioTrainerExperimental` | -**Models** | [ModelStudioWorkerConfig](docs/v2/Models/models/ModelStudioWorkerConfig.md) | `from foundry_sdk.v2.models.models import ModelStudioWorkerConfig` | **Models** | [ModelVersion](docs/v2/Models/models/ModelVersion.md) | `from foundry_sdk.v2.models.models import ModelVersion` | -**Models** | [ModelVersionCodeRepositorySource](docs/v2/Models/models/ModelVersionCodeRepositorySource.md) | `from foundry_sdk.v2.models.models import ModelVersionCodeRepositorySource` | -**Models** | [ModelVersionCodeWorkspaceSource](docs/v2/Models/models/ModelVersionCodeWorkspaceSource.md) | `from foundry_sdk.v2.models.models import ModelVersionCodeWorkspaceSource` | -**Models** | [ModelVersionContainerizedSource](docs/v2/Models/models/ModelVersionContainerizedSource.md) | `from foundry_sdk.v2.models.models import ModelVersionContainerizedSource` | -**Models** | [ModelVersionExternalSource](docs/v2/Models/models/ModelVersionExternalSource.md) | `from foundry_sdk.v2.models.models import ModelVersionExternalSource` | -**Models** | [ModelVersionModelStudioSource](docs/v2/Models/models/ModelVersionModelStudioSource.md) | `from foundry_sdk.v2.models.models import ModelVersionModelStudioSource` | -**Models** | [ModelVersionPromotedSource](docs/v2/Models/models/ModelVersionPromotedSource.md) | `from foundry_sdk.v2.models.models import ModelVersionPromotedSource` | **Models** | [ModelVersionRid](docs/v2/Models/models/ModelVersionRid.md) | `from foundry_sdk.v2.models.models import ModelVersionRid` | -**Models** | [ModelVersionSdkSource](docs/v2/Models/models/ModelVersionSdkSource.md) | `from foundry_sdk.v2.models.models import ModelVersionSdkSource` | -**Models** | [ModelVersionSource](docs/v2/Models/models/ModelVersionSource.md) | `from foundry_sdk.v2.models.models import ModelVersionSource` | -**Models** | [MultipleColumnsNotAllowedForTrainerError](docs/v2/Models/models/MultipleColumnsNotAllowedForTrainerError.md) | `from foundry_sdk.v2.models.models import MultipleColumnsNotAllowedForTrainerError` | -**Models** | [MultiplePropertiesNotAllowedForTrainerError](docs/v2/Models/models/MultiplePropertiesNotAllowedForTrainerError.md) | `from foundry_sdk.v2.models.models import MultiplePropertiesNotAllowedForTrainerError` | -**Models** | [OtherValidationError](docs/v2/Models/models/OtherValidationError.md) | `from foundry_sdk.v2.models.models import OtherValidationError` | -**Models** | [OutputAlias](docs/v2/Models/models/OutputAlias.md) | `from foundry_sdk.v2.models.models import OutputAlias` | -**Models** | [OutputResourceInDifferentProjectError](docs/v2/Models/models/OutputResourceInDifferentProjectError.md) | `from foundry_sdk.v2.models.models import OutputResourceInDifferentProjectError` | -**Models** | [OutputResourceNotFoundError](docs/v2/Models/models/OutputResourceNotFoundError.md) | `from foundry_sdk.v2.models.models import OutputResourceNotFoundError` | -**Models** | [Parameter](docs/v2/Models/models/Parameter.md) | `from foundry_sdk.v2.models.models import Parameter` | -**Models** | [ParameterName](docs/v2/Models/models/ParameterName.md) | `from foundry_sdk.v2.models.models import ParameterName` | -**Models** | [ParameterValue](docs/v2/Models/models/ParameterValue.md) | `from foundry_sdk.v2.models.models import ParameterValue` | -**Models** | [PromoteVersionModelRequest](docs/v2/Models/models/PromoteVersionModelRequest.md) | `from foundry_sdk.v2.models.models import PromoteVersionModelRequest` | -**Models** | [ReplaceLiveDeploymentRequest](docs/v2/Models/models/ReplaceLiveDeploymentRequest.md) | `from foundry_sdk.v2.models.models import ReplaceLiveDeploymentRequest` | -**Models** | [ReplaceModelFunctionRequest](docs/v2/Models/models/ReplaceModelFunctionRequest.md) | `from foundry_sdk.v2.models.models import ReplaceModelFunctionRequest` | -**Models** | [RequiredValueMissingError](docs/v2/Models/models/RequiredValueMissingError.md) | `from foundry_sdk.v2.models.models import RequiredValueMissingError` | -**Models** | [ResourceConfiguration](docs/v2/Models/models/ResourceConfiguration.md) | `from foundry_sdk.v2.models.models import ResourceConfiguration` | -**Models** | [RunId](docs/v2/Models/models/RunId.md) | `from foundry_sdk.v2.models.models import RunId` | -**Models** | [SearchExperimentsAndFilter](docs/v2/Models/models/SearchExperimentsAndFilter.md) | `from foundry_sdk.v2.models.models import SearchExperimentsAndFilter` | -**Models** | [SearchExperimentsContainsFilter](docs/v2/Models/models/SearchExperimentsContainsFilter.md) | `from foundry_sdk.v2.models.models import SearchExperimentsContainsFilter` | -**Models** | [SearchExperimentsContainsFilterField](docs/v2/Models/models/SearchExperimentsContainsFilterField.md) | `from foundry_sdk.v2.models.models import SearchExperimentsContainsFilterField` | -**Models** | [SearchExperimentsEqualsFilter](docs/v2/Models/models/SearchExperimentsEqualsFilter.md) | `from foundry_sdk.v2.models.models import SearchExperimentsEqualsFilter` | -**Models** | [SearchExperimentsEqualsFilterField](docs/v2/Models/models/SearchExperimentsEqualsFilterField.md) | `from foundry_sdk.v2.models.models import SearchExperimentsEqualsFilterField` | -**Models** | [SearchExperimentsFilter](docs/v2/Models/models/SearchExperimentsFilter.md) | `from foundry_sdk.v2.models.models import SearchExperimentsFilter` | -**Models** | [SearchExperimentsNotFilter](docs/v2/Models/models/SearchExperimentsNotFilter.md) | `from foundry_sdk.v2.models.models import SearchExperimentsNotFilter` | -**Models** | [SearchExperimentsNumericFilterOperator](docs/v2/Models/models/SearchExperimentsNumericFilterOperator.md) | `from foundry_sdk.v2.models.models import SearchExperimentsNumericFilterOperator` | -**Models** | [SearchExperimentsOrderBy](docs/v2/Models/models/SearchExperimentsOrderBy.md) | `from foundry_sdk.v2.models.models import SearchExperimentsOrderBy` | -**Models** | [SearchExperimentsOrderByField](docs/v2/Models/models/SearchExperimentsOrderByField.md) | `from foundry_sdk.v2.models.models import SearchExperimentsOrderByField` | -**Models** | [SearchExperimentsOrFilter](docs/v2/Models/models/SearchExperimentsOrFilter.md) | `from foundry_sdk.v2.models.models import SearchExperimentsOrFilter` | -**Models** | [SearchExperimentsParameterFilter](docs/v2/Models/models/SearchExperimentsParameterFilter.md) | `from foundry_sdk.v2.models.models import SearchExperimentsParameterFilter` | -**Models** | [SearchExperimentsParameterFilterOperator](docs/v2/Models/models/SearchExperimentsParameterFilterOperator.md) | `from foundry_sdk.v2.models.models import SearchExperimentsParameterFilterOperator` | -**Models** | [SearchExperimentsRequest](docs/v2/Models/models/SearchExperimentsRequest.md) | `from foundry_sdk.v2.models.models import SearchExperimentsRequest` | -**Models** | [SearchExperimentsResponse](docs/v2/Models/models/SearchExperimentsResponse.md) | `from foundry_sdk.v2.models.models import SearchExperimentsResponse` | -**Models** | [SearchExperimentsSeriesFilter](docs/v2/Models/models/SearchExperimentsSeriesFilter.md) | `from foundry_sdk.v2.models.models import SearchExperimentsSeriesFilter` | -**Models** | [SearchExperimentsSeriesFilterField](docs/v2/Models/models/SearchExperimentsSeriesFilterField.md) | `from foundry_sdk.v2.models.models import SearchExperimentsSeriesFilterField` | -**Models** | [SearchExperimentsStartsWithFilter](docs/v2/Models/models/SearchExperimentsStartsWithFilter.md) | `from foundry_sdk.v2.models.models import SearchExperimentsStartsWithFilter` | -**Models** | [SearchExperimentsStartsWithFilterField](docs/v2/Models/models/SearchExperimentsStartsWithFilterField.md) | `from foundry_sdk.v2.models.models import SearchExperimentsStartsWithFilterField` | -**Models** | [SearchExperimentsSummaryMetricFilter](docs/v2/Models/models/SearchExperimentsSummaryMetricFilter.md) | `from foundry_sdk.v2.models.models import SearchExperimentsSummaryMetricFilter` | -**Models** | [Series](docs/v2/Models/models/Series.md) | `from foundry_sdk.v2.models.models import Series` | -**Models** | [SeriesAggregations](docs/v2/Models/models/SeriesAggregations.md) | `from foundry_sdk.v2.models.models import SeriesAggregations` | -**Models** | [SeriesAggregationsValue](docs/v2/Models/models/SeriesAggregationsValue.md) | `from foundry_sdk.v2.models.models import SeriesAggregationsValue` | -**Models** | [SeriesName](docs/v2/Models/models/SeriesName.md) | `from foundry_sdk.v2.models.models import SeriesName` | -**Models** | [StringParameter](docs/v2/Models/models/StringParameter.md) | `from foundry_sdk.v2.models.models import StringParameter` | -**Models** | [SummaryMetric](docs/v2/Models/models/SummaryMetric.md) | `from foundry_sdk.v2.models.models import SummaryMetric` | -**Models** | [SummaryMetricAggregation](docs/v2/Models/models/SummaryMetricAggregation.md) | `from foundry_sdk.v2.models.models import SummaryMetricAggregation` | -**Models** | [TableArtifactDetails](docs/v2/Models/models/TableArtifactDetails.md) | `from foundry_sdk.v2.models.models import TableArtifactDetails` | -**Models** | [TrainerDescription](docs/v2/Models/models/TrainerDescription.md) | `from foundry_sdk.v2.models.models import TrainerDescription` | -**Models** | [TrainerId](docs/v2/Models/models/TrainerId.md) | `from foundry_sdk.v2.models.models import TrainerId` | -**Models** | [TrainerInputsSpecification](docs/v2/Models/models/TrainerInputsSpecification.md) | `from foundry_sdk.v2.models.models import TrainerInputsSpecification` | -**Models** | [TrainerName](docs/v2/Models/models/TrainerName.md) | `from foundry_sdk.v2.models.models import TrainerName` | -**Models** | [TrainerOutputsSpecification](docs/v2/Models/models/TrainerOutputsSpecification.md) | `from foundry_sdk.v2.models.models import TrainerOutputsSpecification` | -**Models** | [TrainerSchemaDefinition](docs/v2/Models/models/TrainerSchemaDefinition.md) | `from foundry_sdk.v2.models.models import TrainerSchemaDefinition` | -**Models** | [TrainerType](docs/v2/Models/models/TrainerType.md) | `from foundry_sdk.v2.models.models import TrainerType` | -**Models** | [TrainerVersion](docs/v2/Models/models/TrainerVersion.md) | `from foundry_sdk.v2.models.models import TrainerVersion` | -**Models** | [TrainerVersionLocator](docs/v2/Models/models/TrainerVersionLocator.md) | `from foundry_sdk.v2.models.models import TrainerVersionLocator` | -**Models** | [TransformJsonLiveDeploymentRequest](docs/v2/Models/models/TransformJsonLiveDeploymentRequest.md) | `from foundry_sdk.v2.models.models import TransformJsonLiveDeploymentRequest` | -**Models** | [TransformLiveDeploymentResponse](docs/v2/Models/models/TransformLiveDeploymentResponse.md) | `from foundry_sdk.v2.models.models import TransformLiveDeploymentResponse` | -**Models** | [TypeMismatchError](docs/v2/Models/models/TypeMismatchError.md) | `from foundry_sdk.v2.models.models import TypeMismatchError` | -**Models** | [UnknownColumnSpecIdInConfigColumnMappingError](docs/v2/Models/models/UnknownColumnSpecIdInConfigColumnMappingError.md) | `from foundry_sdk.v2.models.models import UnknownColumnSpecIdInConfigColumnMappingError` | -**Models** | [UnknownInputNameError](docs/v2/Models/models/UnknownInputNameError.md) | `from foundry_sdk.v2.models.models import UnknownInputNameError` | -**Models** | [UnsupportedTypeError](docs/v2/Models/models/UnsupportedTypeError.md) | `from foundry_sdk.v2.models.models import UnsupportedTypeError` | **Ontologies** | [AbsoluteTimeRange](docs/v2/Ontologies/models/AbsoluteTimeRange.md) | `from foundry_sdk.v2.ontologies.models import AbsoluteTimeRange` | **Ontologies** | [AbsoluteValuePropertyExpression](docs/v2/Ontologies/models/AbsoluteValuePropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import AbsoluteValuePropertyExpression` | **Ontologies** | [ActionExecutionTime](docs/v2/Ontologies/models/ActionExecutionTime.md) | `from foundry_sdk.v2.ontologies.models import ActionExecutionTime` | @@ -2421,10 +2166,9 @@ Namespace | Name | Import | **Ontologies** | [DurationFormatStyle](docs/v2/Ontologies/models/DurationFormatStyle.md) | `from foundry_sdk.v2.ontologies.models import DurationFormatStyle` | **Ontologies** | [DurationPrecision](docs/v2/Ontologies/models/DurationPrecision.md) | `from foundry_sdk.v2.ontologies.models import DurationPrecision` | **Ontologies** | [EditHistoryEdit](docs/v2/Ontologies/models/EditHistoryEdit.md) | `from foundry_sdk.v2.ontologies.models import EditHistoryEdit` | -**Ontologies** | [EditsHistoryFilter](docs/v2/Ontologies/models/EditsHistoryFilter.md) | `from foundry_sdk.v2.ontologies.models import EditsHistoryFilter` | -**Ontologies** | [EditsHistoryOperationIdsFilter](docs/v2/Ontologies/models/EditsHistoryOperationIdsFilter.md) | `from foundry_sdk.v2.ontologies.models import EditsHistoryOperationIdsFilter` | +**Ontologies** | [EditsHistoryFilters](docs/v2/Ontologies/models/EditsHistoryFilters.md) | `from foundry_sdk.v2.ontologies.models import EditsHistoryFilters` | **Ontologies** | [EditsHistorySortOrder](docs/v2/Ontologies/models/EditsHistorySortOrder.md) | `from foundry_sdk.v2.ontologies.models import EditsHistorySortOrder` | -**Ontologies** | [EditsHistoryTimestampFilter](docs/v2/Ontologies/models/EditsHistoryTimestampFilter.md) | `from foundry_sdk.v2.ontologies.models import EditsHistoryTimestampFilter` | +**Ontologies** | [EditTypeFilter](docs/v2/Ontologies/models/EditTypeFilter.md) | `from foundry_sdk.v2.ontologies.models import EditTypeFilter` | **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` | @@ -2445,22 +2189,9 @@ Namespace | Name | Import | **Ontologies** | [FunctionParameterName](docs/v2/Ontologies/models/FunctionParameterName.md) | `from foundry_sdk.v2.ontologies.models import FunctionParameterName` | **Ontologies** | [FunctionRid](docs/v2/Ontologies/models/FunctionRid.md) | `from foundry_sdk.v2.ontologies.models import FunctionRid` | **Ontologies** | [FunctionVersion](docs/v2/Ontologies/models/FunctionVersion.md) | `from foundry_sdk.v2.ontologies.models import FunctionVersion` | -**Ontologies** | [FuzzyRule](docs/v2/Ontologies/models/FuzzyRule.md) | `from foundry_sdk.v2.ontologies.models import FuzzyRule` | **Ontologies** | [FuzzyV2](docs/v2/Ontologies/models/FuzzyV2.md) | `from foundry_sdk.v2.ontologies.models import FuzzyV2` | -**Ontologies** | [GeoJsonString](docs/v2/Ontologies/models/GeoJsonString.md) | `from foundry_sdk.v2.ontologies.models import GeoJsonString` | -**Ontologies** | [GeoShapeV2Geometry](docs/v2/Ontologies/models/GeoShapeV2Geometry.md) | `from foundry_sdk.v2.ontologies.models import GeoShapeV2Geometry` | -**Ontologies** | [GeoShapeV2Query](docs/v2/Ontologies/models/GeoShapeV2Query.md) | `from foundry_sdk.v2.ontologies.models import GeoShapeV2Query` | **Ontologies** | [GeotemporalSeriesEntry](docs/v2/Ontologies/models/GeotemporalSeriesEntry.md) | `from foundry_sdk.v2.ontologies.models import GeotemporalSeriesEntry` | **Ontologies** | [GeotimeSeriesValue](docs/v2/Ontologies/models/GeotimeSeriesValue.md) | `from foundry_sdk.v2.ontologies.models import GeotimeSeriesValue` | -**Ontologies** | [GetActionTypeByRidBatchRequest](docs/v2/Ontologies/models/GetActionTypeByRidBatchRequest.md) | `from foundry_sdk.v2.ontologies.models import GetActionTypeByRidBatchRequest` | -**Ontologies** | [GetActionTypeByRidBatchRequestElement](docs/v2/Ontologies/models/GetActionTypeByRidBatchRequestElement.md) | `from foundry_sdk.v2.ontologies.models import GetActionTypeByRidBatchRequestElement` | -**Ontologies** | [GetActionTypeByRidBatchResponse](docs/v2/Ontologies/models/GetActionTypeByRidBatchResponse.md) | `from foundry_sdk.v2.ontologies.models import GetActionTypeByRidBatchResponse` | -**Ontologies** | [GetObjectTypeByRidBatchRequest](docs/v2/Ontologies/models/GetObjectTypeByRidBatchRequest.md) | `from foundry_sdk.v2.ontologies.models import GetObjectTypeByRidBatchRequest` | -**Ontologies** | [GetObjectTypeByRidBatchRequestElement](docs/v2/Ontologies/models/GetObjectTypeByRidBatchRequestElement.md) | `from foundry_sdk.v2.ontologies.models import GetObjectTypeByRidBatchRequestElement` | -**Ontologies** | [GetObjectTypeByRidBatchResponse](docs/v2/Ontologies/models/GetObjectTypeByRidBatchResponse.md) | `from foundry_sdk.v2.ontologies.models import GetObjectTypeByRidBatchResponse` | -**Ontologies** | [GetOutgoingLinkTypesByObjectTypeRidBatchRequest](docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchRequest.md) | `from foundry_sdk.v2.ontologies.models import GetOutgoingLinkTypesByObjectTypeRidBatchRequest` | -**Ontologies** | [GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement](docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement.md) | `from foundry_sdk.v2.ontologies.models import GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement` | -**Ontologies** | [GetOutgoingLinkTypesByObjectTypeRidBatchResponse](docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchResponse.md) | `from foundry_sdk.v2.ontologies.models import GetOutgoingLinkTypesByObjectTypeRidBatchResponse` | **Ontologies** | [GetSelectedPropertyOperation](docs/v2/Ontologies/models/GetSelectedPropertyOperation.md) | `from foundry_sdk.v2.ontologies.models import GetSelectedPropertyOperation` | **Ontologies** | [GreatestPropertyExpression](docs/v2/Ontologies/models/GreatestPropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import GreatestPropertyExpression` | **Ontologies** | [GroupMemberConstraint](docs/v2/Ontologies/models/GroupMemberConstraint.md) | `from foundry_sdk.v2.ontologies.models import GroupMemberConstraint` | @@ -2705,7 +2436,6 @@ Namespace | Name | Import | **Ontologies** | [QueryStructType](docs/v2/Ontologies/models/QueryStructType.md) | `from foundry_sdk.v2.ontologies.models import QueryStructType` | **Ontologies** | [QueryThreeDimensionalAggregation](docs/v2/Ontologies/models/QueryThreeDimensionalAggregation.md) | `from foundry_sdk.v2.ontologies.models import QueryThreeDimensionalAggregation` | **Ontologies** | [QueryTwoDimensionalAggregation](docs/v2/Ontologies/models/QueryTwoDimensionalAggregation.md) | `from foundry_sdk.v2.ontologies.models import QueryTwoDimensionalAggregation` | -**Ontologies** | [QueryTypeReferenceType](docs/v2/Ontologies/models/QueryTypeReferenceType.md) | `from foundry_sdk.v2.ontologies.models import QueryTypeReferenceType` | **Ontologies** | [QueryTypeV2](docs/v2/Ontologies/models/QueryTypeV2.md) | `from foundry_sdk.v2.ontologies.models import QueryTypeV2` | **Ontologies** | [QueryUnionType](docs/v2/Ontologies/models/QueryUnionType.md) | `from foundry_sdk.v2.ontologies.models import QueryUnionType` | **Ontologies** | [RangeConstraint](docs/v2/Ontologies/models/RangeConstraint.md) | `from foundry_sdk.v2.ontologies.models import RangeConstraint` | @@ -2756,7 +2486,6 @@ Namespace | Name | Import | **Ontologies** | [SharedPropertyType](docs/v2/Ontologies/models/SharedPropertyType.md) | `from foundry_sdk.v2.ontologies.models import SharedPropertyType` | **Ontologies** | [SharedPropertyTypeApiName](docs/v2/Ontologies/models/SharedPropertyTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import SharedPropertyTypeApiName` | **Ontologies** | [SharedPropertyTypeRid](docs/v2/Ontologies/models/SharedPropertyTypeRid.md) | `from foundry_sdk.v2.ontologies.models import SharedPropertyTypeRid` | -**Ontologies** | [SpatialFilterMode](docs/v2/Ontologies/models/SpatialFilterMode.md) | `from foundry_sdk.v2.ontologies.models import SpatialFilterMode` | **Ontologies** | [StartsWithQuery](docs/v2/Ontologies/models/StartsWithQuery.md) | `from foundry_sdk.v2.ontologies.models import StartsWithQuery` | **Ontologies** | [StaticArgument](docs/v2/Ontologies/models/StaticArgument.md) | `from foundry_sdk.v2.ontologies.models import StaticArgument` | **Ontologies** | [StreamGeotemporalSeriesValuesRequest](docs/v2/Ontologies/models/StreamGeotemporalSeriesValuesRequest.md) | `from foundry_sdk.v2.ontologies.models import StreamGeotemporalSeriesValuesRequest` | @@ -2810,7 +2539,6 @@ Namespace | Name | Import | **Ontologies** | [TransactionEdit](docs/v2/Ontologies/models/TransactionEdit.md) | `from foundry_sdk.v2.ontologies.models import TransactionEdit` | **Ontologies** | [TwoDimensionalAggregation](docs/v2/Ontologies/models/TwoDimensionalAggregation.md) | `from foundry_sdk.v2.ontologies.models import TwoDimensionalAggregation` | **Ontologies** | [TypeClass](docs/v2/Ontologies/models/TypeClass.md) | `from foundry_sdk.v2.ontologies.models import TypeClass` | -**Ontologies** | [TypeReferenceIdentifier](docs/v2/Ontologies/models/TypeReferenceIdentifier.md) | `from foundry_sdk.v2.ontologies.models import TypeReferenceIdentifier` | **Ontologies** | [UnevaluableConstraint](docs/v2/Ontologies/models/UnevaluableConstraint.md) | `from foundry_sdk.v2.ontologies.models import UnevaluableConstraint` | **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` | @@ -2928,77 +2656,29 @@ Namespace | Name | Import | **Orchestration** | [Trigger](docs/v2/Orchestration/models/Trigger.md) | `from foundry_sdk.v2.orchestration.models import Trigger` | **Orchestration** | [UpstreamTarget](docs/v2/Orchestration/models/UpstreamTarget.md) | `from foundry_sdk.v2.orchestration.models import UpstreamTarget` | **Orchestration** | [UserScope](docs/v2/Orchestration/models/UserScope.md) | `from foundry_sdk.v2.orchestration.models import UserScope` | -**SqlQueries** | [AnyColumnType](docs/v2/SqlQueries/models/AnyColumnType.md) | `from foundry_sdk.v2.sql_queries.models import AnyColumnType` | **SqlQueries** | [CanceledQueryStatus](docs/v2/SqlQueries/models/CanceledQueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import CanceledQueryStatus` | -**SqlQueries** | [ColumnType](docs/v2/SqlQueries/models/ColumnType.md) | `from foundry_sdk.v2.sql_queries.models import ColumnType` | -**SqlQueries** | [DecimalColumnType](docs/v2/SqlQueries/models/DecimalColumnType.md) | `from foundry_sdk.v2.sql_queries.models import DecimalColumnType` | -**SqlQueries** | [ExecuteOntologySqlQueryRequest](docs/v2/SqlQueries/models/ExecuteOntologySqlQueryRequest.md) | `from foundry_sdk.v2.sql_queries.models import ExecuteOntologySqlQueryRequest` | **SqlQueries** | [ExecuteSqlQueryRequest](docs/v2/SqlQueries/models/ExecuteSqlQueryRequest.md) | `from foundry_sdk.v2.sql_queries.models import ExecuteSqlQueryRequest` | **SqlQueries** | [FailedQueryStatus](docs/v2/SqlQueries/models/FailedQueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import FailedQueryStatus` | -**SqlQueries** | [ListColumnType](docs/v2/SqlQueries/models/ListColumnType.md) | `from foundry_sdk.v2.sql_queries.models import ListColumnType` | -**SqlQueries** | [MapColumnType](docs/v2/SqlQueries/models/MapColumnType.md) | `from foundry_sdk.v2.sql_queries.models import MapColumnType` | -**SqlQueries** | [MapParameterKey](docs/v2/SqlQueries/models/MapParameterKey.md) | `from foundry_sdk.v2.sql_queries.models import MapParameterKey` | -**SqlQueries** | [NamedParameterMapping](docs/v2/SqlQueries/models/NamedParameterMapping.md) | `from foundry_sdk.v2.sql_queries.models import NamedParameterMapping` | -**SqlQueries** | [ParameterAnyValue](docs/v2/SqlQueries/models/ParameterAnyValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterAnyValue` | -**SqlQueries** | [ParameterBooleanValue](docs/v2/SqlQueries/models/ParameterBooleanValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterBooleanValue` | -**SqlQueries** | [ParameterDateValue](docs/v2/SqlQueries/models/ParameterDateValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterDateValue` | -**SqlQueries** | [ParameterDecimalValue](docs/v2/SqlQueries/models/ParameterDecimalValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterDecimalValue` | -**SqlQueries** | [ParameterDoubleValue](docs/v2/SqlQueries/models/ParameterDoubleValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterDoubleValue` | -**SqlQueries** | [ParameterFloatValue](docs/v2/SqlQueries/models/ParameterFloatValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterFloatValue` | -**SqlQueries** | [ParameterIntegerValue](docs/v2/SqlQueries/models/ParameterIntegerValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterIntegerValue` | -**SqlQueries** | [ParameterListValue](docs/v2/SqlQueries/models/ParameterListValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterListValue` | -**SqlQueries** | [ParameterLongValue](docs/v2/SqlQueries/models/ParameterLongValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterLongValue` | -**SqlQueries** | [ParameterMapping](docs/v2/SqlQueries/models/ParameterMapping.md) | `from foundry_sdk.v2.sql_queries.models import ParameterMapping` | -**SqlQueries** | [ParameterMapValue](docs/v2/SqlQueries/models/ParameterMapValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterMapValue` | -**SqlQueries** | [ParameterName](docs/v2/SqlQueries/models/ParameterName.md) | `from foundry_sdk.v2.sql_queries.models import ParameterName` | -**SqlQueries** | [ParameterNullValue](docs/v2/SqlQueries/models/ParameterNullValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterNullValue` | -**SqlQueries** | [Parameters](docs/v2/SqlQueries/models/Parameters.md) | `from foundry_sdk.v2.sql_queries.models import Parameters` | -**SqlQueries** | [ParameterShortValue](docs/v2/SqlQueries/models/ParameterShortValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterShortValue` | -**SqlQueries** | [ParameterStringValue](docs/v2/SqlQueries/models/ParameterStringValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterStringValue` | -**SqlQueries** | [ParameterStructValue](docs/v2/SqlQueries/models/ParameterStructValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterStructValue` | -**SqlQueries** | [ParameterTimestampValue](docs/v2/SqlQueries/models/ParameterTimestampValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterTimestampValue` | -**SqlQueries** | [ParameterValue](docs/v2/SqlQueries/models/ParameterValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterValue` | **SqlQueries** | [QueryStatus](docs/v2/SqlQueries/models/QueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import QueryStatus` | **SqlQueries** | [RunningQueryStatus](docs/v2/SqlQueries/models/RunningQueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import RunningQueryStatus` | -**SqlQueries** | [SerializationFormat](docs/v2/SqlQueries/models/SerializationFormat.md) | `from foundry_sdk.v2.sql_queries.models import SerializationFormat` | **SqlQueries** | [SqlQueryId](docs/v2/SqlQueries/models/SqlQueryId.md) | `from foundry_sdk.v2.sql_queries.models import SqlQueryId` | -**SqlQueries** | [StructColumnFieldType](docs/v2/SqlQueries/models/StructColumnFieldType.md) | `from foundry_sdk.v2.sql_queries.models import StructColumnFieldType` | -**SqlQueries** | [StructColumnType](docs/v2/SqlQueries/models/StructColumnType.md) | `from foundry_sdk.v2.sql_queries.models import StructColumnType` | -**SqlQueries** | [StructElement](docs/v2/SqlQueries/models/StructElement.md) | `from foundry_sdk.v2.sql_queries.models import StructElement` | -**SqlQueries** | [StructElementName](docs/v2/SqlQueries/models/StructElementName.md) | `from foundry_sdk.v2.sql_queries.models import StructElementName` | -**SqlQueries** | [StructFieldKeyValue](docs/v2/SqlQueries/models/StructFieldKeyValue.md) | `from foundry_sdk.v2.sql_queries.models import StructFieldKeyValue` | -**SqlQueries** | [StructFieldRid](docs/v2/SqlQueries/models/StructFieldRid.md) | `from foundry_sdk.v2.sql_queries.models import StructFieldRid` | **SqlQueries** | [SucceededQueryStatus](docs/v2/SqlQueries/models/SucceededQueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import SucceededQueryStatus` | -**SqlQueries** | [UnnamedParameterValues](docs/v2/SqlQueries/models/UnnamedParameterValues.md) | `from foundry_sdk.v2.sql_queries.models import UnnamedParameterValues` | -**Streams** | [CommitSubscriberOffsetsRequest](docs/v2/Streams/models/CommitSubscriberOffsetsRequest.md) | `from foundry_sdk.v2.streams.models import CommitSubscriberOffsetsRequest` | **Streams** | [Compressed](docs/v2/Streams/models/Compressed.md) | `from foundry_sdk.v2.streams.models import Compressed` | **Streams** | [CreateStreamingDatasetRequest](docs/v2/Streams/models/CreateStreamingDatasetRequest.md) | `from foundry_sdk.v2.streams.models import CreateStreamingDatasetRequest` | **Streams** | [CreateStreamRequest](docs/v2/Streams/models/CreateStreamRequest.md) | `from foundry_sdk.v2.streams.models import CreateStreamRequest` | **Streams** | [CreateStreamRequestStreamSchema](docs/v2/Streams/models/CreateStreamRequestStreamSchema.md) | `from foundry_sdk.v2.streams.models import CreateStreamRequestStreamSchema` | -**Streams** | [CreateSubscriberRequest](docs/v2/Streams/models/CreateSubscriberRequest.md) | `from foundry_sdk.v2.streams.models import CreateSubscriberRequest` | **Streams** | [Dataset](docs/v2/Streams/models/Dataset.md) | `from foundry_sdk.v2.streams.models import Dataset` | -**Streams** | [EarliestPosition](docs/v2/Streams/models/EarliestPosition.md) | `from foundry_sdk.v2.streams.models import EarliestPosition` | **Streams** | [GetEndOffsetsResponse](docs/v2/Streams/models/GetEndOffsetsResponse.md) | `from foundry_sdk.v2.streams.models import GetEndOffsetsResponse` | **Streams** | [GetRecordsResponse](docs/v2/Streams/models/GetRecordsResponse.md) | `from foundry_sdk.v2.streams.models import GetRecordsResponse` | -**Streams** | [LatestPosition](docs/v2/Streams/models/LatestPosition.md) | `from foundry_sdk.v2.streams.models import LatestPosition` | **Streams** | [PartitionId](docs/v2/Streams/models/PartitionId.md) | `from foundry_sdk.v2.streams.models import PartitionId` | -**Streams** | [PartitionOffsets](docs/v2/Streams/models/PartitionOffsets.md) | `from foundry_sdk.v2.streams.models import PartitionOffsets` | -**Streams** | [PartitionRecords](docs/v2/Streams/models/PartitionRecords.md) | `from foundry_sdk.v2.streams.models import PartitionRecords` | **Streams** | [PartitionsCount](docs/v2/Streams/models/PartitionsCount.md) | `from foundry_sdk.v2.streams.models import PartitionsCount` | **Streams** | [PublishRecordsToStreamRequest](docs/v2/Streams/models/PublishRecordsToStreamRequest.md) | `from foundry_sdk.v2.streams.models import PublishRecordsToStreamRequest` | **Streams** | [PublishRecordToStreamRequest](docs/v2/Streams/models/PublishRecordToStreamRequest.md) | `from foundry_sdk.v2.streams.models import PublishRecordToStreamRequest` | -**Streams** | [ReadPosition](docs/v2/Streams/models/ReadPosition.md) | `from foundry_sdk.v2.streams.models import ReadPosition` | -**Streams** | [ReadRecordsFromSubscriberRequest](docs/v2/Streams/models/ReadRecordsFromSubscriberRequest.md) | `from foundry_sdk.v2.streams.models import ReadRecordsFromSubscriberRequest` | -**Streams** | [ReadSubscriberRecordsResponse](docs/v2/Streams/models/ReadSubscriberRecordsResponse.md) | `from foundry_sdk.v2.streams.models import ReadSubscriberRecordsResponse` | **Streams** | [Record](docs/v2/Streams/models/Record.md) | `from foundry_sdk.v2.streams.models import Record` | **Streams** | [RecordWithOffset](docs/v2/Streams/models/RecordWithOffset.md) | `from foundry_sdk.v2.streams.models import RecordWithOffset` | **Streams** | [ResetStreamRequest](docs/v2/Streams/models/ResetStreamRequest.md) | `from foundry_sdk.v2.streams.models import ResetStreamRequest` | -**Streams** | [ResetSubscriberOffsetsRequest](docs/v2/Streams/models/ResetSubscriberOffsetsRequest.md) | `from foundry_sdk.v2.streams.models import ResetSubscriberOffsetsRequest` | -**Streams** | [SpecificPosition](docs/v2/Streams/models/SpecificPosition.md) | `from foundry_sdk.v2.streams.models import SpecificPosition` | **Streams** | [Stream](docs/v2/Streams/models/Stream.md) | `from foundry_sdk.v2.streams.models import Stream` | **Streams** | [StreamType](docs/v2/Streams/models/StreamType.md) | `from foundry_sdk.v2.streams.models import StreamType` | -**Streams** | [Subscriber](docs/v2/Streams/models/Subscriber.md) | `from foundry_sdk.v2.streams.models import Subscriber` | -**Streams** | [SubscriberId](docs/v2/Streams/models/SubscriberId.md) | `from foundry_sdk.v2.streams.models import SubscriberId` | **Streams** | [ViewRid](docs/v2/Streams/models/ViewRid.md) | `from foundry_sdk.v2.streams.models import ViewRid` | **ThirdPartyApplications** | [DeployWebsiteRequest](docs/v2/ThirdPartyApplications/models/DeployWebsiteRequest.md) | `from foundry_sdk.v2.third_party_applications.models import DeployWebsiteRequest` | **ThirdPartyApplications** | [ListVersionsResponse](docs/v2/ThirdPartyApplications/models/ListVersionsResponse.md) | `from foundry_sdk.v2.third_party_applications.models import ListVersionsResponse` | @@ -3009,15 +2689,9 @@ Namespace | Name | Import | **ThirdPartyApplications** | [VersionVersion](docs/v2/ThirdPartyApplications/models/VersionVersion.md) | `from foundry_sdk.v2.third_party_applications.models import VersionVersion` | **ThirdPartyApplications** | [Website](docs/v2/ThirdPartyApplications/models/Website.md) | `from foundry_sdk.v2.third_party_applications.models import Website` | **Widgets** | [DevModeSettings](docs/v2/Widgets/models/DevModeSettings.md) | `from foundry_sdk.v2.widgets.models import DevModeSettings` | -**Widgets** | [DevModeSettingsV2](docs/v2/Widgets/models/DevModeSettingsV2.md) | `from foundry_sdk.v2.widgets.models import DevModeSettingsV2` | -**Widgets** | [DevModeSnapshot](docs/v2/Widgets/models/DevModeSnapshot.md) | `from foundry_sdk.v2.widgets.models import DevModeSnapshot` | -**Widgets** | [DevModeSnapshotId](docs/v2/Widgets/models/DevModeSnapshotId.md) | `from foundry_sdk.v2.widgets.models import DevModeSnapshotId` | **Widgets** | [DevModeStatus](docs/v2/Widgets/models/DevModeStatus.md) | `from foundry_sdk.v2.widgets.models import DevModeStatus` | **Widgets** | [FilePath](docs/v2/Widgets/models/FilePath.md) | `from foundry_sdk.v2.widgets.models import FilePath` | **Widgets** | [ListReleasesResponse](docs/v2/Widgets/models/ListReleasesResponse.md) | `from foundry_sdk.v2.widgets.models import ListReleasesResponse` | -**Widgets** | [OntologySdkInputSpec](docs/v2/Widgets/models/OntologySdkInputSpec.md) | `from foundry_sdk.v2.widgets.models import OntologySdkInputSpec` | -**Widgets** | [OntologySdkPackageRid](docs/v2/Widgets/models/OntologySdkPackageRid.md) | `from foundry_sdk.v2.widgets.models import OntologySdkPackageRid` | -**Widgets** | [OntologySdkVersion](docs/v2/Widgets/models/OntologySdkVersion.md) | `from foundry_sdk.v2.widgets.models import OntologySdkVersion` | **Widgets** | [Release](docs/v2/Widgets/models/Release.md) | `from foundry_sdk.v2.widgets.models import Release` | **Widgets** | [ReleaseLocator](docs/v2/Widgets/models/ReleaseLocator.md) | `from foundry_sdk.v2.widgets.models import ReleaseLocator` | **Widgets** | [ReleaseVersion](docs/v2/Widgets/models/ReleaseVersion.md) | `from foundry_sdk.v2.widgets.models import ReleaseVersion` | @@ -3027,17 +2701,14 @@ Namespace | Name | Import | **Widgets** | [ScriptEntrypoint](docs/v2/Widgets/models/ScriptEntrypoint.md) | `from foundry_sdk.v2.widgets.models import ScriptEntrypoint` | **Widgets** | [ScriptType](docs/v2/Widgets/models/ScriptType.md) | `from foundry_sdk.v2.widgets.models import ScriptType` | **Widgets** | [SetWidgetSetDevModeSettingsByIdRequest](docs/v2/Widgets/models/SetWidgetSetDevModeSettingsByIdRequest.md) | `from foundry_sdk.v2.widgets.models import SetWidgetSetDevModeSettingsByIdRequest` | -**Widgets** | [SetWidgetSetManifestDevModeSettingsV2Request](docs/v2/Widgets/models/SetWidgetSetManifestDevModeSettingsV2Request.md) | `from foundry_sdk.v2.widgets.models import SetWidgetSetManifestDevModeSettingsV2Request` | +**Widgets** | [SetWidgetSetDevModeSettingsRequest](docs/v2/Widgets/models/SetWidgetSetDevModeSettingsRequest.md) | `from foundry_sdk.v2.widgets.models import SetWidgetSetDevModeSettingsRequest` | **Widgets** | [StylesheetEntrypoint](docs/v2/Widgets/models/StylesheetEntrypoint.md) | `from foundry_sdk.v2.widgets.models import StylesheetEntrypoint` | **Widgets** | [WidgetDevModeSettings](docs/v2/Widgets/models/WidgetDevModeSettings.md) | `from foundry_sdk.v2.widgets.models import WidgetDevModeSettings` | -**Widgets** | [WidgetDevModeSettingsV2](docs/v2/Widgets/models/WidgetDevModeSettingsV2.md) | `from foundry_sdk.v2.widgets.models import WidgetDevModeSettingsV2` | **Widgets** | [WidgetId](docs/v2/Widgets/models/WidgetId.md) | `from foundry_sdk.v2.widgets.models import WidgetId` | **Widgets** | [WidgetRid](docs/v2/Widgets/models/WidgetRid.md) | `from foundry_sdk.v2.widgets.models import WidgetRid` | **Widgets** | [WidgetSet](docs/v2/Widgets/models/WidgetSet.md) | `from foundry_sdk.v2.widgets.models import WidgetSet` | **Widgets** | [WidgetSetDevModeSettings](docs/v2/Widgets/models/WidgetSetDevModeSettings.md) | `from foundry_sdk.v2.widgets.models import WidgetSetDevModeSettings` | **Widgets** | [WidgetSetDevModeSettingsById](docs/v2/Widgets/models/WidgetSetDevModeSettingsById.md) | `from foundry_sdk.v2.widgets.models import WidgetSetDevModeSettingsById` | -**Widgets** | [WidgetSetDevModeSettingsV2](docs/v2/Widgets/models/WidgetSetDevModeSettingsV2.md) | `from foundry_sdk.v2.widgets.models import WidgetSetDevModeSettingsV2` | -**Widgets** | [WidgetSetInputSpec](docs/v2/Widgets/models/WidgetSetInputSpec.md) | `from foundry_sdk.v2.widgets.models import WidgetSetInputSpec` | **Widgets** | [WidgetSetRid](docs/v2/Widgets/models/WidgetSetRid.md) | `from foundry_sdk.v2.widgets.models import WidgetSetRid` | @@ -3067,7 +2738,6 @@ Namespace | Name | Import | **Core** | [IntegerType](docs/v1/Core/models/IntegerType.md) | `from foundry_sdk.v1.core.models import IntegerType` | **Core** | [LongType](docs/v1/Core/models/LongType.md) | `from foundry_sdk.v1.core.models import LongType` | **Core** | [MarkingType](docs/v1/Core/models/MarkingType.md) | `from foundry_sdk.v1.core.models import MarkingType` | -**Core** | [MediaReferenceType](docs/v1/Core/models/MediaReferenceType.md) | `from foundry_sdk.v1.core.models import MediaReferenceType` | **Core** | [MediaType](docs/v1/Core/models/MediaType.md) | `from foundry_sdk.v1.core.models import MediaType` | **Core** | [NullType](docs/v1/Core/models/NullType.md) | `from foundry_sdk.v1.core.models import NullType` | **Core** | [OperationScope](docs/v1/Core/models/OperationScope.md) | `from foundry_sdk.v1.core.models import OperationScope` | @@ -3086,7 +2756,6 @@ Namespace | Name | Import | **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` | -**Core** | [VoidType](docs/v1/Core/models/VoidType.md) | `from foundry_sdk.v1.core.models import VoidType` | **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` | @@ -3240,7 +2909,6 @@ Namespace | Name | Import | **Ontologies** | [QueryStructField](docs/v1/Ontologies/models/QueryStructField.md) | `from foundry_sdk.v1.ontologies.models import QueryStructField` | **Ontologies** | [QueryStructType](docs/v1/Ontologies/models/QueryStructType.md) | `from foundry_sdk.v1.ontologies.models import QueryStructType` | **Ontologies** | [QueryType](docs/v1/Ontologies/models/QueryType.md) | `from foundry_sdk.v1.ontologies.models import QueryType` | -**Ontologies** | [QueryTypeReferenceType](docs/v1/Ontologies/models/QueryTypeReferenceType.md) | `from foundry_sdk.v1.ontologies.models import QueryTypeReferenceType` | **Ontologies** | [QueryUnionType](docs/v1/Ontologies/models/QueryUnionType.md) | `from foundry_sdk.v1.ontologies.models import QueryUnionType` | **Ontologies** | [RangeConstraint](docs/v1/Ontologies/models/RangeConstraint.md) | `from foundry_sdk.v1.ontologies.models import RangeConstraint` | **Ontologies** | [ReturnEditsMode](docs/v1/Ontologies/models/ReturnEditsMode.md) | `from foundry_sdk.v1.ontologies.models import ReturnEditsMode` | @@ -3266,7 +2934,6 @@ Namespace | Name | Import | **Ontologies** | [SumAggregation](docs/v1/Ontologies/models/SumAggregation.md) | `from foundry_sdk.v1.ontologies.models import SumAggregation` | **Ontologies** | [ThreeDimensionalAggregation](docs/v1/Ontologies/models/ThreeDimensionalAggregation.md) | `from foundry_sdk.v1.ontologies.models import ThreeDimensionalAggregation` | **Ontologies** | [TwoDimensionalAggregation](docs/v1/Ontologies/models/TwoDimensionalAggregation.md) | `from foundry_sdk.v1.ontologies.models import TwoDimensionalAggregation` | -**Ontologies** | [TypeReferenceIdentifier](docs/v1/Ontologies/models/TypeReferenceIdentifier.md) | `from foundry_sdk.v1.ontologies.models import TypeReferenceIdentifier` | **Ontologies** | [UnevaluableConstraint](docs/v1/Ontologies/models/UnevaluableConstraint.md) | `from foundry_sdk.v1.ontologies.models import UnevaluableConstraint` | **Ontologies** | [UniqueIdentifierLinkId](docs/v1/Ontologies/models/UniqueIdentifierLinkId.md) | `from foundry_sdk.v1.ontologies.models import UniqueIdentifierLinkId` | **Ontologies** | [ValidateActionRequest](docs/v1/Ontologies/models/ValidateActionRequest.md) | `from foundry_sdk.v1.ontologies.models import ValidateActionRequest` | @@ -3288,14 +2955,9 @@ Namespace | Name | Import | **Admin** | AddGroupMembersPermissionDenied | `from foundry_sdk.v2.admin.errors import AddGroupMembersPermissionDenied` | **Admin** | AddMarkingMembersPermissionDenied | `from foundry_sdk.v2.admin.errors import AddMarkingMembersPermissionDenied` | **Admin** | AddMarkingRoleAssignmentsPermissionDenied | `from foundry_sdk.v2.admin.errors import AddMarkingRoleAssignmentsPermissionDenied` | -**Admin** | AddOrganizationGuestMembersPermissionDenied | `from foundry_sdk.v2.admin.errors import AddOrganizationGuestMembersPermissionDenied` | **Admin** | AddOrganizationRoleAssignmentsPermissionDenied | `from foundry_sdk.v2.admin.errors import AddOrganizationRoleAssignmentsPermissionDenied` | -**Admin** | AttributesNotEditable | `from foundry_sdk.v2.admin.errors import AttributesNotEditable` | **Admin** | AuthenticationProviderNotFound | `from foundry_sdk.v2.admin.errors import AuthenticationProviderNotFound` | **Admin** | CannotReplaceProviderInfoForPrincipalInProtectedRealm | `from foundry_sdk.v2.admin.errors import CannotReplaceProviderInfoForPrincipalInProtectedRealm` | -**Admin** | CbacBannerNotFound | `from foundry_sdk.v2.admin.errors import CbacBannerNotFound` | -**Admin** | CbacMarkingRestrictionsNotFound | `from foundry_sdk.v2.admin.errors import CbacMarkingRestrictionsNotFound` | -**Admin** | CbacUnavailable | `from foundry_sdk.v2.admin.errors import CbacUnavailable` | **Admin** | CreateGroupPermissionDenied | `from foundry_sdk.v2.admin.errors import CreateGroupPermissionDenied` | **Admin** | CreateMarkingCategoryMissingInitialAdminRole | `from foundry_sdk.v2.admin.errors import CreateMarkingCategoryMissingInitialAdminRole` | **Admin** | CreateMarkingCategoryMissingOrganization | `from foundry_sdk.v2.admin.errors import CreateMarkingCategoryMissingOrganization` | @@ -3308,9 +2970,6 @@ Namespace | Name | Import | **Admin** | DeleteUserPermissionDenied | `from foundry_sdk.v2.admin.errors import DeleteUserPermissionDenied` | **Admin** | EnrollmentNotFound | `from foundry_sdk.v2.admin.errors import EnrollmentNotFound` | **Admin** | EnrollmentRoleNotFound | `from foundry_sdk.v2.admin.errors import EnrollmentRoleNotFound` | -**Admin** | ExpirationForTransitiveGroupMembersNotSupported | `from foundry_sdk.v2.admin.errors import ExpirationForTransitiveGroupMembersNotSupported` | -**Admin** | GetCbacBannerPermissionDenied | `from foundry_sdk.v2.admin.errors import GetCbacBannerPermissionDenied` | -**Admin** | GetCbacMarkingRestrictionInfoPermissionDenied | `from foundry_sdk.v2.admin.errors import GetCbacMarkingRestrictionInfoPermissionDenied` | **Admin** | GetCurrentEnrollmentPermissionDenied | `from foundry_sdk.v2.admin.errors import GetCurrentEnrollmentPermissionDenied` | **Admin** | GetCurrentUserPermissionDenied | `from foundry_sdk.v2.admin.errors import GetCurrentUserPermissionDenied` | **Admin** | GetGroupProviderInfoPermissionDenied | `from foundry_sdk.v2.admin.errors import GetGroupProviderInfoPermissionDenied` | @@ -3328,18 +2987,15 @@ Namespace | Name | Import | **Admin** | InvalidHostName | `from foundry_sdk.v2.admin.errors import InvalidHostName` | **Admin** | InvalidProfilePicture | `from foundry_sdk.v2.admin.errors import InvalidProfilePicture` | **Admin** | ListAvailableRolesOrganizationPermissionDenied | `from foundry_sdk.v2.admin.errors import ListAvailableRolesOrganizationPermissionDenied` | -**Admin** | ListCurrentGroupsPermissionDenied | `from foundry_sdk.v2.admin.errors import ListCurrentGroupsPermissionDenied` | **Admin** | ListEnrollmentRoleAssignmentsPermissionDenied | `from foundry_sdk.v2.admin.errors import ListEnrollmentRoleAssignmentsPermissionDenied` | **Admin** | ListHostsPermissionDenied | `from foundry_sdk.v2.admin.errors import ListHostsPermissionDenied` | **Admin** | ListMarkingMembersPermissionDenied | `from foundry_sdk.v2.admin.errors import ListMarkingMembersPermissionDenied` | **Admin** | ListMarkingRoleAssignmentsPermissionDenied | `from foundry_sdk.v2.admin.errors import ListMarkingRoleAssignmentsPermissionDenied` | -**Admin** | ListOrganizationGuestMembersPermissionDenied | `from foundry_sdk.v2.admin.errors import ListOrganizationGuestMembersPermissionDenied` | **Admin** | ListOrganizationRoleAssignmentsPermissionDenied | `from foundry_sdk.v2.admin.errors import ListOrganizationRoleAssignmentsPermissionDenied` | **Admin** | MarkingCategoryNotFound | `from foundry_sdk.v2.admin.errors import MarkingCategoryNotFound` | **Admin** | MarkingNameInCategoryAlreadyExists | `from foundry_sdk.v2.admin.errors import MarkingNameInCategoryAlreadyExists` | **Admin** | MarkingNameIsEmpty | `from foundry_sdk.v2.admin.errors import MarkingNameIsEmpty` | **Admin** | MarkingNotFound | `from foundry_sdk.v2.admin.errors import MarkingNotFound` | -**Admin** | OrganizationMarkingAdministerRoleNotSupported | `from foundry_sdk.v2.admin.errors import OrganizationMarkingAdministerRoleNotSupported` | **Admin** | OrganizationNameAlreadyExists | `from foundry_sdk.v2.admin.errors import OrganizationNameAlreadyExists` | **Admin** | OrganizationNotFound | `from foundry_sdk.v2.admin.errors import OrganizationNotFound` | **Admin** | PreregisterGroupPermissionDenied | `from foundry_sdk.v2.admin.errors import PreregisterGroupPermissionDenied` | @@ -3352,12 +3008,9 @@ Namespace | Name | Import | **Admin** | RemoveMarkingMembersPermissionDenied | `from foundry_sdk.v2.admin.errors import RemoveMarkingMembersPermissionDenied` | **Admin** | RemoveMarkingRoleAssignmentsPermissionDenied | `from foundry_sdk.v2.admin.errors import RemoveMarkingRoleAssignmentsPermissionDenied` | **Admin** | RemoveMarkingRoleAssignmentsRemoveAllAdministratorsNotAllowed | `from foundry_sdk.v2.admin.errors import RemoveMarkingRoleAssignmentsRemoveAllAdministratorsNotAllowed` | -**Admin** | RemoveOrganizationGuestMembersPermissionDenied | `from foundry_sdk.v2.admin.errors import RemoveOrganizationGuestMembersPermissionDenied` | **Admin** | RemoveOrganizationRoleAssignmentsPermissionDenied | `from foundry_sdk.v2.admin.errors import RemoveOrganizationRoleAssignmentsPermissionDenied` | **Admin** | ReplaceGroupMembershipExpirationPolicyPermissionDenied | `from foundry_sdk.v2.admin.errors import ReplaceGroupMembershipExpirationPolicyPermissionDenied` | -**Admin** | ReplaceGroupPermissionDenied | `from foundry_sdk.v2.admin.errors import ReplaceGroupPermissionDenied` | **Admin** | ReplaceGroupProviderInfoPermissionDenied | `from foundry_sdk.v2.admin.errors import ReplaceGroupProviderInfoPermissionDenied` | -**Admin** | ReplaceMarkingCategoryPermissionDenied | `from foundry_sdk.v2.admin.errors import ReplaceMarkingCategoryPermissionDenied` | **Admin** | ReplaceMarkingPermissionDenied | `from foundry_sdk.v2.admin.errors import ReplaceMarkingPermissionDenied` | **Admin** | ReplaceOrganizationPermissionDenied | `from foundry_sdk.v2.admin.errors import ReplaceOrganizationPermissionDenied` | **Admin** | ReplaceUserProviderInfoPermissionDenied | `from foundry_sdk.v2.admin.errors import ReplaceUserProviderInfoPermissionDenied` | @@ -3365,7 +3018,6 @@ Namespace | Name | Import | **Admin** | RoleNotFound | `from foundry_sdk.v2.admin.errors import RoleNotFound` | **Admin** | SearchGroupsPermissionDenied | `from foundry_sdk.v2.admin.errors import SearchGroupsPermissionDenied` | **Admin** | SearchUsersPermissionDenied | `from foundry_sdk.v2.admin.errors import SearchUsersPermissionDenied` | -**Admin** | UnknownClassificationBannerDisplayType | `from foundry_sdk.v2.admin.errors import UnknownClassificationBannerDisplayType` | **Admin** | UserDeleted | `from foundry_sdk.v2.admin.errors import UserDeleted` | **Admin** | UserIsActive | `from foundry_sdk.v2.admin.errors import UserIsActive` | **Admin** | UserNotFound | `from foundry_sdk.v2.admin.errors import UserNotFound` | @@ -3516,7 +3168,6 @@ Namespace | Name | Import | **Datasets** | FileNotFound | `from foundry_sdk.v2.datasets.errors import FileNotFound` | **Datasets** | FileNotFoundOnBranch | `from foundry_sdk.v2.datasets.errors import FileNotFoundOnBranch` | **Datasets** | FileNotFoundOnTransactionRange | `from foundry_sdk.v2.datasets.errors import FileNotFoundOnTransactionRange` | -**Datasets** | FileSizeLimitExceeded | `from foundry_sdk.v2.datasets.errors import FileSizeLimitExceeded` | **Datasets** | GetBranchTransactionHistoryPermissionDenied | `from foundry_sdk.v2.datasets.errors import GetBranchTransactionHistoryPermissionDenied` | **Datasets** | GetDatasetHealthCheckReportsPermissionDenied | `from foundry_sdk.v2.datasets.errors import GetDatasetHealthCheckReportsPermissionDenied` | **Datasets** | GetDatasetHealthChecksPermissionDenied | `from foundry_sdk.v2.datasets.errors import GetDatasetHealthChecksPermissionDenied` | @@ -3555,9 +3206,7 @@ Namespace | Name | Import | **Filesystem** | AddGroupToParentGroupPermissionDenied | `from foundry_sdk.v2.filesystem.errors import AddGroupToParentGroupPermissionDenied` | **Filesystem** | AddMarkingsPermissionDenied | `from foundry_sdk.v2.filesystem.errors import AddMarkingsPermissionDenied` | **Filesystem** | AddOrganizationsPermissionDenied | `from foundry_sdk.v2.filesystem.errors import AddOrganizationsPermissionDenied` | -**Filesystem** | AddProjectResourceReferencesPermissionDenied | `from foundry_sdk.v2.filesystem.errors import AddProjectResourceReferencesPermissionDenied` | **Filesystem** | AddResourceRolesPermissionDenied | `from foundry_sdk.v2.filesystem.errors import AddResourceRolesPermissionDenied` | -**Filesystem** | CircularDependency | `from foundry_sdk.v2.filesystem.errors import CircularDependency` | **Filesystem** | CreateFolderOutsideProjectNotSupported | `from foundry_sdk.v2.filesystem.errors import CreateFolderOutsideProjectNotSupported` | **Filesystem** | CreateFolderPermissionDenied | `from foundry_sdk.v2.filesystem.errors import CreateFolderPermissionDenied` | **Filesystem** | CreateGroupPermissionDenied | `from foundry_sdk.v2.filesystem.errors import CreateGroupPermissionDenied` | @@ -3582,11 +3231,8 @@ Namespace | Name | Import | **Filesystem** | InvalidFolder | `from foundry_sdk.v2.filesystem.errors import InvalidFolder` | **Filesystem** | InvalidOrganizationHierarchy | `from foundry_sdk.v2.filesystem.errors import InvalidOrganizationHierarchy` | **Filesystem** | InvalidOrganizations | `from foundry_sdk.v2.filesystem.errors import InvalidOrganizations` | -**Filesystem** | InvalidParentFolder | `from foundry_sdk.v2.filesystem.errors import InvalidParentFolder` | **Filesystem** | InvalidPath | `from foundry_sdk.v2.filesystem.errors import InvalidPath` | **Filesystem** | InvalidPrincipalIdsForGroupTemplate | `from foundry_sdk.v2.filesystem.errors import InvalidPrincipalIdsForGroupTemplate` | -**Filesystem** | InvalidProject | `from foundry_sdk.v2.filesystem.errors import InvalidProject` | -**Filesystem** | InvalidResourceReference | `from foundry_sdk.v2.filesystem.errors import InvalidResourceReference` | **Filesystem** | InvalidRoleIds | `from foundry_sdk.v2.filesystem.errors import InvalidRoleIds` | **Filesystem** | InvalidVariable | `from foundry_sdk.v2.filesystem.errors import InvalidVariable` | **Filesystem** | InvalidVariableEnumOption | `from foundry_sdk.v2.filesystem.errors import InvalidVariableEnumOption` | @@ -3606,9 +3252,7 @@ Namespace | Name | Import | **Filesystem** | ProjectTemplateNotFound | `from foundry_sdk.v2.filesystem.errors import ProjectTemplateNotFound` | **Filesystem** | RemoveMarkingsPermissionDenied | `from foundry_sdk.v2.filesystem.errors import RemoveMarkingsPermissionDenied` | **Filesystem** | RemoveOrganizationsPermissionDenied | `from foundry_sdk.v2.filesystem.errors import RemoveOrganizationsPermissionDenied` | -**Filesystem** | RemoveProjectResourceReferencesPermissionDenied | `from foundry_sdk.v2.filesystem.errors import RemoveProjectResourceReferencesPermissionDenied` | **Filesystem** | RemoveResourceRolesPermissionDenied | `from foundry_sdk.v2.filesystem.errors import RemoveResourceRolesPermissionDenied` | -**Filesystem** | ReplaceFolderPermissionDenied | `from foundry_sdk.v2.filesystem.errors import ReplaceFolderPermissionDenied` | **Filesystem** | ReplaceProjectPermissionDenied | `from foundry_sdk.v2.filesystem.errors import ReplaceProjectPermissionDenied` | **Filesystem** | ReplaceSpacePermissionDenied | `from foundry_sdk.v2.filesystem.errors import ReplaceSpacePermissionDenied` | **Filesystem** | ReservedSpaceCannotBeReplaced | `from foundry_sdk.v2.filesystem.errors import ReservedSpaceCannotBeReplaced` | @@ -3629,24 +3273,11 @@ Namespace | Name | Import | **Filesystem** | TrashingHiddenResourcesNotSupported | `from foundry_sdk.v2.filesystem.errors import TrashingHiddenResourcesNotSupported` | **Filesystem** | TrashingSpaceNotSupported | `from foundry_sdk.v2.filesystem.errors import TrashingSpaceNotSupported` | **Filesystem** | UsageAccountServiceIsNotPresent | `from foundry_sdk.v2.filesystem.errors import UsageAccountServiceIsNotPresent` | -**Functions** | AsyncConsistentSnapshotError | `from foundry_sdk.v2.functions.errors import AsyncConsistentSnapshotError` | -**Functions** | AsyncFunctionNotSupportedWithTransaction | `from foundry_sdk.v2.functions.errors import AsyncFunctionNotSupportedWithTransaction` | -**Functions** | AsyncInvalidQueryOutputValue | `from foundry_sdk.v2.functions.errors import AsyncInvalidQueryOutputValue` | -**Functions** | AsyncQueryEncounteredUserFacingError | `from foundry_sdk.v2.functions.errors import AsyncQueryEncounteredUserFacingError` | -**Functions** | AsyncQueryMemoryExceededLimit | `from foundry_sdk.v2.functions.errors import AsyncQueryMemoryExceededLimit` | -**Functions** | AsyncQueryRuntimeError | `from foundry_sdk.v2.functions.errors import AsyncQueryRuntimeError` | -**Functions** | AsyncQueryTimeExceededLimit | `from foundry_sdk.v2.functions.errors import AsyncQueryTimeExceededLimit` | -**Functions** | CancelExecutionNotSupported | `from foundry_sdk.v2.functions.errors import CancelExecutionNotSupported` | -**Functions** | CancelExecutionPermissionDenied | `from foundry_sdk.v2.functions.errors import CancelExecutionPermissionDenied` | **Functions** | ConsistentSnapshotError | `from foundry_sdk.v2.functions.errors import ConsistentSnapshotError` | -**Functions** | ExecuteAsyncQueryPermissionDenied | `from foundry_sdk.v2.functions.errors import ExecuteAsyncQueryPermissionDenied` | **Functions** | ExecuteQueryPermissionDenied | `from foundry_sdk.v2.functions.errors import ExecuteQueryPermissionDenied` | -**Functions** | ExecutionNotFound | `from foundry_sdk.v2.functions.errors import ExecutionNotFound` | **Functions** | FunctionHasNoPublishedVersion | `from foundry_sdk.v2.functions.errors import FunctionHasNoPublishedVersion` | **Functions** | FunctionNotFound | `from foundry_sdk.v2.functions.errors import FunctionNotFound` | -**Functions** | FunctionNotSupportedWithTransaction | `from foundry_sdk.v2.functions.errors import FunctionNotSupportedWithTransaction` | -**Functions** | GetByRidPermissionDenied | `from foundry_sdk.v2.functions.errors import GetByRidPermissionDenied` | -**Functions** | GetResultExecutionPermissionDenied | `from foundry_sdk.v2.functions.errors import GetResultExecutionPermissionDenied` | +**Functions** | GetByRidQueriesPermissionDenied | `from foundry_sdk.v2.functions.errors import GetByRidQueriesPermissionDenied` | **Functions** | InvalidQueryOutputValue | `from foundry_sdk.v2.functions.errors import InvalidQueryOutputValue` | **Functions** | InvalidQueryParameterValue | `from foundry_sdk.v2.functions.errors import InvalidQueryParameterValue` | **Functions** | MissingParameter | `from foundry_sdk.v2.functions.errors import MissingParameter` | @@ -3661,23 +3292,16 @@ Namespace | Name | Import | **Functions** | ValueTypeNotFound | `from foundry_sdk.v2.functions.errors import ValueTypeNotFound` | **Functions** | VersionIdNotFound | `from foundry_sdk.v2.functions.errors import VersionIdNotFound` | **LanguageModels** | AnthropicMessagesPermissionDenied | `from foundry_sdk.v2.language_models.errors import AnthropicMessagesPermissionDenied` | -**LanguageModels** | InvalidRequest | `from foundry_sdk.v2.language_models.errors import InvalidRequest` | -**LanguageModels** | LanguageModelInferenceError | `from foundry_sdk.v2.language_models.errors import LanguageModelInferenceError` | -**LanguageModels** | LanguageModelNotAvailable | `from foundry_sdk.v2.language_models.errors import LanguageModelNotAvailable` | -**LanguageModels** | LanguageModelNotFound | `from foundry_sdk.v2.language_models.errors import LanguageModelNotFound` | -**LanguageModels** | LanguageModelPermissionDenied | `from foundry_sdk.v2.language_models.errors import LanguageModelPermissionDenied` | **LanguageModels** | MultipleSystemPromptsNotSupported | `from foundry_sdk.v2.language_models.errors import MultipleSystemPromptsNotSupported` | **LanguageModels** | MultipleToolResultContentsNotSupported | `from foundry_sdk.v2.language_models.errors import MultipleToolResultContentsNotSupported` | **LanguageModels** | OpenAiEmbeddingsPermissionDenied | `from foundry_sdk.v2.language_models.errors import OpenAiEmbeddingsPermissionDenied` | **MediaSets** | ConflictingMediaSetIdentifiers | `from foundry_sdk.v2.media_sets.errors import ConflictingMediaSetIdentifiers` | **MediaSets** | GetMediaItemRidByPathPermissionDenied | `from foundry_sdk.v2.media_sets.errors import GetMediaItemRidByPathPermissionDenied` | -**MediaSets** | InvalidMediaItemRid | `from foundry_sdk.v2.media_sets.errors import InvalidMediaItemRid` | **MediaSets** | InvalidMediaItemSchema | `from foundry_sdk.v2.media_sets.errors import InvalidMediaItemSchema` | **MediaSets** | MediaItemHasUnsupportedSecuritySettings | `from foundry_sdk.v2.media_sets.errors import MediaItemHasUnsupportedSecuritySettings` | **MediaSets** | MediaItemImageUnparsable | `from foundry_sdk.v2.media_sets.errors import MediaItemImageUnparsable` | **MediaSets** | MediaItemIsPasswordProtected | `from foundry_sdk.v2.media_sets.errors import MediaItemIsPasswordProtected` | **MediaSets** | MediaItemNotFound | `from foundry_sdk.v2.media_sets.errors import MediaItemNotFound` | -**MediaSets** | MediaItemRidAlreadyExists | `from foundry_sdk.v2.media_sets.errors import MediaItemRidAlreadyExists` | **MediaSets** | MediaItemXmlUnparsable | `from foundry_sdk.v2.media_sets.errors import MediaItemXmlUnparsable` | **MediaSets** | MediaSetNotFound | `from foundry_sdk.v2.media_sets.errors import MediaSetNotFound` | **MediaSets** | MediaSetOpenTransactionAlreadyExists | `from foundry_sdk.v2.media_sets.errors import MediaSetOpenTransactionAlreadyExists` | @@ -3689,57 +3313,14 @@ Namespace | Name | Import | **MediaSets** | TransformationUnavailable | `from foundry_sdk.v2.media_sets.errors import TransformationUnavailable` | **MediaSets** | TransformedMediaItemNotFound | `from foundry_sdk.v2.media_sets.errors import TransformedMediaItemNotFound` | **MediaSets** | UnexpectedMetadataType | `from foundry_sdk.v2.media_sets.errors import UnexpectedMetadataType` | -**MediaSets** | UnsupportedMetadata | `from foundry_sdk.v2.media_sets.errors import UnsupportedMetadata` | **Models** | CondaSolveFailureForProvidedPackages | `from foundry_sdk.v2.models.errors import CondaSolveFailureForProvidedPackages` | -**Models** | CreateConfigValidationError | `from foundry_sdk.v2.models.errors import CreateConfigValidationError` | -**Models** | CreateLiveDeploymentPermissionDenied | `from foundry_sdk.v2.models.errors import CreateLiveDeploymentPermissionDenied` | -**Models** | CreateModelFunctionPermissionDenied | `from foundry_sdk.v2.models.errors import CreateModelFunctionPermissionDenied` | **Models** | CreateModelPermissionDenied | `from foundry_sdk.v2.models.errors import CreateModelPermissionDenied` | -**Models** | CreateModelStudioConfigVersionPermissionDenied | `from foundry_sdk.v2.models.errors import CreateModelStudioConfigVersionPermissionDenied` | -**Models** | CreateModelStudioPermissionDenied | `from foundry_sdk.v2.models.errors import CreateModelStudioPermissionDenied` | **Models** | CreateModelVersionPermissionDenied | `from foundry_sdk.v2.models.errors import CreateModelVersionPermissionDenied` | -**Models** | ExperimentArtifactNotFound | `from foundry_sdk.v2.models.errors import ExperimentArtifactNotFound` | -**Models** | ExperimentNotFound | `from foundry_sdk.v2.models.errors import ExperimentNotFound` | -**Models** | ExperimentSeriesNotFound | `from foundry_sdk.v2.models.errors import ExperimentSeriesNotFound` | -**Models** | FunctionAlreadyExists | `from foundry_sdk.v2.models.errors import FunctionAlreadyExists` | -**Models** | GpuTypeNotAvailable | `from foundry_sdk.v2.models.errors import GpuTypeNotAvailable` | -**Models** | InferenceFailure | `from foundry_sdk.v2.models.errors import InferenceFailure` | -**Models** | InferenceInvalidInput | `from foundry_sdk.v2.models.errors import InferenceInvalidInput` | -**Models** | InferenceTimeout | `from foundry_sdk.v2.models.errors import InferenceTimeout` | -**Models** | InvalidExperimentSearchFilter | `from foundry_sdk.v2.models.errors import InvalidExperimentSearchFilter` | -**Models** | InvalidFunctionApiName | `from foundry_sdk.v2.models.errors import InvalidFunctionApiName` | -**Models** | InvalidGpuCount | `from foundry_sdk.v2.models.errors import InvalidGpuCount` | **Models** | InvalidModelApi | `from foundry_sdk.v2.models.errors import InvalidModelApi` | -**Models** | InvalidModelStudioCreateRequest | `from foundry_sdk.v2.models.errors import InvalidModelStudioCreateRequest` | -**Models** | JsonExperimentArtifactTablePermissionDenied | `from foundry_sdk.v2.models.errors import JsonExperimentArtifactTablePermissionDenied` | -**Models** | JsonExperimentSeriesPermissionDenied | `from foundry_sdk.v2.models.errors import JsonExperimentSeriesPermissionDenied` | -**Models** | LatestModelStudioConfigVersionsPermissionDenied | `from foundry_sdk.v2.models.errors import LatestModelStudioConfigVersionsPermissionDenied` | -**Models** | LaunchModelStudioPermissionDenied | `from foundry_sdk.v2.models.errors import LaunchModelStudioPermissionDenied` | -**Models** | LiveDeploymentNotFound | `from foundry_sdk.v2.models.errors import LiveDeploymentNotFound` | -**Models** | ModelApiTypeUnsupportedForFunction | `from foundry_sdk.v2.models.errors import ModelApiTypeUnsupportedForFunction` | -**Models** | ModelExperimentNotFound | `from foundry_sdk.v2.models.errors import ModelExperimentNotFound` | -**Models** | ModelFunctionNotFound | `from foundry_sdk.v2.models.errors import ModelFunctionNotFound` | **Models** | ModelNotFound | `from foundry_sdk.v2.models.errors import ModelNotFound` | -**Models** | ModelStudioConfigVersionNotFound | `from foundry_sdk.v2.models.errors import ModelStudioConfigVersionNotFound` | -**Models** | ModelStudioNotFound | `from foundry_sdk.v2.models.errors import ModelStudioNotFound` | -**Models** | ModelStudioTrainerNotFound | `from foundry_sdk.v2.models.errors import ModelStudioTrainerNotFound` | **Models** | ModelVersionNotFound | `from foundry_sdk.v2.models.errors import ModelVersionNotFound` | -**Models** | OntologyBindingRequired | `from foundry_sdk.v2.models.errors import OntologyBindingRequired` | -**Models** | OntologyNotFound | `from foundry_sdk.v2.models.errors import OntologyNotFound` | -**Models** | ParquetExperimentArtifactTablePermissionDenied | `from foundry_sdk.v2.models.errors import ParquetExperimentArtifactTablePermissionDenied` | -**Models** | ParquetExperimentSeriesPermissionDenied | `from foundry_sdk.v2.models.errors import ParquetExperimentSeriesPermissionDenied` | -**Models** | PromoteVersionModelPermissionDenied | `from foundry_sdk.v2.models.errors import PromoteVersionModelPermissionDenied` | -**Models** | ReplaceLiveDeploymentPermissionDenied | `from foundry_sdk.v2.models.errors import ReplaceLiveDeploymentPermissionDenied` | -**Models** | ReplaceModelFunctionPermissionDenied | `from foundry_sdk.v2.models.errors import ReplaceModelFunctionPermissionDenied` | -**Models** | SearchExperimentsPermissionDenied | `from foundry_sdk.v2.models.errors import SearchExperimentsPermissionDenied` | -**Models** | ThreadCountTooHigh | `from foundry_sdk.v2.models.errors import ThreadCountTooHigh` | -**Models** | TrainerNotFound | `from foundry_sdk.v2.models.errors import TrainerNotFound` | -**Models** | TransformJsonLiveDeploymentPermissionDenied | `from foundry_sdk.v2.models.errors import TransformJsonLiveDeploymentPermissionDenied` | -**Models** | UnsupportedLiveDeployment | `from foundry_sdk.v2.models.errors import UnsupportedLiveDeployment` | -**Models** | UnsupportedModelSource | `from foundry_sdk.v2.models.errors import UnsupportedModelSource` | **Ontologies** | ActionContainsDuplicateEdits | `from foundry_sdk.v2.ontologies.errors import ActionContainsDuplicateEdits` | **Ontologies** | ActionEditedPropertiesNotFound | `from foundry_sdk.v2.ontologies.errors import ActionEditedPropertiesNotFound` | -**Ontologies** | ActionEditsNotSupportedWithMarketplace | `from foundry_sdk.v2.ontologies.errors import ActionEditsNotSupportedWithMarketplace` | **Ontologies** | ActionEditsReadOnlyEntity | `from foundry_sdk.v2.ontologies.errors import ActionEditsReadOnlyEntity` | **Ontologies** | ActionNotFound | `from foundry_sdk.v2.ontologies.errors import ActionNotFound` | **Ontologies** | ActionParameterInterfaceTypeNotFound | `from foundry_sdk.v2.ontologies.errors import ActionParameterInterfaceTypeNotFound` | @@ -3756,20 +3337,17 @@ Namespace | Name | Import | **Ontologies** | AttachmentNotFound | `from foundry_sdk.v2.ontologies.errors import AttachmentNotFound` | **Ontologies** | AttachmentRidAlreadyExists | `from foundry_sdk.v2.ontologies.errors import AttachmentRidAlreadyExists` | **Ontologies** | AttachmentSizeExceededLimit | `from foundry_sdk.v2.ontologies.errors import AttachmentSizeExceededLimit` | -**Ontologies** | BranchNotSupportedWithMarketplaceQuery | `from foundry_sdk.v2.ontologies.errors import BranchNotSupportedWithMarketplaceQuery` | **Ontologies** | CipherChannelNotFound | `from foundry_sdk.v2.ontologies.errors import CipherChannelNotFound` | **Ontologies** | CompositePrimaryKeyNotSupported | `from foundry_sdk.v2.ontologies.errors import CompositePrimaryKeyNotSupported` | **Ontologies** | ConsistentSnapshotError | `from foundry_sdk.v2.ontologies.errors import ConsistentSnapshotError` | **Ontologies** | DefaultAndNullGroupsNotSupported | `from foundry_sdk.v2.ontologies.errors import DefaultAndNullGroupsNotSupported` | **Ontologies** | DerivedPropertyApiNamesNotUnique | `from foundry_sdk.v2.ontologies.errors import DerivedPropertyApiNamesNotUnique` | -**Ontologies** | DistinctEnumValuesExceededLimit | `from foundry_sdk.v2.ontologies.errors import DistinctEnumValuesExceededLimit` | **Ontologies** | DuplicateOrderBy | `from foundry_sdk.v2.ontologies.errors import DuplicateOrderBy` | **Ontologies** | EditObjectPermissionDenied | `from foundry_sdk.v2.ontologies.errors import EditObjectPermissionDenied` | **Ontologies** | FunctionEncounteredUserFacingError | `from foundry_sdk.v2.ontologies.errors import FunctionEncounteredUserFacingError` | **Ontologies** | FunctionExecutionFailed | `from foundry_sdk.v2.ontologies.errors import FunctionExecutionFailed` | **Ontologies** | FunctionExecutionTimedOut | `from foundry_sdk.v2.ontologies.errors import FunctionExecutionTimedOut` | **Ontologies** | FunctionInvalidInput | `from foundry_sdk.v2.ontologies.errors import FunctionInvalidInput` | -**Ontologies** | FunctionNotSupportedWithTransaction | `from foundry_sdk.v2.ontologies.errors import FunctionNotSupportedWithTransaction` | **Ontologies** | HighScaleComputationNotEnabled | `from foundry_sdk.v2.ontologies.errors import HighScaleComputationNotEnabled` | **Ontologies** | IncompatibleNestedObjectSet | `from foundry_sdk.v2.ontologies.errors import IncompatibleNestedObjectSet` | **Ontologies** | InterfaceBasedObjectSetNotSupported | `from foundry_sdk.v2.ontologies.errors import InterfaceBasedObjectSetNotSupported` | @@ -3790,7 +3368,6 @@ Namespace | Name | Import | **Ontologies** | InvalidContentLength | `from foundry_sdk.v2.ontologies.errors import InvalidContentLength` | **Ontologies** | InvalidContentType | `from foundry_sdk.v2.ontologies.errors import InvalidContentType` | **Ontologies** | InvalidDerivedPropertyDefinition | `from foundry_sdk.v2.ontologies.errors import InvalidDerivedPropertyDefinition` | -**Ontologies** | InvalidDerivedPropertyDefinitionOnInterface | `from foundry_sdk.v2.ontologies.errors import InvalidDerivedPropertyDefinitionOnInterface` | **Ontologies** | InvalidDurationGroupByPropertyType | `from foundry_sdk.v2.ontologies.errors import InvalidDurationGroupByPropertyType` | **Ontologies** | InvalidDurationGroupByPropertyTypeForInterface | `from foundry_sdk.v2.ontologies.errors import InvalidDurationGroupByPropertyTypeForInterface` | **Ontologies** | InvalidDurationGroupByValue | `from foundry_sdk.v2.ontologies.errors import InvalidDurationGroupByValue` | @@ -3840,7 +3417,6 @@ Namespace | Name | Import | **Ontologies** | ObjectTypeNotSynced | `from foundry_sdk.v2.ontologies.errors import ObjectTypeNotSynced` | **Ontologies** | ObjectTypesNotSynced | `from foundry_sdk.v2.ontologies.errors import ObjectTypesNotSynced` | **Ontologies** | OntologyApiNameNotUnique | `from foundry_sdk.v2.ontologies.errors import OntologyApiNameNotUnique` | -**Ontologies** | OntologyDefinitionOutOfSync | `from foundry_sdk.v2.ontologies.errors import OntologyDefinitionOutOfSync` | **Ontologies** | OntologyEditsExceededLimit | `from foundry_sdk.v2.ontologies.errors import OntologyEditsExceededLimit` | **Ontologies** | OntologyNotFound | `from foundry_sdk.v2.ontologies.errors import OntologyNotFound` | **Ontologies** | OntologySyncing | `from foundry_sdk.v2.ontologies.errors import OntologySyncing` | @@ -3920,12 +3496,9 @@ Namespace | Name | Import | **Orchestration** | TargetNotSupported | `from foundry_sdk.v2.orchestration.errors import TargetNotSupported` | **Orchestration** | UnpauseSchedulePermissionDenied | `from foundry_sdk.v2.orchestration.errors import UnpauseSchedulePermissionDenied` | **SqlQueries** | CancelSqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import CancelSqlQueryPermissionDenied` | -**SqlQueries** | ColumnTypesNotSupported | `from foundry_sdk.v2.sql_queries.errors import ColumnTypesNotSupported` | -**SqlQueries** | ExecuteOntologySqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import ExecuteOntologySqlQueryPermissionDenied` | **SqlQueries** | ExecuteSqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import ExecuteSqlQueryPermissionDenied` | **SqlQueries** | GetResultsSqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import GetResultsSqlQueryPermissionDenied` | **SqlQueries** | GetStatusSqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import GetStatusSqlQueryPermissionDenied` | -**SqlQueries** | OntologyQueryFailed | `from foundry_sdk.v2.sql_queries.errors import OntologyQueryFailed` | **SqlQueries** | QueryCanceled | `from foundry_sdk.v2.sql_queries.errors import QueryCanceled` | **SqlQueries** | QueryFailed | `from foundry_sdk.v2.sql_queries.errors import QueryFailed` | **SqlQueries** | QueryParseError | `from foundry_sdk.v2.sql_queries.errors import QueryParseError` | @@ -3934,28 +3507,20 @@ Namespace | Name | Import | **SqlQueries** | ReadQueryInputsPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import ReadQueryInputsPermissionDenied` | **Streams** | CannotCreateStreamingDatasetInUserFolder | `from foundry_sdk.v2.streams.errors import CannotCreateStreamingDatasetInUserFolder` | **Streams** | CannotWriteToTrashedStream | `from foundry_sdk.v2.streams.errors import CannotWriteToTrashedStream` | -**Streams** | CommitSubscriberOffsetsPermissionDenied | `from foundry_sdk.v2.streams.errors import CommitSubscriberOffsetsPermissionDenied` | **Streams** | CreateStreamingDatasetPermissionDenied | `from foundry_sdk.v2.streams.errors import CreateStreamingDatasetPermissionDenied` | **Streams** | CreateStreamPermissionDenied | `from foundry_sdk.v2.streams.errors import CreateStreamPermissionDenied` | -**Streams** | CreateSubscriberPermissionDenied | `from foundry_sdk.v2.streams.errors import CreateSubscriberPermissionDenied` | -**Streams** | DeleteSubscriberPermissionDenied | `from foundry_sdk.v2.streams.errors import DeleteSubscriberPermissionDenied` | **Streams** | FailedToProcessBinaryRecord | `from foundry_sdk.v2.streams.errors import FailedToProcessBinaryRecord` | **Streams** | GetEndOffsetsForStreamPermissionDenied | `from foundry_sdk.v2.streams.errors import GetEndOffsetsForStreamPermissionDenied` | **Streams** | GetRecordsFromStreamPermissionDenied | `from foundry_sdk.v2.streams.errors import GetRecordsFromStreamPermissionDenied` | -**Streams** | GetSubscriberReadPositionPermissionDenied | `from foundry_sdk.v2.streams.errors import GetSubscriberReadPositionPermissionDenied` | **Streams** | InvalidStreamNoSchema | `from foundry_sdk.v2.streams.errors import InvalidStreamNoSchema` | **Streams** | InvalidStreamType | `from foundry_sdk.v2.streams.errors import InvalidStreamType` | **Streams** | PublishBinaryRecordToStreamPermissionDenied | `from foundry_sdk.v2.streams.errors import PublishBinaryRecordToStreamPermissionDenied` | **Streams** | PublishRecordsToStreamPermissionDenied | `from foundry_sdk.v2.streams.errors import PublishRecordsToStreamPermissionDenied` | **Streams** | PublishRecordToStreamPermissionDenied | `from foundry_sdk.v2.streams.errors import PublishRecordToStreamPermissionDenied` | -**Streams** | ReadRecordsFromSubscriberPermissionDenied | `from foundry_sdk.v2.streams.errors import ReadRecordsFromSubscriberPermissionDenied` | **Streams** | RecordDoesNotMatchStreamSchema | `from foundry_sdk.v2.streams.errors import RecordDoesNotMatchStreamSchema` | **Streams** | RecordTooLarge | `from foundry_sdk.v2.streams.errors import RecordTooLarge` | **Streams** | ResetStreamPermissionDenied | `from foundry_sdk.v2.streams.errors import ResetStreamPermissionDenied` | -**Streams** | ResetSubscriberOffsetsPermissionDenied | `from foundry_sdk.v2.streams.errors import ResetSubscriberOffsetsPermissionDenied` | **Streams** | StreamNotFound | `from foundry_sdk.v2.streams.errors import StreamNotFound` | -**Streams** | SubscriberAlreadyExists | `from foundry_sdk.v2.streams.errors import SubscriberAlreadyExists` | -**Streams** | SubscriberNotFound | `from foundry_sdk.v2.streams.errors import SubscriberNotFound` | **Streams** | ViewNotFound | `from foundry_sdk.v2.streams.errors import ViewNotFound` | **ThirdPartyApplications** | CannotDeleteDeployedVersion | `from foundry_sdk.v2.third_party_applications.errors import CannotDeleteDeployedVersion` | **ThirdPartyApplications** | DeleteVersionPermissionDenied | `from foundry_sdk.v2.third_party_applications.errors import DeleteVersionPermissionDenied` | @@ -3963,9 +3528,6 @@ Namespace | Name | Import | **ThirdPartyApplications** | FileCountLimitExceeded | `from foundry_sdk.v2.third_party_applications.errors import FileCountLimitExceeded` | **ThirdPartyApplications** | FileSizeLimitExceeded | `from foundry_sdk.v2.third_party_applications.errors import FileSizeLimitExceeded` | **ThirdPartyApplications** | InvalidVersion | `from foundry_sdk.v2.third_party_applications.errors import InvalidVersion` | -**ThirdPartyApplications** | ScanningErrored | `from foundry_sdk.v2.third_party_applications.errors import ScanningErrored` | -**ThirdPartyApplications** | ScanningInProgress | `from foundry_sdk.v2.third_party_applications.errors import ScanningInProgress` | -**ThirdPartyApplications** | SiteAssetHasVulnerabilities | `from foundry_sdk.v2.third_party_applications.errors import SiteAssetHasVulnerabilities` | **ThirdPartyApplications** | ThirdPartyApplicationNotFound | `from foundry_sdk.v2.third_party_applications.errors import ThirdPartyApplicationNotFound` | **ThirdPartyApplications** | UndeployWebsitePermissionDenied | `from foundry_sdk.v2.third_party_applications.errors import UndeployWebsitePermissionDenied` | **ThirdPartyApplications** | UploadSnapshotVersionPermissionDenied | `from foundry_sdk.v2.third_party_applications.errors import UploadSnapshotVersionPermissionDenied` | @@ -3975,10 +3537,12 @@ Namespace | Name | Import | **ThirdPartyApplications** | VersionNotFound | `from foundry_sdk.v2.third_party_applications.errors import VersionNotFound` | **ThirdPartyApplications** | WebsiteNotFound | `from foundry_sdk.v2.third_party_applications.errors import WebsiteNotFound` | **Widgets** | DeleteReleasePermissionDenied | `from foundry_sdk.v2.widgets.errors import DeleteReleasePermissionDenied` | +**Widgets** | DevModeSettingsNotFound | `from foundry_sdk.v2.widgets.errors import DevModeSettingsNotFound` | +**Widgets** | DisableDevModeSettingsPermissionDenied | `from foundry_sdk.v2.widgets.errors import DisableDevModeSettingsPermissionDenied` | **Widgets** | EnableDevModeSettingsPermissionDenied | `from foundry_sdk.v2.widgets.errors import EnableDevModeSettingsPermissionDenied` | -**Widgets** | EnableDevModeSettingsV2PermissionDenied | `from foundry_sdk.v2.widgets.errors import EnableDevModeSettingsV2PermissionDenied` | **Widgets** | FileCountLimitExceeded | `from foundry_sdk.v2.widgets.errors import FileCountLimitExceeded` | **Widgets** | FileSizeLimitExceeded | `from foundry_sdk.v2.widgets.errors import FileSizeLimitExceeded` | +**Widgets** | GetDevModeSettingsPermissionDenied | `from foundry_sdk.v2.widgets.errors import GetDevModeSettingsPermissionDenied` | **Widgets** | InvalidDevModeBaseHref | `from foundry_sdk.v2.widgets.errors import InvalidDevModeBaseHref` | **Widgets** | InvalidDevModeEntrypointCssCount | `from foundry_sdk.v2.widgets.errors import InvalidDevModeEntrypointCssCount` | **Widgets** | InvalidDevModeEntrypointJsCount | `from foundry_sdk.v2.widgets.errors import InvalidDevModeEntrypointJsCount` | @@ -4008,11 +3572,12 @@ Namespace | Name | Import | **Widgets** | InvalidWidgetId | `from foundry_sdk.v2.widgets.errors import InvalidWidgetId` | **Widgets** | InvalidWidgetName | `from foundry_sdk.v2.widgets.errors import InvalidWidgetName` | **Widgets** | OntologySdkNotFound | `from foundry_sdk.v2.widgets.errors import OntologySdkNotFound` | +**Widgets** | PauseDevModeSettingsPermissionDenied | `from foundry_sdk.v2.widgets.errors import PauseDevModeSettingsPermissionDenied` | **Widgets** | PublishReleasePermissionDenied | `from foundry_sdk.v2.widgets.errors import PublishReleasePermissionDenied` | **Widgets** | ReleaseNotFound | `from foundry_sdk.v2.widgets.errors import ReleaseNotFound` | **Widgets** | RepositoryNotFound | `from foundry_sdk.v2.widgets.errors import RepositoryNotFound` | **Widgets** | SetWidgetSetDevModeSettingsByIdPermissionDenied | `from foundry_sdk.v2.widgets.errors import SetWidgetSetDevModeSettingsByIdPermissionDenied` | -**Widgets** | SetWidgetSetManifestDevModeSettingsV2PermissionDenied | `from foundry_sdk.v2.widgets.errors import SetWidgetSetManifestDevModeSettingsV2PermissionDenied` | +**Widgets** | SetWidgetSetDevModeSettingsPermissionDenied | `from foundry_sdk.v2.widgets.errors import SetWidgetSetDevModeSettingsPermissionDenied` | **Widgets** | VersionAlreadyExists | `from foundry_sdk.v2.widgets.errors import VersionAlreadyExists` | **Widgets** | VersionLimitExceeded | `from foundry_sdk.v2.widgets.errors import VersionLimitExceeded` | **Widgets** | WidgetIdNotFound | `from foundry_sdk.v2.widgets.errors import WidgetIdNotFound` | @@ -4061,7 +3626,6 @@ Namespace | Name | Import | **Datasets** | UploadFilePermissionDenied | `from foundry_sdk.v1.datasets.errors import UploadFilePermissionDenied` | **Ontologies** | ActionContainsDuplicateEdits | `from foundry_sdk.v1.ontologies.errors import ActionContainsDuplicateEdits` | **Ontologies** | ActionEditedPropertiesNotFound | `from foundry_sdk.v1.ontologies.errors import ActionEditedPropertiesNotFound` | -**Ontologies** | ActionEditsNotSupportedWithMarketplace | `from foundry_sdk.v1.ontologies.errors import ActionEditsNotSupportedWithMarketplace` | **Ontologies** | ActionEditsReadOnlyEntity | `from foundry_sdk.v1.ontologies.errors import ActionEditsReadOnlyEntity` | **Ontologies** | ActionNotFound | `from foundry_sdk.v1.ontologies.errors import ActionNotFound` | **Ontologies** | ActionParameterInterfaceTypeNotFound | `from foundry_sdk.v1.ontologies.errors import ActionParameterInterfaceTypeNotFound` | @@ -4078,20 +3642,17 @@ Namespace | Name | Import | **Ontologies** | AttachmentNotFound | `from foundry_sdk.v1.ontologies.errors import AttachmentNotFound` | **Ontologies** | AttachmentRidAlreadyExists | `from foundry_sdk.v1.ontologies.errors import AttachmentRidAlreadyExists` | **Ontologies** | AttachmentSizeExceededLimit | `from foundry_sdk.v1.ontologies.errors import AttachmentSizeExceededLimit` | -**Ontologies** | BranchNotSupportedWithMarketplaceQuery | `from foundry_sdk.v1.ontologies.errors import BranchNotSupportedWithMarketplaceQuery` | **Ontologies** | CipherChannelNotFound | `from foundry_sdk.v1.ontologies.errors import CipherChannelNotFound` | **Ontologies** | CompositePrimaryKeyNotSupported | `from foundry_sdk.v1.ontologies.errors import CompositePrimaryKeyNotSupported` | **Ontologies** | ConsistentSnapshotError | `from foundry_sdk.v1.ontologies.errors import ConsistentSnapshotError` | **Ontologies** | DefaultAndNullGroupsNotSupported | `from foundry_sdk.v1.ontologies.errors import DefaultAndNullGroupsNotSupported` | **Ontologies** | DerivedPropertyApiNamesNotUnique | `from foundry_sdk.v1.ontologies.errors import DerivedPropertyApiNamesNotUnique` | -**Ontologies** | DistinctEnumValuesExceededLimit | `from foundry_sdk.v1.ontologies.errors import DistinctEnumValuesExceededLimit` | **Ontologies** | DuplicateOrderBy | `from foundry_sdk.v1.ontologies.errors import DuplicateOrderBy` | **Ontologies** | EditObjectPermissionDenied | `from foundry_sdk.v1.ontologies.errors import EditObjectPermissionDenied` | **Ontologies** | FunctionEncounteredUserFacingError | `from foundry_sdk.v1.ontologies.errors import FunctionEncounteredUserFacingError` | **Ontologies** | FunctionExecutionFailed | `from foundry_sdk.v1.ontologies.errors import FunctionExecutionFailed` | **Ontologies** | FunctionExecutionTimedOut | `from foundry_sdk.v1.ontologies.errors import FunctionExecutionTimedOut` | **Ontologies** | FunctionInvalidInput | `from foundry_sdk.v1.ontologies.errors import FunctionInvalidInput` | -**Ontologies** | FunctionNotSupportedWithTransaction | `from foundry_sdk.v1.ontologies.errors import FunctionNotSupportedWithTransaction` | **Ontologies** | HighScaleComputationNotEnabled | `from foundry_sdk.v1.ontologies.errors import HighScaleComputationNotEnabled` | **Ontologies** | IncompatibleNestedObjectSet | `from foundry_sdk.v1.ontologies.errors import IncompatibleNestedObjectSet` | **Ontologies** | InterfaceBasedObjectSetNotSupported | `from foundry_sdk.v1.ontologies.errors import InterfaceBasedObjectSetNotSupported` | @@ -4112,7 +3673,6 @@ Namespace | Name | Import | **Ontologies** | InvalidContentLength | `from foundry_sdk.v1.ontologies.errors import InvalidContentLength` | **Ontologies** | InvalidContentType | `from foundry_sdk.v1.ontologies.errors import InvalidContentType` | **Ontologies** | InvalidDerivedPropertyDefinition | `from foundry_sdk.v1.ontologies.errors import InvalidDerivedPropertyDefinition` | -**Ontologies** | InvalidDerivedPropertyDefinitionOnInterface | `from foundry_sdk.v1.ontologies.errors import InvalidDerivedPropertyDefinitionOnInterface` | **Ontologies** | InvalidDurationGroupByPropertyType | `from foundry_sdk.v1.ontologies.errors import InvalidDurationGroupByPropertyType` | **Ontologies** | InvalidDurationGroupByPropertyTypeForInterface | `from foundry_sdk.v1.ontologies.errors import InvalidDurationGroupByPropertyTypeForInterface` | **Ontologies** | InvalidDurationGroupByValue | `from foundry_sdk.v1.ontologies.errors import InvalidDurationGroupByValue` | @@ -4162,7 +3722,6 @@ Namespace | Name | Import | **Ontologies** | ObjectTypeNotSynced | `from foundry_sdk.v1.ontologies.errors import ObjectTypeNotSynced` | **Ontologies** | ObjectTypesNotSynced | `from foundry_sdk.v1.ontologies.errors import ObjectTypesNotSynced` | **Ontologies** | OntologyApiNameNotUnique | `from foundry_sdk.v1.ontologies.errors import OntologyApiNameNotUnique` | -**Ontologies** | OntologyDefinitionOutOfSync | `from foundry_sdk.v1.ontologies.errors import OntologyDefinitionOutOfSync` | **Ontologies** | OntologyEditsExceededLimit | `from foundry_sdk.v1.ontologies.errors import OntologyEditsExceededLimit` | **Ontologies** | OntologyNotFound | `from foundry_sdk.v1.ontologies.errors import OntologyNotFound` | **Ontologies** | OntologySyncing | `from foundry_sdk.v1.ontologies.errors import OntologySyncing` | diff --git a/docs-snippets-npm/package.json b/docs-snippets-npm/package.json index 7241991fe..712349bd5 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.1598.2", + "minVersion": "1.1473.2", "maxVersion": "1.x.x", "optional": false } diff --git a/docs-snippets-npm/src/index.ts b/docs-snippets-npm/src/index.ts index 9fc02c32a..96501b511 100644 --- a/docs-snippets-npm/src/index.ts +++ b/docs-snippets-npm/src/index.ts @@ -250,17 +250,7 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets.media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID.\nmedia_item_rid = None\n# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.\npreview = None\n# Optional[TransactionId] | The id of the transaction associated with this request. Required if this is a transactional media set.\ntransaction_id = None\n# Optional[MediaSetViewRid] | Specifies the specific view by rid to which this media item will be uploaded. May not be provided if branch name or branch rid are provided.\nview_rid = None\n\n\ntry:\n api_response = client.media_sets.MediaSet.upload(\n media_set_rid,\n body,\n branch_name=branch_name,\n branch_rid=branch_rid,\n media_item_path=media_item_path,\n media_item_rid=media_item_rid,\n preview=preview,\n transaction_id=transaction_id,\n view_rid=view_rid,\n )\n print(\"The upload response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling MediaSet.upload: %s\\n\" % e)" + "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# MediaSetRid\nmedia_set_rid = None\n# bytes | Body of the request\nbody = None\n# Optional[BranchName] | Specifies the specific branch by name to which this media item will be uploaded. May not be provided if branch rid or view rid are provided.\nbranch_name = None\n# Optional[BranchRid] | Specifies the specific branch by rid to which this media item will be uploaded. May not be provided if branch name or view rid are provided.\nbranch_rid = None\n# Optional[MediaItemPath] | An identifier for a media item within a media set. Necessary if the backing media set requires paths.\nmedia_item_path = \"q3-data%2fmy-file.png\"\n# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.\npreview = None\n# Optional[TransactionId] | The id of the transaction associated with this request. Required if this is a transactional media set.\ntransaction_id = None\n# Optional[MediaSetViewRid] | Specifies the specific view by rid to which this media item will be uploaded. May not be provided if branch name or branch rid are provided.\nview_rid = None\n\n\ntry:\n api_response = client.media_sets.MediaSet.upload(\n media_set_rid,\n body,\n branch_name=branch_name,\n branch_rid=branch_rid,\n media_item_path=media_item_path,\n preview=preview,\n transaction_id=transaction_id,\n view_rid=view_rid,\n )\n print(\"The upload response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling MediaSet.upload: %s\\n\" % e)" } ], "v2.uploadMedia": [ { - "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# bytes | Body of the request\nbody = None\n# MediaItemPath | A user-defined label for a media item within a media set. Required if the backing media set requires paths. Uploading multiple files to the same path will result in only the most recent file being associated with the path.\nfilename = \"my-file.png\"\n# Optional[Attribution] | used for passing through usage attribution\nattribution = None\n# Optional[MediaItemRid] | An optional RID to use for the media item to create. If omitted, the server will automatically generate a RID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your workflow strictly requires deterministic or client-controlled identifiers. The RID must be in the format of `ri.mio..media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID.\nmedia_item_rid = None\n# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.\npreview = None\n\n\ntry:\n api_response = client.media_sets.MediaSet.upload_media(\n body,\n filename=filename,\n attribution=attribution,\n media_item_rid=media_item_rid,\n preview=preview,\n )\n print(\"The upload_media response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling MediaSet.upload_media: %s\\n\" % e)" - } - ], - "v2.getExperiment": [ - { - "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# ModelRid\nmodel_rid = None\n# ExperimentRid\nexperiment_rid = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.models.Model.Experiment.get(model_rid, experiment_rid, preview=preview)\n print(\"The get response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling Experiment.get: %s\\n\" % e)" - } - ], - "v2.searchExperiments": [ - { - "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# ModelRid\nmodel_rid = None\n# Optional[SearchExperimentsOrderBy] | The field to sort by. Default is to sort by relevance.\norder_by = {\"field\": \"EXPERIMENT_NAME\", \"direction\": \"ASC\"}\n# Optional[PageSize] | The maximum number of results to return. Default 50, maximum of 100.\npage_size = 100\n# Optional[PageToken] | PageToken to identify the next page to retrieve. Leave empty for the first request.\npage_token = \"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z\"\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n# Optional[SearchExperimentsFilter] | Optional search filter for filtering experiments. If not provided, all experiments for the model are returned.\nwhere = None\n\n\ntry:\n api_response = client.models.Model.Experiment.search(\n model_rid,\n order_by=order_by,\n page_size=page_size,\n page_token=page_token,\n preview=preview,\n where=where,\n )\n print(\"The search response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling Experiment.search: %s\\n\" % e)" - } - ], - "v2.jsonExperimentArtifactTable": [ - { - "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# ModelRid\nmodel_rid = None\n# ExperimentRid\nexperiment_rid = None\n# ExperimentArtifactName\nexperiment_artifact_table_name = None\n# Optional[int] | Number of rows to skip from the beginning. Defaults to 0.\noffset = None\n# Optional[PageSize] | Maximum number of rows to return. Default is 10, maximum is 100.\npage_size = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.models.Model.Experiment.ArtifactTable.json(\n model_rid,\n experiment_rid,\n experiment_artifact_table_name,\n offset=offset,\n page_size=page_size,\n preview=preview,\n )\n print(\"The json response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling ArtifactTable.json: %s\\n\" % e)" - } - ], - "v2.parquetExperimentArtifactTable": [ - { - "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# ModelRid\nmodel_rid = None\n# ExperimentRid\nexperiment_rid = None\n# ExperimentArtifactName\nexperiment_artifact_table_name = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.models.Model.Experiment.ArtifactTable.parquet(\n model_rid, experiment_rid, experiment_artifact_table_name, preview=preview\n )\n print(\"The parquet response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling ArtifactTable.parquet: %s\\n\" % e)" - } - ], - "v2.jsonExperimentSeries": [ - { - "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# ModelRid\nmodel_rid = None\n# ExperimentRid\nexperiment_rid = None\n# SeriesName\nexperiment_series_name = None\n# Optional[int] | Number of values to skip from the beginning. Defaults to 0.\noffset = None\n# Optional[PageSize] | Maximum number of values to return per page. Default is 200, maximum is 1000.\npage_size = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.models.Model.Experiment.Series.json(\n model_rid,\n experiment_rid,\n experiment_series_name,\n offset=offset,\n page_size=page_size,\n preview=preview,\n )\n print(\"The json response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling Series.json: %s\\n\" % e)" - } - ], - "v2.parquetExperimentSeries": [ - { - "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# ModelRid\nmodel_rid = None\n# ExperimentRid\nexperiment_rid = None\n# SeriesName\nexperiment_series_name = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.models.Model.Experiment.Series.parquet(\n model_rid, experiment_rid, experiment_series_name, preview=preview\n )\n print(\"The parquet response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling Series.parquet: %s\\n\" % e)" - } - ], - "v2.createLiveDeployment": [ - { - "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# CreateLiveDeploymentTarget | The target model source for the live deployment. Determines which model and version selection strategy to use when creating the deployment.\ndeployment_type = None\n# LiveDeploymentRuntimeConfiguration | The compute resource configuration for the deployment.\nruntime_configuration = {\n \"minReplicas\": 1,\n \"maxReplicas\": 3,\n \"cpu\": 1.0,\n \"memory\": \"256MiB\",\n \"threadCount\": 32,\n}\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.models.LiveDeployment.create(\n deployment_type=deployment_type,\n runtime_configuration=runtime_configuration,\n preview=preview,\n )\n print(\"The create response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling LiveDeployment.create: %s\\n\" % e)" - } - ], - "v2.getLiveDeployment": [ - { - "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# LiveDeploymentRid\nlive_deployment_rid = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.models.LiveDeployment.get(live_deployment_rid, preview=preview)\n print(\"The get response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling LiveDeployment.get: %s\\n\" % e)" - } - ], - "v2.replaceLiveDeployment": [ - { - "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# LiveDeploymentRid\nlive_deployment_rid = None\n# LiveDeploymentRuntimeConfiguration | The compute resource configuration for the deployment.\nruntime_configuration = {\n \"minReplicas\": 1,\n \"maxReplicas\": 3,\n \"cpu\": 1.0,\n \"memory\": \"256MiB\",\n \"threadCount\": 32,\n}\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.models.LiveDeployment.replace(\n live_deployment_rid, runtime_configuration=runtime_configuration, preview=preview\n )\n print(\"The replace response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling LiveDeployment.replace: %s\\n\" % e)" - } - ], - "v2.transformJsonLiveDeployment": [ - { - "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# LiveDeploymentRid\nlive_deployment_rid = None\n# Dict[str, Any] | The input data for the model inference. The structure should match the model's transform API specification, where each key is an input name and the value is the corresponding input data.\ninput = {\"input_df\": [{\"feature_1\": 1.0, \"feature_2\": 2}]}\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.models.LiveDeployment.transform_json(\n live_deployment_rid, input=input, preview=preview\n )\n print(\"The transform_json response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling LiveDeployment.transform_json: %s\\n\" % e)" + "template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# bytes | Body of the request\nbody = None\n# MediaItemPath | The path to write the media item to. Required if the backing media set requires paths.\nfilename = \"my-file.png\"\n# Optional[Attribution] | used for passing through usage attribution\nattribution = None\n# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.\npreview = None\n\n\ntry:\n api_response = client.media_sets.MediaSet.upload_media(\n body, filename=filename, attribution=attribution, preview=preview\n )\n print(\"The upload_media response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling MediaSet.upload_media: %s\\n\" % e)" } ], "v2.createModel": [ @@ -1343,79 +1198,9 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets.media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. | [optional] | **preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | **transaction_id** | Optional[TransactionId] | The id of the transaction associated with this request. Required if this is a transactional media set. | [optional] | **view_rid** | Optional[MediaSetViewRid] | Specifies the specific view by rid to which this media item will be uploaded. May not be provided if branch name or branch rid are provided. | [optional] | @@ -1125,8 +905,6 @@ branch_name = None branch_rid = None # Optional[MediaItemPath] | An identifier for a media item within a media set. Necessary if the backing media set requires paths. media_item_path = "q3-data%2fmy-file.png" -# Optional[MediaItemRid] | An optional RID to use for the media item to create. If omitted, the server will automatically generate a RID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your workflow strictly requires deterministic or client-controlled identifiers. The RID must be in the format of `ri.mio..media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. -media_item_rid = None # Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. preview = None # Optional[TransactionId] | The id of the transaction associated with this request. Required if this is a transactional media set. @@ -1142,7 +920,6 @@ try: branch_name=branch_name, branch_rid=branch_rid, media_item_path=media_item_path, - media_item_rid=media_item_rid, preview=preview, transaction_id=transaction_id, view_rid=view_rid, @@ -1181,9 +958,8 @@ Third-party applications using this endpoint via OAuth2 must request the followi Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **body** | bytes | Body of the request | | -**filename** | MediaItemPath | A user-defined label for a media item within a media set. Required if the backing media set requires paths. Uploading multiple files to the same path will result in only the most recent file being associated with the path. | | +**filename** | MediaItemPath | The path to write the media item to. Required if the backing media set requires paths. | | **attribution** | Optional[Attribution] | used for passing through usage attribution | [optional] | -**media_item_rid** | Optional[MediaItemRid] | An optional RID to use for the media item to create. If omitted, the server will automatically generate a RID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your workflow strictly requires deterministic or client-controlled identifiers. The RID must be in the format of `ri.mio..media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. | [optional] | **preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | ### Return type @@ -1200,23 +976,17 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # bytes | Body of the request body = None -# MediaItemPath | A user-defined label for a media item within a media set. Required if the backing media set requires paths. Uploading multiple files to the same path will result in only the most recent file being associated with the path. +# MediaItemPath | The path to write the media item to. Required if the backing media set requires paths. filename = "my-file.png" # Optional[Attribution] | used for passing through usage attribution attribution = None -# Optional[MediaItemRid] | An optional RID to use for the media item to create. If omitted, the server will automatically generate a RID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your workflow strictly requires deterministic or client-controlled identifiers. The RID must be in the format of `ri.mio..media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. -media_item_rid = None # Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. preview = None try: api_response = client.media_sets.MediaSet.upload_media( - body, - filename=filename, - attribution=attribution, - media_item_rid=media_item_rid, - preview=preview, + body, filename=filename, attribution=attribution, preview=preview ) print("The upload_media response:\n") pprint(api_response) diff --git a/docs/v2/MediaSets/models/ApiNameLocatorWrapper.md b/docs/v2/MediaSets/models/ApiNameLocatorWrapper.md deleted file mode 100644 index d00e83c95..000000000 --- a/docs/v2/MediaSets/models/ApiNameLocatorWrapper.md +++ /dev/null @@ -1,12 +0,0 @@ -# ApiNameLocatorWrapper - -Wrapper for API name-based model locator. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | str | Yes | The API name of the language model. | -**type** | Literal["apiName"] | 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/BatchTransactionsTransactionPolicy.md b/docs/v2/MediaSets/models/BatchTransactionsTransactionPolicy.md deleted file mode 100644 index 810da20e5..000000000 --- a/docs/v2/MediaSets/models/BatchTransactionsTransactionPolicy.md +++ /dev/null @@ -1,13 +0,0 @@ -# BatchTransactionsTransactionPolicy - -All writes must be part of a transaction. Transactions are branch-scoped and created by calling -create transaction. Writes are not visible until commit transaction is called. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["batchTransactions"] | 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/ChatLlmSpec.md b/docs/v2/MediaSets/models/ChatLlmSpec.md deleted file mode 100644 index c7b0ef15a..000000000 --- a/docs/v2/MediaSets/models/ChatLlmSpec.md +++ /dev/null @@ -1,14 +0,0 @@ -# ChatLlmSpec - -Standard chat-based LLM specification with system and user prompts. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**model_locator** | LanguageModelLocator | Yes | | -**system_prompt** | str | Yes | System prompt for the LLM. | -**user_prompt** | str | Yes | User prompt for the LLM. | -**max_tokens** | Optional[int] | No | Maximum number of tokens per request to generate. | - - -[[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/ChatLlmSpecWrapper.md b/docs/v2/MediaSets/models/ChatLlmSpecWrapper.md deleted file mode 100644 index 96c15c36d..000000000 --- a/docs/v2/MediaSets/models/ChatLlmSpecWrapper.md +++ /dev/null @@ -1,12 +0,0 @@ -# ChatLlmSpecWrapper - -Wrapper for chat-based LLM specification. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**chat** | ChatLlmSpec | Yes | | -**type** | Literal["chat"] | 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/CropConfig.md b/docs/v2/MediaSets/models/CropConfig.md deleted file mode 100644 index a0d775eb7..000000000 --- a/docs/v2/MediaSets/models/CropConfig.md +++ /dev/null @@ -1,11 +0,0 @@ -# CropConfig - -Configuration for table cropping. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**table_prompt** | str | Yes | Prompt for table extraction. | - - -[[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 index 676a47f96..cb0adeef8 100644 --- a/docs/v2/MediaSets/models/DocumentDecodeFormat.md +++ b/docs/v2/MediaSets/models/DocumentDecodeFormat.md @@ -5,11 +5,9 @@ The format of a document media item. | **Value** | | --------- | | `"PDF"` | -| `"DOC"` | | `"DOCX"` | | `"TXT"` | | `"PPTX"` | -| `"RTF"` | [[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/DocumentToTextOperation.md b/docs/v2/MediaSets/models/DocumentToTextOperation.md index e2149ddf2..95fff5a32 100644 --- a/docs/v2/MediaSets/models/DocumentToTextOperation.md +++ b/docs/v2/MediaSets/models/DocumentToTextOperation.md @@ -12,12 +12,9 @@ This discriminator class uses the `type` field to differentiate between classes. ExtractTableOfContentsOperation | extractTableOfContents GetPdfPageDimensionsOperation | getPdfPageDimensions ExtractAllTextOperation | extractAllText -ExtractVlmTextOperation | extractVlmText ExtractTextFromPagesToArrayOperation | extractTextFromPagesToArray OcrOnPageOperation | ocrOnPage ExtractFormFieldsOperation | extractFormFields -ExtractDocumentLayoutAwareTextV2Operation | extractLayoutAwareTextV2 -ExtractDocumentTextV2Operation | extractTextV2 ExtractUnstructuredTextFromPageOperation | extractUnstructuredTextFromPage DocumentExtractLayoutAwareContentOperation | extractLayoutAwareContent OcrOnPagesOperation | ocrOnPages diff --git a/docs/v2/MediaSets/models/ExtractDocumentLayoutAwareTextV2Config.md b/docs/v2/MediaSets/models/ExtractDocumentLayoutAwareTextV2Config.md deleted file mode 100644 index 176d30a05..000000000 --- a/docs/v2/MediaSets/models/ExtractDocumentLayoutAwareTextV2Config.md +++ /dev/null @@ -1,13 +0,0 @@ -# ExtractDocumentLayoutAwareTextV2Config - -Configuration for v2 layout-aware document text extraction. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**format** | Optional[TextOutputFormat] | No | | -**mode** | Optional[OcrMode] | No | | -**languages** | List[OcrLanguageOrScript] | Yes | List of OCR languages or scripts to use. | - - -[[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/ExtractDocumentLayoutAwareTextV2Operation.md b/docs/v2/MediaSets/models/ExtractDocumentLayoutAwareTextV2Operation.md deleted file mode 100644 index 5bb027e87..000000000 --- a/docs/v2/MediaSets/models/ExtractDocumentLayoutAwareTextV2Operation.md +++ /dev/null @@ -1,15 +0,0 @@ -# ExtractDocumentLayoutAwareTextV2Operation - -Extract layout aware text with bounding boxes across all pages using the v2 text extraction endpoint. -This only supports PDFs. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**page_range** | Optional[PageRange] | No | | -**config** | ExtractDocumentLayoutAwareTextV2Config | Yes | | -**type** | Literal["extractLayoutAwareTextV2"] | 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/ExtractDocumentTextV2Config.md b/docs/v2/MediaSets/models/ExtractDocumentTextV2Config.md deleted file mode 100644 index ec4ec5853..000000000 --- a/docs/v2/MediaSets/models/ExtractDocumentTextV2Config.md +++ /dev/null @@ -1,13 +0,0 @@ -# ExtractDocumentTextV2Config - -Configuration for v2 document text extraction. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**format** | Optional[TextOutputFormat] | No | | -**mode** | Optional[OcrMode] | No | | -**languages** | List[OcrLanguageOrScript] | Yes | List of OCR languages or scripts to use. | - - -[[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/ExtractDocumentTextV2Operation.md b/docs/v2/MediaSets/models/ExtractDocumentTextV2Operation.md deleted file mode 100644 index 0b7e25b97..000000000 --- a/docs/v2/MediaSets/models/ExtractDocumentTextV2Operation.md +++ /dev/null @@ -1,15 +0,0 @@ -# ExtractDocumentTextV2Operation - -Extract text across all pages using the v2 text extraction endpoint with per page text. -This only supports PDFs. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**page_range** | Optional[PageRange] | No | | -**config** | ExtractDocumentTextV2Config | Yes | | -**type** | Literal["extractTextV2"] | 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/ExtractTextPreprocessingWrapper.md b/docs/v2/MediaSets/models/ExtractTextPreprocessingWrapper.md deleted file mode 100644 index a9617245b..000000000 --- a/docs/v2/MediaSets/models/ExtractTextPreprocessingWrapper.md +++ /dev/null @@ -1,12 +0,0 @@ -# ExtractTextPreprocessingWrapper - -Wrapper for text extraction preprocessing. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**extract_text** | ExtractDocumentTextV2Config | Yes | | -**type** | Literal["extractText"] | 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/ExtractVlmTextOperation.md b/docs/v2/MediaSets/models/ExtractVlmTextOperation.md deleted file mode 100644 index b1bf9a673..000000000 --- a/docs/v2/MediaSets/models/ExtractVlmTextOperation.md +++ /dev/null @@ -1,18 +0,0 @@ -# ExtractVlmTextOperation - -Extract text from a document using vision language models (VLMs). -VLMs can understand document layout and structure more intelligently than traditional OCR. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**llm_spec** | LlmSpec | Yes | | -**preprocessing_configuration** | Optional[VlmPreprocessingConfig] | No | | -**image_spec** | Optional[ImageSpec] | No | | -**output_format** | TextOutputFormat | Yes | | -**page_range** | Optional[PageRange] | No | | -**type** | Literal["extractVlmText"] | 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/GetMediaItemInfoResponse.md b/docs/v2/MediaSets/models/GetMediaItemInfoResponse.md index 46a437ba4..8be4abc2c 100644 --- a/docs/v2/MediaSets/models/GetMediaItemInfoResponse.md +++ b/docs/v2/MediaSets/models/GetMediaItemInfoResponse.md @@ -9,9 +9,6 @@ GetMediaItemInfoResponse **path** | Optional[MediaItemPath] | No | | **logical_timestamp** | LogicalTimestamp | Yes | | **attribution** | Optional[MediaAttribution] | No | | -**originally_uploaded_file_mime_type** | Optional[MediaType] | No | | -**mime_type** | Optional[MediaType] | No | | -**size_bytes** | Optional[int] | No | The size of the media item in bytes. | [[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/GetMediaSetResponse.md b/docs/v2/MediaSets/models/GetMediaSetResponse.md deleted file mode 100644 index 2e9fba51b..000000000 --- a/docs/v2/MediaSets/models/GetMediaSetResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# GetMediaSetResponse - -Information about a media set. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | MediaSetRid | Yes | | -**media_schema** | MediaSchema | Yes | | -**default_branch_name** | BranchName | Yes | | -**transaction_policy** | TransactionPolicy | Yes | | -**paths_required** | bool | Yes | Whether media items in this media set require paths. | - - -[[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/ImageSpec.md b/docs/v2/MediaSets/models/ImageSpec.md deleted file mode 100644 index 37140d4fe..000000000 --- a/docs/v2/MediaSets/models/ImageSpec.md +++ /dev/null @@ -1,16 +0,0 @@ -# ImageSpec - -Specification for image processing parameters used in vision-based extraction. -Controls how document pages are converted to images before being sent to vision models. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**resizing_mode** | ResizingMode | Yes | | -**height** | Optional[int] | No | Target height in pixels. | -**width** | Optional[int] | No | Target width in pixels. | -**mime_type** | ImageryDecodeFormat | 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/LanguageModelLocator.md b/docs/v2/MediaSets/models/LanguageModelLocator.md deleted file mode 100644 index 8805bccbf..000000000 --- a/docs/v2/MediaSets/models/LanguageModelLocator.md +++ /dev/null @@ -1,11 +0,0 @@ -# LanguageModelLocator - -Locator for identifying a language model. - -## Type -```python -ApiNameLocatorWrapper -``` - - -[[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/LayoutAwareExtractionPreprocessingConfig.md b/docs/v2/MediaSets/models/LayoutAwareExtractionPreprocessingConfig.md deleted file mode 100644 index 872a5a538..000000000 --- a/docs/v2/MediaSets/models/LayoutAwareExtractionPreprocessingConfig.md +++ /dev/null @@ -1,12 +0,0 @@ -# LayoutAwareExtractionPreprocessingConfig - -Configuration for layout-aware extraction preprocessing. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**transformation_config** | ExtractDocumentLayoutAwareTextV2Config | Yes | | -**crop_config** | Optional[CropConfig] | 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/LayoutAwarePreprocessingWrapper.md b/docs/v2/MediaSets/models/LayoutAwarePreprocessingWrapper.md deleted file mode 100644 index 5b76cb45f..000000000 --- a/docs/v2/MediaSets/models/LayoutAwarePreprocessingWrapper.md +++ /dev/null @@ -1,12 +0,0 @@ -# LayoutAwarePreprocessingWrapper - -Wrapper for layout-aware preprocessing. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**layout_aware** | LayoutAwareExtractionPreprocessingConfig | Yes | | -**type** | Literal["layoutAware"] | 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/LlmSpec.md b/docs/v2/MediaSets/models/LlmSpec.md deleted file mode 100644 index 4555113fa..000000000 --- a/docs/v2/MediaSets/models/LlmSpec.md +++ /dev/null @@ -1,11 +0,0 @@ -# LlmSpec - -Specification for language model requests. - -## Type -```python -ChatLlmSpecWrapper -``` - - -[[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 index dc10b61dc..04bd61bce 100644 --- a/docs/v2/MediaSets/models/MediaItemMetadata.md +++ b/docs/v2/MediaSets/models/MediaItemMetadata.md @@ -16,7 +16,6 @@ ImageryMediaItemMetadata | imagery SpreadsheetMediaItemMetadata | spreadsheet UntypedMediaItemMetadata | untyped AudioMediaItemMetadata | audio -Model3dMediaItemMetadata | model3d VideoMediaItemMetadata | video DicomMediaItemMetadata | dicom EmailMediaItemMetadata | email diff --git a/docs/v2/MediaSets/models/MediaSchema.md b/docs/v2/MediaSets/models/MediaSchema.md deleted file mode 100644 index a52ad6bd3..000000000 --- a/docs/v2/MediaSets/models/MediaSchema.md +++ /dev/null @@ -1,19 +0,0 @@ -# MediaSchema - -The schema type of a media set, indicating what type of media items it can contain. - -| **Value** | -| --------- | -| `"AUDIO"` | -| `"DICOM"` | -| `"DOCUMENT"` | -| `"IMAGERY"` | -| `"MODEL_3D"` | -| `"MULTIMODAL"` | -| `"SPREADSHEET"` | -| `"STREAMING_VIDEO"` | -| `"VIDEO"` | -| `"EMAIL"` | - - -[[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/Model3dDecodeFormat.md b/docs/v2/MediaSets/models/Model3dDecodeFormat.md deleted file mode 100644 index b015d65ac..000000000 --- a/docs/v2/MediaSets/models/Model3dDecodeFormat.md +++ /dev/null @@ -1,12 +0,0 @@ -# Model3dDecodeFormat - -The format of a 3D model media item. - -| **Value** | -| --------- | -| `"LAS"` | -| `"PLY"` | -| `"OBJ"` | - - -[[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/Model3dMediaItemMetadata.md b/docs/v2/MediaSets/models/Model3dMediaItemMetadata.md deleted file mode 100644 index 751c3e685..000000000 --- a/docs/v2/MediaSets/models/Model3dMediaItemMetadata.md +++ /dev/null @@ -1,14 +0,0 @@ -# Model3dMediaItemMetadata - -Metadata for 3D model media items. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**format** | Model3dDecodeFormat | Yes | | -**model_type** | Model3dType | Yes | | -**size_bytes** | int | Yes | The size of the media item in bytes. | -**type** | Literal["model3d"] | 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/NoTransactionsTransactionPolicy.md b/docs/v2/MediaSets/models/NoTransactionsTransactionPolicy.md deleted file mode 100644 index 27ffca1a6..000000000 --- a/docs/v2/MediaSets/models/NoTransactionsTransactionPolicy.md +++ /dev/null @@ -1,13 +0,0 @@ -# NoTransactionsTransactionPolicy - -Writes are not part of a transaction and are immediately visible. -Calls to create transaction or commit transaction will error. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["noTransactions"] | 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/OcrMode.md b/docs/v2/MediaSets/models/OcrMode.md deleted file mode 100644 index 553c5eae8..000000000 --- a/docs/v2/MediaSets/models/OcrMode.md +++ /dev/null @@ -1,12 +0,0 @@ -# OcrMode - -OCR mode for document extraction. - -| **Value** | -| --------- | -| `"AUTO"` | -| `"ELECTRONIC"` | -| `"SCAN"` | - - -[[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/PageRange.md b/docs/v2/MediaSets/models/PageRange.md deleted file mode 100644 index a1cfc1533..000000000 --- a/docs/v2/MediaSets/models/PageRange.md +++ /dev/null @@ -1,12 +0,0 @@ -# PageRange - -Page range for document extraction. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**start_page_inclusive** | Optional[int] | No | Start page index (0-based, inclusive). If not provided, defaults to start of document. | -**end_page_exclusive** | Optional[int] | No | End page index (0-based, exclusive). If not provided, defaults to end of document. | - - -[[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/PutMediaItemResponse.md b/docs/v2/MediaSets/models/PutMediaItemResponse.md index cf592fcb0..7effefec8 100644 --- a/docs/v2/MediaSets/models/PutMediaItemResponse.md +++ b/docs/v2/MediaSets/models/PutMediaItemResponse.md @@ -6,7 +6,6 @@ PutMediaItemResponse | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **media_item_rid** | MediaItemRid | Yes | | -**media_set_view_rid** | MediaSetViewRid | 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/RegisterMediaItemRequest.md b/docs/v2/MediaSets/models/RegisterMediaItemRequest.md deleted file mode 100644 index b99874730..000000000 --- a/docs/v2/MediaSets/models/RegisterMediaItemRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# RegisterMediaItemRequest - -Request to register a media item from a federated store. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**physical_item_name** | str | Yes | The relative path within the federated media store where the media item exists. | -**media_item_path** | Optional[MediaItemPath] | 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/RegisterMediaItemResponse.md b/docs/v2/MediaSets/models/RegisterMediaItemResponse.md deleted file mode 100644 index f3ce6ec22..000000000 --- a/docs/v2/MediaSets/models/RegisterMediaItemResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# RegisterMediaItemResponse - -Response after successfully registering a media item. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**media_item_rid** | MediaItemRid | Yes | | -**media_type** | MediaType | 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/ResizingMode.md b/docs/v2/MediaSets/models/ResizingMode.md deleted file mode 100644 index bc97af47f..000000000 --- a/docs/v2/MediaSets/models/ResizingMode.md +++ /dev/null @@ -1,11 +0,0 @@ -# ResizingMode - -Image resizing strategy. - -| **Value** | -| --------- | -| `"RESIZING"` | -| `"FIT_INTO_BOUNDING_BOX"` | - - -[[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/TextOutputFormat.md b/docs/v2/MediaSets/models/TextOutputFormat.md deleted file mode 100644 index 153a7dc26..000000000 --- a/docs/v2/MediaSets/models/TextOutputFormat.md +++ /dev/null @@ -1,12 +0,0 @@ -# TextOutputFormat - -Format in which to return extracted text. - -| **Value** | -| --------- | -| `"TEXT"` | -| `"MARKDOWN"` | -| `"HTML"` | - - -[[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/TransactionPolicy.md b/docs/v2/MediaSets/models/TransactionPolicy.md deleted file mode 100644 index a2380c4a3..000000000 --- a/docs/v2/MediaSets/models/TransactionPolicy.md +++ /dev/null @@ -1,17 +0,0 @@ -# TransactionPolicy - -The transaction policy for a media set, determining how writes are handled. - - -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 -| ------------ | ------------- -BatchTransactionsTransactionPolicy | batchTransactions -NoTransactionsTransactionPolicy | noTransactions - - -[[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/VlmPreprocessingConfig.md b/docs/v2/MediaSets/models/VlmPreprocessingConfig.md deleted file mode 100644 index 520a5e96f..000000000 --- a/docs/v2/MediaSets/models/VlmPreprocessingConfig.md +++ /dev/null @@ -1,16 +0,0 @@ -# VlmPreprocessingConfig - -Preprocessing configuration for VLM extraction. - -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 -| ------------ | ------------- -LayoutAwarePreprocessingWrapper | layoutAware -ExtractTextPreprocessingWrapper | extractText - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/Experiment.md b/docs/v2/Models/Experiment.md deleted file mode 100644 index 657bc241c..000000000 --- a/docs/v2/Models/Experiment.md +++ /dev/null @@ -1,133 +0,0 @@ -# Experiment - -Method | HTTP request | Release Stage | -------------- | ------------- | ----- | -[**get**](#get) | **GET** /v2/models/{modelRid}/experiments/{experimentRid} | Private Beta | -[**search**](#search) | **POST** /v2/models/{modelRid}/experiments/search | Private Beta | - -# **get** -Retrieve a single experiment with all metadata, parameters, series metadata, and summary metrics. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_rid** | ModelRid | | | -**experiment_rid** | ExperimentRid | | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**Experiment** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ModelRid -model_rid = None -# ExperimentRid -experiment_rid = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.Model.Experiment.get(model_rid, experiment_rid, preview=preview) - print("The get response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Experiment.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Experiment | | 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) - -# **search** -Search experiments using complex nested queries on experiment metadata, parameters, series, -and summary metrics. Supports AND/OR/NOT combinations and various predicates. -Returns a maximum of 100 results per page. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_rid** | ModelRid | | | -**order_by** | Optional[SearchExperimentsOrderBy] | The field to sort by. Default is to sort by relevance. | [optional] | -**page_size** | Optional[PageSize] | The maximum number of results to return. Default 50, maximum of 100. | [optional] | -**page_token** | Optional[PageToken] | PageToken to identify the next page to retrieve. Leave empty for the first request. | [optional] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | -**where** | Optional[SearchExperimentsFilter] | Optional search filter for filtering experiments. If not provided, all experiments for the model are returned. | [optional] | - -### Return type -**SearchExperimentsResponse** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ModelRid -model_rid = None -# Optional[SearchExperimentsOrderBy] | The field to sort by. Default is to sort by relevance. -order_by = {"field": "EXPERIMENT_NAME", "direction": "ASC"} -# Optional[PageSize] | The maximum number of results to return. Default 50, maximum of 100. -page_size = 100 -# Optional[PageToken] | PageToken to identify the next page to retrieve. Leave empty for the first request. -page_token = "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z" -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None -# Optional[SearchExperimentsFilter] | Optional search filter for filtering experiments. If not provided, all experiments for the model are returned. -where = None - - -try: - api_response = client.models.Model.Experiment.search( - model_rid, - order_by=order_by, - page_size=page_size, - page_token=page_token, - preview=preview, - where=where, - ) - print("The search response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Experiment.search: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | SearchExperimentsResponse | | 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) - diff --git a/docs/v2/Models/ExperimentArtifactTable.md b/docs/v2/Models/ExperimentArtifactTable.md deleted file mode 100644 index b84658776..000000000 --- a/docs/v2/Models/ExperimentArtifactTable.md +++ /dev/null @@ -1,160 +0,0 @@ -# ExperimentArtifactTable - -Method | HTTP request | Release Stage | -------------- | ------------- | ----- | -[**json**](#json) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/artifactTables/{experimentArtifactTableName}/json | Private Beta | -[**parquet**](#parquet) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/artifactTables/{experimentArtifactTableName}/parquet | Private Beta | - -# **json** -Read table data from an experiment artifact as a streamed binary response containing JSON. -The response body is a JSON array of row objects, where each object maps column names to values. -Results are paginated by row count with a default page size of 10 and a maximum of 100. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_rid** | ModelRid | | | -**experiment_rid** | ExperimentRid | | | -**experiment_artifact_table_name** | ExperimentArtifactName | | | -**offset** | Optional[int] | Number of rows to skip from the beginning. Defaults to 0. | [optional] | -**page_size** | Optional[PageSize] | Maximum number of rows to return. Default is 10, maximum is 100. | [optional] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**bytes** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ModelRid -model_rid = None -# ExperimentRid -experiment_rid = None -# ExperimentArtifactName -experiment_artifact_table_name = None -# Optional[int] | Number of rows to skip from the beginning. Defaults to 0. -offset = None -# Optional[PageSize] | Maximum number of rows to return. Default is 10, maximum is 100. -page_size = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.Model.Experiment.ArtifactTable.json( - model_rid, - experiment_rid, - experiment_artifact_table_name, - offset=offset, - page_size=page_size, - preview=preview, - ) - print("The json response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling ArtifactTable.json: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | bytes | | application/octet-stream | - -[[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) - -# **parquet** -Read raw table data from experiment artifacts in Parquet format. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_rid** | ModelRid | | | -**experiment_rid** | ExperimentRid | | | -**experiment_artifact_table_name** | ExperimentArtifactName | | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**bytes** - -> [!TIP] -> This operation returns tabular data that can be converted to data frame formats: -> -> ```python -> # Get data in Arrow format -> table_data = client.models.Model.Experiment.ArtifactTable.parquet(model_rid, experiment_rid, experiment_artifact_table_name, preview=preview) -> -> # Convert to a PyArrow Table -> arrow_table = table_data.to_pyarrow() -> -> # Convert to a Pandas DataFrame -> pandas_df = table_data.to_pandas() -> -> # Convert to a Polars DataFrame -> polars_df = table_data.to_polars() -> -> # Convert to a DuckDB relation -> duckdb_relation = table_data.to_duckdb() -> ``` -> -> For more details, see the [Data Frames section](../../../README.md#data-frames) in the README. - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ModelRid -model_rid = None -# ExperimentRid -experiment_rid = None -# ExperimentArtifactName -experiment_artifact_table_name = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.Model.Experiment.ArtifactTable.parquet( - model_rid, experiment_rid, experiment_artifact_table_name, preview=preview - ) - print("The parquet response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling ArtifactTable.parquet: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | bytes | | application/octet-stream | - -[[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) - diff --git a/docs/v2/Models/ExperimentSeries.md b/docs/v2/Models/ExperimentSeries.md deleted file mode 100644 index b0b444da2..000000000 --- a/docs/v2/Models/ExperimentSeries.md +++ /dev/null @@ -1,159 +0,0 @@ -# ExperimentSeries - -Method | HTTP request | Release Stage | -------------- | ------------- | ----- | -[**json**](#json) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/json | Private Beta | -[**parquet**](#parquet) | **GET** /v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/parquet | Private Beta | - -# **json** -Retrieve raw time-series data for a single series in JSON format. -Results are paginated with a default page size of 200 and a maximum of 1000. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_rid** | ModelRid | | | -**experiment_rid** | ExperimentRid | | | -**experiment_series_name** | SeriesName | | | -**offset** | Optional[int] | Number of values to skip from the beginning. Defaults to 0. | [optional] | -**page_size** | Optional[PageSize] | Maximum number of values to return per page. Default is 200, maximum is 1000. | [optional] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**Series** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ModelRid -model_rid = None -# ExperimentRid -experiment_rid = None -# SeriesName -experiment_series_name = None -# Optional[int] | Number of values to skip from the beginning. Defaults to 0. -offset = None -# Optional[PageSize] | Maximum number of values to return per page. Default is 200, maximum is 1000. -page_size = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.Model.Experiment.Series.json( - model_rid, - experiment_rid, - experiment_series_name, - offset=offset, - page_size=page_size, - preview=preview, - ) - print("The json response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Series.json: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Series | | 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) - -# **parquet** -Retrieve raw time-series data for a single series as a streamed binary response in Apache Parquet format. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_rid** | ModelRid | | | -**experiment_rid** | ExperimentRid | | | -**experiment_series_name** | SeriesName | | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**bytes** - -> [!TIP] -> This operation returns tabular data that can be converted to data frame formats: -> -> ```python -> # Get data in Arrow format -> table_data = client.models.Model.Experiment.Series.parquet(model_rid, experiment_rid, experiment_series_name, preview=preview) -> -> # Convert to a PyArrow Table -> arrow_table = table_data.to_pyarrow() -> -> # Convert to a Pandas DataFrame -> pandas_df = table_data.to_pandas() -> -> # Convert to a Polars DataFrame -> polars_df = table_data.to_polars() -> -> # Convert to a DuckDB relation -> duckdb_relation = table_data.to_duckdb() -> ``` -> -> For more details, see the [Data Frames section](../../../README.md#data-frames) in the README. - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ModelRid -model_rid = None -# ExperimentRid -experiment_rid = None -# SeriesName -experiment_series_name = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.Model.Experiment.Series.parquet( - model_rid, experiment_rid, experiment_series_name, preview=preview - ) - print("The parquet response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Series.parquet: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | bytes | | application/octet-stream | - -[[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) - diff --git a/docs/v2/Models/LiveDeployment.md b/docs/v2/Models/LiveDeployment.md deleted file mode 100644 index 627efbf16..000000000 --- a/docs/v2/Models/LiveDeployment.md +++ /dev/null @@ -1,242 +0,0 @@ -# LiveDeployment - -Method | HTTP request | Release Stage | -------------- | ------------- | ----- | -[**create**](#create) | **POST** /v2/models/liveDeployments | Private Beta | -[**get**](#get) | **GET** /v2/models/liveDeployments/{liveDeploymentRid} | Private Beta | -[**replace**](#replace) | **PUT** /v2/models/liveDeployments/{liveDeploymentRid} | Private Beta | -[**transform_json**](#transform_json) | **POST** /v2/models/liveDeployments/{liveDeploymentRid}/transformJson | Public Beta | - -# **create** -Creates a new live deployment for a model version with the specified runtime configuration. The deployment will begin provisioning compute resources and deploying the target model version. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**deployment_type** | CreateLiveDeploymentTarget | The target model source for the live deployment. Determines which model and version selection strategy to use when creating the deployment. | | -**runtime_configuration** | LiveDeploymentRuntimeConfiguration | The compute resource configuration for the deployment. | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**LiveDeployment** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# CreateLiveDeploymentTarget | The target model source for the live deployment. Determines which model and version selection strategy to use when creating the deployment. -deployment_type = None -# LiveDeploymentRuntimeConfiguration | The compute resource configuration for the deployment. -runtime_configuration = { - "minReplicas": 1, - "maxReplicas": 3, - "cpu": 1.0, - "memory": "256MiB", - "threadCount": 32, -} -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.LiveDeployment.create( - deployment_type=deployment_type, - runtime_configuration=runtime_configuration, - preview=preview, - ) - print("The create response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling LiveDeployment.create: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | LiveDeployment | The created LiveDeployment | 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) - -# **get** -Retrieves a live deployment by its Resource Identifier (RID), including its deployed model version and runtime configuration. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**live_deployment_rid** | LiveDeploymentRid | | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**LiveDeployment** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# LiveDeploymentRid -live_deployment_rid = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.LiveDeployment.get(live_deployment_rid, preview=preview) - print("The get response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling LiveDeployment.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | LiveDeployment | | 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) - -# **replace** -Updates the runtime configuration of the live deployment. The deployment will apply the new configuration to the running replicas. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**live_deployment_rid** | LiveDeploymentRid | | | -**runtime_configuration** | LiveDeploymentRuntimeConfiguration | The compute resource configuration for the deployment. | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**LiveDeployment** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# LiveDeploymentRid -live_deployment_rid = None -# LiveDeploymentRuntimeConfiguration | The compute resource configuration for the deployment. -runtime_configuration = { - "minReplicas": 1, - "maxReplicas": 3, - "cpu": 1.0, - "memory": "256MiB", - "threadCount": 32, -} -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.LiveDeployment.replace( - live_deployment_rid, runtime_configuration=runtime_configuration, preview=preview - ) - print("The replace response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling LiveDeployment.replace: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | LiveDeployment | The replaced LiveDeployment | 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) - -# **transform_json** -Performs inference on the live deployment. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**live_deployment_rid** | LiveDeploymentRid | | | -**input** | Dict[str, Any] | The input data for the model inference. The structure should match the model's transform API specification, where each key is an input name and the value is the corresponding input data. | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**TransformLiveDeploymentResponse** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# LiveDeploymentRid -live_deployment_rid = None -# Dict[str, Any] | The input data for the model inference. The structure should match the model's transform API specification, where each key is an input name and the value is the corresponding input data. -input = {"input_df": [{"feature_1": 1.0, "feature_2": 2}]} -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.LiveDeployment.transform_json( - live_deployment_rid, input=input, preview=preview - ) - print("The transform_json response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling LiveDeployment.transform_json: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | TransformLiveDeploymentResponse | | 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) - diff --git a/docs/v2/Models/Model.md b/docs/v2/Models/Model.md index 7af947203..520562b89 100644 --- a/docs/v2/Models/Model.md +++ b/docs/v2/Models/Model.md @@ -2,9 +2,8 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | -[**create**](#create) | **POST** /v2/models | Public Beta | -[**get**](#get) | **GET** /v2/models/{modelRid} | Public Beta | -[**promote_version**](#promote_version) | **POST** /v2/models/{modelRid}/promoteVersion | Public Beta | +[**create**](#create) | **POST** /v2/models | Private Beta | +[**get**](#get) | **GET** /v2/models/{modelRid} | Private Beta | # **create** Creates a new Model with no versions. @@ -111,62 +110,3 @@ 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) -# **promote_version** -Promotes an existing Model Version to the target Model. The promoted Model Version will be copied to the target Model as the latest version on the specified branch, but will have a new Model Version RID. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_rid** | ModelRid | | | -**source_model_version_rid** | ModelVersionRid | | | -**branch** | Optional[BranchName] | The branch to promote the version to. Defaults to master on most enrollments. | [optional] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ModelVersion** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ModelRid -model_rid = None -# ModelVersionRid -source_model_version_rid = "ri.models.main.model-version.adf94926-c3ac-41ea-beb2-4946699d08ee" -# Optional[BranchName] | The branch to promote the version to. Defaults to master on most enrollments. -branch = "master" -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.Model.promote_version( - model_rid, source_model_version_rid=source_model_version_rid, branch=branch, preview=preview - ) - print("The promote_version response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Model.promote_version: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ModelVersion | | 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) - diff --git a/docs/v2/Models/ModelFunction.md b/docs/v2/Models/ModelFunction.md deleted file mode 100644 index 48ed3b01f..000000000 --- a/docs/v2/Models/ModelFunction.md +++ /dev/null @@ -1,192 +0,0 @@ -# ModelFunction - -Method | HTTP request | Release Stage | -------------- | ------------- | ----- | -[**create**](#create) | **POST** /v2/models/liveDeployments/{liveDeploymentRid}/function | Private Beta | -[**get**](#get) | **GET** /v2/models/liveDeployments/{liveDeploymentRid}/function | Private Beta | -[**replace**](#replace) | **PUT** /v2/models/liveDeployments/{liveDeploymentRid}/function | Private Beta | - -# **create** -Creates a function for the live deployment. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**live_deployment_rid** | LiveDeploymentRid | | | -**api_name** | ModelFunctionApiName | | | -**display_name** | ModelFunctionDisplayName | | | -**is_row_wise** | ModelFunctionIsRowWise | | | -**ontology_binding** | Optional[OntologyRid] | | [optional] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ModelFunction** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# LiveDeploymentRid -live_deployment_rid = None -# ModelFunctionApiName -api_name = "myModelFunction" -# ModelFunctionDisplayName -display_name = "Core.DisplayName" -# ModelFunctionIsRowWise -is_row_wise = False -# Optional[OntologyRid] -ontology_binding = "ri.ontology.main.ontology.a1b2c3d4-e5f6-7890-abcd-ef1234567890" -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.LiveDeployment.Function.create( - live_deployment_rid, - api_name=api_name, - display_name=display_name, - is_row_wise=is_row_wise, - ontology_binding=ontology_binding, - preview=preview, - ) - print("The create response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Function.create: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ModelFunction | The created ModelFunction | 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) - -# **get** -Gets the function for the live deployment. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**live_deployment_rid** | LiveDeploymentRid | | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ModelFunction** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# LiveDeploymentRid -live_deployment_rid = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.LiveDeployment.Function.get(live_deployment_rid, preview=preview) - print("The get response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Function.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ModelFunction | | 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) - -# **replace** -Replaces the function for the live deployment. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**live_deployment_rid** | LiveDeploymentRid | | | -**api_name** | ModelFunctionApiName | | | -**is_row_wise** | ModelFunctionIsRowWise | | | -**ontology_binding** | Optional[OntologyRid] | | [optional] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ModelFunction** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# LiveDeploymentRid -live_deployment_rid = None -# ModelFunctionApiName -api_name = "myModelFunction" -# ModelFunctionIsRowWise -is_row_wise = False -# Optional[OntologyRid] -ontology_binding = "ri.ontology.main.ontology.a1b2c3d4-e5f6-7890-abcd-ef1234567890" -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.LiveDeployment.Function.replace( - live_deployment_rid, - api_name=api_name, - is_row_wise=is_row_wise, - ontology_binding=ontology_binding, - preview=preview, - ) - print("The replace response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Function.replace: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ModelFunction | The replaced ModelFunction | 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) - diff --git a/docs/v2/Models/ModelStudio.md b/docs/v2/Models/ModelStudio.md deleted file mode 100644 index 303638456..000000000 --- a/docs/v2/Models/ModelStudio.md +++ /dev/null @@ -1,163 +0,0 @@ -# ModelStudio - -Method | HTTP request | Release Stage | -------------- | ------------- | ----- | -[**create**](#create) | **POST** /v2/models/modelStudios | Private Beta | -[**get**](#get) | **GET** /v2/models/modelStudios/{modelStudioRid} | Private Beta | -[**launch**](#launch) | **POST** /v2/models/modelStudios/{modelStudioRid}/launch | Private Beta | - -# **create** -Creates a new Model Studio. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**name** | str | The name of the Model Studio. | | -**parent_folder_rid** | FolderRid | The RID of the parent folder where the studio will be created. | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ModelStudio** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# str | The name of the Model Studio. -name = None -# FolderRid | The RID of the parent folder where the studio will be created. -parent_folder_rid = "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791" -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.ModelStudio.create( - name=name, parent_folder_rid=parent_folder_rid, preview=preview - ) - print("The create response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling ModelStudio.create: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ModelStudio | The created ModelStudio | 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) - -# **get** -Gets details about a Model Studio by its RID. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_studio_rid** | ModelStudioRid | | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ModelStudio** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ModelStudioRid -model_studio_rid = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.ModelStudio.get(model_studio_rid, preview=preview) - print("The get response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling ModelStudio.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ModelStudio | | 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) - -# **launch** -Launches a new training run for the Model Studio using the latest configuration version. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_studio_rid** | ModelStudioRid | | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ModelStudioRun** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ModelStudioRid -model_studio_rid = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.ModelStudio.launch(model_studio_rid, preview=preview) - print("The launch response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling ModelStudio.launch: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ModelStudioRun | | 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) - diff --git a/docs/v2/Models/ModelStudioConfigVersion.md b/docs/v2/Models/ModelStudioConfigVersion.md deleted file mode 100644 index 5ce0fd3fe..000000000 --- a/docs/v2/Models/ModelStudioConfigVersion.md +++ /dev/null @@ -1,244 +0,0 @@ -# ModelStudioConfigVersion - -Method | HTTP request | Release Stage | -------------- | ------------- | ----- | -[**create**](#create) | **POST** /v2/models/modelStudios/{modelStudioRid}/configVersions | Private Beta | -[**get**](#get) | **GET** /v2/models/modelStudios/{modelStudioRid}/configVersions/{modelStudioConfigVersionVersion} | Private Beta | -[**latest**](#latest) | **GET** /v2/models/modelStudios/{modelStudioRid}/configVersions/latest | Private Beta | -[**list**](#list) | **GET** /v2/models/modelStudios/{modelStudioRid}/configVersions | Private Beta | - -# **create** -Creates a new Model Studio configuration version. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_studio_rid** | ModelStudioRid | | | -**name** | ModelStudioConfigVersionName | Human readable name of the configuration version and experiment. | | -**resources** | ResourceConfiguration | The compute resources allocated for training runs. | | -**trainer_id** | TrainerId | The identifier of the trainer to use for this configuration. | | -**worker_config** | ModelStudioWorkerConfig | The worker configuration including inputs, outputs, and custom settings. | | -**changelog** | Optional[str] | Changelog describing changes in this version. | [optional] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ModelStudioConfigVersion** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ModelStudioRid -model_studio_rid = None -# ModelStudioConfigVersionName | Human readable name of the configuration version and experiment. -name = None -# ResourceConfiguration | The compute resources allocated for training runs. -resources = {"gpu": "A100"} -# TrainerId | The identifier of the trainer to use for this configuration. -trainer_id = "autogluon" -# ModelStudioWorkerConfig | The worker configuration including inputs, outputs, and custom settings. -worker_config = None -# Optional[str] | Changelog describing changes in this version. -changelog = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.ModelStudio.ConfigVersion.create( - model_studio_rid, - name=name, - resources=resources, - trainer_id=trainer_id, - worker_config=worker_config, - changelog=changelog, - preview=preview, - ) - print("The create response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling ConfigVersion.create: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ModelStudioConfigVersion | The created ModelStudioConfigVersion | 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) - -# **get** -Gets a specific Model Studio configuration version. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_studio_rid** | ModelStudioRid | | | -**model_studio_config_version_version** | ModelStudioConfigVersionNumber | The version number of this configuration. | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ModelStudioConfigVersion** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ModelStudioRid -model_studio_rid = None -# ModelStudioConfigVersionNumber | The version number of this configuration. -model_studio_config_version_version = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.ModelStudio.ConfigVersion.get( - model_studio_rid, model_studio_config_version_version, preview=preview - ) - print("The get response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling ConfigVersion.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ModelStudioConfigVersion | | 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) - -# **latest** -Gets the latest configuration version for a Model Studio. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_studio_rid** | ModelStudioRid | | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**Optional[ModelStudioConfigVersion]** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ModelStudioRid -model_studio_rid = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.ModelStudio.ConfigVersion.latest(model_studio_rid, preview=preview) - print("The latest response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling ConfigVersion.latest: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Optional[ModelStudioConfigVersion] | | 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) - -# **list** -Lists all configuration versions for a Model Studio. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_studio_rid** | ModelStudioRid | | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**page_token** | Optional[PageToken] | The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. | [optional] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListModelStudioConfigVersionsResponse** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ModelStudioRid -model_studio_rid = None -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# Optional[PageToken] | The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - for model_studio_config_version in client.models.ModelStudio.ConfigVersion.list( - model_studio_rid, page_size=page_size, page_token=page_token, preview=preview - ): - pprint(model_studio_config_version) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling ConfigVersion.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListModelStudioConfigVersionsResponse | | 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) - diff --git a/docs/v2/Models/ModelStudioRun.md b/docs/v2/Models/ModelStudioRun.md deleted file mode 100644 index 598acb491..000000000 --- a/docs/v2/Models/ModelStudioRun.md +++ /dev/null @@ -1,70 +0,0 @@ -# ModelStudioRun - -Method | HTTP request | Release Stage | -------------- | ------------- | ----- | -[**list**](#list) | **GET** /v2/models/modelStudios/{modelStudioRid}/runs | Private Beta | - -# **list** -Lists all runs for a Model Studio. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_studio_rid** | ModelStudioRid | | | -**config_version** | Optional[ModelStudioConfigVersionNumber] | Filter runs by configuration version. | [optional] | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**page_token** | Optional[PageToken] | The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. | [optional] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListModelStudioRunsResponse** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ModelStudioRid -model_studio_rid = None -# Optional[ModelStudioConfigVersionNumber] | Filter runs by configuration version. -config_version = None -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# Optional[PageToken] | The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - for model_studio_run in client.models.ModelStudio.Run.list( - model_studio_rid, - config_version=config_version, - page_size=page_size, - page_token=page_token, - preview=preview, - ): - pprint(model_studio_run) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Run.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListModelStudioRunsResponse | | 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) - diff --git a/docs/v2/Models/ModelStudioTrainer.md b/docs/v2/Models/ModelStudioTrainer.md deleted file mode 100644 index 75d79c230..000000000 --- a/docs/v2/Models/ModelStudioTrainer.md +++ /dev/null @@ -1,109 +0,0 @@ -# ModelStudioTrainer - -Method | HTTP request | Release Stage | -------------- | ------------- | ----- | -[**get**](#get) | **GET** /v2/models/modelStudioTrainers/{modelStudioTrainerTrainerId} | Private Beta | -[**list**](#list) | **GET** /v2/models/modelStudioTrainers | Private Beta | - -# **get** -Gets details about a specific trainer by its ID and optional version. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**model_studio_trainer_trainer_id** | TrainerId | | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | -**version** | Optional[TrainerVersion] | Specific version of the trainer to retrieve. If not specified, returns the latest version. | [optional] | - -### Return type -**ModelStudioTrainer** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# TrainerId -model_studio_trainer_trainer_id = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None -# Optional[TrainerVersion] | Specific version of the trainer to retrieve. If not specified, returns the latest version. -version = None - - -try: - api_response = client.models.ModelStudioTrainer.get( - model_studio_trainer_trainer_id, preview=preview, version=version - ) - print("The get response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling ModelStudioTrainer.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ModelStudioTrainer | | 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) - -# **list** -Lists all available trainers for Model Studios. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListModelStudioTrainersResponse** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.models.ModelStudioTrainer.list(preview=preview) - print("The list response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling ModelStudioTrainer.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListModelStudioTrainersResponse | | 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) - diff --git a/docs/v2/Models/ModelVersion.md b/docs/v2/Models/ModelVersion.md index 3e47930f4..143426931 100644 --- a/docs/v2/Models/ModelVersion.md +++ b/docs/v2/Models/ModelVersion.md @@ -3,8 +3,8 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**create**](#create) | **POST** /v2/models/{modelRid}/versions | Private Beta | -[**get**](#get) | **GET** /v2/models/{modelRid}/versions/{modelVersionRid} | Public Beta | -[**list**](#list) | **GET** /v2/models/{modelRid}/versions | Public Beta | +[**get**](#get) | **GET** /v2/models/{modelRid}/versions/{modelVersionRid} | Private Beta | +[**list**](#list) | **GET** /v2/models/{modelRid}/versions | Private Beta | # **create** Creates a new Model Version on an existing model. @@ -35,9 +35,9 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # ModelRid model_rid = None # List[RID] -backing_repositories = ["ri.stemma.main.repository.a1b2c3d4-e5f6-7890-abcd-ef1234567890"] +backing_repositories = None # List[str] -conda_requirements = ["numpy==1.24.0", "pandas==2.0.0"] +conda_requirements = None # ModelApi model_api = { "inputs": [ @@ -161,7 +161,6 @@ Lists all Model Versions for a given Model. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **model_rid** | ModelRid | | | -**branch** | Optional[BranchName] | The branch to list versions from. Defaults to master on most enrollments. | [optional] | **page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | **page_token** | Optional[PageToken] | The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -180,8 +179,6 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # ModelRid model_rid = None -# Optional[BranchName] | The branch to list versions from. Defaults to master on most enrollments. -branch = None # Optional[PageSize] | The page size to use for the endpoint. page_size = None # Optional[PageToken] | The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. @@ -192,7 +189,7 @@ preview = None try: for model_version in client.models.Model.Version.list( - model_rid, branch=branch, page_size=page_size, page_token=page_token, preview=preview + model_rid, page_size=page_size, page_token=page_token, preview=preview ): pprint(model_version) except foundry_sdk.PalantirRPCException as e: diff --git a/docs/v2/Models/models/BooleanParameter.md b/docs/v2/Models/models/BooleanParameter.md deleted file mode 100644 index c734b1d9b..000000000 --- a/docs/v2/Models/models/BooleanParameter.md +++ /dev/null @@ -1,12 +0,0 @@ -# BooleanParameter - -A boolean parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | bool | Yes | | -**type** | Literal["boolean"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ChangelogTooLongError.md b/docs/v2/Models/models/ChangelogTooLongError.md deleted file mode 100644 index f7c7b725f..000000000 --- a/docs/v2/Models/models/ChangelogTooLongError.md +++ /dev/null @@ -1,13 +0,0 @@ -# ChangelogTooLongError - -The provided changelog exceeds the maximum allowed length. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**max_length** | int | Yes | The maximum allowed changelog length. | -**actual_length** | int | Yes | The actual length of the provided changelog. | -**type** | Literal["changelogTooLong"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ColumnTypeSpecId.md b/docs/v2/Models/models/ColumnTypeSpecId.md deleted file mode 100644 index da0574e30..000000000 --- a/docs/v2/Models/models/ColumnTypeSpecId.md +++ /dev/null @@ -1,11 +0,0 @@ -# ColumnTypeSpecId - -An identifier for a column type specification. - -## 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/Models/models/CreateConfigValidationFailureReason.md b/docs/v2/Models/models/CreateConfigValidationFailureReason.md deleted file mode 100644 index 1651704a5..000000000 --- a/docs/v2/Models/models/CreateConfigValidationFailureReason.md +++ /dev/null @@ -1,30 +0,0 @@ -# CreateConfigValidationFailureReason - -A specific reason why configuration validation failed. - -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 -| ------------ | ------------- -JsonSchemaValidationError | jsonSchemaValidationFailure -OutputResourceInDifferentProjectError | outputResourceInDifferentProject -OtherValidationError | other -MissingWorkerConfigOutputError | missingWorkerConfigOutput -MissingRequiredDatasetColumnError | missingRequiredDatasetColumn -MultiplePropertiesNotAllowedForTrainerError | multiplePropertiesNotAllowedForTrainer -FieldValidationError | fieldValidationFailure -ChangelogTooLongError | changelogTooLong -UnknownColumnSpecIdInConfigColumnMappingError | unknownColumnSpecIdInConfigColumnMapping -MultipleColumnsNotAllowedForTrainerError | multipleColumnsNotAllowedForTrainer -MissingWorkerConfigInputDatasetColumnMappingError | missingWorkerConfigInputDatasetColumnMapping -DatasetSchemaNotFoundError | datasetSchemaNotFound -MissingWorkerConfigInputError | missingWorkerConfigInput -MissingWorkerConfigInputObjectSetPropertyMappingError | missingWorkerConfigInputObjectSetPropertyMapping -OutputResourceNotFoundError | outputResourceNotFound -InvalidResourceConfigurationError | invalidResourceConfiguration - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/CreateLiveDeploymentRequest.md b/docs/v2/Models/models/CreateLiveDeploymentRequest.md deleted file mode 100644 index fed69720f..000000000 --- a/docs/v2/Models/models/CreateLiveDeploymentRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateLiveDeploymentRequest - -CreateLiveDeploymentRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**deployment_type** | CreateLiveDeploymentTarget | Yes | The target model source for the live deployment. Determines which model and version selection strategy to use when creating the deployment. | -**runtime_configuration** | LiveDeploymentRuntimeConfiguration | Yes | The compute resource configuration for the deployment. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/CreateLiveDeploymentTarget.md b/docs/v2/Models/models/CreateLiveDeploymentTarget.md deleted file mode 100644 index c2e105815..000000000 --- a/docs/v2/Models/models/CreateLiveDeploymentTarget.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateLiveDeploymentTarget - -The target model source for the live deployment. Determines which model and version selection strategy to use when creating the deployment. - - -## Type -```python -DirectCreateLiveDeploymentTarget -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/CreateModelFunctionRequest.md b/docs/v2/Models/models/CreateModelFunctionRequest.md deleted file mode 100644 index 52421a1c8..000000000 --- a/docs/v2/Models/models/CreateModelFunctionRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# CreateModelFunctionRequest - -CreateModelFunctionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | ModelFunctionApiName | Yes | | -**ontology_binding** | Optional[OntologyRid] | No | | -**is_row_wise** | ModelFunctionIsRowWise | Yes | | -**display_name** | ModelFunctionDisplayName | 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/Models/models/CreateModelStudioConfigVersionRequest.md b/docs/v2/Models/models/CreateModelStudioConfigVersionRequest.md deleted file mode 100644 index 8a9dfb17d..000000000 --- a/docs/v2/Models/models/CreateModelStudioConfigVersionRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# CreateModelStudioConfigVersionRequest - -CreateModelStudioConfigVersionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | ModelStudioConfigVersionName | Yes | Human readable name of the configuration version and experiment. | -**resources** | ResourceConfiguration | Yes | The compute resources allocated for training runs. | -**changelog** | Optional[str] | No | Changelog describing changes in this version. | -**worker_config** | ModelStudioWorkerConfig | Yes | The worker configuration including inputs, outputs, and custom settings. | -**trainer_id** | TrainerId | Yes | The identifier of the trainer to use for this configuration. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/CreateModelStudioRequest.md b/docs/v2/Models/models/CreateModelStudioRequest.md deleted file mode 100644 index e61f3b411..000000000 --- a/docs/v2/Models/models/CreateModelStudioRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateModelStudioRequest - -CreateModelStudioRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | str | Yes | The name of the Model Studio. | -**parent_folder_rid** | FolderRid | Yes | The RID of the parent folder where the studio will be created. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/DatasetInput.md b/docs/v2/Models/models/DatasetInput.md deleted file mode 100644 index 60e0cf7ba..000000000 --- a/docs/v2/Models/models/DatasetInput.md +++ /dev/null @@ -1,15 +0,0 @@ -# DatasetInput - -Dataset input configuration. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | RID | Yes | The RID of the input dataset. | -**column_mapping** | Dict[ColumnTypeSpecId, List[ColumnName]] | Yes | Mapping of column type spec IDs to column names. | -**ignore_columns** | List[ColumnName] | Yes | Columns to ignore from the dataset. | -**select_columns** | List[ColumnName] | Yes | Columns to select from the dataset. If empty, all columns not in ignoreColumns will be used. | -**type** | Literal["dataset"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/DatasetSchemaNotFoundError.md b/docs/v2/Models/models/DatasetSchemaNotFoundError.md deleted file mode 100644 index ad9f98cdc..000000000 --- a/docs/v2/Models/models/DatasetSchemaNotFoundError.md +++ /dev/null @@ -1,12 +0,0 @@ -# DatasetSchemaNotFoundError - -A schema could not be found for the specified dataset. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**dataset_rid** | RID | Yes | The RID of the dataset whose schema was not found. | -**type** | Literal["datasetSchemaNotFound"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/DatetimeParameter.md b/docs/v2/Models/models/DatetimeParameter.md deleted file mode 100644 index a58788368..000000000 --- a/docs/v2/Models/models/DatetimeParameter.md +++ /dev/null @@ -1,12 +0,0 @@ -# DatetimeParameter - -A datetime parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | datetime | Yes | | -**type** | Literal["datetime"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/DirectCreateLiveDeploymentTarget.md b/docs/v2/Models/models/DirectCreateLiveDeploymentTarget.md deleted file mode 100644 index 849af169e..000000000 --- a/docs/v2/Models/models/DirectCreateLiveDeploymentTarget.md +++ /dev/null @@ -1,14 +0,0 @@ -# DirectCreateLiveDeploymentTarget - -Creates a live deployment that tracks the latest model version on a branch. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**model_rid** | ModelRid | Yes | | -**branch** | str | Yes | The model branch for the deployment. | -**type** | Literal["direct"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/DoubleParameter.md b/docs/v2/Models/models/DoubleParameter.md deleted file mode 100644 index 5fe9d6362..000000000 --- a/docs/v2/Models/models/DoubleParameter.md +++ /dev/null @@ -1,12 +0,0 @@ -# DoubleParameter - -A double parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | float | Yes | | -**type** | Literal["double"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/DoubleSeriesAggregations.md b/docs/v2/Models/models/DoubleSeriesAggregations.md deleted file mode 100644 index 0deb18969..000000000 --- a/docs/v2/Models/models/DoubleSeriesAggregations.md +++ /dev/null @@ -1,14 +0,0 @@ -# DoubleSeriesAggregations - -Aggregated statistics for numeric series. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**min** | Optional[float] | No | Minimum value in the series. Absent if the metric has not been computed. | -**max** | Optional[float] | No | Maximum value in the series. Absent if the metric has not been computed. | -**last** | Optional[float] | No | Most recent value in the series. Absent if the metric has not been computed. | -**type** | Literal["double"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/DoubleSeriesV1.md b/docs/v2/Models/models/DoubleSeriesV1.md deleted file mode 100644 index 0163b11da..000000000 --- a/docs/v2/Models/models/DoubleSeriesV1.md +++ /dev/null @@ -1,12 +0,0 @@ -# DoubleSeriesV1 - -A series of double values. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**series** | List[DoubleSeriesValueV1] | Yes | | -**type** | Literal["doubleV1"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/DoubleSeriesValueV1.md b/docs/v2/Models/models/DoubleSeriesValueV1.md deleted file mode 100644 index a69572b6f..000000000 --- a/docs/v2/Models/models/DoubleSeriesValueV1.md +++ /dev/null @@ -1,13 +0,0 @@ -# DoubleSeriesValueV1 - -A single double value in a series. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | float | Yes | | -**timestamp** | EpochMillis | Yes | Milliseconds since unix time zero | -**step** | Long | 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/Models/models/EpochMillis.md b/docs/v2/Models/models/EpochMillis.md deleted file mode 100644 index 42abb1987..000000000 --- a/docs/v2/Models/models/EpochMillis.md +++ /dev/null @@ -1,13 +0,0 @@ -# EpochMillis - -Milliseconds since unix time zero. This representation is used to maintain consistency with the Parquet -format. - - -## Type -```python -Long -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/Experiment.md b/docs/v2/Models/models/Experiment.md deleted file mode 100644 index c8bfd829e..000000000 --- a/docs/v2/Models/models/Experiment.md +++ /dev/null @@ -1,25 +0,0 @@ -# Experiment - -Experiment - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ExperimentRid | Yes | | -**model_rid** | ModelRid | Yes | | -**created_time** | CreatedTime | Yes | | -**created_by** | CreatedBy | Yes | | -**source** | ExperimentSource | Yes | | -**status** | ExperimentStatus | Yes | | -**status_message** | Optional[str] | No | | -**branch** | ExperimentBranch | Yes | | -**parameters** | List[Parameter] | Yes | | -**series** | List[SeriesAggregations] | Yes | | -**summary_metrics** | List[SummaryMetric] | Yes | | -**artifacts** | Dict[ExperimentArtifactName, ExperimentArtifactMetadata] | Yes | | -**tags** | List[ExperimentTagText] | Yes | | -**linked_model_version** | Optional[ModelVersionRid] | No | | -**job_rid** | Optional[JobRid] | 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/Models/models/ExperimentArtifactDetails.md b/docs/v2/Models/models/ExperimentArtifactDetails.md deleted file mode 100644 index cedbdf83f..000000000 --- a/docs/v2/Models/models/ExperimentArtifactDetails.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExperimentArtifactDetails - -Details about an experiment artifact. - -## Type -```python -TableArtifactDetails -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ExperimentArtifactMetadata.md b/docs/v2/Models/models/ExperimentArtifactMetadata.md deleted file mode 100644 index 9ffc9927e..000000000 --- a/docs/v2/Models/models/ExperimentArtifactMetadata.md +++ /dev/null @@ -1,14 +0,0 @@ -# ExperimentArtifactMetadata - -Metadata about an experiment artifact. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | ExperimentArtifactName | Yes | | -**description** | Optional[str] | No | | -**size_bytes** | SizeBytes | Yes | | -**details** | ExperimentArtifactDetails | 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/Models/models/ExperimentArtifactName.md b/docs/v2/Models/models/ExperimentArtifactName.md deleted file mode 100644 index 2389fd0a7..000000000 --- a/docs/v2/Models/models/ExperimentArtifactName.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExperimentArtifactName - -The name of an experiment artifact. - -## 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/Models/models/ExperimentAuthoringSource.md b/docs/v2/Models/models/ExperimentAuthoringSource.md deleted file mode 100644 index 7bfc2dc7d..000000000 --- a/docs/v2/Models/models/ExperimentAuthoringSource.md +++ /dev/null @@ -1,12 +0,0 @@ -# ExperimentAuthoringSource - -Experiment created from an authoring repository. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**stemma_rid** | RID | Yes | | -**type** | Literal["authoring"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ExperimentBranch.md b/docs/v2/Models/models/ExperimentBranch.md deleted file mode 100644 index 606f44d84..000000000 --- a/docs/v2/Models/models/ExperimentBranch.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExperimentBranch - -ExperimentBranch - -## 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/Models/models/ExperimentCodeWorkspaceSource.md b/docs/v2/Models/models/ExperimentCodeWorkspaceSource.md deleted file mode 100644 index 462b06444..000000000 --- a/docs/v2/Models/models/ExperimentCodeWorkspaceSource.md +++ /dev/null @@ -1,13 +0,0 @@ -# ExperimentCodeWorkspaceSource - -Experiment created from a code workspace. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**container_rid** | RID | Yes | | -**deployment_rid** | Optional[RID] | No | | -**type** | Literal["codeWorkspace"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ExperimentRid.md b/docs/v2/Models/models/ExperimentRid.md deleted file mode 100644 index d945297ee..000000000 --- a/docs/v2/Models/models/ExperimentRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExperimentRid - -The Resource Identifier (RID) of an Experiment. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ExperimentSdkSource.md b/docs/v2/Models/models/ExperimentSdkSource.md deleted file mode 100644 index d4f5908a4..000000000 --- a/docs/v2/Models/models/ExperimentSdkSource.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExperimentSdkSource - -Experiment created from the SDK. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["sdk"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ExperimentSource.md b/docs/v2/Models/models/ExperimentSource.md deleted file mode 100644 index 5fa72bfea..000000000 --- a/docs/v2/Models/models/ExperimentSource.md +++ /dev/null @@ -1,17 +0,0 @@ -# ExperimentSource - -The source from which the experiment was created. - -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 -| ------------ | ------------- -ExperimentCodeWorkspaceSource | codeWorkspace -ExperimentAuthoringSource | authoring -ExperimentSdkSource | sdk - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ExperimentStatus.md b/docs/v2/Models/models/ExperimentStatus.md deleted file mode 100644 index 73bd331f3..000000000 --- a/docs/v2/Models/models/ExperimentStatus.md +++ /dev/null @@ -1,12 +0,0 @@ -# ExperimentStatus - -The current status of an experiment. - -| **Value** | -| --------- | -| `"RUNNING"` | -| `"SUCCEEDED"` | -| `"FAILED"` | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ExperimentTagText.md b/docs/v2/Models/models/ExperimentTagText.md deleted file mode 100644 index bbae37fb6..000000000 --- a/docs/v2/Models/models/ExperimentTagText.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExperimentTagText - -A tag associated with an experiment. - -## 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/Models/models/FieldValidationError.md b/docs/v2/Models/models/FieldValidationError.md deleted file mode 100644 index e4e8599fe..000000000 --- a/docs/v2/Models/models/FieldValidationError.md +++ /dev/null @@ -1,14 +0,0 @@ -# FieldValidationError - -A dataset column type is not compatible with the trainer's supported column types. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**dataset_rid** | RID | Yes | The RID of the dataset containing the invalid field. | -**field_name** | Optional[str] | No | The name of the dataset column or field that failed validation. | -**field_type** | str | Yes | The type of the dataset field. | -**type** | Literal["fieldValidationFailure"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/GpuType.md b/docs/v2/Models/models/GpuType.md deleted file mode 100644 index ac7860e36..000000000 --- a/docs/v2/Models/models/GpuType.md +++ /dev/null @@ -1,18 +0,0 @@ -# GpuType - -The specific type of GPU hardware to use. - -| **Value** | -| --------- | -| `"A100"` | -| `"A10G"` | -| `"A16"` | -| `"H100"` | -| `"H200"` | -| `"L4"` | -| `"L40S"` | -| `"T4"` | -| `"V100"` | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/InconsistentArrayDimensionsError.md b/docs/v2/Models/models/InconsistentArrayDimensionsError.md deleted file mode 100644 index f45605314..000000000 --- a/docs/v2/Models/models/InconsistentArrayDimensionsError.md +++ /dev/null @@ -1,13 +0,0 @@ -# InconsistentArrayDimensionsError - -Array elements have inconsistent dimensions. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**first_element_shape** | List[int] | Yes | The shape of the first array element | -**conflicting_element_shape** | List[int] | Yes | The shape of the conflicting array element | -**type** | Literal["inconsistentArrayDimensions"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/InferenceInputErrorType.md b/docs/v2/Models/models/InferenceInputErrorType.md deleted file mode 100644 index a92a2eaa7..000000000 --- a/docs/v2/Models/models/InferenceInputErrorType.md +++ /dev/null @@ -1,24 +0,0 @@ -# InferenceInputErrorType - -The specific type and details of an input validation error for inference requests. -Each variant carries parameters relevant to that specific error category. - - -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 -| ------------ | ------------- -InvalidArrayShapeError | invalidArrayShape -TypeMismatchError | typeMismatch -UnsupportedTypeError | unsupportedType -UnknownInputNameError | unknownInputName -InvalidTabularFormatError | invalidTabularFormat -InconsistentArrayDimensionsError | inconsistentArrayDimensions -RequiredValueMissingError | requiredValueMissing -InvalidMapFormatError | invalidMapFormat - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/InputAlias.md b/docs/v2/Models/models/InputAlias.md deleted file mode 100644 index 9ef1776a4..000000000 --- a/docs/v2/Models/models/InputAlias.md +++ /dev/null @@ -1,11 +0,0 @@ -# InputAlias - -A string alias used to identify inputs in a Model Studio configuration. - -## 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/Models/models/IntegerParameter.md b/docs/v2/Models/models/IntegerParameter.md deleted file mode 100644 index b259fdb8f..000000000 --- a/docs/v2/Models/models/IntegerParameter.md +++ /dev/null @@ -1,12 +0,0 @@ -# IntegerParameter - -An integer parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | Long | Yes | | -**type** | Literal["integer"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/InvalidArrayShapeError.md b/docs/v2/Models/models/InvalidArrayShapeError.md deleted file mode 100644 index 0e4fa2a81..000000000 --- a/docs/v2/Models/models/InvalidArrayShapeError.md +++ /dev/null @@ -1,13 +0,0 @@ -# InvalidArrayShapeError - -Array dimensions do not match expected ndarray shape. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**expected_shape** | List[int] | Yes | The expected array shape from the model API specification | -**actual_shape** | Optional[List[int]] | No | The actual shape of the provided array | -**type** | Literal["invalidArrayShape"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/InvalidMapFormatError.md b/docs/v2/Models/models/InvalidMapFormatError.md deleted file mode 100644 index f80e7b2d6..000000000 --- a/docs/v2/Models/models/InvalidMapFormatError.md +++ /dev/null @@ -1,11 +0,0 @@ -# InvalidMapFormatError - -Map input has incorrect structure or null keys. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["invalidMapFormat"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/InvalidResourceConfigurationError.md b/docs/v2/Models/models/InvalidResourceConfigurationError.md deleted file mode 100644 index 348f3373f..000000000 --- a/docs/v2/Models/models/InvalidResourceConfigurationError.md +++ /dev/null @@ -1,13 +0,0 @@ -# InvalidResourceConfigurationError - -A resource configuration field has an invalid format. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | str | Yes | The name of the invalid field (e.g. "cpu", "memory"). | -**message** | str | Yes | A description of why the value is invalid. | -**type** | Literal["invalidResourceConfiguration"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/InvalidTabularFormatError.md b/docs/v2/Models/models/InvalidTabularFormatError.md deleted file mode 100644 index 9ada3e31b..000000000 --- a/docs/v2/Models/models/InvalidTabularFormatError.md +++ /dev/null @@ -1,12 +0,0 @@ -# InvalidTabularFormatError - -Tabular input has incorrect JSON structure. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**input_field_name** | str | Yes | The name of the tabular input field with incorrect format | -**type** | Literal["invalidTabularFormat"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/JsonSchemaValidationError.md b/docs/v2/Models/models/JsonSchemaValidationError.md deleted file mode 100644 index 04cb1ada5..000000000 --- a/docs/v2/Models/models/JsonSchemaValidationError.md +++ /dev/null @@ -1,13 +0,0 @@ -# JsonSchemaValidationError - -The custom configuration failed JSON schema validation. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | str | Yes | The field in the provided JSON that is invalid. | -**message** | str | Yes | A description of the validation failure. | -**type** | Literal["jsonSchemaValidationFailure"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ListModelStudioConfigVersionsResponse.md b/docs/v2/Models/models/ListModelStudioConfigVersionsResponse.md deleted file mode 100644 index 2479481f4..000000000 --- a/docs/v2/Models/models/ListModelStudioConfigVersionsResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListModelStudioConfigVersionsResponse - -ListModelStudioConfigVersionsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[ModelStudioConfigVersion] | Yes | | -**next_page_token** | Optional[PageToken] | 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/Models/models/ListModelStudioRunsResponse.md b/docs/v2/Models/models/ListModelStudioRunsResponse.md deleted file mode 100644 index 4873d488a..000000000 --- a/docs/v2/Models/models/ListModelStudioRunsResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListModelStudioRunsResponse - -ListModelStudioRunsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[ModelStudioRun] | Yes | | -**next_page_token** | Optional[PageToken] | 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/Models/models/ListModelStudioTrainersResponse.md b/docs/v2/Models/models/ListModelStudioTrainersResponse.md deleted file mode 100644 index 8ccdd707a..000000000 --- a/docs/v2/Models/models/ListModelStudioTrainersResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListModelStudioTrainersResponse - -ListModelStudioTrainersResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[ModelStudioTrainer] | Yes | | -**next_page_token** | Optional[PageToken] | 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/Models/models/LiveDeployment.md b/docs/v2/Models/models/LiveDeployment.md deleted file mode 100644 index 7e31bc4fd..000000000 --- a/docs/v2/Models/models/LiveDeployment.md +++ /dev/null @@ -1,14 +0,0 @@ -# LiveDeployment - -LiveDeployment - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | LiveDeploymentRid | Yes | | -**model_version** | LiveDeploymentModelVersion | Yes | The currently deployed model version. | -**runtime_configuration** | LiveDeploymentRuntimeConfiguration | Yes | The compute resource configuration for the deployment. | -**status** | LiveDeploymentStatus | Yes | The current operational status of the deployment. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/LiveDeploymentGpu.md b/docs/v2/Models/models/LiveDeploymentGpu.md deleted file mode 100644 index 1d50578b4..000000000 --- a/docs/v2/Models/models/LiveDeploymentGpu.md +++ /dev/null @@ -1,12 +0,0 @@ -# LiveDeploymentGpu - -GPU resource configuration for a live deployment. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**count** | int | Yes | The number of GPU units requested (e.g. 1). | -**type** | Optional[GpuType] | No | The specific type of GPU to use. Not setting a type means any type is acceptable. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/LiveDeploymentModelVersion.md b/docs/v2/Models/models/LiveDeploymentModelVersion.md deleted file mode 100644 index bbfefdde9..000000000 --- a/docs/v2/Models/models/LiveDeploymentModelVersion.md +++ /dev/null @@ -1,12 +0,0 @@ -# LiveDeploymentModelVersion - -Identifies the model and model version associated with a live deployment. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**model_rid** | ModelRid | Yes | | -**model_version_rid** | ModelVersionRid | 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/Models/models/LiveDeploymentRid.md b/docs/v2/Models/models/LiveDeploymentRid.md deleted file mode 100644 index 50a69a364..000000000 --- a/docs/v2/Models/models/LiveDeploymentRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# LiveDeploymentRid - -The Resource Identifier (RID) of a Live Deployment. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/LiveDeploymentRuntimeConfiguration.md b/docs/v2/Models/models/LiveDeploymentRuntimeConfiguration.md deleted file mode 100644 index 72ee421e7..000000000 --- a/docs/v2/Models/models/LiveDeploymentRuntimeConfiguration.md +++ /dev/null @@ -1,18 +0,0 @@ -# LiveDeploymentRuntimeConfiguration - -The compute resource configuration for a live deployment, controlling replica scaling, CPU, memory, and GPU resources. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**min_replicas** | int | Yes | The minimum number of replicas to keep running. | -**max_replicas** | int | Yes | The maximum number of replicas to scale to under load. | -**cpu** | Optional[float] | No | The number of CPU units requested. This is also set as the limit. | -**memory** | Optional[str] | No | The amount of memory requested in human-readable format (e.g. "256MiB", "1GiB"). This is also set as the limit. | -**gpu** | Optional[LiveDeploymentGpu] | No | Optional GPU resources for the deployment. | -**thread_count** | Optional[int] | No | The number of threads used for query handling. Defaults to 32 if not specified. Also affects how many concurrent requests will be sent to a single replica. | -**scaling_configuration** | Optional[LiveDeploymentScalingConfiguration] | No | Autoscaling configuration for the deployment. Controls how the deployment scales replicas up and down based on load. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/LiveDeploymentScalingConfiguration.md b/docs/v2/Models/models/LiveDeploymentScalingConfiguration.md deleted file mode 100644 index 633cd0de3..000000000 --- a/docs/v2/Models/models/LiveDeploymentScalingConfiguration.md +++ /dev/null @@ -1,14 +0,0 @@ -# LiveDeploymentScalingConfiguration - -Autoscaling configuration that controls how the deployment scales replicas based on load thresholds and cooldown delays. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**scale_up_load_threshold** | float | Yes | A threshold between 0.0 and 1.0. If the ratio of running jobs to job capacity exceeds this threshold for the duration of the scale-up delay, the deployment will scale up. Job capacity is the number of running replicas multiplied by the thread count (concurrency limit). | -**scale_up_delay** | Duration | Yes | The duration that load must exceed the scale-up threshold before scaling up. | -**scale_down_delay** | Duration | Yes | The duration that load must be below the scale-down threshold before scaling down. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/LiveDeploymentState.md b/docs/v2/Models/models/LiveDeploymentState.md deleted file mode 100644 index 3cb69e0d5..000000000 --- a/docs/v2/Models/models/LiveDeploymentState.md +++ /dev/null @@ -1,23 +0,0 @@ -# LiveDeploymentState - -The operational state of a live deployment. - -| Value | Description | -| --- | --- | -| ACTIVE | The deployment is active. It may have zero replicas due to autoscaling and still not be ready. | -| STARTING | The deployment is starting up. | -| DEGRADED | At least one replica is ready, but not all replicas are healthy. | -| DISABLED | The deployment is disabled. | -| FAILED | The deployment has failed. No healthy replicas are available. | - - -| **Value** | -| --------- | -| `"ACTIVE"` | -| `"STARTING"` | -| `"DEGRADED"` | -| `"DISABLED"` | -| `"FAILED"` | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/LiveDeploymentStatus.md b/docs/v2/Models/models/LiveDeploymentStatus.md deleted file mode 100644 index 273f45537..000000000 --- a/docs/v2/Models/models/LiveDeploymentStatus.md +++ /dev/null @@ -1,12 +0,0 @@ -# LiveDeploymentStatus - -The current operational status of a live deployment. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**state** | LiveDeploymentState | Yes | The current operational state of the deployment. | -**is_ready** | bool | Yes | Whether the deployment is ready to serve inference requests. A deployment may be active but not ready if it has been autoscaled to zero replicas. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/MissingRequiredDatasetColumnError.md b/docs/v2/Models/models/MissingRequiredDatasetColumnError.md deleted file mode 100644 index f37b9463f..000000000 --- a/docs/v2/Models/models/MissingRequiredDatasetColumnError.md +++ /dev/null @@ -1,14 +0,0 @@ -# MissingRequiredDatasetColumnError - -The user-provided dataset is missing a column required by the trainer. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**dataset_rid** | RID | Yes | The RID of the dataset missing the required column. | -**column_type_spec_id** | ColumnTypeSpecId | Yes | The trainer column type spec ID for the required column. | -**column_names** | List[ColumnName] | Yes | The valid dataset column names that could map to this trainer column. | -**type** | Literal["missingRequiredDatasetColumn"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/MissingWorkerConfigInputDatasetColumnMappingError.md b/docs/v2/Models/models/MissingWorkerConfigInputDatasetColumnMappingError.md deleted file mode 100644 index efd93dc81..000000000 --- a/docs/v2/Models/models/MissingWorkerConfigInputDatasetColumnMappingError.md +++ /dev/null @@ -1,13 +0,0 @@ -# MissingWorkerConfigInputDatasetColumnMappingError - -The provided worker config input dataset is missing a column mapping required by the trainer. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**dataset_rid** | RID | Yes | The RID of the dataset with the missing column mapping. | -**column_type_spec_id** | ColumnTypeSpecId | Yes | The column type spec ID for the missing column. | -**type** | Literal["missingWorkerConfigInputDatasetColumnMapping"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/MissingWorkerConfigInputError.md b/docs/v2/Models/models/MissingWorkerConfigInputError.md deleted file mode 100644 index fb3b1e89c..000000000 --- a/docs/v2/Models/models/MissingWorkerConfigInputError.md +++ /dev/null @@ -1,12 +0,0 @@ -# MissingWorkerConfigInputError - -The worker configuration is missing an input required by the trainer. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**input_alias** | InputAlias | Yes | The alias of the missing input. | -**type** | Literal["missingWorkerConfigInput"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/MissingWorkerConfigInputObjectSetPropertyMappingError.md b/docs/v2/Models/models/MissingWorkerConfigInputObjectSetPropertyMappingError.md deleted file mode 100644 index 9acd9f07d..000000000 --- a/docs/v2/Models/models/MissingWorkerConfigInputObjectSetPropertyMappingError.md +++ /dev/null @@ -1,13 +0,0 @@ -# MissingWorkerConfigInputObjectSetPropertyMappingError - -The provided worker config input object set is missing a property mapping required by the trainer. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_set_rid** | RID | Yes | The RID of the object set with the missing property mapping. | -**property_type_spec_id** | str | Yes | The property type spec ID for the missing property. | -**type** | Literal["missingWorkerConfigInputObjectSetPropertyMapping"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/MissingWorkerConfigOutputError.md b/docs/v2/Models/models/MissingWorkerConfigOutputError.md deleted file mode 100644 index f64bf3362..000000000 --- a/docs/v2/Models/models/MissingWorkerConfigOutputError.md +++ /dev/null @@ -1,12 +0,0 @@ -# MissingWorkerConfigOutputError - -The worker configuration is missing an output required by the trainer. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**output_alias** | OutputAlias | Yes | The alias of the missing output. | -**type** | Literal["missingWorkerConfigOutput"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelFunction.md b/docs/v2/Models/models/ModelFunction.md deleted file mode 100644 index 3d56ebf29..000000000 --- a/docs/v2/Models/models/ModelFunction.md +++ /dev/null @@ -1,16 +0,0 @@ -# ModelFunction - -ModelFunction - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**function_rid** | ModelFunctionFunctionRid | Yes | | -**function_version** | ModelFunctionFunctionVersion | Yes | | -**display_name** | ModelFunctionDisplayName | Yes | | -**api_name** | ModelFunctionApiName | Yes | | -**is_row_wise** | ModelFunctionIsRowWise | Yes | | -**ontology_binding** | Optional[OntologyRid] | 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/Models/models/ModelFunctionApiName.md b/docs/v2/Models/models/ModelFunctionApiName.md deleted file mode 100644 index 9a4c1a1d5..000000000 --- a/docs/v2/Models/models/ModelFunctionApiName.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelFunctionApiName - -ModelFunctionApiName - -## 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/Models/models/ModelFunctionDisplayName.md b/docs/v2/Models/models/ModelFunctionDisplayName.md deleted file mode 100644 index 2ad0fd34a..000000000 --- a/docs/v2/Models/models/ModelFunctionDisplayName.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelFunctionDisplayName - -ModelFunctionDisplayName - -## 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/Models/models/ModelFunctionFunctionRid.md b/docs/v2/Models/models/ModelFunctionFunctionRid.md deleted file mode 100644 index ca31d05d4..000000000 --- a/docs/v2/Models/models/ModelFunctionFunctionRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelFunctionFunctionRid - -ModelFunctionFunctionRid - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelFunctionFunctionVersion.md b/docs/v2/Models/models/ModelFunctionFunctionVersion.md deleted file mode 100644 index 21e2f792d..000000000 --- a/docs/v2/Models/models/ModelFunctionFunctionVersion.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelFunctionFunctionVersion - -ModelFunctionFunctionVersion - -## 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/Models/models/ModelFunctionIsRowWise.md b/docs/v2/Models/models/ModelFunctionIsRowWise.md deleted file mode 100644 index aea8c0beb..000000000 --- a/docs/v2/Models/models/ModelFunctionIsRowWise.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelFunctionIsRowWise - -ModelFunctionIsRowWise - -## Type -```python -bool -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelOutput.md b/docs/v2/Models/models/ModelOutput.md deleted file mode 100644 index bededd72b..000000000 --- a/docs/v2/Models/models/ModelOutput.md +++ /dev/null @@ -1,12 +0,0 @@ -# ModelOutput - -Model output configuration. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**model_rid** | RID | Yes | The RID of the output model. | -**type** | Literal["model"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelStudio.md b/docs/v2/Models/models/ModelStudio.md deleted file mode 100644 index a591c8516..000000000 --- a/docs/v2/Models/models/ModelStudio.md +++ /dev/null @@ -1,13 +0,0 @@ -# ModelStudio - -ModelStudio - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ModelStudioRid | Yes | | -**folder_rid** | FolderRid | Yes | The parent folder containing this Model Studio. | -**created_time** | CreatedTime | 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/Models/models/ModelStudioConfigVersion.md b/docs/v2/Models/models/ModelStudioConfigVersion.md deleted file mode 100644 index ee6c96631..000000000 --- a/docs/v2/Models/models/ModelStudioConfigVersion.md +++ /dev/null @@ -1,19 +0,0 @@ -# ModelStudioConfigVersion - -ModelStudioConfigVersion - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | ModelStudioConfigVersionName | Yes | Human readable name of the configuration version and experiment. | -**version** | ModelStudioConfigVersionNumber | Yes | The version number of this configuration. | -**trainer_id** | TrainerId | Yes | The identifier of the trainer to use for this configuration. | -**trainer** | TrainerVersionLocator | Yes | The trainer and version used for this configuration. | -**worker_config** | ModelStudioWorkerConfig | Yes | The worker configuration including inputs, outputs, and custom settings. | -**resources** | ResourceConfiguration | Yes | The compute resources allocated for training runs. | -**changelog** | Optional[str] | No | Changelog describing changes in this version. | -**created_by** | CreatedBy | Yes | | -**created_time** | CreatedTime | 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/Models/models/ModelStudioConfigVersionName.md b/docs/v2/Models/models/ModelStudioConfigVersionName.md deleted file mode 100644 index 1c532d49b..000000000 --- a/docs/v2/Models/models/ModelStudioConfigVersionName.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelStudioConfigVersionName - -Human readable name of the configuration version and experiment. - -## 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/Models/models/ModelStudioConfigVersionNumber.md b/docs/v2/Models/models/ModelStudioConfigVersionNumber.md deleted file mode 100644 index 0254dda2d..000000000 --- a/docs/v2/Models/models/ModelStudioConfigVersionNumber.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelStudioConfigVersionNumber - -The version number of a Model Studio Configuration. - -## Type -```python -int -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelStudioInput.md b/docs/v2/Models/models/ModelStudioInput.md deleted file mode 100644 index e11aa4512..000000000 --- a/docs/v2/Models/models/ModelStudioInput.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelStudioInput - -Input specification for a Model Studio configuration. - -## Type -```python -DatasetInput -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelStudioOutput.md b/docs/v2/Models/models/ModelStudioOutput.md deleted file mode 100644 index c8c9257ae..000000000 --- a/docs/v2/Models/models/ModelStudioOutput.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelStudioOutput - -Output specification for a Model Studio configuration. - -## Type -```python -ModelOutput -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelStudioRid.md b/docs/v2/Models/models/ModelStudioRid.md deleted file mode 100644 index 6cc416fd7..000000000 --- a/docs/v2/Models/models/ModelStudioRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelStudioRid - -The Resource Identifier (RID) of a Model Studio. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelStudioRun.md b/docs/v2/Models/models/ModelStudioRun.md deleted file mode 100644 index 4ec0ad0d7..000000000 --- a/docs/v2/Models/models/ModelStudioRun.md +++ /dev/null @@ -1,18 +0,0 @@ -# ModelStudioRun - -ModelStudioRun - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**run_id** | RunId | Yes | A unique identifier for this run, derived from the studio, config, and build. | -**build_rid** | ModelStudioRunBuildRid | Yes | The RID of the build associated with this run. | -**job_rid** | ModelStudioRunJobRid | Yes | The RID of the job associated with this run. | -**config_version** | ModelStudioConfigVersionNumber | Yes | The configuration version used for this run. | -**started_by** | CreatedBy | Yes | The user who started this run. | -**started_time** | CreatedTime | Yes | When this run was started. | -**build_status** | Optional[BuildStatus] | No | Status of the build. | -**resolved_outputs** | Dict[OutputAlias, ModelStudioRunOutput] | Yes | Map of alias to resolved output details (e.g., for models, contains the version RID and experiment). | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelStudioRunBuildRid.md b/docs/v2/Models/models/ModelStudioRunBuildRid.md deleted file mode 100644 index 26011a007..000000000 --- a/docs/v2/Models/models/ModelStudioRunBuildRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelStudioRunBuildRid - -The RID of the build associated with this run. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelStudioRunJobRid.md b/docs/v2/Models/models/ModelStudioRunJobRid.md deleted file mode 100644 index 6104a7107..000000000 --- a/docs/v2/Models/models/ModelStudioRunJobRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelStudioRunJobRid - -The RID of the job associated with this run. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelStudioRunModelOutput.md b/docs/v2/Models/models/ModelStudioRunModelOutput.md deleted file mode 100644 index 6b6bcc54f..000000000 --- a/docs/v2/Models/models/ModelStudioRunModelOutput.md +++ /dev/null @@ -1,14 +0,0 @@ -# ModelStudioRunModelOutput - -Resolved model output details for a Model Studio run. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**model_rid** | RID | Yes | The RID of the model. | -**model_version_rid** | RID | Yes | The RID of the model version created by this run. | -**experiment_rid** | Optional[RID] | No | The RID of the experiment associated with this run, if any. | -**type** | Literal["model"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelStudioRunOutput.md b/docs/v2/Models/models/ModelStudioRunOutput.md deleted file mode 100644 index bcd59eccb..000000000 --- a/docs/v2/Models/models/ModelStudioRunOutput.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelStudioRunOutput - -Resolved output details for a Model Studio run. - -## Type -```python -ModelStudioRunModelOutput -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelStudioTrainer.md b/docs/v2/Models/models/ModelStudioTrainer.md deleted file mode 100644 index e6dac591e..000000000 --- a/docs/v2/Models/models/ModelStudioTrainer.md +++ /dev/null @@ -1,19 +0,0 @@ -# ModelStudioTrainer - -ModelStudioTrainer - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**trainer_id** | TrainerId | Yes | | -**version** | TrainerVersion | Yes | The version of this trainer. | -**name** | TrainerName | Yes | Human-readable name of the trainer. | -**type** | TrainerType | Yes | The type/category of this trainer (e.g., TABULAR_CLASSIFICATION, TIME_SERIES). | -**description** | TrainerDescription | Yes | Description of what this trainer does and its capabilities. | -**custom_config_schema** | TrainerSchemaDefinition | Yes | JSON schema defining the custom configuration parameters for this trainer. | -**inputs** | TrainerInputsSpecification | Yes | Input specifications for this trainer. | -**outputs** | TrainerOutputsSpecification | Yes | Output specifications for this trainer. | -**experimental** | ModelStudioTrainerExperimental | Yes | Whether this trainer is experimental and may have breaking changes. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelStudioTrainerExperimental.md b/docs/v2/Models/models/ModelStudioTrainerExperimental.md deleted file mode 100644 index 12c34fd20..000000000 --- a/docs/v2/Models/models/ModelStudioTrainerExperimental.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelStudioTrainerExperimental - -Whether this trainer is experimental and may have breaking changes. - -## Type -```python -bool -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelStudioWorkerConfig.md b/docs/v2/Models/models/ModelStudioWorkerConfig.md deleted file mode 100644 index 1de6a9850..000000000 --- a/docs/v2/Models/models/ModelStudioWorkerConfig.md +++ /dev/null @@ -1,13 +0,0 @@ -# ModelStudioWorkerConfig - -Configuration for the Model Studio worker. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**custom_config** | Optional[Dict[str, Any]] | No | Custom configuration matching the trainer's JSON schema. | -**inputs** | Dict[InputAlias, ModelStudioInput] | Yes | Input configurations keyed by alias. | -**outputs** | Dict[OutputAlias, ModelStudioOutput] | Yes | Output configurations keyed by alias. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelVersion.md b/docs/v2/Models/models/ModelVersion.md index a3e93814d..098f3e447 100644 --- a/docs/v2/Models/models/ModelVersion.md +++ b/docs/v2/Models/models/ModelVersion.md @@ -9,9 +9,6 @@ ModelVersion **model_api** | ModelApi | Yes | | **conda_requirements** | List[str] | Yes | | **backing_repositories** | List[RID] | Yes | | -**created_time** | CreatedTime | Yes | | -**source** | Optional[ModelVersionSource] | No | | -**linked_experiment** | Optional[ExperimentRid] | No | The Experiment linked to this Model Version, if one exists. | [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelVersionCodeRepositorySource.md b/docs/v2/Models/models/ModelVersionCodeRepositorySource.md deleted file mode 100644 index b23366823..000000000 --- a/docs/v2/Models/models/ModelVersionCodeRepositorySource.md +++ /dev/null @@ -1,13 +0,0 @@ -# ModelVersionCodeRepositorySource - -Model version created from a code repository. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**repository_rid** | RID | Yes | | -**branch** | str | Yes | | -**type** | Literal["codeRepository"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelVersionCodeWorkspaceSource.md b/docs/v2/Models/models/ModelVersionCodeWorkspaceSource.md deleted file mode 100644 index 08b55c868..000000000 --- a/docs/v2/Models/models/ModelVersionCodeWorkspaceSource.md +++ /dev/null @@ -1,13 +0,0 @@ -# ModelVersionCodeWorkspaceSource - -Model version created from a code workspace. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**code_workspace_rid** | RID | Yes | | -**branch** | str | Yes | | -**type** | Literal["codeWorkspace"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelVersionContainerizedSource.md b/docs/v2/Models/models/ModelVersionContainerizedSource.md deleted file mode 100644 index cda520dac..000000000 --- a/docs/v2/Models/models/ModelVersionContainerizedSource.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelVersionContainerizedSource - -Model version imported from a containerized model. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["importedContainerizedModel"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelVersionExternalSource.md b/docs/v2/Models/models/ModelVersionExternalSource.md deleted file mode 100644 index e27da4b05..000000000 --- a/docs/v2/Models/models/ModelVersionExternalSource.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelVersionExternalSource - -Model version backed by an external model. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["external"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelVersionModelStudioSource.md b/docs/v2/Models/models/ModelVersionModelStudioSource.md deleted file mode 100644 index 95011544a..000000000 --- a/docs/v2/Models/models/ModelVersionModelStudioSource.md +++ /dev/null @@ -1,12 +0,0 @@ -# ModelVersionModelStudioSource - -Model version created from Model Studio. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**model_studio_rid** | RID | Yes | | -**type** | Literal["modelStudio"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelVersionPromotedSource.md b/docs/v2/Models/models/ModelVersionPromotedSource.md deleted file mode 100644 index b81004904..000000000 --- a/docs/v2/Models/models/ModelVersionPromotedSource.md +++ /dev/null @@ -1,13 +0,0 @@ -# ModelVersionPromotedSource - -Model version promoted from another model version. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**previous_model_rid** | ModelRid | Yes | | -**previous_model_version_rid** | ModelVersionRid | Yes | | -**type** | Literal["promoted"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelVersionSdkSource.md b/docs/v2/Models/models/ModelVersionSdkSource.md deleted file mode 100644 index 9d5cd3e16..000000000 --- a/docs/v2/Models/models/ModelVersionSdkSource.md +++ /dev/null @@ -1,11 +0,0 @@ -# ModelVersionSdkSource - -Model version created via the SDK. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["sdk"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ModelVersionSource.md b/docs/v2/Models/models/ModelVersionSource.md deleted file mode 100644 index 6ef4edaac..000000000 --- a/docs/v2/Models/models/ModelVersionSource.md +++ /dev/null @@ -1,21 +0,0 @@ -# ModelVersionSource - -The source from which this model version was created. - -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 -| ------------ | ------------- -ModelVersionContainerizedSource | importedContainerizedModel -ModelVersionExternalSource | external -ModelVersionCodeWorkspaceSource | codeWorkspace -ModelVersionModelStudioSource | modelStudio -ModelVersionCodeRepositorySource | codeRepository -ModelVersionSdkSource | sdk -ModelVersionPromotedSource | promoted - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/MultipleColumnsNotAllowedForTrainerError.md b/docs/v2/Models/models/MultipleColumnsNotAllowedForTrainerError.md deleted file mode 100644 index e64b3ee99..000000000 --- a/docs/v2/Models/models/MultipleColumnsNotAllowedForTrainerError.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultipleColumnsNotAllowedForTrainerError - -Multiple columns were mapped but the trainer only allows a single column for this spec. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**dataset_rid** | RID | Yes | The RID of the dataset with multiple columns mapped. | -**column_type_spec_id** | ColumnTypeSpecId | Yes | The column type spec ID that does not allow multiple columns. | -**type** | Literal["multipleColumnsNotAllowedForTrainer"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/MultiplePropertiesNotAllowedForTrainerError.md b/docs/v2/Models/models/MultiplePropertiesNotAllowedForTrainerError.md deleted file mode 100644 index 92d4b5106..000000000 --- a/docs/v2/Models/models/MultiplePropertiesNotAllowedForTrainerError.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiplePropertiesNotAllowedForTrainerError - -Multiple properties were mapped but the trainer only allows a single property for this spec. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_set_rid** | RID | Yes | The RID of the object set with multiple properties mapped. | -**property_type_spec_id** | str | Yes | The property type spec ID that does not allow multiple properties. | -**type** | Literal["multiplePropertiesNotAllowedForTrainer"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/OtherValidationError.md b/docs/v2/Models/models/OtherValidationError.md deleted file mode 100644 index a72a7cccf..000000000 --- a/docs/v2/Models/models/OtherValidationError.md +++ /dev/null @@ -1,12 +0,0 @@ -# OtherValidationError - -A validation error that does not match any specific known type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**message** | str | Yes | A description of the validation failure. | -**type** | Literal["other"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/OutputAlias.md b/docs/v2/Models/models/OutputAlias.md deleted file mode 100644 index 5aa1c8b72..000000000 --- a/docs/v2/Models/models/OutputAlias.md +++ /dev/null @@ -1,11 +0,0 @@ -# OutputAlias - -A string alias used to identify outputs in a Model Studio configuration. - -## 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/Models/models/OutputResourceInDifferentProjectError.md b/docs/v2/Models/models/OutputResourceInDifferentProjectError.md deleted file mode 100644 index 963c3d063..000000000 --- a/docs/v2/Models/models/OutputResourceInDifferentProjectError.md +++ /dev/null @@ -1,13 +0,0 @@ -# OutputResourceInDifferentProjectError - -The output resource is in a different project than the Model Studio. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**resource_rid** | RID | Yes | The RID of the resource in a different project. | -**output_alias** | OutputAlias | Yes | The alias of the output referencing the resource. | -**type** | Literal["outputResourceInDifferentProject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/OutputResourceNotFoundError.md b/docs/v2/Models/models/OutputResourceNotFoundError.md deleted file mode 100644 index 7595dcea1..000000000 --- a/docs/v2/Models/models/OutputResourceNotFoundError.md +++ /dev/null @@ -1,13 +0,0 @@ -# OutputResourceNotFoundError - -The output resource does not exist or is in the trash. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**resource_rid** | RID | Yes | The RID of the resource that was not found. | -**output_alias** | OutputAlias | Yes | The alias of the output referencing the missing resource. | -**type** | Literal["outputResourceNotFound"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/Parameter.md b/docs/v2/Models/models/Parameter.md deleted file mode 100644 index db831869c..000000000 --- a/docs/v2/Models/models/Parameter.md +++ /dev/null @@ -1,12 +0,0 @@ -# Parameter - -A parameter with its name and value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | ParameterName | Yes | The parameter name | -**value** | ParameterValue | Yes | The parameter value | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ParameterName.md b/docs/v2/Models/models/ParameterName.md deleted file mode 100644 index 2aabb12c5..000000000 --- a/docs/v2/Models/models/ParameterName.md +++ /dev/null @@ -1,11 +0,0 @@ -# ParameterName - -The name of an experiment parameter. - -## 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/Models/models/ParameterValue.md b/docs/v2/Models/models/ParameterValue.md deleted file mode 100644 index b26b286dc..000000000 --- a/docs/v2/Models/models/ParameterValue.md +++ /dev/null @@ -1,19 +0,0 @@ -# ParameterValue - -A parameter value logged for an experiment. - -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 -| ------------ | ------------- -DatetimeParameter | datetime -BooleanParameter | boolean -StringParameter | string -DoubleParameter | double -IntegerParameter | integer - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/PromoteVersionModelRequest.md b/docs/v2/Models/models/PromoteVersionModelRequest.md deleted file mode 100644 index d591bf9ae..000000000 --- a/docs/v2/Models/models/PromoteVersionModelRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# PromoteVersionModelRequest - -PromoteVersionModelRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**source_model_version_rid** | ModelVersionRid | Yes | | -**branch** | Optional[BranchName] | No | The branch to promote the version to. Defaults to master on most enrollments. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ReplaceLiveDeploymentRequest.md b/docs/v2/Models/models/ReplaceLiveDeploymentRequest.md deleted file mode 100644 index 3616fe24b..000000000 --- a/docs/v2/Models/models/ReplaceLiveDeploymentRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# ReplaceLiveDeploymentRequest - -ReplaceLiveDeploymentRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**runtime_configuration** | LiveDeploymentRuntimeConfiguration | Yes | The compute resource configuration for the deployment. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ReplaceModelFunctionRequest.md b/docs/v2/Models/models/ReplaceModelFunctionRequest.md deleted file mode 100644 index 245f13f68..000000000 --- a/docs/v2/Models/models/ReplaceModelFunctionRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# ReplaceModelFunctionRequest - -ReplaceModelFunctionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | ModelFunctionApiName | Yes | | -**ontology_binding** | Optional[OntologyRid] | No | | -**is_row_wise** | ModelFunctionIsRowWise | 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/Models/models/RequiredValueMissingError.md b/docs/v2/Models/models/RequiredValueMissingError.md deleted file mode 100644 index 0a89cf755..000000000 --- a/docs/v2/Models/models/RequiredValueMissingError.md +++ /dev/null @@ -1,12 +0,0 @@ -# RequiredValueMissingError - -Required input field is null or missing. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field_name** | str | Yes | The name of the required field that was null or missing | -**type** | Literal["requiredValueMissing"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/ResourceConfiguration.md b/docs/v2/Models/models/ResourceConfiguration.md deleted file mode 100644 index 437a015c6..000000000 --- a/docs/v2/Models/models/ResourceConfiguration.md +++ /dev/null @@ -1,13 +0,0 @@ -# ResourceConfiguration - -Compute resource configuration for training runs. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**memory** | str | Yes | Memory allocation (e.g., "4G"). | -**cpu** | str | Yes | CPU allocation (e.g., "2"). | -**gpu** | Optional[GpuType] | No | GPU allocation (must be available in the project's resource queue). | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/RunId.md b/docs/v2/Models/models/RunId.md deleted file mode 100644 index 123e3476d..000000000 --- a/docs/v2/Models/models/RunId.md +++ /dev/null @@ -1,11 +0,0 @@ -# RunId - -A unique identifier for a Model Studio run, derived from the studio, config, and build. - -## 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/Models/models/SearchExperimentsAndFilter.md b/docs/v2/Models/models/SearchExperimentsAndFilter.md deleted file mode 100644 index 6f897b3b0..000000000 --- a/docs/v2/Models/models/SearchExperimentsAndFilter.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchExperimentsAndFilter - -Returns experiments where every filter is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**filters** | List[SearchExperimentsFilter] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsContainsFilter.md b/docs/v2/Models/models/SearchExperimentsContainsFilter.md deleted file mode 100644 index a2efe5bab..000000000 --- a/docs/v2/Models/models/SearchExperimentsContainsFilter.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchExperimentsContainsFilter - -Filter for substring containment matches. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | SearchExperimentsContainsFilterField | Yes | | -**value** | Any | Yes | | -**type** | Literal["contains"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsContainsFilterField.md b/docs/v2/Models/models/SearchExperimentsContainsFilterField.md deleted file mode 100644 index 88ca1aeef..000000000 --- a/docs/v2/Models/models/SearchExperimentsContainsFilterField.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchExperimentsContainsFilterField - -Fields that support substring containment filtering. - -| **Value** | -| --------- | -| `"EXPERIMENT_NAME"` | -| `"PARAMETER_NAME"` | -| `"SERIES_NAME"` | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsEqualsFilter.md b/docs/v2/Models/models/SearchExperimentsEqualsFilter.md deleted file mode 100644 index 64d917e9e..000000000 --- a/docs/v2/Models/models/SearchExperimentsEqualsFilter.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchExperimentsEqualsFilter - -Filter for exact field value matches. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | SearchExperimentsEqualsFilterField | Yes | | -**value** | Any | Yes | | -**type** | Literal["eq"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsEqualsFilterField.md b/docs/v2/Models/models/SearchExperimentsEqualsFilterField.md deleted file mode 100644 index 223db777b..000000000 --- a/docs/v2/Models/models/SearchExperimentsEqualsFilterField.md +++ /dev/null @@ -1,17 +0,0 @@ -# SearchExperimentsEqualsFilterField - -Fields that support equality filtering. - -| **Value** | -| --------- | -| `"STATUS"` | -| `"BRANCH"` | -| `"EXPERIMENT_NAME"` | -| `"EXPERIMENT_RID"` | -| `"JOB_RID"` | -| `"TAG"` | -| `"PARAMETER_NAME"` | -| `"SERIES_NAME"` | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsFilter.md b/docs/v2/Models/models/SearchExperimentsFilter.md deleted file mode 100644 index 8410efefe..000000000 --- a/docs/v2/Models/models/SearchExperimentsFilter.md +++ /dev/null @@ -1,35 +0,0 @@ -# SearchExperimentsFilter - -Filter for searching experiments using operator-based composition. -Supports equality, text matching, boolean combination operators, and compound filters -that atomically bind a name to a value comparison. - -Example filters: -- Simple status: {"eq": {"field": "STATUS", "value": "RUNNING"}} -- Branch match: {"eq": {"field": "BRANCH", "value": "master"}} -- Parameter filter: {"parameterFilter": {"parameterName": "learning_rate", "operator": "GT", "value": 0.01}} -- Combined: {"and": {"filters": [ - {"eq": {"field": "STATUS", "value": "SUCCEEDED"}}, - {"parameterFilter": {"parameterName": "learning_rate", "operator": "GT", "value": 0.5}} - ]}} - - -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 -| ------------ | ------------- -SearchExperimentsSeriesFilter | seriesFilter -SearchExperimentsContainsFilter | contains -SearchExperimentsNotFilter | not -SearchExperimentsOrFilter | or -SearchExperimentsAndFilter | and -SearchExperimentsParameterFilter | parameterFilter -SearchExperimentsSummaryMetricFilter | summaryMetricFilter -SearchExperimentsEqualsFilter | eq -SearchExperimentsStartsWithFilter | startsWith - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsNotFilter.md b/docs/v2/Models/models/SearchExperimentsNotFilter.md deleted file mode 100644 index cf9a26b90..000000000 --- a/docs/v2/Models/models/SearchExperimentsNotFilter.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchExperimentsNotFilter - -Returns experiments where the filter is not satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | SearchExperimentsFilter | Yes | | -**type** | Literal["not"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsNumericFilterOperator.md b/docs/v2/Models/models/SearchExperimentsNumericFilterOperator.md deleted file mode 100644 index 6b92427f9..000000000 --- a/docs/v2/Models/models/SearchExperimentsNumericFilterOperator.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchExperimentsNumericFilterOperator - -Comparison operator for numeric filter predicates (series and summary metrics). - -| **Value** | -| --------- | -| `"EQ"` | -| `"GT"` | -| `"LT"` | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsOrFilter.md b/docs/v2/Models/models/SearchExperimentsOrFilter.md deleted file mode 100644 index d609a8ef3..000000000 --- a/docs/v2/Models/models/SearchExperimentsOrFilter.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchExperimentsOrFilter - -Returns experiments where at least one filter is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**filters** | List[SearchExperimentsFilter] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsOrderBy.md b/docs/v2/Models/models/SearchExperimentsOrderBy.md deleted file mode 100644 index aa02f1e71..000000000 --- a/docs/v2/Models/models/SearchExperimentsOrderBy.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchExperimentsOrderBy - -Ordering configuration for experiment search results. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | SearchExperimentsOrderByField | Yes | | -**direction** | OrderByDirection | 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/Models/models/SearchExperimentsOrderByField.md b/docs/v2/Models/models/SearchExperimentsOrderByField.md deleted file mode 100644 index e8f4faff9..000000000 --- a/docs/v2/Models/models/SearchExperimentsOrderByField.md +++ /dev/null @@ -1,11 +0,0 @@ -# SearchExperimentsOrderByField - -Fields to order experiment search results by. - -| **Value** | -| --------- | -| `"EXPERIMENT_NAME"` | -| `"CREATED_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/Models/models/SearchExperimentsParameterFilter.md b/docs/v2/Models/models/SearchExperimentsParameterFilter.md deleted file mode 100644 index 5e3ec5268..000000000 --- a/docs/v2/Models/models/SearchExperimentsParameterFilter.md +++ /dev/null @@ -1,20 +0,0 @@ -# SearchExperimentsParameterFilter - -Filter that atomically binds a parameter name to a value comparison, -ensuring both conditions are evaluated on the same parameter. -Supported combinations: -- EQ: boolean, double, integer, or datetime value -- GT/LT: double, integer, or datetime value -- CONTAINS: string value (substring match on the parameter's string value) - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameter_name** | ParameterName | Yes | The exact name of the parameter to filter on. | -**operator** | SearchExperimentsParameterFilterOperator | Yes | The comparison operator to apply. | -**value** | Any | Yes | The value to compare against. | -**type** | Literal["parameterFilter"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsParameterFilterOperator.md b/docs/v2/Models/models/SearchExperimentsParameterFilterOperator.md deleted file mode 100644 index 80e0c76b9..000000000 --- a/docs/v2/Models/models/SearchExperimentsParameterFilterOperator.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchExperimentsParameterFilterOperator - -Comparison operator for parameter filter predicates. - -| **Value** | -| --------- | -| `"EQ"` | -| `"GT"` | -| `"LT"` | -| `"CONTAINS"` | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsRequest.md b/docs/v2/Models/models/SearchExperimentsRequest.md deleted file mode 100644 index 29572bfdd..000000000 --- a/docs/v2/Models/models/SearchExperimentsRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# SearchExperimentsRequest - -SearchExperimentsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**where** | Optional[SearchExperimentsFilter] | No | Optional search filter for filtering experiments. If not provided, all experiments for the model are returned. | -**order_by** | Optional[SearchExperimentsOrderBy] | No | The field to sort by. Default is to sort by relevance. | -**page_size** | Optional[PageSize] | No | The maximum number of results to return. Default 50, maximum of 100. | -**page_token** | Optional[PageToken] | No | PageToken to identify the next page to retrieve. Leave empty for the first request. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsResponse.md b/docs/v2/Models/models/SearchExperimentsResponse.md deleted file mode 100644 index a18a72971..000000000 --- a/docs/v2/Models/models/SearchExperimentsResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchExperimentsResponse - -Response from searching experiments. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[Experiment] | Yes | List of experiments matching the search criteria. | -**next_page_token** | Optional[PageToken] | No | Token for retrieving the next page of results, if more results are available. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsSeriesFilter.md b/docs/v2/Models/models/SearchExperimentsSeriesFilter.md deleted file mode 100644 index 8457da3a3..000000000 --- a/docs/v2/Models/models/SearchExperimentsSeriesFilter.md +++ /dev/null @@ -1,17 +0,0 @@ -# SearchExperimentsSeriesFilter - -Filter that atomically binds a series name to a metric comparison, -ensuring all conditions are evaluated on the same series. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**series_name** | SeriesName | Yes | The name of the series to filter on. | -**field** | SearchExperimentsSeriesFilterField | Yes | The series metric to compare. | -**operator** | SearchExperimentsNumericFilterOperator | Yes | The comparison operator (EQ, GT, or LT). | -**value** | Any | Yes | The value to compare against. | -**type** | Literal["seriesFilter"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsSeriesFilterField.md b/docs/v2/Models/models/SearchExperimentsSeriesFilterField.md deleted file mode 100644 index 267d7c9b2..000000000 --- a/docs/v2/Models/models/SearchExperimentsSeriesFilterField.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchExperimentsSeriesFilterField - -The series metric to filter on. - -| **Value** | -| --------- | -| `"LENGTH"` | -| `"AGGREGATION_MIN"` | -| `"AGGREGATION_MAX"` | -| `"AGGREGATION_LAST"` | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsStartsWithFilter.md b/docs/v2/Models/models/SearchExperimentsStartsWithFilter.md deleted file mode 100644 index ccdd9ae72..000000000 --- a/docs/v2/Models/models/SearchExperimentsStartsWithFilter.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchExperimentsStartsWithFilter - -Filter for prefix matches. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | SearchExperimentsStartsWithFilterField | Yes | | -**value** | Any | Yes | | -**type** | Literal["startsWith"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsStartsWithFilterField.md b/docs/v2/Models/models/SearchExperimentsStartsWithFilterField.md deleted file mode 100644 index fdca64233..000000000 --- a/docs/v2/Models/models/SearchExperimentsStartsWithFilterField.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchExperimentsStartsWithFilterField - -Fields that support prefix filtering. - -| **Value** | -| --------- | -| `"EXPERIMENT_NAME"` | -| `"PARAMETER_NAME"` | -| `"SERIES_NAME"` | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SearchExperimentsSummaryMetricFilter.md b/docs/v2/Models/models/SearchExperimentsSummaryMetricFilter.md deleted file mode 100644 index b15ad0068..000000000 --- a/docs/v2/Models/models/SearchExperimentsSummaryMetricFilter.md +++ /dev/null @@ -1,17 +0,0 @@ -# SearchExperimentsSummaryMetricFilter - -Filter that atomically binds a series name and aggregation type to a value comparison, -ensuring all conditions are evaluated on the same summary metric. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**series_name** | SeriesName | Yes | The name of the series this metric belongs to. | -**aggregation** | SummaryMetricAggregation | Yes | The aggregation type (MIN, MAX, LAST). | -**operator** | SearchExperimentsNumericFilterOperator | Yes | The comparison operator (EQ, GT, or LT). | -**value** | Any | Yes | The value to compare against. | -**type** | Literal["summaryMetricFilter"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/Series.md b/docs/v2/Models/models/Series.md deleted file mode 100644 index c8ca8c11c..000000000 --- a/docs/v2/Models/models/Series.md +++ /dev/null @@ -1,11 +0,0 @@ -# Series - -A series of values logged over time. - -## Type -```python -DoubleSeriesV1 -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SeriesAggregations.md b/docs/v2/Models/models/SeriesAggregations.md deleted file mode 100644 index 5884da311..000000000 --- a/docs/v2/Models/models/SeriesAggregations.md +++ /dev/null @@ -1,13 +0,0 @@ -# SeriesAggregations - -Series with precomputed aggregation values. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | SeriesName | Yes | The series name | -**length** | Optional[Long] | No | Number of values in the series. This field may be absent when series aggregations are derived from summary metrics rather than the full series data. | -**value** | SeriesAggregationsValue | Yes | Aggregated values for this series | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SeriesAggregationsValue.md b/docs/v2/Models/models/SeriesAggregationsValue.md deleted file mode 100644 index 0b9ebdccf..000000000 --- a/docs/v2/Models/models/SeriesAggregationsValue.md +++ /dev/null @@ -1,11 +0,0 @@ -# SeriesAggregationsValue - -Union of aggregation values by series type. - -## Type -```python -DoubleSeriesAggregations -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SeriesName.md b/docs/v2/Models/models/SeriesName.md deleted file mode 100644 index d6d21da1c..000000000 --- a/docs/v2/Models/models/SeriesName.md +++ /dev/null @@ -1,11 +0,0 @@ -# SeriesName - -The name of a series (metrics tracked over time). - -## 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/Models/models/StringParameter.md b/docs/v2/Models/models/StringParameter.md deleted file mode 100644 index 1ea3bb651..000000000 --- a/docs/v2/Models/models/StringParameter.md +++ /dev/null @@ -1,12 +0,0 @@ -# StringParameter - -A string parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | str | Yes | | -**type** | Literal["string"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SummaryMetric.md b/docs/v2/Models/models/SummaryMetric.md deleted file mode 100644 index 2f6093253..000000000 --- a/docs/v2/Models/models/SummaryMetric.md +++ /dev/null @@ -1,13 +0,0 @@ -# SummaryMetric - -A summary metric with series name, aggregation type, and computed value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**series_name** | SeriesName | Yes | Name of the series this metric belongs to | -**aggregation** | SummaryMetricAggregation | Yes | Type of aggregation (MIN, MAX, LAST) | -**value** | float | Yes | The computed value | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/SummaryMetricAggregation.md b/docs/v2/Models/models/SummaryMetricAggregation.md deleted file mode 100644 index 1324a78db..000000000 --- a/docs/v2/Models/models/SummaryMetricAggregation.md +++ /dev/null @@ -1,12 +0,0 @@ -# SummaryMetricAggregation - -The type of aggregation computed for a summary metric. - -| **Value** | -| --------- | -| `"MIN"` | -| `"MAX"` | -| `"LAST"` | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/TableArtifactDetails.md b/docs/v2/Models/models/TableArtifactDetails.md deleted file mode 100644 index 2c9f650ff..000000000 --- a/docs/v2/Models/models/TableArtifactDetails.md +++ /dev/null @@ -1,12 +0,0 @@ -# TableArtifactDetails - -Details about a table artifact. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**row_count** | Long | Yes | | -**type** | Literal["table"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/TrainerDescription.md b/docs/v2/Models/models/TrainerDescription.md deleted file mode 100644 index 7a67e9fdf..000000000 --- a/docs/v2/Models/models/TrainerDescription.md +++ /dev/null @@ -1,11 +0,0 @@ -# TrainerDescription - -Description of what a trainer does and its capabilities. - -## 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/Models/models/TrainerId.md b/docs/v2/Models/models/TrainerId.md deleted file mode 100644 index 89df81815..000000000 --- a/docs/v2/Models/models/TrainerId.md +++ /dev/null @@ -1,11 +0,0 @@ -# TrainerId - -The identifier for a trainer. - -## 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/Models/models/TrainerInputsSpecification.md b/docs/v2/Models/models/TrainerInputsSpecification.md deleted file mode 100644 index 189ae77e0..000000000 --- a/docs/v2/Models/models/TrainerInputsSpecification.md +++ /dev/null @@ -1,12 +0,0 @@ -# TrainerInputsSpecification - -Specification of the inputs required by a trainer. When creating a ModelStudioConfigVersion, the workerConfig.inputs must conform to this specification, providing entries for each required input defined here. - - -## Type -```python -Any -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/TrainerName.md b/docs/v2/Models/models/TrainerName.md deleted file mode 100644 index 794eed66a..000000000 --- a/docs/v2/Models/models/TrainerName.md +++ /dev/null @@ -1,11 +0,0 @@ -# TrainerName - -Human-readable name of a trainer. - -## 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/Models/models/TrainerOutputsSpecification.md b/docs/v2/Models/models/TrainerOutputsSpecification.md deleted file mode 100644 index c3f01edc2..000000000 --- a/docs/v2/Models/models/TrainerOutputsSpecification.md +++ /dev/null @@ -1,12 +0,0 @@ -# TrainerOutputsSpecification - -Specification of the outputs produced by a trainer. When creating a ModelStudioConfigVersion, the workerConfig.outputs must conform to this specification, providing entries for each required output defined here. - - -## Type -```python -Any -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/TrainerSchemaDefinition.md b/docs/v2/Models/models/TrainerSchemaDefinition.md deleted file mode 100644 index eb20e412a..000000000 --- a/docs/v2/Models/models/TrainerSchemaDefinition.md +++ /dev/null @@ -1,11 +0,0 @@ -# TrainerSchemaDefinition - -JSON schema defining the custom configuration parameters for a trainer. - -## Type -```python -Any -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/TrainerType.md b/docs/v2/Models/models/TrainerType.md deleted file mode 100644 index f8060c6ad..000000000 --- a/docs/v2/Models/models/TrainerType.md +++ /dev/null @@ -1,11 +0,0 @@ -# TrainerType - -The type/category of a trainer. - -## 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/Models/models/TrainerVersion.md b/docs/v2/Models/models/TrainerVersion.md deleted file mode 100644 index 968d7c788..000000000 --- a/docs/v2/Models/models/TrainerVersion.md +++ /dev/null @@ -1,11 +0,0 @@ -# TrainerVersion - -A specific version identifier for a trainer. - -## 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/Models/models/TrainerVersionLocator.md b/docs/v2/Models/models/TrainerVersionLocator.md deleted file mode 100644 index 67b389f88..000000000 --- a/docs/v2/Models/models/TrainerVersionLocator.md +++ /dev/null @@ -1,12 +0,0 @@ -# TrainerVersionLocator - -Identifies a specific version of a trainer. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**trainer_id** | TrainerId | Yes | | -**version** | str | 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/Models/models/TransformJsonLiveDeploymentRequest.md b/docs/v2/Models/models/TransformJsonLiveDeploymentRequest.md deleted file mode 100644 index 12405c350..000000000 --- a/docs/v2/Models/models/TransformJsonLiveDeploymentRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# TransformJsonLiveDeploymentRequest - -TransformJsonLiveDeploymentRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**input** | Dict[str, Any] | Yes | The input data for the model inference. The structure should match the model's transform API specification, where each key is an input name and the value is the corresponding input data. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/TransformLiveDeploymentResponse.md b/docs/v2/Models/models/TransformLiveDeploymentResponse.md deleted file mode 100644 index 1dec4129a..000000000 --- a/docs/v2/Models/models/TransformLiveDeploymentResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# TransformLiveDeploymentResponse - -The response from transforming input data using a live deployment. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**output** | Dict[str, Any] | Yes | The output data from the model inference. The structure depends on the model's defined API specification, where each key is an output name and the value is the corresponding output data. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/TypeMismatchError.md b/docs/v2/Models/models/TypeMismatchError.md deleted file mode 100644 index 05820a2ae..000000000 --- a/docs/v2/Models/models/TypeMismatchError.md +++ /dev/null @@ -1,13 +0,0 @@ -# TypeMismatchError - -Input type does not match expected type in model API. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**expected_type** | str | Yes | The expected type from the model API specification | -**actual_type** | str | Yes | The actual type provided in the input | -**type** | Literal["typeMismatch"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/UnknownColumnSpecIdInConfigColumnMappingError.md b/docs/v2/Models/models/UnknownColumnSpecIdInConfigColumnMappingError.md deleted file mode 100644 index dde4cda79..000000000 --- a/docs/v2/Models/models/UnknownColumnSpecIdInConfigColumnMappingError.md +++ /dev/null @@ -1,13 +0,0 @@ -# UnknownColumnSpecIdInConfigColumnMappingError - -The worker config column mapping contains an unknown column spec ID not found in the trainer's column specification. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**dataset_rid** | RID | Yes | The RID of the dataset containing the unknown column mapping. | -**column_type_spec_id** | ColumnTypeSpecId | Yes | The unknown column type spec ID. | -**type** | Literal["unknownColumnSpecIdInConfigColumnMapping"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/UnknownInputNameError.md b/docs/v2/Models/models/UnknownInputNameError.md deleted file mode 100644 index 2b248c0ac..000000000 --- a/docs/v2/Models/models/UnknownInputNameError.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnknownInputNameError - -Provided input name not found in model API specification. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**input_name** | str | Yes | The input name that was not found in the model API specification | -**type** | Literal["unknownInputName"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Models/models/UnsupportedTypeError.md b/docs/v2/Models/models/UnsupportedTypeError.md deleted file mode 100644 index f969db2a0..000000000 --- a/docs/v2/Models/models/UnsupportedTypeError.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnsupportedTypeError - -Input contains an unsupported data type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**unsupported_type** | str | Yes | The unsupported data type | -**type** | Literal["unsupportedType"] | 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/Action.md b/docs/v2/Ontologies/Action.md index 08032ebf4..5aafc0230 100644 --- a/docs/v2/Ontologies/Action.md +++ b/docs/v2/Ontologies/Action.md @@ -30,8 +30,6 @@ Name | Type | Description | Notes | **options** | Optional[ApplyActionRequestOptions] | | [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] | -**trace_parent** | Optional[TraceParent] | The W3C trace parent header included in the request. | [optional] | -**trace_state** | Optional[TraceState] | The W3C trace state header included in the request. | [optional] | **transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to apply the action against. Transactions are an experimental feature and all workflows may not be supported. | [optional] | ### Return type @@ -60,10 +58,6 @@ options = None sdk_package_rid = None # Optional[SdkVersion] | The version of the generated SDK. sdk_version = None -# Optional[TraceParent] | The W3C trace parent header included in the request. -trace_parent = None -# Optional[TraceState] | The W3C trace state header included in the request. -trace_state = None # Optional[OntologyTransactionId] | The ID of an Ontology transaction to apply the action against. Transactions are an experimental feature and all workflows may not be supported. transaction_id = None @@ -77,8 +71,6 @@ try: options=options, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version, - trace_parent=trace_parent, - trace_state=trace_state, transaction_id=transaction_id, ) print("The apply response:\n") diff --git a/docs/v2/Ontologies/ActionType.md b/docs/v2/Ontologies/ActionType.md index 1ea573ee5..630b1f48d 100644 --- a/docs/v2/Ontologies/ActionType.md +++ b/docs/v2/Ontologies/ActionType.md @@ -4,7 +4,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**get**](#get) | **GET** /v2/ontologies/{ontology}/actionTypes/{actionType} | Stable | [**get_by_rid**](#get_by_rid) | **GET** /v2/ontologies/{ontology}/actionTypes/byRid/{actionTypeRid} | Stable | -[**get_by_rid_batch**](#get_by_rid_batch) | **POST** /v2/ontologies/{ontology}/actionTypes/getByRidBatch | Public Beta | [**list**](#list) | **GET** /v2/ontologies/{ontology}/actionTypes | Stable | # **get** @@ -117,70 +116,6 @@ 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) -# **get_by_rid_batch** -Gets a list of action types by RID in bulk. - -Action types are filtered from the response if they don't exist or the requesting token lacks the required -permissions. - -The maximum batch size for this endpoint is 100. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | | | -**requests** | List[GetActionTypeByRidBatchRequestElement] | | | -**branch** | Optional[FoundryBranch] | The Foundry branch to load the action type definitions from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. | [optional] | -**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | - -### Return type -**GetActionTypeByRidBatchResponse** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyIdentifier -ontology = "palantir" -# List[GetActionTypeByRidBatchRequestElement] -requests = None -# Optional[FoundryBranch] | The Foundry branch to load the action type definitions from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. -branch = None -# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. -preview = None - - -try: - api_response = client.ontologies.Ontology.ActionType.get_by_rid_batch( - ontology, requests=requests, branch=branch, preview=preview - ) - print("The get_by_rid_batch response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling ActionType.get_by_rid_batch: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | GetActionTypeByRidBatchResponse | Success response. | 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) - # **list** Lists the action types for the given Ontology. diff --git a/docs/v2/Ontologies/CipherTextProperty.md b/docs/v2/Ontologies/CipherTextProperty.md index f9478955a..48f43bf9f 100644 --- a/docs/v2/Ontologies/CipherTextProperty.md +++ b/docs/v2/Ontologies/CipherTextProperty.md @@ -2,7 +2,7 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | -[**decrypt**](#decrypt) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/ciphertexts/{property}/decrypt | Stable | +[**decrypt**](#decrypt) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/ciphertexts/{property}/decrypt | Public Beta | # **decrypt** Decrypt the value of a ciphertext property. diff --git a/docs/v2/Ontologies/ObjectType.md b/docs/v2/Ontologies/ObjectType.md index 41d206cc1..f9089e022 100644 --- a/docs/v2/Ontologies/ObjectType.md +++ b/docs/v2/Ontologies/ObjectType.md @@ -3,11 +3,9 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**get**](#get) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType} | Stable | -[**get_by_rid_batch**](#get_by_rid_batch) | **POST** /v2/ontologies/{ontology}/objectTypes/getByRidBatch | Public Beta | -[**get_edits_history**](#get_edits_history) | **POST** /v2/ontologies/{ontology}/objectTypes/{objectType}/editsHistory | Public Beta | +[**get_edits_history**](#get_edits_history) | **POST** /v2/ontologies/{ontology}/objectTypes/{objectType}/editsHistory | Private Beta | [**get_full_metadata**](#get_full_metadata) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/fullMetadata | Public Beta | [**get_outgoing_link_type**](#get_outgoing_link_type) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} | Stable | -[**get_outgoing_link_types_by_object_type_rid_batch**](#get_outgoing_link_types_by_object_type_rid_batch) | **POST** /v2/ontologies/{ontology}/outgoingLinkTypes/getByRidBatch | Public Beta | [**list**](#list) | **GET** /v2/ontologies/{ontology}/objectTypes | Stable | [**list_outgoing_link_types**](#list_outgoing_link_types) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes | Stable | @@ -65,78 +63,15 @@ 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) -# **get_by_rid_batch** -Gets a list of object types by RID in bulk. - -Object types are filtered from the response if they don't exist or the requesting token lacks the required -permissions. - -The maximum batch size for this endpoint is 100. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | | | -**requests** | List[GetObjectTypeByRidBatchRequestElement] | | | -**branch** | Optional[FoundryBranch] | The Foundry branch to load the object type definitions from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. | [optional] | -**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | - -### Return type -**GetObjectTypeByRidBatchResponse** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyIdentifier -ontology = "palantir" -# List[GetObjectTypeByRidBatchRequestElement] -requests = None -# Optional[FoundryBranch] | The Foundry branch to load the object type definitions from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. -branch = None -# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. -preview = None - - -try: - api_response = client.ontologies.Ontology.ObjectType.get_by_rid_batch( - ontology, requests=requests, branch=branch, preview=preview - ) - print("The get_by_rid_batch response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling ObjectType.get_by_rid_batch: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | GetObjectTypeByRidBatchResponse | Success response. | 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) - # **get_edits_history** Returns the history of edits (additions, modifications, deletions) for objects of a specific object type. This endpoint provides visibility into all actions that have modified objects of this type. -The edits are returned in reverse chronological order (most recent first) by default. +The edits are returned in reverse chronological order (most recent first). -Note that filters are ignored for OSv1 object types. +WARNING: right now this endpoint works only if you pass in an object primary key, i.e. it does not function +as a global object type edits history. Global object type edits history is currently under development. ### Parameters @@ -146,7 +81,7 @@ Name | Type | Description | Notes | **ontology** | OntologyIdentifier | The ontology RID or API name | | **object_type** | ObjectTypeApiName | The API name of the object type | | **branch** | Optional[FoundryBranch] | The Foundry branch from which we will get edits history. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. | [optional] | -**filters** | Optional[EditsHistoryFilter] | | [optional] | +**filters** | Optional[EditsHistoryFilters] | | [optional] | **include_all_previous_properties** | Optional[bool] | | [optional] | **object_primary_key** | Optional[ObjectPrimaryKeyV2] | | [optional] | **page_size** | Optional[int] | The maximum number of edits to return per page. Defaults to 100. | [optional] | @@ -171,7 +106,7 @@ ontology = "palantir" object_type = "Employee" # Optional[FoundryBranch] | The Foundry branch from which we will get edits history. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. branch = None -# Optional[EditsHistoryFilter] +# Optional[EditsHistoryFilters] filters = None # Optional[bool] include_all_previous_properties = None @@ -346,85 +281,6 @@ 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) -# **get_outgoing_link_types_by_object_type_rid_batch** -Gets outgoing link types for a batch of object types, identified by their RIDs. - -For each requested object type, returns the list of outgoing link types visible to the -requesting token. Optionally, results can be filtered to only include specific link type RIDs. - -Object types that don't exist or that the requesting token lacks permissions for are -silently omitted from the response. - -The maximum batch size for this endpoint is 100. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | | | -**filter_link_type_rids** | List[LinkTypeRid] | If provided, only return outgoing link types with RIDs in this list. If omitted, all outgoing link types for each requested object type are returned. | | -**requests** | List[GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement] | | | -**branch** | Optional[FoundryBranch] | The Foundry branch to load the outgoing link type definitions from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. | [optional] | -**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | - -### Return type -**GetOutgoingLinkTypesByObjectTypeRidBatchResponse** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyIdentifier -ontology = "palantir" -# List[LinkTypeRid] | If provided, only return outgoing link types with RIDs in this list. If omitted, all outgoing link types for each requested object type are returned. -filter_link_type_rids = None -# List[GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement] -requests = None -# Optional[FoundryBranch] | The Foundry branch to load the outgoing link type definitions from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. -branch = None -# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. -preview = None - - -try: - api_response = ( - client.ontologies.Ontology.ObjectType.get_outgoing_link_types_by_object_type_rid_batch( - ontology, - filter_link_type_rids=filter_link_type_rids, - requests=requests, - branch=branch, - preview=preview, - ) - ) - print("The get_outgoing_link_types_by_object_type_rid_batch response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print( - "HTTP error when calling ObjectType.get_outgoing_link_types_by_object_type_rid_batch: %s\n" - % e - ) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | GetOutgoingLinkTypesByObjectTypeRidBatchResponse | Success response. | 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) - # **list** Lists the object types for the given Ontology. diff --git a/docs/v2/Ontologies/OntologyInterface.md b/docs/v2/Ontologies/OntologyInterface.md index c8cd10cf6..50d95a2b4 100644 --- a/docs/v2/Ontologies/OntologyInterface.md +++ b/docs/v2/Ontologies/OntologyInterface.md @@ -433,7 +433,6 @@ Name | Type | Description | Notes | **order_by** | Optional[OrderBy] | | [optional] | **page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [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] | **select** | Optional[List[SelectedPropertyApiName]] | The properties of the interface type that should be included in the response. Omit this parameter to get all the properties. | [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] | @@ -463,8 +462,6 @@ order_by = None page_size = None # Optional[PageToken] page_token = None -# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. -preview = None # Optional[List[SelectedPropertyApiName]] | The properties of the interface type that should be included in the response. Omit this parameter to get all the properties. select = None # 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. @@ -480,7 +477,6 @@ try: order_by=order_by, page_size=page_size, page_token=page_token, - preview=preview, select=select, snapshot=snapshot, ): diff --git a/docs/v2/Ontologies/OntologyObjectSet.md b/docs/v2/Ontologies/OntologyObjectSet.md index feb263775..168f2d8c7 100644 --- a/docs/v2/Ontologies/OntologyObjectSet.md +++ b/docs/v2/Ontologies/OntologyObjectSet.md @@ -27,8 +27,6 @@ Name | Type | Description | Notes | **include_compute_usage** | Optional[IncludeComputeUsage] | | [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] | -**trace_parent** | Optional[TraceParent] | The W3C trace parent header included in the request. | [optional] | -**trace_state** | Optional[TraceState] | The W3C trace state header included in the request. | [optional] | **transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. | [optional] | ### Return type @@ -71,10 +69,6 @@ include_compute_usage = None sdk_package_rid = None # Optional[SdkVersion] | The package version of the generated SDK. sdk_version = None -# Optional[TraceParent] | The W3C trace parent header included in the request. -trace_parent = None -# Optional[TraceState] | The W3C trace state header included in the request. -trace_state = None # Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. transaction_id = None @@ -90,8 +84,6 @@ try: include_compute_usage=include_compute_usage, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version, - trace_parent=trace_parent, - trace_state=trace_state, transaction_id=transaction_id, ) print("The aggregate response:\n") @@ -127,8 +119,6 @@ Name | Type | Description | Notes | **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] | -**trace_parent** | Optional[TraceParent] | The W3C trace parent header included in the request. | [optional] | -**trace_state** | Optional[TraceState] | The W3C trace state header included in the request. | [optional] | ### Return type **CreateTemporaryObjectSetResponseV2** @@ -152,10 +142,6 @@ branch = None sdk_package_rid = None # Optional[SdkVersion] | The package version of the generated SDK. sdk_version = None -# Optional[TraceParent] | The W3C trace parent header included in the request. -trace_parent = None -# Optional[TraceState] | The W3C trace state header included in the request. -trace_state = None try: @@ -165,8 +151,6 @@ try: branch=branch, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version, - trace_parent=trace_parent, - trace_state=trace_state, ) print("The create_temporary response:\n") pprint(api_response) @@ -268,8 +252,6 @@ Name | Type | Description | Notes | **sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | **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. | [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] | -**trace_parent** | Optional[TraceParent] | The W3C trace parent header included in the request. | [optional] | -**trace_state** | Optional[TraceState] | The W3C trace state header included in the request. | [optional] | **transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. | [optional] | ### Return type @@ -312,10 +294,6 @@ sdk_version = None select_v2 = None # 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. snapshot = None -# Optional[TraceParent] | The W3C trace parent header included in the request. -trace_parent = None -# Optional[TraceState] | The W3C trace state header included in the request. -trace_state = None # Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. transaction_id = None @@ -336,8 +314,6 @@ try: sdk_version=sdk_version, select_v2=select_v2, snapshot=snapshot, - trace_parent=trace_parent, - trace_state=trace_state, transaction_id=transaction_id, ) print("The load response:\n") @@ -390,8 +366,6 @@ Name | Type | Description | Notes | **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] | -**trace_parent** | Optional[TraceParent] | The W3C trace parent header included in the request. | [optional] | -**trace_state** | Optional[TraceState] | The W3C trace state header included in the request. | [optional] | ### Return type **LoadObjectSetLinksResponseV2** @@ -423,10 +397,6 @@ preview = None sdk_package_rid = None # Optional[SdkVersion] | The package version of the generated SDK. sdk_version = None -# Optional[TraceParent] | The W3C trace parent header included in the request. -trace_parent = None -# Optional[TraceState] | The W3C trace state header included in the request. -trace_state = None try: @@ -440,8 +410,6 @@ try: preview=preview, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version, - trace_parent=trace_parent, - trace_state=trace_state, ) print("The load_links response:\n") pprint(api_response) @@ -498,8 +466,6 @@ Name | Type | Description | Notes | **sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | **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. | [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] | -**trace_parent** | Optional[TraceParent] | The W3C trace parent header included in the request. | [optional] | -**trace_state** | Optional[TraceState] | The W3C trace state header included in the request. | [optional] | **transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. | [optional] | ### Return type @@ -544,10 +510,6 @@ sdk_version = None select_v2 = None # 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. snapshot = None -# Optional[TraceParent] | The W3C trace parent header included in the request. -trace_parent = None -# Optional[TraceState] | The W3C trace state header included in the request. -trace_state = None # Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. transaction_id = None @@ -569,8 +531,6 @@ try: sdk_version=sdk_version, select_v2=select_v2, snapshot=snapshot, - trace_parent=trace_parent, - trace_state=trace_state, transaction_id=transaction_id, ) print("The load_multiple_object_types response:\n") @@ -628,9 +588,6 @@ Name | Type | Description | Notes | **sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | **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. | [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] | -**trace_parent** | Optional[TraceParent] | The W3C trace parent header included in the request. | [optional] | -**trace_state** | Optional[TraceState] | The W3C trace state header included in the request. | [optional] | -**transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. | [optional] | ### Return type **LoadObjectSetV2ObjectsOrInterfacesResponse** @@ -670,12 +627,6 @@ sdk_version = None select_v2 = None # 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. snapshot = None -# Optional[TraceParent] | The W3C trace parent header included in the request. -trace_parent = None -# Optional[TraceState] | The W3C trace state header included in the request. -trace_state = None -# Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. -transaction_id = None try: @@ -693,9 +644,6 @@ try: sdk_version=sdk_version, select_v2=select_v2, snapshot=snapshot, - trace_parent=trace_parent, - trace_state=trace_state, - transaction_id=transaction_id, ) print("The load_objects_or_interfaces response:\n") pprint(api_response) diff --git a/docs/v2/Ontologies/Query.md b/docs/v2/Ontologies/Query.md index 5bee10581..3e69b45f0 100644 --- a/docs/v2/Ontologies/Query.md +++ b/docs/v2/Ontologies/Query.md @@ -18,13 +18,12 @@ Name | Type | Description | Notes | **query_api_name** | QueryApiName | The API name of the Query to execute. | | **parameters** | Dict[ParameterId, Optional[DataValue]] | | | **attribution** | Optional[Attribution] | The Attribution to be used when executing this request. | [optional] | -**branch** | Optional[FoundryBranch] | The Foundry branch to execute the query from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. When provided without `version`, the latest version on this branch is used, including pre-release versions. When provided with `version`, the specified version must exist on the branch. | [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] | **trace_parent** | Optional[TraceParent] | The W3C trace parent header included in the request. | [optional] | **trace_state** | Optional[TraceState] | The W3C trace state header included in the request. | [optional] | **transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. | [optional] | -**version** | Optional[FunctionVersion] | The version of the Query to execute. When used with `branch`, the specified version must exist on the branch. | [optional] | +**version** | Optional[FunctionVersion] | The version of the Query to execute. | [optional] | ### Return type **ExecuteQueryResponse** @@ -46,8 +45,6 @@ query_api_name = "getEmployeesInCity" parameters = {"city": "New York"} # Optional[Attribution] | The Attribution to be used when executing this request. attribution = None -# Optional[FoundryBranch] | The Foundry branch to execute the query from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. When provided without `version`, the latest version on this branch is used, including pre-release versions. When provided with `version`, the specified version must exist on the branch. -branch = None # Optional[SdkPackageRid] | The package rid of the generated SDK. sdk_package_rid = None # Optional[SdkVersion] | The version of the generated SDK. @@ -58,7 +55,7 @@ trace_parent = None trace_state = None # Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. transaction_id = None -# Optional[FunctionVersion] | The version of the Query to execute. When used with `branch`, the specified version must exist on the branch. +# Optional[FunctionVersion] | The version of the Query to execute. version = None @@ -68,7 +65,6 @@ try: query_api_name, parameters=parameters, attribution=attribution, - branch=branch, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version, trace_parent=trace_parent, diff --git a/docs/v2/Ontologies/QueryType.md b/docs/v2/Ontologies/QueryType.md index 73bc202f1..620d1210d 100644 --- a/docs/v2/Ontologies/QueryType.md +++ b/docs/v2/Ontologies/QueryType.md @@ -83,7 +83,6 @@ results available, at least one result will be present in the response. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | | | -**branch** | Optional[FoundryBranch] | The Foundry branch to list queries from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. | [optional] | **page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 100. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | **page_token** | Optional[PageToken] | | [optional] | @@ -101,8 +100,6 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # OntologyIdentifier ontology = "palantir" -# Optional[FoundryBranch] | The Foundry branch to list queries from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. -branch = None # Optional[PageSize] | The desired size of the page to be returned. Defaults to 100. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. page_size = None # Optional[PageToken] @@ -111,7 +108,7 @@ page_token = None try: for query_type in client.ontologies.Ontology.QueryType.list( - ontology, branch=branch, page_size=page_size, page_token=page_token + ontology, page_size=page_size, page_token=page_token ): pprint(query_type) except foundry_sdk.PalantirRPCException as e: diff --git a/docs/v2/Ontologies/models/AggregationAccuracyRequest.md b/docs/v2/Ontologies/models/AggregationAccuracyRequest.md index 65a7424e5..b17209cc7 100644 --- a/docs/v2/Ontologies/models/AggregationAccuracyRequest.md +++ b/docs/v2/Ontologies/models/AggregationAccuracyRequest.md @@ -1,13 +1,6 @@ # AggregationAccuracyRequest -Specifies the accuracy requirement for aggregation results. - -- `REQUIRE_ACCURATE`: Only return results if they are guaranteed to be accurate. If accuracy cannot be - guaranteed (e.g., due to a low `maxGroupCount` relative to distinct values), the request will fail - with an `AggregationAccuracyNotSupported` error. -- `ALLOW_APPROXIMATE`: Allow approximate results when exact computation is not feasible. This is the - default behavior if not specified. - +AggregationAccuracyRequest | **Value** | | --------- | diff --git a/docs/v2/Ontologies/models/AggregationDurationGroupingV2.md b/docs/v2/Ontologies/models/AggregationDurationGroupingV2.md index c643d86c5..1508300e7 100644 --- a/docs/v2/Ontologies/models/AggregationDurationGroupingV2.md +++ b/docs/v2/Ontologies/models/AggregationDurationGroupingV2.md @@ -2,14 +2,12 @@ Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. -Either `field` or `propertyIdentifier` must be supplied, but not both. ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**field** | Optional[PropertyApiName] | No | | -**property_identifier** | Optional[PropertyIdentifier] | No | | +**field** | PropertyApiName | Yes | | **value** | int | Yes | | **unit** | TimeUnit | Yes | | **type** | Literal["duration"] | Yes | None | diff --git a/docs/v2/Ontologies/models/AggregationExactGroupingV2.md b/docs/v2/Ontologies/models/AggregationExactGroupingV2.md index 2e7297b84..e91971809 100644 --- a/docs/v2/Ontologies/models/AggregationExactGroupingV2.md +++ b/docs/v2/Ontologies/models/AggregationExactGroupingV2.md @@ -1,15 +1,12 @@ # AggregationExactGroupingV2 Divides objects into groups according to an exact value. -Either `field` or `propertyIdentifier` must be supplied, but not both. - ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**field** | Optional[PropertyApiName] | No | | -**property_identifier** | Optional[PropertyIdentifier] | No | | -**max_group_count** | Optional[int] | No | The maximum number of groups to return. If omitted, defaults to 10,000. The server allocates resources based on the specified `maxGroupCount`. When the number of distinct values in your data is within this limit, results are accurate and the top N values are returned correctly. When distinct values exceed what the allocated resources can handle, results may become approximate. If you need accurate results with high-cardinality properties, set `maxGroupCount` high enough to cover your distinct values. Items exceeding the limit are excluded from results and counted in `excludedItems`. The response `accuracy` field indicates whether the results are `ACCURATE` or `APPROXIMATE`. | +**field** | PropertyApiName | Yes | | +**max_group_count** | Optional[int] | No | | **default_value** | Optional[str] | No | Includes a group with the specified default value that includes all objects where the specified field's value is null. Cannot be used with includeNullValues. | **include_null_values** | Optional[bool] | No | Includes a group with a null value that includes all objects where the specified field's value is null. Cannot be used with defaultValue or orderBy clauses on the aggregation. | **type** | Literal["exact"] | Yes | None | diff --git a/docs/v2/Ontologies/models/AggregationFixedWidthGroupingV2.md b/docs/v2/Ontologies/models/AggregationFixedWidthGroupingV2.md index edf58eacc..1e8cf52f0 100644 --- a/docs/v2/Ontologies/models/AggregationFixedWidthGroupingV2.md +++ b/docs/v2/Ontologies/models/AggregationFixedWidthGroupingV2.md @@ -1,14 +1,11 @@ # AggregationFixedWidthGroupingV2 Divides objects into groups with the specified width. -Either `field` or `propertyIdentifier` must be supplied, but not both. - ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**field** | Optional[PropertyApiName] | No | | -**property_identifier** | Optional[PropertyIdentifier] | No | | +**field** | PropertyApiName | Yes | | **fixed_width** | int | Yes | | **type** | Literal["fixedWidth"] | Yes | None | diff --git a/docs/v2/Ontologies/models/AggregationRangesGroupingV2.md b/docs/v2/Ontologies/models/AggregationRangesGroupingV2.md index 0f4259ac4..98e64396a 100644 --- a/docs/v2/Ontologies/models/AggregationRangesGroupingV2.md +++ b/docs/v2/Ontologies/models/AggregationRangesGroupingV2.md @@ -1,14 +1,11 @@ # AggregationRangesGroupingV2 Divides objects into groups according to specified ranges. -Either `field` or `propertyIdentifier` must be supplied, but not both. - ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**field** | Optional[PropertyApiName] | No | | -**property_identifier** | Optional[PropertyIdentifier] | No | | +**field** | PropertyApiName | Yes | | **ranges** | List[AggregationRangeV2] | Yes | | **type** | Literal["ranges"] | Yes | None | diff --git a/docs/v2/Ontologies/models/ApproximateDistinctAggregationV2.md b/docs/v2/Ontologies/models/ApproximateDistinctAggregationV2.md index e55775876..01a24f7fe 100644 --- a/docs/v2/Ontologies/models/ApproximateDistinctAggregationV2.md +++ b/docs/v2/Ontologies/models/ApproximateDistinctAggregationV2.md @@ -1,14 +1,11 @@ # ApproximateDistinctAggregationV2 Computes an approximate number of distinct values for the provided field. -Either `field` or `propertyIdentifier` must be supplied, but not both. - ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**field** | Optional[PropertyApiName] | No | | -**property_identifier** | Optional[PropertyIdentifier] | No | | +**field** | PropertyApiName | Yes | | **name** | Optional[AggregationMetricName] | No | | **direction** | Optional[OrderByDirection] | No | | **type** | Literal["approximateDistinct"] | Yes | None | diff --git a/docs/v2/Ontologies/models/ApproximatePercentileAggregationV2.md b/docs/v2/Ontologies/models/ApproximatePercentileAggregationV2.md index c4e4f7f78..0889af51d 100644 --- a/docs/v2/Ontologies/models/ApproximatePercentileAggregationV2.md +++ b/docs/v2/Ontologies/models/ApproximatePercentileAggregationV2.md @@ -1,14 +1,11 @@ # ApproximatePercentileAggregationV2 Computes the approximate percentile value for the provided field. Requires Object Storage V2. -Either `field` or `propertyIdentifier` must be supplied, but not both. - ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**field** | Optional[PropertyApiName] | No | | -**property_identifier** | Optional[PropertyIdentifier] | No | | +**field** | PropertyApiName | Yes | | **name** | Optional[AggregationMetricName] | No | | **approximate_percentile** | float | Yes | | **direction** | Optional[OrderByDirection] | No | | diff --git a/docs/v2/Ontologies/models/AvgAggregationV2.md b/docs/v2/Ontologies/models/AvgAggregationV2.md index 95e38cdc2..08aac5cf8 100644 --- a/docs/v2/Ontologies/models/AvgAggregationV2.md +++ b/docs/v2/Ontologies/models/AvgAggregationV2.md @@ -1,14 +1,11 @@ # AvgAggregationV2 Computes the average value for the provided field. -Either `field` or `propertyIdentifier` must be supplied, but not both. - ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**field** | Optional[PropertyApiName] | No | | -**property_identifier** | Optional[PropertyIdentifier] | No | | +**field** | PropertyApiName | Yes | | **name** | Optional[AggregationMetricName] | No | | **direction** | Optional[OrderByDirection] | No | | **type** | Literal["avg"] | Yes | None | diff --git a/docs/v2/Ontologies/models/BoundingBoxValue.md b/docs/v2/Ontologies/models/BoundingBoxValue.md index bde661777..4aaf5ddb3 100644 --- a/docs/v2/Ontologies/models/BoundingBoxValue.md +++ b/docs/v2/Ontologies/models/BoundingBoxValue.md @@ -8,7 +8,6 @@ The top left and bottom right coordinate points that make up the bounding box. | ------------ | ------------- | ------------- | ------------- | **top_left** | WithinBoundingBoxPoint | Yes | | **bottom_right** | WithinBoundingBoxPoint | Yes | | -**type** | Literal["envelope"] | 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/ContainsAllTermsQuery.md b/docs/v2/Ontologies/models/ContainsAllTermsQuery.md index 407109ff2..4e43def72 100644 --- a/docs/v2/Ontologies/models/ContainsAllTermsQuery.md +++ b/docs/v2/Ontologies/models/ContainsAllTermsQuery.md @@ -1,7 +1,7 @@ # ContainsAllTermsQuery Returns objects where the specified field contains all of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on +order in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. diff --git a/docs/v2/MediaSets/models/Model3dType.md b/docs/v2/Ontologies/models/EditTypeFilter.md similarity index 69% rename from docs/v2/MediaSets/models/Model3dType.md rename to docs/v2/Ontologies/models/EditTypeFilter.md index d11b846b4..e36799d39 100644 --- a/docs/v2/MediaSets/models/Model3dType.md +++ b/docs/v2/Ontologies/models/EditTypeFilter.md @@ -1,11 +1,12 @@ -# Model3dType +# EditTypeFilter -The type of 3D model representation. +EditTypeFilter | **Value** | | --------- | -| `"POINT_CLOUD"` | -| `"MESH"` | +| `"create"` | +| `"modify"` | +| `"delete"` | [[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/EditsHistoryFilter.md b/docs/v2/Ontologies/models/EditsHistoryFilter.md deleted file mode 100644 index 93ed62311..000000000 --- a/docs/v2/Ontologies/models/EditsHistoryFilter.md +++ /dev/null @@ -1,16 +0,0 @@ -# EditsHistoryFilter - -EditsHistoryFilter - -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 -| ------------ | ------------- -EditsHistoryTimestampFilter | timestampFilter -EditsHistoryOperationIdsFilter | operationIdsFilter - - -[[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/EditsHistoryTimestampFilter.md b/docs/v2/Ontologies/models/EditsHistoryFilters.md similarity index 54% rename from docs/v2/Ontologies/models/EditsHistoryTimestampFilter.md rename to docs/v2/Ontologies/models/EditsHistoryFilters.md index fd9be7718..566e8eb41 100644 --- a/docs/v2/Ontologies/models/EditsHistoryTimestampFilter.md +++ b/docs/v2/Ontologies/models/EditsHistoryFilters.md @@ -1,13 +1,15 @@ -# EditsHistoryTimestampFilter +# EditsHistoryFilters -EditsHistoryTimestampFilter +EditsHistoryFilters ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **start_time** | Optional[datetime] | No | Filter edits to only those that occurred after this timestamp (inclusive). ISO 8601 format. Example: "2024-01-01T00:00:00Z" | **end_time** | Optional[datetime] | No | Filter edits to only those that occurred before this timestamp (inclusive). ISO 8601 format. Example: "2024-12-31T23:59:59Z" | -**type** | Literal["timestampFilter"] | Yes | None | +**action_types** | List[ActionTypeApiName] | Yes | Filter edits to only those caused by specific action types. If not specified, edits from all action types are returned. | +**edit_types** | List[EditTypeFilter] | Yes | Filter edits by operation type (create, modify, or delete). If not specified, all edit types are returned. | +**user_ids** | List[str] | Yes | Filter edits to only those performed by specific users. If not specified, edits from all users are returned. | [[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/EditsHistoryOperationIdsFilter.md b/docs/v2/Ontologies/models/EditsHistoryOperationIdsFilter.md deleted file mode 100644 index 78c27823c..000000000 --- a/docs/v2/Ontologies/models/EditsHistoryOperationIdsFilter.md +++ /dev/null @@ -1,12 +0,0 @@ -# EditsHistoryOperationIdsFilter - -EditsHistoryOperationIdsFilter - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**operation_ids** | List[ActionRid] | Yes | | -**type** | Literal["operationIdsFilter"] | 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/EqualsQueryV2.md b/docs/v2/Ontologies/models/EqualsQueryV2.md index c5a01ff9d..d960e118b 100644 --- a/docs/v2/Ontologies/models/EqualsQueryV2.md +++ b/docs/v2/Ontologies/models/EqualsQueryV2.md @@ -3,8 +3,6 @@ Returns objects where the specified field is equal to a value. Allows you to specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. -For string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager. - ## Properties | Name | Type | Required | Description | diff --git a/docs/v2/Ontologies/models/ExactDistinctAggregationV2.md b/docs/v2/Ontologies/models/ExactDistinctAggregationV2.md index 4b3b4b5b1..715689e67 100644 --- a/docs/v2/Ontologies/models/ExactDistinctAggregationV2.md +++ b/docs/v2/Ontologies/models/ExactDistinctAggregationV2.md @@ -1,15 +1,11 @@ # ExactDistinctAggregationV2 -Computes an exact number of distinct values for the provided field. May be slower than an approximate -distinct aggregation. Requires Object Storage V2. -Either `field` or `propertyIdentifier` must be supplied, but not both. - +Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**field** | Optional[PropertyApiName] | No | | -**property_identifier** | Optional[PropertyIdentifier] | No | | +**field** | PropertyApiName | Yes | | **name** | Optional[AggregationMetricName] | No | | **direction** | Optional[OrderByDirection] | No | | **type** | Literal["exactDistinct"] | Yes | None | diff --git a/docs/v2/Ontologies/models/FuzzyRule.md b/docs/v2/Ontologies/models/FuzzyRule.md deleted file mode 100644 index 22a8b3960..000000000 --- a/docs/v2/Ontologies/models/FuzzyRule.md +++ /dev/null @@ -1,16 +0,0 @@ -# FuzzyRule - -Matches intervals containing terms that are similar to the provided term, within an edit distance -defined by fuzziness. An edit is a single character change needed to make a term match, including -character insertion, deletion, substitution, or transposition of two adjacent characters. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**term** | str | Yes | The term to match. | -**fuzziness** | Optional[int] | No | Maximum edit distance allowed for matching. Valid values are 0, 1, or 2. Defaults to 2. | -**type** | Literal["fuzzy"] | 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/GeoJsonString.md b/docs/v2/Ontologies/models/GeoJsonString.md deleted file mode 100644 index d1d9a9816..000000000 --- a/docs/v2/Ontologies/models/GeoJsonString.md +++ /dev/null @@ -1,12 +0,0 @@ -# GeoJsonString - -A GeoJSON geometry specification. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**geo_json** | str | Yes | A GeoJSON geometry string. Supported geometry types include Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, and GeometryCollection. | -**type** | Literal["geoJson"] | 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/GeoShapeV2Geometry.md b/docs/v2/Ontologies/models/GeoShapeV2Geometry.md deleted file mode 100644 index 935e12eb4..000000000 --- a/docs/v2/Ontologies/models/GeoShapeV2Geometry.md +++ /dev/null @@ -1,17 +0,0 @@ -# GeoShapeV2Geometry - -Geometry specification for a GeoShapeV2Query. Supports bounding box envelopes and arbitrary GeoJSON geometries. - - -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 -| ------------ | ------------- -BoundingBoxValue | envelope -GeoJsonString | geoJson - - -[[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/GeoShapeV2Query.md b/docs/v2/Ontologies/models/GeoShapeV2Query.md deleted file mode 100644 index 2f73a3ff1..000000000 --- a/docs/v2/Ontologies/models/GeoShapeV2Query.md +++ /dev/null @@ -1,18 +0,0 @@ -# GeoShapeV2Query - -Returns objects where the specified field satisfies the provided geometry query with the given spatial operator. -Supports both envelope (bounding box) and GeoJSON geometries for filtering geopoint or geoshape properties. -Either `field` or `propertyIdentifier` can be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | Optional[PropertyApiName] | No | | -**property_identifier** | Optional[PropertyIdentifier] | No | | -**geometry** | GeoShapeV2Geometry | Yes | | -**spatial_filter_mode** | SpatialFilterMode | Yes | | -**type** | Literal["geoShapeV2"] | 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/GetActionTypeByRidBatchRequest.md b/docs/v2/Ontologies/models/GetActionTypeByRidBatchRequest.md deleted file mode 100644 index 1ae5f826e..000000000 --- a/docs/v2/Ontologies/models/GetActionTypeByRidBatchRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetActionTypeByRidBatchRequest - -GetActionTypeByRidBatchRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**requests** | List[GetActionTypeByRidBatchRequestElement] | 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/GetActionTypeByRidBatchRequestElement.md b/docs/v2/Ontologies/models/GetActionTypeByRidBatchRequestElement.md deleted file mode 100644 index d5b6b3402..000000000 --- a/docs/v2/Ontologies/models/GetActionTypeByRidBatchRequestElement.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetActionTypeByRidBatchRequestElement - -GetActionTypeByRidBatchRequestElement - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**action_type_rid** | ActionTypeRid | 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/GetActionTypeByRidBatchResponse.md b/docs/v2/Ontologies/models/GetActionTypeByRidBatchResponse.md deleted file mode 100644 index 5f4670f5b..000000000 --- a/docs/v2/Ontologies/models/GetActionTypeByRidBatchResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetActionTypeByRidBatchResponse - -GetActionTypeByRidBatchResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[ActionTypeV2] | 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/GetObjectTypeByRidBatchRequest.md b/docs/v2/Ontologies/models/GetObjectTypeByRidBatchRequest.md deleted file mode 100644 index 9099b3c4c..000000000 --- a/docs/v2/Ontologies/models/GetObjectTypeByRidBatchRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetObjectTypeByRidBatchRequest - -GetObjectTypeByRidBatchRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**requests** | List[GetObjectTypeByRidBatchRequestElement] | 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/GetObjectTypeByRidBatchRequestElement.md b/docs/v2/Ontologies/models/GetObjectTypeByRidBatchRequestElement.md deleted file mode 100644 index 0107613ea..000000000 --- a/docs/v2/Ontologies/models/GetObjectTypeByRidBatchRequestElement.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetObjectTypeByRidBatchRequestElement - -GetObjectTypeByRidBatchRequestElement - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_type_rid** | ObjectTypeRid | 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/GetObjectTypeByRidBatchResponse.md b/docs/v2/Ontologies/models/GetObjectTypeByRidBatchResponse.md deleted file mode 100644 index 63a109c24..000000000 --- a/docs/v2/Ontologies/models/GetObjectTypeByRidBatchResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetObjectTypeByRidBatchResponse - -GetObjectTypeByRidBatchResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[ObjectTypeV2] | 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/GetOutgoingLinkTypesByObjectTypeRidBatchRequest.md b/docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchRequest.md deleted file mode 100644 index 816797dca..000000000 --- a/docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# GetOutgoingLinkTypesByObjectTypeRidBatchRequest - -GetOutgoingLinkTypesByObjectTypeRidBatchRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**requests** | List[GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement] | Yes | | -**filter_link_type_rids** | List[LinkTypeRid] | Yes | If provided, only return outgoing link types with RIDs in this list. If omitted, all outgoing link types for each requested object type are returned. | - - -[[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/GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement.md b/docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement.md deleted file mode 100644 index 777c23b41..000000000 --- a/docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement - -GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_type_rid** | ObjectTypeRid | 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/GetOutgoingLinkTypesByObjectTypeRidBatchResponse.md b/docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchResponse.md deleted file mode 100644 index 42d51abd6..000000000 --- a/docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetOutgoingLinkTypesByObjectTypeRidBatchResponse - -GetOutgoingLinkTypesByObjectTypeRidBatchResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | Dict[ObjectTypeRid, List[LinkTypeSideV2]] | 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/InQuery.md b/docs/v2/Ontologies/models/InQuery.md index e1565566e..b3d88ebf1 100644 --- a/docs/v2/Ontologies/models/InQuery.md +++ b/docs/v2/Ontologies/models/InQuery.md @@ -4,8 +4,6 @@ Returns objects where the specified field equals any of the provided values. All 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. -For string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager. - ## Properties | Name | Type | Required | Description | diff --git a/docs/v2/Ontologies/models/IntervalQueryRule.md b/docs/v2/Ontologies/models/IntervalQueryRule.md index 9356660ae..e1499af69 100644 --- a/docs/v2/Ontologies/models/IntervalQueryRule.md +++ b/docs/v2/Ontologies/models/IntervalQueryRule.md @@ -13,7 +13,6 @@ AllOfRule | allOf MatchRule | match AnyOfRule | anyOf PrefixOnLastTokenRule | prefixOnLastToken -FuzzyRule | fuzzy [[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/LoadObjectSetV2ObjectsOrInterfacesResponse.md b/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesResponse.md index 3b75024e2..475ba9f92 100644 --- a/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesResponse.md +++ b/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesResponse.md @@ -10,7 +10,6 @@ defined by an interface that the objects belong to or properties defined by the **data** | List[OntologyObjectV2] | Yes | The list of objects in the current page. | **next_page_token** | Optional[PageToken] | No | | **total_count** | TotalCount | Yes | | -**transaction_id** | Optional[OntologyTransactionId] | 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/MaxAggregationV2.md b/docs/v2/Ontologies/models/MaxAggregationV2.md index 505439160..3738287bc 100644 --- a/docs/v2/Ontologies/models/MaxAggregationV2.md +++ b/docs/v2/Ontologies/models/MaxAggregationV2.md @@ -1,14 +1,11 @@ # MaxAggregationV2 Computes the maximum value for the provided field. -Either `field` or `propertyIdentifier` must be supplied, but not both. - ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**field** | Optional[PropertyApiName] | No | | -**property_identifier** | Optional[PropertyIdentifier] | No | | +**field** | PropertyApiName | Yes | | **name** | Optional[AggregationMetricName] | No | | **direction** | Optional[OrderByDirection] | No | | **type** | Literal["max"] | Yes | None | diff --git a/docs/v2/Ontologies/models/MinAggregationV2.md b/docs/v2/Ontologies/models/MinAggregationV2.md index d98df8f9c..2ddef7c51 100644 --- a/docs/v2/Ontologies/models/MinAggregationV2.md +++ b/docs/v2/Ontologies/models/MinAggregationV2.md @@ -1,14 +1,11 @@ # MinAggregationV2 Computes the minimum value for the provided field. -Either `field` or `propertyIdentifier` must be supplied, but not both. - ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**field** | Optional[PropertyApiName] | No | | -**property_identifier** | Optional[PropertyIdentifier] | No | | +**field** | PropertyApiName | Yes | | **name** | Optional[AggregationMetricName] | No | | **direction** | Optional[OrderByDirection] | No | | **type** | Literal["min"] | Yes | None | diff --git a/docs/v2/Ontologies/models/ObjectEditHistoryEntry.md b/docs/v2/Ontologies/models/ObjectEditHistoryEntry.md index f81daa276..a0bcc1615 100644 --- a/docs/v2/Ontologies/models/ObjectEditHistoryEntry.md +++ b/docs/v2/Ontologies/models/ObjectEditHistoryEntry.md @@ -7,7 +7,6 @@ created, modified, or deleted as part of an action execution. ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**object_primary_key** | ObjectPrimaryKeyV2 | Yes | | **operation_id** | ActionRid | Yes | | **action_type_rid** | ActionTypeRid | Yes | | **user_id** | str | Yes | The user ID or principal that performed the action | diff --git a/docs/v2/Ontologies/models/ObjectTypeEditsHistoryRequest.md b/docs/v2/Ontologies/models/ObjectTypeEditsHistoryRequest.md index d8ce542ad..6ec94077b 100644 --- a/docs/v2/Ontologies/models/ObjectTypeEditsHistoryRequest.md +++ b/docs/v2/Ontologies/models/ObjectTypeEditsHistoryRequest.md @@ -10,7 +10,7 @@ Otherwise, the method will return edits history for all objects of this object t | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **object_primary_key** | Optional[ObjectPrimaryKeyV2] | No | | -**filters** | Optional[EditsHistoryFilter] | No | | +**filters** | Optional[EditsHistoryFilters] | No | | **sort_order** | Optional[EditsHistorySortOrder] | No | | **include_all_previous_properties** | Optional[bool] | No | | **page_size** | Optional[int] | No | The maximum number of edits to return per page. Defaults to 100. | diff --git a/docs/v2/Ontologies/models/OntologyDataType.md b/docs/v2/Ontologies/models/OntologyDataType.md index 15f8e483a..fa382d602 100644 --- a/docs/v2/Ontologies/models/OntologyDataType.md +++ b/docs/v2/Ontologies/models/OntologyDataType.md @@ -24,7 +24,6 @@ BooleanType | boolean CipherTextType | cipherText MarkingType | marking UnsupportedType | unsupported -MediaReferenceType | mediaReference OntologyArrayType | array OntologyObjectSetType | objectSet BinaryType | binary diff --git a/docs/v2/Ontologies/models/QueryDataType.md b/docs/v2/Ontologies/models/QueryDataType.md index a849fe7c9..3877d5830 100644 --- a/docs/v2/Ontologies/models/QueryDataType.md +++ b/docs/v2/Ontologies/models/QueryDataType.md @@ -13,28 +13,25 @@ This discriminator class uses the `type` field to differentiate between classes. DateType | date OntologyInterfaceObjectType | interfaceObject QueryStructType | struct +QuerySetType | set StringType | string +EntrySetType | entrySet +DoubleType | double IntegerType | integer ThreeDimensionalAggregation | threeDimensionalAggregation +QueryUnionType | union FloatType | float LongType | long +BooleanType | boolean UnsupportedType | unsupported AttachmentType | attachment +NullType | null QueryArrayType | array OntologyObjectSetType | objectSet TwoDimensionalAggregation | twoDimensionalAggregation -QueryTypeReferenceType | typeReference -TimestampType | timestamp -QuerySetType | set -VoidType | void -EntrySetType | entrySet -DoubleType | double -QueryUnionType | union -BooleanType | boolean -MediaReferenceType | mediaReference -NullType | null OntologyInterfaceObjectSetType | interfaceObjectSet OntologyObjectType | object +TimestampType | timestamp [[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/QueryParameterV2.md b/docs/v2/Ontologies/models/QueryParameterV2.md index fa2f68be1..9b1abb881 100644 --- a/docs/v2/Ontologies/models/QueryParameterV2.md +++ b/docs/v2/Ontologies/models/QueryParameterV2.md @@ -7,7 +7,6 @@ Details about a parameter of a query. | ------------ | ------------- | ------------- | ------------- | **description** | Optional[str] | No | | **data_type** | QueryDataType | Yes | | -**required** | bool | 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/QueryTypeReferenceType.md b/docs/v2/Ontologies/models/QueryTypeReferenceType.md deleted file mode 100644 index adf1d99fb..000000000 --- a/docs/v2/Ontologies/models/QueryTypeReferenceType.md +++ /dev/null @@ -1,14 +0,0 @@ -# QueryTypeReferenceType - -A reference to a type that is defined in the `typeReferences` map of the enclosing Query. -This enables support for recursive type definitions where a type may reference itself. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type_id** | TypeReferenceIdentifier | Yes | | -**type** | Literal["typeReference"] | 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/QueryTypeV2.md b/docs/v2/Ontologies/models/QueryTypeV2.md index 8ed75b7b2..8ee80ba6b 100644 --- a/docs/v2/Ontologies/models/QueryTypeV2.md +++ b/docs/v2/Ontologies/models/QueryTypeV2.md @@ -12,7 +12,6 @@ Represents a query type in the Ontology. **output** | QueryDataType | Yes | | **rid** | FunctionRid | Yes | | **version** | FunctionVersion | Yes | | -**type_references** | Dict[TypeReferenceIdentifier, QueryDataType] | 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/RegexQuery.md b/docs/v2/Ontologies/models/RegexQuery.md index e2a287f72..e84a21d89 100644 --- a/docs/v2/Ontologies/models/RegexQuery.md +++ b/docs/v2/Ontologies/models/RegexQuery.md @@ -1,26 +1,7 @@ # RegexQuery Returns objects where the specified field matches the regex pattern provided. This applies to the non-analyzed -form of text fields. Supported operators: - - `.` matches any character. - - `?` repeats the previous character 0 or 1 times. - - `+` repeats the previous character 1 or more times. - - `*` repeats the previous character 0 or more times. - - `{}` defines the minimum and maximum number of times the preceding character can repeat. `{2}` means the - previous character must repeat only twice, `{2,}` means the previous character must repeat at least twice, - and `{2,4}` means the previous character must repeat between 2-4 times. - - `|` is the OR operator. - - `()` forms a group within an expression such that the group can be treated as a single character. - - `[]` matches a single one of the characters contained inside the brackets, meaning [abc] matches `a`, `b` or - `c`. Unless `-` is the first character or escaped with `\` (in which case it is treated as a normal character), - `-` can be used inside the bracket to create a range of characters, meaning [a-c] matches `a`, `b`, or `c`. - If the character sequence inside the brackets begins with `^`, the set of characters is negated, meaning - [^abc] does not match `a`, `b`, or `c`. Otherwise, `^` is treated as a normal character. - - `"` creates groups of string literals. - - `\` is used as an escape character. However, \d and \D match digit and non-digit characters respectively, \s - and \S match whitespace and non whitespace characters respectively, and \w and \W match word and non word - characters respectively. - +form of text fields and supports standard regex syntax of dot (.), star(*) and question mark(?). Either `field` or `propertyIdentifier` can be supplied, but not both. diff --git a/docs/v2/Ontologies/models/SearchJsonQueryV2.md b/docs/v2/Ontologies/models/SearchJsonQueryV2.md index 7c374cd8b..40876afb4 100644 --- a/docs/v2/Ontologies/models/SearchJsonQueryV2.md +++ b/docs/v2/Ontologies/models/SearchJsonQueryV2.md @@ -35,7 +35,6 @@ RegexQuery | regex IsNullQueryV2 | isNull ContainsAnyTermQuery | containsAnyTerm IntervalQuery | interval -GeoShapeV2Query | geoShapeV2 StartsWithQuery | startsWith diff --git a/docs/v2/Ontologies/models/SpatialFilterMode.md b/docs/v2/Ontologies/models/SpatialFilterMode.md deleted file mode 100644 index 5c5c0bc16..000000000 --- a/docs/v2/Ontologies/models/SpatialFilterMode.md +++ /dev/null @@ -1,16 +0,0 @@ -# SpatialFilterMode - -The spatial relation operator for a GeoShapeV2Query. INTERSECTS matches objects that intersect the provided -geometry, DISJOINT matches objects that do not intersect the provided geometry, WITHIN matches objects that -lie within the provided geometry, and CONTAINS matches objects that contain the provided geometry. - - -| **Value** | -| --------- | -| `"INTERSECTS"` | -| `"DISJOINT"` | -| `"WITHIN"` | -| `"CONTAINS"` | - - -[[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/SumAggregationV2.md b/docs/v2/Ontologies/models/SumAggregationV2.md index a65d86378..99fa61936 100644 --- a/docs/v2/Ontologies/models/SumAggregationV2.md +++ b/docs/v2/Ontologies/models/SumAggregationV2.md @@ -1,14 +1,11 @@ # SumAggregationV2 Computes the sum of values for the provided field. -Either `field` or `propertyIdentifier` must be supplied, but not both. - ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**field** | Optional[PropertyApiName] | No | | -**property_identifier** | Optional[PropertyIdentifier] | No | | +**field** | PropertyApiName | Yes | | **name** | Optional[AggregationMetricName] | No | | **direction** | Optional[OrderByDirection] | No | | **type** | Literal["sum"] | Yes | None | diff --git a/docs/v2/Ontologies/models/SyncApplyActionResponseV2.md b/docs/v2/Ontologies/models/SyncApplyActionResponseV2.md index 32b0cc591..58e5884e7 100644 --- a/docs/v2/Ontologies/models/SyncApplyActionResponseV2.md +++ b/docs/v2/Ontologies/models/SyncApplyActionResponseV2.md @@ -5,7 +5,6 @@ SyncApplyActionResponseV2 ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**operation_id** | Optional[RID] | No | | **validation** | Optional[ValidateActionResponseV2] | No | | **edits** | Optional[ActionResults] | No | | diff --git a/docs/v2/Ontologies/models/TypeReferenceIdentifier.md b/docs/v2/Ontologies/models/TypeReferenceIdentifier.md deleted file mode 100644 index 7910e95d4..000000000 --- a/docs/v2/Ontologies/models/TypeReferenceIdentifier.md +++ /dev/null @@ -1,13 +0,0 @@ -# TypeReferenceIdentifier - -The unique identifier of a type reference. This identifier is used to look up the -type definition in the `typeReferences` map of the enclosing Query. - - -## 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/Orchestration/Build.md b/docs/v2/Orchestration/Build.md index f1cb5b4b7..0cab4956b 100644 --- a/docs/v2/Orchestration/Build.md +++ b/docs/v2/Orchestration/Build.md @@ -143,9 +143,6 @@ See [README](../../../README.md#authorization) # **get** Get the Build with the specified rid. -Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - - ### Parameters Name | Type | Description | Notes | @@ -193,9 +190,6 @@ See [README](../../../README.md#authorization) # **get_batch** Execute multiple get requests on Build. -Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - - The maximum batch size for this endpoint is 100. ### Parameters diff --git a/docs/v2/Orchestration/Job.md b/docs/v2/Orchestration/Job.md index b93644c71..b565fc71b 100644 --- a/docs/v2/Orchestration/Job.md +++ b/docs/v2/Orchestration/Job.md @@ -8,9 +8,6 @@ Method | HTTP request | Release Stage | # **get** Get the Job with the specified rid. -Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - - ### Parameters Name | Type | Description | Notes | @@ -61,9 +58,6 @@ See [README](../../../README.md#authorization) # **get_batch** Execute multiple get requests on Job. -Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - - The maximum batch size for this endpoint is 500. ### Parameters diff --git a/docs/v2/Orchestration/Schedule.md b/docs/v2/Orchestration/Schedule.md index 9e3390df2..8a1e38b08 100644 --- a/docs/v2/Orchestration/Schedule.md +++ b/docs/v2/Orchestration/Schedule.md @@ -16,13 +16,6 @@ Method | HTTP request | Release Stage | # **create** Creates a new Schedule. -:::callout{theme=warning title=Warning} -If the schedule is created in user-scoped mode, outputs to build will be discovered based on resources -that the user has access to. If the user's permissions change later, this could change the outputs that -will be built or cause builds to fail. Consider using a project-scoped schedule instead. -::: - - ### Parameters Name | Type | Description | Notes | @@ -355,14 +348,7 @@ 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) # **replace** -Replaces the Schedule with the specified rid. - -:::callout{theme=warning title=Warning} -If the schedule is configured in user-scoped mode, outputs to build will be discovered based on resources -that the user has access to. If the user's permissions change later, this could change the outputs that -will be built or cause builds to fail. Consider using a project-scoped schedule instead. -::: - +Replace the Schedule with the specified rid. ### Parameters diff --git a/docs/v2/Orchestration/models/Build.md b/docs/v2/Orchestration/models/Build.md index ea221ffd5..30b71af62 100644 --- a/docs/v2/Orchestration/models/Build.md +++ b/docs/v2/Orchestration/models/Build.md @@ -15,7 +15,6 @@ Build **retry_backoff_duration** | RetryBackoffDuration | Yes | | **abort_on_failure** | AbortOnFailure | Yes | | **status** | BuildStatus | Yes | | -**finished_time** | Optional[datetime] | No | The time the build finished processing. Will be empty while the build is still running. | **schedule_rid** | Optional[ScheduleRid] | No | Schedule RID of the Schedule that triggered this build. If a user triggered the build, Schedule RID will be empty. | diff --git a/docs/v2/Orchestration/models/ScheduleRunErrorName.md b/docs/v2/Orchestration/models/ScheduleRunErrorName.md index beb30c7da..e8c14463f 100644 --- a/docs/v2/Orchestration/models/ScheduleRunErrorName.md +++ b/docs/v2/Orchestration/models/ScheduleRunErrorName.md @@ -4,13 +4,13 @@ ScheduleRunErrorName | **Value** | | --------- | -| `"TARGETRESOLUTIONFAILURE"` | -| `"CYCLICDEPENDENCY"` | -| `"INCOMPATIBLETARGETS"` | -| `"PERMISSIONDENIED"` | -| `"JOBSPECNOTFOUND"` | -| `"SCHEDULEOWNERNOTFOUND"` | -| `"INTERNAL"` | +| `"TargetResolutionFailure"` | +| `"CyclicDependency"` | +| `"IncompatibleTargets"` | +| `"PermissionDenied"` | +| `"JobSpecNotFound"` | +| `"ScheduleOwnerNotFound"` | +| `"Internal"` | [[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 2c13ea6ca..a0779be8d 100644 --- a/docs/v2/SqlQueries/SqlQuery.md +++ b/docs/v2/SqlQueries/SqlQuery.md @@ -4,7 +4,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**cancel**](#cancel) | **POST** /v2/sqlQueries/{sqlQueryId}/cancel | Stable | [**execute**](#execute) | **POST** /v2/sqlQueries/execute | Stable | -[**execute_ontology**](#execute_ontology) | **POST** /v2/sqlQueries/executeOntology | Private Beta | [**get_results**](#get_results) | **GET** /v2/sqlQueries/{sqlQueryId}/getResults | Stable | [**get_status**](#get_status) | **GET** /v2/sqlQueries/{sqlQueryId}/getStatus | Stable | @@ -68,7 +67,6 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **query** | str | The SQL query to execute. Queries should conform to the [Spark SQL dialect](https://spark.apache.org/docs/latest/sql-ref.html). This supports SELECT queries only. Datasets can be referenced in SQL queries by path or by RID. See the [documentation](https://www.palantir.com/docs/foundry/analytics-connectivity/odbc-jdbc-drivers/#use-sql-to-query-foundry-datasets) for more details. | | **fallback_branch_ids** | Optional[List[BranchName]] | The list of branch ids to use as fallbacks if the query fails to execute on the primary branch. If a is not explicitly provided in the SQL query, the resource will be queried on the first fallback branch provided that exists. If no fallback branches are provided the default branch is used. This is `master` for most enrollments. | [optional] | -**serialization_format** | Optional[SerializationFormat] | The format used to serialize query results. If not specified, defaults to `ARROW`. | [optional] | ### Return type **QueryStatus** @@ -86,15 +84,11 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa query = "SELECT * FROM `/Path/To/Dataset`" # Optional[List[BranchName]] | The list of branch ids to use as fallbacks if the query fails to execute on the primary branch. If a is not explicitly provided in the SQL query, the resource will be queried on the first fallback branch provided that exists. If no fallback branches are provided the default branch is used. This is `master` for most enrollments. fallback_branch_ids = ["master"] -# Optional[SerializationFormat] | The format used to serialize query results. If not specified, defaults to `ARROW`. -serialization_format = "CSV" try: api_response = client.sql_queries.SqlQuery.execute( - query=query, - fallback_branch_ids=fallback_branch_ids, - serialization_format=serialization_format, + query=query, fallback_branch_ids=fallback_branch_ids ) print("The execute response:\n") pprint(api_response) @@ -116,72 +110,9 @@ 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) -# **execute_ontology** -Executes a SQL query against the Ontology. Results are returned synchronously in -[Apache Arrow](https://arrow.apache.org/) format. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**query** | str | The SQL query to execute. | | -**dry_run** | Optional[bool] | If true, parse and validate the query without executing it. Defaults to false. | [optional] | -**parameters** | Optional[Parameters] | Parameters for the SQL query. Can be either unnamed positional parameters or a named parameter mapping. | [optional] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | -**row_limit** | Optional[int] | Maximum number of rows to return. | [optional] | - -### Return type -**bytes** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# str | The SQL query to execute. -query = "SELECT * FROM ri.ontology.main.object-type.xxx" -# Optional[bool] | If true, parse and validate the query without executing it. Defaults to false. -dry_run = None -# Optional[Parameters] | Parameters for the SQL query. Can be either unnamed positional parameters or a named parameter mapping. -parameters = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None -# Optional[int] | Maximum number of rows to return. -row_limit = None - - -try: - api_response = client.sql_queries.SqlQuery.execute_ontology( - query=query, dry_run=dry_run, parameters=parameters, preview=preview, row_limit=row_limit - ) - print("The execute_ontology response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling SqlQuery.execute_ontology: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | bytes | | application/octet-stream | - -[[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) - # **get_results** -Gets the results of a query. Results are returned in the `serializationFormat` specified at execute time -(defaulting to [Apache Arrow](https://arrow.apache.org/) if no format is provided). +Gets the results of a query. The results of the query are returned in the +[Apache Arrow](https://arrow.apache.org/) format. This endpoint implements long polling and requests will time out after one minute. They can be safely retried while the query is still running. diff --git a/docs/v2/SqlQueries/models/AnyColumnType.md b/docs/v2/SqlQueries/models/AnyColumnType.md deleted file mode 100644 index a789b4581..000000000 --- a/docs/v2/SqlQueries/models/AnyColumnType.md +++ /dev/null @@ -1,11 +0,0 @@ -# AnyColumnType - -AnyColumnType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["any"] | 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/models/ColumnType.md b/docs/v2/SqlQueries/models/ColumnType.md deleted file mode 100644 index 6a340169d..000000000 --- a/docs/v2/SqlQueries/models/ColumnType.md +++ /dev/null @@ -1,29 +0,0 @@ -# ColumnType - -The type of a column in a SQL query result or parameter. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DateType | date -StructColumnType | struct -StringType | string -DoubleType | double -IntegerType | integer -FloatType | float -ListColumnType | list -AnyColumnType | any -LongType | long -BooleanType | boolean -BinaryType | binary -ShortType | short -DecimalColumnType | decimal -MapColumnType | map -TimestampType | timestamp - - -[[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/models/DecimalColumnType.md b/docs/v2/SqlQueries/models/DecimalColumnType.md deleted file mode 100644 index c9cd9dc9e..000000000 --- a/docs/v2/SqlQueries/models/DecimalColumnType.md +++ /dev/null @@ -1,13 +0,0 @@ -# DecimalColumnType - -DecimalColumnType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**precision** | int | Yes | | -**scale** | int | Yes | | -**type** | Literal["decimal"] | 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/models/ExecuteOntologySqlQueryRequest.md b/docs/v2/SqlQueries/models/ExecuteOntologySqlQueryRequest.md deleted file mode 100644 index 13ce37554..000000000 --- a/docs/v2/SqlQueries/models/ExecuteOntologySqlQueryRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# ExecuteOntologySqlQueryRequest - -ExecuteOntologySqlQueryRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | str | Yes | The SQL query to execute. | -**parameters** | Optional[Parameters] | No | Parameters for the SQL query. Can be either unnamed positional parameters or a named parameter mapping. | -**row_limit** | Optional[int] | No | Maximum number of rows to return. | -**dry_run** | Optional[bool] | No | If true, parse and validate the query without executing it. Defaults to false. | - - -[[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/models/ExecuteSqlQueryRequest.md b/docs/v2/SqlQueries/models/ExecuteSqlQueryRequest.md index 14b3d06c7..58bb613dd 100644 --- a/docs/v2/SqlQueries/models/ExecuteSqlQueryRequest.md +++ b/docs/v2/SqlQueries/models/ExecuteSqlQueryRequest.md @@ -7,7 +7,6 @@ ExecuteSqlQueryRequest | ------------ | ------------- | ------------- | ------------- | **query** | str | Yes | The SQL query to execute. Queries should conform to the [Spark SQL dialect](https://spark.apache.org/docs/latest/sql-ref.html). This supports SELECT queries only. Datasets can be referenced in SQL queries by path or by RID. See the [documentation](https://www.palantir.com/docs/foundry/analytics-connectivity/odbc-jdbc-drivers/#use-sql-to-query-foundry-datasets) for more details. | **fallback_branch_ids** | Optional[List[BranchName]] | No | The list of branch ids to use as fallbacks if the query fails to execute on the primary branch. If a is not explicitly provided in the SQL query, the resource will be queried on the first fallback branch provided that exists. If no fallback branches are provided the default branch is used. This is `master` for most enrollments. | -**serialization_format** | Optional[SerializationFormat] | No | The format used to serialize query results. If not specified, defaults to `ARROW`. | [[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/models/ListColumnType.md b/docs/v2/SqlQueries/models/ListColumnType.md deleted file mode 100644 index f8ce18c3c..000000000 --- a/docs/v2/SqlQueries/models/ListColumnType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListColumnType - -ListColumnType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**element_type** | ColumnType | Yes | | -**type** | Literal["list"] | 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/models/MapColumnType.md b/docs/v2/SqlQueries/models/MapColumnType.md deleted file mode 100644 index 04678779b..000000000 --- a/docs/v2/SqlQueries/models/MapColumnType.md +++ /dev/null @@ -1,13 +0,0 @@ -# MapColumnType - -MapColumnType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key_type** | ColumnType | Yes | | -**value_type** | ColumnType | Yes | | -**type** | Literal["map"] | 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/models/MapParameterKey.md b/docs/v2/SqlQueries/models/MapParameterKey.md deleted file mode 100644 index 9dfbe4d2f..000000000 --- a/docs/v2/SqlQueries/models/MapParameterKey.md +++ /dev/null @@ -1,11 +0,0 @@ -# MapParameterKey - -A key for a map parameter value. - -## 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/SqlQueries/models/NamedParameterMapping.md b/docs/v2/SqlQueries/models/NamedParameterMapping.md deleted file mode 100644 index f699aee6f..000000000 --- a/docs/v2/SqlQueries/models/NamedParameterMapping.md +++ /dev/null @@ -1,12 +0,0 @@ -# NamedParameterMapping - -A named mapping of parameter names to values. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**mapping** | ParameterMapping | Yes | | -**type** | Literal["namedParameterMapping"] | 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/models/ParameterAnyValue.md b/docs/v2/SqlQueries/models/ParameterAnyValue.md deleted file mode 100644 index 6e427be31..000000000 --- a/docs/v2/SqlQueries/models/ParameterAnyValue.md +++ /dev/null @@ -1,12 +0,0 @@ -# ParameterAnyValue - -An untyped parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | Any | Yes | | -**type** | Literal["any"] | 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/models/ParameterBooleanValue.md b/docs/v2/SqlQueries/models/ParameterBooleanValue.md deleted file mode 100644 index 5497f2819..000000000 --- a/docs/v2/SqlQueries/models/ParameterBooleanValue.md +++ /dev/null @@ -1,12 +0,0 @@ -# ParameterBooleanValue - -A boolean parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | bool | Yes | | -**type** | Literal["boolean"] | 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/models/ParameterDateValue.md b/docs/v2/SqlQueries/models/ParameterDateValue.md deleted file mode 100644 index d2db08536..000000000 --- a/docs/v2/SqlQueries/models/ParameterDateValue.md +++ /dev/null @@ -1,12 +0,0 @@ -# ParameterDateValue - -A date parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | date | Yes | | -**type** | Literal["date"] | 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/models/ParameterDecimalValue.md b/docs/v2/SqlQueries/models/ParameterDecimalValue.md deleted file mode 100644 index d0c48076b..000000000 --- a/docs/v2/SqlQueries/models/ParameterDecimalValue.md +++ /dev/null @@ -1,12 +0,0 @@ -# ParameterDecimalValue - -A decimal parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | decimal.Decimal | Yes | | -**type** | Literal["decimal"] | 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/models/ParameterDoubleValue.md b/docs/v2/SqlQueries/models/ParameterDoubleValue.md deleted file mode 100644 index 336eb8f87..000000000 --- a/docs/v2/SqlQueries/models/ParameterDoubleValue.md +++ /dev/null @@ -1,12 +0,0 @@ -# ParameterDoubleValue - -A double parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | float | Yes | | -**type** | Literal["double"] | 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/models/ParameterFloatValue.md b/docs/v2/SqlQueries/models/ParameterFloatValue.md deleted file mode 100644 index cbc59df80..000000000 --- a/docs/v2/SqlQueries/models/ParameterFloatValue.md +++ /dev/null @@ -1,12 +0,0 @@ -# ParameterFloatValue - -A float parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | float | Yes | | -**type** | Literal["float"] | 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/models/ParameterIntegerValue.md b/docs/v2/SqlQueries/models/ParameterIntegerValue.md deleted file mode 100644 index 77ac366ab..000000000 --- a/docs/v2/SqlQueries/models/ParameterIntegerValue.md +++ /dev/null @@ -1,12 +0,0 @@ -# ParameterIntegerValue - -An integer parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | int | Yes | | -**type** | Literal["integer"] | 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/models/ParameterListValue.md b/docs/v2/SqlQueries/models/ParameterListValue.md deleted file mode 100644 index dcfd09596..000000000 --- a/docs/v2/SqlQueries/models/ParameterListValue.md +++ /dev/null @@ -1,14 +0,0 @@ -# ParameterListValue - -A parameter value that is a list of other parameter values. All values in the list must be of the same type. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**values** | List[ParameterValue] | Yes | | -**element_type** | ColumnType | Yes | | -**type** | Literal["list"] | 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/models/ParameterLongValue.md b/docs/v2/SqlQueries/models/ParameterLongValue.md deleted file mode 100644 index 5cca9c544..000000000 --- a/docs/v2/SqlQueries/models/ParameterLongValue.md +++ /dev/null @@ -1,12 +0,0 @@ -# ParameterLongValue - -A long integer parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | Long | Yes | | -**type** | Literal["long"] | 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/models/ParameterMapValue.md b/docs/v2/SqlQueries/models/ParameterMapValue.md deleted file mode 100644 index cd56117cc..000000000 --- a/docs/v2/SqlQueries/models/ParameterMapValue.md +++ /dev/null @@ -1,12 +0,0 @@ -# ParameterMapValue - -A map parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**values** | Dict[MapParameterKey, ParameterValue] | Yes | | -**type** | Literal["map"] | 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/models/ParameterMapping.md b/docs/v2/SqlQueries/models/ParameterMapping.md deleted file mode 100644 index 52c7b4a54..000000000 --- a/docs/v2/SqlQueries/models/ParameterMapping.md +++ /dev/null @@ -1,11 +0,0 @@ -# ParameterMapping - -A mapping of named parameters to their values. - -## Type -```python -Dict[ParameterName, ParameterValue] -``` - - -[[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/models/ParameterName.md b/docs/v2/SqlQueries/models/ParameterName.md deleted file mode 100644 index 441f723a4..000000000 --- a/docs/v2/SqlQueries/models/ParameterName.md +++ /dev/null @@ -1,11 +0,0 @@ -# ParameterName - -The name of a SQL query parameter. - -## 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/SqlQueries/models/ParameterNullValue.md b/docs/v2/SqlQueries/models/ParameterNullValue.md deleted file mode 100644 index 17e7d6997..000000000 --- a/docs/v2/SqlQueries/models/ParameterNullValue.md +++ /dev/null @@ -1,11 +0,0 @@ -# ParameterNullValue - -A null parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["null"] | 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/models/ParameterShortValue.md b/docs/v2/SqlQueries/models/ParameterShortValue.md deleted file mode 100644 index d55f9d85a..000000000 --- a/docs/v2/SqlQueries/models/ParameterShortValue.md +++ /dev/null @@ -1,12 +0,0 @@ -# ParameterShortValue - -A short integer parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | int | Yes | | -**type** | Literal["short"] | 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/models/ParameterStringValue.md b/docs/v2/SqlQueries/models/ParameterStringValue.md deleted file mode 100644 index 0344ab161..000000000 --- a/docs/v2/SqlQueries/models/ParameterStringValue.md +++ /dev/null @@ -1,12 +0,0 @@ -# ParameterStringValue - -A string parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | str | Yes | | -**type** | Literal["string"] | 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/models/ParameterStructValue.md b/docs/v2/SqlQueries/models/ParameterStructValue.md deleted file mode 100644 index d84d16269..000000000 --- a/docs/v2/SqlQueries/models/ParameterStructValue.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterStructValue - -A struct composed of ordered elements, each with a name and value. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**struct_elements** | List[StructElement] | Yes | | -**type** | Literal["struct"] | 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/models/ParameterTimestampValue.md b/docs/v2/SqlQueries/models/ParameterTimestampValue.md deleted file mode 100644 index 25f4929b3..000000000 --- a/docs/v2/SqlQueries/models/ParameterTimestampValue.md +++ /dev/null @@ -1,12 +0,0 @@ -# ParameterTimestampValue - -A timestamp parameter value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | datetime | Yes | | -**type** | Literal["timestamp"] | 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/models/ParameterValue.md b/docs/v2/SqlQueries/models/ParameterValue.md deleted file mode 100644 index 8c10f0d0a..000000000 --- a/docs/v2/SqlQueries/models/ParameterValue.md +++ /dev/null @@ -1,29 +0,0 @@ -# ParameterValue - -A typed parameter value for SQL query execution. - -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 -| ------------ | ------------- -ParameterDateValue | date -ParameterStructValue | struct -ParameterStringValue | string -ParameterDoubleValue | double -ParameterIntegerValue | integer -ParameterFloatValue | float -ParameterListValue | list -ParameterAnyValue | any -ParameterLongValue | long -ParameterBooleanValue | boolean -ParameterNullValue | null -ParameterShortValue | short -ParameterDecimalValue | decimal -ParameterMapValue | map -ParameterTimestampValue | timestamp - - -[[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/models/Parameters.md b/docs/v2/SqlQueries/models/Parameters.md deleted file mode 100644 index a8f2ed582..000000000 --- a/docs/v2/SqlQueries/models/Parameters.md +++ /dev/null @@ -1,18 +0,0 @@ -# Parameters - -Parameters for SQL query execution. Can be either unnamed positional parameters -or named parameter mappings. - - -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 -| ------------ | ------------- -UnnamedParameterValues | unnamedParameterValues -NamedParameterMapping | namedParameterMapping - - -[[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/models/SerializationFormat.md b/docs/v2/SqlQueries/models/SerializationFormat.md deleted file mode 100644 index 237ef704c..000000000 --- a/docs/v2/SqlQueries/models/SerializationFormat.md +++ /dev/null @@ -1,12 +0,0 @@ -# SerializationFormat - -Format for SQL query result serialization. - - -| **Value** | -| --------- | -| `"ARROW"` | -| `"CSV"` | - - -[[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/models/StructColumnFieldType.md b/docs/v2/SqlQueries/models/StructColumnFieldType.md deleted file mode 100644 index e439ee417..000000000 --- a/docs/v2/SqlQueries/models/StructColumnFieldType.md +++ /dev/null @@ -1,12 +0,0 @@ -# StructColumnFieldType - -StructColumnFieldType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | str | Yes | | -**type** | ColumnType | 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/SqlQueries/models/StructColumnType.md b/docs/v2/SqlQueries/models/StructColumnType.md deleted file mode 100644 index 6a1a563f3..000000000 --- a/docs/v2/SqlQueries/models/StructColumnType.md +++ /dev/null @@ -1,12 +0,0 @@ -# StructColumnType - -StructColumnType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[StructColumnFieldType] | Yes | | -**type** | Literal["struct"] | 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/models/StructElement.md b/docs/v2/SqlQueries/models/StructElement.md deleted file mode 100644 index ddfb36182..000000000 --- a/docs/v2/SqlQueries/models/StructElement.md +++ /dev/null @@ -1,12 +0,0 @@ -# StructElement - -Represents an entry in a struct. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**struct_element_name** | StructElementName | Yes | | -**struct_element_value** | ParameterValue | 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/SqlQueries/models/StructElementName.md b/docs/v2/SqlQueries/models/StructElementName.md deleted file mode 100644 index 20f835a64..000000000 --- a/docs/v2/SqlQueries/models/StructElementName.md +++ /dev/null @@ -1,16 +0,0 @@ -# StructElementName - -The name of a struct element. - -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 -| ------------ | ------------- -StructFieldRid | structFieldRid -StructFieldKeyValue | structFieldKey - - -[[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/models/StructFieldKeyValue.md b/docs/v2/SqlQueries/models/StructFieldKeyValue.md deleted file mode 100644 index 007a1eb7a..000000000 --- a/docs/v2/SqlQueries/models/StructFieldKeyValue.md +++ /dev/null @@ -1,12 +0,0 @@ -# StructFieldKeyValue - -A string key for a struct field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | str | Yes | | -**type** | Literal["structFieldKey"] | 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/models/StructFieldRid.md b/docs/v2/SqlQueries/models/StructFieldRid.md deleted file mode 100644 index bc42fe3db..000000000 --- a/docs/v2/SqlQueries/models/StructFieldRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# StructFieldRid - -A unique identifier for a field of a struct property type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | RID | Yes | | -**type** | Literal["structFieldRid"] | 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/models/UnnamedParameterValues.md b/docs/v2/SqlQueries/models/UnnamedParameterValues.md deleted file mode 100644 index 00c6e15ae..000000000 --- a/docs/v2/SqlQueries/models/UnnamedParameterValues.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnnamedParameterValues - -An ordered list of unnamed positional parameter values. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**values** | List[ParameterValue] | Yes | | -**type** | Literal["unnamedParameterValues"] | 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/Streams/Stream.md b/docs/v2/Streams/Stream.md index 82ab39362..c145f77d8 100644 --- a/docs/v2/Streams/Stream.md +++ b/docs/v2/Streams/Stream.md @@ -3,12 +3,12 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**create**](#create) | **POST** /v2/streams/datasets/{datasetRid}/streams | Public Beta | -[**get**](#get) | **GET** /v2/streams/datasets/{datasetRid}/streams/{streamBranchName} | Stable | +[**get**](#get) | **GET** /v2/streams/datasets/{datasetRid}/streams/{streamBranchName} | Public Beta | [**get_end_offsets**](#get_end_offsets) | **GET** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/getEndOffsets | Public Beta | [**get_records**](#get_records) | **GET** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/getRecords | Public Beta | -[**publish_binary_record**](#publish_binary_record) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishBinaryRecord | Stable | -[**publish_record**](#publish_record) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecord | Stable | -[**publish_records**](#publish_records) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecords | Stable | +[**publish_binary_record**](#publish_binary_record) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishBinaryRecord | Public Beta | +[**publish_record**](#publish_record) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecord | Public Beta | +[**publish_records**](#publish_records) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecords | Public Beta | [**reset**](#reset) | **POST** /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/reset | Public Beta | # **create** @@ -96,6 +96,7 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **dataset_rid** | DatasetRid | | | **stream_branch_name** | BranchName | | | +**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type **Stream** @@ -113,10 +114,14 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa dataset_rid = None # BranchName stream_branch_name = None +# Optional[PreviewMode] | Enables the use of preview functionality. +preview = None try: - api_response = client.streams.Dataset.Stream.get(dataset_rid, stream_branch_name) + api_response = client.streams.Dataset.Stream.get( + dataset_rid, stream_branch_name, preview=preview + ) print("The get response:\n") pprint(api_response) except foundry_sdk.PalantirRPCException as e: @@ -282,6 +287,7 @@ Name | Type | Description | Notes | **dataset_rid** | DatasetRid | | | **stream_branch_name** | BranchName | | | **body** | bytes | The binary record to publish to the stream | | +**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | **view_rid** | Optional[ViewRid] | If provided, this endpoint will only write to the stream corresponding to the specified view RID. If not provided, this endpoint will write to the latest stream on the branch. Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed. | [optional] | ### Return type @@ -302,13 +308,15 @@ dataset_rid = None stream_branch_name = None # bytes | The binary record to publish to the stream body = None +# Optional[PreviewMode] | Enables the use of preview functionality. +preview = None # Optional[ViewRid] | If provided, this endpoint will only write to the stream corresponding to the specified view RID. If not provided, this endpoint will write to the latest stream on the branch. Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed. view_rid = None try: api_response = client.streams.Dataset.Stream.publish_binary_record( - dataset_rid, stream_branch_name, body, view_rid=view_rid + dataset_rid, stream_branch_name, body, preview=preview, view_rid=view_rid ) print("The publish_binary_record response:\n") pprint(api_response) @@ -342,6 +350,7 @@ Name | Type | Description | Notes | **dataset_rid** | DatasetRid | | | **stream_branch_name** | BranchName | | | **record** | Record | The record to publish to the stream | | +**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | **view_rid** | Optional[ViewRid] | If provided, this endpoint will only write to the stream corresponding to the specified view RID. If not provided, this endpoint will write the latest stream on the branch. Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed. | [optional] | ### Return type @@ -362,13 +371,15 @@ dataset_rid = None stream_branch_name = None # Record | The record to publish to the stream record = {"timestamp": 1731426022784, "value": "Hello, World!"} +# Optional[PreviewMode] | Enables the use of preview functionality. +preview = None # Optional[ViewRid] | If provided, this endpoint will only write to the stream corresponding to the specified view RID. If not provided, this endpoint will write the latest stream on the branch. Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed. view_rid = "ri.foundry-streaming.main.view.ecd4f0f6-8526-4468-9eda-14939449ad79" try: api_response = client.streams.Dataset.Stream.publish_record( - dataset_rid, stream_branch_name, record=record, view_rid=view_rid + dataset_rid, stream_branch_name, record=record, preview=preview, view_rid=view_rid ) print("The publish_record response:\n") pprint(api_response) @@ -402,6 +413,7 @@ Name | Type | Description | Notes | **dataset_rid** | DatasetRid | | | **stream_branch_name** | BranchName | | | **records** | List[Record] | The records to publish to the stream | | +**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | **view_rid** | Optional[ViewRid] | If provided, this endpoint will only write to the stream corresponding to the specified view RID. If not provided, this endpoint will write to the latest stream on the branch. Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed. | [optional] | ### Return type @@ -422,13 +434,15 @@ dataset_rid = None stream_branch_name = None # List[Record] | The records to publish to the stream records = [{"timestamp": 1731426022784, "value": "Hello, World!"}] +# Optional[PreviewMode] | Enables the use of preview functionality. +preview = None # Optional[ViewRid] | If provided, this endpoint will only write to the stream corresponding to the specified view RID. If not provided, this endpoint will write to the latest stream on the branch. Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed. view_rid = "ri.foundry-streaming.main.view.ecd4f0f6-8526-4468-9eda-14939449ad79" try: api_response = client.streams.Dataset.Stream.publish_records( - dataset_rid, stream_branch_name, records=records, view_rid=view_rid + dataset_rid, stream_branch_name, records=records, preview=preview, view_rid=view_rid ) print("The publish_records response:\n") pprint(api_response) diff --git a/docs/v2/Streams/Subscriber.md b/docs/v2/Streams/Subscriber.md deleted file mode 100644 index 110ba6546..000000000 --- a/docs/v2/Streams/Subscriber.md +++ /dev/null @@ -1,441 +0,0 @@ -# Subscriber - -Method | HTTP request | Release Stage | -------------- | ------------- | ----- | -[**commit_offsets**](#commit_offsets) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId}/commitOffsets | Private Beta | -[**create**](#create) | **POST** /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers | Private Beta | -[**delete**](#delete) | **DELETE** /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId} | Private Beta | -[**get_read_position**](#get_read_position) | **GET** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId}/getReadPosition | Private Beta | -[**read_records**](#read_records) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId}/readRecords | Private Beta | -[**reset_offsets**](#reset_offsets) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId}/resetOffsets | Private Beta | - -# **commit_offsets** -Explicitly commit offsets for a subscriber. Required when `autoCommit` is false. - -Pass the last offset you processed for each partition. - -For example, if you processed a record at offset 50, commit `{"0": 50}` and the next -read from partition "0" will start at offset 51. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | | | -**stream_branch_name** | BranchName | | | -**subscriber_subscriber_id** | SubscriberId | | | -**offsets** | PartitionOffsets | The last processed offset for each partition. The server will store these as read positions (offset + 1), so the next read starts after the committed offset. | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | -**view_rid** | Optional[ViewRid] | The view RID to commit offsets for. If not provided, uses the latest view for the dataset/branch. | [optional] | - -### Return type -**PartitionOffsets** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# DatasetRid -dataset_rid = None -# BranchName -stream_branch_name = None -# SubscriberId -subscriber_subscriber_id = None -# PartitionOffsets | The last processed offset for each partition. The server will store these as read positions (offset + 1), so the next read starts after the committed offset. -offsets = {"0": 50, "1": 75} -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None -# Optional[ViewRid] | The view RID to commit offsets for. If not provided, uses the latest view for the dataset/branch. -view_rid = "ri.foundry-streaming.main.view.ecd4f0f6-8526-4468-9eda-14939449ad79" - - -try: - api_response = client.streams.Dataset.Stream.Subscriber.commit_offsets( - dataset_rid, - stream_branch_name, - subscriber_subscriber_id, - offsets=offsets, - preview=preview, - view_rid=view_rid, - ) - print("The commit_offsets response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Subscriber.commit_offsets: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | PartitionOffsets | | 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) - -# **create** -Register a new subscriber for a stream. Subscribers maintain server-side offset tracking, -allowing reliable consumption without client-side state management. - -If a subscriber with the same ID already exists for this stream, the existing registration -is returned. If a subscriber with the same ID exists for a different stream, an error is returned. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | | | -**stream_branch_name** | BranchName | | | -**subscriber_id** | SubscriberId | | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | -**read_position** | Optional[ReadPosition] | Where to start reading from. Defaults to `earliest` if not specified. The `readPosition` determines where the subscriber will start reading: - `earliest`: Start from the beginning of each partition (offset 0). Use this to process all historical data. - `latest`: Start from the current end of each partition. Use this to skip historical data and only process new records arriving after registration. - `specific`: Start from explicit offsets for each partition. Use this to resume from a known checkpoint. | [optional] | - -### Return type -**Subscriber** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# DatasetRid -dataset_rid = None -# BranchName -stream_branch_name = None -# SubscriberId -subscriber_id = "my-subscriber-001" -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None -# Optional[ReadPosition] | Where to start reading from. Defaults to `earliest` if not specified. The `readPosition` determines where the subscriber will start reading: - `earliest`: Start from the beginning of each partition (offset 0). Use this to process all historical data. - `latest`: Start from the current end of each partition. Use this to skip historical data and only process new records arriving after registration. - `specific`: Start from explicit offsets for each partition. Use this to resume from a known checkpoint. -read_position = None - - -try: - api_response = client.streams.Dataset.Stream.Subscriber.create( - dataset_rid, - stream_branch_name, - subscriber_id=subscriber_id, - preview=preview, - read_position=read_position, - ) - print("The create response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Subscriber.create: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Subscriber | The created Subscriber | 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) - -# **delete** -Delete a subscriber and all its committed offset state. After deletion, the subscriber ID -can be reused to create a new subscriber. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | | | -**stream_branch_name** | BranchName | | | -**subscriber_subscriber_id** | SubscriberId | | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**None** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# DatasetRid -dataset_rid = None -# BranchName -stream_branch_name = None -# SubscriberId -subscriber_subscriber_id = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.streams.Dataset.Stream.Subscriber.delete( - dataset_rid, stream_branch_name, subscriber_subscriber_id, preview=preview - ) - print("The delete response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Subscriber.delete: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**204** | None | | None | - -[[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) - -# **get_read_position** -Get the current read position for a subscriber. Returns the offset per partition where the next read -will begin. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | | | -**stream_branch_name** | BranchName | | | -**subscriber_subscriber_id** | SubscriberId | | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | -**view_rid** | Optional[ViewRid] | The view RID to get positions for. If not provided, uses the latest view for the dataset/branch. | [optional] | - -### Return type -**PartitionOffsets** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# DatasetRid -dataset_rid = None -# BranchName -stream_branch_name = None -# SubscriberId -subscriber_subscriber_id = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None -# Optional[ViewRid] | The view RID to get positions for. If not provided, uses the latest view for the dataset/branch. -view_rid = None - - -try: - api_response = client.streams.Dataset.Stream.Subscriber.get_read_position( - dataset_rid, - stream_branch_name, - subscriber_subscriber_id, - preview=preview, - view_rid=view_rid, - ) - print("The get_read_position response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Subscriber.get_read_position: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | PartitionOffsets | | 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_records** -Fetch records for a subscriber starting from their committed offset. Returns records -grouped by partition. - -If `autoCommit` is true, offsets are automatically committed after the records are -fetched, so the next read will start from where this one left off. - -If `autoCommit` is false, you must call `commitOffsets` to update the read position. -Use manual commits for at-least-once processing where you need to ensure records are -processed before acknowledging them. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | | | -**stream_branch_name** | BranchName | | | -**subscriber_subscriber_id** | SubscriberId | | | -**auto_commit** | Optional[bool] | If true, the read position is automatically committed after reading records. The committed position will be the offset after the last record read. If false, you must call the `commitOffsets` endpoint to commit offsets. Defaults to false. | [optional] | -**limit** | Optional[int] | Maximum number of records to return across all partitions. Defaults to 100, max 1000. If a value greater than 1000 is requested, only 1000 records will be returned. | [optional] | -**partition_ids** | Optional[List[PartitionId]] | If specified, only read from these partitions. Otherwise, read from all partitions. | [optional] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | -**view_rid** | Optional[ViewRid] | The view RID to read from. If not provided, reads from the latest view for the dataset/branch. | [optional] | - -### Return type -**ReadSubscriberRecordsResponse** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# DatasetRid -dataset_rid = None -# BranchName -stream_branch_name = None -# SubscriberId -subscriber_subscriber_id = None -# Optional[bool] | If true, the read position is automatically committed after reading records. The committed position will be the offset after the last record read. If false, you must call the `commitOffsets` endpoint to commit offsets. Defaults to false. -auto_commit = None -# Optional[int] | Maximum number of records to return across all partitions. Defaults to 100, max 1000. If a value greater than 1000 is requested, only 1000 records will be returned. -limit = None -# Optional[List[PartitionId]] | If specified, only read from these partitions. Otherwise, read from all partitions. -partition_ids = ["0"] -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None -# Optional[ViewRid] | The view RID to read from. If not provided, reads from the latest view for the dataset/branch. -view_rid = "ri.foundry-streaming.main.view.ecd4f0f6-8526-4468-9eda-14939449ad79" - - -try: - api_response = client.streams.Dataset.Stream.Subscriber.read_records( - dataset_rid, - stream_branch_name, - subscriber_subscriber_id, - auto_commit=auto_commit, - limit=limit, - partition_ids=partition_ids, - preview=preview, - view_rid=view_rid, - ) - print("The read_records response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Subscriber.read_records: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ReadSubscriberRecordsResponse | | 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) - -# **reset_offsets** -Reset subscriber offsets to a specific position. Use this to replay data from the -beginning, skip to the latest records, or jump to specific offsets. - -The `position` parameter determines where reading will resume: -- `earliest`: Reset to the beginning of each partition (offset 0) -- `latest`: Reset to the current end of each partition -- `specific`: Reset to explicit offsets for each partition - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | | | -**stream_branch_name** | BranchName | | | -**subscriber_subscriber_id** | SubscriberId | | | -**position** | ReadPosition | The position to reset offsets to. | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**PartitionOffsets** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# DatasetRid -dataset_rid = None -# BranchName -stream_branch_name = None -# SubscriberId -subscriber_subscriber_id = None -# ReadPosition | The position to reset offsets to. -position = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.streams.Dataset.Stream.Subscriber.reset_offsets( - dataset_rid, - stream_branch_name, - subscriber_subscriber_id, - position=position, - preview=preview, - ) - print("The reset_offsets response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Subscriber.reset_offsets: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | PartitionOffsets | | 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) - diff --git a/docs/v2/Streams/models/CommitSubscriberOffsetsRequest.md b/docs/v2/Streams/models/CommitSubscriberOffsetsRequest.md deleted file mode 100644 index 14d908da0..000000000 --- a/docs/v2/Streams/models/CommitSubscriberOffsetsRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# CommitSubscriberOffsetsRequest - -CommitSubscriberOffsetsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**view_rid** | Optional[ViewRid] | No | The view RID to commit offsets for. If not provided, uses the latest view for the dataset/branch. | -**offsets** | PartitionOffsets | Yes | The last processed offset for each partition. The server will store these as read positions (offset + 1), so the next read starts after the committed offset. | - - -[[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/Streams/models/CreateSubscriberRequest.md b/docs/v2/Streams/models/CreateSubscriberRequest.md deleted file mode 100644 index 908775177..000000000 --- a/docs/v2/Streams/models/CreateSubscriberRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateSubscriberRequest - -CreateSubscriberRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subscriber_id** | SubscriberId | Yes | | -**read_position** | Optional[ReadPosition] | No | Where to start reading from. Defaults to `earliest` if not specified. The `readPosition` determines where the subscriber will start reading: - `earliest`: Start from the beginning of each partition (offset 0). Use this to process all historical data. - `latest`: Start from the current end of each partition. Use this to skip historical data and only process new records arriving after registration. - `specific`: Start from explicit offsets for each partition. Use this to resume from a known checkpoint. | - - -[[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/Streams/models/EarliestPosition.md b/docs/v2/Streams/models/EarliestPosition.md deleted file mode 100644 index a5fed4b95..000000000 --- a/docs/v2/Streams/models/EarliestPosition.md +++ /dev/null @@ -1,13 +0,0 @@ -# EarliestPosition - -Start reading from the beginning of the stream. Sets offset to 0 for all partitions, -allowing the subscriber to read all historical data from the start. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["earliest"] | 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/Streams/models/LatestPosition.md b/docs/v2/Streams/models/LatestPosition.md deleted file mode 100644 index 7fccacb4b..000000000 --- a/docs/v2/Streams/models/LatestPosition.md +++ /dev/null @@ -1,14 +0,0 @@ -# LatestPosition - -Start reading from the current end of the stream. Sets offsets to the latest available -offset for each partition, meaning the subscriber will only receive records published -after this point. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["latest"] | 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/Streams/models/PartitionOffsets.md b/docs/v2/Streams/models/PartitionOffsets.md deleted file mode 100644 index 64cf31e74..000000000 --- a/docs/v2/Streams/models/PartitionOffsets.md +++ /dev/null @@ -1,12 +0,0 @@ -# PartitionOffsets - -A map of partition IDs to offsets. - - -## Type -```python -Dict[PartitionId, Long] -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Streams/models/PartitionRecords.md b/docs/v2/Streams/models/PartitionRecords.md deleted file mode 100644 index 00e0b7485..000000000 --- a/docs/v2/Streams/models/PartitionRecords.md +++ /dev/null @@ -1,12 +0,0 @@ -# PartitionRecords - -Records from a single partition with their offsets. - - -## Type -```python -List[RecordWithOffset] -``` - - -[[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/Streams/models/ReadPosition.md b/docs/v2/Streams/models/ReadPosition.md deleted file mode 100644 index 0069a614c..000000000 --- a/docs/v2/Streams/models/ReadPosition.md +++ /dev/null @@ -1,25 +0,0 @@ -# ReadPosition - -Position to start reading from when registering a subscriber or resetting offsets. - -- `earliest`: Start reading from the beginning of each partition (offset 0). Use this to - reprocess all historical data in the stream. -- `latest`: Start reading from the current end of each partition. Use this to skip - historical data and only process new records arriving after registration. -- `specific`: Start reading from explicit offsets for each partition. Use this for precise - replay scenarios or to resume from a known checkpoint. - - -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 -| ------------ | ------------- -SpecificPosition | specific -EarliestPosition | earliest -LatestPosition | latest - - -[[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/Streams/models/ReadRecordsFromSubscriberRequest.md b/docs/v2/Streams/models/ReadRecordsFromSubscriberRequest.md deleted file mode 100644 index 96e29f106..000000000 --- a/docs/v2/Streams/models/ReadRecordsFromSubscriberRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# ReadRecordsFromSubscriberRequest - -ReadRecordsFromSubscriberRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**view_rid** | Optional[ViewRid] | No | The view RID to read from. If not provided, reads from the latest view for the dataset/branch. | -**limit** | Optional[int] | No | Maximum number of records to return across all partitions. Defaults to 100, max 1000. If a value greater than 1000 is requested, only 1000 records will be returned. | -**partition_ids** | Optional[List[PartitionId]] | No | If specified, only read from these partitions. Otherwise, read from all partitions. | -**auto_commit** | Optional[bool] | No | If true, the read position is automatically committed after reading records. The committed position will be the offset after the last record read. If false, you must call the `commitOffsets` endpoint to commit offsets. Defaults to false. | - - -[[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/Streams/models/ReadSubscriberRecordsResponse.md b/docs/v2/Streams/models/ReadSubscriberRecordsResponse.md deleted file mode 100644 index b6fbed619..000000000 --- a/docs/v2/Streams/models/ReadSubscriberRecordsResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReadSubscriberRecordsResponse - -Response containing records grouped by partition ID. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**records_by_partition** | Dict[PartitionId, PartitionRecords] | Yes | Records grouped by partition ID. | - - -[[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/Streams/models/ResetSubscriberOffsetsRequest.md b/docs/v2/Streams/models/ResetSubscriberOffsetsRequest.md deleted file mode 100644 index 391fc99db..000000000 --- a/docs/v2/Streams/models/ResetSubscriberOffsetsRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# ResetSubscriberOffsetsRequest - -ResetSubscriberOffsetsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**position** | ReadPosition | Yes | The position to reset offsets to. | - - -[[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/Streams/models/SpecificPosition.md b/docs/v2/Streams/models/SpecificPosition.md deleted file mode 100644 index 8f05a19f1..000000000 --- a/docs/v2/Streams/models/SpecificPosition.md +++ /dev/null @@ -1,14 +0,0 @@ -# SpecificPosition - -Start reading from specific offsets for each partition. Useful for resuming from a known -checkpoint or replaying from a specific point in time. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**offsets** | PartitionOffsets | Yes | Specific offsets for each partition. Offsets must be valid (non-negative and not beyond the end of the partition). | -**type** | Literal["specific"] | 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/Streams/models/StreamType.md b/docs/v2/Streams/models/StreamType.md index 5f8afeccc..6c13b49db 100644 --- a/docs/v2/Streams/models/StreamType.md +++ b/docs/v2/Streams/models/StreamType.md @@ -7,7 +7,7 @@ introduce some non-zero latency at the expense of a higher throughput. This stre recommended if you inspect your stream metrics in-platform and observe that the average batch size is equal to the max match size, or if jobs using the stream are failing due to Kafka producer batches expiring. For additional information on inspecting stream metrics, refer to the -[stream monitoring](https://palantir.com/docs/foundry/data-integration/stream-monitoring/#viewing-metrics) documentation. +(stream monitoring)[/docs/foundry/data-integration/stream-monitoring/#viewing-metrics] documentation. For more information, refer to the [stream types](https://palantir.com/docs/foundry/data-integration/streams/#stream-types) documentation. diff --git a/docs/v2/Streams/models/Subscriber.md b/docs/v2/Streams/models/Subscriber.md deleted file mode 100644 index 789b93305..000000000 --- a/docs/v2/Streams/models/Subscriber.md +++ /dev/null @@ -1,17 +0,0 @@ -# Subscriber - -Subscriber - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subscriber_id** | SubscriberId | Yes | | -**read_position** | Optional[ReadPosition] | No | Where to start reading from. Defaults to `earliest` if not specified. The `readPosition` determines where the subscriber will start reading: - `earliest`: Start from the beginning of each partition (offset 0). Use this to process all historical data. - `latest`: Start from the current end of each partition. Use this to skip historical data and only process new records arriving after registration. - `specific`: Start from explicit offsets for each partition. Use this to resume from a known checkpoint. | -**dataset_rid** | DatasetRid | Yes | The RID of the dataset the subscriber is bound to. | -**branch_name** | BranchName | Yes | The branch of the stream the subscriber is bound to. | -**view_rid** | ViewRid | Yes | The current view RID being read from. This may change over time if the stream's schema is migrated to a new view. | -**start_offsets** | PartitionOffsets | Yes | The offsets where reading began for each partition, based on the initial read position. | -**created_time** | CreatedTime | Yes | Timestamp when the subscriber was registered. | - - -[[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/Streams/models/SubscriberId.md b/docs/v2/Streams/models/SubscriberId.md deleted file mode 100644 index c16270507..000000000 --- a/docs/v2/Streams/models/SubscriberId.md +++ /dev/null @@ -1,12 +0,0 @@ -# SubscriberId - -A unique identifier for a stream subscriber. Must be unique within the scope of a stream. - - -## 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/Widgets/DevModeSettings.md b/docs/v2/Widgets/DevModeSettings.md index 6d01d4993..7838b903a 100644 --- a/docs/v2/Widgets/DevModeSettings.md +++ b/docs/v2/Widgets/DevModeSettings.md @@ -2,9 +2,60 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | +[**disable**](#disable) | **POST** /v2/widgets/devModeSettings/disable | Private Beta | [**enable**](#enable) | **POST** /v2/widgets/devModeSettings/enable | Private Beta | +[**get**](#get) | **GET** /v2/widgets/devModeSettings | Private Beta | +[**pause**](#pause) | **POST** /v2/widgets/devModeSettings/pause | Private Beta | +[**set_widget_set**](#set_widget_set) | **POST** /v2/widgets/devModeSettings/setWidgetSet | Private Beta | [**set_widget_set_by_id**](#set_widget_set_by_id) | **POST** /v2/widgets/devModeSettings/setWidgetSetById | Private Beta | +# **disable** +Disable dev mode for the user associated with the provided token. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | + +### Return type +**DevModeSettings** + +### Example + +```python +from foundry_sdk import FoundryClient +import foundry_sdk +from pprint import pprint + +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") + +# Optional[PreviewMode] | Enables the use of preview functionality. +preview = None + + +try: + api_response = client.widgets.DevModeSettings.disable(preview=preview) + print("The disable response:\n") + pprint(api_response) +except foundry_sdk.PalantirRPCException as e: + print("HTTP error when calling DevModeSettings.disable: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | DevModeSettings | | 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) + # **enable** Enable dev mode for the user associated with the provided token. @@ -41,6 +92,162 @@ except foundry_sdk.PalantirRPCException as e: +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | DevModeSettings | | 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) + +# **get** +Get the dev mode settings for the user associated with the provided token. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | + +### Return type +**DevModeSettings** + +### Example + +```python +from foundry_sdk import FoundryClient +import foundry_sdk +from pprint import pprint + +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") + +# Optional[PreviewMode] | Enables the use of preview functionality. +preview = None + + +try: + api_response = client.widgets.DevModeSettings.get(preview=preview) + print("The get response:\n") + pprint(api_response) +except foundry_sdk.PalantirRPCException as e: + print("HTTP error when calling DevModeSettings.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | DevModeSettings | | 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) + +# **pause** +Pause dev mode for the user associated with the provided token. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | + +### Return type +**DevModeSettings** + +### Example + +```python +from foundry_sdk import FoundryClient +import foundry_sdk +from pprint import pprint + +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") + +# Optional[PreviewMode] | Enables the use of preview functionality. +preview = None + + +try: + api_response = client.widgets.DevModeSettings.pause(preview=preview) + print("The pause response:\n") + pprint(api_response) +except foundry_sdk.PalantirRPCException as e: + print("HTTP error when calling DevModeSettings.pause: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | DevModeSettings | | 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) + +# **set_widget_set** +Set the dev mode settings for the given widget set for the user associated with the provided token. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**settings** | WidgetSetDevModeSettings | | | +**widget_set_rid** | WidgetSetRid | | | +**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | + +### Return type +**DevModeSettings** + +### Example + +```python +from foundry_sdk import FoundryClient +import foundry_sdk +from pprint import pprint + +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") + +# WidgetSetDevModeSettings +settings = { + "widgetSettings": { + "ri.widgetregistry..widget.21dt2c42-b7df-4b23-880b-1436a3dred2e": { + "stylesheetEntrypoints": [{"filePath": "dist/app.js"}], + "scriptEntrypoints": [{"filePath": "dist/app.js", "scriptType": "DEFAULT"}], + } + } +} +# WidgetSetRid +widget_set_rid = "ri.widgetregistry..widget-set.21dt2c42-b7df-4b23-880b-1436a3dred2e" +# Optional[PreviewMode] | Enables the use of preview functionality. +preview = None + + +try: + api_response = client.widgets.DevModeSettings.set_widget_set( + settings=settings, widget_set_rid=widget_set_rid, preview=preview + ) + print("The set_widget_set response:\n") + pprint(api_response) +except foundry_sdk.PalantirRPCException as e: + print("HTTP error when calling DevModeSettings.set_widget_set: %s\n" % e) + +``` + + + ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Widgets/DevModeSettingsV2.md b/docs/v2/Widgets/DevModeSettingsV2.md deleted file mode 100644 index ab6fa7090..000000000 --- a/docs/v2/Widgets/DevModeSettingsV2.md +++ /dev/null @@ -1,124 +0,0 @@ -# DevModeSettingsV2 - -Method | HTTP request | Release Stage | -------------- | ------------- | ----- | -[**enable**](#enable) | **POST** /v2/widgets/devModeSettingsV2/enable | Private Beta | -[**set_widget_set_manifest**](#set_widget_set_manifest) | **POST** /v2/widgets/devModeSettingsV2/setWidgetSetManifest | Private Beta | - -# **enable** -Enable dev mode for the user associated with the provided token. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**DevModeSettingsV2** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.widgets.DevModeSettingsV2.enable(preview=preview) - print("The enable response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling DevModeSettingsV2.enable: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | DevModeSettingsV2 | | 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) - -# **set_widget_set_manifest** -Set the dev mode settings for the given widget set using the manifest format. -The request body is a dev settings manifest JSON object with the following -structure: - - { - "manifestVersion": "1.0.0", - "devSettings": { - "baseHref": "...", - "widgets": { ... }, - "inputSpec": { ... } - } - } - -See https://github.com/palantir/osdk-ts for the widget library API types for the -dev settings manifest. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**manifest** | Any | | | -**widget_set_rid** | WidgetSetRid | | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**DevModeSettingsV2** - -### Example - -```python -from foundry_sdk import FoundryClient -import foundry_sdk -from pprint import pprint - -client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# Any -manifest = None -# WidgetSetRid -widget_set_rid = "ri.widgetregistry..widget-set.21dt2c42-b7df-4b23-880b-1436a3dred2e" -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = client.widgets.DevModeSettingsV2.set_widget_set_manifest( - manifest=manifest, widget_set_rid=widget_set_rid, preview=preview - ) - print("The set_widget_set_manifest response:\n") - pprint(api_response) -except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling DevModeSettingsV2.set_widget_set_manifest: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | DevModeSettingsV2 | | 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) - diff --git a/docs/v2/Widgets/models/DevModeSettingsV2.md b/docs/v2/Widgets/models/DevModeSettingsV2.md deleted file mode 100644 index 2dcab6eae..000000000 --- a/docs/v2/Widgets/models/DevModeSettingsV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# DevModeSettingsV2 - -DevModeSettingsV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**status** | DevModeStatus | Yes | | -**snapshot** | Optional[DevModeSnapshot] | No | The content-addressed snapshot of the current dev mode settings, if any. | - - -[[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/Widgets/models/DevModeSnapshot.md b/docs/v2/Widgets/models/DevModeSnapshot.md deleted file mode 100644 index dfe3c989c..000000000 --- a/docs/v2/Widgets/models/DevModeSnapshot.md +++ /dev/null @@ -1,14 +0,0 @@ -# DevModeSnapshot - -A content-addressed snapshot of the dev mode settings. Snapshots are immutable -and identified by their content-addressed ID. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**snapshot_id** | DevModeSnapshotId | Yes | The content-addressed identifier for this snapshot. | -**widget_set_settings** | Dict[WidgetSetRid, WidgetSetDevModeSettingsV2] | Yes | The dev mode settings for each widget set, keyed by widget set RID. | - - -[[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/Widgets/models/DevModeSnapshotId.md b/docs/v2/Widgets/models/DevModeSnapshotId.md deleted file mode 100644 index d7017149f..000000000 --- a/docs/v2/Widgets/models/DevModeSnapshotId.md +++ /dev/null @@ -1,11 +0,0 @@ -# DevModeSnapshotId - -A content-addressed identifier for a dev mode settings snapshot. - -## 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/Widgets/models/OntologySdkInputSpec.md b/docs/v2/Widgets/models/OntologySdkInputSpec.md deleted file mode 100644 index ad0395c0b..000000000 --- a/docs/v2/Widgets/models/OntologySdkInputSpec.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologySdkInputSpec - -A specification of an Ontology SDK used by a widget set. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**sdk_package_rid** | OntologySdkPackageRid | Yes | The RID of the Ontology SDK package. | -**sdk_version** | OntologySdkVersion | Yes | The version of the Ontology SDK. | - - -[[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/Widgets/models/OntologySdkPackageRid.md b/docs/v2/Widgets/models/OntologySdkPackageRid.md deleted file mode 100644 index f6e028f9d..000000000 --- a/docs/v2/Widgets/models/OntologySdkPackageRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# OntologySdkPackageRid - -A Resource Identifier (RID) identifying an Ontology SDK package. - -## Type -```python -RID -``` - - -[[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/Widgets/models/OntologySdkVersion.md b/docs/v2/Widgets/models/OntologySdkVersion.md deleted file mode 100644 index ab9f336c8..000000000 --- a/docs/v2/Widgets/models/OntologySdkVersion.md +++ /dev/null @@ -1,11 +0,0 @@ -# OntologySdkVersion - -A limited semver version string of the format major.minor.patch. - -## 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/Widgets/models/SetWidgetSetManifestDevModeSettingsV2Request.md b/docs/v2/Widgets/models/SetWidgetSetDevModeSettingsRequest.md similarity index 72% rename from docs/v2/Widgets/models/SetWidgetSetManifestDevModeSettingsV2Request.md rename to docs/v2/Widgets/models/SetWidgetSetDevModeSettingsRequest.md index b3e796702..75639c980 100644 --- a/docs/v2/Widgets/models/SetWidgetSetManifestDevModeSettingsV2Request.md +++ b/docs/v2/Widgets/models/SetWidgetSetDevModeSettingsRequest.md @@ -1,12 +1,12 @@ -# SetWidgetSetManifestDevModeSettingsV2Request +# SetWidgetSetDevModeSettingsRequest -SetWidgetSetManifestDevModeSettingsV2Request +SetWidgetSetDevModeSettingsRequest ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **widget_set_rid** | WidgetSetRid | Yes | | -**manifest** | Any | Yes | | +**settings** | WidgetSetDevModeSettings | 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/Widgets/models/WidgetDevModeSettingsV2.md b/docs/v2/Widgets/models/WidgetDevModeSettingsV2.md deleted file mode 100644 index 5e7fad14e..000000000 --- a/docs/v2/Widgets/models/WidgetDevModeSettingsV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# WidgetDevModeSettingsV2 - -The settings for a given widget in development mode (v2). - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | Optional[str] | No | The display name of the widget. | -**description** | Optional[str] | No | A description of the widget. | -**script_entrypoints** | List[ScriptEntrypoint] | Yes | The entrypoint JavaScript files for the widget. | -**stylesheet_entrypoints** | List[StylesheetEntrypoint] | Yes | The entrypoint CSS files for the widget. | - - -[[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/Widgets/models/WidgetSetDevModeSettingsV2.md b/docs/v2/Widgets/models/WidgetSetDevModeSettingsV2.md deleted file mode 100644 index ed65b92f1..000000000 --- a/docs/v2/Widgets/models/WidgetSetDevModeSettingsV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# WidgetSetDevModeSettingsV2 - -The settings for a widget set in development mode (v2), keyed by widget ID. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**base_href** | str | Yes | The base path for the HTML file used to render the widget in dev mode. | -**input_spec** | Optional[WidgetSetInputSpec] | No | The input spec for the widget set in dev mode. | -**widget_settings** | Dict[WidgetId, WidgetDevModeSettingsV2] | Yes | The dev mode settings for each widget in the widget set, keyed by widget IDs. | - - -[[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/Widgets/models/WidgetSetInputSpec.md b/docs/v2/Widgets/models/WidgetSetInputSpec.md deleted file mode 100644 index 16e044680..000000000 --- a/docs/v2/Widgets/models/WidgetSetInputSpec.md +++ /dev/null @@ -1,13 +0,0 @@ -# WidgetSetInputSpec - -A specification of the Foundry data inputs that a widget set uses. This restricts -the data access that a widget set has at runtime. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**sdks** | List[OntologySdkInputSpec] | Yes | The Ontology SDK specifications used by the widget set. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/foundry_sdk/_core/hostname_supplier.py b/foundry_sdk/_core/hostname_supplier.py index 6f8dbb366..00591ee4c 100644 --- a/foundry_sdk/_core/hostname_supplier.py +++ b/foundry_sdk/_core/hostname_supplier.py @@ -51,7 +51,7 @@ def __init__(self, base_url: str, is_user_supplied: bool) -> None: self._base_url = base_url self._api_gateway_url = base_url + "/api" self._multipass_url = base_url + "/multipass/api" - self._stream_proxy_url = base_url + "/stream-proxy/api" + self._stream_proxy_url = base_url + "/api" self._is_user_supplied = is_user_supplied def get_hostname(self) -> str: diff --git a/foundry_sdk/_version.py b/foundry_sdk/_version.py index d0c6198a9..fcf10e8ce 100644 --- a/foundry_sdk/_version.py +++ b/foundry_sdk/_version.py @@ -17,4 +17,4 @@ # using the autorelease bot __version__ = "0.0.0" -__openapi_document_version__ = "1.1598.2" +__openapi_document_version__ = "1.1473.2" diff --git a/foundry_sdk/v1/core/models.py b/foundry_sdk/v1/core/models.py index 620fe1ccc..640774db6 100644 --- a/foundry_sdk/v1/core/models.py +++ b/foundry_sdk/v1/core/models.py @@ -158,12 +158,6 @@ class MarkingType(core.ModelBase): type: typing.Literal["marking"] = "marking" -class MediaReferenceType(core.ModelBase): - """MediaReferenceType""" - - type: typing.Literal["mediaReference"] = "mediaReference" - - MediaType = str """ The [media type](https://www.iana.org/assignments/media-types/media-types.xhtml) of the file or attachment. @@ -255,12 +249,6 @@ class UnsupportedType(core.ModelBase): """UnsupportedTypeParamValue""" -class VoidType(core.ModelBase): - """VoidType""" - - type: typing.Literal["void"] = "void" - - __all__ = [ "AnyType", "AttachmentType", @@ -284,7 +272,6 @@ class VoidType(core.ModelBase): "IntegerType", "LongType", "MarkingType", - "MediaReferenceType", "MediaType", "NullType", "OperationScope", @@ -303,5 +290,4 @@ class VoidType(core.ModelBase): "UnsupportedType", "UnsupportedTypeParamKey", "UnsupportedTypeParamValue", - "VoidType", ] diff --git a/foundry_sdk/v1/ontologies/errors.py b/foundry_sdk/v1/ontologies/errors.py index c4e0b0dae..48d4598b2 100644 --- a/foundry_sdk/v1/ontologies/errors.py +++ b/foundry_sdk/v1/ontologies/errors.py @@ -52,19 +52,6 @@ class ActionEditedPropertiesNotFound(errors.BadRequestError): error_instance_id: str -class ActionEditsNotSupportedWithMarketplaceParameters(typing_extensions.TypedDict): - """Returning action edits is not supported when using marketplace bindings.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class ActionEditsNotSupportedWithMarketplace(errors.BadRequestError): - name: typing.Literal["ActionEditsNotSupportedWithMarketplace"] - parameters: ActionEditsNotSupportedWithMarketplaceParameters - error_instance_id: str - - class ActionEditsReadOnlyEntityParameters(typing_extensions.TypedDict): """The given action request performs edits on a type that is read-only or does not allow edits.""" @@ -339,19 +326,6 @@ class AttachmentSizeExceededLimit(errors.BadRequestError): error_instance_id: str -class BranchNotSupportedWithMarketplaceQueryParameters(typing_extensions.TypedDict): - """The branch parameter is not supported when executing queries with marketplace bindings.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class BranchNotSupportedWithMarketplaceQuery(errors.BadRequestError): - name: typing.Literal["BranchNotSupportedWithMarketplaceQuery"] - parameters: BranchNotSupportedWithMarketplaceQueryParameters - error_instance_id: str - - class CipherChannelNotFoundParameters(typing_extensions.TypedDict): """ The Cipher Channel was not found. @@ -433,21 +407,6 @@ class DerivedPropertyApiNamesNotUnique(errors.BadRequestError): error_instance_id: str -class DistinctEnumValuesExceededLimitParameters(typing_extensions.TypedDict): - """An enum time series contained too many distinct enum values. Check that the time series sync is using the correct value column.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - maxDistinctValues: typing_extensions.NotRequired[int] - - -@dataclass -class DistinctEnumValuesExceededLimit(errors.BadRequestError): - name: typing.Literal["DistinctEnumValuesExceededLimit"] - parameters: DistinctEnumValuesExceededLimitParameters - error_instance_id: str - - class DuplicateOrderByParameters(typing_extensions.TypedDict): """The requested sort order includes duplicate properties.""" @@ -543,23 +502,6 @@ class FunctionInvalidInput(errors.BadRequestError): error_instance_id: str -class FunctionNotSupportedWithTransactionParameters(typing_extensions.TypedDict): - """The function runtime does not support execution with a transaction.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - functionRid: ontologies_models.FunctionRid - functionVersion: ontologies_models.FunctionVersion - message: str - - -@dataclass -class FunctionNotSupportedWithTransaction(errors.BadRequestError): - name: typing.Literal["FunctionNotSupportedWithTransaction"] - parameters: FunctionNotSupportedWithTransactionParameters - error_instance_id: str - - class HighScaleComputationNotEnabledParameters(typing_extensions.TypedDict): """High-scale compute was required for this Ontology query but is not enabled on this enrollment.""" @@ -868,25 +810,6 @@ class InvalidDerivedPropertyDefinition(errors.BadRequestError): error_instance_id: str -class InvalidDerivedPropertyDefinitionOnInterfaceParameters(typing_extensions.TypedDict): - """ - Derived property definition on an interface-typed object set was invalid due to shape of query or type - checking. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - interfaceType: ontologies_models.InterfaceTypeApiName - derivedProperty: ontologies_models.DerivedPropertyApiName - - -@dataclass -class InvalidDerivedPropertyDefinitionOnInterface(errors.BadRequestError): - name: typing.Literal["InvalidDerivedPropertyDefinitionOnInterface"] - parameters: InvalidDerivedPropertyDefinitionOnInterfaceParameters - error_instance_id: str - - class InvalidDurationGroupByPropertyTypeParameters(typing_extensions.TypedDict): """Invalid property type for duration groupBy.""" @@ -1729,25 +1652,6 @@ class OntologyApiNameNotUnique(errors.BadRequestError): error_instance_id: str -class OntologyDefinitionOutOfSyncParameters(typing_extensions.TypedDict): - """ - The ontology definition is temporarily out of sync. The indexed definition does not yet - reflect the latest saved definition for this type. This is typically a transient condition that - resolves as indexing completes. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectTypeRid: ontologies_models.ObjectTypeRid - - -@dataclass -class OntologyDefinitionOutOfSync(errors.ConflictError): - name: typing.Literal["OntologyDefinitionOutOfSync"] - parameters: OntologyDefinitionOutOfSyncParameters - error_instance_id: str - - class OntologyEditsExceededLimitParameters(typing_extensions.TypedDict): """ The number of edits to the Ontology exceeded the allowed limit. @@ -2474,7 +2378,6 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): __all__ = [ "ActionContainsDuplicateEdits", "ActionEditedPropertiesNotFound", - "ActionEditsNotSupportedWithMarketplace", "ActionEditsReadOnlyEntity", "ActionNotFound", "ActionParameterInterfaceTypeNotFound", @@ -2491,20 +2394,17 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): "AttachmentNotFound", "AttachmentRidAlreadyExists", "AttachmentSizeExceededLimit", - "BranchNotSupportedWithMarketplaceQuery", "CipherChannelNotFound", "CompositePrimaryKeyNotSupported", "ConsistentSnapshotError", "DefaultAndNullGroupsNotSupported", "DerivedPropertyApiNamesNotUnique", - "DistinctEnumValuesExceededLimit", "DuplicateOrderBy", "EditObjectPermissionDenied", "FunctionEncounteredUserFacingError", "FunctionExecutionFailed", "FunctionExecutionTimedOut", "FunctionInvalidInput", - "FunctionNotSupportedWithTransaction", "HighScaleComputationNotEnabled", "IncompatibleNestedObjectSet", "InterfaceBasedObjectSetNotSupported", @@ -2525,7 +2425,6 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): "InvalidContentLength", "InvalidContentType", "InvalidDerivedPropertyDefinition", - "InvalidDerivedPropertyDefinitionOnInterface", "InvalidDurationGroupByPropertyType", "InvalidDurationGroupByPropertyTypeForInterface", "InvalidDurationGroupByValue", @@ -2575,7 +2474,6 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): "ObjectsExceededLimit", "ObjectsModifiedConcurrently", "OntologyApiNameNotUnique", - "OntologyDefinitionOutOfSync", "OntologyEditsExceededLimit", "OntologyNotFound", "OntologySyncing", diff --git a/foundry_sdk/v1/ontologies/models.py b/foundry_sdk/v1/ontologies/models.py index f300b98aa..065353ab4 100644 --- a/foundry_sdk/v1/ontologies/models.py +++ b/foundry_sdk/v1/ontologies/models.py @@ -403,11 +403,7 @@ class EntrySetType(core.ModelBase): class EqualsQuery(core.ModelBase): - """ - Returns objects where the specified field is equal to a value. - - For string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager. - """ + """Returns objects where the specified field is equal to a value.""" field: FieldNameV1 value: PropertyValue @@ -776,7 +772,6 @@ class OntologyArrayType(core.ModelBase): core_models.CipherTextType, core_models.MarkingType, core_models.UnsupportedType, - core_models.MediaReferenceType, "OntologyArrayType", "OntologyObjectSetType", core_models.BinaryType, @@ -1129,28 +1124,25 @@ class QueryArrayType(core.ModelBase): core_models.DateType, "OntologyInterfaceObjectType", "QueryStructType", + "QuerySetType", core_models.StringType, + "EntrySetType", + core_models.DoubleType, core_models.IntegerType, "ThreeDimensionalAggregation", + "QueryUnionType", core_models.FloatType, core_models.LongType, + core_models.BooleanType, core_models.UnsupportedType, core_models.AttachmentType, + core_models.NullType, "QueryArrayType", "OntologyObjectSetType", "TwoDimensionalAggregation", - "QueryTypeReferenceType", - core_models.TimestampType, - "QuerySetType", - core_models.VoidType, - "EntrySetType", - core_models.DoubleType, - "QueryUnionType", - core_models.BooleanType, - core_models.MediaReferenceType, - core_models.NullType, "OntologyInterfaceObjectSetType", "OntologyObjectType", + core_models.TimestampType, ], pydantic.Field(discriminator="type"), ] @@ -1194,16 +1186,6 @@ class QueryType(core.ModelBase): version: FunctionVersion -class QueryTypeReferenceType(core.ModelBase): - """ - A reference to a type that is defined in the `typeReferences` map of the enclosing Query. - This enables support for recursive type definitions where a type may reference itself. - """ - - type_id: TypeReferenceIdentifier = pydantic.Field(alias=str("typeId")) # type: ignore[literal-required] - type: typing.Literal["typeReference"] = "typeReference" - - class QueryUnionType(core.ModelBase): """QueryUnionType""" @@ -1462,13 +1444,6 @@ class TwoDimensionalAggregation(core.ModelBase): type: typing.Literal["twoDimensionalAggregation"] = "twoDimensionalAggregation" -TypeReferenceIdentifier = str -""" -The unique identifier of a type reference. This identifier is used to look up the -type definition in the `typeReferences` map of the enclosing Query. -""" - - class UnevaluableConstraint(core.ModelBase): """ The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. @@ -1692,7 +1667,6 @@ class ValidateActionResponse(core.ModelBase): "QueryStructField", "QueryStructType", "QueryType", - "QueryTypeReferenceType", "QueryUnionType", "RangeConstraint", "ReturnEditsMode", @@ -1718,7 +1692,6 @@ class ValidateActionResponse(core.ModelBase): "SumAggregation", "ThreeDimensionalAggregation", "TwoDimensionalAggregation", - "TypeReferenceIdentifier", "UnevaluableConstraint", "UniqueIdentifierLinkId", "ValidateActionRequest", diff --git a/foundry_sdk/v2/admin/_client.py b/foundry_sdk/v2/admin/_client.py index 87dbd6b23..f4aec52bf 100644 --- a/foundry_sdk/v2/admin/_client.py +++ b/foundry_sdk/v2/admin/_client.py @@ -43,28 +43,6 @@ def __init__( self._config = config - @cached_property - def CbacBanner(self): - from foundry_sdk.v2.admin.cbac_banner import CbacBannerClient - - return CbacBannerClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - - @cached_property - def CbacMarkingRestrictions(self): - from foundry_sdk.v2.admin.cbac_marking_restrictions import ( - CbacMarkingRestrictionsClient, - ) # NOQA - - return CbacMarkingRestrictionsClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - @cached_property def Enrollment(self): from foundry_sdk.v2.admin.enrollment import EnrollmentClient @@ -163,10 +141,6 @@ def __init__( hostname: typing.Union[str, core.HostnameSupplier], config: typing.Optional[core.Config] = None, ): - from foundry_sdk.v2.admin.cbac_banner import AsyncCbacBannerClient - from foundry_sdk.v2.admin.cbac_marking_restrictions import ( - AsyncCbacMarkingRestrictionsClient, - ) # NOQA from foundry_sdk.v2.admin.enrollment import AsyncEnrollmentClient from foundry_sdk.v2.admin.group import AsyncGroupClient from foundry_sdk.v2.admin.marking import AsyncMarkingClient @@ -178,12 +152,6 @@ def __init__( from foundry_sdk.v2.admin.role import AsyncRoleClient from foundry_sdk.v2.admin.user import AsyncUserClient - self.CbacBanner = AsyncCbacBannerClient(auth=auth, hostname=hostname, config=config) - - self.CbacMarkingRestrictions = AsyncCbacMarkingRestrictionsClient( - auth=auth, hostname=hostname, config=config - ) - self.Enrollment = AsyncEnrollmentClient(auth=auth, hostname=hostname, config=config) self.Group = AsyncGroupClient(auth=auth, hostname=hostname, config=config) diff --git a/foundry_sdk/v2/admin/cbac_banner.py b/foundry_sdk/v2/admin/cbac_banner.py deleted file mode 100644 index dbe8b280e..000000000 --- a/foundry_sdk/v2/admin/cbac_banner.py +++ /dev/null @@ -1,227 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.admin import errors as admin_errors -from foundry_sdk.v2.admin import models as admin_models -from foundry_sdk.v2.core import models as core_models - - -class CbacBannerClient: - """ - The API client for the CbacBanner Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _CbacBannerClientStreaming(self) - self.with_raw_response = _CbacBannerClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - *, - display_type: typing.Optional[admin_models.ClassificationBannerDisplayType] = None, - marking_ids: typing.Optional[typing.List[core_models.MarkingId]] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.CbacBanner: - """ - Returns a classification banner string and colors for the given set of marking IDs. - :param display_type: The display type of the banner. Defaults to PORTION_MARKING. BANNER_LINE is the long classification string used in the header of a document; PORTION_MARKING is a short classification string used for individual paragraphs - :type display_type: Optional[ClassificationBannerDisplayType] - :param marking_ids: The marking IDs for which to generate a banner. - :type marking_ids: Optional[List[MarkingId]] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: admin_models.CbacBanner - - :raises CbacBannerNotFound: The given CbacBanner could not be found. - :raises CbacUnavailable: CBAC is not available. - :raises GetCbacBannerPermissionDenied: The provided token does not have permission to get the CBAC banner for the markings. - :raises UnknownClassificationBannerDisplayType: The provided classification banner display type is not recognized. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/cbacBanner", - query_params={ - "displayType": display_type, - "markingIds": marking_ids, - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=admin_models.CbacBanner, - request_timeout=request_timeout, - throwable_errors={ - "CbacBannerNotFound": admin_errors.CbacBannerNotFound, - "CbacUnavailable": admin_errors.CbacUnavailable, - "GetCbacBannerPermissionDenied": admin_errors.GetCbacBannerPermissionDenied, - "UnknownClassificationBannerDisplayType": admin_errors.UnknownClassificationBannerDisplayType, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _CbacBannerClientRaw: - def __init__(self, client: CbacBannerClient) -> None: - def get(_: admin_models.CbacBanner): ... - - self.get = core.with_raw_response(get, client.get) - - -class _CbacBannerClientStreaming: - def __init__(self, client: CbacBannerClient) -> None: - def get(_: admin_models.CbacBanner): ... - - self.get = core.with_streaming_response(get, client.get) - - -class AsyncCbacBannerClient: - """ - The API client for the CbacBanner Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncCbacBannerClientStreaming(self) - self.with_raw_response = _AsyncCbacBannerClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - *, - display_type: typing.Optional[admin_models.ClassificationBannerDisplayType] = None, - marking_ids: typing.Optional[typing.List[core_models.MarkingId]] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[admin_models.CbacBanner]: - """ - Returns a classification banner string and colors for the given set of marking IDs. - :param display_type: The display type of the banner. Defaults to PORTION_MARKING. BANNER_LINE is the long classification string used in the header of a document; PORTION_MARKING is a short classification string used for individual paragraphs - :type display_type: Optional[ClassificationBannerDisplayType] - :param marking_ids: The marking IDs for which to generate a banner. - :type marking_ids: Optional[List[MarkingId]] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[admin_models.CbacBanner] - - :raises CbacBannerNotFound: The given CbacBanner could not be found. - :raises CbacUnavailable: CBAC is not available. - :raises GetCbacBannerPermissionDenied: The provided token does not have permission to get the CBAC banner for the markings. - :raises UnknownClassificationBannerDisplayType: The provided classification banner display type is not recognized. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/cbacBanner", - query_params={ - "displayType": display_type, - "markingIds": marking_ids, - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=admin_models.CbacBanner, - request_timeout=request_timeout, - throwable_errors={ - "CbacBannerNotFound": admin_errors.CbacBannerNotFound, - "CbacUnavailable": admin_errors.CbacUnavailable, - "GetCbacBannerPermissionDenied": admin_errors.GetCbacBannerPermissionDenied, - "UnknownClassificationBannerDisplayType": admin_errors.UnknownClassificationBannerDisplayType, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _AsyncCbacBannerClientRaw: - def __init__(self, client: AsyncCbacBannerClient) -> None: - def get(_: admin_models.CbacBanner): ... - - self.get = core.async_with_raw_response(get, client.get) - - -class _AsyncCbacBannerClientStreaming: - def __init__(self, client: AsyncCbacBannerClient) -> None: - def get(_: admin_models.CbacBanner): ... - - self.get = core.async_with_streaming_response(get, client.get) diff --git a/foundry_sdk/v2/admin/cbac_marking_restrictions.py b/foundry_sdk/v2/admin/cbac_marking_restrictions.py deleted file mode 100644 index da255b545..000000000 --- a/foundry_sdk/v2/admin/cbac_marking_restrictions.py +++ /dev/null @@ -1,215 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.admin import errors as admin_errors -from foundry_sdk.v2.admin import models as admin_models -from foundry_sdk.v2.core import models as core_models - - -class CbacMarkingRestrictionsClient: - """ - The API client for the CbacMarkingRestrictions Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _CbacMarkingRestrictionsClientStreaming(self) - self.with_raw_response = _CbacMarkingRestrictionsClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - *, - marking_ids: typing.Optional[typing.List[core_models.MarkingId]] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.CbacMarkingRestrictions: - """ - Returns disallowed, implied, and required markings for the given set of marking IDs. - :param marking_ids: The marking IDs for which to get restrictions. - :type marking_ids: Optional[List[MarkingId]] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: admin_models.CbacMarkingRestrictions - - :raises CbacMarkingRestrictionsNotFound: The given CbacMarkingRestrictions could not be found. - :raises CbacUnavailable: CBAC is not available. - :raises GetCbacMarkingRestrictionInfoPermissionDenied: The provided token does not have permission to get the CBAC marking restrictions for the markings. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/cbacMarkingRestrictions", - query_params={ - "markingIds": marking_ids, - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=admin_models.CbacMarkingRestrictions, - request_timeout=request_timeout, - throwable_errors={ - "CbacMarkingRestrictionsNotFound": admin_errors.CbacMarkingRestrictionsNotFound, - "CbacUnavailable": admin_errors.CbacUnavailable, - "GetCbacMarkingRestrictionInfoPermissionDenied": admin_errors.GetCbacMarkingRestrictionInfoPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _CbacMarkingRestrictionsClientRaw: - def __init__(self, client: CbacMarkingRestrictionsClient) -> None: - def get(_: admin_models.CbacMarkingRestrictions): ... - - self.get = core.with_raw_response(get, client.get) - - -class _CbacMarkingRestrictionsClientStreaming: - def __init__(self, client: CbacMarkingRestrictionsClient) -> None: - def get(_: admin_models.CbacMarkingRestrictions): ... - - self.get = core.with_streaming_response(get, client.get) - - -class AsyncCbacMarkingRestrictionsClient: - """ - The API client for the CbacMarkingRestrictions Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncCbacMarkingRestrictionsClientStreaming(self) - self.with_raw_response = _AsyncCbacMarkingRestrictionsClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - *, - marking_ids: typing.Optional[typing.List[core_models.MarkingId]] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[admin_models.CbacMarkingRestrictions]: - """ - Returns disallowed, implied, and required markings for the given set of marking IDs. - :param marking_ids: The marking IDs for which to get restrictions. - :type marking_ids: Optional[List[MarkingId]] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[admin_models.CbacMarkingRestrictions] - - :raises CbacMarkingRestrictionsNotFound: The given CbacMarkingRestrictions could not be found. - :raises CbacUnavailable: CBAC is not available. - :raises GetCbacMarkingRestrictionInfoPermissionDenied: The provided token does not have permission to get the CBAC marking restrictions for the markings. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/cbacMarkingRestrictions", - query_params={ - "markingIds": marking_ids, - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=admin_models.CbacMarkingRestrictions, - request_timeout=request_timeout, - throwable_errors={ - "CbacMarkingRestrictionsNotFound": admin_errors.CbacMarkingRestrictionsNotFound, - "CbacUnavailable": admin_errors.CbacUnavailable, - "GetCbacMarkingRestrictionInfoPermissionDenied": admin_errors.GetCbacMarkingRestrictionInfoPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _AsyncCbacMarkingRestrictionsClientRaw: - def __init__(self, client: AsyncCbacMarkingRestrictionsClient) -> None: - def get(_: admin_models.CbacMarkingRestrictions): ... - - self.get = core.async_with_raw_response(get, client.get) - - -class _AsyncCbacMarkingRestrictionsClientStreaming: - def __init__(self, client: AsyncCbacMarkingRestrictionsClient) -> None: - def get(_: admin_models.CbacMarkingRestrictions): ... - - self.get = core.async_with_streaming_response(get, client.get) diff --git a/foundry_sdk/v2/admin/errors.py b/foundry_sdk/v2/admin/errors.py index f2db77959..061acf409 100644 --- a/foundry_sdk/v2/admin/errors.py +++ b/foundry_sdk/v2/admin/errors.py @@ -84,21 +84,6 @@ class AddMarkingRoleAssignmentsPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class AddOrganizationGuestMembersPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not add the OrganizationGuestMember.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - organizationRid: core_models.OrganizationRid - - -@dataclass -class AddOrganizationGuestMembersPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["AddOrganizationGuestMembersPermissionDenied"] - parameters: AddOrganizationGuestMembersPermissionDeniedParameters - error_instance_id: str - - class AddOrganizationRoleAssignmentsPermissionDeniedParameters(typing_extensions.TypedDict): """Could not add the OrganizationRoleAssignment.""" @@ -114,21 +99,6 @@ class AddOrganizationRoleAssignmentsPermissionDenied(errors.PermissionDeniedErro error_instance_id: str -class AttributesNotEditableParameters(typing_extensions.TypedDict): - """One or more attributes are not editable. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are not editable.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - attributeNames: typing.List[str] - - -@dataclass -class AttributesNotEditable(errors.BadRequestError): - name: typing.Literal["AttributesNotEditable"] - parameters: AttributesNotEditableParameters - error_instance_id: str - - class AuthenticationProviderNotFoundParameters(typing_extensions.TypedDict): """The given AuthenticationProvider could not be found.""" @@ -161,45 +131,6 @@ class CannotReplaceProviderInfoForPrincipalInProtectedRealm(errors.BadRequestErr error_instance_id: str -class CbacBannerNotFoundParameters(typing_extensions.TypedDict): - """The given CbacBanner could not be found.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class CbacBannerNotFound(errors.NotFoundError): - name: typing.Literal["CbacBannerNotFound"] - parameters: CbacBannerNotFoundParameters - error_instance_id: str - - -class CbacMarkingRestrictionsNotFoundParameters(typing_extensions.TypedDict): - """The given CbacMarkingRestrictions could not be found.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class CbacMarkingRestrictionsNotFound(errors.NotFoundError): - name: typing.Literal["CbacMarkingRestrictionsNotFound"] - parameters: CbacMarkingRestrictionsNotFoundParameters - error_instance_id: str - - -class CbacUnavailableParameters(typing_extensions.TypedDict): - """CBAC is not available.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class CbacUnavailable(errors.BadRequestError): - name: typing.Literal["CbacUnavailable"] - parameters: CbacUnavailableParameters - error_instance_id: str - - class CreateGroupPermissionDeniedParameters(typing_extensions.TypedDict): """Could not create the Group.""" @@ -362,49 +293,6 @@ class EnrollmentRoleNotFound(errors.NotFoundError): error_instance_id: str -class ExpirationForTransitiveGroupMembersNotSupportedParameters(typing_extensions.TypedDict): - """You cannot pass includeExpirations if transitive is true.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class ExpirationForTransitiveGroupMembersNotSupported(errors.BadRequestError): - name: typing.Literal["ExpirationForTransitiveGroupMembersNotSupported"] - parameters: ExpirationForTransitiveGroupMembersNotSupportedParameters - error_instance_id: str - - -class GetCbacBannerPermissionDeniedParameters(typing_extensions.TypedDict): - """The provided token does not have permission to get the CBAC banner for the markings.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - markingIds: typing.List[core_models.MarkingId] - - -@dataclass -class GetCbacBannerPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["GetCbacBannerPermissionDenied"] - parameters: GetCbacBannerPermissionDeniedParameters - error_instance_id: str - - -class GetCbacMarkingRestrictionInfoPermissionDeniedParameters(typing_extensions.TypedDict): - """The provided token does not have permission to get the CBAC marking restrictions for the markings.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - markingIds: typing.List[core_models.MarkingId] - - -@dataclass -class GetCbacMarkingRestrictionInfoPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["GetCbacMarkingRestrictionInfoPermissionDenied"] - parameters: GetCbacMarkingRestrictionInfoPermissionDeniedParameters - error_instance_id: str - - class GetCurrentEnrollmentPermissionDeniedParameters(typing_extensions.TypedDict): """Could not getCurrent the Enrollment.""" @@ -657,19 +545,6 @@ class ListAvailableRolesOrganizationPermissionDenied(errors.PermissionDeniedErro error_instance_id: str -class ListCurrentGroupsPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not listCurrent the Group.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class ListCurrentGroupsPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["ListCurrentGroupsPermissionDenied"] - parameters: ListCurrentGroupsPermissionDeniedParameters - error_instance_id: str - - class ListEnrollmentRoleAssignmentsPermissionDeniedParameters(typing_extensions.TypedDict): """The provided token does not have permission to list assigned roles for this enrollment.""" @@ -730,21 +605,6 @@ class ListMarkingRoleAssignmentsPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class ListOrganizationGuestMembersPermissionDeniedParameters(typing_extensions.TypedDict): - """The provided token does not have permission to list guest members for this organization.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - organizationRid: core_models.OrganizationRid - - -@dataclass -class ListOrganizationGuestMembersPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["ListOrganizationGuestMembersPermissionDenied"] - parameters: ListOrganizationGuestMembersPermissionDeniedParameters - error_instance_id: str - - class ListOrganizationRoleAssignmentsPermissionDeniedParameters(typing_extensions.TypedDict): """The provided token does not have permission to list assigned roles for this organization.""" @@ -819,26 +679,6 @@ class MarkingNotFound(errors.NotFoundError): error_instance_id: str -class OrganizationMarkingAdministerRoleNotSupportedParameters(typing_extensions.TypedDict): - """ - The ADMINISTER role on Organization markings cannot be managed through the Marking Role Assignments - endpoints. To manage administrator roles for an Organization, use the Organization Role Assignment endpoints - instead. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - markingId: core_models.MarkingId - organizationRid: core_models.OrganizationRid - - -@dataclass -class OrganizationMarkingAdministerRoleNotSupported(errors.BadRequestError): - name: typing.Literal["OrganizationMarkingAdministerRoleNotSupported"] - parameters: OrganizationMarkingAdministerRoleNotSupportedParameters - error_instance_id: str - - class OrganizationNameAlreadyExistsParameters(typing_extensions.TypedDict): """An organization with the same name already exists.""" @@ -1022,21 +862,6 @@ class RemoveMarkingRoleAssignmentsRemoveAllAdministratorsNotAllowed(errors.BadRe error_instance_id: str -class RemoveOrganizationGuestMembersPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not remove the OrganizationGuestMember.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - organizationRid: core_models.OrganizationRid - - -@dataclass -class RemoveOrganizationGuestMembersPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["RemoveOrganizationGuestMembersPermissionDenied"] - parameters: RemoveOrganizationGuestMembersPermissionDeniedParameters - error_instance_id: str - - class RemoveOrganizationRoleAssignmentsPermissionDeniedParameters(typing_extensions.TypedDict): """Could not remove the OrganizationRoleAssignment.""" @@ -1067,21 +892,6 @@ class ReplaceGroupMembershipExpirationPolicyPermissionDenied(errors.PermissionDe error_instance_id: str -class ReplaceGroupPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not replace the Group.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - groupId: core_models.GroupId - - -@dataclass -class ReplaceGroupPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["ReplaceGroupPermissionDenied"] - parameters: ReplaceGroupPermissionDeniedParameters - error_instance_id: str - - class ReplaceGroupProviderInfoPermissionDeniedParameters(typing_extensions.TypedDict): """Could not replace the GroupProviderInfo.""" @@ -1097,21 +907,6 @@ class ReplaceGroupProviderInfoPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class ReplaceMarkingCategoryPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not replace the MarkingCategory.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - markingCategoryId: admin_models.MarkingCategoryId - - -@dataclass -class ReplaceMarkingCategoryPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["ReplaceMarkingCategoryPermissionDenied"] - parameters: ReplaceMarkingCategoryPermissionDeniedParameters - error_instance_id: str - - class ReplaceMarkingPermissionDeniedParameters(typing_extensions.TypedDict): """Could not replace the Marking.""" @@ -1213,21 +1008,6 @@ class SearchUsersPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class UnknownClassificationBannerDisplayTypeParameters(typing_extensions.TypedDict): - """The provided classification banner display type is not recognized.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - displayType: str - - -@dataclass -class UnknownClassificationBannerDisplayType(errors.BadRequestError): - name: typing.Literal["UnknownClassificationBannerDisplayType"] - parameters: UnknownClassificationBannerDisplayTypeParameters - error_instance_id: str - - class UserDeletedParameters(typing_extensions.TypedDict): """The user is deleted.""" @@ -1293,14 +1073,9 @@ class UserProviderInfoNotFound(errors.NotFoundError): "AddGroupMembersPermissionDenied", "AddMarkingMembersPermissionDenied", "AddMarkingRoleAssignmentsPermissionDenied", - "AddOrganizationGuestMembersPermissionDenied", "AddOrganizationRoleAssignmentsPermissionDenied", - "AttributesNotEditable", "AuthenticationProviderNotFound", "CannotReplaceProviderInfoForPrincipalInProtectedRealm", - "CbacBannerNotFound", - "CbacMarkingRestrictionsNotFound", - "CbacUnavailable", "CreateGroupPermissionDenied", "CreateMarkingCategoryMissingInitialAdminRole", "CreateMarkingCategoryMissingOrganization", @@ -1313,9 +1088,6 @@ class UserProviderInfoNotFound(errors.NotFoundError): "DeleteUserPermissionDenied", "EnrollmentNotFound", "EnrollmentRoleNotFound", - "ExpirationForTransitiveGroupMembersNotSupported", - "GetCbacBannerPermissionDenied", - "GetCbacMarkingRestrictionInfoPermissionDenied", "GetCurrentEnrollmentPermissionDenied", "GetCurrentUserPermissionDenied", "GetGroupProviderInfoPermissionDenied", @@ -1333,18 +1105,15 @@ class UserProviderInfoNotFound(errors.NotFoundError): "InvalidHostName", "InvalidProfilePicture", "ListAvailableRolesOrganizationPermissionDenied", - "ListCurrentGroupsPermissionDenied", "ListEnrollmentRoleAssignmentsPermissionDenied", "ListHostsPermissionDenied", "ListMarkingMembersPermissionDenied", "ListMarkingRoleAssignmentsPermissionDenied", - "ListOrganizationGuestMembersPermissionDenied", "ListOrganizationRoleAssignmentsPermissionDenied", "MarkingCategoryNotFound", "MarkingNameInCategoryAlreadyExists", "MarkingNameIsEmpty", "MarkingNotFound", - "OrganizationMarkingAdministerRoleNotSupported", "OrganizationNameAlreadyExists", "OrganizationNotFound", "PreregisterGroupPermissionDenied", @@ -1357,12 +1126,9 @@ class UserProviderInfoNotFound(errors.NotFoundError): "RemoveMarkingMembersPermissionDenied", "RemoveMarkingRoleAssignmentsPermissionDenied", "RemoveMarkingRoleAssignmentsRemoveAllAdministratorsNotAllowed", - "RemoveOrganizationGuestMembersPermissionDenied", "RemoveOrganizationRoleAssignmentsPermissionDenied", "ReplaceGroupMembershipExpirationPolicyPermissionDenied", - "ReplaceGroupPermissionDenied", "ReplaceGroupProviderInfoPermissionDenied", - "ReplaceMarkingCategoryPermissionDenied", "ReplaceMarkingPermissionDenied", "ReplaceOrganizationPermissionDenied", "ReplaceUserProviderInfoPermissionDenied", @@ -1370,7 +1136,6 @@ class UserProviderInfoNotFound(errors.NotFoundError): "RoleNotFound", "SearchGroupsPermissionDenied", "SearchUsersPermissionDenied", - "UnknownClassificationBannerDisplayType", "UserDeleted", "UserIsActive", "UserNotFound", diff --git a/foundry_sdk/v2/admin/group.py b/foundry_sdk/v2/admin/group.py index dec324697..fd6551b01 100644 --- a/foundry_sdk/v2/admin/group.py +++ b/foundry_sdk/v2/admin/group.py @@ -329,123 +329,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def list_current( - self, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.ListCurrentGroupsResponse: - """ - Returns all Groups which contain the current user as a direct or transitive member. For example if the current user is a member of Group A and Group A is a member of Group B, this endpoint will return Group A and Group B. - - Unlike the list Group Memberships endpoint which requires the `api:admin-read` scope, this endpoint - does not require any particular scopes and can be used by any authenticated user to retrieve their own - group memberships. - - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: admin_models.ListCurrentGroupsResponse - - :raises ListCurrentGroupsPermissionDenied: Could not listCurrent the Group. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/groups/listCurrent", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=admin_models.ListCurrentGroupsResponse, - request_timeout=request_timeout, - throwable_errors={ - "ListCurrentGroupsPermissionDenied": admin_errors.ListCurrentGroupsPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def replace( - self, - group_id: core_models.GroupId, - *, - attributes: typing.Dict[admin_models.AttributeName, admin_models.AttributeValues], - name: admin_models.GroupName, - organizations: typing.List[core_models.OrganizationRid], - description: typing.Optional[str] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.Group: - """ - When replacing groups, you must send all attributes that begin with `multipass:` exactly as they appear when calling the Get Group endpoint. - :param group_id: - :type group_id: GroupId - :param attributes: A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. - :type attributes: Dict[AttributeName, AttributeValues] - :param name: The name of the Group. - :type name: GroupName - :param organizations: The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed. - :type organizations: List[OrganizationRid] - :param description: A description of the Group. - :type description: Optional[str] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: admin_models.Group - - :raises AttributesNotEditable: One or more attributes are not editable. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are not editable. - :raises GroupNameAlreadyExists: A group with this name already exists - :raises GroupNotFound: The given Group could not be found. - :raises InvalidGroupOrganizations: At least one Organization RID must be provided for a group - :raises ReplaceGroupPermissionDenied: Could not replace the Group. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="PUT", - resource_path="/v2/admin/groups/{groupId}", - query_params={}, - path_params={ - "groupId": group_id, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=admin_models.ReplaceGroupRequest( - name=name, - organizations=organizations, - description=description, - attributes=attributes, - ), - response_type=admin_models.Group, - request_timeout=request_timeout, - throwable_errors={ - "AttributesNotEditable": admin_errors.AttributesNotEditable, - "GroupNameAlreadyExists": admin_errors.GroupNameAlreadyExists, - "GroupNotFound": admin_errors.GroupNotFound, - "InvalidGroupOrganizations": admin_errors.InvalidGroupOrganizations, - "ReplaceGroupPermissionDenied": admin_errors.ReplaceGroupPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -509,8 +392,6 @@ def delete(_: None): ... def get(_: admin_models.Group): ... def get_batch(_: admin_models.GetGroupsBatchResponse): ... def list(_: admin_models.ListGroupsResponse): ... - def list_current(_: admin_models.ListCurrentGroupsResponse): ... - def replace(_: admin_models.Group): ... def search(_: admin_models.SearchGroupsResponse): ... self.create = core.with_raw_response(create, client.create) @@ -518,8 +399,6 @@ def search(_: admin_models.SearchGroupsResponse): ... self.get = core.with_raw_response(get, client.get) self.get_batch = core.with_raw_response(get_batch, client.get_batch) self.list = core.with_raw_response(list, client.list) - self.list_current = core.with_raw_response(list_current, client.list_current) - self.replace = core.with_raw_response(replace, client.replace) self.search = core.with_raw_response(search, client.search) @@ -529,16 +408,12 @@ def create(_: admin_models.Group): ... def get(_: admin_models.Group): ... def get_batch(_: admin_models.GetGroupsBatchResponse): ... def list(_: admin_models.ListGroupsResponse): ... - def list_current(_: admin_models.ListCurrentGroupsResponse): ... - def replace(_: admin_models.Group): ... def search(_: admin_models.SearchGroupsResponse): ... self.create = core.with_streaming_response(create, client.create) self.get = core.with_streaming_response(get, client.get) self.get_batch = core.with_streaming_response(get_batch, client.get_batch) self.list = core.with_streaming_response(list, client.list) - self.list_current = core.with_streaming_response(list_current, client.list_current) - self.replace = core.with_streaming_response(replace, client.replace) self.search = core.with_streaming_response(search, client.search) @@ -843,123 +718,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def list_current( - self, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[admin_models.ListCurrentGroupsResponse]: - """ - Returns all Groups which contain the current user as a direct or transitive member. For example if the current user is a member of Group A and Group A is a member of Group B, this endpoint will return Group A and Group B. - - Unlike the list Group Memberships endpoint which requires the `api:admin-read` scope, this endpoint - does not require any particular scopes and can be used by any authenticated user to retrieve their own - group memberships. - - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[admin_models.ListCurrentGroupsResponse] - - :raises ListCurrentGroupsPermissionDenied: Could not listCurrent the Group. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/groups/listCurrent", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=admin_models.ListCurrentGroupsResponse, - request_timeout=request_timeout, - throwable_errors={ - "ListCurrentGroupsPermissionDenied": admin_errors.ListCurrentGroupsPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def replace( - self, - group_id: core_models.GroupId, - *, - attributes: typing.Dict[admin_models.AttributeName, admin_models.AttributeValues], - name: admin_models.GroupName, - organizations: typing.List[core_models.OrganizationRid], - description: typing.Optional[str] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[admin_models.Group]: - """ - When replacing groups, you must send all attributes that begin with `multipass:` exactly as they appear when calling the Get Group endpoint. - :param group_id: - :type group_id: GroupId - :param attributes: A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. - :type attributes: Dict[AttributeName, AttributeValues] - :param name: The name of the Group. - :type name: GroupName - :param organizations: The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed. - :type organizations: List[OrganizationRid] - :param description: A description of the Group. - :type description: Optional[str] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[admin_models.Group] - - :raises AttributesNotEditable: One or more attributes are not editable. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are not editable. - :raises GroupNameAlreadyExists: A group with this name already exists - :raises GroupNotFound: The given Group could not be found. - :raises InvalidGroupOrganizations: At least one Organization RID must be provided for a group - :raises ReplaceGroupPermissionDenied: Could not replace the Group. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="PUT", - resource_path="/v2/admin/groups/{groupId}", - query_params={}, - path_params={ - "groupId": group_id, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=admin_models.ReplaceGroupRequest( - name=name, - organizations=organizations, - description=description, - attributes=attributes, - ), - response_type=admin_models.Group, - request_timeout=request_timeout, - throwable_errors={ - "AttributesNotEditable": admin_errors.AttributesNotEditable, - "GroupNameAlreadyExists": admin_errors.GroupNameAlreadyExists, - "GroupNotFound": admin_errors.GroupNotFound, - "InvalidGroupOrganizations": admin_errors.InvalidGroupOrganizations, - "ReplaceGroupPermissionDenied": admin_errors.ReplaceGroupPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -1023,8 +781,6 @@ def delete(_: None): ... def get(_: admin_models.Group): ... def get_batch(_: admin_models.GetGroupsBatchResponse): ... def list(_: admin_models.ListGroupsResponse): ... - def list_current(_: admin_models.ListCurrentGroupsResponse): ... - def replace(_: admin_models.Group): ... def search(_: admin_models.SearchGroupsResponse): ... self.create = core.async_with_raw_response(create, client.create) @@ -1032,8 +788,6 @@ def search(_: admin_models.SearchGroupsResponse): ... self.get = core.async_with_raw_response(get, client.get) self.get_batch = core.async_with_raw_response(get_batch, client.get_batch) self.list = core.async_with_raw_response(list, client.list) - self.list_current = core.async_with_raw_response(list_current, client.list_current) - self.replace = core.async_with_raw_response(replace, client.replace) self.search = core.async_with_raw_response(search, client.search) @@ -1043,14 +797,10 @@ def create(_: admin_models.Group): ... def get(_: admin_models.Group): ... def get_batch(_: admin_models.GetGroupsBatchResponse): ... def list(_: admin_models.ListGroupsResponse): ... - def list_current(_: admin_models.ListCurrentGroupsResponse): ... - def replace(_: admin_models.Group): ... def search(_: admin_models.SearchGroupsResponse): ... self.create = core.async_with_streaming_response(create, client.create) self.get = core.async_with_streaming_response(get, client.get) self.get_batch = core.async_with_streaming_response(get_batch, client.get_batch) self.list = core.async_with_streaming_response(list, client.list) - self.list_current = core.async_with_streaming_response(list_current, client.list_current) - self.replace = core.async_with_streaming_response(replace, client.replace) self.search = core.async_with_streaming_response(search, client.search) diff --git a/foundry_sdk/v2/admin/group_member.py b/foundry_sdk/v2/admin/group_member.py index 0f815b682..8b09d426d 100644 --- a/foundry_sdk/v2/admin/group_member.py +++ b/foundry_sdk/v2/admin/group_member.py @@ -120,7 +120,6 @@ def list( self, group_id: core_models.GroupId, *, - include_expirations: typing.Optional[bool] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, transitive: typing.Optional[bool] = None, @@ -138,20 +137,17 @@ def list( :param group_id: :type group_id: GroupId - :param include_expirations: When true, includes the expiration time of any temporary members of this group. `includeExpirations` cannot be set to true if `transitive` is also set to true. Defaults to false. - :type include_expirations: Optional[bool] :param page_size: The page size to use for the endpoint. :type page_size: Optional[PageSize] :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. :type page_token: Optional[PageToken] - :param transitive: When true, includes the transitive members of groups contained within this group. For example, say the Group has member Group A, and Group A has member User B. If `transitive=false` only Group A will be returned, but if `transitive=true` then Group A and User B will be returned. This will recursively resolve Groups through all layers of nesting. If `transitive` is true, `includeExpirations` cannot also be set to true. Defaults to false. + :param transitive: When true, includes the transitive members of groups contained within this group. For example, say the Group has member Group A, and Group A has member User B. If `transitive=false` only Group A will be returned, but if `transitive=true` then Group A and User B will be returned. This will recursively resolve Groups through all layers of nesting. Defaults to false. :type transitive: Optional[bool] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. :rtype: core.ResourceIterator[admin_models.GroupMember] - :raises ExpirationForTransitiveGroupMembersNotSupported: You cannot pass includeExpirations if transitive is true. :raises GroupNotFound: The given Group could not be found. :raises InvalidPageSize: The provided page size was zero or negative. Page sizes must be greater than zero. """ @@ -161,7 +157,6 @@ def list( method="GET", resource_path="/v2/admin/groups/{groupId}/groupMembers", query_params={ - "includeExpirations": include_expirations, "pageSize": page_size, "pageToken": page_token, "transitive": transitive, @@ -176,7 +171,6 @@ def list( response_type=admin_models.ListGroupMembersResponse, request_timeout=request_timeout, throwable_errors={ - "ExpirationForTransitiveGroupMembersNotSupported": admin_errors.ExpirationForTransitiveGroupMembersNotSupported, "GroupNotFound": admin_errors.GroupNotFound, "InvalidPageSize": core_errors.InvalidPageSize, }, @@ -349,7 +343,6 @@ def list( self, group_id: core_models.GroupId, *, - include_expirations: typing.Optional[bool] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, transitive: typing.Optional[bool] = None, @@ -367,20 +360,17 @@ def list( :param group_id: :type group_id: GroupId - :param include_expirations: When true, includes the expiration time of any temporary members of this group. `includeExpirations` cannot be set to true if `transitive` is also set to true. Defaults to false. - :type include_expirations: Optional[bool] :param page_size: The page size to use for the endpoint. :type page_size: Optional[PageSize] :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. :type page_token: Optional[PageToken] - :param transitive: When true, includes the transitive members of groups contained within this group. For example, say the Group has member Group A, and Group A has member User B. If `transitive=false` only Group A will be returned, but if `transitive=true` then Group A and User B will be returned. This will recursively resolve Groups through all layers of nesting. If `transitive` is true, `includeExpirations` cannot also be set to true. Defaults to false. + :param transitive: When true, includes the transitive members of groups contained within this group. For example, say the Group has member Group A, and Group A has member User B. If `transitive=false` only Group A will be returned, but if `transitive=true` then Group A and User B will be returned. This will recursively resolve Groups through all layers of nesting. Defaults to false. :type transitive: Optional[bool] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. :rtype: core.AsyncResourceIterator[admin_models.GroupMember] - :raises ExpirationForTransitiveGroupMembersNotSupported: You cannot pass includeExpirations if transitive is true. :raises GroupNotFound: The given Group could not be found. :raises InvalidPageSize: The provided page size was zero or negative. Page sizes must be greater than zero. """ @@ -390,7 +380,6 @@ def list( method="GET", resource_path="/v2/admin/groups/{groupId}/groupMembers", query_params={ - "includeExpirations": include_expirations, "pageSize": page_size, "pageToken": page_token, "transitive": transitive, @@ -405,7 +394,6 @@ def list( response_type=admin_models.ListGroupMembersResponse, request_timeout=request_timeout, throwable_errors={ - "ExpirationForTransitiveGroupMembersNotSupported": admin_errors.ExpirationForTransitiveGroupMembersNotSupported, "GroupNotFound": admin_errors.GroupNotFound, "InvalidPageSize": core_errors.InvalidPageSize, }, diff --git a/foundry_sdk/v2/admin/group_provider_info.py b/foundry_sdk/v2/admin/group_provider_info.py index 9d8f8a5e5..62d1aae6c 100644 --- a/foundry_sdk/v2/admin/group_provider_info.py +++ b/foundry_sdk/v2/admin/group_provider_info.py @@ -61,6 +61,7 @@ def get( self, group_id: core_models.GroupId, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> admin_models.GroupProviderInfo: @@ -68,6 +69,8 @@ def get( Get the GroupProviderInfo. :param group_id: :type group_id: GroupId + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -82,7 +85,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/admin/groups/{groupId}/providerInfo", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "groupId": group_id, }, @@ -109,6 +114,7 @@ def replace( group_id: core_models.GroupId, *, provider_id: admin_models.ProviderId, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> admin_models.GroupProviderInfo: @@ -118,6 +124,8 @@ def replace( :type group_id: GroupId :param provider_id: The ID of the Group in the external authentication provider. This value is determined by the authentication provider. At most one Group can have a given provider ID in a given Realm. :type provider_id: ProviderId + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -134,7 +142,9 @@ def replace( core.RequestInfo( method="PUT", resource_path="/v2/admin/groups/{groupId}/providerInfo", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "groupId": group_id, }, @@ -213,6 +223,7 @@ def get( self, group_id: core_models.GroupId, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[admin_models.GroupProviderInfo]: @@ -220,6 +231,8 @@ def get( Get the GroupProviderInfo. :param group_id: :type group_id: GroupId + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -234,7 +247,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/admin/groups/{groupId}/providerInfo", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "groupId": group_id, }, @@ -261,6 +276,7 @@ def replace( group_id: core_models.GroupId, *, provider_id: admin_models.ProviderId, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[admin_models.GroupProviderInfo]: @@ -270,6 +286,8 @@ def replace( :type group_id: GroupId :param provider_id: The ID of the Group in the external authentication provider. This value is determined by the authentication provider. At most one Group can have a given provider ID in a given Realm. :type provider_id: ProviderId + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -286,7 +304,9 @@ def replace( core.RequestInfo( method="PUT", resource_path="/v2/admin/groups/{groupId}/providerInfo", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "groupId": group_id, }, diff --git a/foundry_sdk/v2/admin/marking_category.py b/foundry_sdk/v2/admin/marking_category.py index 75802ba1a..b529ee8af 100644 --- a/foundry_sdk/v2/admin/marking_category.py +++ b/foundry_sdk/v2/admin/marking_category.py @@ -125,6 +125,7 @@ def get( self, marking_category_id: admin_models.MarkingCategoryId, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> admin_models.MarkingCategory: @@ -132,6 +133,8 @@ def get( Get the MarkingCategory with the specified id. :param marking_category_id: :type marking_category_id: MarkingCategoryId + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -145,7 +148,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/admin/markingCategories/{markingCategoryId}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "markingCategoryId": marking_category_id, }, @@ -171,6 +176,7 @@ def list( *, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> core.ResourceIterator[admin_models.MarkingCategory]: @@ -180,6 +186,8 @@ def list( :type page_size: Optional[PageSize] :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. :type page_token: Optional[PageToken] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -195,6 +203,7 @@ def list( query_params={ "pageSize": page_size, "pageToken": page_token, + "preview": preview, }, path_params={}, header_params={ @@ -210,80 +219,16 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def replace( - self, - marking_category_id: admin_models.MarkingCategoryId, - *, - description: admin_models.MarkingCategoryDescription, - name: admin_models.MarkingCategoryName, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.MarkingCategory: - """ - Replace the MarkingCategory with the specified id. - :param marking_category_id: - :type marking_category_id: MarkingCategoryId - :param description: - :type description: MarkingCategoryDescription - :param name: - :type name: MarkingCategoryName - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: admin_models.MarkingCategory - - :raises GetMarkingCategoryPermissionDenied: The provided token does not have permission to view the marking category. - :raises MarkingCategoryNotFound: The given MarkingCategory could not be found. - :raises ReplaceMarkingCategoryPermissionDenied: Could not replace the MarkingCategory. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="PUT", - resource_path="/v2/admin/markingCategories/{markingCategoryId}", - query_params={ - "preview": preview, - }, - path_params={ - "markingCategoryId": marking_category_id, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=admin_models.ReplaceMarkingCategoryRequest( - name=name, - description=description, - ), - response_type=admin_models.MarkingCategory, - request_timeout=request_timeout, - throwable_errors={ - "GetMarkingCategoryPermissionDenied": admin_errors.GetMarkingCategoryPermissionDenied, - "MarkingCategoryNotFound": admin_errors.MarkingCategoryNotFound, - "ReplaceMarkingCategoryPermissionDenied": admin_errors.ReplaceMarkingCategoryPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _MarkingCategoryClientRaw: def __init__(self, client: MarkingCategoryClient) -> None: def create(_: admin_models.MarkingCategory): ... def get(_: admin_models.MarkingCategory): ... def list(_: admin_models.ListMarkingCategoriesResponse): ... - def replace(_: admin_models.MarkingCategory): ... self.create = core.with_raw_response(create, client.create) self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.replace = core.with_raw_response(replace, client.replace) class _MarkingCategoryClientStreaming: @@ -291,12 +236,10 @@ def __init__(self, client: MarkingCategoryClient) -> None: def create(_: admin_models.MarkingCategory): ... def get(_: admin_models.MarkingCategory): ... def list(_: admin_models.ListMarkingCategoriesResponse): ... - def replace(_: admin_models.MarkingCategory): ... self.create = core.with_streaming_response(create, client.create) self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.replace = core.with_streaming_response(replace, client.replace) class AsyncMarkingCategoryClient: @@ -398,6 +341,7 @@ def get( self, marking_category_id: admin_models.MarkingCategoryId, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[admin_models.MarkingCategory]: @@ -405,6 +349,8 @@ def get( Get the MarkingCategory with the specified id. :param marking_category_id: :type marking_category_id: MarkingCategoryId + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -418,7 +364,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/admin/markingCategories/{markingCategoryId}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "markingCategoryId": marking_category_id, }, @@ -444,6 +392,7 @@ def list( *, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> core.AsyncResourceIterator[admin_models.MarkingCategory]: @@ -453,6 +402,8 @@ def list( :type page_size: Optional[PageSize] :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. :type page_token: Optional[PageToken] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -468,6 +419,7 @@ def list( query_params={ "pageSize": page_size, "pageToken": page_token, + "preview": preview, }, path_params={}, header_params={ @@ -483,80 +435,16 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def replace( - self, - marking_category_id: admin_models.MarkingCategoryId, - *, - description: admin_models.MarkingCategoryDescription, - name: admin_models.MarkingCategoryName, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[admin_models.MarkingCategory]: - """ - Replace the MarkingCategory with the specified id. - :param marking_category_id: - :type marking_category_id: MarkingCategoryId - :param description: - :type description: MarkingCategoryDescription - :param name: - :type name: MarkingCategoryName - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[admin_models.MarkingCategory] - - :raises GetMarkingCategoryPermissionDenied: The provided token does not have permission to view the marking category. - :raises MarkingCategoryNotFound: The given MarkingCategory could not be found. - :raises ReplaceMarkingCategoryPermissionDenied: Could not replace the MarkingCategory. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="PUT", - resource_path="/v2/admin/markingCategories/{markingCategoryId}", - query_params={ - "preview": preview, - }, - path_params={ - "markingCategoryId": marking_category_id, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=admin_models.ReplaceMarkingCategoryRequest( - name=name, - description=description, - ), - response_type=admin_models.MarkingCategory, - request_timeout=request_timeout, - throwable_errors={ - "GetMarkingCategoryPermissionDenied": admin_errors.GetMarkingCategoryPermissionDenied, - "MarkingCategoryNotFound": admin_errors.MarkingCategoryNotFound, - "ReplaceMarkingCategoryPermissionDenied": admin_errors.ReplaceMarkingCategoryPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _AsyncMarkingCategoryClientRaw: def __init__(self, client: AsyncMarkingCategoryClient) -> None: def create(_: admin_models.MarkingCategory): ... def get(_: admin_models.MarkingCategory): ... def list(_: admin_models.ListMarkingCategoriesResponse): ... - def replace(_: admin_models.MarkingCategory): ... self.create = core.async_with_raw_response(create, client.create) self.get = core.async_with_raw_response(get, client.get) self.list = core.async_with_raw_response(list, client.list) - self.replace = core.async_with_raw_response(replace, client.replace) class _AsyncMarkingCategoryClientStreaming: @@ -564,9 +452,7 @@ def __init__(self, client: AsyncMarkingCategoryClient) -> None: def create(_: admin_models.MarkingCategory): ... def get(_: admin_models.MarkingCategory): ... def list(_: admin_models.ListMarkingCategoriesResponse): ... - def replace(_: admin_models.MarkingCategory): ... self.create = core.async_with_streaming_response(create, client.create) self.get = core.async_with_streaming_response(get, client.get) self.list = core.async_with_streaming_response(list, client.list) - self.replace = core.async_with_streaming_response(replace, client.replace) diff --git a/foundry_sdk/v2/admin/marking_role_assignment.py b/foundry_sdk/v2/admin/marking_role_assignment.py index d1dfff700..8cbc99b46 100644 --- a/foundry_sdk/v2/admin/marking_role_assignment.py +++ b/foundry_sdk/v2/admin/marking_role_assignment.py @@ -66,8 +66,6 @@ def add( _sdk_internal: core.SdkInternal = {}, ) -> None: """ - Adds role assignments for the given Marking. For Organization markings, only the USE and DECLASSIFY - roles are supported; the ADMINISTER role must be managed via the Organization Role Assignment endpoints. :param marking_id: :type marking_id: MarkingId @@ -81,7 +79,6 @@ def add( :raises AddMarkingRoleAssignmentsPermissionDenied: Could not add the MarkingRoleAssignment. :raises GetMarkingPermissionDenied: The provided token does not have permission to view the marking. :raises MarkingNotFound: The given Marking could not be found. - :raises OrganizationMarkingAdministerRoleNotSupported: The ADMINISTER role on Organization markings cannot be managed through the Marking Role Assignments endpoints. To manage administrator roles for an Organization, use the Organization Role Assignment endpoints instead. :raises PrincipalNotFound: A principal (User or Group) with the given PrincipalId could not be found """ @@ -105,7 +102,6 @@ def add( "AddMarkingRoleAssignmentsPermissionDenied": admin_errors.AddMarkingRoleAssignmentsPermissionDenied, "GetMarkingPermissionDenied": admin_errors.GetMarkingPermissionDenied, "MarkingNotFound": admin_errors.MarkingNotFound, - "OrganizationMarkingAdministerRoleNotSupported": admin_errors.OrganizationMarkingAdministerRoleNotSupported, "PrincipalNotFound": admin_errors.PrincipalNotFound, }, response_mode=_sdk_internal.get("response_mode"), @@ -179,8 +175,6 @@ def remove( _sdk_internal: core.SdkInternal = {}, ) -> None: """ - Removes role assignments for the given Marking. For Organization markings, only the USE and DECLASSIFY - roles are supported; the ADMINISTER role must be managed via the Organization Role Assignment endpoints. :param marking_id: :type marking_id: MarkingId @@ -194,7 +188,6 @@ def remove( :raises GetMarkingPermissionDenied: The provided token does not have permission to view the marking. :raises ListMarkingRoleAssignmentsPermissionDenied: The provided token does not have permission to list assigned roles for this marking. :raises MarkingNotFound: The given Marking could not be found. - :raises OrganizationMarkingAdministerRoleNotSupported: The ADMINISTER role on Organization markings cannot be managed through the Marking Role Assignments endpoints. To manage administrator roles for an Organization, use the Organization Role Assignment endpoints instead. :raises PrincipalNotFound: A principal (User or Group) with the given PrincipalId could not be found :raises RemoveMarkingMembersPermissionDenied: Could not remove the MarkingMember. :raises RemoveMarkingRoleAssignmentsPermissionDenied: Could not remove the MarkingRoleAssignment. @@ -221,7 +214,6 @@ def remove( "GetMarkingPermissionDenied": admin_errors.GetMarkingPermissionDenied, "ListMarkingRoleAssignmentsPermissionDenied": admin_errors.ListMarkingRoleAssignmentsPermissionDenied, "MarkingNotFound": admin_errors.MarkingNotFound, - "OrganizationMarkingAdministerRoleNotSupported": admin_errors.OrganizationMarkingAdministerRoleNotSupported, "PrincipalNotFound": admin_errors.PrincipalNotFound, "RemoveMarkingMembersPermissionDenied": admin_errors.RemoveMarkingMembersPermissionDenied, "RemoveMarkingRoleAssignmentsPermissionDenied": admin_errors.RemoveMarkingRoleAssignmentsPermissionDenied, @@ -291,8 +283,6 @@ def add( _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[None]: """ - Adds role assignments for the given Marking. For Organization markings, only the USE and DECLASSIFY - roles are supported; the ADMINISTER role must be managed via the Organization Role Assignment endpoints. :param marking_id: :type marking_id: MarkingId @@ -306,7 +296,6 @@ def add( :raises AddMarkingRoleAssignmentsPermissionDenied: Could not add the MarkingRoleAssignment. :raises GetMarkingPermissionDenied: The provided token does not have permission to view the marking. :raises MarkingNotFound: The given Marking could not be found. - :raises OrganizationMarkingAdministerRoleNotSupported: The ADMINISTER role on Organization markings cannot be managed through the Marking Role Assignments endpoints. To manage administrator roles for an Organization, use the Organization Role Assignment endpoints instead. :raises PrincipalNotFound: A principal (User or Group) with the given PrincipalId could not be found """ @@ -330,7 +319,6 @@ def add( "AddMarkingRoleAssignmentsPermissionDenied": admin_errors.AddMarkingRoleAssignmentsPermissionDenied, "GetMarkingPermissionDenied": admin_errors.GetMarkingPermissionDenied, "MarkingNotFound": admin_errors.MarkingNotFound, - "OrganizationMarkingAdministerRoleNotSupported": admin_errors.OrganizationMarkingAdministerRoleNotSupported, "PrincipalNotFound": admin_errors.PrincipalNotFound, }, response_mode=_sdk_internal.get("response_mode"), @@ -404,8 +392,6 @@ def remove( _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[None]: """ - Removes role assignments for the given Marking. For Organization markings, only the USE and DECLASSIFY - roles are supported; the ADMINISTER role must be managed via the Organization Role Assignment endpoints. :param marking_id: :type marking_id: MarkingId @@ -419,7 +405,6 @@ def remove( :raises GetMarkingPermissionDenied: The provided token does not have permission to view the marking. :raises ListMarkingRoleAssignmentsPermissionDenied: The provided token does not have permission to list assigned roles for this marking. :raises MarkingNotFound: The given Marking could not be found. - :raises OrganizationMarkingAdministerRoleNotSupported: The ADMINISTER role on Organization markings cannot be managed through the Marking Role Assignments endpoints. To manage administrator roles for an Organization, use the Organization Role Assignment endpoints instead. :raises PrincipalNotFound: A principal (User or Group) with the given PrincipalId could not be found :raises RemoveMarkingMembersPermissionDenied: Could not remove the MarkingMember. :raises RemoveMarkingRoleAssignmentsPermissionDenied: Could not remove the MarkingRoleAssignment. @@ -446,7 +431,6 @@ def remove( "GetMarkingPermissionDenied": admin_errors.GetMarkingPermissionDenied, "ListMarkingRoleAssignmentsPermissionDenied": admin_errors.ListMarkingRoleAssignmentsPermissionDenied, "MarkingNotFound": admin_errors.MarkingNotFound, - "OrganizationMarkingAdministerRoleNotSupported": admin_errors.OrganizationMarkingAdministerRoleNotSupported, "PrincipalNotFound": admin_errors.PrincipalNotFound, "RemoveMarkingMembersPermissionDenied": admin_errors.RemoveMarkingMembersPermissionDenied, "RemoveMarkingRoleAssignmentsPermissionDenied": admin_errors.RemoveMarkingRoleAssignmentsPermissionDenied, diff --git a/foundry_sdk/v2/admin/models.py b/foundry_sdk/v2/admin/models.py index eda07f8db..44beccf49 100644 --- a/foundry_sdk/v2/admin/models.py +++ b/foundry_sdk/v2/admin/models.py @@ -49,12 +49,6 @@ class AddMarkingRoleAssignmentsRequest(core.ModelBase): role_assignments: typing.List[MarkingRoleUpdate] = pydantic.Field(alias=str("roleAssignments")) # type: ignore[literal-required] -class AddOrganizationGuestMembersRequest(core.ModelBase): - """AddOrganizationGuestMembersRequest""" - - principal_ids: typing.List[core_models.PrincipalId] = pydantic.Field(alias=str("principalIds")) # type: ignore[literal-required] - - class AddOrganizationRoleAssignmentsRequest(core.ModelBase): """AddOrganizationRoleAssignmentsRequest""" @@ -110,46 +104,6 @@ class AuthenticationProvider(core.ModelBase): """AuthenticationProviderRid""" -class CbacBanner(core.ModelBase): - """CbacBanner""" - - classification_string: CbacBannerClassificationString = pydantic.Field(alias=str("classificationString")) # type: ignore[literal-required] - markings: typing.List[core_models.MarkingId] - text_color: core_models.Color = pydantic.Field(alias=str("textColor")) # type: ignore[literal-required] - background_colors: typing.List[core_models.Color] = pydantic.Field(alias=str("backgroundColors")) # type: ignore[literal-required] - - -CbacBannerClassificationString = str -"""CbacBannerClassificationString""" - - -class CbacMarkingRestrictions(core.ModelBase): - """CbacMarkingRestrictions""" - - disallowed_markings: typing.List[core_models.MarkingId] = pydantic.Field(alias=str("disallowedMarkings")) # type: ignore[literal-required] - """Markings that cannot appear in conjunction with the provided markings. This includes all such markings, not just those present in the provided set.""" - - implied_markings: typing.List[core_models.MarkingId] = pydantic.Field(alias=str("impliedMarkings")) # type: ignore[literal-required] - """Markings that are automatically granted when a user has membership in any of the provided markings.""" - - required_markings: typing.List[typing.List[core_models.MarkingId]] = pydantic.Field(alias=str("requiredMarkings")) # type: ignore[literal-required] - """Markings that must appear in conjunction with the provided markings. Each list contains the requirements for one of the provided markings, and at least one marking from each must be included in the provided markingIds to constitute a valid classification.""" - - user_satisfies_markings: CbacMarkingRestrictionsUserSatisfiesMarkings = pydantic.Field(alias=str("userSatisfiesMarkings")) # type: ignore[literal-required] - """True if the current user satisfies the provided markings. The user must be a member of all conjunctive markings. The provided disjunctive markings are grouped by category, and the user must be a member of at least one marking in each group.""" - - is_valid: CbacMarkingRestrictionsIsValid = pydantic.Field(alias=str("isValid")) # type: ignore[literal-required] - """True if the provided markings constitute a valid classification, containing no disallowed markings and satisfying all required marking constraints.""" - - -CbacMarkingRestrictionsIsValid = bool -"""True if the provided markings constitute a valid classification, containing no disallowed markings and satisfying all required marking constraints.""" - - -CbacMarkingRestrictionsUserSatisfiesMarkings = bool -"""True if the current user satisfies the provided markings. The user must be a member of all conjunctive markings. The provided disjunctive markings are grouped by category, and the user must be a member of at least one marking in each group.""" - - class CertificateInfo(core.ModelBase): """CertificateInfo""" @@ -165,10 +119,6 @@ class CertificateInfo(core.ModelBase): """CertificateUsageType""" -ClassificationBannerDisplayType = typing.Literal["BANNER_LINE", "PORTION_MARKING"] -"""The display type of the classification banner. BANNER_LINE is the long classification string used in the header of a document; PORTION_MARKING is a short classification string used for individual paragraphs""" - - class CreateGroupRequest(core.ModelBase): """CreateGroupRequest""" @@ -342,11 +292,6 @@ class GroupMember(core.ModelBase): principal_type: core_models.PrincipalType = pydantic.Field(alias=str("principalType")) # type: ignore[literal-required] principal_id: core_models.PrincipalId = pydantic.Field(alias=str("principalId")) # type: ignore[literal-required] - expiration: typing.Optional[GroupMembershipExpiration] = None - """ - The time at which this member's membership in the group will expire. This field will always be - empty unless the `includeExpirations` query parameter is set to true in the list operation. - """ class GroupMembership(core.ModelBase): @@ -413,12 +358,6 @@ class ListAvailableOrganizationRolesResponse(core.ModelBase): data: typing.List[core_models.Role] -class ListCurrentGroupsResponse(core.ModelBase): - """ListCurrentGroupsResponse""" - - data: typing.List[Group] - - class ListEnrollmentRoleAssignmentsResponse(core.ModelBase): """ListEnrollmentRoleAssignmentsResponse""" @@ -482,13 +421,6 @@ class ListMarkingsResponse(core.ModelBase): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] -class ListOrganizationGuestMembersResponse(core.ModelBase): - """ListOrganizationGuestMembersResponse""" - - data: typing.List[OrganizationGuestMember] - next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] - - class ListOrganizationRoleAssignmentsResponse(core.ModelBase): """ListOrganizationRoleAssignmentsResponse""" @@ -645,13 +577,6 @@ class Organization(core.ModelBase): """ -class OrganizationGuestMember(core.ModelBase): - """OrganizationGuestMember""" - - principal_type: core_models.PrincipalType = pydantic.Field(alias=str("principalType")) # type: ignore[literal-required] - principal_id: core_models.PrincipalId = pydantic.Field(alias=str("principalId")) # type: ignore[literal-required] - - OrganizationName = str """OrganizationName""" @@ -722,12 +647,6 @@ class RemoveMarkingRoleAssignmentsRequest(core.ModelBase): role_assignments: typing.List[MarkingRoleUpdate] = pydantic.Field(alias=str("roleAssignments")) # type: ignore[literal-required] -class RemoveOrganizationGuestMembersRequest(core.ModelBase): - """RemoveOrganizationGuestMembersRequest""" - - principal_ids: typing.List[core_models.PrincipalId] = pydantic.Field(alias=str("principalIds")) # type: ignore[literal-required] - - class RemoveOrganizationRoleAssignmentsRequest(core.ModelBase): """RemoveOrganizationRoleAssignmentsRequest""" @@ -754,29 +673,6 @@ class ReplaceGroupProviderInfoRequest(core.ModelBase): """ -class ReplaceGroupRequest(core.ModelBase): - """ReplaceGroupRequest""" - - name: GroupName - """The name of the Group.""" - - organizations: typing.List[core_models.OrganizationRid] - """The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed.""" - - description: typing.Optional[str] = None - """A description of the Group.""" - - attributes: typing.Dict[AttributeName, AttributeValues] - """A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change.""" - - -class ReplaceMarkingCategoryRequest(core.ModelBase): - """ReplaceMarkingCategoryRequest""" - - name: MarkingCategoryName - description: MarkingCategoryDescription - - class ReplaceMarkingRequest(core.ModelBase): """ReplaceMarkingRequest""" @@ -946,7 +842,6 @@ class UserSearchFilter(core.ModelBase): "AddGroupMembersRequest", "AddMarkingMembersRequest", "AddMarkingRoleAssignmentsRequest", - "AddOrganizationGuestMembersRequest", "AddOrganizationRoleAssignmentsRequest", "AttributeName", "AttributeValue", @@ -956,14 +851,8 @@ class UserSearchFilter(core.ModelBase): "AuthenticationProviderEnabled", "AuthenticationProviderName", "AuthenticationProviderRid", - "CbacBanner", - "CbacBannerClassificationString", - "CbacMarkingRestrictions", - "CbacMarkingRestrictionsIsValid", - "CbacMarkingRestrictionsUserSatisfiesMarkings", "CertificateInfo", "CertificateUsageType", - "ClassificationBannerDisplayType", "CreateGroupRequest", "CreateMarkingCategoryRequest", "CreateMarkingRequest", @@ -992,7 +881,6 @@ class UserSearchFilter(core.ModelBase): "HostName", "ListAuthenticationProvidersResponse", "ListAvailableOrganizationRolesResponse", - "ListCurrentGroupsResponse", "ListEnrollmentRoleAssignmentsResponse", "ListGroupMembersResponse", "ListGroupMembershipsResponse", @@ -1002,7 +890,6 @@ class UserSearchFilter(core.ModelBase): "ListMarkingMembersResponse", "ListMarkingRoleAssignmentsResponse", "ListMarkingsResponse", - "ListOrganizationGuestMembersResponse", "ListOrganizationRoleAssignmentsResponse", "ListUsersResponse", "Marking", @@ -1023,7 +910,6 @@ class UserSearchFilter(core.ModelBase): "MarkingType", "OidcAuthenticationProtocol", "Organization", - "OrganizationGuestMember", "OrganizationName", "OrganizationRoleAssignment", "PreregisterGroupRequest", @@ -1034,12 +920,9 @@ class UserSearchFilter(core.ModelBase): "RemoveGroupMembersRequest", "RemoveMarkingMembersRequest", "RemoveMarkingRoleAssignmentsRequest", - "RemoveOrganizationGuestMembersRequest", "RemoveOrganizationRoleAssignmentsRequest", "ReplaceGroupMembershipExpirationPolicyRequest", "ReplaceGroupProviderInfoRequest", - "ReplaceGroupRequest", - "ReplaceMarkingCategoryRequest", "ReplaceMarkingRequest", "ReplaceOrganizationRequest", "ReplaceUserProviderInfoRequest", diff --git a/foundry_sdk/v2/admin/organization.py b/foundry_sdk/v2/admin/organization.py index f6209d302..423e44165 100644 --- a/foundry_sdk/v2/admin/organization.py +++ b/foundry_sdk/v2/admin/organization.py @@ -67,18 +67,6 @@ def OrganizationRoleAssignment(self): config=self._config, ) - @cached_property - def OrganizationGuestMember(self): - from foundry_sdk.v2.admin.organization_guest_member import ( - OrganizationGuestMemberClient, - ) # NOQA - - return OrganizationGuestMemberClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -161,6 +149,7 @@ def get( self, organization_rid: core_models.OrganizationRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> admin_models.Organization: @@ -168,6 +157,8 @@ def get( Get the Organization with the specified rid. :param organization_rid: :type organization_rid: OrganizationRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -180,7 +171,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/admin/organizations/{organizationRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "organizationRid": organization_rid, }, @@ -204,6 +197,7 @@ def list_available_roles( self, organization_rid: core_models.OrganizationRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> admin_models.ListAvailableOrganizationRolesResponse: @@ -212,6 +206,8 @@ def list_available_roles( :param organization_rid: :type organization_rid: OrganizationRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -225,7 +221,9 @@ def list_available_roles( core.RequestInfo( method="GET", resource_path="/v2/admin/organizations/{organizationRid}/listAvailableRoles", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "organizationRid": organization_rid, }, @@ -253,6 +251,7 @@ def replace( name: admin_models.OrganizationName, description: typing.Optional[str] = None, host: typing.Optional[admin_models.HostName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> admin_models.Organization: @@ -266,6 +265,8 @@ def replace( :type description: Optional[str] :param host: The primary host name of the Organization. This should be used when constructing URLs for users of this Organization. :type host: Optional[HostName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -281,7 +282,9 @@ def replace( core.RequestInfo( method="PUT", resource_path="/v2/admin/organizations/{organizationRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "organizationRid": organization_rid, }, @@ -378,18 +381,6 @@ def OrganizationRoleAssignment(self): config=self._config, ) - @cached_property - def OrganizationGuestMember(self): - from foundry_sdk.v2.admin.organization_guest_member import ( - AsyncOrganizationGuestMemberClient, - ) # NOQA - - return AsyncOrganizationGuestMemberClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -472,6 +463,7 @@ def get( self, organization_rid: core_models.OrganizationRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[admin_models.Organization]: @@ -479,6 +471,8 @@ def get( Get the Organization with the specified rid. :param organization_rid: :type organization_rid: OrganizationRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -491,7 +485,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/admin/organizations/{organizationRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "organizationRid": organization_rid, }, @@ -515,6 +511,7 @@ def list_available_roles( self, organization_rid: core_models.OrganizationRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[admin_models.ListAvailableOrganizationRolesResponse]: @@ -523,6 +520,8 @@ def list_available_roles( :param organization_rid: :type organization_rid: OrganizationRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -536,7 +535,9 @@ def list_available_roles( core.RequestInfo( method="GET", resource_path="/v2/admin/organizations/{organizationRid}/listAvailableRoles", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "organizationRid": organization_rid, }, @@ -564,6 +565,7 @@ def replace( name: admin_models.OrganizationName, description: typing.Optional[str] = None, host: typing.Optional[admin_models.HostName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[admin_models.Organization]: @@ -577,6 +579,8 @@ def replace( :type description: Optional[str] :param host: The primary host name of the Organization. This should be used when constructing URLs for users of this Organization. :type host: Optional[HostName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -592,7 +596,9 @@ def replace( core.RequestInfo( method="PUT", resource_path="/v2/admin/organizations/{organizationRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "organizationRid": organization_rid, }, diff --git a/foundry_sdk/v2/admin/organization_guest_member.py b/foundry_sdk/v2/admin/organization_guest_member.py deleted file mode 100644 index 5747d37ff..000000000 --- a/foundry_sdk/v2/admin/organization_guest_member.py +++ /dev/null @@ -1,455 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.admin import errors as admin_errors -from foundry_sdk.v2.admin import models as admin_models -from foundry_sdk.v2.core import models as core_models - - -class OrganizationGuestMemberClient: - """ - The API client for the OrganizationGuestMember Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _OrganizationGuestMemberClientStreaming(self) - self.with_raw_response = _OrganizationGuestMemberClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def add( - self, - organization_rid: core_models.OrganizationRid, - *, - principal_ids: typing.List[core_models.PrincipalId], - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> None: - """ - Adds principals as guest members of an Organization. Attempting to add a primary member through this endpoint will not add the principal as a guest, but will still return a successful response. - - :param organization_rid: - :type organization_rid: OrganizationRid - :param principal_ids: - :type principal_ids: List[PrincipalId] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - - :raises AddOrganizationGuestMembersPermissionDenied: Could not add the OrganizationGuestMember. - :raises OrganizationNotFound: The given Organization could not be found. - :raises PrincipalNotFound: A principal (User or Group) with the given PrincipalId could not be found - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/admin/organizations/{organizationRid}/guestMembers/add", - query_params={ - "preview": preview, - }, - path_params={ - "organizationRid": organization_rid, - }, - header_params={ - "Content-Type": "application/json", - }, - body=admin_models.AddOrganizationGuestMembersRequest( - principal_ids=principal_ids, - ), - response_type=None, - request_timeout=request_timeout, - throwable_errors={ - "AddOrganizationGuestMembersPermissionDenied": admin_errors.AddOrganizationGuestMembersPermissionDenied, - "OrganizationNotFound": admin_errors.OrganizationNotFound, - "PrincipalNotFound": admin_errors.PrincipalNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def list( - self, - organization_rid: core_models.OrganizationRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.ListOrganizationGuestMembersResponse: - """ - Lists all guest members of an Organization. - - :param organization_rid: - :type organization_rid: OrganizationRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: admin_models.ListOrganizationGuestMembersResponse - - :raises ListOrganizationGuestMembersPermissionDenied: The provided token does not have permission to list guest members for this organization. - :raises OrganizationNotFound: The given Organization could not be found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/organizations/{organizationRid}/guestMembers", - query_params={ - "preview": preview, - }, - path_params={ - "organizationRid": organization_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=admin_models.ListOrganizationGuestMembersResponse, - request_timeout=request_timeout, - throwable_errors={ - "ListOrganizationGuestMembersPermissionDenied": admin_errors.ListOrganizationGuestMembersPermissionDenied, - "OrganizationNotFound": admin_errors.OrganizationNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def remove( - self, - organization_rid: core_models.OrganizationRid, - *, - principal_ids: typing.List[core_models.PrincipalId], - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> None: - """ - Removes principals from being guest members of an Organization. Attempting to remove a primary member through this endpoint will not remove the primary member, but will still return a successful response. - - :param organization_rid: - :type organization_rid: OrganizationRid - :param principal_ids: - :type principal_ids: List[PrincipalId] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - - :raises OrganizationNotFound: The given Organization could not be found. - :raises PrincipalNotFound: A principal (User or Group) with the given PrincipalId could not be found - :raises RemoveOrganizationGuestMembersPermissionDenied: Could not remove the OrganizationGuestMember. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/admin/organizations/{organizationRid}/guestMembers/remove", - query_params={ - "preview": preview, - }, - path_params={ - "organizationRid": organization_rid, - }, - header_params={ - "Content-Type": "application/json", - }, - body=admin_models.RemoveOrganizationGuestMembersRequest( - principal_ids=principal_ids, - ), - response_type=None, - request_timeout=request_timeout, - throwable_errors={ - "OrganizationNotFound": admin_errors.OrganizationNotFound, - "PrincipalNotFound": admin_errors.PrincipalNotFound, - "RemoveOrganizationGuestMembersPermissionDenied": admin_errors.RemoveOrganizationGuestMembersPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _OrganizationGuestMemberClientRaw: - def __init__(self, client: OrganizationGuestMemberClient) -> None: - def add(_: None): ... - def list(_: admin_models.ListOrganizationGuestMembersResponse): ... - def remove(_: None): ... - - self.add = core.with_raw_response(add, client.add) - self.list = core.with_raw_response(list, client.list) - self.remove = core.with_raw_response(remove, client.remove) - - -class _OrganizationGuestMemberClientStreaming: - def __init__(self, client: OrganizationGuestMemberClient) -> None: - def list(_: admin_models.ListOrganizationGuestMembersResponse): ... - - self.list = core.with_streaming_response(list, client.list) - - -class AsyncOrganizationGuestMemberClient: - """ - The API client for the OrganizationGuestMember Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncOrganizationGuestMemberClientStreaming(self) - self.with_raw_response = _AsyncOrganizationGuestMemberClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def add( - self, - organization_rid: core_models.OrganizationRid, - *, - principal_ids: typing.List[core_models.PrincipalId], - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[None]: - """ - Adds principals as guest members of an Organization. Attempting to add a primary member through this endpoint will not add the principal as a guest, but will still return a successful response. - - :param organization_rid: - :type organization_rid: OrganizationRid - :param principal_ids: - :type principal_ids: List[PrincipalId] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[None] - - :raises AddOrganizationGuestMembersPermissionDenied: Could not add the OrganizationGuestMember. - :raises OrganizationNotFound: The given Organization could not be found. - :raises PrincipalNotFound: A principal (User or Group) with the given PrincipalId could not be found - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/admin/organizations/{organizationRid}/guestMembers/add", - query_params={ - "preview": preview, - }, - path_params={ - "organizationRid": organization_rid, - }, - header_params={ - "Content-Type": "application/json", - }, - body=admin_models.AddOrganizationGuestMembersRequest( - principal_ids=principal_ids, - ), - response_type=None, - request_timeout=request_timeout, - throwable_errors={ - "AddOrganizationGuestMembersPermissionDenied": admin_errors.AddOrganizationGuestMembersPermissionDenied, - "OrganizationNotFound": admin_errors.OrganizationNotFound, - "PrincipalNotFound": admin_errors.PrincipalNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def list( - self, - organization_rid: core_models.OrganizationRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[admin_models.ListOrganizationGuestMembersResponse]: - """ - Lists all guest members of an Organization. - - :param organization_rid: - :type organization_rid: OrganizationRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[admin_models.ListOrganizationGuestMembersResponse] - - :raises ListOrganizationGuestMembersPermissionDenied: The provided token does not have permission to list guest members for this organization. - :raises OrganizationNotFound: The given Organization could not be found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/organizations/{organizationRid}/guestMembers", - query_params={ - "preview": preview, - }, - path_params={ - "organizationRid": organization_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=admin_models.ListOrganizationGuestMembersResponse, - request_timeout=request_timeout, - throwable_errors={ - "ListOrganizationGuestMembersPermissionDenied": admin_errors.ListOrganizationGuestMembersPermissionDenied, - "OrganizationNotFound": admin_errors.OrganizationNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def remove( - self, - organization_rid: core_models.OrganizationRid, - *, - principal_ids: typing.List[core_models.PrincipalId], - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[None]: - """ - Removes principals from being guest members of an Organization. Attempting to remove a primary member through this endpoint will not remove the primary member, but will still return a successful response. - - :param organization_rid: - :type organization_rid: OrganizationRid - :param principal_ids: - :type principal_ids: List[PrincipalId] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[None] - - :raises OrganizationNotFound: The given Organization could not be found. - :raises PrincipalNotFound: A principal (User or Group) with the given PrincipalId could not be found - :raises RemoveOrganizationGuestMembersPermissionDenied: Could not remove the OrganizationGuestMember. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/admin/organizations/{organizationRid}/guestMembers/remove", - query_params={ - "preview": preview, - }, - path_params={ - "organizationRid": organization_rid, - }, - header_params={ - "Content-Type": "application/json", - }, - body=admin_models.RemoveOrganizationGuestMembersRequest( - principal_ids=principal_ids, - ), - response_type=None, - request_timeout=request_timeout, - throwable_errors={ - "OrganizationNotFound": admin_errors.OrganizationNotFound, - "PrincipalNotFound": admin_errors.PrincipalNotFound, - "RemoveOrganizationGuestMembersPermissionDenied": admin_errors.RemoveOrganizationGuestMembersPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _AsyncOrganizationGuestMemberClientRaw: - def __init__(self, client: AsyncOrganizationGuestMemberClient) -> None: - def add(_: None): ... - def list(_: admin_models.ListOrganizationGuestMembersResponse): ... - def remove(_: None): ... - - self.add = core.async_with_raw_response(add, client.add) - self.list = core.async_with_raw_response(list, client.list) - self.remove = core.async_with_raw_response(remove, client.remove) - - -class _AsyncOrganizationGuestMemberClientStreaming: - def __init__(self, client: AsyncOrganizationGuestMemberClient) -> None: - def list(_: admin_models.ListOrganizationGuestMembersResponse): ... - - self.list = core.async_with_streaming_response(list, client.list) diff --git a/foundry_sdk/v2/admin/organization_role_assignment.py b/foundry_sdk/v2/admin/organization_role_assignment.py index aab335fbe..da7cccf32 100644 --- a/foundry_sdk/v2/admin/organization_role_assignment.py +++ b/foundry_sdk/v2/admin/organization_role_assignment.py @@ -62,6 +62,7 @@ def add( organization_rid: core_models.OrganizationRid, *, role_assignments: typing.List[core_models.RoleAssignmentUpdate], + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> None: @@ -72,6 +73,8 @@ def add( :type organization_rid: OrganizationRid :param role_assignments: :type role_assignments: List[RoleAssignmentUpdate] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -86,7 +89,9 @@ def add( core.RequestInfo( method="POST", resource_path="/v2/admin/organizations/{organizationRid}/roleAssignments/add", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "organizationRid": organization_rid, }, @@ -114,6 +119,7 @@ def list( self, organization_rid: core_models.OrganizationRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> admin_models.ListOrganizationRoleAssignmentsResponse: @@ -122,6 +128,8 @@ def list( :param organization_rid: :type organization_rid: OrganizationRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -135,7 +143,9 @@ def list( core.RequestInfo( method="GET", resource_path="/v2/admin/organizations/{organizationRid}/roleAssignments", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "organizationRid": organization_rid, }, @@ -161,6 +171,7 @@ def remove( organization_rid: core_models.OrganizationRid, *, role_assignments: typing.List[core_models.RoleAssignmentUpdate], + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> None: @@ -171,6 +182,8 @@ def remove( :type organization_rid: OrganizationRid :param role_assignments: :type role_assignments: List[RoleAssignmentUpdate] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -185,7 +198,9 @@ def remove( core.RequestInfo( method="POST", resource_path="/v2/admin/organizations/{organizationRid}/roleAssignments/remove", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "organizationRid": organization_rid, }, @@ -262,6 +277,7 @@ def add( organization_rid: core_models.OrganizationRid, *, role_assignments: typing.List[core_models.RoleAssignmentUpdate], + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[None]: @@ -272,6 +288,8 @@ def add( :type organization_rid: OrganizationRid :param role_assignments: :type role_assignments: List[RoleAssignmentUpdate] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -286,7 +304,9 @@ def add( core.RequestInfo( method="POST", resource_path="/v2/admin/organizations/{organizationRid}/roleAssignments/add", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "organizationRid": organization_rid, }, @@ -314,6 +334,7 @@ def list( self, organization_rid: core_models.OrganizationRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[admin_models.ListOrganizationRoleAssignmentsResponse]: @@ -322,6 +343,8 @@ def list( :param organization_rid: :type organization_rid: OrganizationRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -335,7 +358,9 @@ def list( core.RequestInfo( method="GET", resource_path="/v2/admin/organizations/{organizationRid}/roleAssignments", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "organizationRid": organization_rid, }, @@ -361,6 +386,7 @@ def remove( organization_rid: core_models.OrganizationRid, *, role_assignments: typing.List[core_models.RoleAssignmentUpdate], + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[None]: @@ -371,6 +397,8 @@ def remove( :type organization_rid: OrganizationRid :param role_assignments: :type role_assignments: List[RoleAssignmentUpdate] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -385,7 +413,9 @@ def remove( core.RequestInfo( method="POST", resource_path="/v2/admin/organizations/{organizationRid}/roleAssignments/remove", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "organizationRid": organization_rid, }, diff --git a/foundry_sdk/v2/admin/user.py b/foundry_sdk/v2/admin/user.py index 0093fee5d..90b2ba820 100644 --- a/foundry_sdk/v2/admin/user.py +++ b/foundry_sdk/v2/admin/user.py @@ -262,6 +262,7 @@ def get_markings( self, user_id: core_models.UserId, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> admin_models.GetUserMarkingsResponse: @@ -269,6 +270,8 @@ def get_markings( Retrieve Markings that the user is currently a member of. :param user_id: :type user_id: UserId + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -283,7 +286,9 @@ def get_markings( core.RequestInfo( method="GET", resource_path="/v2/admin/users/{userId}/getMarkings", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "userId": user_id, }, @@ -415,6 +420,7 @@ def revoke_all_tokens( self, user_id: core_models.UserId, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> None: @@ -426,6 +432,8 @@ def revoke_all_tokens( :param user_id: :type user_id: UserId + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -440,7 +448,9 @@ def revoke_all_tokens( core.RequestInfo( method="POST", resource_path="/v2/admin/users/{userId}/revokeAllTokens", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "userId": user_id, }, @@ -470,8 +480,7 @@ def search( _sdk_internal: core.SdkInternal = {}, ) -> admin_models.SearchUsersResponse: """ - Perform a case-insensitive prefix search for active users based on username, given name and family name. - Deleted users are not included in results. To list deleted users, use the `list` endpoint with `include=DELETED`. + Perform a case-insensitive prefix search for users based on username, given name and family name. :param where: :type where: UserSearchFilter @@ -790,6 +799,7 @@ def get_markings( self, user_id: core_models.UserId, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[admin_models.GetUserMarkingsResponse]: @@ -797,6 +807,8 @@ def get_markings( Retrieve Markings that the user is currently a member of. :param user_id: :type user_id: UserId + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -811,7 +823,9 @@ def get_markings( core.RequestInfo( method="GET", resource_path="/v2/admin/users/{userId}/getMarkings", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "userId": user_id, }, @@ -943,6 +957,7 @@ def revoke_all_tokens( self, user_id: core_models.UserId, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[None]: @@ -954,6 +969,8 @@ def revoke_all_tokens( :param user_id: :type user_id: UserId + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -968,7 +985,9 @@ def revoke_all_tokens( core.RequestInfo( method="POST", resource_path="/v2/admin/users/{userId}/revokeAllTokens", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "userId": user_id, }, @@ -998,8 +1017,7 @@ def search( _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[admin_models.SearchUsersResponse]: """ - Perform a case-insensitive prefix search for active users based on username, given name and family name. - Deleted users are not included in results. To list deleted users, use the `list` endpoint with `include=DELETED`. + Perform a case-insensitive prefix search for users based on username, given name and family name. :param where: :type where: UserSearchFilter diff --git a/foundry_sdk/v2/admin/user_provider_info.py b/foundry_sdk/v2/admin/user_provider_info.py index 4858e5dec..25402b5f8 100644 --- a/foundry_sdk/v2/admin/user_provider_info.py +++ b/foundry_sdk/v2/admin/user_provider_info.py @@ -61,6 +61,7 @@ def get( self, user_id: core_models.UserId, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> admin_models.UserProviderInfo: @@ -68,6 +69,8 @@ def get( Get the UserProviderInfo. :param user_id: :type user_id: UserId + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -83,7 +86,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/admin/users/{userId}/providerInfo", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "userId": user_id, }, @@ -111,6 +116,7 @@ def replace( user_id: core_models.UserId, *, provider_id: admin_models.ProviderId, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> admin_models.UserProviderInfo: @@ -120,6 +126,8 @@ def replace( :type user_id: UserId :param provider_id: The ID of the User in the external authentication provider. This value is determined by the authentication provider. At most one User can have a given provider ID in a given Realm. :type provider_id: ProviderId + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -137,7 +145,9 @@ def replace( core.RequestInfo( method="PUT", resource_path="/v2/admin/users/{userId}/providerInfo", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "userId": user_id, }, @@ -217,6 +227,7 @@ def get( self, user_id: core_models.UserId, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[admin_models.UserProviderInfo]: @@ -224,6 +235,8 @@ def get( Get the UserProviderInfo. :param user_id: :type user_id: UserId + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -239,7 +252,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/admin/users/{userId}/providerInfo", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "userId": user_id, }, @@ -267,6 +282,7 @@ def replace( user_id: core_models.UserId, *, provider_id: admin_models.ProviderId, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[admin_models.UserProviderInfo]: @@ -276,6 +292,8 @@ def replace( :type user_id: UserId :param provider_id: The ID of the User in the external authentication provider. This value is determined by the authentication provider. At most one User can have a given provider ID in a given Realm. :type provider_id: ProviderId + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -293,7 +311,9 @@ def replace( core.RequestInfo( method="PUT", resource_path="/v2/admin/users/{userId}/providerInfo", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "userId": user_id, }, diff --git a/foundry_sdk/v2/aip_agents/agent.py b/foundry_sdk/v2/aip_agents/agent.py index 99d1b5c19..1613b64fc 100644 --- a/foundry_sdk/v2/aip_agents/agent.py +++ b/foundry_sdk/v2/aip_agents/agent.py @@ -143,8 +143,8 @@ def get( _sdk_internal: core.SdkInternal = {}, ) -> aip_agents_models.Agent: """ - Get details for an Agent. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + Get details for an AIP Agent. + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -158,7 +158,7 @@ def get( :raises AgentNotFound: The given Agent could not be found. :raises AgentVersionNotFound: The given AgentVersion could not be found. :raises InvalidAgentVersion: The provided version string is not a valid format for an Agent version. - :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Chatbot Studio to use the latest published version, or specify the version of the Agent to use. + :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Agent Studio to use the latest published version, or specify the version of the Agent to use. """ return self._api_client.call_api( @@ -324,8 +324,8 @@ def get( _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[aip_agents_models.Agent]: """ - Get details for an Agent. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + Get details for an AIP Agent. + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -339,7 +339,7 @@ def get( :raises AgentNotFound: The given Agent could not be found. :raises AgentVersionNotFound: The given AgentVersion could not be found. :raises InvalidAgentVersion: The provided version string is not a valid format for an Agent version. - :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Chatbot Studio to use the latest published version, or specify the version of the Agent to use. + :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Agent Studio to use the latest published version, or specify the version of the Agent to use. """ return self._api_client.call_api( diff --git a/foundry_sdk/v2/aip_agents/agent_version.py b/foundry_sdk/v2/aip_agents/agent_version.py index 2a2380024..1bf6d2659 100644 --- a/foundry_sdk/v2/aip_agents/agent_version.py +++ b/foundry_sdk/v2/aip_agents/agent_version.py @@ -67,8 +67,8 @@ def get( _sdk_internal: core.SdkInternal = {}, ) -> aip_agents_models.AgentVersion: """ - Get version details for an Agent. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + Get version details for an AIP Agent. + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param agent_version_string: The semantic version of the Agent, formatted as "majorVersion.minorVersion". :type agent_version_string: AgentVersionString @@ -82,7 +82,7 @@ def get( :raises AgentNotFound: The given Agent could not be found. :raises AgentVersionNotFound: The given AgentVersion could not be found. :raises InvalidAgentVersion: The provided version string is not a valid format for an Agent version. - :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Chatbot Studio to use the latest published version, or specify the version of the Agent to use. + :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Agent Studio to use the latest published version, or specify the version of the Agent to use. """ return self._api_client.call_api( @@ -126,10 +126,10 @@ def list( _sdk_internal: core.SdkInternal = {}, ) -> core.ResourceIterator[aip_agents_models.AgentVersion]: """ - List all versions for an Agent. + List all versions for an AIP Agent. Versions are returned in descending order, by most recent versions first. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param page_size: The page size to use for the endpoint. :type page_size: Optional[PageSize] @@ -231,8 +231,8 @@ def get( _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[aip_agents_models.AgentVersion]: """ - Get version details for an Agent. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + Get version details for an AIP Agent. + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param agent_version_string: The semantic version of the Agent, formatted as "majorVersion.minorVersion". :type agent_version_string: AgentVersionString @@ -246,7 +246,7 @@ def get( :raises AgentNotFound: The given Agent could not be found. :raises AgentVersionNotFound: The given AgentVersion could not be found. :raises InvalidAgentVersion: The provided version string is not a valid format for an Agent version. - :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Chatbot Studio to use the latest published version, or specify the version of the Agent to use. + :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Agent Studio to use the latest published version, or specify the version of the Agent to use. """ return self._api_client.call_api( @@ -290,10 +290,10 @@ def list( _sdk_internal: core.SdkInternal = {}, ) -> core.AsyncResourceIterator[aip_agents_models.AgentVersion]: """ - List all versions for an Agent. + List all versions for an AIP Agent. Versions are returned in descending order, by most recent versions first. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param page_size: The page size to use for the endpoint. :type page_size: Optional[PageSize] diff --git a/foundry_sdk/v2/aip_agents/content.py b/foundry_sdk/v2/aip_agents/content.py index 088b9b7fb..00dd3445d 100644 --- a/foundry_sdk/v2/aip_agents/content.py +++ b/foundry_sdk/v2/aip_agents/content.py @@ -68,7 +68,7 @@ def get( ) -> aip_agents_models.Content: """ Get the conversation content for a session between the calling user and an Agent. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid @@ -168,7 +168,7 @@ def get( ) -> typing.Awaitable[aip_agents_models.Content]: """ Get the conversation content for a session between the calling user and an Agent. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid diff --git a/foundry_sdk/v2/aip_agents/errors.py b/foundry_sdk/v2/aip_agents/errors.py index 11d5d62c2..8bc4fe3df 100644 --- a/foundry_sdk/v2/aip_agents/errors.py +++ b/foundry_sdk/v2/aip_agents/errors.py @@ -28,7 +28,7 @@ class AgentIterationsExceededLimitParameters(typing_extensions.TypedDict): """ The Agent was unable to produce an answer in the set number of maximum iterations. This can happen if the Agent gets confused or stuck in a loop, or if the query is too complex. - Try a different query or review the Agent configuration in AIP Chatbot Studio. + Try a different query or review the Agent configuration in AIP Agent Studio. """ __pydantic_config__ = {"extra": "allow"} # type: ignore @@ -52,7 +52,7 @@ class AgentNotFoundParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" @dataclass @@ -68,7 +68,7 @@ class AgentVersionNotFoundParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" agentVersionString: aip_agents_models.AgentVersionString """The semantic version of the Agent, formatted as "majorVersion.minorVersion".""" @@ -87,7 +87,7 @@ class BlockingContinueSessionPermissionDeniedParameters(typing_extensions.TypedD __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" @@ -135,7 +135,7 @@ class CancelSessionPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" @@ -154,7 +154,7 @@ class ContentNotFoundParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" @@ -194,7 +194,7 @@ class CreateSessionPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" @dataclass @@ -210,7 +210,7 @@ class DeleteSessionPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" @@ -268,7 +268,7 @@ class GetRagContextForSessionPermissionDeniedParameters(typing_extensions.TypedD __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" @@ -300,7 +300,7 @@ class InvalidAgentVersion(errors.BadRequestError): class InvalidParameterParameters(typing_extensions.TypedDict): """ The provided application variable is not valid for the Agent for this session. - Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Chatbot Studio. + Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Agent Studio. The Agent version used for the session can be checked through the API with `getSession`. """ @@ -321,7 +321,7 @@ class InvalidParameter(errors.BadRequestError): class InvalidParameterTypeParameters(typing_extensions.TypedDict): """ The provided value does not match the expected type for the application variable configured on the Agent for this session. - Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Chatbot Studio. + Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Agent Studio. The Agent version used for the session can be checked through the API with `getSession`. """ @@ -357,7 +357,7 @@ class ListSessionsForAgentsPermissionDenied(errors.PermissionDeniedError): class NoPublishedAgentVersionParameters(typing_extensions.TypedDict): """ Failed to retrieve the latest published version of the Agent because the Agent has no published versions. - Try publishing the Agent in AIP Chatbot Studio to use the latest published version, or specify the version of the Agent to use. + Try publishing the Agent in AIP Agent Studio to use the latest published version, or specify the version of the Agent to use. """ __pydantic_config__ = {"extra": "allow"} # type: ignore @@ -523,7 +523,7 @@ class SessionNotFoundParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" @@ -562,7 +562,7 @@ class SessionTraceNotFoundParameters(typing_extensions.TypedDict): """The unique identifier for the trace.""" agentRid: aip_agents_models.AgentRid - """An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" @@ -581,7 +581,7 @@ class StreamingContinueSessionPermissionDeniedParameters(typing_extensions.Typed __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" @@ -600,7 +600,7 @@ class UpdateSessionTitlePermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" diff --git a/foundry_sdk/v2/aip_agents/models.py b/foundry_sdk/v2/aip_agents/models.py index e93593e7e..60ad77bfd 100644 --- a/foundry_sdk/v2/aip_agents/models.py +++ b/foundry_sdk/v2/aip_agents/models.py @@ -30,7 +30,7 @@ class Agent(core.ModelBase): """Agent""" rid: AgentRid - """An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" version: AgentVersionString """The version of this instance of the Agent.""" @@ -38,7 +38,7 @@ class Agent(core.ModelBase): metadata: AgentMetadata parameters: typing.Dict[ParameterId, Parameter] """ - The types and names of variables configured for the Agent in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/) in the [application state](https://palantir.com/docs/foundry/chatbot-studio/application-state/). + The types and names of variables configured for the Agent in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/) in the [application state](https://palantir.com/docs/foundry/agent-studio/application-state/). These variables can be used to send custom values in prompts sent to an Agent to customize and control the Agent's behavior. """ @@ -64,7 +64,7 @@ class AgentMetadata(core.ModelBase): AgentRid = core.RID -"""An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" +"""An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" class AgentSessionRagContextResponse(core.ModelBase): @@ -120,11 +120,11 @@ class BlockingContinueSessionRequest(core.ModelBase): """The user message for the Agent to respond to.""" parameter_inputs: typing.Dict[ParameterId, ParameterValue] = pydantic.Field(alias=str("parameterInputs")) # type: ignore[literal-required] - """Any supplied values for [application variables](https://palantir.com/docs/foundry/chatbot-studio/application-state/) to pass to the Agent for the exchange.""" + """Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange.""" contexts_override: typing.Optional[typing.List[InputContext]] = pydantic.Field(alias=str("contextsOverride"), default=None) # type: ignore[literal-required] """ - If set, automatic [context retrieval](https://palantir.com/docs/foundry/chatbot-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. + If set, automatic [context retrieval](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. """ @@ -216,13 +216,13 @@ class GetRagContextForSessionRequest(core.ModelBase): """The user message to retrieve relevant context for from the configured Agent data sources.""" parameter_inputs: typing.Dict[ParameterId, ParameterValue] = pydantic.Field(alias=str("parameterInputs")) # type: ignore[literal-required] - """Any values for [application variables](https://palantir.com/docs/foundry/chatbot-studio/application-state/) to use for the context retrieval.""" + """Any values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to use for the context retrieval.""" InputContext = typing_extensions.Annotated[ typing.Union["FunctionRetrievedContext", "ObjectContext"], pydantic.Field(discriminator="type") ] -"""Custom retrieved [context](https://palantir.com/docs/foundry/chatbot-studio/retrieval-context/) to provide to an Agent for continuing a session.""" +"""Custom retrieved [context](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) to provide to an Agent for continuing a session.""" class ListAgentVersionsResponse(core.ModelBase): @@ -288,7 +288,7 @@ class ObjectSetParameterValueUpdate(core.ModelBase): class Parameter(core.ModelBase): - """A variable configured in the application state of an Agent in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" + """A variable configured in the application state of an Agent in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" parameter_type: ParameterType = pydantic.Field(alias=str("parameterType")) # type: ignore[literal-required] """Details of the types of values accepted and defaults for this variable.""" @@ -311,7 +311,7 @@ class Parameter(core.ModelBase): ParameterId = str -"""The unique identifier for a variable configured in the application state of an Agent in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/).""" +"""The unique identifier for a variable configured in the application state of an Agent in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" ParameterType = typing_extensions.Annotated[ @@ -324,7 +324,7 @@ class Parameter(core.ModelBase): typing.Union["StringParameterValue", "ObjectSetParameterValue"], pydantic.Field(discriminator="type"), ] -"""The value provided for a variable configured in the [application state](https://palantir.com/docs/foundry/chatbot-studio/application-state/) of an Agent.""" +"""The value provided for a variable configured in the [application state](https://palantir.com/docs/foundry/agent-studio/application-state/) of an Agent.""" ParameterValueUpdate = typing_extensions.Annotated[ @@ -332,7 +332,7 @@ class Parameter(core.ModelBase): pydantic.Field(discriminator="type"), ] """ -A value update for an [application variable](https://palantir.com/docs/foundry/chatbot-studio/application-state/) generated by the Agent. +A value update for an [application variable](https://palantir.com/docs/foundry/agent-studio/application-state/) generated by the Agent. For `StringParameter` types, this will be the updated string value. For `ObjectSetParameter` types, this will be a Resource Identifier (RID) for the updated object set. """ @@ -408,7 +408,7 @@ class SessionExchangeResult(core.ModelBase): parameter_updates: typing.Dict[ParameterId, ParameterValueUpdate] = pydantic.Field(alias=str("parameterUpdates")) # type: ignore[literal-required] """ Any updates to application variable values which were generated by the Agent for this exchange. - Updates can only be generated for application variables configured with `READ_WRITE` access on the Agent in AIP Chatbot Studio. + Updates can only be generated for application variables configured with `READ_WRITE` access on the Agent in AIP Agent Studio. """ total_tokens_used: typing.Optional[int] = pydantic.Field(alias=str("totalTokensUsed"), default=None) # type: ignore[literal-required] @@ -503,11 +503,11 @@ class StreamingContinueSessionRequest(core.ModelBase): """The user message for the Agent to respond to.""" parameter_inputs: typing.Dict[ParameterId, ParameterValue] = pydantic.Field(alias=str("parameterInputs")) # type: ignore[literal-required] - """Any supplied values for [application variables](https://palantir.com/docs/foundry/chatbot-studio/application-state/) to pass to the Agent for the exchange.""" + """Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange.""" contexts_override: typing.Optional[typing.List[InputContext]] = pydantic.Field(alias=str("contextsOverride"), default=None) # type: ignore[literal-required] """ - If set, automatic [context](https://palantir.com/docs/foundry/chatbot-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. + If set, automatic [context](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. """ diff --git a/foundry_sdk/v2/aip_agents/session.py b/foundry_sdk/v2/aip_agents/session.py index 7e56032fd..039b8661a 100644 --- a/foundry_sdk/v2/aip_agents/session.py +++ b/foundry_sdk/v2/aip_agents/session.py @@ -101,15 +101,15 @@ def blocking_continue( Concurrent requests to continue the same session are not supported. Clients should wait to receive a response before sending the next message. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid - :param parameter_inputs: Any supplied values for [application variables](https://palantir.com/docs/foundry/chatbot-studio/application-state/) to pass to the Agent for the exchange. + :param parameter_inputs: Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. :type parameter_inputs: Dict[ParameterId, ParameterValue] :param user_input: The user message for the Agent to respond to. :type user_input: UserTextInput - :param contexts_override: If set, automatic [context retrieval](https://palantir.com/docs/foundry/chatbot-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. + :param contexts_override: If set, automatic [context retrieval](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. :type contexts_override: Optional[List[InputContext]] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -120,13 +120,13 @@ def blocking_continue( :return: Returns the result object. :rtype: aip_agents_models.SessionExchangeResult - :raises AgentIterationsExceededLimit: The Agent was unable to produce an answer in the set number of maximum iterations. This can happen if the Agent gets confused or stuck in a loop, or if the query is too complex. Try a different query or review the Agent configuration in AIP Chatbot Studio. + :raises AgentIterationsExceededLimit: The Agent was unable to produce an answer in the set number of maximum iterations. This can happen if the Agent gets confused or stuck in a loop, or if the query is too complex. Try a different query or review the Agent configuration in AIP Agent Studio. :raises AgentNotFound: The given Agent could not be found. :raises BlockingContinueSessionPermissionDenied: Could not blockingContinue the Session. :raises ContextSizeExceededLimit: Failed to generate a response for a session because the context size of the LLM has been exceeded. Clients should either retry with a shorter message or create a new session and try re-sending the message. :raises FunctionLocatorNotFound: The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access. - :raises InvalidParameter: The provided application variable is not valid for the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with `getSession`. - :raises InvalidParameterType: The provided value does not match the expected type for the application variable configured on the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with `getSession`. + :raises InvalidParameter: The provided application variable is not valid for the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Agent Studio. The Agent version used for the session can be checked through the API with `getSession`. + :raises InvalidParameterType: The provided value does not match the expected type for the application variable configured on the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Agent Studio. The Agent version used for the session can be checked through the API with `getSession`. :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises OntologyEntitiesNotFound: Some ontology types are configured for use by the Agent but could not be found. The types either do not exist or the client token does not have access. Object types and their link types can be checked by listing available object/link types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). @@ -202,7 +202,7 @@ def cancel( Canceling an exchange allows clients to prevent the exchange from being added to the session, or to provide a response to replace the Agent-generated response. Note that canceling an exchange does not terminate the stream returned by `streamingContinue`; clients should close the stream on triggering the cancellation request to stop reading from the stream. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid @@ -270,7 +270,7 @@ def create( Create a new conversation session between the calling user and an Agent. Use `blockingContinue` or `streamingContinue` to start adding exchanges to the session. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param agent_version: The version of the Agent associated with the session. This can be set by clients on session creation. If not specified, defaults to use the latest published version of the Agent at session creation time. :type agent_version: Optional[AgentVersionString] @@ -286,7 +286,7 @@ def create( :raises CreateSessionPermissionDenied: Could not create the Session. :raises FunctionLocatorNotFound: The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access. :raises InvalidAgentVersion: The provided version string is not a valid format for an Agent version. - :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Chatbot Studio to use the latest published version, or specify the version of the Agent to use. + :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Agent Studio to use the latest published version, or specify the version of the Agent to use. :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises OntologyEntitiesNotFound: Some ontology types are configured for use by the Agent but could not be found. The types either do not exist or the client token does not have access. Object types and their link types can be checked by listing available object/link types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). @@ -344,7 +344,7 @@ def delete( Delete a conversation session between the calling user and an Agent. Once deleted, the session can no longer be accessed and will not appear in session lists. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid @@ -398,7 +398,7 @@ def get( ) -> aip_agents_models.Session: """ Get the details of a conversation session between the calling user and an Agent. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid @@ -454,10 +454,10 @@ def list( """ List all conversation sessions between the calling user and an Agent that was created by this client. This does not list sessions for the user created by other clients. - For example, any sessions created by the user in AIP Chatbot Studio will not be listed here. + For example, any sessions created by the user in AIP Agent Studio will not be listed here. Sessions are returned in order of most recently updated first. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param page_size: The page size to use for the endpoint. :type page_size: Optional[PageSize] @@ -515,14 +515,14 @@ def rag_context( _sdk_internal: core.SdkInternal = {}, ) -> aip_agents_models.AgentSessionRagContextResponse: """ - Retrieve relevant [context](https://palantir.com/docs/foundry/chatbot-studio/core-concepts/#retrieval-context) for a user message from the data sources configured for the session. + Retrieve relevant [context](https://palantir.com/docs/foundry/agent-studio/core-concepts/#retrieval-context) for a user message from the data sources configured for the session. This allows clients to pre-retrieve context for a user message before sending it to the Agent with the `contextsOverride` option when continuing a session, to allow any pre-processing of the context before sending it to the Agent. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid - :param parameter_inputs: Any values for [application variables](https://palantir.com/docs/foundry/chatbot-studio/application-state/) to use for the context retrieval. + :param parameter_inputs: Any values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to use for the context retrieval. :type parameter_inputs: Dict[ParameterId, ParameterValue] :param user_input: The user message to retrieve relevant context for from the configured Agent data sources. :type user_input: UserTextInput @@ -604,15 +604,15 @@ def streaming_continue( Concurrent requests to continue the same session are not supported. Clients should wait to receive a response, or cancel the in-progress exchange, before sending the next message. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid - :param parameter_inputs: Any supplied values for [application variables](https://palantir.com/docs/foundry/chatbot-studio/application-state/) to pass to the Agent for the exchange. + :param parameter_inputs: Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. :type parameter_inputs: Dict[ParameterId, ParameterValue] :param user_input: The user message for the Agent to respond to. :type user_input: UserTextInput - :param contexts_override: If set, automatic [context](https://palantir.com/docs/foundry/chatbot-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. + :param contexts_override: If set, automatic [context](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. :type contexts_override: Optional[List[InputContext]] :param message_id: A client-generated Universally Unique Identifier (UUID) to identify the message, which the client can use to cancel the exchange before the streaming response is complete. :type message_id: Optional[MessageId] @@ -627,8 +627,8 @@ def streaming_continue( :raises AgentNotFound: The given Agent could not be found. :raises FunctionLocatorNotFound: The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access. - :raises InvalidParameter: The provided application variable is not valid for the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with `getSession`. - :raises InvalidParameterType: The provided value does not match the expected type for the application variable configured on the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with `getSession`. + :raises InvalidParameter: The provided application variable is not valid for the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Agent Studio. The Agent version used for the session can be checked through the API with `getSession`. + :raises InvalidParameterType: The provided value does not match the expected type for the application variable configured on the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Agent Studio. The Agent version used for the session can be checked through the API with `getSession`. :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises OntologyEntitiesNotFound: Some ontology types are configured for use by the Agent but could not be found. The types either do not exist or the client token does not have access. Object types and their link types can be checked by listing available object/link types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). @@ -694,7 +694,7 @@ def update_title( Update the title for a session. Use this to set a custom title for a session to help identify it in the list of sessions with an Agent. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid @@ -864,15 +864,15 @@ def blocking_continue( Concurrent requests to continue the same session are not supported. Clients should wait to receive a response before sending the next message. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid - :param parameter_inputs: Any supplied values for [application variables](https://palantir.com/docs/foundry/chatbot-studio/application-state/) to pass to the Agent for the exchange. + :param parameter_inputs: Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. :type parameter_inputs: Dict[ParameterId, ParameterValue] :param user_input: The user message for the Agent to respond to. :type user_input: UserTextInput - :param contexts_override: If set, automatic [context retrieval](https://palantir.com/docs/foundry/chatbot-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. + :param contexts_override: If set, automatic [context retrieval](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. :type contexts_override: Optional[List[InputContext]] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -883,13 +883,13 @@ def blocking_continue( :return: Returns the result object. :rtype: typing.Awaitable[aip_agents_models.SessionExchangeResult] - :raises AgentIterationsExceededLimit: The Agent was unable to produce an answer in the set number of maximum iterations. This can happen if the Agent gets confused or stuck in a loop, or if the query is too complex. Try a different query or review the Agent configuration in AIP Chatbot Studio. + :raises AgentIterationsExceededLimit: The Agent was unable to produce an answer in the set number of maximum iterations. This can happen if the Agent gets confused or stuck in a loop, or if the query is too complex. Try a different query or review the Agent configuration in AIP Agent Studio. :raises AgentNotFound: The given Agent could not be found. :raises BlockingContinueSessionPermissionDenied: Could not blockingContinue the Session. :raises ContextSizeExceededLimit: Failed to generate a response for a session because the context size of the LLM has been exceeded. Clients should either retry with a shorter message or create a new session and try re-sending the message. :raises FunctionLocatorNotFound: The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access. - :raises InvalidParameter: The provided application variable is not valid for the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with `getSession`. - :raises InvalidParameterType: The provided value does not match the expected type for the application variable configured on the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with `getSession`. + :raises InvalidParameter: The provided application variable is not valid for the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Agent Studio. The Agent version used for the session can be checked through the API with `getSession`. + :raises InvalidParameterType: The provided value does not match the expected type for the application variable configured on the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Agent Studio. The Agent version used for the session can be checked through the API with `getSession`. :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises OntologyEntitiesNotFound: Some ontology types are configured for use by the Agent but could not be found. The types either do not exist or the client token does not have access. Object types and their link types can be checked by listing available object/link types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). @@ -965,7 +965,7 @@ def cancel( Canceling an exchange allows clients to prevent the exchange from being added to the session, or to provide a response to replace the Agent-generated response. Note that canceling an exchange does not terminate the stream returned by `streamingContinue`; clients should close the stream on triggering the cancellation request to stop reading from the stream. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid @@ -1033,7 +1033,7 @@ def create( Create a new conversation session between the calling user and an Agent. Use `blockingContinue` or `streamingContinue` to start adding exchanges to the session. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param agent_version: The version of the Agent associated with the session. This can be set by clients on session creation. If not specified, defaults to use the latest published version of the Agent at session creation time. :type agent_version: Optional[AgentVersionString] @@ -1049,7 +1049,7 @@ def create( :raises CreateSessionPermissionDenied: Could not create the Session. :raises FunctionLocatorNotFound: The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access. :raises InvalidAgentVersion: The provided version string is not a valid format for an Agent version. - :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Chatbot Studio to use the latest published version, or specify the version of the Agent to use. + :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Agent Studio to use the latest published version, or specify the version of the Agent to use. :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises OntologyEntitiesNotFound: Some ontology types are configured for use by the Agent but could not be found. The types either do not exist or the client token does not have access. Object types and their link types can be checked by listing available object/link types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). @@ -1107,7 +1107,7 @@ def delete( Delete a conversation session between the calling user and an Agent. Once deleted, the session can no longer be accessed and will not appear in session lists. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid @@ -1161,7 +1161,7 @@ def get( ) -> typing.Awaitable[aip_agents_models.Session]: """ Get the details of a conversation session between the calling user and an Agent. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid @@ -1217,10 +1217,10 @@ def list( """ List all conversation sessions between the calling user and an Agent that was created by this client. This does not list sessions for the user created by other clients. - For example, any sessions created by the user in AIP Chatbot Studio will not be listed here. + For example, any sessions created by the user in AIP Agent Studio will not be listed here. Sessions are returned in order of most recently updated first. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param page_size: The page size to use for the endpoint. :type page_size: Optional[PageSize] @@ -1278,14 +1278,14 @@ def rag_context( _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[aip_agents_models.AgentSessionRagContextResponse]: """ - Retrieve relevant [context](https://palantir.com/docs/foundry/chatbot-studio/core-concepts/#retrieval-context) for a user message from the data sources configured for the session. + Retrieve relevant [context](https://palantir.com/docs/foundry/agent-studio/core-concepts/#retrieval-context) for a user message from the data sources configured for the session. This allows clients to pre-retrieve context for a user message before sending it to the Agent with the `contextsOverride` option when continuing a session, to allow any pre-processing of the context before sending it to the Agent. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid - :param parameter_inputs: Any values for [application variables](https://palantir.com/docs/foundry/chatbot-studio/application-state/) to use for the context retrieval. + :param parameter_inputs: Any values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to use for the context retrieval. :type parameter_inputs: Dict[ParameterId, ParameterValue] :param user_input: The user message to retrieve relevant context for from the configured Agent data sources. :type user_input: UserTextInput @@ -1367,15 +1367,15 @@ def streaming_continue( Concurrent requests to continue the same session are not supported. Clients should wait to receive a response, or cancel the in-progress exchange, before sending the next message. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid - :param parameter_inputs: Any supplied values for [application variables](https://palantir.com/docs/foundry/chatbot-studio/application-state/) to pass to the Agent for the exchange. + :param parameter_inputs: Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. :type parameter_inputs: Dict[ParameterId, ParameterValue] :param user_input: The user message for the Agent to respond to. :type user_input: UserTextInput - :param contexts_override: If set, automatic [context](https://palantir.com/docs/foundry/chatbot-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. + :param contexts_override: If set, automatic [context](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. :type contexts_override: Optional[List[InputContext]] :param message_id: A client-generated Universally Unique Identifier (UUID) to identify the message, which the client can use to cancel the exchange before the streaming response is complete. :type message_id: Optional[MessageId] @@ -1390,8 +1390,8 @@ def streaming_continue( :raises AgentNotFound: The given Agent could not be found. :raises FunctionLocatorNotFound: The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access. - :raises InvalidParameter: The provided application variable is not valid for the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with `getSession`. - :raises InvalidParameterType: The provided value does not match the expected type for the application variable configured on the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with `getSession`. + :raises InvalidParameter: The provided application variable is not valid for the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Agent Studio. The Agent version used for the session can be checked through the API with `getSession`. + :raises InvalidParameterType: The provided value does not match the expected type for the application variable configured on the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Agent Studio. The Agent version used for the session can be checked through the API with `getSession`. :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises OntologyEntitiesNotFound: Some ontology types are configured for use by the Agent but could not be found. The types either do not exist or the client token does not have access. Object types and their link types can be checked by listing available object/link types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). @@ -1457,7 +1457,7 @@ def update_title( Update the title for a session. Use this to set a custom title for a session to help identify it in the list of sessions with an Agent. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid diff --git a/foundry_sdk/v2/aip_agents/session_trace.py b/foundry_sdk/v2/aip_agents/session_trace.py index 82b176957..eec963da4 100644 --- a/foundry_sdk/v2/aip_agents/session_trace.py +++ b/foundry_sdk/v2/aip_agents/session_trace.py @@ -72,7 +72,7 @@ def get( an answer. For example, a trace may include steps such as context retrieval and tool calls. Clients should poll this endpoint to check the realtime progress of a response until the trace is completed. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid @@ -179,7 +179,7 @@ def get( an answer. For example, a trace may include steps such as context retrieval and tool calls. Clients should poll this endpoint to check the realtime progress of a response until the trace is completed. - :param agent_rid: An RID identifying an Agent created in [AIP Chatbot Studio](https://palantir.com/docs/foundry/chatbot-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid diff --git a/foundry_sdk/v2/checkpoints/models.py b/foundry_sdk/v2/checkpoints/models.py index f66fbcc52..89c0c26c3 100644 --- a/foundry_sdk/v2/checkpoints/models.py +++ b/foundry_sdk/v2/checkpoints/models.py @@ -142,11 +142,6 @@ class ApprovalsMetadata(core.ModelBase): "UPLOAD_DATA_TO_FLOW_CAPTURE", "EXPORT_FLOW_CAPTURE_ZIP", "INSIGHT_LOAD", - "AIP_ANALYST_APP_LOAD", - "PEER_MANAGER_CDS_PAYLOAD_EXPORT", - "PEER_MANAGER_OBJECT_TYPE_SCHEMAS_EXPORT", - "AIP_ANALYST_EXPORT", - "OBJECT_EXPLORER_SEARCH", ] """ Checkpoint type identifier. See the [Checkpoints documentation](https://palantir.com/docs/foundry/checkpoints/overview) @@ -224,7 +219,6 @@ class CheckpointedIssueRid(core.ModelBase): "CheckpointedObjectSet", "CheckpointedMarking", "CheckpointedMarketplaceProduct", - "CheckpointedPeeringJob", "CheckpointedRole", "CheckpointedIntervention", "CheckpointedLanguageModelSession", @@ -247,7 +241,6 @@ class CheckpointedIssueRid(core.ModelBase): "CheckpointedObjectSetVersionedRid", "CheckpointedObjectSetTypesProxyRids", "CheckpointedResourceRid", - "CheckpointedPeeringJobId", "CheckpointedIssueRid", "CheckpointedInterventionRid", "CheckpointedJobSpecRid", @@ -400,28 +393,6 @@ class CheckpointedOntologyWithObjectTypes(core.ModelBase): object_type_rids: typing.List[core.RID] = pydantic.Field(alias=str("objectTypeRids")) # type: ignore[literal-required] -class CheckpointedPeeringJob(core.ModelBase): - """A peering job that was captured as part of a checkpoint.""" - - job_id: str = pydantic.Field(alias=str("jobId")) # type: ignore[literal-required] - """Identifier of the peering job.""" - - relationship_rid: core.RID = pydantic.Field(alias=str("relationshipRid")) # type: ignore[literal-required] - """Resource identifier of the peering relationship.""" - - type: typing.Literal["checkpointedPeeringJob"] = "checkpointedPeeringJob" - - -class CheckpointedPeeringJobId(core.ModelBase): - """Peering job identifier for a checkpointed peering job.""" - - id: str - relationship_rid: core.RID = pydantic.Field(alias=str("relationshipRid")) # type: ignore[literal-required] - """Resource identifier of the peering relationship.""" - - type: typing.Literal["checkpointedPeeringJobId"] = "checkpointedPeeringJobId" - - class CheckpointedPrincipal(core.ModelBase): """A user or group principal that was captured as part of a checkpoint.""" @@ -505,7 +476,6 @@ class CheckpointedResourceRid(core.ModelBase): "WORKSHOP_MODULE", "WALKTHROUGH", "FLOW_CAPTURE", - "PEERING_CONNECTION", ] """Type of resource that was captured.""" @@ -709,7 +679,7 @@ class Record(core.ModelBase): RecordCreatedAt = core.AwareDatetime -"""The time at which the checkpoint record was created.""" +"""RecordCreatedAt""" RecordRid = core.RID @@ -846,7 +816,7 @@ class SearchCheckpointRecordsRequest(core.ModelBase): class SearchCheckpointRecordsResponse(core.ModelBase): - """Response payload for searching checkpoint records.""" + """SearchCheckpointRecordsResponse""" data: typing.List[Record] next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] @@ -923,8 +893,6 @@ class SearchRecordsRequest(core.ModelBase): "CheckpointedObjectSetVersionedRid", "CheckpointedOntology", "CheckpointedOntologyWithObjectTypes", - "CheckpointedPeeringJob", - "CheckpointedPeeringJobId", "CheckpointedPrincipal", "CheckpointedPrincipalId", "CheckpointedPrincipalRole", diff --git a/foundry_sdk/v2/cli.py b/foundry_sdk/v2/cli.py index eb9777c13..f8adb40f6 100644 --- a/foundry_sdk/v2/cli.py +++ b/foundry_sdk/v2/cli.py @@ -128,16 +128,21 @@ def admin_user_op_get_current( @admin_user.command("get_markings") @click.argument("user_id", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def admin_user_op_get_markings( client: FoundryClient, user_id: str, + preview: typing.Optional[bool], ): """ Retrieve Markings that the user is currently a member of. """ result = client.admin.User.get_markings( user_id=user_id, + preview=preview, ) click.echo(repr(result)) @@ -191,10 +196,14 @@ def admin_user_op_profile_picture( @admin_user.command("revoke_all_tokens") @click.argument("user_id", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def admin_user_op_revoke_all_tokens( client: FoundryClient, user_id: str, + preview: typing.Optional[bool], ): """ Revoke all active authentication tokens for the user including active browser sessions and long-lived @@ -205,6 +214,7 @@ def admin_user_op_revoke_all_tokens( """ result = client.admin.User.revoke_all_tokens( user_id=user_id, + preview=preview, ) click.echo(repr(result)) @@ -221,8 +231,7 @@ def admin_user_op_search( page_token: typing.Optional[str], ): """ - Perform a case-insensitive prefix search for active users based on username, given name and family name. - Deleted users are not included in results. To list deleted users, use the `list` endpoint with `include=DELETED`. + Perform a case-insensitive prefix search for users based on username, given name and family name. """ result = client.admin.User.search( @@ -297,16 +306,21 @@ def admin_user_user_provider_info(): @admin_user_user_provider_info.command("get") @click.argument("user_id", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def admin_user_user_provider_info_op_get( client: FoundryClient, user_id: str, + preview: typing.Optional[bool], ): """ Get the UserProviderInfo. """ result = client.admin.User.ProviderInfo.get( user_id=user_id, + preview=preview, ) click.echo(repr(result)) @@ -321,11 +335,15 @@ def admin_user_user_provider_info_op_get( At most one User can have a given provider ID in a given Realm. """, ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def admin_user_user_provider_info_op_replace( client: FoundryClient, user_id: str, provider_id: str, + preview: typing.Optional[bool], ): """ Replace the UserProviderInfo. @@ -333,6 +351,7 @@ def admin_user_user_provider_info_op_replace( result = client.admin.User.ProviderInfo.replace( user_id=user_id, provider_id=provider_id, + preview=preview, ) click.echo(repr(result)) @@ -445,26 +464,35 @@ def admin_organization_op_create( @admin_organization.command("get") @click.argument("organization_rid", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def admin_organization_op_get( client: FoundryClient, organization_rid: str, + preview: typing.Optional[bool], ): """ Get the Organization with the specified rid. """ result = client.admin.Organization.get( organization_rid=organization_rid, + preview=preview, ) click.echo(repr(result)) @admin_organization.command("list_available_roles") @click.argument("organization_rid", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def admin_organization_op_list_available_roles( client: FoundryClient, organization_rid: str, + preview: typing.Optional[bool], ): """ List all roles that can be assigned to a principal for the given Organization. @@ -472,6 +500,7 @@ def admin_organization_op_list_available_roles( """ result = client.admin.Organization.list_available_roles( organization_rid=organization_rid, + preview=preview, ) click.echo(repr(result)) @@ -488,6 +517,9 @@ def admin_organization_op_list_available_roles( Organization. """, ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def admin_organization_op_replace( client: FoundryClient, @@ -495,6 +527,7 @@ def admin_organization_op_replace( name: str, description: typing.Optional[str], host: typing.Optional[str], + preview: typing.Optional[bool], ): """ Replace the Organization with the specified rid. @@ -504,82 +537,6 @@ def admin_organization_op_replace( name=name, description=description, host=host, - ) - click.echo(repr(result)) - - -@admin_organization.group("organization_guest_member") -def admin_organization_organization_guest_member(): - pass - - -@admin_organization_organization_guest_member.command("add") -@click.argument("organization_rid", type=str, required=True) -@click.option("--principal_ids", type=str, required=True, help="""""") -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def admin_organization_organization_guest_member_op_add( - client: FoundryClient, - organization_rid: str, - principal_ids: str, - preview: typing.Optional[bool], -): - """ - Adds principals as guest members of an Organization. Attempting to add a primary member through this endpoint will not add the principal as a guest, but will still return a successful response. - - """ - result = client.admin.Organization.OrganizationGuestMember.add( - organization_rid=organization_rid, - principal_ids=json.loads(principal_ids), - preview=preview, - ) - click.echo(repr(result)) - - -@admin_organization_organization_guest_member.command("list") -@click.argument("organization_rid", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def admin_organization_organization_guest_member_op_list( - client: FoundryClient, - organization_rid: str, - preview: typing.Optional[bool], -): - """ - Lists all guest members of an Organization. - - """ - result = client.admin.Organization.OrganizationGuestMember.list( - organization_rid=organization_rid, - preview=preview, - ) - click.echo(repr(result)) - - -@admin_organization_organization_guest_member.command("remove") -@click.argument("organization_rid", type=str, required=True) -@click.option("--principal_ids", type=str, required=True, help="""""") -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def admin_organization_organization_guest_member_op_remove( - client: FoundryClient, - organization_rid: str, - principal_ids: str, - preview: typing.Optional[bool], -): - """ - Removes principals from being guest members of an Organization. Attempting to remove a primary member through this endpoint will not remove the primary member, but will still return a successful response. - - """ - result = client.admin.Organization.OrganizationGuestMember.remove( - organization_rid=organization_rid, - principal_ids=json.loads(principal_ids), preview=preview, ) click.echo(repr(result)) @@ -593,11 +550,15 @@ def admin_organization_organization_role_assignment(): @admin_organization_organization_role_assignment.command("add") @click.argument("organization_rid", type=str, required=True) @click.option("--role_assignments", type=str, required=True, help="""""") +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def admin_organization_organization_role_assignment_op_add( client: FoundryClient, organization_rid: str, role_assignments: str, + preview: typing.Optional[bool], ): """ Assign roles to principals for the given Organization. At most 100 role assignments can be added in a single request. @@ -606,16 +567,21 @@ def admin_organization_organization_role_assignment_op_add( result = client.admin.Organization.OrganizationRoleAssignment.add( organization_rid=organization_rid, role_assignments=json.loads(role_assignments), + preview=preview, ) click.echo(repr(result)) @admin_organization_organization_role_assignment.command("list") @click.argument("organization_rid", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def admin_organization_organization_role_assignment_op_list( client: FoundryClient, organization_rid: str, + preview: typing.Optional[bool], ): """ List all principals who are assigned a role for the given Organization. @@ -623,6 +589,7 @@ def admin_organization_organization_role_assignment_op_list( """ result = client.admin.Organization.OrganizationRoleAssignment.list( organization_rid=organization_rid, + preview=preview, ) click.echo(repr(result)) @@ -630,11 +597,15 @@ def admin_organization_organization_role_assignment_op_list( @admin_organization_organization_role_assignment.command("remove") @click.argument("organization_rid", type=str, required=True) @click.option("--role_assignments", type=str, required=True, help="""""") +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def admin_organization_organization_role_assignment_op_remove( client: FoundryClient, organization_rid: str, role_assignments: str, + preview: typing.Optional[bool], ): """ Remove roles from principals for the given Organization. At most 100 role assignments can be removed in a single request. @@ -643,6 +614,7 @@ def admin_organization_organization_role_assignment_op_remove( result = client.admin.Organization.OrganizationRoleAssignment.remove( organization_rid=organization_rid, role_assignments=json.loads(role_assignments), + preview=preview, ) click.echo(repr(result)) @@ -696,16 +668,21 @@ def admin_marking_category_op_create( @admin_marking_category.command("get") @click.argument("marking_category_id", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def admin_marking_category_op_get( client: FoundryClient, marking_category_id: str, + preview: typing.Optional[bool], ): """ Get the MarkingCategory with the specified id. """ result = client.admin.MarkingCategory.get( marking_category_id=marking_category_id, + preview=preview, ) click.echo(repr(result)) @@ -722,11 +699,15 @@ def admin_marking_category_op_get( To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request.""", ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def admin_marking_category_op_list( client: FoundryClient, page_size: typing.Optional[int], page_token: typing.Optional[str], + preview: typing.Optional[bool], ): """ Maximum page size 100. @@ -734,32 +715,6 @@ def admin_marking_category_op_list( result = client.admin.MarkingCategory.list( page_size=page_size, page_token=page_token, - ) - click.echo(repr(result)) - - -@admin_marking_category.command("replace") -@click.argument("marking_category_id", type=str, required=True) -@click.option("--description", type=str, required=True, help="""""") -@click.option("--name", type=str, required=True, help="""""") -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def admin_marking_category_op_replace( - client: FoundryClient, - marking_category_id: str, - description: str, - name: str, - preview: typing.Optional[bool], -): - """ - Replace the MarkingCategory with the specified id. - """ - result = client.admin.MarkingCategory.replace( - marking_category_id=marking_category_id, - description=description, - name=name, preview=preview, ) click.echo(repr(result)) @@ -912,11 +867,7 @@ def admin_marking_marking_role_assignment_op_add( marking_id: str, role_assignments: str, ): - """ - Adds role assignments for the given Marking. For Organization markings, only the USE and DECLASSIFY - roles are supported; the ADMINISTER role must be managed via the Organization Role Assignment endpoints. - - """ + """ """ result = client.admin.Marking.MarkingRoleAssignment.add( marking_id=marking_id, role_assignments=json.loads(role_assignments), @@ -965,11 +916,7 @@ def admin_marking_marking_role_assignment_op_remove( marking_id: str, role_assignments: str, ): - """ - Removes role assignments for the given Marking. For Organization markings, only the USE and DECLASSIFY - roles are supported; the ADMINISTER role must be managed via the Organization Role Assignment endpoints. - - """ + """ """ result = client.admin.Marking.MarkingRoleAssignment.remove( marking_id=marking_id, role_assignments=json.loads(role_assignments), @@ -1184,68 +1131,6 @@ def admin_group_op_list( click.echo(repr(result)) -@admin_group.command("list_current") -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def admin_group_op_list_current( - client: FoundryClient, - preview: typing.Optional[bool], -): - """ - Returns all Groups which contain the current user as a direct or transitive member. For example if the current user is a member of Group A and Group A is a member of Group B, this endpoint will return Group A and Group B. - - Unlike the list Group Memberships endpoint which requires the `api:admin-read` scope, this endpoint - does not require any particular scopes and can be used by any authenticated user to retrieve their own - group memberships. - - """ - result = client.admin.Group.list_current( - preview=preview, - ) - click.echo(repr(result)) - - -@admin_group.command("replace") -@click.argument("group_id", type=str, required=True) -@click.option( - "--attributes", - type=str, - required=True, - help="""A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change.""", -) -@click.option("--name", type=str, required=True, help="""The name of the Group.""") -@click.option( - "--organizations", - type=str, - required=True, - help="""The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed. -""", -) -@click.option("--description", type=str, required=False, help="""A description of the Group.""") -@click.pass_obj -def admin_group_op_replace( - client: FoundryClient, - group_id: str, - attributes: str, - name: str, - organizations: str, - description: typing.Optional[str], -): - """ - When replacing groups, you must send all attributes that begin with `multipass:` exactly as they appear when calling the Get Group endpoint. - """ - result = client.admin.Group.replace( - group_id=group_id, - attributes=json.loads(attributes), - name=name, - organizations=json.loads(organizations), - description=description, - ) - click.echo(repr(result)) - - @admin_group.command("search") @click.option("--where", type=str, required=True, help="""""") @click.option("--page_size", type=int, required=False, help="""""") @@ -1360,16 +1245,6 @@ def admin_group_group_member_op_add( @admin_group_group_member.command("list") @click.argument("group_id", type=str, required=True) -@click.option( - "--include_expirations", - type=bool, - required=False, - help="""When true, includes the expiration time of any temporary members of this group. `includeExpirations` -cannot be set to true if `transitive` is also set to true. - -Defaults to false. -""", -) @click.option( "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" ) @@ -1390,8 +1265,6 @@ def admin_group_group_member_op_add( be returned, but if `transitive=true` then Group A and User B will be returned. This will recursively resolve Groups through all layers of nesting. -If `transitive` is true, `includeExpirations` cannot also be set to true. - Defaults to false. """, ) @@ -1399,7 +1272,6 @@ def admin_group_group_member_op_add( def admin_group_group_member_op_list( client: FoundryClient, group_id: str, - include_expirations: typing.Optional[bool], page_size: typing.Optional[int], page_token: typing.Optional[str], transitive: typing.Optional[bool], @@ -1416,7 +1288,6 @@ def admin_group_group_member_op_list( """ result = client.admin.Group.GroupMember.list( group_id=group_id, - include_expirations=include_expirations, page_size=page_size, page_token=page_token, transitive=transitive, @@ -1448,16 +1319,21 @@ def admin_group_group_provider_info(): @admin_group_group_provider_info.command("get") @click.argument("group_id", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def admin_group_group_provider_info_op_get( client: FoundryClient, group_id: str, + preview: typing.Optional[bool], ): """ Get the GroupProviderInfo. """ result = client.admin.Group.ProviderInfo.get( group_id=group_id, + preview=preview, ) click.echo(repr(result)) @@ -1472,11 +1348,15 @@ def admin_group_group_provider_info_op_get( At most one Group can have a given provider ID in a given Realm. """, ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def admin_group_group_provider_info_op_replace( client: FoundryClient, group_id: str, provider_id: str, + preview: typing.Optional[bool], ): """ Replace the GroupProviderInfo. @@ -1484,6 +1364,7 @@ def admin_group_group_provider_info_op_replace( result = client.admin.Group.ProviderInfo.replace( group_id=group_id, provider_id=provider_id, + preview=preview, ) click.echo(repr(result)) @@ -1799,130 +1680,60 @@ def admin_enrollment_enrollment_role_assignment_op_remove( click.echo(repr(result)) -@admin.group("cbac_marking_restrictions") -def admin_cbac_marking_restrictions(): +@cli.group("aip_agents") +def aip_agents(): + pass + + +@aip_agents.group("agent") +def aip_agents_agent(): pass -@admin_cbac_marking_restrictions.command("get") +@aip_agents_agent.command("all_sessions") @click.option( - "--marking_ids", - type=str, + "--page_size", + type=int, required=False, - help="""The marking IDs for which to get restrictions.""", + help="""The maximum number of sessions to return in a single page. The maximum allowed value is 100. +Defaults to 100 if not specified. +""", ) +@click.option("--page_token", type=str, required=False, help="""""") @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def admin_cbac_marking_restrictions_op_get( +def aip_agents_agent_op_all_sessions( client: FoundryClient, - marking_ids: typing.Optional[str], + page_size: typing.Optional[int], + page_token: typing.Optional[str], preview: typing.Optional[bool], ): """ - Returns disallowed, implied, and required markings for the given set of marking IDs. + List all conversation sessions between the calling user and all accessible Agents that were created by this client. + Sessions are returned in order of most recently updated first. + """ - result = client.admin.CbacMarkingRestrictions.get( - marking_ids=None if marking_ids is None else json.loads(marking_ids), + result = client.aip_agents.Agent.all_sessions( + page_size=page_size, + page_token=page_token, preview=preview, ) click.echo(repr(result)) -@admin.group("cbac_banner") -def admin_cbac_banner(): - pass - - -@admin_cbac_banner.command("get") +@aip_agents_agent.command("get") +@click.argument("agent_rid", type=str, required=True) @click.option( - "--display_type", - type=click.Choice(["BANNER_LINE", "PORTION_MARKING"]), - required=False, - help="""The display type of the banner. Defaults to PORTION_MARKING. BANNER_LINE is the long classification string used in the header of a document; PORTION_MARKING is a short classification string used for individual paragraphs""", + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.option( - "--marking_ids", + "--version", type=str, required=False, - help="""The marking IDs for which to generate a banner.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def admin_cbac_banner_op_get( - client: FoundryClient, - display_type: typing.Optional[typing.Literal["BANNER_LINE", "PORTION_MARKING"]], - marking_ids: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Returns a classification banner string and colors for the given set of marking IDs. - """ - result = client.admin.CbacBanner.get( - display_type=display_type, - marking_ids=None if marking_ids is None else json.loads(marking_ids), - preview=preview, - ) - click.echo(repr(result)) - - -@cli.group("aip_agents") -def aip_agents(): - pass - - -@aip_agents.group("agent") -def aip_agents_agent(): - pass - - -@aip_agents_agent.command("all_sessions") -@click.option( - "--page_size", - type=int, - required=False, - help="""The maximum number of sessions to return in a single page. The maximum allowed value is 100. -Defaults to 100 if not specified. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def aip_agents_agent_op_all_sessions( - client: FoundryClient, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - List all conversation sessions between the calling user and all accessible Agents that were created by this client. - Sessions are returned in order of most recently updated first. - - """ - result = client.aip_agents.Agent.all_sessions( - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - -@aip_agents_agent.command("get") -@click.argument("agent_rid", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.option( - "--version", - type=str, - required=False, - help="""The version of the Agent to retrieve. If not specified, the latest published version will be returned. -""", + help="""The version of the Agent to retrieve. If not specified, the latest published version will be returned. +""", ) @click.pass_obj def aip_agents_agent_op_get( @@ -1932,7 +1743,7 @@ def aip_agents_agent_op_get( version: typing.Optional[str], ): """ - Get details for an Agent. + Get details for an AIP Agent. """ result = client.aip_agents.Agent.get( agent_rid=agent_rid, @@ -1954,7 +1765,7 @@ def aip_agents_agent_session(): "--parameter_inputs", type=str, required=True, - help="""Any supplied values for [application variables](https://palantir.com/docs/foundry/chatbot-studio/application-state/) to pass to the Agent for the exchange. + help="""Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. """, ) @click.option( @@ -1967,7 +1778,7 @@ def aip_agents_agent_session(): "--contexts_override", type=str, required=False, - help="""If set, automatic [context retrieval](https://palantir.com/docs/foundry/chatbot-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. + help="""If set, automatic [context retrieval](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. """, ) @@ -2174,7 +1985,7 @@ def aip_agents_agent_session_op_list( """ List all conversation sessions between the calling user and an Agent that was created by this client. This does not list sessions for the user created by other clients. - For example, any sessions created by the user in AIP Chatbot Studio will not be listed here. + For example, any sessions created by the user in AIP Agent Studio will not be listed here. Sessions are returned in order of most recently updated first. """ @@ -2194,7 +2005,7 @@ def aip_agents_agent_session_op_list( "--parameter_inputs", type=str, required=True, - help="""Any values for [application variables](https://palantir.com/docs/foundry/chatbot-studio/application-state/) to use for the context retrieval. + help="""Any values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to use for the context retrieval. """, ) @click.option( @@ -2216,7 +2027,7 @@ def aip_agents_agent_session_op_rag_context( preview: typing.Optional[bool], ): """ - Retrieve relevant [context](https://palantir.com/docs/foundry/chatbot-studio/core-concepts/#retrieval-context) for a user message from the data sources configured for the session. + Retrieve relevant [context](https://palantir.com/docs/foundry/agent-studio/core-concepts/#retrieval-context) for a user message from the data sources configured for the session. This allows clients to pre-retrieve context for a user message before sending it to the Agent with the `contextsOverride` option when continuing a session, to allow any pre-processing of the context before sending it to the Agent. """ @@ -2237,7 +2048,7 @@ def aip_agents_agent_session_op_rag_context( "--parameter_inputs", type=str, required=True, - help="""Any supplied values for [application variables](https://palantir.com/docs/foundry/chatbot-studio/application-state/) to pass to the Agent for the exchange. + help="""Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. """, ) @click.option( @@ -2250,7 +2061,7 @@ def aip_agents_agent_session_op_rag_context( "--contexts_override", type=str, required=False, - help="""If set, automatic [context](https://palantir.com/docs/foundry/chatbot-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. + help="""If set, automatic [context](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. """, ) @@ -2429,7 +2240,7 @@ def aip_agents_agent_agent_version_op_get( preview: typing.Optional[bool], ): """ - Get version details for an Agent. + Get version details for an AIP Agent. """ result = client.aip_agents.Agent.AgentVersion.get( agent_rid=agent_rid, @@ -2464,7 +2275,7 @@ def aip_agents_agent_agent_version_op_list( preview: typing.Optional[bool], ): """ - List all versions for an Agent. + List all versions for an AIP Agent. Versions are returned in descending order, by most recent versions first. """ @@ -2678,6 +2489,9 @@ def connectivity_connection(): ) @click.option("--parent_folder_rid", type=str, required=True, help="""""") @click.option("--worker", type=str, required=True, help="""""") +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_op_create( client: FoundryClient, @@ -2685,6 +2499,7 @@ def connectivity_connection_op_create( display_name: str, parent_folder_rid: str, worker: str, + preview: typing.Optional[bool], ): """ Creates a new Connection with a [direct connection](https://palantir.com/docs/foundry/data-connection/core-concepts/#direct-connection) runtime. @@ -2703,32 +2518,42 @@ def connectivity_connection_op_create( display_name=display_name, parent_folder_rid=parent_folder_rid, worker=json.loads(worker), + preview=preview, ) click.echo(repr(result)) @connectivity_connection.command("get") @click.argument("connection_rid", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_op_get( client: FoundryClient, connection_rid: str, + preview: typing.Optional[bool], ): """ Get the Connection with the specified rid. """ result = client.connectivity.Connection.get( connection_rid=connection_rid, + preview=preview, ) click.echo(repr(result)) @connectivity_connection.command("get_configuration") @click.argument("connection_rid", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_op_get_configuration( client: FoundryClient, connection_rid: str, + preview: typing.Optional[bool], ): """ Retrieves the ConnectionConfiguration of the [Connection](https://palantir.com/docs/foundry/data-connection/set-up-source/) itself. @@ -2737,16 +2562,21 @@ def connectivity_connection_op_get_configuration( """ result = client.connectivity.Connection.get_configuration( connection_rid=connection_rid, + preview=preview, ) click.echo(repr(result)) @connectivity_connection.command("get_configuration_batch") @click.argument("body", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_op_get_configuration_batch( client: FoundryClient, body: str, + preview: typing.Optional[bool], ): """ Returns a map of Connection RIDs to their corresponding configurations. @@ -2757,6 +2587,7 @@ def connectivity_connection_op_get_configuration_batch( """ result = client.connectivity.Connection.get_configuration_batch( body=json.loads(body), + preview=preview, ) click.echo(repr(result)) @@ -2764,11 +2595,15 @@ def connectivity_connection_op_get_configuration_batch( @connectivity_connection.command("update_export_settings") @click.argument("connection_rid", type=str, required=True) @click.option("--export_settings", type=str, required=True, help="""""") +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_op_update_export_settings( client: FoundryClient, connection_rid: str, export_settings: str, + preview: typing.Optional[bool], ): """ Updates the [export settings on the Connection.](https://palantir.com/docs/foundry/data-connection/export-overview/#enable-exports-for-source) @@ -2778,6 +2613,7 @@ def connectivity_connection_op_update_export_settings( result = client.connectivity.Connection.update_export_settings( connection_rid=connection_rid, export_settings=json.loads(export_settings), + preview=preview, ) click.echo(repr(result)) @@ -2828,12 +2664,16 @@ def connectivity_connection_op_update_secrets( help="""The file name of the uploaded JDBC driver. Must end with .jar """, ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_op_upload_custom_jdbc_drivers( client: FoundryClient, connection_rid: str, body: io.BufferedReader, file_name: str, + preview: typing.Optional[bool], ): """ Upload custom jdbc drivers to an existing JDBC connection. @@ -2844,6 +2684,7 @@ def connectivity_connection_op_upload_custom_jdbc_drivers( connection_rid=connection_rid, body=body.read(), file_name=file_name, + preview=preview, ) click.echo(repr(result)) @@ -2859,6 +2700,9 @@ def connectivity_connection_virtual_table(): @click.option("--name", type=str, required=True, help="""""") @click.option("--parent_rid", type=str, required=True, help="""""") @click.option("--markings", type=str, required=False, help="""""") +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_virtual_table_op_create( client: FoundryClient, @@ -2867,6 +2711,7 @@ def connectivity_connection_virtual_table_op_create( name: str, parent_rid: str, markings: typing.Optional[str], + preview: typing.Optional[bool], ): """ Creates a new [Virtual Table](https://palantir.com/docs/foundry/data-integration/virtual-tables/) from an upstream table. The VirtualTable will be created @@ -2879,6 +2724,7 @@ def connectivity_connection_virtual_table_op_create( name=name, parent_rid=parent_rid, markings=None if markings is None else json.loads(markings), + preview=preview, ) click.echo(repr(result)) @@ -2913,6 +2759,9 @@ def connectivity_connection_table_import(): required=False, help="""The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. Can not be modified after the table import is created.""", ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_table_import_op_create( client: FoundryClient, @@ -2923,6 +2772,7 @@ def connectivity_connection_table_import_op_create( import_mode: typing.Literal["SNAPSHOT", "APPEND"], allow_schema_changes: typing.Optional[bool], branch_name: typing.Optional[str], + preview: typing.Optional[bool], ): """ Creates a new TableImport. @@ -2935,6 +2785,7 @@ def connectivity_connection_table_import_op_create( import_mode=import_mode, allow_schema_changes=allow_schema_changes, branch_name=branch_name, + preview=preview, ) click.echo(repr(result)) @@ -2942,11 +2793,15 @@ def connectivity_connection_table_import_op_create( @connectivity_connection_table_import.command("delete") @click.argument("connection_rid", type=str, required=True) @click.argument("table_import_rid", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_table_import_op_delete( client: FoundryClient, connection_rid: str, table_import_rid: str, + preview: typing.Optional[bool], ): """ Delete the TableImport with the specified RID. @@ -2957,6 +2812,7 @@ def connectivity_connection_table_import_op_delete( result = client.connectivity.Connection.TableImport.delete( connection_rid=connection_rid, table_import_rid=table_import_rid, + preview=preview, ) click.echo(repr(result)) @@ -2964,11 +2820,15 @@ def connectivity_connection_table_import_op_delete( @connectivity_connection_table_import.command("execute") @click.argument("connection_rid", type=str, required=True) @click.argument("table_import_rid", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_table_import_op_execute( client: FoundryClient, connection_rid: str, table_import_rid: str, + preview: typing.Optional[bool], ): """ Executes the TableImport, which runs asynchronously as a [Foundry Build](https://palantir.com/docs/foundry/data-integration/builds/). @@ -2978,6 +2838,7 @@ def connectivity_connection_table_import_op_execute( result = client.connectivity.Connection.TableImport.execute( connection_rid=connection_rid, table_import_rid=table_import_rid, + preview=preview, ) click.echo(repr(result)) @@ -2985,11 +2846,15 @@ def connectivity_connection_table_import_op_execute( @connectivity_connection_table_import.command("get") @click.argument("connection_rid", type=str, required=True) @click.argument("table_import_rid", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_table_import_op_get( client: FoundryClient, connection_rid: str, table_import_rid: str, + preview: typing.Optional[bool], ): """ Get the TableImport with the specified rid. @@ -2997,6 +2862,7 @@ def connectivity_connection_table_import_op_get( result = client.connectivity.Connection.TableImport.get( connection_rid=connection_rid, table_import_rid=table_import_rid, + preview=preview, ) click.echo(repr(result)) @@ -3014,12 +2880,16 @@ def connectivity_connection_table_import_op_get( To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request.""", ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_table_import_op_list( client: FoundryClient, connection_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], + preview: typing.Optional[bool], ): """ Lists all table imports defined for this connection. @@ -3030,6 +2900,7 @@ def connectivity_connection_table_import_op_list( connection_rid=connection_rid, page_size=page_size, page_token=page_token, + preview=preview, ) click.echo(repr(result)) @@ -3048,6 +2919,9 @@ def connectivity_connection_table_import_op_list( required=False, help="""Allow the TableImport to succeed if the schema of imported rows does not match the existing dataset's schema. Defaults to false for new table imports.""", ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_table_import_op_replace( client: FoundryClient, @@ -3057,6 +2931,7 @@ def connectivity_connection_table_import_op_replace( display_name: str, import_mode: typing.Literal["SNAPSHOT", "APPEND"], allow_schema_changes: typing.Optional[bool], + preview: typing.Optional[bool], ): """ Replace the TableImport with the specified rid. @@ -3068,6 +2943,7 @@ def connectivity_connection_table_import_op_replace( display_name=display_name, import_mode=import_mode, allow_schema_changes=allow_schema_changes, + preview=preview, ) click.echo(repr(result)) @@ -3101,6 +2977,9 @@ def connectivity_connection_file_import(): required=False, help="""The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. Can not be modified after the file import is created.""", ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.option( "--subfolder", type=str, @@ -3116,6 +2995,7 @@ def connectivity_connection_file_import_op_create( file_import_filters: str, import_mode: typing.Literal["SNAPSHOT", "APPEND", "UPDATE"], branch_name: typing.Optional[str], + preview: typing.Optional[bool], subfolder: typing.Optional[str], ): """ @@ -3128,6 +3008,7 @@ def connectivity_connection_file_import_op_create( file_import_filters=json.loads(file_import_filters), import_mode=import_mode, branch_name=branch_name, + preview=preview, subfolder=subfolder, ) click.echo(repr(result)) @@ -3136,11 +3017,15 @@ def connectivity_connection_file_import_op_create( @connectivity_connection_file_import.command("delete") @click.argument("connection_rid", type=str, required=True) @click.argument("file_import_rid", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_file_import_op_delete( client: FoundryClient, connection_rid: str, file_import_rid: str, + preview: typing.Optional[bool], ): """ Delete the FileImport with the specified RID. @@ -3151,6 +3036,7 @@ def connectivity_connection_file_import_op_delete( result = client.connectivity.Connection.FileImport.delete( connection_rid=connection_rid, file_import_rid=file_import_rid, + preview=preview, ) click.echo(repr(result)) @@ -3158,11 +3044,15 @@ def connectivity_connection_file_import_op_delete( @connectivity_connection_file_import.command("execute") @click.argument("connection_rid", type=str, required=True) @click.argument("file_import_rid", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_file_import_op_execute( client: FoundryClient, connection_rid: str, file_import_rid: str, + preview: typing.Optional[bool], ): """ Executes the FileImport, which runs asynchronously as a [Foundry Build](https://palantir.com/docs/foundry/data-integration/builds/). @@ -3172,6 +3062,7 @@ def connectivity_connection_file_import_op_execute( result = client.connectivity.Connection.FileImport.execute( connection_rid=connection_rid, file_import_rid=file_import_rid, + preview=preview, ) click.echo(repr(result)) @@ -3179,11 +3070,15 @@ def connectivity_connection_file_import_op_execute( @connectivity_connection_file_import.command("get") @click.argument("connection_rid", type=str, required=True) @click.argument("file_import_rid", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_file_import_op_get( client: FoundryClient, connection_rid: str, file_import_rid: str, + preview: typing.Optional[bool], ): """ Get the FileImport with the specified rid. @@ -3191,6 +3086,7 @@ def connectivity_connection_file_import_op_get( result = client.connectivity.Connection.FileImport.get( connection_rid=connection_rid, file_import_rid=file_import_rid, + preview=preview, ) click.echo(repr(result)) @@ -3208,12 +3104,16 @@ def connectivity_connection_file_import_op_get( To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request.""", ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def connectivity_connection_file_import_op_list( client: FoundryClient, connection_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], + preview: typing.Optional[bool], ): """ Lists all file imports defined for this connection. @@ -3224,6 +3124,7 @@ def connectivity_connection_file_import_op_list( connection_rid=connection_rid, page_size=page_size, page_token=page_token, + preview=preview, ) click.echo(repr(result)) @@ -3241,6 +3142,9 @@ def connectivity_connection_file_import_op_list( @click.option( "--import_mode", type=click.Choice(["SNAPSHOT", "APPEND", "UPDATE"]), required=True, help="""""" ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.option( "--subfolder", type=str, @@ -3255,6 +3159,7 @@ def connectivity_connection_file_import_op_replace( display_name: str, file_import_filters: str, import_mode: typing.Literal["SNAPSHOT", "APPEND", "UPDATE"], + preview: typing.Optional[bool], subfolder: typing.Optional[str], ): """ @@ -3266,6 +3171,7 @@ def connectivity_connection_file_import_op_replace( display_name=display_name, file_import_filters=json.loads(file_import_filters), import_mode=import_mode, + preview=preview, subfolder=subfolder, ) click.echo(repr(result)) @@ -3455,12 +3361,16 @@ def datasets_view(): @click.argument("view_dataset_rid", type=str, required=True) @click.option("--backing_datasets", type=str, required=True, help="""""") @click.option("--branch", type=str, required=False, help="""""") +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def datasets_view_op_add_backing_datasets( client: FoundryClient, view_dataset_rid: str, backing_datasets: str, branch: typing.Optional[str], + preview: typing.Optional[bool], ): """ Adds one or more backing datasets to a View. Any duplicates with the same dataset RID and branch name are @@ -3471,6 +3381,7 @@ def datasets_view_op_add_backing_datasets( view_dataset_rid=view_dataset_rid, backing_datasets=json.loads(backing_datasets), branch=branch, + preview=preview, ) click.echo(repr(result)) @@ -3479,12 +3390,16 @@ def datasets_view_op_add_backing_datasets( @click.argument("view_dataset_rid", type=str, required=True) @click.option("--primary_key", type=str, required=True, help="""""") @click.option("--branch", type=str, required=False, help="""""") +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def datasets_view_op_add_primary_key( client: FoundryClient, view_dataset_rid: str, primary_key: str, branch: typing.Optional[str], + preview: typing.Optional[bool], ): """ Adds a primary key to a View that does not already have one. Primary keys are treated as @@ -3495,6 +3410,7 @@ def datasets_view_op_add_primary_key( view_dataset_rid=view_dataset_rid, primary_key=json.loads(primary_key), branch=branch, + preview=preview, ) click.echo(repr(result)) @@ -3509,6 +3425,9 @@ def datasets_view_op_add_primary_key( required=False, help="""The branch name of the View. If not specified, defaults to `master` for most enrollments.""", ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.option("--primary_key", type=str, required=False, help="""""") @click.pass_obj def datasets_view_op_create( @@ -3517,6 +3436,7 @@ def datasets_view_op_create( parent_folder_rid: str, view_name: str, branch: typing.Optional[str], + preview: typing.Optional[bool], primary_key: typing.Optional[str], ): """ @@ -3527,6 +3447,7 @@ def datasets_view_op_create( parent_folder_rid=parent_folder_rid, view_name=view_name, branch=branch, + preview=preview, primary_key=None if primary_key is None else json.loads(primary_key), ) click.echo(repr(result)) @@ -3535,11 +3456,15 @@ def datasets_view_op_create( @datasets_view.command("get") @click.argument("view_dataset_rid", type=str, required=True) @click.option("--branch", type=str, required=False, help="""""") +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def datasets_view_op_get( client: FoundryClient, view_dataset_rid: str, branch: typing.Optional[str], + preview: typing.Optional[bool], ): """ Get metadata for a View. @@ -3547,6 +3472,7 @@ def datasets_view_op_get( result = client.datasets.View.get( view_dataset_rid=view_dataset_rid, branch=branch, + preview=preview, ) click.echo(repr(result)) @@ -3555,12 +3481,16 @@ def datasets_view_op_get( @click.argument("view_dataset_rid", type=str, required=True) @click.option("--backing_datasets", type=str, required=True, help="""""") @click.option("--branch", type=str, required=False, help="""""") +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def datasets_view_op_remove_backing_datasets( client: FoundryClient, view_dataset_rid: str, backing_datasets: str, branch: typing.Optional[str], + preview: typing.Optional[bool], ): """ Removes specified backing datasets from a View. Removing a dataset triggers a @@ -3572,6 +3502,7 @@ def datasets_view_op_remove_backing_datasets( view_dataset_rid=view_dataset_rid, backing_datasets=json.loads(backing_datasets), branch=branch, + preview=preview, ) click.echo(repr(result)) @@ -3580,12 +3511,16 @@ def datasets_view_op_remove_backing_datasets( @click.argument("view_dataset_rid", type=str, required=True) @click.option("--backing_datasets", type=str, required=True, help="""""") @click.option("--branch", type=str, required=False, help="""""") +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def datasets_view_op_replace_backing_datasets( client: FoundryClient, view_dataset_rid: str, backing_datasets: str, branch: typing.Optional[str], + preview: typing.Optional[bool], ): """ Replaces the backing datasets for a View. Removing any backing dataset triggers a @@ -3596,6 +3531,7 @@ def datasets_view_op_replace_backing_datasets( view_dataset_rid=view_dataset_rid, backing_datasets=json.loads(backing_datasets), branch=branch, + preview=preview, ) click.echo(repr(result)) @@ -3720,6 +3656,9 @@ def datasets_dataset_op_get_health_checks( ) @click.option("--page_size", type=int, required=False, help="""""") @click.option("--page_token", type=str, required=False, help="""""") +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def datasets_dataset_op_get_schedules( client: FoundryClient, @@ -3727,13 +3666,10 @@ def datasets_dataset_op_get_schedules( branch_name: typing.Optional[str], page_size: typing.Optional[int], page_token: typing.Optional[str], + preview: typing.Optional[bool], ): """ - Get the RIDs of the Schedules that target the given Dataset. - - Note: It may take up to an hour for recent changes to schedules to be reflected in this response, - especially for schedules managed by Marketplace. This operation will return outdated results in the - meantime. + Get the RIDs of the Schedules that target the given Dataset """ result = client.datasets.Dataset.get_schedules( @@ -3741,6 +3677,7 @@ def datasets_dataset_op_get_schedules( branch_name=branch_name, page_size=page_size, page_token=page_token, + preview=preview, ) click.echo(repr(result)) @@ -3755,6 +3692,9 @@ def datasets_dataset_op_get_schedules( help="""The Resource Identifier (RID) of the end Transaction. If a user does not provide a value, the RID of the latest committed transaction will be used. """, ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.option( "--version_id", type=str, @@ -3768,6 +3708,7 @@ def datasets_dataset_op_get_schema( dataset_rid: str, branch_name: typing.Optional[str], end_transaction_rid: typing.Optional[str], + preview: typing.Optional[bool], version_id: typing.Optional[str], ): """ @@ -3778,6 +3719,7 @@ def datasets_dataset_op_get_schema( dataset_rid=dataset_rid, branch_name=branch_name, end_transaction_rid=end_transaction_rid, + preview=preview, version_id=version_id, ) click.echo(repr(result)) @@ -3785,10 +3727,14 @@ def datasets_dataset_op_get_schema( @datasets_dataset.command("get_schema_batch") @click.argument("body", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def datasets_dataset_op_get_schema_batch( client: FoundryClient, body: str, + preview: typing.Optional[bool], ): """ Fetch schemas for multiple datasets in a single request. Datasets not found @@ -3799,6 +3745,7 @@ def datasets_dataset_op_get_schema_batch( """ result = client.datasets.Dataset.get_schema_batch( body=json.loads(body), + preview=preview, ) click.echo(repr(result)) @@ -3875,6 +3822,9 @@ def datasets_dataset_op_jobs( help="""The Resource Identifier (RID) of the end Transaction. """, ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def datasets_dataset_op_put_schema( client: FoundryClient, @@ -3883,6 +3833,7 @@ def datasets_dataset_op_put_schema( branch_name: typing.Optional[str], dataframe_reader: typing.Optional[typing.Literal["AVRO", "CSV", "PARQUET", "DATASOURCE"]], end_transaction_rid: typing.Optional[str], + preview: typing.Optional[bool], ): """ Adds a schema on an existing dataset using a PUT request. @@ -3894,6 +3845,7 @@ def datasets_dataset_op_put_schema( branch_name=branch_name, dataframe_reader=dataframe_reader, end_transaction_rid=end_transaction_rid, + preview=preview, ) click.echo(repr(result)) @@ -5238,14 +5190,6 @@ def filesystem_project_op_add_organizations( @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) -@click.option( - "--resource_level_role_grants_allowed", - type=bool, - required=False, - help="""Whether role grants should be allowed on individual resources within the Project. -When not specified, defaults to true. -""", -) @click.pass_obj def filesystem_project_op_create( client: FoundryClient, @@ -5256,7 +5200,6 @@ def filesystem_project_op_create( space_rid: str, description: typing.Optional[str], preview: typing.Optional[bool], - resource_level_role_grants_allowed: typing.Optional[bool], ): """ Creates a new Project. @@ -5274,7 +5217,6 @@ def filesystem_project_op_create( space_rid=space_rid, description=description, preview=preview, - resource_level_role_grants_allowed=resource_level_role_grants_allowed, ) click.echo(repr(result)) @@ -5427,38 +5369,13 @@ def filesystem_project_op_replace( click.echo(repr(result)) -@filesystem_project.group("project_resource_reference") -def filesystem_project_project_resource_reference(): +@filesystem.group("folder") +def filesystem_folder(): pass -@filesystem_project_project_resource_reference.command("add") -@click.argument("project_rid", type=str, required=True) -@click.option("--resources", type=str, required=True, help="""""") -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def filesystem_project_project_resource_reference_op_add( - client: FoundryClient, - project_rid: str, - resources: str, - preview: typing.Optional[bool], -): - """ - Add references to the given project - - """ - result = client.filesystem.Project.Reference.add( - project_rid=project_rid, - resources=json.loads(resources), - preview=preview, - ) - click.echo(repr(result)) - - -@filesystem_project_project_resource_reference.command("list") -@click.argument("project_rid", type=str, required=True) +@filesystem_folder.command("children") +@click.argument("folder_rid", type=str, required=True) @click.option( "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" ) @@ -5473,112 +5390,32 @@ def filesystem_project_project_resource_reference_op_add( @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) -@click.option( - "--reference_type", - type=click.Choice(["EXTERNAL", "FILESYSTEM"]), - required=False, - help="""Filter references by type. If not provided, all references are returned.""", -) @click.pass_obj -def filesystem_project_project_resource_reference_op_list( +def filesystem_folder_op_children( client: FoundryClient, - project_rid: str, + folder_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], preview: typing.Optional[bool], - reference_type: typing.Optional[typing.Literal["EXTERNAL", "FILESYSTEM"]], ): """ - List all references in the given project + List all child Resources of the Folder. + + This is a paged endpoint. The page size will be limited to 2,000 results per page. If no page size is + provided, this page size will also be used as the default. """ - result = client.filesystem.Project.Reference.list( - project_rid=project_rid, + result = client.filesystem.Folder.children( + folder_rid=folder_rid, page_size=page_size, page_token=page_token, preview=preview, - reference_type=reference_type, ) click.echo(repr(result)) -@filesystem_project_project_resource_reference.command("remove") -@click.argument("project_rid", type=str, required=True) -@click.option( - "--resources", - type=str, - required=True, - help="""The resource identifiers to remove as references. These may be either filesystem or external resource identifiers.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def filesystem_project_project_resource_reference_op_remove( - client: FoundryClient, - project_rid: str, - resources: str, - preview: typing.Optional[bool], -): - """ - Remove references from the given project - - """ - result = client.filesystem.Project.Reference.remove( - project_rid=project_rid, - resources=json.loads(resources), - preview=preview, - ) - click.echo(repr(result)) - - -@filesystem.group("folder") -def filesystem_folder(): - pass - - -@filesystem_folder.command("children") -@click.argument("folder_rid", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""The page token indicates where to start paging. This should be omitted from the first page's request. -To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response -and use it to populate the `pageToken` field of the next request.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def filesystem_folder_op_children( - client: FoundryClient, - folder_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - List all child Resources of the Folder. - - This is a paged endpoint. The page size will be limited to 2,000 results per page. If no page size is - provided, this page size will also be used as the default. - - """ - result = client.filesystem.Folder.children( - folder_rid=folder_rid, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - -@filesystem_folder.command("create") -@click.option("--display_name", type=str, required=True, help="""""") +@filesystem_folder.command("create") +@click.option("--display_name", type=str, required=True, help="""""") @click.option( "--parent_folder_rid", type=str, @@ -5653,40 +5490,6 @@ def filesystem_folder_op_get_batch( click.echo(repr(result)) -@filesystem_folder.command("replace") -@click.argument("folder_rid", type=str, required=True) -@click.option("--display_name", type=str, required=True, help="""""") -@click.option( - "--parent_folder_rid", - type=str, - required=True, - help="""The parent folder Resource Identifier (RID). For Projects, this will be the Space RID and for Spaces, -this value will be the root folder (`ri.compass.main.folder.0`). -""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def filesystem_folder_op_replace( - client: FoundryClient, - folder_rid: str, - display_name: str, - parent_folder_rid: str, - preview: typing.Optional[bool], -): - """ - Replace the Folder with the specified rid. - """ - result = client.filesystem.Folder.replace( - folder_rid=folder_rid, - display_name=display_name, - parent_folder_rid=parent_folder_rid, - preview=preview, - ) - click.echo(repr(result)) - - @cli.group("functions") def functions(): pass @@ -5758,15 +5561,6 @@ def functions_query(): @click.argument("query_api_name", type=str, required=True) @click.option("--parameters", type=str, required=True, help="""""") @click.option("--attribution", type=str, required=False, help="""""") -@click.option( - "--branch", - type=str, - required=False, - help="""The Foundry branch to execute the query from. If not specified, the default branch is used. -When provided without `version`, the latest version on this branch is used. -When provided with `version`, the specified version must exist on the branch. -""", -) @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @@ -5778,20 +5572,13 @@ def functions_query(): required=False, help="""The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported.""", ) -@click.option( - "--version", - type=str, - required=False, - help="""The version of the query to execute. When used with `branch`, the specified version must exist on the branch. -""", -) +@click.option("--version", type=str, required=False, help="""""") @click.pass_obj def functions_query_op_execute( client: FoundryClient, query_api_name: str, parameters: str, attribution: typing.Optional[str], - branch: typing.Optional[str], preview: typing.Optional[bool], trace_parent: typing.Optional[str], trace_state: typing.Optional[str], @@ -5811,83 +5598,6 @@ def functions_query_op_execute( query_api_name=query_api_name, parameters=json.loads(parameters), attribution=attribution, - branch=branch, - preview=preview, - trace_parent=trace_parent, - trace_state=trace_state, - transaction_id=transaction_id, - version=version, - ) - click.echo(repr(result)) - - -@functions_query.command("execute_async") -@click.argument("query_api_name", type=str, required=True) -@click.option("--parameters", type=str, required=True, help="""""") -@click.option("--attribution", type=str, required=False, help="""""") -@click.option( - "--branch", - type=str, - required=False, - help="""The Foundry branch to execute the query from. If not specified, the default branch is used. -When provided without `version`, the latest version on this branch is used. -When provided with `version`, the specified version must exist on the branch. -""", -) -@click.option( - "--ontology", - type=str, - required=False, - help="""Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped -function. When omitted, executes a global function. -""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.option("--trace_parent", type=str, required=False, help="""""") -@click.option("--trace_state", type=str, required=False, help="""""") -@click.option( - "--transaction_id", - type=str, - required=False, - help="""The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported.""", -) -@click.option( - "--version", - type=str, - required=False, - help="""The version of the query to execute. When used with `branch`, the specified version must exist on the branch. -""", -) -@click.pass_obj -def functions_query_op_execute_async( - client: FoundryClient, - query_api_name: str, - parameters: str, - attribution: typing.Optional[str], - branch: typing.Optional[str], - ontology: typing.Optional[str], - preview: typing.Optional[bool], - trace_parent: typing.Optional[str], - trace_state: typing.Optional[str], - transaction_id: typing.Optional[str], - version: typing.Optional[str], -): - """ - Submits a Query for asynchronous execution. Returns either an execution ID - for polling, or the complete result if execution finished immediately. - - Use the Execution resource's getResult endpoint to poll for the - result of a submitted execution. - - """ - result = client.functions.Query.execute_async( - query_api_name=query_api_name, - parameters=json.loads(parameters), - attribution=attribution, - branch=branch, - ontology=ontology, preview=preview, trace_parent=trace_parent, trace_state=trace_state, @@ -5960,45 +5670,10 @@ def functions_query_op_get_by_rid( click.echo(repr(result)) -@functions_query.command("get_by_rid_batch") -@click.argument("body", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def functions_query_op_get_by_rid_batch( - client: FoundryClient, - body: str, - preview: typing.Optional[bool], -): - """ - Gets a list of query types by RID in bulk. By default, this gets the latest version of each query. - - Queries are filtered from the response if they don't exist or the requesting token lacks the required - permissions. - - The maximum batch size for this endpoint is 100. - """ - result = client.functions.Query.get_by_rid_batch( - body=json.loads(body), - preview=preview, - ) - click.echo(repr(result)) - - @functions_query.command("streaming_execute") @click.argument("query_api_name", type=str, required=True) @click.option("--parameters", type=str, required=True, help="""""") @click.option("--attribution", type=str, required=False, help="""""") -@click.option( - "--branch", - type=str, - required=False, - help="""The Foundry branch to execute the query from. If not specified, the default branch is used. -When provided without `version`, the latest version on this branch is used. -When provided with `version`, the specified version must exist on the branch. -""", -) @click.option( "--ontology", type=str, @@ -6018,20 +5693,13 @@ def functions_query_op_get_by_rid_batch( required=False, help="""The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported.""", ) -@click.option( - "--version", - type=str, - required=False, - help="""The version of the query to execute. When used with `branch`, the specified version must exist on the branch. -""", -) +@click.option("--version", type=str, required=False, help="""""") @click.pass_obj def functions_query_op_streaming_execute( client: FoundryClient, query_api_name: str, parameters: str, attribution: typing.Optional[str], - branch: typing.Optional[str], ontology: typing.Optional[str], preview: typing.Optional[bool], trace_parent: typing.Optional[str], @@ -6071,7 +5739,6 @@ def functions_query_op_streaming_execute( query_api_name=query_api_name, parameters=json.loads(parameters), attribution=attribution, - branch=branch, ontology=ontology, preview=preview, trace_parent=trace_parent, @@ -6082,77 +5749,6 @@ def functions_query_op_streaming_execute( click.echo(result) -@functions.group("execution") -def functions_execution(): - pass - - -@functions_execution.command("cancel") -@click.argument("execution_id", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def functions_execution_op_cancel( - client: FoundryClient, - execution_id: str, - preview: typing.Optional[bool], -): - """ - Cancel a running async query execution. This endpoint is idempotent. - - """ - result = client.functions.Execution.cancel( - execution_id=execution_id, - preview=preview, - ) - click.echo(repr(result)) - - -@functions_execution.command("get_result") -@click.argument("execution_id", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.option( - "--timeout", - type=int, - required=False, - help="""Maximum time in seconds to hold the connection open while waiting -for execution to complete. Default: 0 (immediate status check). -Values above 280 are clamped to 280. -""", -) -@click.pass_obj -def functions_execution_op_get_result( - client: FoundryClient, - execution_id: str, - preview: typing.Optional[bool], - timeout: typing.Optional[int], -): - """ - Poll for the result of an async query execution. - - Returns a discriminated union: - - running: execution is still in progress. - - succeeded: execution completed successfully with a return value. - - If the execution failed, a service error is thrown. - - Use the timeout parameter for long-polling: the server holds the - connection open for up to the specified number of seconds. If the - execution completes within that window, the result is returned - immediately. Otherwise, the running variant is returned. - - """ - result = client.functions.Execution.get_result( - execution_id=execution_id, - preview=preview, - timeout=timeout, - ) - click.echo(repr(result)) - - @cli.group("geo") def geo(): pass @@ -6240,12 +5836,6 @@ def language_models_anthropic_model(): """, ) @click.option("--attribution", type=str, required=False, help="""""") -@click.option( - "--output_config", - type=str, - required=False, - help="""Configuration to control the shape of the model's output""", -) @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @@ -6305,7 +5895,6 @@ def language_models_anthropic_model_op_messages( max_tokens: int, messages: str, attribution: typing.Optional[str], - output_config: typing.Optional[str], preview: typing.Optional[bool], stop_sequences: typing.Optional[str], system: typing.Optional[str], @@ -6322,7 +5911,6 @@ def language_models_anthropic_model_op_messages( max_tokens=max_tokens, messages=json.loads(messages), attribution=attribution, - output_config=None if output_config is None else json.loads(output_config), preview=preview, stop_sequences=None if stop_sequences is None else json.loads(stop_sequences), system=None if system is None else json.loads(system), @@ -6407,81 +5995,6 @@ def media_sets_media_set_op_calculate( click.echo(repr(result)) -@media_sets_media_set.command("clear") -@click.argument("media_set_rid", type=str, required=True) -@click.option( - "--media_item_path", - type=str, - required=True, - help="""The path of the media item to clear. -""", -) -@click.option( - "--branch_name", - type=str, - required=False, - help="""Specifies the specific branch by name from which this media item will be cleared. May not be provided if branch rid or view rid are provided.""", -) -@click.option( - "--branch_rid", - type=str, - required=False, - help="""Specifies the specific branch by rid from which this media item will be cleared. May not be provided if branch name or view rid are provided.""", -) -@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( - "--transaction_id", - type=str, - required=False, - help="""The ID of the transaction associated with this request. Required if this is a transactional media set. -""", -) -@click.option( - "--view_rid", - type=str, - required=False, - help="""Specifies the specific view by rid from which this media item will be cleared. May not be provided if branch name or branch rid are provided.""", -) -@click.pass_obj -def media_sets_media_set_op_clear( - client: FoundryClient, - media_set_rid: str, - media_item_path: str, - branch_name: typing.Optional[str], - branch_rid: typing.Optional[str], - preview: typing.Optional[bool], - transaction_id: typing.Optional[str], - view_rid: typing.Optional[str], -): - """ - Clears (soft-deletes) the media item at the specified path within a media set, making it and all older - media items at that path un-retrievable. - - A branch name, branch RID, or view RID may optionally be specified. If none is specified, - the item will be cleared from the default branch. If more than one is specified, an error is thrown. - - For transactional media sets, a transaction ID must be provided. The deletion will not be - visible until the transaction is committed. - - """ - result = client.media_sets.MediaSet.clear( - media_set_rid=media_set_rid, - media_item_path=media_item_path, - branch_name=branch_name, - branch_rid=branch_rid, - preview=preview, - transaction_id=transaction_id, - view_rid=view_rid, - ) - click.echo(repr(result)) - - @media_sets_media_set.command("commit") @click.argument("media_set_rid", type=str, required=True) @click.argument("transaction_id", type=str, required=True) @@ -6546,32 +6059,6 @@ def media_sets_media_set_op_create( click.echo(repr(result)) -@media_sets_media_set.command("get") -@click.argument("media_set_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.pass_obj -def media_sets_media_set_op_get( - client: FoundryClient, - media_set_rid: str, - preview: typing.Optional[bool], -): - """ - Gets information about the media set. - - """ - result = client.media_sets.MediaSet.get( - media_set_rid=media_set_rid, - preview=preview, - ) - click.echo(repr(result)) - - @media_sets_media_set.command("get_result") @click.argument("media_set_rid", type=str, required=True) @click.argument("media_item_rid", type=str, required=True) @@ -6863,68 +6350,6 @@ def media_sets_media_set_op_reference( click.echo(repr(result)) -@media_sets_media_set.command("register") -@click.argument("media_set_rid", type=str, required=True) -@click.option( - "--physical_item_name", - type=str, - required=True, - help="""The relative path within the federated media store where the media item exists.""", -) -@click.option( - "--branch_name", - type=str, - required=False, - help="""Specifies the specific branch by name to which this media item will be registered.""", -) -@click.option("--media_item_path", type=str, required=False, help="""""") -@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( - "--transaction_id", - type=str, - required=False, - help="""The id of the transaction associated with this request. Required for transactional media sets.""", -) -@click.option( - "--view_rid", - type=str, - required=False, - help="""Specifies the specific view by rid to which this media item will be registered.""", -) -@click.pass_obj -def media_sets_media_set_op_register( - client: FoundryClient, - media_set_rid: str, - physical_item_name: str, - branch_name: typing.Optional[str], - media_item_path: typing.Optional[str], - preview: typing.Optional[bool], - transaction_id: typing.Optional[str], - view_rid: typing.Optional[str], -): - """ - Registers a media item that currently resides in a federated media store. Registration will validate the item - against the media set's schema and perform initial metadata extraction. - This endpoint is only applicable for federated media sets. - - """ - result = client.media_sets.MediaSet.register( - media_set_rid=media_set_rid, - physical_item_name=physical_item_name, - branch_name=branch_name, - media_item_path=media_item_path, - preview=preview, - transaction_id=transaction_id, - view_rid=view_rid, - ) - click.echo(repr(result)) - - @media_sets_media_set.command("retrieve") @click.argument("media_set_rid", type=str, required=True) @click.argument("media_item_rid", type=str, required=True) @@ -6963,12 +6388,6 @@ def media_sets_media_set_op_retrieve( @click.argument("media_set_rid", type=str, required=True) @click.argument("media_item_rid", type=str, required=True) @click.option("--transformation", type=str, required=True, help="""""") -@click.option( - "--attribution", - type=str, - required=False, - help="""Optional resource to attribute LLM calls on behalf of.""", -) @click.option( "--preview", type=bool, @@ -6983,7 +6402,6 @@ def media_sets_media_set_op_transform( media_set_rid: str, media_item_rid: str, transformation: str, - attribution: typing.Optional[str], preview: typing.Optional[bool], token: typing.Optional[str], ): @@ -6999,7 +6417,6 @@ def media_sets_media_set_op_transform( media_set_rid=media_set_rid, media_item_rid=media_item_rid, transformation=json.loads(transformation), - attribution=attribution, preview=preview, token=token, ) @@ -7027,19 +6444,6 @@ def media_sets_media_set_op_transform( required=False, help="""An identifier for a media item within a media set. Necessary if the backing media set requires paths.""", ) -@click.option( - "--media_item_rid", - type=str, - required=False, - help="""An optional RID to use for the media item to create. If omitted, the server will automatically generate a -RID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your -workflow strictly requires deterministic or client-controlled identifiers. -The RID must be in the format of `ri.mio..media-item.`, where `` is the same as -the instance part of the media set RID, and `` is a UUID. -An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. -A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. -""", -) @click.option( "--preview", type=bool, @@ -7057,1072 +6461,233 @@ def media_sets_media_set_op_transform( @click.option( "--view_rid", type=str, - required=False, - help="""Specifies the specific view by rid to which this media item will be uploaded. May not be provided if branch name or branch rid are provided.""", -) -@click.pass_obj -def media_sets_media_set_op_upload( - client: FoundryClient, - media_set_rid: str, - body: io.BufferedReader, - branch_name: typing.Optional[str], - branch_rid: typing.Optional[str], - media_item_path: typing.Optional[str], - media_item_rid: typing.Optional[str], - preview: typing.Optional[bool], - transaction_id: typing.Optional[str], - view_rid: typing.Optional[str], -): - """ - Uploads a media item to an existing media set. - The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. - A branch name, or branch rid, or view rid may optionally be specified. If none is specified, the item will be uploaded to the default branch. If more than one is specified, an error is thrown. - - """ - result = client.media_sets.MediaSet.upload( - media_set_rid=media_set_rid, - body=body.read(), - branch_name=branch_name, - branch_rid=branch_rid, - media_item_path=media_item_path, - media_item_rid=media_item_rid, - preview=preview, - transaction_id=transaction_id, - view_rid=view_rid, - ) - click.echo(repr(result)) - - -@media_sets_media_set.command("upload_media") -@click.argument("body", type=click.File("rb"), required=True) -@click.option( - "--filename", - type=str, - required=True, - help="""A user-defined label for a media item within a media set. Required if the backing media set requires paths. -Uploading multiple files to the same path will result in only the most recent file being associated with the -path. -""", -) -@click.option( - "--attribution", type=str, required=False, help="""used for passing through usage attribution""" -) -@click.option( - "--media_item_rid", - type=str, - required=False, - help="""An optional RID to use for the media item to create. If omitted, the server will automatically generate a -RID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your -workflow strictly requires deterministic or client-controlled identifiers. -The RID must be in the format of `ri.mio..media-item.`, where `` is the same as -the instance part of the media set RID, and `` is a UUID. -An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. -A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. -""", -) -@click.option( - "--preview", - type=bool, - required=False, - help="""A boolean flag that, when set to true, enables the use of beta features in preview mode. -""", -) -@click.pass_obj -def media_sets_media_set_op_upload_media( - client: FoundryClient, - body: io.BufferedReader, - filename: str, - attribution: typing.Optional[str], - media_item_rid: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Uploads a temporary media item. If the media item isn't persisted within 1 hour, the item will be deleted. - - If multiple resources are attributed to, usage will be attributed to the first one in the list. - - The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. - Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read api:ontologies-write`. - - """ - result = client.media_sets.MediaSet.upload_media( - body=body.read(), - filename=filename, - attribution=attribution, - media_item_rid=media_item_rid, - preview=preview, - ) - click.echo(repr(result)) - - -@cli.group("models") -def models(): - pass - - -@models.group("model_studio_trainer") -def models_model_studio_trainer(): - pass - - -@models_model_studio_trainer.command("get") -@click.argument("model_studio_trainer_trainer_id", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.option( - "--version", - type=str, - required=False, - help="""Specific version of the trainer to retrieve. If not specified, returns the latest version.""", -) -@click.pass_obj -def models_model_studio_trainer_op_get( - client: FoundryClient, - model_studio_trainer_trainer_id: str, - preview: typing.Optional[bool], - version: typing.Optional[str], -): - """ - Gets details about a specific trainer by its ID and optional version. - """ - result = client.models.ModelStudioTrainer.get( - model_studio_trainer_trainer_id=model_studio_trainer_trainer_id, - preview=preview, - version=version, - ) - click.echo(repr(result)) - - -@models_model_studio_trainer.command("list") -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_studio_trainer_op_list( - client: FoundryClient, - preview: typing.Optional[bool], -): - """ - Lists all available trainers for Model Studios. - """ - result = client.models.ModelStudioTrainer.list( - preview=preview, - ) - click.echo(repr(result)) - - -@models.group("model_studio") -def models_model_studio(): - pass - - -@models_model_studio.command("create") -@click.option("--name", type=str, required=True, help="""The name of the Model Studio.""") -@click.option( - "--parent_folder_rid", - type=str, - required=True, - help="""The RID of the parent folder where the studio will be created.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_studio_op_create( - client: FoundryClient, - name: str, - parent_folder_rid: str, - preview: typing.Optional[bool], -): - """ - Creates a new Model Studio. - """ - result = client.models.ModelStudio.create( - name=name, - parent_folder_rid=parent_folder_rid, - preview=preview, - ) - click.echo(repr(result)) - - -@models_model_studio.command("get") -@click.argument("model_studio_rid", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_studio_op_get( - client: FoundryClient, - model_studio_rid: str, - preview: typing.Optional[bool], -): - """ - Gets details about a Model Studio by its RID. - """ - result = client.models.ModelStudio.get( - model_studio_rid=model_studio_rid, - preview=preview, - ) - click.echo(repr(result)) - - -@models_model_studio.command("launch") -@click.argument("model_studio_rid", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_studio_op_launch( - client: FoundryClient, - model_studio_rid: str, - preview: typing.Optional[bool], -): - """ - Launches a new training run for the Model Studio using the latest configuration version. - """ - result = client.models.ModelStudio.launch( - model_studio_rid=model_studio_rid, - preview=preview, - ) - click.echo(repr(result)) - - -@models_model_studio.group("model_studio_config_version") -def models_model_studio_model_studio_config_version(): - pass - - -@models_model_studio_model_studio_config_version.command("create") -@click.argument("model_studio_rid", type=str, required=True) -@click.option( - "--name", - type=str, - required=True, - help="""Human readable name of the configuration version and experiment.""", -) -@click.option( - "--resources", - type=str, - required=True, - help="""The compute resources allocated for training runs.""", -) -@click.option( - "--trainer_id", - type=str, - required=True, - help="""The identifier of the trainer to use for this configuration.""", -) -@click.option( - "--worker_config", - type=str, - required=True, - help="""The worker configuration including inputs, outputs, and custom settings.""", -) -@click.option( - "--changelog", - type=str, - required=False, - help="""Changelog describing changes in this version.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_studio_model_studio_config_version_op_create( - client: FoundryClient, - model_studio_rid: str, - name: str, - resources: str, - trainer_id: str, - worker_config: str, - changelog: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Creates a new Model Studio configuration version. - """ - result = client.models.ModelStudio.ConfigVersion.create( - model_studio_rid=model_studio_rid, - name=name, - resources=json.loads(resources), - trainer_id=trainer_id, - worker_config=json.loads(worker_config), - changelog=changelog, - preview=preview, - ) - click.echo(repr(result)) - - -@models_model_studio_model_studio_config_version.command("get") -@click.argument("model_studio_rid", type=str, required=True) -@click.argument("model_studio_config_version_version", type=int, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_studio_model_studio_config_version_op_get( - client: FoundryClient, - model_studio_rid: str, - model_studio_config_version_version: int, - preview: typing.Optional[bool], -): - """ - Gets a specific Model Studio configuration version. - """ - result = client.models.ModelStudio.ConfigVersion.get( - model_studio_rid=model_studio_rid, - model_studio_config_version_version=model_studio_config_version_version, - preview=preview, - ) - click.echo(repr(result)) - - -@models_model_studio_model_studio_config_version.command("latest") -@click.argument("model_studio_rid", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_studio_model_studio_config_version_op_latest( - client: FoundryClient, - model_studio_rid: str, - preview: typing.Optional[bool], -): - """ - Gets the latest configuration version for a Model Studio. - """ - result = client.models.ModelStudio.ConfigVersion.latest( - model_studio_rid=model_studio_rid, - preview=preview, - ) - click.echo(repr(result)) - - -@models_model_studio_model_studio_config_version.command("list") -@click.argument("model_studio_rid", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""The page token indicates where to start paging. This should be omitted from the first page's request. -To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response -and use it to populate the `pageToken` field of the next request.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_studio_model_studio_config_version_op_list( - client: FoundryClient, - model_studio_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Lists all configuration versions for a Model Studio. - """ - result = client.models.ModelStudio.ConfigVersion.list( - model_studio_rid=model_studio_rid, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - -@models_model_studio.group("model_studio_run") -def models_model_studio_model_studio_run(): - pass - - -@models_model_studio_model_studio_run.command("list") -@click.argument("model_studio_rid", type=str, required=True) -@click.option( - "--config_version", type=int, required=False, help="""Filter runs by configuration version.""" -) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""The page token indicates where to start paging. This should be omitted from the first page's request. -To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response -and use it to populate the `pageToken` field of the next request.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_studio_model_studio_run_op_list( - client: FoundryClient, - model_studio_rid: str, - config_version: typing.Optional[int], - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Lists all runs for a Model Studio. - """ - result = client.models.ModelStudio.Run.list( - model_studio_rid=model_studio_rid, - config_version=config_version, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - -@models.group("model") -def models_model(): - pass - - -@models_model.command("create") -@click.option("--name", type=str, required=True, help="""""") -@click.option("--parent_folder_rid", type=str, required=True, help="""""") -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_op_create( - client: FoundryClient, - name: str, - parent_folder_rid: str, - preview: typing.Optional[bool], -): - """ - Creates a new Model with no versions. - """ - result = client.models.Model.create( - name=name, - parent_folder_rid=parent_folder_rid, - preview=preview, - ) - click.echo(repr(result)) - - -@models_model.command("get") -@click.argument("model_rid", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_op_get( - client: FoundryClient, - model_rid: str, - preview: typing.Optional[bool], -): - """ - Retrieves a Model by its Resource Identifier (RID). - """ - result = client.models.Model.get( - model_rid=model_rid, - preview=preview, - ) - click.echo(repr(result)) - - -@models_model.command("promote_version") -@click.argument("model_rid", type=str, required=True) -@click.option("--source_model_version_rid", type=str, required=True, help="""""") -@click.option( - "--branch", - type=str, - required=False, - help="""The branch to promote the version to. Defaults to master on most enrollments. -""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_op_promote_version( - client: FoundryClient, - model_rid: str, - source_model_version_rid: str, - branch: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Promotes an existing Model Version to the target Model. The promoted Model Version will be copied to the target Model as the latest version on the specified branch, but will have a new Model Version RID. - - """ - result = client.models.Model.promote_version( - model_rid=model_rid, - source_model_version_rid=source_model_version_rid, - branch=branch, - preview=preview, - ) - click.echo(repr(result)) - - -@models_model.group("model_version") -def models_model_model_version(): - pass - - -@models_model_model_version.command("create") -@click.argument("model_rid", type=str, required=True) -@click.option("--backing_repositories", type=str, required=True, help="""""") -@click.option("--conda_requirements", type=str, required=True, help="""""") -@click.option("--model_api", type=str, required=True, help="""""") -@click.option("--model_files", type=str, required=True, help="""""") -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_model_version_op_create( - client: FoundryClient, - model_rid: str, - backing_repositories: str, - conda_requirements: str, - model_api: str, - model_files: str, - preview: typing.Optional[bool], -): - """ - Creates a new Model Version on an existing model. - """ - result = client.models.Model.Version.create( - model_rid=model_rid, - backing_repositories=json.loads(backing_repositories), - conda_requirements=json.loads(conda_requirements), - model_api=json.loads(model_api), - model_files=json.loads(model_files), - preview=preview, - ) - click.echo(repr(result)) - - -@models_model_model_version.command("get") -@click.argument("model_rid", type=str, required=True) -@click.argument("model_version_rid", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_model_version_op_get( - client: FoundryClient, - model_rid: str, - model_version_rid: str, - preview: typing.Optional[bool], -): - """ - Retrieves a Model Version by its Resource Identifier (RID). - """ - result = client.models.Model.Version.get( - model_rid=model_rid, - model_version_rid=model_version_rid, - preview=preview, - ) - click.echo(repr(result)) - - -@models_model_model_version.command("list") -@click.argument("model_rid", type=str, required=True) -@click.option( - "--branch", - type=str, - required=False, - help="""The branch to list versions from. Defaults to master on most enrollments. -""", -) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""The page token indicates where to start paging. This should be omitted from the first page's request. -To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response -and use it to populate the `pageToken` field of the next request.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_model_version_op_list( - client: FoundryClient, - model_rid: str, - branch: typing.Optional[str], - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Lists all Model Versions for a given Model. - """ - result = client.models.Model.Version.list( - model_rid=model_rid, - branch=branch, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - -@models_model.group("experiment") -def models_model_experiment(): - pass - - -@models_model_experiment.command("get") -@click.argument("model_rid", type=str, required=True) -@click.argument("experiment_rid", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_experiment_op_get( - client: FoundryClient, - model_rid: str, - experiment_rid: str, - preview: typing.Optional[bool], -): - """ - Retrieve a single experiment with all metadata, parameters, series metadata, and summary metrics. - - """ - result = client.models.Model.Experiment.get( - model_rid=model_rid, - experiment_rid=experiment_rid, - preview=preview, - ) - click.echo(repr(result)) - - -@models_model_experiment.command("search") -@click.argument("model_rid", type=str, required=True) -@click.option( - "--order_by", - type=str, - required=False, - help="""The field to sort by. Default is to sort by relevance.""", -) -@click.option( - "--page_size", - type=int, - required=False, - help="""The maximum number of results to return. Default 50, maximum of 100.""", -) -@click.option( - "--page_token", - type=str, - required=False, - help="""PageToken to identify the next page to retrieve. Leave empty for the first request.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.option( - "--where", - type=str, - required=False, - help="""Optional search filter for filtering experiments. If not provided, all experiments for the model are returned.""", -) -@click.pass_obj -def models_model_experiment_op_search( - client: FoundryClient, - model_rid: str, - order_by: typing.Optional[str], - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], - where: typing.Optional[str], -): - """ - Search experiments using complex nested queries on experiment metadata, parameters, series, - and summary metrics. Supports AND/OR/NOT combinations and various predicates. - Returns a maximum of 100 results per page. - - """ - result = client.models.Model.Experiment.search( - model_rid=model_rid, - order_by=None if order_by is None else json.loads(order_by), - page_size=page_size, - page_token=page_token, - preview=preview, - where=None if where is None else json.loads(where), - ) - click.echo(repr(result)) - - -@models_model_experiment.group("experiment_artifact_table") -def models_model_experiment_experiment_artifact_table(): - pass - - -@models_model_experiment_experiment_artifact_table.command("json") -@click.argument("model_rid", type=str, required=True) -@click.argument("experiment_rid", type=str, required=True) -@click.argument("experiment_artifact_table_name", type=str, required=True) -@click.option( - "--offset", - type=int, - required=False, - help="""Number of rows to skip from the beginning. Defaults to 0.""", -) -@click.option( - "--page_size", - type=int, - required=False, - help="""Maximum number of rows to return. Default is 10, maximum is 100.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_experiment_experiment_artifact_table_op_json( - client: FoundryClient, - model_rid: str, - experiment_rid: str, - experiment_artifact_table_name: str, - offset: typing.Optional[int], - page_size: typing.Optional[int], - preview: typing.Optional[bool], -): - """ - Read table data from an experiment artifact as a streamed binary response containing JSON. - The response body is a JSON array of row objects, where each object maps column names to values. - Results are paginated by row count with a default page size of 10 and a maximum of 100. - - """ - result = client.models.Model.Experiment.ArtifactTable.json( - model_rid=model_rid, - experiment_rid=experiment_rid, - experiment_artifact_table_name=experiment_artifact_table_name, - offset=offset, - page_size=page_size, - preview=preview, - ) - click.echo(result) - - -@models_model_experiment_experiment_artifact_table.command("parquet") -@click.argument("model_rid", type=str, required=True) -@click.argument("experiment_rid", type=str, required=True) -@click.argument("experiment_artifact_table_name", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_experiment_experiment_artifact_table_op_parquet( - client: FoundryClient, - model_rid: str, - experiment_rid: str, - experiment_artifact_table_name: str, - preview: typing.Optional[bool], -): - """ - Read raw table data from experiment artifacts in Parquet format. - - """ - result = client.models.Model.Experiment.ArtifactTable.parquet( - model_rid=model_rid, - experiment_rid=experiment_rid, - experiment_artifact_table_name=experiment_artifact_table_name, - preview=preview, - ) - click.echo(result) - - -@models_model_experiment.group("experiment_series") -def models_model_experiment_experiment_series(): - pass - - -@models_model_experiment_experiment_series.command("json") -@click.argument("model_rid", type=str, required=True) -@click.argument("experiment_rid", type=str, required=True) -@click.argument("experiment_series_name", type=str, required=True) -@click.option( - "--offset", - type=int, - required=False, - help="""Number of values to skip from the beginning. Defaults to 0.""", -) -@click.option( - "--page_size", - type=int, - required=False, - help="""Maximum number of values to return per page. Default is 200, maximum is 1000.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_model_experiment_experiment_series_op_json( - client: FoundryClient, - model_rid: str, - experiment_rid: str, - experiment_series_name: str, - offset: typing.Optional[int], - page_size: typing.Optional[int], - preview: typing.Optional[bool], -): - """ - Retrieve raw time-series data for a single series in JSON format. - Results are paginated with a default page size of 200 and a maximum of 1000. - - """ - result = client.models.Model.Experiment.Series.json( - model_rid=model_rid, - experiment_rid=experiment_rid, - experiment_series_name=experiment_series_name, - offset=offset, - page_size=page_size, - preview=preview, - ) - click.echo(repr(result)) - - -@models_model_experiment_experiment_series.command("parquet") -@click.argument("model_rid", type=str, required=True) -@click.argument("experiment_rid", type=str, required=True) -@click.argument("experiment_series_name", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" + required=False, + help="""Specifies the specific view by rid to which this media item will be uploaded. May not be provided if branch name or branch rid are provided.""", ) @click.pass_obj -def models_model_experiment_experiment_series_op_parquet( +def media_sets_media_set_op_upload( client: FoundryClient, - model_rid: str, - experiment_rid: str, - experiment_series_name: str, + media_set_rid: str, + body: io.BufferedReader, + branch_name: typing.Optional[str], + branch_rid: typing.Optional[str], + media_item_path: typing.Optional[str], preview: typing.Optional[bool], + transaction_id: typing.Optional[str], + view_rid: typing.Optional[str], ): """ - Retrieve raw time-series data for a single series as a streamed binary response in Apache Parquet format. + Uploads a media item to an existing media set. + The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. + A branch name, or branch rid, or view rid may optionally be specified. If none is specified, the item will be uploaded to the default branch. If more than one is specified, an error is thrown. """ - result = client.models.Model.Experiment.Series.parquet( - model_rid=model_rid, - experiment_rid=experiment_rid, - experiment_series_name=experiment_series_name, + result = client.media_sets.MediaSet.upload( + media_set_rid=media_set_rid, + body=body.read(), + branch_name=branch_name, + branch_rid=branch_rid, + media_item_path=media_item_path, preview=preview, + transaction_id=transaction_id, + view_rid=view_rid, ) - click.echo(result) - - -@models.group("live_deployment") -def models_live_deployment(): - pass + click.echo(repr(result)) -@models_live_deployment.command("create") +@media_sets_media_set.command("upload_media") +@click.argument("body", type=click.File("rb"), required=True) @click.option( - "--deployment_type", + "--filename", type=str, required=True, - help="""The target model source for the live deployment. Determines which model and version selection strategy to use when creating the deployment. + help="""The path to write the media item to. Required if the backing media set requires paths. """, ) @click.option( - "--runtime_configuration", - type=str, - required=True, - help="""The compute resource configuration for the deployment.""", + "--attribution", type=str, required=False, help="""used for passing through usage attribution""" ) @click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" + "--preview", + type=bool, + required=False, + help="""A boolean flag that, when set to true, enables the use of beta features in preview mode. +""", ) @click.pass_obj -def models_live_deployment_op_create( +def media_sets_media_set_op_upload_media( client: FoundryClient, - deployment_type: str, - runtime_configuration: str, + body: io.BufferedReader, + filename: str, + attribution: typing.Optional[str], preview: typing.Optional[bool], ): """ - Creates a new live deployment for a model version with the specified runtime configuration. The deployment will begin provisioning compute resources and deploying the target model version. + Uploads a temporary media item. If the media item isn't persisted within 1 hour, the item will be deleted. + + If multiple resources are attributed to, usage will be attributed to the first one in the list. + + The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. + Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read api:ontologies-write`. """ - result = client.models.LiveDeployment.create( - deployment_type=json.loads(deployment_type), - runtime_configuration=json.loads(runtime_configuration), + result = client.media_sets.MediaSet.upload_media( + body=body.read(), + filename=filename, + attribution=attribution, preview=preview, ) click.echo(repr(result)) -@models_live_deployment.command("get") -@click.argument("live_deployment_rid", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def models_live_deployment_op_get( - client: FoundryClient, - live_deployment_rid: str, - preview: typing.Optional[bool], -): - """ - Retrieves a live deployment by its Resource Identifier (RID), including its deployed model version and runtime configuration. +@cli.group("models") +def models(): + pass - """ - result = client.models.LiveDeployment.get( - live_deployment_rid=live_deployment_rid, - preview=preview, - ) - click.echo(repr(result)) + +@models.group("model") +def models_model(): + pass -@models_live_deployment.command("replace") -@click.argument("live_deployment_rid", type=str, required=True) -@click.option( - "--runtime_configuration", - type=str, - required=True, - help="""The compute resource configuration for the deployment.""", -) +@models_model.command("create") +@click.option("--name", type=str, required=True, help="""""") +@click.option("--parent_folder_rid", type=str, required=True, help="""""") @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def models_live_deployment_op_replace( +def models_model_op_create( client: FoundryClient, - live_deployment_rid: str, - runtime_configuration: str, + name: str, + parent_folder_rid: str, preview: typing.Optional[bool], ): """ - Updates the runtime configuration of the live deployment. The deployment will apply the new configuration to the running replicas. - + Creates a new Model with no versions. """ - result = client.models.LiveDeployment.replace( - live_deployment_rid=live_deployment_rid, - runtime_configuration=json.loads(runtime_configuration), + result = client.models.Model.create( + name=name, + parent_folder_rid=parent_folder_rid, preview=preview, ) click.echo(repr(result)) -@models_live_deployment.command("transform_json") -@click.argument("live_deployment_rid", type=str, required=True) -@click.option( - "--input", - type=str, - required=True, - help="""The input data for the model inference. The structure should match the model's transform API specification, where each key is an input name and the value is the corresponding input data. -""", -) +@models_model.command("get") +@click.argument("model_rid", type=str, required=True) @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def models_live_deployment_op_transform_json( +def models_model_op_get( client: FoundryClient, - live_deployment_rid: str, - input: str, + model_rid: str, preview: typing.Optional[bool], ): """ - Performs inference on the live deployment. - + Retrieves a Model by its Resource Identifier (RID). """ - result = client.models.LiveDeployment.transform_json( - live_deployment_rid=live_deployment_rid, - input=json.loads(input), + result = client.models.Model.get( + model_rid=model_rid, preview=preview, ) click.echo(repr(result)) -@models_live_deployment.group("model_function") -def models_live_deployment_model_function(): +@models_model.group("model_version") +def models_model_model_version(): pass -@models_live_deployment_model_function.command("create") -@click.argument("live_deployment_rid", type=str, required=True) -@click.option("--api_name", type=str, required=True, help="""""") -@click.option("--display_name", type=str, required=True, help="""""") -@click.option("--is_row_wise", type=bool, required=True, help="""""") -@click.option("--ontology_binding", type=str, required=False, help="""""") +@models_model_model_version.command("create") +@click.argument("model_rid", type=str, required=True) +@click.option("--backing_repositories", type=str, required=True, help="""""") +@click.option("--conda_requirements", type=str, required=True, help="""""") +@click.option("--model_api", type=str, required=True, help="""""") +@click.option("--model_files", type=str, required=True, help="""""") @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def models_live_deployment_model_function_op_create( +def models_model_model_version_op_create( client: FoundryClient, - live_deployment_rid: str, - api_name: str, - display_name: str, - is_row_wise: bool, - ontology_binding: typing.Optional[str], + model_rid: str, + backing_repositories: str, + conda_requirements: str, + model_api: str, + model_files: str, preview: typing.Optional[bool], ): """ - Creates a function for the live deployment. + Creates a new Model Version on an existing model. """ - result = client.models.LiveDeployment.Function.create( - live_deployment_rid=live_deployment_rid, - api_name=api_name, - display_name=display_name, - is_row_wise=is_row_wise, - ontology_binding=ontology_binding, + result = client.models.Model.Version.create( + model_rid=model_rid, + backing_repositories=json.loads(backing_repositories), + conda_requirements=json.loads(conda_requirements), + model_api=json.loads(model_api), + model_files=json.loads(model_files), preview=preview, ) click.echo(repr(result)) -@models_live_deployment_model_function.command("get") -@click.argument("live_deployment_rid", type=str, required=True) +@models_model_model_version.command("get") +@click.argument("model_rid", type=str, required=True) +@click.argument("model_version_rid", type=str, required=True) @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def models_live_deployment_model_function_op_get( +def models_model_model_version_op_get( client: FoundryClient, - live_deployment_rid: str, + model_rid: str, + model_version_rid: str, preview: typing.Optional[bool], ): """ - Gets the function for the live deployment. + Retrieves a Model Version by its Resource Identifier (RID). """ - result = client.models.LiveDeployment.Function.get( - live_deployment_rid=live_deployment_rid, + result = client.models.Model.Version.get( + model_rid=model_rid, + model_version_rid=model_version_rid, preview=preview, ) click.echo(repr(result)) -@models_live_deployment_model_function.command("replace") -@click.argument("live_deployment_rid", type=str, required=True) -@click.option("--api_name", type=str, required=True, help="""""") -@click.option("--is_row_wise", type=bool, required=True, help="""""") -@click.option("--ontology_binding", type=str, required=False, help="""""") +@models_model_model_version.command("list") +@click.argument("model_rid", type=str, required=True) +@click.option( + "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" +) +@click.option( + "--page_token", + type=str, + required=False, + help="""The page token indicates where to start paging. This should be omitted from the first page's request. +To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response +and use it to populate the `pageToken` field of the next request.""", +) @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def models_live_deployment_model_function_op_replace( +def models_model_model_version_op_list( client: FoundryClient, - live_deployment_rid: str, - api_name: str, - is_row_wise: bool, - ontology_binding: typing.Optional[str], + model_rid: str, + page_size: typing.Optional[int], + page_token: typing.Optional[str], preview: typing.Optional[bool], ): """ - Replaces the function for the live deployment. + Lists all Model Versions for a given Model. """ - result = client.models.LiveDeployment.Function.replace( - live_deployment_rid=live_deployment_rid, - api_name=api_name, - is_row_wise=is_row_wise, - ontology_binding=ontology_binding, + result = client.models.Model.Version.list( + model_rid=model_rid, + page_size=page_size, + page_token=page_token, preview=preview, ) click.echo(repr(result)) @@ -8398,16 +6963,6 @@ def ontologies_query(): help="""The Attribution to be used when executing this request. """, ) -@click.option( - "--branch", - type=str, - required=False, - help="""The Foundry branch to execute the query from. If not specified, the default branch is used. -Branches are an experimental feature and not all workflows are supported. -When provided without `version`, the latest version on this branch is used, including pre-release versions. -When provided with `version`, the specified version must exist on the branch. -""", -) @click.option( "--sdk_package_rid", type=str, @@ -8448,7 +7003,7 @@ def ontologies_query(): "--version", type=str, required=False, - help="""The version of the Query to execute. When used with `branch`, the specified version must exist on the branch. + help="""The version of the Query to execute. """, ) @click.pass_obj @@ -8458,7 +7013,6 @@ def ontologies_query_op_execute( query_api_name: str, parameters: str, attribution: typing.Optional[str], - branch: typing.Optional[str], sdk_package_rid: typing.Optional[str], sdk_version: typing.Optional[str], trace_parent: typing.Optional[str], @@ -8477,7 +7031,6 @@ def ontologies_query_op_execute( query_api_name=query_api_name, parameters=json.loads(parameters), attribution=attribution, - branch=branch, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version, trace_parent=trace_parent, @@ -8642,20 +7195,6 @@ def ontologies_ontology_object_set(): help="""The package version of the generated SDK. """, ) -@click.option( - "--trace_parent", - type=str, - required=False, - help="""The W3C trace parent header included in the request. -""", -) -@click.option( - "--trace_state", - type=str, - required=False, - help="""The W3C trace state header included in the request. -""", -) @click.option( "--transaction_id", type=str, @@ -8676,8 +7215,6 @@ def ontologies_ontology_object_set_op_aggregate( include_compute_usage: typing.Optional[bool], sdk_package_rid: typing.Optional[str], sdk_version: typing.Optional[str], - trace_parent: typing.Optional[str], - trace_state: typing.Optional[str], transaction_id: typing.Optional[str], ): """ @@ -8694,8 +7231,6 @@ def ontologies_ontology_object_set_op_aggregate( include_compute_usage=include_compute_usage, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version, - trace_parent=trace_parent, - trace_state=trace_state, transaction_id=transaction_id, ) click.echo(repr(result)) @@ -8726,20 +7261,6 @@ def ontologies_ontology_object_set_op_aggregate( help="""The package version of the generated SDK. """, ) -@click.option( - "--trace_parent", - type=str, - required=False, - help="""The W3C trace parent header included in the request. -""", -) -@click.option( - "--trace_state", - type=str, - required=False, - help="""The W3C trace state header included in the request. -""", -) @click.pass_obj def ontologies_ontology_object_set_op_create_temporary( client: FoundryClient, @@ -8748,8 +7269,6 @@ def ontologies_ontology_object_set_op_create_temporary( branch: typing.Optional[str], sdk_package_rid: typing.Optional[str], sdk_version: typing.Optional[str], - trace_parent: typing.Optional[str], - trace_state: typing.Optional[str], ): """ Creates a temporary `ObjectSet` from the given definition. This `ObjectSet` expires after one hour. @@ -8761,8 +7280,6 @@ def ontologies_ontology_object_set_op_create_temporary( branch=branch, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version, - trace_parent=trace_parent, - trace_state=trace_state, ) click.echo(repr(result)) @@ -8854,20 +7371,6 @@ def ontologies_ontology_object_set_op_get( This defaults to false if not specified, which means you will always get the latest results. """, ) -@click.option( - "--trace_parent", - type=str, - required=False, - help="""The W3C trace parent header included in the request. -""", -) -@click.option( - "--trace_state", - type=str, - required=False, - help="""The W3C trace state header included in the request. -""", -) @click.option( "--transaction_id", type=str, @@ -8893,8 +7396,6 @@ def ontologies_ontology_object_set_op_load( sdk_version: typing.Optional[str], select_v2: typing.Optional[str], snapshot: typing.Optional[bool], - trace_parent: typing.Optional[str], - trace_state: typing.Optional[str], transaction_id: typing.Optional[str], ): """ @@ -8923,8 +7424,6 @@ def ontologies_ontology_object_set_op_load( sdk_version=sdk_version, select_v2=None if select_v2 is None else json.loads(select_v2), snapshot=snapshot, - trace_parent=trace_parent, - trace_state=trace_state, transaction_id=transaction_id, ) click.echo(repr(result)) @@ -8965,20 +7464,6 @@ def ontologies_ontology_object_set_op_load( help="""The package version of the generated SDK. """, ) -@click.option( - "--trace_parent", - type=str, - required=False, - help="""The W3C trace parent header included in the request. -""", -) -@click.option( - "--trace_state", - type=str, - required=False, - help="""The W3C trace state header included in the request. -""", -) @click.pass_obj def ontologies_ontology_object_set_op_load_links( client: FoundryClient, @@ -8991,8 +7476,6 @@ def ontologies_ontology_object_set_op_load_links( preview: typing.Optional[bool], sdk_package_rid: typing.Optional[str], sdk_version: typing.Optional[str], - trace_parent: typing.Optional[str], - trace_state: typing.Optional[str], ): """ Loads the specified links from the defined object set. @@ -9021,8 +7504,6 @@ def ontologies_ontology_object_set_op_load_links( preview=preview, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version, - trace_parent=trace_parent, - trace_state=trace_state, ) click.echo(repr(result)) @@ -9098,21 +7579,7 @@ def ontologies_ontology_object_set_op_load_links( help="""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. -""", -) -@click.option( - "--trace_parent", - type=str, - required=False, - help="""The W3C trace parent header included in the request. -""", -) -@click.option( - "--trace_state", - type=str, - required=False, - help="""The W3C trace state header included in the request. +This defaults to false if not specified, which means you will always get the latest results. """, ) @click.option( @@ -9141,8 +7608,6 @@ def ontologies_ontology_object_set_op_load_multiple_object_types( sdk_version: typing.Optional[str], select_v2: typing.Optional[str], snapshot: typing.Optional[bool], - trace_parent: typing.Optional[str], - trace_state: typing.Optional[str], transaction_id: typing.Optional[str], ): """ @@ -9177,8 +7642,6 @@ def ontologies_ontology_object_set_op_load_multiple_object_types( sdk_version=sdk_version, select_v2=None if select_v2 is None else json.loads(select_v2), snapshot=snapshot, - trace_parent=trace_parent, - trace_state=trace_state, transaction_id=transaction_id, ) click.echo(repr(result)) @@ -9246,28 +7709,6 @@ def ontologies_ontology_object_set_op_load_multiple_object_types( This defaults to false if not specified, which means you will always get the latest results. """, ) -@click.option( - "--trace_parent", - type=str, - required=False, - help="""The W3C trace parent header included in the request. -""", -) -@click.option( - "--trace_state", - type=str, - required=False, - help="""The W3C trace state header included in the request. -""", -) -@click.option( - "--transaction_id", - type=str, - required=False, - help="""The ID of an Ontology transaction to read from. -Transactions are an experimental feature and all workflows may not be supported. -""", -) @click.pass_obj def ontologies_ontology_object_set_op_load_objects_or_interfaces( client: FoundryClient, @@ -9284,9 +7725,6 @@ def ontologies_ontology_object_set_op_load_objects_or_interfaces( sdk_version: typing.Optional[str], select_v2: typing.Optional[str], snapshot: typing.Optional[bool], - trace_parent: typing.Optional[str], - trace_state: typing.Optional[str], - transaction_id: typing.Optional[str], ): """ Load the ontology objects present in the `ObjectSet` from the provided object set definition. If the requested @@ -9320,9 +7758,6 @@ def ontologies_ontology_object_set_op_load_objects_or_interfaces( sdk_version=sdk_version, select_v2=None if select_v2 is None else json.loads(select_v2), snapshot=snapshot, - trace_parent=trace_parent, - trace_state=trace_state, - transaction_id=transaction_id, ) click.echo(repr(result)) @@ -10092,13 +8527,6 @@ def ontologies_ontology_interface_op_list_interface_linked_objects( """, ) @click.option("--page_token", type=str, required=False, help="""""") -@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( "--select", type=str, @@ -10127,7 +8555,6 @@ def ontologies_ontology_interface_op_list_objects_for_interface( order_by: typing.Optional[str], page_size: typing.Optional[int], page_token: typing.Optional[str], - preview: typing.Optional[bool], select: typing.Optional[str], snapshot: typing.Optional[bool], ): @@ -10155,7 +8582,6 @@ def ontologies_ontology_interface_op_list_objects_for_interface( order_by=order_by, page_size=page_size, page_token=page_token, - preview=preview, select=None if select is None else json.loads(select), snapshot=snapshot, ) @@ -10516,14 +8942,6 @@ def ontologies_ontology_query_type_op_get( @ontologies_ontology_query_type.command("list") @click.argument("ontology", type=str, required=True) -@click.option( - "--branch", - type=str, - required=False, - help="""The Foundry branch to list queries from. If not specified, the default branch will be used. -Branches are an experimental feature and not all workflows are supported. -""", -) @click.option( "--page_size", type=int, @@ -10537,7 +8955,6 @@ def ontologies_ontology_query_type_op_get( def ontologies_ontology_query_type_op_list( client: FoundryClient, ontology: str, - branch: typing.Optional[str], page_size: typing.Optional[int], page_token: typing.Optional[str], ): @@ -10550,7 +8967,6 @@ def ontologies_ontology_query_type_op_list( """ result = client.ontologies.Ontology.QueryType.list( ontology=ontology, - branch=branch, page_size=page_size, page_token=page_token, ) @@ -10592,50 +9008,6 @@ def ontologies_ontology_object_type_op_get( click.echo(repr(result)) -@ontologies_ontology_object_type.command("get_by_rid_batch") -@click.argument("ontology", type=str, required=True) -@click.option("--requests", type=str, required=True, help="""""") -@click.option( - "--branch", - type=str, - required=False, - help="""The Foundry branch to load the object type definitions from. If not specified, the default branch will be used. -Branches are an experimental feature and not all workflows are supported. -""", -) -@click.option( - "--preview", - type=bool, - required=False, - help="""A boolean flag that, when set to true, enables the use of beta features in preview mode. -""", -) -@click.pass_obj -def ontologies_ontology_object_type_op_get_by_rid_batch( - client: FoundryClient, - ontology: str, - requests: str, - branch: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Gets a list of object types by RID in bulk. - - Object types are filtered from the response if they don't exist or the requesting token lacks the required - permissions. - - The maximum batch size for this endpoint is 100. - - """ - result = client.ontologies.Ontology.ObjectType.get_by_rid_batch( - ontology=ontology, - requests=json.loads(requests), - branch=branch, - preview=preview, - ) - click.echo(repr(result)) - - @ontologies_ontology_object_type.command("get_edits_history") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @@ -10683,9 +9055,10 @@ def ontologies_ontology_object_type_op_get_edits_history( specific object type. This endpoint provides visibility into all actions that have modified objects of this type. - The edits are returned in reverse chronological order (most recent first) by default. + The edits are returned in reverse chronological order (most recent first). - Note that filters are ignored for OSv1 object types. + WARNING: right now this endpoint works only if you pass in an object primary key, i.e. it does not function + as a global object type edits history. Global object type edits history is currently under development. """ result = client.ontologies.Ontology.ObjectType.get_edits_history( @@ -10792,63 +9165,6 @@ def ontologies_ontology_object_type_op_get_outgoing_link_type( click.echo(repr(result)) -@ontologies_ontology_object_type.command("get_outgoing_link_types_by_object_type_rid_batch") -@click.argument("ontology", type=str, required=True) -@click.option( - "--filter_link_type_rids", - type=str, - required=True, - help="""If provided, only return outgoing link types with RIDs in this list. -If omitted, all outgoing link types for each requested object type are returned. -""", -) -@click.option("--requests", type=str, required=True, help="""""") -@click.option( - "--branch", - type=str, - required=False, - help="""The Foundry branch to load the outgoing link type definitions from. If not specified, the default branch will be used. -Branches are an experimental feature and not all workflows are supported. -""", -) -@click.option( - "--preview", - type=bool, - required=False, - help="""A boolean flag that, when set to true, enables the use of beta features in preview mode. -""", -) -@click.pass_obj -def ontologies_ontology_object_type_op_get_outgoing_link_types_by_object_type_rid_batch( - client: FoundryClient, - ontology: str, - filter_link_type_rids: str, - requests: str, - branch: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Gets outgoing link types for a batch of object types, identified by their RIDs. - - For each requested object type, returns the list of outgoing link types visible to the - requesting token. Optionally, results can be filtered to only include specific link type RIDs. - - Object types that don't exist or that the requesting token lacks permissions for are - silently omitted from the response. - - The maximum batch size for this endpoint is 100. - - """ - result = client.ontologies.Ontology.ObjectType.get_outgoing_link_types_by_object_type_rid_batch( - ontology=ontology, - filter_link_type_rids=json.loads(filter_link_type_rids), - requests=json.loads(requests), - branch=branch, - preview=preview, - ) - click.echo(repr(result)) - - @ontologies_ontology_object_type.command("list") @click.argument("ontology", type=str, required=True) @click.option( @@ -10996,50 +9312,6 @@ def ontologies_ontology_action_type_op_get_by_rid( click.echo(repr(result)) -@ontologies_ontology_action_type.command("get_by_rid_batch") -@click.argument("ontology", type=str, required=True) -@click.option("--requests", type=str, required=True, help="""""") -@click.option( - "--branch", - type=str, - required=False, - help="""The Foundry branch to load the action type definitions from. If not specified, the default branch will be used. -Branches are an experimental feature and not all workflows are supported. -""", -) -@click.option( - "--preview", - type=bool, - required=False, - help="""A boolean flag that, when set to true, enables the use of beta features in preview mode. -""", -) -@click.pass_obj -def ontologies_ontology_action_type_op_get_by_rid_batch( - client: FoundryClient, - ontology: str, - requests: str, - branch: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Gets a list of action types by RID in bulk. - - Action types are filtered from the response if they don't exist or the requesting token lacks the required - permissions. - - The maximum batch size for this endpoint is 100. - - """ - result = client.ontologies.Ontology.ActionType.get_by_rid_batch( - ontology=ontology, - requests=json.loads(requests), - branch=branch, - preview=preview, - ) - click.echo(repr(result)) - - @ontologies_ontology_action_type.command("list") @click.argument("ontology", type=str, required=True) @click.option( @@ -11999,20 +10271,6 @@ def ontologies_action(): help="""The version of the generated SDK. """, ) -@click.option( - "--trace_parent", - type=str, - required=False, - help="""The W3C trace parent header included in the request. -""", -) -@click.option( - "--trace_state", - type=str, - required=False, - help="""The W3C trace state header included in the request. -""", -) @click.option( "--transaction_id", type=str, @@ -12031,8 +10289,6 @@ def ontologies_action_op_apply( options: typing.Optional[str], sdk_package_rid: typing.Optional[str], sdk_version: typing.Optional[str], - trace_parent: typing.Optional[str], - trace_state: typing.Optional[str], transaction_id: typing.Optional[str], ): """ @@ -12056,8 +10312,6 @@ def ontologies_action_op_apply( options=None if options is None else json.loads(options), sdk_package_rid=sdk_package_rid, sdk_version=sdk_version, - trace_parent=trace_parent, - trace_state=trace_state, transaction_id=transaction_id, ) click.echo(repr(result)) @@ -12278,13 +10532,6 @@ def orchestration_schedule_op_create( ): """ Creates a new Schedule. - - :::callout{theme=warning title=Warning} - If the schedule is created in user-scoped mode, outputs to build will be discovered based on resources - that the user has access to. If the user's permissions change later, this could change the outputs that - will be built or cause builds to fail. Consider using a project-scoped schedule instead. - ::: - """ result = client.orchestration.Schedule.create( action=json.loads(action), @@ -12421,14 +10668,7 @@ def orchestration_schedule_op_replace( trigger: typing.Optional[str], ): """ - Replaces the Schedule with the specified rid. - - :::callout{theme=warning title=Warning} - If the schedule is configured in user-scoped mode, outputs to build will be discovered based on resources - that the user has access to. If the user's permissions change later, this could change the outputs that - will be built or cause builds to fail. Consider using a project-scoped schedule instead. - ::: - + Replace the Schedule with the specified rid. """ result = client.orchestration.Schedule.replace( schedule_rid=schedule_rid, @@ -12520,9 +10760,6 @@ def orchestration_job_op_get( ): """ Get the Job with the specified rid. - - Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - """ result = client.orchestration.Job.get( job_rid=job_rid, @@ -12545,9 +10782,6 @@ def orchestration_job_op_get_batch( """ Execute multiple get requests on Job. - Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - - The maximum batch size for this endpoint is 500. """ result = client.orchestration.Job.get_batch( @@ -12632,9 +10866,6 @@ def orchestration_build_op_get( ): """ Get the Build with the specified rid. - - Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - """ result = client.orchestration.Build.get( build_rid=build_rid, @@ -12652,9 +10883,6 @@ def orchestration_build_op_get_batch( """ Execute multiple get requests on Build. - Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - - The maximum batch size for this endpoint is 100. """ result = client.orchestration.Build.get_batch( @@ -12779,19 +11007,11 @@ def sql_queries_sql_query_op_cancel( `master` for most enrollments. """, ) -@click.option( - "--serialization_format", - type=click.Choice(["ARROW", "CSV"]), - required=False, - help="""The format used to serialize query results. If not specified, defaults to `ARROW`. -""", -) @click.pass_obj def sql_queries_sql_query_op_execute( client: FoundryClient, query: str, fallback_branch_ids: typing.Optional[str], - serialization_format: typing.Optional[typing.Literal["ARROW", "CSV"]], ): """ Executes a new query. Only the user that invoked the query can operate on the query. The size of query @@ -12804,68 +11024,10 @@ def sql_queries_sql_query_op_execute( fallback_branch_ids=( None if fallback_branch_ids is None else json.loads(fallback_branch_ids) ), - serialization_format=serialization_format, ) click.echo(repr(result)) -@sql_queries_sql_query.command("execute_ontology") -@click.option( - "--query", - type=str, - required=True, - help="""The SQL query to execute. -""", -) -@click.option( - "--dry_run", - type=bool, - required=False, - help="""If true, parse and validate the query without executing it. Defaults to false. -""", -) -@click.option( - "--parameters", - type=str, - required=False, - help="""Parameters for the SQL query. Can be either unnamed positional parameters -or a named parameter mapping. -""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.option( - "--row_limit", - type=int, - required=False, - help="""Maximum number of rows to return. -""", -) -@click.pass_obj -def sql_queries_sql_query_op_execute_ontology( - client: FoundryClient, - query: str, - dry_run: typing.Optional[bool], - parameters: typing.Optional[str], - preview: typing.Optional[bool], - row_limit: typing.Optional[int], -): - """ - Executes a SQL query against the Ontology. Results are returned synchronously in - [Apache Arrow](https://arrow.apache.org/) format. - - """ - result = client.sql_queries.SqlQuery.execute_ontology( - query=query, - dry_run=dry_run, - parameters=None if parameters is None else json.loads(parameters), - preview=preview, - row_limit=row_limit, - ) - click.echo(result) - - @sql_queries_sql_query.command("get_results") @click.argument("sql_query_id", type=str, required=True) @click.pass_obj @@ -12874,8 +11036,8 @@ def sql_queries_sql_query_op_get_results( sql_query_id: str, ): """ - Gets the results of a query. Results are returned in the `serializationFormat` specified at execute time - (defaulting to [Apache Arrow](https://arrow.apache.org/) if no format is provided). + Gets the results of a query. The results of the query are returned in the + [Apache Arrow](https://arrow.apache.org/) format. This endpoint implements long polling and requests will time out after one minute. They can be safely retried while the query is still running. @@ -13062,11 +11224,15 @@ def streams_dataset_stream_op_create( @streams_dataset_stream.command("get") @click.argument("dataset_rid", type=str, required=True) @click.argument("stream_branch_name", type=str, required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.pass_obj def streams_dataset_stream_op_get( client: FoundryClient, dataset_rid: str, stream_branch_name: str, + preview: typing.Optional[bool], ): """ Get a stream by its branch name. If the branch does not exist, there is no stream on that branch, or the @@ -13076,6 +11242,7 @@ def streams_dataset_stream_op_get( result = client.streams.Dataset.Stream.get( dataset_rid=dataset_rid, stream_branch_name=stream_branch_name, + preview=preview, ) click.echo(repr(result)) @@ -13188,6 +11355,9 @@ def streams_dataset_stream_op_get_records( @click.argument("dataset_rid", type=str, required=True) @click.argument("stream_branch_name", type=str, required=True) @click.argument("body", type=click.File("rb"), required=True) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.option( "--view_rid", type=str, @@ -13205,6 +11375,7 @@ def streams_dataset_stream_op_publish_binary_record( dataset_rid: str, stream_branch_name: str, body: io.BufferedReader, + preview: typing.Optional[bool], view_rid: typing.Optional[str], ): """ @@ -13215,6 +11386,7 @@ def streams_dataset_stream_op_publish_binary_record( dataset_rid=dataset_rid, stream_branch_name=stream_branch_name, body=body.read(), + preview=preview, view_rid=view_rid, ) click.echo(repr(result)) @@ -13230,6 +11402,9 @@ def streams_dataset_stream_op_publish_binary_record( help="""The record to publish to the stream """, ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.option( "--view_rid", type=str, @@ -13247,6 +11422,7 @@ def streams_dataset_stream_op_publish_record( dataset_rid: str, stream_branch_name: str, record: str, + preview: typing.Optional[bool], view_rid: typing.Optional[str], ): """ @@ -13258,6 +11434,7 @@ def streams_dataset_stream_op_publish_record( dataset_rid=dataset_rid, stream_branch_name=stream_branch_name, record=json.loads(record), + preview=preview, view_rid=view_rid, ) click.echo(repr(result)) @@ -13273,6 +11450,9 @@ def streams_dataset_stream_op_publish_record( help="""The records to publish to the stream """, ) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) @click.option( "--view_rid", type=str, @@ -13290,6 +11470,7 @@ def streams_dataset_stream_op_publish_records( dataset_rid: str, stream_branch_name: str, records: str, + preview: typing.Optional[bool], view_rid: typing.Optional[str], ): """ @@ -13301,6 +11482,7 @@ def streams_dataset_stream_op_publish_records( dataset_rid=dataset_rid, stream_branch_name=stream_branch_name, records=json.loads(records), + preview=preview, view_rid=view_rid, ) click.echo(repr(result)) @@ -13384,301 +11566,6 @@ def streams_dataset_stream_op_reset( click.echo(repr(result)) -@streams_dataset_stream.group("subscriber") -def streams_dataset_stream_subscriber(): - pass - - -@streams_dataset_stream_subscriber.command("commit_offsets") -@click.argument("dataset_rid", type=str, required=True) -@click.argument("stream_branch_name", type=str, required=True) -@click.argument("subscriber_subscriber_id", type=str, required=True) -@click.option( - "--offsets", - type=str, - required=True, - help="""The last processed offset for each partition. The server will store these as -read positions (offset + 1), so the next read starts after the committed offset. -""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.option( - "--view_rid", - type=str, - required=False, - help="""The view RID to commit offsets for. If not provided, uses the latest view for the -dataset/branch. -""", -) -@click.pass_obj -def streams_dataset_stream_subscriber_op_commit_offsets( - client: FoundryClient, - dataset_rid: str, - stream_branch_name: str, - subscriber_subscriber_id: str, - offsets: str, - preview: typing.Optional[bool], - view_rid: typing.Optional[str], -): - """ - Explicitly commit offsets for a subscriber. Required when `autoCommit` is false. - - Pass the last offset you processed for each partition. - - For example, if you processed a record at offset 50, commit `{"0": 50}` and the next - read from partition "0" will start at offset 51. - - """ - result = client.streams.Dataset.Stream.Subscriber.commit_offsets( - dataset_rid=dataset_rid, - stream_branch_name=stream_branch_name, - subscriber_subscriber_id=subscriber_subscriber_id, - offsets=json.loads(offsets), - preview=preview, - view_rid=view_rid, - ) - click.echo(repr(result)) - - -@streams_dataset_stream_subscriber.command("create") -@click.argument("dataset_rid", type=str, required=True) -@click.argument("stream_branch_name", type=str, required=True) -@click.option("--subscriber_id", type=str, required=True, help="""""") -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.option( - "--read_position", - type=str, - required=False, - help="""Where to start reading from. Defaults to `earliest` if not specified. - -The `readPosition` determines where the subscriber will start reading: -- `earliest`: Start from the beginning of each partition (offset 0). Use this to process - all historical data. -- `latest`: Start from the current end of each partition. Use this to skip historical data - and only process new records arriving after registration. -- `specific`: Start from explicit offsets for each partition. Use this to resume from a - known checkpoint. -""", -) -@click.pass_obj -def streams_dataset_stream_subscriber_op_create( - client: FoundryClient, - dataset_rid: str, - stream_branch_name: str, - subscriber_id: str, - preview: typing.Optional[bool], - read_position: typing.Optional[str], -): - """ - Register a new subscriber for a stream. Subscribers maintain server-side offset tracking, - allowing reliable consumption without client-side state management. - - If a subscriber with the same ID already exists for this stream, the existing registration - is returned. If a subscriber with the same ID exists for a different stream, an error is returned. - - """ - result = client.streams.Dataset.Stream.Subscriber.create( - dataset_rid=dataset_rid, - stream_branch_name=stream_branch_name, - subscriber_id=subscriber_id, - preview=preview, - read_position=None if read_position is None else json.loads(read_position), - ) - click.echo(repr(result)) - - -@streams_dataset_stream_subscriber.command("delete") -@click.argument("dataset_rid", type=str, required=True) -@click.argument("stream_branch_name", type=str, required=True) -@click.argument("subscriber_subscriber_id", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def streams_dataset_stream_subscriber_op_delete( - client: FoundryClient, - dataset_rid: str, - stream_branch_name: str, - subscriber_subscriber_id: str, - preview: typing.Optional[bool], -): - """ - Delete a subscriber and all its committed offset state. After deletion, the subscriber ID - can be reused to create a new subscriber. - - """ - result = client.streams.Dataset.Stream.Subscriber.delete( - dataset_rid=dataset_rid, - stream_branch_name=stream_branch_name, - subscriber_subscriber_id=subscriber_subscriber_id, - preview=preview, - ) - click.echo(repr(result)) - - -@streams_dataset_stream_subscriber.command("get_read_position") -@click.argument("dataset_rid", type=str, required=True) -@click.argument("stream_branch_name", type=str, required=True) -@click.argument("subscriber_subscriber_id", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.option( - "--view_rid", - type=str, - required=False, - help="""The view RID to get positions for. If not provided, uses the latest view for the -dataset/branch. -""", -) -@click.pass_obj -def streams_dataset_stream_subscriber_op_get_read_position( - client: FoundryClient, - dataset_rid: str, - stream_branch_name: str, - subscriber_subscriber_id: str, - preview: typing.Optional[bool], - view_rid: typing.Optional[str], -): - """ - Get the current read position for a subscriber. Returns the offset per partition where the next read - will begin. - - """ - result = client.streams.Dataset.Stream.Subscriber.get_read_position( - dataset_rid=dataset_rid, - stream_branch_name=stream_branch_name, - subscriber_subscriber_id=subscriber_subscriber_id, - preview=preview, - view_rid=view_rid, - ) - click.echo(repr(result)) - - -@streams_dataset_stream_subscriber.command("read_records") -@click.argument("dataset_rid", type=str, required=True) -@click.argument("stream_branch_name", type=str, required=True) -@click.argument("subscriber_subscriber_id", type=str, required=True) -@click.option( - "--auto_commit", - type=bool, - required=False, - help="""If true, the read position is automatically committed after reading records. -The committed position will be the offset after the last record read. -If false, you must call the `commitOffsets` endpoint to commit offsets. -Defaults to false. -""", -) -@click.option( - "--limit", - type=int, - required=False, - help="""Maximum number of records to return across all partitions. Defaults to 100, max 1000. If a value -greater than 1000 is requested, only 1000 records will be returned. -""", -) -@click.option( - "--partition_ids", - type=str, - required=False, - help="""If specified, only read from these partitions. Otherwise, read from all partitions. -""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.option( - "--view_rid", - type=str, - required=False, - help="""The view RID to read from. If not provided, reads from the latest view for the -dataset/branch. -""", -) -@click.pass_obj -def streams_dataset_stream_subscriber_op_read_records( - client: FoundryClient, - dataset_rid: str, - stream_branch_name: str, - subscriber_subscriber_id: str, - auto_commit: typing.Optional[bool], - limit: typing.Optional[int], - partition_ids: typing.Optional[str], - preview: typing.Optional[bool], - view_rid: typing.Optional[str], -): - """ - Fetch records for a subscriber starting from their committed offset. Returns records - grouped by partition. - - If `autoCommit` is true, offsets are automatically committed after the records are - fetched, so the next read will start from where this one left off. - - If `autoCommit` is false, you must call `commitOffsets` to update the read position. - Use manual commits for at-least-once processing where you need to ensure records are - processed before acknowledging them. - - """ - result = client.streams.Dataset.Stream.Subscriber.read_records( - dataset_rid=dataset_rid, - stream_branch_name=stream_branch_name, - subscriber_subscriber_id=subscriber_subscriber_id, - auto_commit=auto_commit, - limit=limit, - partition_ids=None if partition_ids is None else json.loads(partition_ids), - preview=preview, - view_rid=view_rid, - ) - click.echo(repr(result)) - - -@streams_dataset_stream_subscriber.command("reset_offsets") -@click.argument("dataset_rid", type=str, required=True) -@click.argument("stream_branch_name", type=str, required=True) -@click.argument("subscriber_subscriber_id", type=str, required=True) -@click.option( - "--position", - type=str, - required=True, - help="""The position to reset offsets to. -""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def streams_dataset_stream_subscriber_op_reset_offsets( - client: FoundryClient, - dataset_rid: str, - stream_branch_name: str, - subscriber_subscriber_id: str, - position: str, - preview: typing.Optional[bool], -): - """ - Reset subscriber offsets to a specific position. Use this to replay data from the - beginning, skip to the latest records, or jump to specific offsets. - - The `position` parameter determines where reading will resume: - - `earliest`: Reset to the beginning of each partition (offset 0) - - `latest`: Reset to the current end of each partition - - `specific`: Reset to explicit offsets for each partition - - """ - result = client.streams.Dataset.Stream.Subscriber.reset_offsets( - dataset_rid=dataset_rid, - stream_branch_name=stream_branch_name, - subscriber_subscriber_id=subscriber_subscriber_id, - position=json.loads(position), - preview=preview, - ) - click.echo(repr(result)) - - @cli.group("third_party_applications") def third_party_applications(): pass @@ -14078,86 +11965,102 @@ def widgets_repository_op_publish( click.echo(repr(result)) -@widgets.group("dev_mode_settings_v2") -def widgets_dev_mode_settings_v2(): +@widgets.group("dev_mode_settings") +def widgets_dev_mode_settings(): pass -@widgets_dev_mode_settings_v2.command("enable") +@widgets_dev_mode_settings.command("disable") @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def widgets_dev_mode_settings_v2_op_enable( +def widgets_dev_mode_settings_op_disable( client: FoundryClient, preview: typing.Optional[bool], ): """ - Enable dev mode for the user associated with the provided token. + Disable dev mode for the user associated with the provided token. """ - result = client.widgets.DevModeSettingsV2.enable( + result = client.widgets.DevModeSettings.disable( preview=preview, ) click.echo(repr(result)) -@widgets_dev_mode_settings_v2.command("set_widget_set_manifest") -@click.option("--manifest", type=str, required=True, help="""""") -@click.option("--widget_set_rid", type=str, required=True, help="""""") +@widgets_dev_mode_settings.command("enable") @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def widgets_dev_mode_settings_v2_op_set_widget_set_manifest( +def widgets_dev_mode_settings_op_enable( client: FoundryClient, - manifest: str, - widget_set_rid: str, preview: typing.Optional[bool], ): """ - Set the dev mode settings for the given widget set using the manifest format. - The request body is a dev settings manifest JSON object with the following - structure: - - { - "manifestVersion": "1.0.0", - "devSettings": { - "baseHref": "...", - "widgets": { ... }, - "inputSpec": { ... } - } - } + Enable dev mode for the user associated with the provided token. + """ + result = client.widgets.DevModeSettings.enable( + preview=preview, + ) + click.echo(repr(result)) - See https://github.com/palantir/osdk-ts for the widget library API types for the - dev settings manifest. +@widgets_dev_mode_settings.command("get") +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) +@click.pass_obj +def widgets_dev_mode_settings_op_get( + client: FoundryClient, + preview: typing.Optional[bool], +): """ - result = client.widgets.DevModeSettingsV2.set_widget_set_manifest( - manifest=json.loads(manifest), - widget_set_rid=widget_set_rid, + Get the dev mode settings for the user associated with the provided token. + """ + result = client.widgets.DevModeSettings.get( preview=preview, ) click.echo(repr(result)) -@widgets.group("dev_mode_settings") -def widgets_dev_mode_settings(): - pass +@widgets_dev_mode_settings.command("pause") +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) +@click.pass_obj +def widgets_dev_mode_settings_op_pause( + client: FoundryClient, + preview: typing.Optional[bool], +): + """ + Pause dev mode for the user associated with the provided token. + """ + result = client.widgets.DevModeSettings.pause( + preview=preview, + ) + click.echo(repr(result)) -@widgets_dev_mode_settings.command("enable") +@widgets_dev_mode_settings.command("set_widget_set") +@click.option("--settings", type=str, required=True, help="""""") +@click.option("--widget_set_rid", type=str, required=True, help="""""") @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def widgets_dev_mode_settings_op_enable( +def widgets_dev_mode_settings_op_set_widget_set( client: FoundryClient, + settings: str, + widget_set_rid: str, preview: typing.Optional[bool], ): """ - Enable dev mode for the user associated with the provided token. + Set the dev mode settings for the given widget set for the user associated with the provided token. """ - result = client.widgets.DevModeSettings.enable( + result = client.widgets.DevModeSettings.set_widget_set( + settings=json.loads(settings), + widget_set_rid=widget_set_rid, preview=preview, ) click.echo(repr(result)) diff --git a/foundry_sdk/v2/connectivity/connection.py b/foundry_sdk/v2/connectivity/connection.py index f91214ba5..2daa5868d 100644 --- a/foundry_sdk/v2/connectivity/connection.py +++ b/foundry_sdk/v2/connectivity/connection.py @@ -24,6 +24,7 @@ from foundry_sdk import _errors as errors from foundry_sdk.v2.connectivity import errors as connectivity_errors from foundry_sdk.v2.connectivity import models as connectivity_models +from foundry_sdk.v2.core import models as core_models from foundry_sdk.v2.filesystem import errors as filesystem_errors from foundry_sdk.v2.filesystem import models as filesystem_models @@ -97,6 +98,7 @@ def create( display_name: connectivity_models.ConnectionDisplayName, parent_folder_rid: filesystem_models.FolderRid, worker: connectivity_models.CreateConnectionRequestConnectionWorker, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> connectivity_models.Connection: @@ -119,6 +121,8 @@ def create( :type parent_folder_rid: FolderRid :param worker: :type worker: CreateConnectionRequestConnectionWorker + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -137,7 +141,9 @@ def create( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections", - query_params={}, + query_params={ + "preview": preview, + }, path_params={}, header_params={ "Content-Type": "application/json", @@ -171,6 +177,7 @@ def get( self, connection_rid: connectivity_models.ConnectionRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> connectivity_models.Connection: @@ -178,6 +185,8 @@ def get( Get the Connection with the specified rid. :param connection_rid: :type connection_rid: ConnectionRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -192,7 +201,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/connectivity/connections/{connectionRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, }, @@ -218,6 +229,7 @@ def get_configuration( self, connection_rid: connectivity_models.ConnectionRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> connectivity_models.ConnectionConfiguration: @@ -227,6 +239,8 @@ def get_configuration( :param connection_rid: :type connection_rid: ConnectionRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -241,7 +255,9 @@ def get_configuration( core.RequestInfo( method="GET", resource_path="/v2/connectivity/connections/{connectionRid}/getConfiguration", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, }, @@ -270,6 +286,7 @@ def get_configuration_batch( annotated_types.Len(min_length=1, max_length=200), ], *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> connectivity_models.GetConfigurationConnectionsBatchResponse: @@ -281,6 +298,8 @@ def get_configuration_batch( The maximum batch size for this endpoint is 200. :param body: Body of the request :type body: List[GetConfigurationConnectionsBatchRequestElement] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -291,7 +310,9 @@ def get_configuration_batch( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections/getConfigurationBatch", - query_params={}, + query_params={ + "preview": preview, + }, path_params={}, header_params={ "Content-Type": "application/json", @@ -313,6 +334,7 @@ def update_export_settings( connection_rid: connectivity_models.ConnectionRid, *, export_settings: connectivity_models.ConnectionExportSettings, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> None: @@ -324,6 +346,8 @@ def update_export_settings( :type connection_rid: ConnectionRid :param export_settings: :type export_settings: ConnectionExportSettings + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -337,7 +361,9 @@ def update_export_settings( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections/{connectionRid}/updateExportSettings", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, }, @@ -429,6 +455,7 @@ def upload_custom_jdbc_drivers( body: bytes, *, file_name: str, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> connectivity_models.Connection: @@ -442,6 +469,8 @@ def upload_custom_jdbc_drivers( :type body: bytes :param file_name: The file name of the uploaded JDBC driver. Must end with .jar :type file_name: str + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -457,6 +486,7 @@ def upload_custom_jdbc_drivers( resource_path="/v2/connectivity/connections/{connectionRid}/uploadCustomJdbcDrivers", query_params={ "fileName": file_name, + "preview": preview, }, path_params={ "connectionRid": connection_rid, @@ -596,6 +626,7 @@ def create( display_name: connectivity_models.ConnectionDisplayName, parent_folder_rid: filesystem_models.FolderRid, worker: connectivity_models.CreateConnectionRequestConnectionWorker, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[connectivity_models.Connection]: @@ -618,6 +649,8 @@ def create( :type parent_folder_rid: FolderRid :param worker: :type worker: CreateConnectionRequestConnectionWorker + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -636,7 +669,9 @@ def create( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections", - query_params={}, + query_params={ + "preview": preview, + }, path_params={}, header_params={ "Content-Type": "application/json", @@ -670,6 +705,7 @@ def get( self, connection_rid: connectivity_models.ConnectionRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[connectivity_models.Connection]: @@ -677,6 +713,8 @@ def get( Get the Connection with the specified rid. :param connection_rid: :type connection_rid: ConnectionRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -691,7 +729,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/connectivity/connections/{connectionRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, }, @@ -717,6 +757,7 @@ def get_configuration( self, connection_rid: connectivity_models.ConnectionRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[connectivity_models.ConnectionConfiguration]: @@ -726,6 +767,8 @@ def get_configuration( :param connection_rid: :type connection_rid: ConnectionRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -740,7 +783,9 @@ def get_configuration( core.RequestInfo( method="GET", resource_path="/v2/connectivity/connections/{connectionRid}/getConfiguration", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, }, @@ -769,6 +814,7 @@ def get_configuration_batch( annotated_types.Len(min_length=1, max_length=200), ], *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[connectivity_models.GetConfigurationConnectionsBatchResponse]: @@ -780,6 +826,8 @@ def get_configuration_batch( The maximum batch size for this endpoint is 200. :param body: Body of the request :type body: List[GetConfigurationConnectionsBatchRequestElement] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -790,7 +838,9 @@ def get_configuration_batch( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections/getConfigurationBatch", - query_params={}, + query_params={ + "preview": preview, + }, path_params={}, header_params={ "Content-Type": "application/json", @@ -812,6 +862,7 @@ def update_export_settings( connection_rid: connectivity_models.ConnectionRid, *, export_settings: connectivity_models.ConnectionExportSettings, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[None]: @@ -823,6 +874,8 @@ def update_export_settings( :type connection_rid: ConnectionRid :param export_settings: :type export_settings: ConnectionExportSettings + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -836,7 +889,9 @@ def update_export_settings( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections/{connectionRid}/updateExportSettings", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, }, @@ -928,6 +983,7 @@ def upload_custom_jdbc_drivers( body: bytes, *, file_name: str, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[connectivity_models.Connection]: @@ -941,6 +997,8 @@ def upload_custom_jdbc_drivers( :type body: bytes :param file_name: The file name of the uploaded JDBC driver. Must end with .jar :type file_name: str + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -956,6 +1014,7 @@ def upload_custom_jdbc_drivers( resource_path="/v2/connectivity/connections/{connectionRid}/uploadCustomJdbcDrivers", query_params={ "fileName": file_name, + "preview": preview, }, path_params={ "connectionRid": connection_rid, diff --git a/foundry_sdk/v2/connectivity/file_import.py b/foundry_sdk/v2/connectivity/file_import.py index 945d299bb..ed4eab23d 100644 --- a/foundry_sdk/v2/connectivity/file_import.py +++ b/foundry_sdk/v2/connectivity/file_import.py @@ -67,6 +67,7 @@ def create( file_import_filters: typing.List[connectivity_models.FileImportFilter], import_mode: connectivity_models.FileImportMode, branch_name: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, subfolder: typing.Optional[str] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -85,6 +86,8 @@ def create( :type import_mode: FileImportMode :param branch_name: The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. Can not be modified after the file import is created. :type branch_name: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param subfolder: A subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system. :type subfolder: Optional[str] :param request_timeout: timeout setting for this request in seconds. @@ -109,7 +112,9 @@ def create( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections/{connectionRid}/fileImports", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, }, @@ -152,6 +157,7 @@ def delete( connection_rid: connectivity_models.ConnectionRid, file_import_rid: connectivity_models.FileImportRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> None: @@ -164,6 +170,8 @@ def delete( :type connection_rid: ConnectionRid :param file_import_rid: :type file_import_rid: FileImportRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -177,7 +185,9 @@ def delete( core.RequestInfo( method="DELETE", resource_path="/v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "fileImportRid": file_import_rid, @@ -202,6 +212,7 @@ def execute( connection_rid: connectivity_models.ConnectionRid, file_import_rid: connectivity_models.FileImportRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> core_models.BuildRid: @@ -213,6 +224,8 @@ def execute( :type connection_rid: ConnectionRid :param file_import_rid: :type file_import_rid: FileImportRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -226,7 +239,9 @@ def execute( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}/execute", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "fileImportRid": file_import_rid, @@ -253,6 +268,7 @@ def get( connection_rid: connectivity_models.ConnectionRid, file_import_rid: connectivity_models.FileImportRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> connectivity_models.FileImport: @@ -262,6 +278,8 @@ def get( :type connection_rid: ConnectionRid :param file_import_rid: :type file_import_rid: FileImportRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -274,7 +292,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "fileImportRid": file_import_rid, @@ -301,6 +321,7 @@ def list( *, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> core.ResourceIterator[connectivity_models.FileImport]: @@ -314,6 +335,8 @@ def list( :type page_size: Optional[PageSize] :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. :type page_token: Optional[PageToken] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -329,6 +352,7 @@ def list( query_params={ "pageSize": page_size, "pageToken": page_token, + "preview": preview, }, path_params={ "connectionRid": connection_rid, @@ -357,6 +381,7 @@ def replace( display_name: connectivity_models.FileImportDisplayName, file_import_filters: typing.List[connectivity_models.FileImportFilter], import_mode: connectivity_models.FileImportMode, + preview: typing.Optional[core_models.PreviewMode] = None, subfolder: typing.Optional[str] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -373,6 +398,8 @@ def replace( :type file_import_filters: List[FileImportFilter] :param import_mode: :type import_mode: FileImportMode + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param subfolder: A subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system. :type subfolder: Optional[str] :param request_timeout: timeout setting for this request in seconds. @@ -394,7 +421,9 @@ def replace( core.RequestInfo( method="PUT", resource_path="/v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "fileImportRid": file_import_rid, @@ -499,6 +528,7 @@ def create( file_import_filters: typing.List[connectivity_models.FileImportFilter], import_mode: connectivity_models.FileImportMode, branch_name: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, subfolder: typing.Optional[str] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -517,6 +547,8 @@ def create( :type import_mode: FileImportMode :param branch_name: The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. Can not be modified after the file import is created. :type branch_name: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param subfolder: A subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system. :type subfolder: Optional[str] :param request_timeout: timeout setting for this request in seconds. @@ -541,7 +573,9 @@ def create( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections/{connectionRid}/fileImports", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, }, @@ -584,6 +618,7 @@ def delete( connection_rid: connectivity_models.ConnectionRid, file_import_rid: connectivity_models.FileImportRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[None]: @@ -596,6 +631,8 @@ def delete( :type connection_rid: ConnectionRid :param file_import_rid: :type file_import_rid: FileImportRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -609,7 +646,9 @@ def delete( core.RequestInfo( method="DELETE", resource_path="/v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "fileImportRid": file_import_rid, @@ -634,6 +673,7 @@ def execute( connection_rid: connectivity_models.ConnectionRid, file_import_rid: connectivity_models.FileImportRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[core_models.BuildRid]: @@ -645,6 +685,8 @@ def execute( :type connection_rid: ConnectionRid :param file_import_rid: :type file_import_rid: FileImportRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -658,7 +700,9 @@ def execute( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}/execute", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "fileImportRid": file_import_rid, @@ -685,6 +729,7 @@ def get( connection_rid: connectivity_models.ConnectionRid, file_import_rid: connectivity_models.FileImportRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[connectivity_models.FileImport]: @@ -694,6 +739,8 @@ def get( :type connection_rid: ConnectionRid :param file_import_rid: :type file_import_rid: FileImportRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -706,7 +753,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "fileImportRid": file_import_rid, @@ -733,6 +782,7 @@ def list( *, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> core.AsyncResourceIterator[connectivity_models.FileImport]: @@ -746,6 +796,8 @@ def list( :type page_size: Optional[PageSize] :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. :type page_token: Optional[PageToken] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -761,6 +813,7 @@ def list( query_params={ "pageSize": page_size, "pageToken": page_token, + "preview": preview, }, path_params={ "connectionRid": connection_rid, @@ -789,6 +842,7 @@ def replace( display_name: connectivity_models.FileImportDisplayName, file_import_filters: typing.List[connectivity_models.FileImportFilter], import_mode: connectivity_models.FileImportMode, + preview: typing.Optional[core_models.PreviewMode] = None, subfolder: typing.Optional[str] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -805,6 +859,8 @@ def replace( :type file_import_filters: List[FileImportFilter] :param import_mode: :type import_mode: FileImportMode + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param subfolder: A subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system. :type subfolder: Optional[str] :param request_timeout: timeout setting for this request in seconds. @@ -826,7 +882,9 @@ def replace( core.RequestInfo( method="PUT", resource_path="/v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "fileImportRid": file_import_rid, diff --git a/foundry_sdk/v2/connectivity/models.py b/foundry_sdk/v2/connectivity/models.py index 238815092..41df92078 100644 --- a/foundry_sdk/v2/connectivity/models.py +++ b/foundry_sdk/v2/connectivity/models.py @@ -292,7 +292,7 @@ class CreateConnectionRequestDatabricksConnectionConfiguration(core.ModelBase): class CreateConnectionRequestFoundryWorker(core.ModelBase): """CreateConnectionRequestFoundryWorker""" - network_egress_policy_rids: typing.List[core_models.NetworkEgressPolicyRid] = pydantic.Field(alias=str("networkEgressPolicyRids")) # type: ignore[literal-required] + network_egress_policy_rids: typing.List[NetworkEgressPolicyRid] = pydantic.Field(alias=str("networkEgressPolicyRids")) # type: ignore[literal-required] type: typing.Literal["foundryWorker"] = "foundryWorker" @@ -1042,7 +1042,7 @@ class FoundryWorker(core.ModelBase): and scalable job execution, improved stability and do not incur the maintenance overhead associated with agents. """ - network_egress_policy_rids: typing.List[core_models.NetworkEgressPolicyRid] = pydantic.Field(alias=str("networkEgressPolicyRids")) # type: ignore[literal-required] + network_egress_policy_rids: typing.List[NetworkEgressPolicyRid] = pydantic.Field(alias=str("networkEgressPolicyRids")) # type: ignore[literal-required] type: typing.Literal["foundryWorker"] = "foundryWorker" @@ -1253,6 +1253,10 @@ class MicrosoftSqlServerTableImportConfig(core.ModelBase): type: typing.Literal["microsoftSqlServerImportConfig"] = "microsoftSqlServerImportConfig" +NetworkEgressPolicyRid = core.RID +"""The Resource Identifier (RID) of a Network Egress Policy.""" + + class OauthMachineToMachineAuth(core.ModelBase): """ Authenticate as a service principal using OAuth. Create a service principal in Databricks and generate an OAuth secret to obtain a client ID and secret. @@ -2197,6 +2201,7 @@ class WorkflowIdentityFederation(core.ModelBase): "LongColumnInitialIncrementalState", "MicrosoftAccessTableImportConfig", "MicrosoftSqlServerTableImportConfig", + "NetworkEgressPolicyRid", "OauthMachineToMachineAuth", "OracleTableImportConfig", "PersonalAccessToken", diff --git a/foundry_sdk/v2/connectivity/table_import.py b/foundry_sdk/v2/connectivity/table_import.py index ad90b0356..0aa1aa656 100644 --- a/foundry_sdk/v2/connectivity/table_import.py +++ b/foundry_sdk/v2/connectivity/table_import.py @@ -70,6 +70,7 @@ def create( connectivity_models.TableImportAllowSchemaChanges ] = None, branch_name: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> connectivity_models.TableImport: @@ -89,6 +90,8 @@ def create( :type allow_schema_changes: Optional[TableImportAllowSchemaChanges] :param branch_name: The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. Can not be modified after the table import is created. :type branch_name: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -106,7 +109,9 @@ def create( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections/{connectionRid}/tableImports", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, }, @@ -144,6 +149,7 @@ def delete( connection_rid: connectivity_models.ConnectionRid, table_import_rid: connectivity_models.TableImportRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> None: @@ -156,6 +162,8 @@ def delete( :type connection_rid: ConnectionRid :param table_import_rid: :type table_import_rid: TableImportRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -169,7 +177,9 @@ def delete( core.RequestInfo( method="DELETE", resource_path="/v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "tableImportRid": table_import_rid, @@ -194,6 +204,7 @@ def execute( connection_rid: connectivity_models.ConnectionRid, table_import_rid: connectivity_models.TableImportRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> core_models.BuildRid: @@ -205,6 +216,8 @@ def execute( :type connection_rid: ConnectionRid :param table_import_rid: :type table_import_rid: TableImportRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -218,7 +231,9 @@ def execute( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}/execute", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "tableImportRid": table_import_rid, @@ -245,6 +260,7 @@ def get( connection_rid: connectivity_models.ConnectionRid, table_import_rid: connectivity_models.TableImportRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> connectivity_models.TableImport: @@ -254,6 +270,8 @@ def get( :type connection_rid: ConnectionRid :param table_import_rid: :type table_import_rid: TableImportRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -267,7 +285,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "tableImportRid": table_import_rid, @@ -295,6 +315,7 @@ def list( *, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> core.ResourceIterator[connectivity_models.TableImport]: @@ -308,6 +329,8 @@ def list( :type page_size: Optional[PageSize] :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. :type page_token: Optional[PageToken] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -323,6 +346,7 @@ def list( query_params={ "pageSize": page_size, "pageToken": page_token, + "preview": preview, }, path_params={ "connectionRid": connection_rid, @@ -354,6 +378,7 @@ def replace( allow_schema_changes: typing.Optional[ connectivity_models.TableImportAllowSchemaChanges ] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> connectivity_models.TableImport: @@ -371,6 +396,8 @@ def replace( :type import_mode: TableImportMode :param allow_schema_changes: Allow the TableImport to succeed if the schema of imported rows does not match the existing dataset's schema. Defaults to false for new table imports. :type allow_schema_changes: Optional[TableImportAllowSchemaChanges] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -388,7 +415,9 @@ def replace( core.RequestInfo( method="PUT", resource_path="/v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "tableImportRid": table_import_rid, @@ -494,6 +523,7 @@ def create( connectivity_models.TableImportAllowSchemaChanges ] = None, branch_name: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[connectivity_models.TableImport]: @@ -513,6 +543,8 @@ def create( :type allow_schema_changes: Optional[TableImportAllowSchemaChanges] :param branch_name: The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. Can not be modified after the table import is created. :type branch_name: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -530,7 +562,9 @@ def create( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections/{connectionRid}/tableImports", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, }, @@ -568,6 +602,7 @@ def delete( connection_rid: connectivity_models.ConnectionRid, table_import_rid: connectivity_models.TableImportRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[None]: @@ -580,6 +615,8 @@ def delete( :type connection_rid: ConnectionRid :param table_import_rid: :type table_import_rid: TableImportRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -593,7 +630,9 @@ def delete( core.RequestInfo( method="DELETE", resource_path="/v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "tableImportRid": table_import_rid, @@ -618,6 +657,7 @@ def execute( connection_rid: connectivity_models.ConnectionRid, table_import_rid: connectivity_models.TableImportRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[core_models.BuildRid]: @@ -629,6 +669,8 @@ def execute( :type connection_rid: ConnectionRid :param table_import_rid: :type table_import_rid: TableImportRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -642,7 +684,9 @@ def execute( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}/execute", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "tableImportRid": table_import_rid, @@ -669,6 +713,7 @@ def get( connection_rid: connectivity_models.ConnectionRid, table_import_rid: connectivity_models.TableImportRid, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[connectivity_models.TableImport]: @@ -678,6 +723,8 @@ def get( :type connection_rid: ConnectionRid :param table_import_rid: :type table_import_rid: TableImportRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -691,7 +738,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "tableImportRid": table_import_rid, @@ -719,6 +768,7 @@ def list( *, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> core.AsyncResourceIterator[connectivity_models.TableImport]: @@ -732,6 +782,8 @@ def list( :type page_size: Optional[PageSize] :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. :type page_token: Optional[PageToken] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -747,6 +799,7 @@ def list( query_params={ "pageSize": page_size, "pageToken": page_token, + "preview": preview, }, path_params={ "connectionRid": connection_rid, @@ -778,6 +831,7 @@ def replace( allow_schema_changes: typing.Optional[ connectivity_models.TableImportAllowSchemaChanges ] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[connectivity_models.TableImport]: @@ -795,6 +849,8 @@ def replace( :type import_mode: TableImportMode :param allow_schema_changes: Allow the TableImport to succeed if the schema of imported rows does not match the existing dataset's schema. Defaults to false for new table imports. :type allow_schema_changes: Optional[TableImportAllowSchemaChanges] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -812,7 +868,9 @@ def replace( core.RequestInfo( method="PUT", resource_path="/v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, "tableImportRid": table_import_rid, diff --git a/foundry_sdk/v2/connectivity/virtual_table.py b/foundry_sdk/v2/connectivity/virtual_table.py index 5f943615a..0376dcd10 100644 --- a/foundry_sdk/v2/connectivity/virtual_table.py +++ b/foundry_sdk/v2/connectivity/virtual_table.py @@ -66,6 +66,7 @@ def create( name: connectivity_models.TableName, parent_rid: filesystem_models.FolderRid, markings: typing.Optional[typing.List[core_models.MarkingId]] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> connectivity_models.VirtualTable: @@ -83,6 +84,8 @@ def create( :type parent_rid: FolderRid :param markings: :type markings: Optional[List[MarkingId]] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -99,7 +102,9 @@ def create( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections/{connectionRid}/virtualTables", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, }, @@ -181,6 +186,7 @@ def create( name: connectivity_models.TableName, parent_rid: filesystem_models.FolderRid, markings: typing.Optional[typing.List[core_models.MarkingId]] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[connectivity_models.VirtualTable]: @@ -198,6 +204,8 @@ def create( :type parent_rid: FolderRid :param markings: :type markings: Optional[List[MarkingId]] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -214,7 +222,9 @@ def create( core.RequestInfo( method="POST", resource_path="/v2/connectivity/connections/{connectionRid}/virtualTables", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "connectionRid": connection_rid, }, diff --git a/foundry_sdk/v2/core/models.py b/foundry_sdk/v2/core/models.py index cea18ec0c..c4d81a9bf 100644 --- a/foundry_sdk/v2/core/models.py +++ b/foundry_sdk/v2/core/models.py @@ -95,14 +95,6 @@ class CipherTextType(core.ModelBase): type: typing.Literal["cipherText"] = "cipherText" -Color = str -"""The hex value of a color.""" - - -ColumnName = str -"""The name of a column in a dataset.""" - - ComputeSeconds = float """A measurement of compute usage expressed in [compute-seconds](https://palantir.com/docs/foundry/resource-management/usage-types#compute-second). For more information, please refer to the [Usage types](https://palantir.com/docs/foundry/resource-management/usage-types) documentation.""" @@ -606,10 +598,6 @@ class MediaSetViewItemWrapper(core.ModelBase): """ -NetworkEgressPolicyRid = core.RID -"""The Resource Identifier (RID) of a Network Egress Policy.""" - - class NullType(core.ModelBase): """NullType""" @@ -907,12 +895,6 @@ class VectorType(core.ModelBase): """The version identifier of a dataset schema.""" -class VoidType(core.ModelBase): - """VoidType""" - - type: typing.Literal["void"] = "void" - - ZoneId = str """A string representation of a java.time.ZoneId""" @@ -960,8 +942,6 @@ class VoidType(core.ModelBase): "CheckReportRid", "CheckRid", "CipherTextType", - "Color", - "ColumnName", "ComputeSeconds", "ContentLength", "ContentType", @@ -1031,7 +1011,6 @@ class VoidType(core.ModelBase): "MediaSetViewItemWrapper", "MediaSetViewRid", "MediaType", - "NetworkEgressPolicyRid", "NullType", "NumericOrNonNumericType", "Operation", @@ -1078,6 +1057,5 @@ class VoidType(core.ModelBase): "VectorSimilarityFunctionValue", "VectorType", "VersionId", - "VoidType", "ZoneId", ] diff --git a/foundry_sdk/v2/datasets/dataset.py b/foundry_sdk/v2/datasets/dataset.py index f2934665e..d386b51b1 100644 --- a/foundry_sdk/v2/datasets/dataset.py +++ b/foundry_sdk/v2/datasets/dataset.py @@ -334,15 +334,12 @@ def get_schedules( branch_name: typing.Optional[core_models.BranchName] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> core.ResourceIterator[core_models.ScheduleRid]: """ - Get the RIDs of the Schedules that target the given Dataset. - - Note: It may take up to an hour for recent changes to schedules to be reflected in this response, - especially for schedules managed by Marketplace. This operation will return outdated results in the - meantime. + Get the RIDs of the Schedules that target the given Dataset :param dataset_rid: :type dataset_rid: DatasetRid @@ -352,6 +349,8 @@ def get_schedules( :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -370,6 +369,7 @@ def get_schedules( "branchName": branch_name, "pageSize": page_size, "pageToken": page_token, + "preview": preview, }, path_params={ "datasetRid": dataset_rid, @@ -398,6 +398,7 @@ def get_schema( *, branch_name: typing.Optional[core_models.BranchName] = None, end_transaction_rid: typing.Optional[datasets_models.TransactionRid] = None, + preview: typing.Optional[core_models.PreviewMode] = None, version_id: typing.Optional[core_models.VersionId] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -411,6 +412,8 @@ def get_schema( :type branch_name: Optional[BranchName] :param end_transaction_rid: The Resource Identifier (RID) of the end Transaction. If a user does not provide a value, the RID of the latest committed transaction will be used. :type end_transaction_rid: Optional[TransactionRid] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param version_id: The schema version that should be used. If none is provided, the latest version will be used. :type version_id: Optional[VersionId] :param request_timeout: timeout setting for this request in seconds. @@ -433,6 +436,7 @@ def get_schema( query_params={ "branchName": branch_name, "endTransactionRid": end_transaction_rid, + "preview": preview, "versionId": version_id, }, path_params={ @@ -466,6 +470,7 @@ def get_schema_batch( annotated_types.Len(min_length=1, max_length=1000), ], *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> datasets_models.GetSchemaDatasetsBatchResponse: @@ -477,6 +482,8 @@ def get_schema_batch( The maximum batch size for this endpoint is 1000. :param body: Body of the request :type body: List[GetSchemaDatasetsBatchRequestElement] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -487,7 +494,9 @@ def get_schema_batch( core.RequestInfo( method="POST", resource_path="/v2/datasets/getSchemaBatch", - query_params={}, + query_params={ + "preview": preview, + }, path_params={}, header_params={ "Content-Type": "application/json", @@ -587,6 +596,7 @@ def put_schema( branch_name: typing.Optional[core_models.BranchName] = None, dataframe_reader: typing.Optional[datasets_models.DataframeReader] = None, end_transaction_rid: typing.Optional[datasets_models.TransactionRid] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> datasets_models.GetDatasetSchemaResponse: @@ -603,6 +613,8 @@ def put_schema( :type dataframe_reader: Optional[DataframeReader] :param end_transaction_rid: The Resource Identifier (RID) of the end Transaction. :type end_transaction_rid: Optional[TransactionRid] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -619,7 +631,9 @@ def put_schema( core.RequestInfo( method="PUT", resource_path="/v2/datasets/{datasetRid}/putSchema", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "datasetRid": dataset_rid, }, @@ -1157,15 +1171,12 @@ def get_schedules( branch_name: typing.Optional[core_models.BranchName] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> core.AsyncResourceIterator[core_models.ScheduleRid]: """ - Get the RIDs of the Schedules that target the given Dataset. - - Note: It may take up to an hour for recent changes to schedules to be reflected in this response, - especially for schedules managed by Marketplace. This operation will return outdated results in the - meantime. + Get the RIDs of the Schedules that target the given Dataset :param dataset_rid: :type dataset_rid: DatasetRid @@ -1175,6 +1186,8 @@ def get_schedules( :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -1193,6 +1206,7 @@ def get_schedules( "branchName": branch_name, "pageSize": page_size, "pageToken": page_token, + "preview": preview, }, path_params={ "datasetRid": dataset_rid, @@ -1221,6 +1235,7 @@ def get_schema( *, branch_name: typing.Optional[core_models.BranchName] = None, end_transaction_rid: typing.Optional[datasets_models.TransactionRid] = None, + preview: typing.Optional[core_models.PreviewMode] = None, version_id: typing.Optional[core_models.VersionId] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -1234,6 +1249,8 @@ def get_schema( :type branch_name: Optional[BranchName] :param end_transaction_rid: The Resource Identifier (RID) of the end Transaction. If a user does not provide a value, the RID of the latest committed transaction will be used. :type end_transaction_rid: Optional[TransactionRid] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param version_id: The schema version that should be used. If none is provided, the latest version will be used. :type version_id: Optional[VersionId] :param request_timeout: timeout setting for this request in seconds. @@ -1256,6 +1273,7 @@ def get_schema( query_params={ "branchName": branch_name, "endTransactionRid": end_transaction_rid, + "preview": preview, "versionId": version_id, }, path_params={ @@ -1289,6 +1307,7 @@ def get_schema_batch( annotated_types.Len(min_length=1, max_length=1000), ], *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[datasets_models.GetSchemaDatasetsBatchResponse]: @@ -1300,6 +1319,8 @@ def get_schema_batch( The maximum batch size for this endpoint is 1000. :param body: Body of the request :type body: List[GetSchemaDatasetsBatchRequestElement] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -1310,7 +1331,9 @@ def get_schema_batch( core.RequestInfo( method="POST", resource_path="/v2/datasets/getSchemaBatch", - query_params={}, + query_params={ + "preview": preview, + }, path_params={}, header_params={ "Content-Type": "application/json", @@ -1410,6 +1433,7 @@ def put_schema( branch_name: typing.Optional[core_models.BranchName] = None, dataframe_reader: typing.Optional[datasets_models.DataframeReader] = None, end_transaction_rid: typing.Optional[datasets_models.TransactionRid] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[datasets_models.GetDatasetSchemaResponse]: @@ -1426,6 +1450,8 @@ def put_schema( :type dataframe_reader: Optional[DataframeReader] :param end_transaction_rid: The Resource Identifier (RID) of the end Transaction. :type end_transaction_rid: Optional[TransactionRid] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -1442,7 +1468,9 @@ def put_schema( core.RequestInfo( method="PUT", resource_path="/v2/datasets/{datasetRid}/putSchema", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "datasetRid": dataset_rid, }, diff --git a/foundry_sdk/v2/datasets/errors.py b/foundry_sdk/v2/datasets/errors.py index 9df50c066..4277f47cf 100644 --- a/foundry_sdk/v2/datasets/errors.py +++ b/foundry_sdk/v2/datasets/errors.py @@ -18,7 +18,6 @@ import typing_extensions -from foundry_sdk import _core as core from foundry_sdk import _errors as errors from foundry_sdk.v2.core import models as core_models from foundry_sdk.v2.datasets import models as datasets_models @@ -380,26 +379,6 @@ class FileNotFoundOnTransactionRange(errors.NotFoundError): error_instance_id: str -class FileSizeLimitExceededParameters(typing_extensions.TypedDict): - """ - The requested file is larger than the configured maximum download size. Contact Palantir Support to discuss - limit increases. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - datasetRid: core_models.DatasetRid - path: core_models.FilePath - fileSizeBytes: core.Long - - -@dataclass -class FileSizeLimitExceeded(errors.BadRequestError): - name: typing.Literal["FileSizeLimitExceeded"] - parameters: FileSizeLimitExceededParameters - error_instance_id: str - - class GetBranchTransactionHistoryPermissionDeniedParameters(typing_extensions.TypedDict): """Could not transactions the Branch.""" @@ -973,7 +952,6 @@ class ViewPrimaryKeyRequiresBackingDatasets(errors.BadRequestError): "FileNotFound", "FileNotFoundOnBranch", "FileNotFoundOnTransactionRange", - "FileSizeLimitExceeded", "GetBranchTransactionHistoryPermissionDenied", "GetDatasetHealthCheckReportsPermissionDenied", "GetDatasetHealthChecksPermissionDenied", diff --git a/foundry_sdk/v2/datasets/file.py b/foundry_sdk/v2/datasets/file.py index 98776bb00..7e416038f 100644 --- a/foundry_sdk/v2/datasets/file.py +++ b/foundry_sdk/v2/datasets/file.py @@ -107,7 +107,6 @@ def content( :raises DatasetNotFound: The requested dataset could not be found, or the client token does not have access to it. :raises FileNotFoundOnBranch: The requested file could not be found on the given branch, or the client token does not have access to it. :raises FileNotFoundOnTransactionRange: The requested file could not be found on the given transaction range, or the client token does not have access to it. - :raises FileSizeLimitExceeded: The requested file is larger than the configured maximum download size. Contact Palantir Support to discuss limit increases. :raises GetFileContentPermissionDenied: Could not content the File. :raises InvalidBranchName: The requested branch name cannot be used. Branch names cannot be empty and must not look like RIDs or UUIDs. :raises InvalidParameterCombination: The given parameters are individually valid but cannot be used in the given combination. @@ -138,7 +137,6 @@ def content( "DatasetNotFound": datasets_errors.DatasetNotFound, "FileNotFoundOnBranch": datasets_errors.FileNotFoundOnBranch, "FileNotFoundOnTransactionRange": datasets_errors.FileNotFoundOnTransactionRange, - "FileSizeLimitExceeded": datasets_errors.FileSizeLimitExceeded, "GetFileContentPermissionDenied": datasets_errors.GetFileContentPermissionDenied, "InvalidBranchName": datasets_errors.InvalidBranchName, "InvalidParameterCombination": core_errors.InvalidParameterCombination, @@ -637,7 +635,6 @@ def content( :raises DatasetNotFound: The requested dataset could not be found, or the client token does not have access to it. :raises FileNotFoundOnBranch: The requested file could not be found on the given branch, or the client token does not have access to it. :raises FileNotFoundOnTransactionRange: The requested file could not be found on the given transaction range, or the client token does not have access to it. - :raises FileSizeLimitExceeded: The requested file is larger than the configured maximum download size. Contact Palantir Support to discuss limit increases. :raises GetFileContentPermissionDenied: Could not content the File. :raises InvalidBranchName: The requested branch name cannot be used. Branch names cannot be empty and must not look like RIDs or UUIDs. :raises InvalidParameterCombination: The given parameters are individually valid but cannot be used in the given combination. @@ -668,7 +665,6 @@ def content( "DatasetNotFound": datasets_errors.DatasetNotFound, "FileNotFoundOnBranch": datasets_errors.FileNotFoundOnBranch, "FileNotFoundOnTransactionRange": datasets_errors.FileNotFoundOnTransactionRange, - "FileSizeLimitExceeded": datasets_errors.FileSizeLimitExceeded, "GetFileContentPermissionDenied": datasets_errors.GetFileContentPermissionDenied, "InvalidBranchName": datasets_errors.InvalidBranchName, "InvalidParameterCombination": core_errors.InvalidParameterCombination, diff --git a/foundry_sdk/v2/datasets/view.py b/foundry_sdk/v2/datasets/view.py index 74eaccf65..64e39d195 100644 --- a/foundry_sdk/v2/datasets/view.py +++ b/foundry_sdk/v2/datasets/view.py @@ -66,6 +66,7 @@ def add_backing_datasets( *, backing_datasets: typing.List[datasets_models.ViewBackingDataset], branch: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> datasets_models.View: @@ -79,6 +80,8 @@ def add_backing_datasets( :type backing_datasets: List[ViewBackingDataset] :param branch: :type branch: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -95,7 +98,9 @@ def add_backing_datasets( core.RequestInfo( method="POST", resource_path="/v2/datasets/views/{viewDatasetRid}/addBackingDatasets", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "viewDatasetRid": view_dataset_rid, }, @@ -129,6 +134,7 @@ def add_primary_key( *, primary_key: datasets_models.ViewPrimaryKey, branch: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> datasets_models.View: @@ -142,6 +148,8 @@ def add_primary_key( :type primary_key: ViewPrimaryKey :param branch: :type branch: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -162,7 +170,9 @@ def add_primary_key( core.RequestInfo( method="POST", resource_path="/v2/datasets/views/{viewDatasetRid}/addPrimaryKey", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "viewDatasetRid": view_dataset_rid, }, @@ -201,6 +211,7 @@ def create( parent_folder_rid: filesystem_models.FolderRid, view_name: datasets_models.DatasetName, branch: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, primary_key: typing.Optional[datasets_models.ViewPrimaryKey] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -215,6 +226,8 @@ def create( :type view_name: DatasetName :param branch: The branch name of the View. If not specified, defaults to `master` for most enrollments. :type branch: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param primary_key: :type primary_key: Optional[ViewPrimaryKey] :param request_timeout: timeout setting for this request in seconds. @@ -244,7 +257,9 @@ def create( core.RequestInfo( method="POST", resource_path="/v2/datasets/views", - query_params={}, + query_params={ + "preview": preview, + }, path_params={}, header_params={ "Content-Type": "application/json", @@ -289,6 +304,7 @@ def get( view_dataset_rid: core_models.DatasetRid, *, branch: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> datasets_models.View: @@ -298,6 +314,8 @@ def get( :type view_dataset_rid: DatasetRid :param branch: :type branch: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -312,6 +330,7 @@ def get( resource_path="/v2/datasets/views/{viewDatasetRid}", query_params={ "branch": branch, + "preview": preview, }, path_params={ "viewDatasetRid": view_dataset_rid, @@ -338,6 +357,7 @@ def remove_backing_datasets( *, backing_datasets: typing.List[datasets_models.ViewBackingDataset], branch: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> datasets_models.View: @@ -352,6 +372,8 @@ def remove_backing_datasets( :type backing_datasets: List[ViewBackingDataset] :param branch: :type branch: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -367,7 +389,9 @@ def remove_backing_datasets( core.RequestInfo( method="POST", resource_path="/v2/datasets/views/{viewDatasetRid}/removeBackingDatasets", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "viewDatasetRid": view_dataset_rid, }, @@ -400,6 +424,7 @@ def replace_backing_datasets( *, backing_datasets: typing.List[datasets_models.ViewBackingDataset], branch: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> datasets_models.View: @@ -413,6 +438,8 @@ def replace_backing_datasets( :type backing_datasets: List[ViewBackingDataset] :param branch: :type branch: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -429,7 +456,9 @@ def replace_backing_datasets( core.RequestInfo( method="PUT", resource_path="/v2/datasets/views/{viewDatasetRid}/replaceBackingDatasets", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "viewDatasetRid": view_dataset_rid, }, @@ -539,6 +568,7 @@ def add_backing_datasets( *, backing_datasets: typing.List[datasets_models.ViewBackingDataset], branch: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[datasets_models.View]: @@ -552,6 +582,8 @@ def add_backing_datasets( :type backing_datasets: List[ViewBackingDataset] :param branch: :type branch: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -568,7 +600,9 @@ def add_backing_datasets( core.RequestInfo( method="POST", resource_path="/v2/datasets/views/{viewDatasetRid}/addBackingDatasets", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "viewDatasetRid": view_dataset_rid, }, @@ -602,6 +636,7 @@ def add_primary_key( *, primary_key: datasets_models.ViewPrimaryKey, branch: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[datasets_models.View]: @@ -615,6 +650,8 @@ def add_primary_key( :type primary_key: ViewPrimaryKey :param branch: :type branch: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -635,7 +672,9 @@ def add_primary_key( core.RequestInfo( method="POST", resource_path="/v2/datasets/views/{viewDatasetRid}/addPrimaryKey", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "viewDatasetRid": view_dataset_rid, }, @@ -674,6 +713,7 @@ def create( parent_folder_rid: filesystem_models.FolderRid, view_name: datasets_models.DatasetName, branch: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, primary_key: typing.Optional[datasets_models.ViewPrimaryKey] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -688,6 +728,8 @@ def create( :type view_name: DatasetName :param branch: The branch name of the View. If not specified, defaults to `master` for most enrollments. :type branch: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param primary_key: :type primary_key: Optional[ViewPrimaryKey] :param request_timeout: timeout setting for this request in seconds. @@ -717,7 +759,9 @@ def create( core.RequestInfo( method="POST", resource_path="/v2/datasets/views", - query_params={}, + query_params={ + "preview": preview, + }, path_params={}, header_params={ "Content-Type": "application/json", @@ -762,6 +806,7 @@ def get( view_dataset_rid: core_models.DatasetRid, *, branch: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[datasets_models.View]: @@ -771,6 +816,8 @@ def get( :type view_dataset_rid: DatasetRid :param branch: :type branch: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -785,6 +832,7 @@ def get( resource_path="/v2/datasets/views/{viewDatasetRid}", query_params={ "branch": branch, + "preview": preview, }, path_params={ "viewDatasetRid": view_dataset_rid, @@ -811,6 +859,7 @@ def remove_backing_datasets( *, backing_datasets: typing.List[datasets_models.ViewBackingDataset], branch: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[datasets_models.View]: @@ -825,6 +874,8 @@ def remove_backing_datasets( :type backing_datasets: List[ViewBackingDataset] :param branch: :type branch: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -840,7 +891,9 @@ def remove_backing_datasets( core.RequestInfo( method="POST", resource_path="/v2/datasets/views/{viewDatasetRid}/removeBackingDatasets", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "viewDatasetRid": view_dataset_rid, }, @@ -873,6 +926,7 @@ def replace_backing_datasets( *, backing_datasets: typing.List[datasets_models.ViewBackingDataset], branch: typing.Optional[core_models.BranchName] = None, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[datasets_models.View]: @@ -886,6 +940,8 @@ def replace_backing_datasets( :type backing_datasets: List[ViewBackingDataset] :param branch: :type branch: Optional[BranchName] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -902,7 +958,9 @@ def replace_backing_datasets( core.RequestInfo( method="PUT", resource_path="/v2/datasets/views/{viewDatasetRid}/replaceBackingDatasets", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "viewDatasetRid": view_dataset_rid, }, diff --git a/foundry_sdk/v2/filesystem/errors.py b/foundry_sdk/v2/filesystem/errors.py index 9787c331d..7b75f718f 100644 --- a/foundry_sdk/v2/filesystem/errors.py +++ b/foundry_sdk/v2/filesystem/errors.py @@ -68,21 +68,6 @@ class AddOrganizationsPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class AddProjectResourceReferencesPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not add the ProjectResourceReference.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - projectRid: filesystem_models.ProjectRid - - -@dataclass -class AddProjectResourceReferencesPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["AddProjectResourceReferencesPermissionDenied"] - parameters: AddProjectResourceReferencesPermissionDeniedParameters - error_instance_id: str - - class AddResourceRolesPermissionDeniedParameters(typing_extensions.TypedDict): """Could not add the ResourceRole.""" @@ -98,19 +83,6 @@ class AddResourceRolesPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class CircularDependencyParameters(typing_extensions.TypedDict): - """The requested operation would result in a circular dependency in the folder hierarchy. For example, moving a folder into one of its descendants.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class CircularDependency(errors.BadRequestError): - name: typing.Literal["CircularDependency"] - parameters: CircularDependencyParameters - error_instance_id: str - - class CreateFolderOutsideProjectNotSupportedParameters(typing_extensions.TypedDict): """The given Resource is not a folder.""" @@ -459,21 +431,6 @@ class InvalidOrganizations(errors.BadRequestError): error_instance_id: str -class InvalidParentFolderParameters(typing_extensions.TypedDict): - """The specified parent folder is not a valid destination for the resource. For example, a project cannot be moved under a regular folder, a folder cannot be moved to a Space, etc.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parentFolderRid: filesystem_models.FolderRid - - -@dataclass -class InvalidParentFolder(errors.BadRequestError): - name: typing.Literal["InvalidParentFolder"] - parameters: InvalidParentFolderParameters - error_instance_id: str - - class InvalidPathParameters(typing_extensions.TypedDict): """ The given path is invalid. @@ -508,39 +465,6 @@ class InvalidPrincipalIdsForGroupTemplate(errors.BadRequestError): error_instance_id: str -class InvalidProjectParameters(typing_extensions.TypedDict): - """The provided resource identifier does not refer to a valid project.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - projectRid: filesystem_models.ProjectRid - - -@dataclass -class InvalidProject(errors.BadRequestError): - name: typing.Literal["InvalidProject"] - parameters: InvalidProjectParameters - error_instance_id: str - - -class InvalidResourceReferenceParameters(typing_extensions.TypedDict): - """ - The resource reference is invalid. This can occur when the resource identifier is malformed, - the resource type does not match the reference type, or the resource cannot be added as a reference. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - resourceRid: filesystem_models.ResourceRid - - -@dataclass -class InvalidResourceReference(errors.BadRequestError): - name: typing.Literal["InvalidResourceReference"] - parameters: InvalidResourceReferenceParameters - error_instance_id: str - - class InvalidRoleIdsParameters(typing_extensions.TypedDict): """A roleId referenced in either default roles or role grants does not exist in the project role set for the space.""" @@ -835,21 +759,6 @@ class RemoveOrganizationsPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class RemoveProjectResourceReferencesPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not remove the ProjectResourceReference.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - projectRid: filesystem_models.ProjectRid - - -@dataclass -class RemoveProjectResourceReferencesPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["RemoveProjectResourceReferencesPermissionDenied"] - parameters: RemoveProjectResourceReferencesPermissionDeniedParameters - error_instance_id: str - - class RemoveResourceRolesPermissionDeniedParameters(typing_extensions.TypedDict): """Could not remove the ResourceRole.""" @@ -865,21 +774,6 @@ class RemoveResourceRolesPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class ReplaceFolderPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not replace the Folder.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - folderRid: filesystem_models.FolderRid - - -@dataclass -class ReplaceFolderPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["ReplaceFolderPermissionDenied"] - parameters: ReplaceFolderPermissionDeniedParameters - error_instance_id: str - - class ReplaceProjectPermissionDeniedParameters(typing_extensions.TypedDict): """Could not replace the Project.""" @@ -1175,9 +1069,7 @@ class UsageAccountServiceIsNotPresent(errors.InternalServerError): "AddGroupToParentGroupPermissionDenied", "AddMarkingsPermissionDenied", "AddOrganizationsPermissionDenied", - "AddProjectResourceReferencesPermissionDenied", "AddResourceRolesPermissionDenied", - "CircularDependency", "CreateFolderOutsideProjectNotSupported", "CreateFolderPermissionDenied", "CreateGroupPermissionDenied", @@ -1202,11 +1094,8 @@ class UsageAccountServiceIsNotPresent(errors.InternalServerError): "InvalidFolder", "InvalidOrganizationHierarchy", "InvalidOrganizations", - "InvalidParentFolder", "InvalidPath", "InvalidPrincipalIdsForGroupTemplate", - "InvalidProject", - "InvalidResourceReference", "InvalidRoleIds", "InvalidVariable", "InvalidVariableEnumOption", @@ -1226,9 +1115,7 @@ class UsageAccountServiceIsNotPresent(errors.InternalServerError): "ProjectTemplateNotFound", "RemoveMarkingsPermissionDenied", "RemoveOrganizationsPermissionDenied", - "RemoveProjectResourceReferencesPermissionDenied", "RemoveResourceRolesPermissionDenied", - "ReplaceFolderPermissionDenied", "ReplaceProjectPermissionDenied", "ReplaceSpacePermissionDenied", "ReservedSpaceCannotBeReplaced", diff --git a/foundry_sdk/v2/filesystem/folder.py b/foundry_sdk/v2/filesystem/folder.py index 6ad664750..c39924065 100644 --- a/foundry_sdk/v2/filesystem/folder.py +++ b/foundry_sdk/v2/filesystem/folder.py @@ -291,80 +291,6 @@ def get_batch( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def replace( - self, - folder_rid: filesystem_models.FolderRid, - *, - display_name: filesystem_models.ResourceDisplayName, - parent_folder_rid: filesystem_models.FolderRid, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> filesystem_models.Folder: - """ - Replace the Folder with the specified rid. - :param folder_rid: - :type folder_rid: FolderRid - :param display_name: - :type display_name: ResourceDisplayName - :param parent_folder_rid: The parent folder Resource Identifier (RID). For Projects, this will be the Space RID and for Spaces, this value will be the root folder (`ri.compass.main.folder.0`). - :type parent_folder_rid: FolderRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: filesystem_models.Folder - - :raises CircularDependency: The requested operation would result in a circular dependency in the folder hierarchy. For example, moving a folder into one of its descendants. - :raises FolderNotFound: The given Folder could not be found. - :raises GetRootFolderNotSupported: Getting the root folder as a resource is not supported. - :raises InvalidDisplayName: The display name of a Resource should not be exactly `.` or `..`, contain a forward slash `/` and must be less than or equal to 700 characters. - :raises InvalidFolder: The given Resource is not a Folder. - :raises InvalidParentFolder: The specified parent folder is not a valid destination for the resource. For example, a project cannot be moved under a regular folder, a folder cannot be moved to a Space, etc. - :raises MissingDisplayName: A Display Name must be provided. - :raises ReplaceFolderPermissionDenied: Could not replace the Folder. - :raises ResourceNameAlreadyExists: The provided resource name is already in use by another resource in the same folder. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="PUT", - resource_path="/v2/filesystem/folders/{folderRid}", - query_params={ - "preview": preview, - }, - path_params={ - "folderRid": folder_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=filesystem_models.ReplaceFolderRequest( - parent_folder_rid=parent_folder_rid, - display_name=display_name, - ), - response_type=filesystem_models.Folder, - request_timeout=request_timeout, - throwable_errors={ - "CircularDependency": filesystem_errors.CircularDependency, - "FolderNotFound": filesystem_errors.FolderNotFound, - "GetRootFolderNotSupported": filesystem_errors.GetRootFolderNotSupported, - "InvalidDisplayName": filesystem_errors.InvalidDisplayName, - "InvalidFolder": filesystem_errors.InvalidFolder, - "InvalidParentFolder": filesystem_errors.InvalidParentFolder, - "MissingDisplayName": filesystem_errors.MissingDisplayName, - "ReplaceFolderPermissionDenied": filesystem_errors.ReplaceFolderPermissionDenied, - "ResourceNameAlreadyExists": filesystem_errors.ResourceNameAlreadyExists, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _FolderClientRaw: def __init__(self, client: FolderClient) -> None: @@ -372,13 +298,11 @@ def children(_: filesystem_models.ListChildrenOfFolderResponse): ... def create(_: filesystem_models.Folder): ... def get(_: filesystem_models.Folder): ... def get_batch(_: filesystem_models.GetFoldersBatchResponse): ... - def replace(_: filesystem_models.Folder): ... self.children = core.with_raw_response(children, client.children) self.create = core.with_raw_response(create, client.create) self.get = core.with_raw_response(get, client.get) self.get_batch = core.with_raw_response(get_batch, client.get_batch) - self.replace = core.with_raw_response(replace, client.replace) class _FolderClientStreaming: @@ -387,13 +311,11 @@ def children(_: filesystem_models.ListChildrenOfFolderResponse): ... def create(_: filesystem_models.Folder): ... def get(_: filesystem_models.Folder): ... def get_batch(_: filesystem_models.GetFoldersBatchResponse): ... - def replace(_: filesystem_models.Folder): ... self.children = core.with_streaming_response(children, client.children) self.create = core.with_streaming_response(create, client.create) self.get = core.with_streaming_response(get, client.get) self.get_batch = core.with_streaming_response(get_batch, client.get_batch) - self.replace = core.with_streaming_response(replace, client.replace) class AsyncFolderClient: @@ -661,80 +583,6 @@ def get_batch( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def replace( - self, - folder_rid: filesystem_models.FolderRid, - *, - display_name: filesystem_models.ResourceDisplayName, - parent_folder_rid: filesystem_models.FolderRid, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[filesystem_models.Folder]: - """ - Replace the Folder with the specified rid. - :param folder_rid: - :type folder_rid: FolderRid - :param display_name: - :type display_name: ResourceDisplayName - :param parent_folder_rid: The parent folder Resource Identifier (RID). For Projects, this will be the Space RID and for Spaces, this value will be the root folder (`ri.compass.main.folder.0`). - :type parent_folder_rid: FolderRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[filesystem_models.Folder] - - :raises CircularDependency: The requested operation would result in a circular dependency in the folder hierarchy. For example, moving a folder into one of its descendants. - :raises FolderNotFound: The given Folder could not be found. - :raises GetRootFolderNotSupported: Getting the root folder as a resource is not supported. - :raises InvalidDisplayName: The display name of a Resource should not be exactly `.` or `..`, contain a forward slash `/` and must be less than or equal to 700 characters. - :raises InvalidFolder: The given Resource is not a Folder. - :raises InvalidParentFolder: The specified parent folder is not a valid destination for the resource. For example, a project cannot be moved under a regular folder, a folder cannot be moved to a Space, etc. - :raises MissingDisplayName: A Display Name must be provided. - :raises ReplaceFolderPermissionDenied: Could not replace the Folder. - :raises ResourceNameAlreadyExists: The provided resource name is already in use by another resource in the same folder. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="PUT", - resource_path="/v2/filesystem/folders/{folderRid}", - query_params={ - "preview": preview, - }, - path_params={ - "folderRid": folder_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=filesystem_models.ReplaceFolderRequest( - parent_folder_rid=parent_folder_rid, - display_name=display_name, - ), - response_type=filesystem_models.Folder, - request_timeout=request_timeout, - throwable_errors={ - "CircularDependency": filesystem_errors.CircularDependency, - "FolderNotFound": filesystem_errors.FolderNotFound, - "GetRootFolderNotSupported": filesystem_errors.GetRootFolderNotSupported, - "InvalidDisplayName": filesystem_errors.InvalidDisplayName, - "InvalidFolder": filesystem_errors.InvalidFolder, - "InvalidParentFolder": filesystem_errors.InvalidParentFolder, - "MissingDisplayName": filesystem_errors.MissingDisplayName, - "ReplaceFolderPermissionDenied": filesystem_errors.ReplaceFolderPermissionDenied, - "ResourceNameAlreadyExists": filesystem_errors.ResourceNameAlreadyExists, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _AsyncFolderClientRaw: def __init__(self, client: AsyncFolderClient) -> None: @@ -742,13 +590,11 @@ def children(_: filesystem_models.ListChildrenOfFolderResponse): ... def create(_: filesystem_models.Folder): ... def get(_: filesystem_models.Folder): ... def get_batch(_: filesystem_models.GetFoldersBatchResponse): ... - def replace(_: filesystem_models.Folder): ... self.children = core.async_with_raw_response(children, client.children) self.create = core.async_with_raw_response(create, client.create) self.get = core.async_with_raw_response(get, client.get) self.get_batch = core.async_with_raw_response(get_batch, client.get_batch) - self.replace = core.async_with_raw_response(replace, client.replace) class _AsyncFolderClientStreaming: @@ -757,10 +603,8 @@ def children(_: filesystem_models.ListChildrenOfFolderResponse): ... def create(_: filesystem_models.Folder): ... def get(_: filesystem_models.Folder): ... def get_batch(_: filesystem_models.GetFoldersBatchResponse): ... - def replace(_: filesystem_models.Folder): ... self.children = core.async_with_streaming_response(children, client.children) self.create = core.async_with_streaming_response(create, client.create) self.get = core.async_with_streaming_response(get, client.get) self.get_batch = core.async_with_streaming_response(get_batch, client.get_batch) - self.replace = core.async_with_streaming_response(replace, client.replace) diff --git a/foundry_sdk/v2/filesystem/models.py b/foundry_sdk/v2/filesystem/models.py index 82aff0a9a..881589b68 100644 --- a/foundry_sdk/v2/filesystem/models.py +++ b/foundry_sdk/v2/filesystem/models.py @@ -34,25 +34,6 @@ class AccessRequirements(core.ModelBase): markings: typing.List[Marking] -class AddExternalResourceReferenceRequest(core.ModelBase): - """A request to add an external resource as a reference to a project""" - - resource_rid: core.RID = pydantic.Field(alias=str("resourceRid")) # type: ignore[literal-required] - """The resource identifier of the external resource to add as a reference. Note that this is not a Foundry filesystem resource.""" - - import_name: str = pydantic.Field(alias=str("importName")) # type: ignore[literal-required] - """A user-provided label for this reference, used to identify the import within the project.""" - - type: typing.Literal["external"] = "external" - - -class AddFilesystemResourceReferenceRequest(core.ModelBase): - """A request to add a resource from the filesystem as a reference to a project""" - - resource_rid: ResourceRid = pydantic.Field(alias=str("resourceRid")) # type: ignore[literal-required] - type: typing.Literal["filesystem"] = "filesystem" - - class AddMarkingsRequest(core.ModelBase): """AddMarkingsRequest""" @@ -65,19 +46,6 @@ class AddOrganizationsRequest(core.ModelBase): organization_rids: typing.List[core_models.OrganizationRid] = pydantic.Field(alias=str("organizationRids")) # type: ignore[literal-required] -class AddProjectResourceReferencesRequest(core.ModelBase): - """AddProjectResourceReferencesRequest""" - - resources: typing.List[AddResourceReferenceRequest] - - -AddResourceReferenceRequest = typing_extensions.Annotated[ - typing.Union["AddExternalResourceReferenceRequest", "AddFilesystemResourceReferenceRequest"], - pydantic.Field(discriminator="type"), -] -"""A request to add a resource as a reference to a project""" - - class AddResourceRolesRequest(core.ModelBase): """AddResourceRolesRequest""" @@ -115,11 +83,6 @@ class CreateProjectRequest(core.ModelBase): role_grants: typing.Dict[core_models.RoleId, typing.List[PrincipalWithId]] = pydantic.Field(alias=str("roleGrants")) # type: ignore[literal-required] default_roles: typing.List[core_models.RoleId] = pydantic.Field(alias=str("defaultRoles")) # type: ignore[literal-required] organization_rids: typing.List[core_models.OrganizationRid] = pydantic.Field(alias=str("organizationRids")) # type: ignore[literal-required] - resource_level_role_grants_allowed: typing.Optional[bool] = pydantic.Field(alias=str("resourceLevelRoleGrantsAllowed"), default=None) # type: ignore[literal-required] - """ - Whether role grants should be allowed on individual resources within the Project. - When not specified, defaults to true. - """ class CreateSpaceRequest(core.ModelBase): @@ -277,13 +240,6 @@ class ListOrganizationsOfProjectResponse(core.ModelBase): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] -class ListProjectResourceReferencesResponse(core.ModelBase): - """ListProjectResourceReferencesResponse""" - - data: typing.List[ProjectResourceReference] - next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] - - class ListResourceRolesResponse(core.ModelBase): """ListResourceRolesResponse""" @@ -363,63 +319,6 @@ class Project(core.ModelBase): space_rid: SpaceRid = pydantic.Field(alias=str("spaceRid")) # type: ignore[literal-required] """The Space Resource Identifier (RID) that the Project lives in.""" - resource_level_role_grants_allowed: ProjectResourceLevelRoleGrantsAllowed = pydantic.Field(alias=str("resourceLevelRoleGrantsAllowed")) # type: ignore[literal-required] - """Whether role grants are allowed on individual resources within the Project.""" - - -class ProjectExternalResourceReference(core.ModelBase): - """A reference to a resource that exists outside of the Foundry filesystem such as a spark profile or an LLM model.""" - - resource_rid: core.RID = pydantic.Field(alias=str("resourceRid")) # type: ignore[literal-required] - """The resource identifier of the external resource.""" - - name: str - """The user-provided label for this reference, used to identify the import within the project.""" - - imported_at: core.AwareDatetime = pydantic.Field(alias=str("importedAt")) # type: ignore[literal-required] - imported_by: core_models.UserId = pydantic.Field(alias=str("importedBy")) # type: ignore[literal-required] - type: typing.Literal["external"] = "external" - - -class ProjectFilesystemResourceReference(core.ModelBase): - """A reference to a resource that exists within another project""" - - resource_rid: ResourceRid = pydantic.Field(alias=str("resourceRid")) # type: ignore[literal-required] - name: str - """The display name of the referenced resource.""" - - imported_at: core.AwareDatetime = pydantic.Field(alias=str("importedAt")) # type: ignore[literal-required] - imported_by: core_models.UserId = pydantic.Field(alias=str("importedBy")) # type: ignore[literal-required] - type: typing.Literal["filesystem"] = "filesystem" - - -ProjectResourceLevelRoleGrantsAllowed = bool -"""Whether role grants are allowed on individual resources within the Project.""" - - -class ProjectResourceReference(core.ModelBase): - """ProjectResourceReference""" - - reference: ProjectResourceReferenceUnion - - -ProjectResourceReferenceType = typing.Literal["EXTERNAL", "FILESYSTEM"] -""" -A type of resource that has been referenced. A FILESYSTEM resource is anything that you can find in a Foundry -file tree within a project. An EXTERNAL resource exists outside of the Foundry filesystem, such as a spark -profile or an LLM model. -""" - - -ProjectResourceReferenceUnion = typing_extensions.Annotated[ - typing.Union["ProjectExternalResourceReference", "ProjectFilesystemResourceReference"], - pydantic.Field(discriminator="type"), -] -""" -A [reference](https://palantir.com/docs/foundry/security/projects-and-roles/#references) represents a resource from outside of -the current project that has been imported to the given project. -""" - ProjectRid = core.RID """The unique resource identifier (RID) of a Project.""" @@ -449,31 +348,12 @@ class RemoveOrganizationsRequest(core.ModelBase): organization_rids: typing.List[core_models.OrganizationRid] = pydantic.Field(alias=str("organizationRids")) # type: ignore[literal-required] -class RemoveProjectResourceReferencesRequest(core.ModelBase): - """RemoveProjectResourceReferencesRequest""" - - resources: typing.List[core.RID] - """The resource identifiers to remove as references. These may be either filesystem or external resource identifiers.""" - - class RemoveResourceRolesRequest(core.ModelBase): """RemoveResourceRolesRequest""" roles: typing.List[ResourceRoleIdentifier] -class ReplaceFolderRequest(core.ModelBase): - """ReplaceFolderRequest""" - - parent_folder_rid: FolderRid = pydantic.Field(alias=str("parentFolderRid")) # type: ignore[literal-required] - """ - The parent folder Resource Identifier (RID). For Projects, this will be the Space RID and for Spaces, - this value will be the root folder (`ri.compass.main.folder.0`). - """ - - display_name: ResourceDisplayName = pydantic.Field(alias=str("displayName")) # type: ignore[literal-required] - - class ReplaceProjectRequest(core.ModelBase): """ReplaceProjectRequest""" @@ -719,20 +599,13 @@ class Space(core.ModelBase): TrashStatus = typing.Literal["DIRECTLY_TRASHED", "ANCESTOR_TRASHED", "NOT_TRASHED"] -""" -Values: - - **DIRECTLY_TRASHED**: The resource was specifically trashed by a user. It can be restored directly. - - **ANCESTOR_TRASHED**: A folder that contains this resource was trashed by a user. Restoring this resource requires restoring the original folder. - - **NOT_TRASHED**: The default status of resources. -""" +"""TrashStatus""" UsageAccountRid = core.RID """The unique resource identifier (RID) of the usage account that will be used as a default on project creation.""" -core.resolve_forward_references(AddResourceReferenceRequest, globalns=globals(), localns=locals()) -core.resolve_forward_references(ProjectResourceReferenceUnion, globalns=globals(), localns=locals()) core.resolve_forward_references(ResourceRolePrincipal, globalns=globals(), localns=locals()) core.resolve_forward_references( ResourceRolePrincipalIdentifier, globalns=globals(), localns=locals() @@ -740,12 +613,8 @@ class Space(core.ModelBase): __all__ = [ "AccessRequirements", - "AddExternalResourceReferenceRequest", - "AddFilesystemResourceReferenceRequest", "AddMarkingsRequest", "AddOrganizationsRequest", - "AddProjectResourceReferencesRequest", - "AddResourceReferenceRequest", "AddResourceRolesRequest", "CreateFolderRequest", "CreateProjectFromTemplateRequest", @@ -766,7 +635,6 @@ class Space(core.ModelBase): "ListChildrenOfFolderResponse", "ListMarkingsOfResourceResponse", "ListOrganizationsOfProjectResponse", - "ListProjectResourceReferencesResponse", "ListResourceRolesResponse", "ListSpacesResponse", "Marking", @@ -774,21 +642,13 @@ class Space(core.ModelBase): "PrincipalIdOnly", "PrincipalWithId", "Project", - "ProjectExternalResourceReference", - "ProjectFilesystemResourceReference", - "ProjectResourceLevelRoleGrantsAllowed", - "ProjectResourceReference", - "ProjectResourceReferenceType", - "ProjectResourceReferenceUnion", "ProjectRid", "ProjectTemplateRid", "ProjectTemplateVariableId", "ProjectTemplateVariableValue", "RemoveMarkingsRequest", "RemoveOrganizationsRequest", - "RemoveProjectResourceReferencesRequest", "RemoveResourceRolesRequest", - "ReplaceFolderRequest", "ReplaceProjectRequest", "ReplaceSpaceRequest", "Resource", diff --git a/foundry_sdk/v2/filesystem/project.py b/foundry_sdk/v2/filesystem/project.py index 875e5d410..7275461cd 100644 --- a/foundry_sdk/v2/filesystem/project.py +++ b/foundry_sdk/v2/filesystem/project.py @@ -14,7 +14,6 @@ import typing -from functools import cached_property import pydantic import typing_extensions @@ -55,18 +54,6 @@ def __init__( self.with_streaming_response = _ProjectClientStreaming(self) self.with_raw_response = _ProjectClientRaw(self) - @cached_property - def Reference(self): - from foundry_sdk.v2.filesystem.project_resource_reference import ( - ProjectResourceReferenceClient, - ) # NOQA - - return ProjectResourceReferenceClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -141,7 +128,6 @@ def create( space_rid: filesystem_models.SpaceRid, description: typing.Optional[str] = None, preview: typing.Optional[core_models.PreviewMode] = None, - resource_level_role_grants_allowed: typing.Optional[bool] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> filesystem_models.Project: @@ -166,8 +152,6 @@ def create( :type description: Optional[str] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] - :param resource_level_role_grants_allowed: Whether role grants should be allowed on individual resources within the Project. When not specified, defaults to true. - :type resource_level_role_grants_allowed: Optional[bool] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -204,7 +188,6 @@ def create( role_grants=role_grants, default_roles=default_roles, organization_rids=organization_rids, - resource_level_role_grants_allowed=resource_level_role_grants_allowed, ), response_type=filesystem_models.Project, request_timeout=request_timeout, @@ -624,18 +607,6 @@ def __init__( self.with_streaming_response = _AsyncProjectClientStreaming(self) self.with_raw_response = _AsyncProjectClientRaw(self) - @cached_property - def Reference(self): - from foundry_sdk.v2.filesystem.project_resource_reference import ( - AsyncProjectResourceReferenceClient, - ) # NOQA - - return AsyncProjectResourceReferenceClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -710,7 +681,6 @@ def create( space_rid: filesystem_models.SpaceRid, description: typing.Optional[str] = None, preview: typing.Optional[core_models.PreviewMode] = None, - resource_level_role_grants_allowed: typing.Optional[bool] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[filesystem_models.Project]: @@ -735,8 +705,6 @@ def create( :type description: Optional[str] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] - :param resource_level_role_grants_allowed: Whether role grants should be allowed on individual resources within the Project. When not specified, defaults to true. - :type resource_level_role_grants_allowed: Optional[bool] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -773,7 +741,6 @@ def create( role_grants=role_grants, default_roles=default_roles, organization_rids=organization_rids, - resource_level_role_grants_allowed=resource_level_role_grants_allowed, ), response_type=filesystem_models.Project, request_timeout=request_timeout, diff --git a/foundry_sdk/v2/filesystem/project_resource_reference.py b/foundry_sdk/v2/filesystem/project_resource_reference.py deleted file mode 100644 index ab736655c..000000000 --- a/foundry_sdk/v2/filesystem/project_resource_reference.py +++ /dev/null @@ -1,491 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.core import models as core_models -from foundry_sdk.v2.filesystem import errors as filesystem_errors -from foundry_sdk.v2.filesystem import models as filesystem_models - - -class ProjectResourceReferenceClient: - """ - The API client for the ProjectResourceReference Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _ProjectResourceReferenceClientStreaming(self) - self.with_raw_response = _ProjectResourceReferenceClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def add( - self, - project_rid: filesystem_models.ProjectRid, - *, - resources: typing.List[filesystem_models.AddResourceReferenceRequest], - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> None: - """ - Add references to the given project - - :param project_rid: - :type project_rid: ProjectRid - :param resources: - :type resources: List[AddResourceReferenceRequest] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - - :raises AddProjectResourceReferencesPermissionDenied: Could not add the ProjectResourceReference. - :raises InvalidProject: The provided resource identifier does not refer to a valid project. - :raises InvalidResourceReference: The resource reference is invalid. This can occur when the resource identifier is malformed, the resource type does not match the reference type, or the resource cannot be added as a reference. - :raises ProjectNotFound: The given Project could not be found. - :raises ResourceNotFound: The given Resource could not be found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/filesystem/projects/{projectRid}/references/add", - query_params={ - "preview": preview, - }, - path_params={ - "projectRid": project_rid, - }, - header_params={ - "Content-Type": "application/json", - }, - body=filesystem_models.AddProjectResourceReferencesRequest( - resources=resources, - ), - response_type=None, - request_timeout=request_timeout, - throwable_errors={ - "AddProjectResourceReferencesPermissionDenied": filesystem_errors.AddProjectResourceReferencesPermissionDenied, - "InvalidProject": filesystem_errors.InvalidProject, - "InvalidResourceReference": filesystem_errors.InvalidResourceReference, - "ProjectNotFound": filesystem_errors.ProjectNotFound, - "ResourceNotFound": filesystem_errors.ResourceNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def list( - self, - project_rid: filesystem_models.ProjectRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - reference_type: typing.Optional[filesystem_models.ProjectResourceReferenceType] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> core.ResourceIterator[filesystem_models.ProjectResourceReference]: - """ - List all references in the given project - - :param project_rid: - :type project_rid: ProjectRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. - :type page_token: Optional[PageToken] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param reference_type: Filter references by type. If not provided, all references are returned. - :type reference_type: Optional[ProjectResourceReferenceType] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: core.ResourceIterator[filesystem_models.ProjectResourceReference] - - :raises ProjectNotFound: The given Project could not be found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/filesystem/projects/{projectRid}/references", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - "referenceType": reference_type, - }, - path_params={ - "projectRid": project_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=filesystem_models.ListProjectResourceReferencesResponse, - request_timeout=request_timeout, - throwable_errors={ - "ProjectNotFound": filesystem_errors.ProjectNotFound, - }, - response_mode=_sdk_internal.get("response_mode", "ITERATOR"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def remove( - self, - project_rid: filesystem_models.ProjectRid, - *, - resources: typing.List[core.RID], - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> None: - """ - Remove references from the given project - - :param project_rid: - :type project_rid: ProjectRid - :param resources: The resource identifiers to remove as references. These may be either filesystem or external resource identifiers. - :type resources: List[RID] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - - :raises InvalidProject: The provided resource identifier does not refer to a valid project. - :raises InvalidResourceReference: The resource reference is invalid. This can occur when the resource identifier is malformed, the resource type does not match the reference type, or the resource cannot be added as a reference. - :raises ProjectNotFound: The given Project could not be found. - :raises RemoveProjectResourceReferencesPermissionDenied: Could not remove the ProjectResourceReference. - :raises ResourceNotFound: The given Resource could not be found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/filesystem/projects/{projectRid}/references/remove", - query_params={ - "preview": preview, - }, - path_params={ - "projectRid": project_rid, - }, - header_params={ - "Content-Type": "application/json", - }, - body=filesystem_models.RemoveProjectResourceReferencesRequest( - resources=resources, - ), - response_type=None, - request_timeout=request_timeout, - throwable_errors={ - "InvalidProject": filesystem_errors.InvalidProject, - "InvalidResourceReference": filesystem_errors.InvalidResourceReference, - "ProjectNotFound": filesystem_errors.ProjectNotFound, - "RemoveProjectResourceReferencesPermissionDenied": filesystem_errors.RemoveProjectResourceReferencesPermissionDenied, - "ResourceNotFound": filesystem_errors.ResourceNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _ProjectResourceReferenceClientRaw: - def __init__(self, client: ProjectResourceReferenceClient) -> None: - def add(_: None): ... - def list(_: filesystem_models.ListProjectResourceReferencesResponse): ... - def remove(_: None): ... - - self.add = core.with_raw_response(add, client.add) - self.list = core.with_raw_response(list, client.list) - self.remove = core.with_raw_response(remove, client.remove) - - -class _ProjectResourceReferenceClientStreaming: - def __init__(self, client: ProjectResourceReferenceClient) -> None: - def list(_: filesystem_models.ListProjectResourceReferencesResponse): ... - - self.list = core.with_streaming_response(list, client.list) - - -class AsyncProjectResourceReferenceClient: - """ - The API client for the ProjectResourceReference Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncProjectResourceReferenceClientStreaming(self) - self.with_raw_response = _AsyncProjectResourceReferenceClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def add( - self, - project_rid: filesystem_models.ProjectRid, - *, - resources: typing.List[filesystem_models.AddResourceReferenceRequest], - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[None]: - """ - Add references to the given project - - :param project_rid: - :type project_rid: ProjectRid - :param resources: - :type resources: List[AddResourceReferenceRequest] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[None] - - :raises AddProjectResourceReferencesPermissionDenied: Could not add the ProjectResourceReference. - :raises InvalidProject: The provided resource identifier does not refer to a valid project. - :raises InvalidResourceReference: The resource reference is invalid. This can occur when the resource identifier is malformed, the resource type does not match the reference type, or the resource cannot be added as a reference. - :raises ProjectNotFound: The given Project could not be found. - :raises ResourceNotFound: The given Resource could not be found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/filesystem/projects/{projectRid}/references/add", - query_params={ - "preview": preview, - }, - path_params={ - "projectRid": project_rid, - }, - header_params={ - "Content-Type": "application/json", - }, - body=filesystem_models.AddProjectResourceReferencesRequest( - resources=resources, - ), - response_type=None, - request_timeout=request_timeout, - throwable_errors={ - "AddProjectResourceReferencesPermissionDenied": filesystem_errors.AddProjectResourceReferencesPermissionDenied, - "InvalidProject": filesystem_errors.InvalidProject, - "InvalidResourceReference": filesystem_errors.InvalidResourceReference, - "ProjectNotFound": filesystem_errors.ProjectNotFound, - "ResourceNotFound": filesystem_errors.ResourceNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def list( - self, - project_rid: filesystem_models.ProjectRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - reference_type: typing.Optional[filesystem_models.ProjectResourceReferenceType] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> core.AsyncResourceIterator[filesystem_models.ProjectResourceReference]: - """ - List all references in the given project - - :param project_rid: - :type project_rid: ProjectRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. - :type page_token: Optional[PageToken] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param reference_type: Filter references by type. If not provided, all references are returned. - :type reference_type: Optional[ProjectResourceReferenceType] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: core.AsyncResourceIterator[filesystem_models.ProjectResourceReference] - - :raises ProjectNotFound: The given Project could not be found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/filesystem/projects/{projectRid}/references", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - "referenceType": reference_type, - }, - path_params={ - "projectRid": project_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=filesystem_models.ListProjectResourceReferencesResponse, - request_timeout=request_timeout, - throwable_errors={ - "ProjectNotFound": filesystem_errors.ProjectNotFound, - }, - response_mode=_sdk_internal.get("response_mode", "ITERATOR"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def remove( - self, - project_rid: filesystem_models.ProjectRid, - *, - resources: typing.List[core.RID], - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[None]: - """ - Remove references from the given project - - :param project_rid: - :type project_rid: ProjectRid - :param resources: The resource identifiers to remove as references. These may be either filesystem or external resource identifiers. - :type resources: List[RID] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[None] - - :raises InvalidProject: The provided resource identifier does not refer to a valid project. - :raises InvalidResourceReference: The resource reference is invalid. This can occur when the resource identifier is malformed, the resource type does not match the reference type, or the resource cannot be added as a reference. - :raises ProjectNotFound: The given Project could not be found. - :raises RemoveProjectResourceReferencesPermissionDenied: Could not remove the ProjectResourceReference. - :raises ResourceNotFound: The given Resource could not be found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/filesystem/projects/{projectRid}/references/remove", - query_params={ - "preview": preview, - }, - path_params={ - "projectRid": project_rid, - }, - header_params={ - "Content-Type": "application/json", - }, - body=filesystem_models.RemoveProjectResourceReferencesRequest( - resources=resources, - ), - response_type=None, - request_timeout=request_timeout, - throwable_errors={ - "InvalidProject": filesystem_errors.InvalidProject, - "InvalidResourceReference": filesystem_errors.InvalidResourceReference, - "ProjectNotFound": filesystem_errors.ProjectNotFound, - "RemoveProjectResourceReferencesPermissionDenied": filesystem_errors.RemoveProjectResourceReferencesPermissionDenied, - "ResourceNotFound": filesystem_errors.ResourceNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _AsyncProjectResourceReferenceClientRaw: - def __init__(self, client: AsyncProjectResourceReferenceClient) -> None: - def add(_: None): ... - def list(_: filesystem_models.ListProjectResourceReferencesResponse): ... - def remove(_: None): ... - - self.add = core.async_with_raw_response(add, client.add) - self.list = core.async_with_raw_response(list, client.list) - self.remove = core.async_with_raw_response(remove, client.remove) - - -class _AsyncProjectResourceReferenceClientStreaming: - def __init__(self, client: AsyncProjectResourceReferenceClient) -> None: - def list(_: filesystem_models.ListProjectResourceReferencesResponse): ... - - self.list = core.async_with_streaming_response(list, client.list) diff --git a/foundry_sdk/v2/functions/_client.py b/foundry_sdk/v2/functions/_client.py index 87f0d52b0..f66b1d1e9 100644 --- a/foundry_sdk/v2/functions/_client.py +++ b/foundry_sdk/v2/functions/_client.py @@ -43,16 +43,6 @@ def __init__( self._config = config - @cached_property - def Execution(self): - from foundry_sdk.v2.functions.execution import ExecutionClient - - return ExecutionClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - @cached_property def Query(self): from foundry_sdk.v2.functions.query import QueryClient @@ -89,12 +79,9 @@ def __init__( hostname: typing.Union[str, core.HostnameSupplier], config: typing.Optional[core.Config] = None, ): - from foundry_sdk.v2.functions.execution import AsyncExecutionClient from foundry_sdk.v2.functions.query import AsyncQueryClient from foundry_sdk.v2.functions.value_type import AsyncValueTypeClient - self.Execution = AsyncExecutionClient(auth=auth, hostname=hostname, config=config) - self.Query = AsyncQueryClient(auth=auth, hostname=hostname, config=config) self.ValueType = AsyncValueTypeClient(auth=auth, hostname=hostname, config=config) diff --git a/foundry_sdk/v2/functions/errors.py b/foundry_sdk/v2/functions/errors.py index fa2324f81..7ee8a1884 100644 --- a/foundry_sdk/v2/functions/errors.py +++ b/foundry_sdk/v2/functions/errors.py @@ -22,165 +22,6 @@ from foundry_sdk.v2.functions import models as functions_models -class AsyncConsistentSnapshotErrorParameters(typing_extensions.TypedDict): - """ - The async query failed because the Ontology snapshot used for consistent reads became stale. Retrying the - request typically resolves this. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - functionRid: typing_extensions.NotRequired[functions_models.FunctionRid] - functionVersion: typing_extensions.NotRequired[functions_models.FunctionVersion] - - -@dataclass -class AsyncConsistentSnapshotError(errors.ConflictError): - name: typing.Literal["AsyncConsistentSnapshotError"] - parameters: AsyncConsistentSnapshotErrorParameters - error_instance_id: str - - -class AsyncFunctionNotSupportedWithTransactionParameters(typing_extensions.TypedDict): - """The function runtime does not support async execution with a transaction.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - functionRid: typing_extensions.NotRequired[functions_models.FunctionRid] - functionVersion: typing_extensions.NotRequired[functions_models.FunctionVersion] - message: str - - -@dataclass -class AsyncFunctionNotSupportedWithTransaction(errors.BadRequestError): - name: typing.Literal["AsyncFunctionNotSupportedWithTransaction"] - parameters: AsyncFunctionNotSupportedWithTransactionParameters - error_instance_id: str - - -class AsyncInvalidQueryOutputValueParameters(typing_extensions.TypedDict): - """ - The value of the async query's output is invalid. This may be because the return value did not match the - specified output type or constraints. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - outputDataType: typing_extensions.NotRequired[functions_models.QueryDataType] - outputValue: typing_extensions.NotRequired[functions_models.DataValue] - functionRid: typing_extensions.NotRequired[functions_models.FunctionRid] - functionVersion: typing_extensions.NotRequired[functions_models.FunctionVersion] - - -@dataclass -class AsyncInvalidQueryOutputValue(errors.BadRequestError): - name: typing.Literal["AsyncInvalidQueryOutputValue"] - parameters: AsyncInvalidQueryOutputValueParameters - error_instance_id: str - - -class AsyncQueryEncounteredUserFacingErrorParameters(typing_extensions.TypedDict): - """ - The authored `Query` failed during async execution because of a user induced error. The message argument - is meant to be displayed to the user. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - functionRid: typing_extensions.NotRequired[functions_models.FunctionRid] - functionVersion: typing_extensions.NotRequired[functions_models.FunctionVersion] - message: str - - -@dataclass -class AsyncQueryEncounteredUserFacingError(errors.ConflictError): - name: typing.Literal["AsyncQueryEncounteredUserFacingError"] - parameters: AsyncQueryEncounteredUserFacingErrorParameters - error_instance_id: str - - -class AsyncQueryMemoryExceededLimitParameters(typing_extensions.TypedDict): - """Memory limits were exceeded during async `Query` execution.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - functionRid: typing_extensions.NotRequired[functions_models.FunctionRid] - functionVersion: typing_extensions.NotRequired[functions_models.FunctionVersion] - - -@dataclass -class AsyncQueryMemoryExceededLimit(errors.InternalServerError): - name: typing.Literal["AsyncQueryMemoryExceededLimit"] - parameters: AsyncQueryMemoryExceededLimitParameters - error_instance_id: str - - -class AsyncQueryRuntimeErrorParameters(typing_extensions.TypedDict): - """The authored `Query` failed to execute because of a runtime error during async execution.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - functionRid: typing_extensions.NotRequired[functions_models.FunctionRid] - functionVersion: typing_extensions.NotRequired[functions_models.FunctionVersion] - message: typing_extensions.NotRequired[str] - stacktrace: typing_extensions.NotRequired[str] - parameters: typing.Dict[functions_models.QueryRuntimeErrorParameter, str] - - -@dataclass -class AsyncQueryRuntimeError(errors.BadRequestError): - name: typing.Literal["AsyncQueryRuntimeError"] - parameters: AsyncQueryRuntimeErrorParameters - error_instance_id: str - - -class AsyncQueryTimeExceededLimitParameters(typing_extensions.TypedDict): - """Time limits were exceeded during async `Query` execution.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - functionRid: typing_extensions.NotRequired[functions_models.FunctionRid] - functionVersion: typing_extensions.NotRequired[functions_models.FunctionVersion] - - -@dataclass -class AsyncQueryTimeExceededLimit(errors.InternalServerError): - name: typing.Literal["AsyncQueryTimeExceededLimit"] - parameters: AsyncQueryTimeExceededLimitParameters - error_instance_id: str - - -class CancelExecutionNotSupportedParameters(typing_extensions.TypedDict): - """The function runtime does not support cancelling executions.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - functionRid: typing_extensions.NotRequired[functions_models.FunctionRid] - functionVersion: typing_extensions.NotRequired[functions_models.FunctionVersion] - - -@dataclass -class CancelExecutionNotSupported(errors.InternalServerError): - name: typing.Literal["CancelExecutionNotSupported"] - parameters: CancelExecutionNotSupportedParameters - error_instance_id: str - - -class CancelExecutionPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not cancel the Execution.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - executionId: functions_models.ExecutionId - - -@dataclass -class CancelExecutionPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["CancelExecutionPermissionDenied"] - parameters: CancelExecutionPermissionDeniedParameters - error_instance_id: str - - class ConsistentSnapshotErrorParameters(typing_extensions.TypedDict): """ The query failed because the Ontology snapshot used for consistent reads became stale. Retrying the request @@ -200,21 +41,6 @@ class ConsistentSnapshotError(errors.ConflictError): error_instance_id: str -class ExecuteAsyncQueryPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not executeAsync the Query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - queryApiName: functions_models.QueryApiName - - -@dataclass -class ExecuteAsyncQueryPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["ExecuteAsyncQueryPermissionDenied"] - parameters: ExecuteAsyncQueryPermissionDeniedParameters - error_instance_id: str - - class ExecuteQueryPermissionDeniedParameters(typing_extensions.TypedDict): """Could not execute the Query.""" @@ -230,21 +56,6 @@ class ExecuteQueryPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class ExecutionNotFoundParameters(typing_extensions.TypedDict): - """No async query execution found with the given ID.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - executionId: functions_models.ExecutionId - - -@dataclass -class ExecutionNotFound(errors.NotFoundError): - name: typing.Literal["ExecutionNotFound"] - parameters: ExecutionNotFoundParameters - error_instance_id: str - - class FunctionHasNoPublishedVersionParameters(typing_extensions.TypedDict): """The query function has no published versions.""" @@ -275,48 +86,16 @@ class FunctionNotFound(errors.NotFoundError): error_instance_id: str -class FunctionNotSupportedWithTransactionParameters(typing_extensions.TypedDict): - """The function runtime does not support execution with a transaction.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - functionRid: functions_models.FunctionRid - functionVersion: functions_models.FunctionVersion - message: str - - -@dataclass -class FunctionNotSupportedWithTransaction(errors.BadRequestError): - name: typing.Literal["FunctionNotSupportedWithTransaction"] - parameters: FunctionNotSupportedWithTransactionParameters - error_instance_id: str - - -class GetByRidPermissionDeniedParameters(typing_extensions.TypedDict): +class GetByRidQueriesPermissionDeniedParameters(typing_extensions.TypedDict): """Could not getByRid the Query.""" __pydantic_config__ = {"extra": "allow"} # type: ignore @dataclass -class GetByRidPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["GetByRidPermissionDenied"] - parameters: GetByRidPermissionDeniedParameters - error_instance_id: str - - -class GetResultExecutionPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not getResult the Execution.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - executionId: functions_models.ExecutionId - - -@dataclass -class GetResultExecutionPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["GetResultExecutionPermissionDenied"] - parameters: GetResultExecutionPermissionDeniedParameters +class GetByRidQueriesPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["GetByRidQueriesPermissionDenied"] + parameters: GetByRidQueriesPermissionDeniedParameters error_instance_id: str @@ -547,24 +326,11 @@ class VersionIdNotFound(errors.NotFoundError): __all__ = [ - "AsyncConsistentSnapshotError", - "AsyncFunctionNotSupportedWithTransaction", - "AsyncInvalidQueryOutputValue", - "AsyncQueryEncounteredUserFacingError", - "AsyncQueryMemoryExceededLimit", - "AsyncQueryRuntimeError", - "AsyncQueryTimeExceededLimit", - "CancelExecutionNotSupported", - "CancelExecutionPermissionDenied", "ConsistentSnapshotError", - "ExecuteAsyncQueryPermissionDenied", "ExecuteQueryPermissionDenied", - "ExecutionNotFound", "FunctionHasNoPublishedVersion", "FunctionNotFound", - "FunctionNotSupportedWithTransaction", - "GetByRidPermissionDenied", - "GetResultExecutionPermissionDenied", + "GetByRidQueriesPermissionDenied", "InvalidQueryOutputValue", "InvalidQueryParameterValue", "MissingParameter", diff --git a/foundry_sdk/v2/functions/execution.py b/foundry_sdk/v2/functions/execution.py deleted file mode 100644 index 3807cb318..000000000 --- a/foundry_sdk/v2/functions/execution.py +++ /dev/null @@ -1,351 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.core import models as core_models -from foundry_sdk.v2.functions import errors as functions_errors -from foundry_sdk.v2.functions import models as functions_models - - -class ExecutionClient: - """ - The API client for the Execution Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _ExecutionClientStreaming(self) - self.with_raw_response = _ExecutionClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def cancel( - self, - execution_id: functions_models.ExecutionId, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> functions_models.CancelExecutionResponse: - """ - Cancel a running async query execution. This endpoint is idempotent. - - :param execution_id: - :type execution_id: ExecutionId - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: functions_models.CancelExecutionResponse - - :raises CancelExecutionPermissionDenied: Could not cancel the Execution. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/functions/executions/{executionId}/cancel", - query_params={ - "preview": preview, - }, - path_params={ - "executionId": execution_id, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=functions_models.CancelExecutionResponse, - request_timeout=request_timeout, - throwable_errors={ - "CancelExecutionPermissionDenied": functions_errors.CancelExecutionPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get_result( - self, - execution_id: functions_models.ExecutionId, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - timeout: typing.Optional[int] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> functions_models.GetExecutionResultResponse: - """ - Poll for the result of an async query execution. - - Returns a discriminated union: - - running: execution is still in progress. - - succeeded: execution completed successfully with a return value. - - If the execution failed, a service error is thrown. - - Use the timeout parameter for long-polling: the server holds the - connection open for up to the specified number of seconds. If the - execution completes within that window, the result is returned - immediately. Otherwise, the running variant is returned. - - :param execution_id: - :type execution_id: ExecutionId - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param timeout: Maximum time in seconds to hold the connection open while waiting for execution to complete. Default: 0 (immediate status check). Values above 280 are clamped to 280. - :type timeout: Optional[int] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: functions_models.GetExecutionResultResponse - - :raises GetResultExecutionPermissionDenied: Could not getResult the Execution. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/functions/executions/{executionId}/getResult", - query_params={ - "preview": preview, - }, - path_params={ - "executionId": execution_id, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=functions_models.GetResultExecutionRequest( - timeout=timeout, - ), - response_type=functions_models.GetExecutionResultResponse, - request_timeout=request_timeout, - throwable_errors={ - "GetResultExecutionPermissionDenied": functions_errors.GetResultExecutionPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _ExecutionClientRaw: - def __init__(self, client: ExecutionClient) -> None: - def cancel(_: functions_models.CancelExecutionResponse): ... - def get_result(_: functions_models.GetExecutionResultResponse): ... - - self.cancel = core.with_raw_response(cancel, client.cancel) - self.get_result = core.with_raw_response(get_result, client.get_result) - - -class _ExecutionClientStreaming: - def __init__(self, client: ExecutionClient) -> None: - def cancel(_: functions_models.CancelExecutionResponse): ... - def get_result(_: functions_models.GetExecutionResultResponse): ... - - self.cancel = core.with_streaming_response(cancel, client.cancel) - self.get_result = core.with_streaming_response(get_result, client.get_result) - - -class AsyncExecutionClient: - """ - The API client for the Execution Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncExecutionClientStreaming(self) - self.with_raw_response = _AsyncExecutionClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def cancel( - self, - execution_id: functions_models.ExecutionId, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[functions_models.CancelExecutionResponse]: - """ - Cancel a running async query execution. This endpoint is idempotent. - - :param execution_id: - :type execution_id: ExecutionId - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[functions_models.CancelExecutionResponse] - - :raises CancelExecutionPermissionDenied: Could not cancel the Execution. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/functions/executions/{executionId}/cancel", - query_params={ - "preview": preview, - }, - path_params={ - "executionId": execution_id, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=functions_models.CancelExecutionResponse, - request_timeout=request_timeout, - throwable_errors={ - "CancelExecutionPermissionDenied": functions_errors.CancelExecutionPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get_result( - self, - execution_id: functions_models.ExecutionId, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - timeout: typing.Optional[int] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[functions_models.GetExecutionResultResponse]: - """ - Poll for the result of an async query execution. - - Returns a discriminated union: - - running: execution is still in progress. - - succeeded: execution completed successfully with a return value. - - If the execution failed, a service error is thrown. - - Use the timeout parameter for long-polling: the server holds the - connection open for up to the specified number of seconds. If the - execution completes within that window, the result is returned - immediately. Otherwise, the running variant is returned. - - :param execution_id: - :type execution_id: ExecutionId - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param timeout: Maximum time in seconds to hold the connection open while waiting for execution to complete. Default: 0 (immediate status check). Values above 280 are clamped to 280. - :type timeout: Optional[int] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[functions_models.GetExecutionResultResponse] - - :raises GetResultExecutionPermissionDenied: Could not getResult the Execution. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/functions/executions/{executionId}/getResult", - query_params={ - "preview": preview, - }, - path_params={ - "executionId": execution_id, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=functions_models.GetResultExecutionRequest( - timeout=timeout, - ), - response_type=functions_models.GetExecutionResultResponse, - request_timeout=request_timeout, - throwable_errors={ - "GetResultExecutionPermissionDenied": functions_errors.GetResultExecutionPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _AsyncExecutionClientRaw: - def __init__(self, client: AsyncExecutionClient) -> None: - def cancel(_: functions_models.CancelExecutionResponse): ... - def get_result(_: functions_models.GetExecutionResultResponse): ... - - self.cancel = core.async_with_raw_response(cancel, client.cancel) - self.get_result = core.async_with_raw_response(get_result, client.get_result) - - -class _AsyncExecutionClientStreaming: - def __init__(self, client: AsyncExecutionClient) -> None: - def cancel(_: functions_models.CancelExecutionResponse): ... - def get_result(_: functions_models.GetExecutionResultResponse): ... - - self.cancel = core.async_with_streaming_response(cancel, client.cancel) - self.get_result = core.async_with_streaming_response(get_result, client.get_result) diff --git a/foundry_sdk/v2/functions/models.py b/foundry_sdk/v2/functions/models.py index 21385bc04..baac373a3 100644 --- a/foundry_sdk/v2/functions/models.py +++ b/foundry_sdk/v2/functions/models.py @@ -35,12 +35,6 @@ class ArrayConstraint(core.ModelBase): type: typing.Literal["array"] = "array" -class CancelExecutionResponse(core.ModelBase): - """CancelExecutionResponse""" - - id: ExecutionId - - DataValue = typing.Any """ Represents the value of data in the following format. Note that these values can be nested, for example an array of structs. @@ -75,46 +69,11 @@ class EnumConstraint(core.ModelBase): type: typing.Literal["enum"] = "enum" -class ExecuteAsyncQueryRequest(core.ModelBase): - """ExecuteAsyncQueryRequest""" - - ontology: typing.Optional[ontologies_models.OntologyIdentifier] = None - """ - Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped - function. When omitted, executes a global function. - """ - - parameters: typing.Dict[ParameterId, typing.Optional[DataValue]] - version: typing.Optional[FunctionVersion] = None - """The version of the query to execute. When used with `branch`, the specified version must exist on the branch.""" - - branch: typing.Optional[core_models.FoundryBranch] = None - """ - The Foundry branch to execute the query from. If not specified, the default branch is used. - When provided without `version`, the latest version on this branch is used. - When provided with `version`, the specified version must exist on the branch. - """ - - -ExecuteQueryAsyncResponse = typing_extensions.Annotated[ - typing.Union["ExecutionSubmitted", "ExecutionCompleted"], pydantic.Field(discriminator="type") -] -"""Response from submitting a query for async execution.""" - - class ExecuteQueryRequest(core.ModelBase): """ExecuteQueryRequest""" parameters: typing.Dict[ParameterId, typing.Optional[DataValue]] version: typing.Optional[FunctionVersion] = None - """The version of the query to execute. When used with `branch`, the specified version must exist on the branch.""" - - branch: typing.Optional[core_models.FoundryBranch] = None - """ - The Foundry branch to execute the query from. If not specified, the default branch is used. - When provided without `version`, the latest version on this branch is used. - When provided with `version`, the specified version must exist on the branch. - """ class ExecuteQueryResponse(core.ModelBase): @@ -123,27 +82,6 @@ class ExecuteQueryResponse(core.ModelBase): value: DataValue -class ExecutionCompleted(core.ModelBase): - """The query completed immediately. No polling needed.""" - - value: DataValue - type: typing.Literal["completed"] = "completed" - - -ExecutionId = str -"""Unique identifier for an async query execution.""" - - -class ExecutionSubmitted(core.ModelBase): - """ - The query was submitted for async processing. - Use the executionId to poll for results via getResult or to cancel via cancel. - """ - - execution_id: ExecutionId = pydantic.Field(alias=str("executionId")) # type: ignore[literal-required] - type: typing.Literal["submitted"] = "submitted" - - FunctionRid = core.RID """The unique resource identifier of a Function, useful for interacting with other Foundry APIs.""" @@ -155,9 +93,11 @@ class ExecutionSubmitted(core.ModelBase): """ -class GetByRidQueriesBatchRequestElement(core.ModelBase): - """GetByRidQueriesBatchRequestElement""" +class GetByRidQueriesRequest(core.ModelBase): + """GetByRidQueriesRequest""" + rid: FunctionRid + version: typing.Optional[FunctionVersion] = None include_prerelease: typing.Optional[bool] = pydantic.Field(alias=str("includePrerelease"), default=None) # type: ignore[literal-required] """ When no version is specified and this flag is set to true, the latest version resolution will consider @@ -167,32 +107,6 @@ class GetByRidQueriesBatchRequestElement(core.ModelBase): Defaults to false. """ - rid: FunctionRid - version: typing.Optional[FunctionVersion] = None - - -class GetByRidQueriesBatchResponse(core.ModelBase): - """GetByRidQueriesBatchResponse""" - - data: typing.List[Query] - - -GetExecutionResultResponse = typing_extensions.Annotated[ - typing.Union["RunningExecution", "SucceededExecution"], pydantic.Field(discriminator="type") -] -"""Poll response for an async query execution.""" - - -class GetResultExecutionRequest(core.ModelBase): - """GetResultExecutionRequest""" - - timeout: typing.Optional[int] = None - """ - Maximum time in seconds to hold the connection open while waiting - for execution to complete. Default: 0 (immediate status check). - Values above 280 are clamped to 280. - """ - class LengthConstraint(core.ModelBase): """LengthConstraint""" @@ -227,7 +141,6 @@ class Parameter(core.ModelBase): description: typing.Optional[str] = None data_type: QueryDataType = pydantic.Field(alias=str("dataType")) # type: ignore[literal-required] - required: bool ParameterId = str @@ -247,7 +160,6 @@ class Query(core.ModelBase): output: QueryDataType rid: FunctionRid version: FunctionVersion - type_references: typing.Optional[typing.Dict[TypeReferenceIdentifier, QueryDataType]] = pydantic.Field(alias=str("typeReferences"), default=None) # type: ignore[literal-required] QueryAggregationKeyType = typing_extensions.Annotated[ @@ -307,7 +219,6 @@ class QueryArrayType(core.ModelBase): core_models.DateType, "QueryStructType", "QuerySetType", - core_models.VoidType, core_models.StringType, core_models.DoubleType, core_models.IntegerType, @@ -318,12 +229,10 @@ class QueryArrayType(core.ModelBase): core_models.BooleanType, core_models.UnsupportedType, core_models.AttachmentType, - core_models.MediaReferenceType, core_models.NullType, "QueryArrayType", "TwoDimensionalAggregation", "ValueTypeReference", - "QueryTypeReferenceType", core_models.TimestampType, ], pydantic.Field(discriminator="type"), @@ -356,16 +265,6 @@ class QueryStructType(core.ModelBase): type: typing.Literal["struct"] = "struct" -class QueryTypeReferenceType(core.ModelBase): - """ - A reference to a type that is defined in the `typeReferences` map of the enclosing Query. - This enables support for recursive type definitions where a type may reference itself. - """ - - type_id: TypeReferenceIdentifier = pydantic.Field(alias=str("typeId")) # type: ignore[literal-required] - type: typing.Literal["typeReference"] = "typeReference" - - class QueryUnionType(core.ModelBase): """QueryUnionType""" @@ -395,12 +294,6 @@ class RidConstraint(core.ModelBase): type: typing.Literal["rid"] = "rid" -class RunningExecution(core.ModelBase): - """The query execution is still in progress.""" - - type: typing.Literal["running"] = "running" - - class StreamingExecuteQueryRequest(core.ModelBase): """StreamingExecuteQueryRequest""" @@ -412,14 +305,6 @@ class StreamingExecuteQueryRequest(core.ModelBase): parameters: typing.Dict[ParameterId, typing.Optional[DataValue]] version: typing.Optional[FunctionVersion] = None - """The version of the query to execute. When used with `branch`, the specified version must exist on the branch.""" - - branch: typing.Optional[core_models.FoundryBranch] = None - """ - The Foundry branch to execute the query from. If not specified, the default branch is used. - When provided without `version`, the latest version on this branch is used. - When provided with `version`, the specified version must exist on the branch. - """ class StructConstraint(core.ModelBase): @@ -444,13 +329,6 @@ class StructV1Constraint(core.ModelBase): type: typing.Literal["structV1"] = "structV1" -class SucceededExecution(core.ModelBase): - """The query execution completed successfully.""" - - value: DataValue - type: typing.Literal["succeeded"] = "succeeded" - - class ThreeDimensionalAggregation(core.ModelBase): """ThreeDimensionalAggregation""" @@ -471,13 +349,6 @@ class TwoDimensionalAggregation(core.ModelBase): type: typing.Literal["twoDimensionalAggregation"] = "twoDimensionalAggregation" -TypeReferenceIdentifier = str -""" -The unique identifier of a type reference. This identifier is used to look up the -type definition in the `typeReferences` map of the enclosing Query. -""" - - class UuidConstraint(core.ModelBase): """UuidConstraint""" @@ -710,8 +581,6 @@ class VersionId(core.ModelBase): constraints: typing.List[ValueTypeConstraint] -core.resolve_forward_references(ExecuteQueryAsyncResponse, globalns=globals(), localns=locals()) -core.resolve_forward_references(GetExecutionResultResponse, globalns=globals(), localns=locals()) core.resolve_forward_references(QueryAggregationKeyType, globalns=globals(), localns=locals()) core.resolve_forward_references(QueryAggregationRangeSubType, globalns=globals(), localns=locals()) core.resolve_forward_references(QueryAggregationValueType, globalns=globals(), localns=locals()) @@ -721,22 +590,13 @@ class VersionId(core.ModelBase): __all__ = [ "ArrayConstraint", - "CancelExecutionResponse", "DataValue", "EnumConstraint", - "ExecuteAsyncQueryRequest", - "ExecuteQueryAsyncResponse", "ExecuteQueryRequest", "ExecuteQueryResponse", - "ExecutionCompleted", - "ExecutionId", - "ExecutionSubmitted", "FunctionRid", "FunctionVersion", - "GetByRidQueriesBatchRequestElement", - "GetByRidQueriesBatchResponse", - "GetExecutionResultResponse", - "GetResultExecutionRequest", + "GetByRidQueriesRequest", "LengthConstraint", "MapConstraint", "NullableConstraint", @@ -755,22 +615,18 @@ class VersionId(core.ModelBase): "QuerySetType", "QueryStructField", "QueryStructType", - "QueryTypeReferenceType", "QueryUnionType", "RangesConstraint", "RegexConstraint", "RidConstraint", - "RunningExecution", "StreamingExecuteQueryRequest", "StructConstraint", "StructFieldApiName", "StructFieldName", "StructV1Constraint", - "SucceededExecution", "ThreeDimensionalAggregation", "TransactionId", "TwoDimensionalAggregation", - "TypeReferenceIdentifier", "UuidConstraint", "ValueType", "ValueTypeApiName", diff --git a/foundry_sdk/v2/functions/query.py b/foundry_sdk/v2/functions/query.py index 5a1aa7178..cb1cc1df5 100644 --- a/foundry_sdk/v2/functions/query.py +++ b/foundry_sdk/v2/functions/query.py @@ -15,7 +15,6 @@ import typing -import annotated_types import pydantic import typing_extensions @@ -67,7 +66,6 @@ def execute( functions_models.ParameterId, typing.Optional[functions_models.DataValue] ], attribution: typing.Optional[core_models.Attribution] = None, - branch: typing.Optional[core_models.FoundryBranch] = None, preview: typing.Optional[core_models.PreviewMode] = None, trace_parent: typing.Optional[core_models.TraceParent] = None, trace_state: typing.Optional[core_models.TraceState] = None, @@ -90,8 +88,6 @@ def execute( :type parameters: Dict[ParameterId, Optional[DataValue]] :param attribution: :type attribution: Optional[Attribution] - :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. - :type branch: Optional[FoundryBranch] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param trace_parent: @@ -100,7 +96,7 @@ def execute( :type trace_state: Optional[TraceState] :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[TransactionId] - :param version: The version of the query to execute. When used with `branch`, the specified version must exist on the branch. + :param version: :type version: Optional[FunctionVersion] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] @@ -131,7 +127,6 @@ def execute( body=functions_models.ExecuteQueryRequest( parameters=parameters, version=version, - branch=branch, ), response_type=functions_models.ExecuteQueryResponse, request_timeout=request_timeout, @@ -142,95 +137,6 @@ def execute( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def execute_async( - self, - query_api_name: functions_models.QueryApiName, - *, - parameters: typing.Dict[ - functions_models.ParameterId, typing.Optional[functions_models.DataValue] - ], - attribution: typing.Optional[core_models.Attribution] = None, - branch: typing.Optional[core_models.FoundryBranch] = None, - ontology: typing.Optional[ontologies_models.OntologyIdentifier] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, - transaction_id: typing.Optional[functions_models.TransactionId] = None, - version: typing.Optional[functions_models.FunctionVersion] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> functions_models.ExecuteQueryAsyncResponse: - """ - Submits a Query for asynchronous execution. Returns either an execution ID - for polling, or the complete result if execution finished immediately. - - Use the Execution resource's getResult endpoint to poll for the - result of a submitted execution. - - :param query_api_name: - :type query_api_name: QueryApiName - :param parameters: - :type parameters: Dict[ParameterId, Optional[DataValue]] - :param attribution: - :type attribution: Optional[Attribution] - :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. - :type branch: Optional[FoundryBranch] - :param ontology: Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function. - :type ontology: Optional[OntologyIdentifier] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param trace_parent: - :type trace_parent: Optional[TraceParent] - :param trace_state: - :type trace_state: Optional[TraceState] - :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. - :type transaction_id: Optional[TransactionId] - :param version: The version of the query to execute. When used with `branch`, the specified version must exist on the branch. - :type version: Optional[FunctionVersion] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: functions_models.ExecuteQueryAsyncResponse - - :raises ExecuteAsyncQueryPermissionDenied: Could not executeAsync the Query. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/functions/queries/{queryApiName}/executeAsync", - query_params={ - "preview": preview, - "transactionId": transaction_id, - }, - path_params={ - "queryApiName": query_api_name, - }, - header_params={ - "attribution": attribution, - "traceParent": trace_parent, - "traceState": trace_state, - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=functions_models.ExecuteAsyncQueryRequest( - ontology=ontology, - parameters=parameters, - version=version, - branch=branch, - ), - response_type=functions_models.ExecuteQueryAsyncResponse, - request_timeout=request_timeout, - throwable_errors={ - "ExecuteAsyncQueryPermissionDenied": functions_errors.ExecuteAsyncQueryPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -313,84 +219,35 @@ def get_by_rid( :return: Returns the result object. :rtype: functions_models.Query - :raises GetByRidPermissionDenied: Could not getByRid the Query. + :raises GetByRidQueriesPermissionDenied: Could not getByRid the Query. """ return self._api_client.call_api( core.RequestInfo( - method="GET", + method="POST", resource_path="/v2/functions/queries/getByRid", query_params={ - "rid": rid, - "includePrerelease": include_prerelease, "preview": preview, - "version": version, }, path_params={}, header_params={ + "Content-Type": "application/json", "Accept": "application/json", }, - body=None, + body=functions_models.GetByRidQueriesRequest( + rid=rid, + version=version, + include_prerelease=include_prerelease, + ), response_type=functions_models.Query, request_timeout=request_timeout, throwable_errors={ - "GetByRidPermissionDenied": functions_errors.GetByRidPermissionDenied, + "GetByRidQueriesPermissionDenied": functions_errors.GetByRidQueriesPermissionDenied, }, response_mode=_sdk_internal.get("response_mode"), ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get_by_rid_batch( - self, - body: typing_extensions.Annotated[ - typing.List[functions_models.GetByRidQueriesBatchRequestElement], - annotated_types.Len(min_length=1, max_length=100), - ], - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> functions_models.GetByRidQueriesBatchResponse: - """ - Gets a list of query types by RID in bulk. By default, this gets the latest version of each query. - - Queries are filtered from the response if they don't exist or the requesting token lacks the required - permissions. - - The maximum batch size for this endpoint is 100. - :param body: Body of the request - :type body: List[GetByRidQueriesBatchRequestElement] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: functions_models.GetByRidQueriesBatchResponse - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/functions/queries/getByRidBatch", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=body, - response_type=functions_models.GetByRidQueriesBatchResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -402,7 +259,6 @@ def streaming_execute( functions_models.ParameterId, typing.Optional[functions_models.DataValue] ], attribution: typing.Optional[core_models.Attribution] = None, - branch: typing.Optional[core_models.FoundryBranch] = None, ontology: typing.Optional[ontologies_models.OntologyIdentifier] = None, preview: typing.Optional[core_models.PreviewMode] = None, trace_parent: typing.Optional[core_models.TraceParent] = None, @@ -445,8 +301,6 @@ def streaming_execute( :type parameters: Dict[ParameterId, Optional[DataValue]] :param attribution: :type attribution: Optional[Attribution] - :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. - :type branch: Optional[FoundryBranch] :param ontology: Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function. :type ontology: Optional[OntologyIdentifier] :param preview: Enables the use of preview functionality. @@ -457,7 +311,7 @@ def streaming_execute( :type trace_state: Optional[TraceState] :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[TransactionId] - :param version: The version of the query to execute. When used with `branch`, the specified version must exist on the branch. + :param version: :type version: Optional[FunctionVersion] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] @@ -489,7 +343,6 @@ def streaming_execute( ontology=ontology, parameters=parameters, version=version, - branch=branch, ), response_type=bytes, request_timeout=request_timeout, @@ -504,36 +357,26 @@ def streaming_execute( class _QueryClientRaw: def __init__(self, client: QueryClient) -> None: def execute(_: functions_models.ExecuteQueryResponse): ... - def execute_async(_: functions_models.ExecuteQueryAsyncResponse): ... def get(_: functions_models.Query): ... def get_by_rid(_: functions_models.Query): ... - def get_by_rid_batch(_: functions_models.GetByRidQueriesBatchResponse): ... def streaming_execute(_: bytes): ... self.execute = core.with_raw_response(execute, client.execute) - self.execute_async = core.with_raw_response(execute_async, client.execute_async) self.get = core.with_raw_response(get, client.get) self.get_by_rid = core.with_raw_response(get_by_rid, client.get_by_rid) - self.get_by_rid_batch = core.with_raw_response(get_by_rid_batch, client.get_by_rid_batch) self.streaming_execute = core.with_raw_response(streaming_execute, client.streaming_execute) class _QueryClientStreaming: def __init__(self, client: QueryClient) -> None: def execute(_: functions_models.ExecuteQueryResponse): ... - def execute_async(_: functions_models.ExecuteQueryAsyncResponse): ... def get(_: functions_models.Query): ... def get_by_rid(_: functions_models.Query): ... - def get_by_rid_batch(_: functions_models.GetByRidQueriesBatchResponse): ... def streaming_execute(_: bytes): ... self.execute = core.with_streaming_response(execute, client.execute) - self.execute_async = core.with_streaming_response(execute_async, client.execute_async) self.get = core.with_streaming_response(get, client.get) self.get_by_rid = core.with_streaming_response(get_by_rid, client.get_by_rid) - self.get_by_rid_batch = core.with_streaming_response( - get_by_rid_batch, client.get_by_rid_batch - ) self.streaming_execute = core.with_streaming_response( streaming_execute, client.streaming_execute ) @@ -579,7 +422,6 @@ def execute( functions_models.ParameterId, typing.Optional[functions_models.DataValue] ], attribution: typing.Optional[core_models.Attribution] = None, - branch: typing.Optional[core_models.FoundryBranch] = None, preview: typing.Optional[core_models.PreviewMode] = None, trace_parent: typing.Optional[core_models.TraceParent] = None, trace_state: typing.Optional[core_models.TraceState] = None, @@ -602,8 +444,6 @@ def execute( :type parameters: Dict[ParameterId, Optional[DataValue]] :param attribution: :type attribution: Optional[Attribution] - :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. - :type branch: Optional[FoundryBranch] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param trace_parent: @@ -612,7 +452,7 @@ def execute( :type trace_state: Optional[TraceState] :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[TransactionId] - :param version: The version of the query to execute. When used with `branch`, the specified version must exist on the branch. + :param version: :type version: Optional[FunctionVersion] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] @@ -643,7 +483,6 @@ def execute( body=functions_models.ExecuteQueryRequest( parameters=parameters, version=version, - branch=branch, ), response_type=functions_models.ExecuteQueryResponse, request_timeout=request_timeout, @@ -654,95 +493,6 @@ def execute( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def execute_async( - self, - query_api_name: functions_models.QueryApiName, - *, - parameters: typing.Dict[ - functions_models.ParameterId, typing.Optional[functions_models.DataValue] - ], - attribution: typing.Optional[core_models.Attribution] = None, - branch: typing.Optional[core_models.FoundryBranch] = None, - ontology: typing.Optional[ontologies_models.OntologyIdentifier] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, - transaction_id: typing.Optional[functions_models.TransactionId] = None, - version: typing.Optional[functions_models.FunctionVersion] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[functions_models.ExecuteQueryAsyncResponse]: - """ - Submits a Query for asynchronous execution. Returns either an execution ID - for polling, or the complete result if execution finished immediately. - - Use the Execution resource's getResult endpoint to poll for the - result of a submitted execution. - - :param query_api_name: - :type query_api_name: QueryApiName - :param parameters: - :type parameters: Dict[ParameterId, Optional[DataValue]] - :param attribution: - :type attribution: Optional[Attribution] - :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. - :type branch: Optional[FoundryBranch] - :param ontology: Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function. - :type ontology: Optional[OntologyIdentifier] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param trace_parent: - :type trace_parent: Optional[TraceParent] - :param trace_state: - :type trace_state: Optional[TraceState] - :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. - :type transaction_id: Optional[TransactionId] - :param version: The version of the query to execute. When used with `branch`, the specified version must exist on the branch. - :type version: Optional[FunctionVersion] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[functions_models.ExecuteQueryAsyncResponse] - - :raises ExecuteAsyncQueryPermissionDenied: Could not executeAsync the Query. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/functions/queries/{queryApiName}/executeAsync", - query_params={ - "preview": preview, - "transactionId": transaction_id, - }, - path_params={ - "queryApiName": query_api_name, - }, - header_params={ - "attribution": attribution, - "traceParent": trace_parent, - "traceState": trace_state, - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=functions_models.ExecuteAsyncQueryRequest( - ontology=ontology, - parameters=parameters, - version=version, - branch=branch, - ), - response_type=functions_models.ExecuteQueryAsyncResponse, - request_timeout=request_timeout, - throwable_errors={ - "ExecuteAsyncQueryPermissionDenied": functions_errors.ExecuteAsyncQueryPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -825,80 +575,31 @@ def get_by_rid( :return: Returns the result object. :rtype: typing.Awaitable[functions_models.Query] - :raises GetByRidPermissionDenied: Could not getByRid the Query. + :raises GetByRidQueriesPermissionDenied: Could not getByRid the Query. """ return self._api_client.call_api( core.RequestInfo( - method="GET", + method="POST", resource_path="/v2/functions/queries/getByRid", query_params={ - "rid": rid, - "includePrerelease": include_prerelease, "preview": preview, - "version": version, }, path_params={}, header_params={ + "Content-Type": "application/json", "Accept": "application/json", }, - body=None, + body=functions_models.GetByRidQueriesRequest( + rid=rid, + version=version, + include_prerelease=include_prerelease, + ), response_type=functions_models.Query, request_timeout=request_timeout, throwable_errors={ - "GetByRidPermissionDenied": functions_errors.GetByRidPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get_by_rid_batch( - self, - body: typing_extensions.Annotated[ - typing.List[functions_models.GetByRidQueriesBatchRequestElement], - annotated_types.Len(min_length=1, max_length=100), - ], - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[functions_models.GetByRidQueriesBatchResponse]: - """ - Gets a list of query types by RID in bulk. By default, this gets the latest version of each query. - - Queries are filtered from the response if they don't exist or the requesting token lacks the required - permissions. - - The maximum batch size for this endpoint is 100. - :param body: Body of the request - :type body: List[GetByRidQueriesBatchRequestElement] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[functions_models.GetByRidQueriesBatchResponse] - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/functions/queries/getByRidBatch", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", + "GetByRidQueriesPermissionDenied": functions_errors.GetByRidQueriesPermissionDenied, }, - body=body, - response_type=functions_models.GetByRidQueriesBatchResponse, - request_timeout=request_timeout, - throwable_errors={}, response_mode=_sdk_internal.get("response_mode"), ), ) @@ -914,7 +615,6 @@ def streaming_execute( functions_models.ParameterId, typing.Optional[functions_models.DataValue] ], attribution: typing.Optional[core_models.Attribution] = None, - branch: typing.Optional[core_models.FoundryBranch] = None, ontology: typing.Optional[ontologies_models.OntologyIdentifier] = None, preview: typing.Optional[core_models.PreviewMode] = None, trace_parent: typing.Optional[core_models.TraceParent] = None, @@ -957,8 +657,6 @@ def streaming_execute( :type parameters: Dict[ParameterId, Optional[DataValue]] :param attribution: :type attribution: Optional[Attribution] - :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. - :type branch: Optional[FoundryBranch] :param ontology: Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function. :type ontology: Optional[OntologyIdentifier] :param preview: Enables the use of preview functionality. @@ -969,7 +667,7 @@ def streaming_execute( :type trace_state: Optional[TraceState] :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[TransactionId] - :param version: The version of the query to execute. When used with `branch`, the specified version must exist on the branch. + :param version: :type version: Optional[FunctionVersion] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] @@ -1001,7 +699,6 @@ def streaming_execute( ontology=ontology, parameters=parameters, version=version, - branch=branch, ), response_type=bytes, request_timeout=request_timeout, @@ -1016,19 +713,13 @@ def streaming_execute( class _AsyncQueryClientRaw: def __init__(self, client: AsyncQueryClient) -> None: def execute(_: functions_models.ExecuteQueryResponse): ... - def execute_async(_: functions_models.ExecuteQueryAsyncResponse): ... def get(_: functions_models.Query): ... def get_by_rid(_: functions_models.Query): ... - def get_by_rid_batch(_: functions_models.GetByRidQueriesBatchResponse): ... def streaming_execute(_: bytes): ... self.execute = core.async_with_raw_response(execute, client.execute) - self.execute_async = core.async_with_raw_response(execute_async, client.execute_async) self.get = core.async_with_raw_response(get, client.get) self.get_by_rid = core.async_with_raw_response(get_by_rid, client.get_by_rid) - self.get_by_rid_batch = core.async_with_raw_response( - get_by_rid_batch, client.get_by_rid_batch - ) self.streaming_execute = core.async_with_raw_response( streaming_execute, client.streaming_execute ) @@ -1037,19 +728,13 @@ def streaming_execute(_: bytes): ... class _AsyncQueryClientStreaming: def __init__(self, client: AsyncQueryClient) -> None: def execute(_: functions_models.ExecuteQueryResponse): ... - def execute_async(_: functions_models.ExecuteQueryAsyncResponse): ... def get(_: functions_models.Query): ... def get_by_rid(_: functions_models.Query): ... - def get_by_rid_batch(_: functions_models.GetByRidQueriesBatchResponse): ... def streaming_execute(_: bytes): ... self.execute = core.async_with_streaming_response(execute, client.execute) - self.execute_async = core.async_with_streaming_response(execute_async, client.execute_async) self.get = core.async_with_streaming_response(get, client.get) self.get_by_rid = core.async_with_streaming_response(get_by_rid, client.get_by_rid) - self.get_by_rid_batch = core.async_with_streaming_response( - get_by_rid_batch, client.get_by_rid_batch - ) self.streaming_execute = core.async_with_streaming_response( streaming_execute, client.streaming_execute ) diff --git a/foundry_sdk/v2/language_models/anthropic_model.py b/foundry_sdk/v2/language_models/anthropic_model.py index 1e7151037..40cbde4c4 100644 --- a/foundry_sdk/v2/language_models/anthropic_model.py +++ b/foundry_sdk/v2/language_models/anthropic_model.py @@ -64,7 +64,6 @@ def messages( max_tokens: int, messages: typing.List[language_models_models.AnthropicMessage], attribution: typing.Optional[core_models.Attribution] = None, - output_config: typing.Optional[language_models_models.AnthropicOutputConfig] = None, preview: typing.Optional[core_models.PreviewMode] = None, stop_sequences: typing.Optional[typing.List[str]] = None, system: typing.Optional[typing.List[language_models_models.AnthropicSystemMessage]] = None, @@ -87,8 +86,6 @@ def messages( :type messages: List[AnthropicMessage] :param attribution: :type attribution: Optional[Attribution] - :param output_config: Configuration to control the shape of the model's output - :type output_config: Optional[AnthropicOutputConfig] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param stop_sequences: Custom text sequences that will cause the model to stop generating. @@ -143,7 +140,6 @@ def messages( tools=tools, top_k=top_k, top_p=top_p, - output_config=output_config, ), response_type=language_models_models.AnthropicMessagesResponse, request_timeout=request_timeout, @@ -210,7 +206,6 @@ def messages( max_tokens: int, messages: typing.List[language_models_models.AnthropicMessage], attribution: typing.Optional[core_models.Attribution] = None, - output_config: typing.Optional[language_models_models.AnthropicOutputConfig] = None, preview: typing.Optional[core_models.PreviewMode] = None, stop_sequences: typing.Optional[typing.List[str]] = None, system: typing.Optional[typing.List[language_models_models.AnthropicSystemMessage]] = None, @@ -233,8 +228,6 @@ def messages( :type messages: List[AnthropicMessage] :param attribution: :type attribution: Optional[Attribution] - :param output_config: Configuration to control the shape of the model's output - :type output_config: Optional[AnthropicOutputConfig] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param stop_sequences: Custom text sequences that will cause the model to stop generating. @@ -289,7 +282,6 @@ def messages( tools=tools, top_k=top_k, top_p=top_p, - output_config=output_config, ), response_type=language_models_models.AnthropicMessagesResponse, request_timeout=request_timeout, diff --git a/foundry_sdk/v2/language_models/errors.py b/foundry_sdk/v2/language_models/errors.py index 58cc669cc..c5eeaac2e 100644 --- a/foundry_sdk/v2/language_models/errors.py +++ b/foundry_sdk/v2/language_models/errors.py @@ -18,7 +18,6 @@ import typing_extensions -from foundry_sdk import _core as core from foundry_sdk import _errors as errors from foundry_sdk.v2.language_models import models as language_models_models @@ -38,84 +37,6 @@ class AnthropicMessagesPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class InvalidRequestParameters(typing_extensions.TypedDict): - """ - The request was unable to be deserialized as a valid request to this endpoint. This may be either due to - missing a required field or including a field which is not supported. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - message: str - params: typing.Dict[str, str] - - -@dataclass -class InvalidRequest(errors.BadRequestError): - name: typing.Literal["InvalidRequest"] - parameters: InvalidRequestParameters - error_instance_id: str - - -class LanguageModelInferenceErrorParameters(typing_extensions.TypedDict): - """An error was thrown by the underlying model provider during inference.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - code: int - message: typing_extensions.NotRequired[str] - - -@dataclass -class LanguageModelInferenceError(errors.BadRequestError): - name: typing.Literal["LanguageModelInferenceError"] - parameters: LanguageModelInferenceErrorParameters - error_instance_id: str - - -class LanguageModelNotAvailableParameters(typing_extensions.TypedDict): - """The language model requested is not available in this environment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class LanguageModelNotAvailable(errors.BadRequestError): - name: typing.Literal["LanguageModelNotAvailable"] - parameters: LanguageModelNotAvailableParameters - error_instance_id: str - - -class LanguageModelNotFoundParameters(typing_extensions.TypedDict): - """No known language model exists with the specified ID.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - modelId: str - - -@dataclass -class LanguageModelNotFound(errors.NotFoundError): - name: typing.Literal["LanguageModelNotFound"] - parameters: LanguageModelNotFoundParameters - error_instance_id: str - - -class LanguageModelPermissionDeniedParameters(typing_extensions.TypedDict): - """The token provided does not have permission to use this language model.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - languageModelRid: core.RID - - -@dataclass -class LanguageModelPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["LanguageModelPermissionDenied"] - parameters: LanguageModelPermissionDeniedParameters - error_instance_id: str - - class MultipleSystemPromptsNotSupportedParameters(typing_extensions.TypedDict): """Multiple system prompts are not currently supported, but will be in the future.""" @@ -163,11 +84,6 @@ class OpenAiEmbeddingsPermissionDenied(errors.PermissionDeniedError): __all__ = [ "AnthropicMessagesPermissionDenied", - "InvalidRequest", - "LanguageModelInferenceError", - "LanguageModelNotAvailable", - "LanguageModelNotFound", - "LanguageModelPermissionDenied", "MultipleSystemPromptsNotSupported", "MultipleToolResultContentsNotSupported", "OpenAiEmbeddingsPermissionDenied", diff --git a/foundry_sdk/v2/language_models/models.py b/foundry_sdk/v2/language_models/models.py index 00c5d2c15..1db1dd200 100644 --- a/foundry_sdk/v2/language_models/models.py +++ b/foundry_sdk/v2/language_models/models.py @@ -145,16 +145,6 @@ class AnthropicDocumentCitations(core.ModelBase): """AnthropicDocumentSource""" -AnthropicEffort = typing.Literal["LOW", "MEDIUM", "HIGH", "MAX"] -""" -https://docs.anthropic.com/en/docs/build-with-claude/extended-thinking#effort - -Controls how many tokens Claude uses when responding. -Supported by Claude models beginning with Opus 4.5. -Setting effort to HIGH produces the same behavior as omitting the parameter entirely. -""" - - class AnthropicEnabledThinking(core.ModelBase): """AnthropicEnabledThinking""" @@ -188,13 +178,6 @@ class AnthropicImageBase64Source(core.ModelBase): type: typing.Literal["base64"] = "base64" -class AnthropicJsonSchemaOutputFormat(core.ModelBase): - """AnthropicJsonSchemaOutputFormat""" - - schema_: JsonSchema = pydantic.Field(alias=str("schema")) # type: ignore[literal-required] - type: typing.Literal["jsonSchema"] = "jsonSchema" - - AnthropicMediaType = typing.Literal["IMAGE_JPEG", "IMAGE_PNG", "IMAGE_GIF", "IMAGE_WEBP"] """AnthropicMediaType""" @@ -267,9 +250,6 @@ class AnthropicMessagesRequest(core.ModelBase): top_p: typing.Optional[float] = pydantic.Field(alias=str("topP"), default=None) # type: ignore[literal-required] """Use nucleus sampling. You should either alter temperature or top_p, but not both""" - output_config: typing.Optional[AnthropicOutputConfig] = pydantic.Field(alias=str("outputConfig"), default=None) # type: ignore[literal-required] - """Configuration to control the shape of the model's output""" - class AnthropicMessagesResponse(core.ModelBase): """AnthropicMessagesResponse""" @@ -289,13 +269,6 @@ class AnthropicNoneToolChoice(core.ModelBase): type: typing.Literal["none"] = "none" -class AnthropicOutputConfig(core.ModelBase): - """AnthropicOutputConfig""" - - format: typing.Optional[AnthropicOutputFormat] = None - effort: typing.Optional[AnthropicEffort] = None - - class AnthropicRedactedThinking(core.ModelBase): """AnthropicRedactedThinking""" @@ -450,10 +423,6 @@ class OpenAiEmbeddingsResponse(core.ModelBase): """AnthropicImageSource""" -AnthropicOutputFormat = AnthropicJsonSchemaOutputFormat -"""AnthropicOutputFormat""" - - AnthropicSystemMessage = AnthropicText """AnthropicSystemMessage""" @@ -492,13 +461,11 @@ class OpenAiEmbeddingsResponse(core.ModelBase): "AnthropicDocument", "AnthropicDocumentCitations", "AnthropicDocumentSource", - "AnthropicEffort", "AnthropicEnabledThinking", "AnthropicEphemeralCacheControl", "AnthropicImage", "AnthropicImageBase64Source", "AnthropicImageSource", - "AnthropicJsonSchemaOutputFormat", "AnthropicMediaType", "AnthropicMessage", "AnthropicMessageContent", @@ -506,8 +473,6 @@ class OpenAiEmbeddingsResponse(core.ModelBase): "AnthropicMessagesRequest", "AnthropicMessagesResponse", "AnthropicNoneToolChoice", - "AnthropicOutputConfig", - "AnthropicOutputFormat", "AnthropicRedactedThinking", "AnthropicSystemMessage", "AnthropicText", diff --git a/foundry_sdk/v2/media_sets/errors.py b/foundry_sdk/v2/media_sets/errors.py index c72816eee..c260d1edf 100644 --- a/foundry_sdk/v2/media_sets/errors.py +++ b/foundry_sdk/v2/media_sets/errors.py @@ -51,25 +51,6 @@ class GetMediaItemRidByPathPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class InvalidMediaItemRidParameters(typing_extensions.TypedDict): - """The provided media item RID is invalid.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - mediaItemRid: core_models.MediaItemRid - reason: str - invalidFieldName: typing_extensions.NotRequired[str] - expectedFieldValue: typing_extensions.NotRequired[str] - actualFieldValue: typing_extensions.NotRequired[str] - - -@dataclass -class InvalidMediaItemRid(errors.BadRequestError): - name: typing.Literal["InvalidMediaItemRid"] - parameters: InvalidMediaItemRidParameters - error_instance_id: str - - class InvalidMediaItemSchemaParameters(typing_extensions.TypedDict): """The media item does not match the schema of the media set.""" @@ -150,21 +131,6 @@ class MediaItemNotFound(errors.NotFoundError): error_instance_id: str -class MediaItemRidAlreadyExistsParameters(typing_extensions.TypedDict): - """A media item with the specified RID already exists.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - mediaItemRid: core_models.MediaItemRid - - -@dataclass -class MediaItemRidAlreadyExists(errors.ConflictError): - name: typing.Literal["MediaItemRidAlreadyExists"] - parameters: MediaItemRidAlreadyExistsParameters - error_instance_id: str - - class MediaItemXmlUnparsableParameters(typing_extensions.TypedDict): """The document cannot be parsed due to an unrecognized XML structure.""" @@ -328,29 +294,14 @@ class UnexpectedMetadataType(errors.InternalServerError): error_instance_id: str -class UnsupportedMetadataParameters(typing_extensions.TypedDict): - """A media item has an unsupported metadata type""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class UnsupportedMetadata(errors.InternalServerError): - name: typing.Literal["UnsupportedMetadata"] - parameters: UnsupportedMetadataParameters - error_instance_id: str - - __all__ = [ "ConflictingMediaSetIdentifiers", "GetMediaItemRidByPathPermissionDenied", - "InvalidMediaItemRid", "InvalidMediaItemSchema", "MediaItemHasUnsupportedSecuritySettings", "MediaItemImageUnparsable", "MediaItemIsPasswordProtected", "MediaItemNotFound", - "MediaItemRidAlreadyExists", "MediaItemXmlUnparsable", "MediaSetNotFound", "MediaSetOpenTransactionAlreadyExists", @@ -362,5 +313,4 @@ class UnsupportedMetadata(errors.InternalServerError): "TransformationUnavailable", "TransformedMediaItemNotFound", "UnexpectedMetadataType", - "UnsupportedMetadata", ] diff --git a/foundry_sdk/v2/media_sets/media_set.py b/foundry_sdk/v2/media_sets/media_set.py index e9c6df141..c2f47f2c4 100644 --- a/foundry_sdk/v2/media_sets/media_set.py +++ b/foundry_sdk/v2/media_sets/media_set.py @@ -153,76 +153,6 @@ def calculate( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def clear( - self, - media_set_rid: core_models.MediaSetRid, - *, - media_item_path: core_models.MediaItemPath, - branch_name: typing.Optional[media_sets_models.BranchName] = None, - branch_rid: typing.Optional[media_sets_models.BranchRid] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - transaction_id: typing.Optional[media_sets_models.TransactionId] = None, - view_rid: typing.Optional[core_models.MediaSetViewRid] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> None: - """ - Clears (soft-deletes) the media item at the specified path within a media set, making it and all older - media items at that path un-retrievable. - - A branch name, branch RID, or view RID may optionally be specified. If none is specified, - the item will be cleared from the default branch. If more than one is specified, an error is thrown. - - For transactional media sets, a transaction ID must be provided. The deletion will not be - visible until the transaction is committed. - - :param media_set_rid: The RID of the media set. - :type media_set_rid: MediaSetRid - :param media_item_path: The path of the media item to clear. - :type media_item_path: MediaItemPath - :param branch_name: Specifies the specific branch by name from which this media item will be cleared. May not be provided if branch rid or view rid are provided. - :type branch_name: Optional[BranchName] - :param branch_rid: Specifies the specific branch by rid from which this media item will be cleared. May not be provided if branch name or view rid are provided. - :type branch_rid: Optional[BranchRid] - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] - :param transaction_id: The ID of the transaction associated with this request. Required if this is a transactional media set. - :type transaction_id: Optional[TransactionId] - :param view_rid: Specifies the specific view by rid from which this media item will be cleared. May not be provided if branch name or branch rid are provided. - :type view_rid: Optional[MediaSetViewRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - """ - - return self._api_client.call_api( - core.RequestInfo( - method="DELETE", - resource_path="/v2/mediasets/{mediaSetRid}/items/clearAtPath", - query_params={ - "mediaItemPath": media_item_path, - "branchName": branch_name, - "branchRid": branch_rid, - "preview": preview, - "transactionId": transaction_id, - "viewRid": view_rid, - }, - path_params={ - "mediaSetRid": media_set_rid, - }, - header_params={}, - body=None, - response_type=None, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -319,51 +249,6 @@ def create( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - media_set_rid: core_models.MediaSetRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> media_sets_models.GetMediaSetResponse: - """ - Gets information about the media set. - - :param media_set_rid: - :type media_set_rid: MediaSetRid - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: media_sets_models.GetMediaSetResponse - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/mediasets/{mediaSetRid}", - query_params={ - "preview": preview, - }, - path_params={ - "mediaSetRid": media_set_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=media_sets_models.GetMediaSetResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -806,75 +691,6 @@ def reference( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def register( - self, - media_set_rid: core_models.MediaSetRid, - *, - physical_item_name: str, - branch_name: typing.Optional[media_sets_models.BranchName] = None, - media_item_path: typing.Optional[core_models.MediaItemPath] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - transaction_id: typing.Optional[media_sets_models.TransactionId] = None, - view_rid: typing.Optional[core_models.MediaSetViewRid] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> media_sets_models.RegisterMediaItemResponse: - """ - Registers a media item that currently resides in a federated media store. Registration will validate the item - against the media set's schema and perform initial metadata extraction. - This endpoint is only applicable for federated media sets. - - :param media_set_rid: - :type media_set_rid: MediaSetRid - :param physical_item_name: The relative path within the federated media store where the media item exists. - :type physical_item_name: str - :param branch_name: Specifies the specific branch by name to which this media item will be registered. - :type branch_name: Optional[BranchName] - :param media_item_path: - :type media_item_path: Optional[MediaItemPath] - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] - :param transaction_id: The id of the transaction associated with this request. Required for transactional media sets. - :type transaction_id: Optional[TransactionId] - :param view_rid: Specifies the specific view by rid to which this media item will be registered. - :type view_rid: Optional[MediaSetViewRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: media_sets_models.RegisterMediaItemResponse - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/mediasets/{mediaSetRid}/items/register", - query_params={ - "branchName": branch_name, - "preview": preview, - "transactionId": transaction_id, - "viewRid": view_rid, - }, - path_params={ - "mediaSetRid": media_set_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=media_sets_models.RegisterMediaItemRequest( - physical_item_name=physical_item_name, - media_item_path=media_item_path, - ), - response_type=media_sets_models.RegisterMediaItemResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -939,7 +755,6 @@ def transform( media_item_rid: core_models.MediaItemRid, *, transformation: media_sets_models.Transformation, - attribution: typing.Optional[core_models.Attribution] = None, preview: typing.Optional[core_models.PreviewMode] = None, token: typing.Optional[core_models.MediaItemReadToken] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -958,8 +773,6 @@ def transform( :type media_item_rid: MediaItemRid :param transformation: :type transformation: Transformation - :param attribution: Optional resource to attribute LLM calls on behalf of. - :type attribution: Optional[Attribution] :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. :type preview: Optional[PreviewMode] :param token: @@ -982,7 +795,6 @@ def transform( "mediaItemRid": media_item_rid, }, header_params={ - "Attribution": attribution, "Token": token, "Content-Type": "application/json", "Accept": "application/json", @@ -1008,7 +820,6 @@ def upload( branch_name: typing.Optional[media_sets_models.BranchName] = None, branch_rid: typing.Optional[media_sets_models.BranchRid] = None, media_item_path: typing.Optional[core_models.MediaItemPath] = None, - media_item_rid: typing.Optional[core_models.MediaItemRid] = None, preview: typing.Optional[core_models.PreviewMode] = None, transaction_id: typing.Optional[media_sets_models.TransactionId] = None, view_rid: typing.Optional[core_models.MediaSetViewRid] = None, @@ -1030,8 +841,6 @@ def upload( :type branch_rid: Optional[BranchRid] :param media_item_path: An identifier for a media item within a media set. Necessary if the backing media set requires paths. :type media_item_path: Optional[MediaItemPath] - :param media_item_rid: An optional RID to use for the media item to create. If omitted, the server will automatically generate a RID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your workflow strictly requires deterministic or client-controlled identifiers. The RID must be in the format of `ri.mio..media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. - :type media_item_rid: Optional[MediaItemRid] :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. :type preview: Optional[PreviewMode] :param transaction_id: The id of the transaction associated with this request. Required if this is a transactional media set. @@ -1052,7 +861,6 @@ def upload( "branchName": branch_name, "branchRid": branch_rid, "mediaItemPath": media_item_path, - "mediaItemRid": media_item_rid, "preview": preview, "transactionId": transaction_id, "viewRid": view_rid, @@ -1081,7 +889,6 @@ def upload_media( *, filename: core_models.MediaItemPath, attribution: typing.Optional[core_models.Attribution] = None, - media_item_rid: typing.Optional[core_models.MediaItemRid] = None, preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -1096,12 +903,10 @@ def upload_media( :param body: Body of the request :type body: bytes - :param filename: A user-defined label for a media item within a media set. Required if the backing media set requires paths. Uploading multiple files to the same path will result in only the most recent file being associated with the path. + :param filename: The path to write the media item to. Required if the backing media set requires paths. :type filename: MediaItemPath :param attribution: used for passing through usage attribution :type attribution: Optional[Attribution] - :param media_item_rid: An optional RID to use for the media item to create. If omitted, the server will automatically generate a RID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your workflow strictly requires deterministic or client-controlled identifiers. The RID must be in the format of `ri.mio..media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. - :type media_item_rid: Optional[MediaItemRid] :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. @@ -1116,7 +921,6 @@ def upload_media( resource_path="/v2/mediasets/media/upload", query_params={ "filename": filename, - "mediaItemRid": media_item_rid, "preview": preview, }, path_params={}, @@ -1138,10 +942,8 @@ class _MediaSetClientRaw: def __init__(self, client: MediaSetClient) -> None: def abort(_: None): ... def calculate(_: media_sets_models.TrackedTransformationResponse): ... - def clear(_: None): ... def commit(_: None): ... def create(_: media_sets_models.TransactionId): ... - def get(_: media_sets_models.GetMediaSetResponse): ... def get_result(_: bytes): ... def get_rid_by_path(_: media_sets_models.GetMediaItemRidByPathResponse): ... def get_status(_: media_sets_models.GetTransformationJobStatusResponse): ... @@ -1150,7 +952,6 @@ def metadata(_: media_sets_models.MediaItemMetadata): ... def read(_: bytes): ... def read_original(_: bytes): ... def reference(_: core_models.MediaReference): ... - def register(_: media_sets_models.RegisterMediaItemResponse): ... def retrieve(_: bytes): ... def transform(_: media_sets_models.TransformMediaItemResponse): ... def upload(_: media_sets_models.PutMediaItemResponse): ... @@ -1158,10 +959,8 @@ def upload_media(_: core_models.MediaReference): ... self.abort = core.with_raw_response(abort, client.abort) self.calculate = core.with_raw_response(calculate, client.calculate) - self.clear = core.with_raw_response(clear, client.clear) self.commit = core.with_raw_response(commit, client.commit) self.create = core.with_raw_response(create, client.create) - self.get = core.with_raw_response(get, client.get) self.get_result = core.with_raw_response(get_result, client.get_result) self.get_rid_by_path = core.with_raw_response(get_rid_by_path, client.get_rid_by_path) self.get_status = core.with_raw_response(get_status, client.get_status) @@ -1170,7 +969,6 @@ def upload_media(_: core_models.MediaReference): ... 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) - self.register = core.with_raw_response(register, client.register) self.retrieve = core.with_raw_response(retrieve, client.retrieve) self.transform = core.with_raw_response(transform, client.transform) self.upload = core.with_raw_response(upload, client.upload) @@ -1181,7 +979,6 @@ class _MediaSetClientStreaming: def __init__(self, client: MediaSetClient) -> None: def calculate(_: media_sets_models.TrackedTransformationResponse): ... def create(_: media_sets_models.TransactionId): ... - def get(_: media_sets_models.GetMediaSetResponse): ... def get_result(_: bytes): ... def get_rid_by_path(_: media_sets_models.GetMediaItemRidByPathResponse): ... def get_status(_: media_sets_models.GetTransformationJobStatusResponse): ... @@ -1190,7 +987,6 @@ def metadata(_: media_sets_models.MediaItemMetadata): ... def read(_: bytes): ... def read_original(_: bytes): ... def reference(_: core_models.MediaReference): ... - def register(_: media_sets_models.RegisterMediaItemResponse): ... def retrieve(_: bytes): ... def transform(_: media_sets_models.TransformMediaItemResponse): ... def upload(_: media_sets_models.PutMediaItemResponse): ... @@ -1198,7 +994,6 @@ def upload_media(_: core_models.MediaReference): ... self.calculate = core.with_streaming_response(calculate, client.calculate) self.create = core.with_streaming_response(create, client.create) - self.get = core.with_streaming_response(get, client.get) self.get_result = core.with_streaming_response(get_result, client.get_result) self.get_rid_by_path = core.with_streaming_response(get_rid_by_path, client.get_rid_by_path) self.get_status = core.with_streaming_response(get_status, client.get_status) @@ -1207,7 +1002,6 @@ def upload_media(_: core_models.MediaReference): ... 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) - self.register = core.with_streaming_response(register, client.register) self.retrieve = core.with_streaming_response(retrieve, client.retrieve) self.transform = core.with_streaming_response(transform, client.transform) self.upload = core.with_streaming_response(upload, client.upload) @@ -1343,76 +1137,6 @@ def calculate( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def clear( - self, - media_set_rid: core_models.MediaSetRid, - *, - media_item_path: core_models.MediaItemPath, - branch_name: typing.Optional[media_sets_models.BranchName] = None, - branch_rid: typing.Optional[media_sets_models.BranchRid] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - transaction_id: typing.Optional[media_sets_models.TransactionId] = None, - view_rid: typing.Optional[core_models.MediaSetViewRid] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[None]: - """ - Clears (soft-deletes) the media item at the specified path within a media set, making it and all older - media items at that path un-retrievable. - - A branch name, branch RID, or view RID may optionally be specified. If none is specified, - the item will be cleared from the default branch. If more than one is specified, an error is thrown. - - For transactional media sets, a transaction ID must be provided. The deletion will not be - visible until the transaction is committed. - - :param media_set_rid: The RID of the media set. - :type media_set_rid: MediaSetRid - :param media_item_path: The path of the media item to clear. - :type media_item_path: MediaItemPath - :param branch_name: Specifies the specific branch by name from which this media item will be cleared. May not be provided if branch rid or view rid are provided. - :type branch_name: Optional[BranchName] - :param branch_rid: Specifies the specific branch by rid from which this media item will be cleared. May not be provided if branch name or view rid are provided. - :type branch_rid: Optional[BranchRid] - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] - :param transaction_id: The ID of the transaction associated with this request. Required if this is a transactional media set. - :type transaction_id: Optional[TransactionId] - :param view_rid: Specifies the specific view by rid from which this media item will be cleared. May not be provided if branch name or branch rid are provided. - :type view_rid: Optional[MediaSetViewRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[None] - """ - - return self._api_client.call_api( - core.RequestInfo( - method="DELETE", - resource_path="/v2/mediasets/{mediaSetRid}/items/clearAtPath", - query_params={ - "mediaItemPath": media_item_path, - "branchName": branch_name, - "branchRid": branch_rid, - "preview": preview, - "transactionId": transaction_id, - "viewRid": view_rid, - }, - path_params={ - "mediaSetRid": media_set_rid, - }, - header_params={}, - body=None, - response_type=None, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -1509,51 +1233,6 @@ def create( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - media_set_rid: core_models.MediaSetRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[media_sets_models.GetMediaSetResponse]: - """ - Gets information about the media set. - - :param media_set_rid: - :type media_set_rid: MediaSetRid - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[media_sets_models.GetMediaSetResponse] - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/mediasets/{mediaSetRid}", - query_params={ - "preview": preview, - }, - path_params={ - "mediaSetRid": media_set_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=media_sets_models.GetMediaSetResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -1996,75 +1675,6 @@ def reference( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def register( - self, - media_set_rid: core_models.MediaSetRid, - *, - physical_item_name: str, - branch_name: typing.Optional[media_sets_models.BranchName] = None, - media_item_path: typing.Optional[core_models.MediaItemPath] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - transaction_id: typing.Optional[media_sets_models.TransactionId] = None, - view_rid: typing.Optional[core_models.MediaSetViewRid] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[media_sets_models.RegisterMediaItemResponse]: - """ - Registers a media item that currently resides in a federated media store. Registration will validate the item - against the media set's schema and perform initial metadata extraction. - This endpoint is only applicable for federated media sets. - - :param media_set_rid: - :type media_set_rid: MediaSetRid - :param physical_item_name: The relative path within the federated media store where the media item exists. - :type physical_item_name: str - :param branch_name: Specifies the specific branch by name to which this media item will be registered. - :type branch_name: Optional[BranchName] - :param media_item_path: - :type media_item_path: Optional[MediaItemPath] - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] - :param transaction_id: The id of the transaction associated with this request. Required for transactional media sets. - :type transaction_id: Optional[TransactionId] - :param view_rid: Specifies the specific view by rid to which this media item will be registered. - :type view_rid: Optional[MediaSetViewRid] - :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.RegisterMediaItemResponse] - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/mediasets/{mediaSetRid}/items/register", - query_params={ - "branchName": branch_name, - "preview": preview, - "transactionId": transaction_id, - "viewRid": view_rid, - }, - path_params={ - "mediaSetRid": media_set_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=media_sets_models.RegisterMediaItemRequest( - physical_item_name=physical_item_name, - media_item_path=media_item_path, - ), - response_type=media_sets_models.RegisterMediaItemResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -2129,7 +1739,6 @@ def transform( media_item_rid: core_models.MediaItemRid, *, transformation: media_sets_models.Transformation, - attribution: typing.Optional[core_models.Attribution] = None, preview: typing.Optional[core_models.PreviewMode] = None, token: typing.Optional[core_models.MediaItemReadToken] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -2148,8 +1757,6 @@ def transform( :type media_item_rid: MediaItemRid :param transformation: :type transformation: Transformation - :param attribution: Optional resource to attribute LLM calls on behalf of. - :type attribution: Optional[Attribution] :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. :type preview: Optional[PreviewMode] :param token: @@ -2172,7 +1779,6 @@ def transform( "mediaItemRid": media_item_rid, }, header_params={ - "Attribution": attribution, "Token": token, "Content-Type": "application/json", "Accept": "application/json", @@ -2198,7 +1804,6 @@ def upload( branch_name: typing.Optional[media_sets_models.BranchName] = None, branch_rid: typing.Optional[media_sets_models.BranchRid] = None, media_item_path: typing.Optional[core_models.MediaItemPath] = None, - media_item_rid: typing.Optional[core_models.MediaItemRid] = None, preview: typing.Optional[core_models.PreviewMode] = None, transaction_id: typing.Optional[media_sets_models.TransactionId] = None, view_rid: typing.Optional[core_models.MediaSetViewRid] = None, @@ -2220,8 +1825,6 @@ def upload( :type branch_rid: Optional[BranchRid] :param media_item_path: An identifier for a media item within a media set. Necessary if the backing media set requires paths. :type media_item_path: Optional[MediaItemPath] - :param media_item_rid: An optional RID to use for the media item to create. If omitted, the server will automatically generate a RID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your workflow strictly requires deterministic or client-controlled identifiers. The RID must be in the format of `ri.mio..media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. - :type media_item_rid: Optional[MediaItemRid] :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. :type preview: Optional[PreviewMode] :param transaction_id: The id of the transaction associated with this request. Required if this is a transactional media set. @@ -2242,7 +1845,6 @@ def upload( "branchName": branch_name, "branchRid": branch_rid, "mediaItemPath": media_item_path, - "mediaItemRid": media_item_rid, "preview": preview, "transactionId": transaction_id, "viewRid": view_rid, @@ -2271,7 +1873,6 @@ def upload_media( *, filename: core_models.MediaItemPath, attribution: typing.Optional[core_models.Attribution] = None, - media_item_rid: typing.Optional[core_models.MediaItemRid] = None, preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -2286,12 +1887,10 @@ def upload_media( :param body: Body of the request :type body: bytes - :param filename: A user-defined label for a media item within a media set. Required if the backing media set requires paths. Uploading multiple files to the same path will result in only the most recent file being associated with the path. + :param filename: The path to write the media item to. Required if the backing media set requires paths. :type filename: MediaItemPath :param attribution: used for passing through usage attribution :type attribution: Optional[Attribution] - :param media_item_rid: An optional RID to use for the media item to create. If omitted, the server will automatically generate a RID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your workflow strictly requires deterministic or client-controlled identifiers. The RID must be in the format of `ri.mio..media-item.`, where `` is the same as the instance part of the media set RID, and `` is a UUID. An `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format. A `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID. - :type media_item_rid: Optional[MediaItemRid] :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. @@ -2306,7 +1905,6 @@ def upload_media( resource_path="/v2/mediasets/media/upload", query_params={ "filename": filename, - "mediaItemRid": media_item_rid, "preview": preview, }, path_params={}, @@ -2328,10 +1926,8 @@ class _AsyncMediaSetClientRaw: def __init__(self, client: AsyncMediaSetClient) -> None: def abort(_: None): ... def calculate(_: media_sets_models.TrackedTransformationResponse): ... - def clear(_: None): ... def commit(_: None): ... def create(_: media_sets_models.TransactionId): ... - def get(_: media_sets_models.GetMediaSetResponse): ... def get_result(_: bytes): ... def get_rid_by_path(_: media_sets_models.GetMediaItemRidByPathResponse): ... def get_status(_: media_sets_models.GetTransformationJobStatusResponse): ... @@ -2340,7 +1936,6 @@ def metadata(_: media_sets_models.MediaItemMetadata): ... def read(_: bytes): ... def read_original(_: bytes): ... def reference(_: core_models.MediaReference): ... - def register(_: media_sets_models.RegisterMediaItemResponse): ... def retrieve(_: bytes): ... def transform(_: media_sets_models.TransformMediaItemResponse): ... def upload(_: media_sets_models.PutMediaItemResponse): ... @@ -2348,10 +1943,8 @@ def upload_media(_: core_models.MediaReference): ... self.abort = core.async_with_raw_response(abort, client.abort) self.calculate = core.async_with_raw_response(calculate, client.calculate) - self.clear = core.async_with_raw_response(clear, client.clear) self.commit = core.async_with_raw_response(commit, client.commit) self.create = core.async_with_raw_response(create, client.create) - self.get = core.async_with_raw_response(get, client.get) self.get_result = core.async_with_raw_response(get_result, client.get_result) self.get_rid_by_path = core.async_with_raw_response(get_rid_by_path, client.get_rid_by_path) self.get_status = core.async_with_raw_response(get_status, client.get_status) @@ -2360,7 +1953,6 @@ def upload_media(_: core_models.MediaReference): ... 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) - self.register = core.async_with_raw_response(register, client.register) self.retrieve = core.async_with_raw_response(retrieve, client.retrieve) self.transform = core.async_with_raw_response(transform, client.transform) self.upload = core.async_with_raw_response(upload, client.upload) @@ -2371,7 +1963,6 @@ class _AsyncMediaSetClientStreaming: def __init__(self, client: AsyncMediaSetClient) -> None: def calculate(_: media_sets_models.TrackedTransformationResponse): ... def create(_: media_sets_models.TransactionId): ... - def get(_: media_sets_models.GetMediaSetResponse): ... def get_result(_: bytes): ... def get_rid_by_path(_: media_sets_models.GetMediaItemRidByPathResponse): ... def get_status(_: media_sets_models.GetTransformationJobStatusResponse): ... @@ -2380,7 +1971,6 @@ def metadata(_: media_sets_models.MediaItemMetadata): ... def read(_: bytes): ... def read_original(_: bytes): ... def reference(_: core_models.MediaReference): ... - def register(_: media_sets_models.RegisterMediaItemResponse): ... def retrieve(_: bytes): ... def transform(_: media_sets_models.TransformMediaItemResponse): ... def upload(_: media_sets_models.PutMediaItemResponse): ... @@ -2388,7 +1978,6 @@ def upload_media(_: core_models.MediaReference): ... self.calculate = core.async_with_streaming_response(calculate, client.calculate) self.create = core.async_with_streaming_response(create, client.create) - self.get = core.async_with_streaming_response(get, client.get) self.get_result = core.async_with_streaming_response(get_result, client.get_result) self.get_rid_by_path = core.async_with_streaming_response( get_rid_by_path, client.get_rid_by_path @@ -2399,7 +1988,6 @@ def upload_media(_: core_models.MediaReference): ... 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) - self.register = core.async_with_streaming_response(register, client.register) self.retrieve = core.async_with_streaming_response(retrieve, client.retrieve) self.transform = core.async_with_streaming_response(transform, client.transform) self.upload = core.async_with_streaming_response(upload, client.upload) diff --git a/foundry_sdk/v2/media_sets/models.py b/foundry_sdk/v2/media_sets/models.py index cc1bc9ecb..d5fbb64f6 100644 --- a/foundry_sdk/v2/media_sets/models.py +++ b/foundry_sdk/v2/media_sets/models.py @@ -59,15 +59,6 @@ class Annotation(core.ModelBase): """The font size for the label text.""" -class ApiNameLocatorWrapper(core.ModelBase): - """Wrapper for API name-based model locator.""" - - api_name: str = pydantic.Field(alias=str("apiName")) # type: ignore[literal-required] - """The API name of the language model.""" - - type: typing.Literal["apiName"] = "apiName" - - class AudioChannelOperation(core.ModelBase): """Selects a specific channel from multi-channel audio.""" @@ -166,15 +157,6 @@ class BandInfo(core.ModelBase): unit_interpretation: typing.Optional[UnitInterpretation] = pydantic.Field(alias=str("unitInterpretation"), default=None) # type: ignore[literal-required] -class BatchTransactionsTransactionPolicy(core.ModelBase): - """ - All writes must be part of a transaction. Transactions are branch-scoped and created by calling - create transaction. Writes are not visible until commit transaction is called. - """ - - type: typing.Literal["batchTransactions"] = "batchTransactions" - - class BoundingBox(core.ModelBase): """A rectangular bounding box for annotations.""" @@ -209,27 +191,6 @@ class BoundingBoxGeometry(core.ModelBase): """A resource identifier that identifies a branch of a media set.""" -class ChatLlmSpec(core.ModelBase): - """Standard chat-based LLM specification with system and user prompts.""" - - model_locator: LanguageModelLocator = pydantic.Field(alias=str("modelLocator")) # type: ignore[literal-required] - system_prompt: str = pydantic.Field(alias=str("systemPrompt")) # type: ignore[literal-required] - """System prompt for the LLM.""" - - user_prompt: str = pydantic.Field(alias=str("userPrompt")) # type: ignore[literal-required] - """User prompt for the LLM.""" - - max_tokens: typing.Optional[int] = pydantic.Field(alias=str("maxTokens"), default=None) # type: ignore[literal-required] - """Maximum number of tokens per request to generate.""" - - -class ChatLlmSpecWrapper(core.ModelBase): - """Wrapper for chat-based LLM specification.""" - - chat: ChatLlmSpec - type: typing.Literal["chat"] = "chat" - - class Color(core.ModelBase): """An RGBA color value.""" @@ -370,13 +331,6 @@ class CreatePdfOperation(core.ModelBase): type: typing.Literal["createPdf"] = "createPdf" -class CropConfig(core.ModelBase): - """Configuration for table cropping.""" - - table_prompt: str = pydantic.Field(alias=str("tablePrompt")) # type: ignore[literal-required] - """Prompt for table extraction.""" - - class CropImageOperation(core.ModelBase): """Crops an image to a rectangular sub-window.""" @@ -492,7 +446,7 @@ class Dimensions(core.ModelBase): """The height of the image in pixels.""" -DocumentDecodeFormat = typing.Literal["PDF", "DOC", "DOCX", "TXT", "PPTX", "RTF"] +DocumentDecodeFormat = typing.Literal["PDF", "DOCX", "TXT", "PPTX"] """The format of a document media item.""" @@ -557,12 +511,9 @@ class DocumentToImageTransformation(core.ModelBase): "ExtractTableOfContentsOperation", "GetPdfPageDimensionsOperation", "ExtractAllTextOperation", - "ExtractVlmTextOperation", "ExtractTextFromPagesToArrayOperation", "OcrOnPageOperation", "ExtractFormFieldsOperation", - "ExtractDocumentLayoutAwareTextV2Operation", - "ExtractDocumentTextV2Operation", "ExtractUnstructuredTextFromPageOperation", "DocumentExtractLayoutAwareContentOperation", "OcrOnPagesOperation", @@ -672,46 +623,6 @@ class ExtractAudioOperation(core.ModelBase): type: typing.Literal["extractAudio"] = "extractAudio" -class ExtractDocumentLayoutAwareTextV2Config(core.ModelBase): - """Configuration for v2 layout-aware document text extraction.""" - - format: typing.Optional[TextOutputFormat] = None - mode: typing.Optional[OcrMode] = None - languages: typing.List[OcrLanguageOrScript] - """List of OCR languages or scripts to use.""" - - -class ExtractDocumentLayoutAwareTextV2Operation(core.ModelBase): - """ - Extract layout aware text with bounding boxes across all pages using the v2 text extraction endpoint. - This only supports PDFs. - """ - - page_range: typing.Optional[PageRange] = pydantic.Field(alias=str("pageRange"), default=None) # type: ignore[literal-required] - config: ExtractDocumentLayoutAwareTextV2Config - type: typing.Literal["extractLayoutAwareTextV2"] = "extractLayoutAwareTextV2" - - -class ExtractDocumentTextV2Config(core.ModelBase): - """Configuration for v2 document text extraction.""" - - format: typing.Optional[TextOutputFormat] = None - mode: typing.Optional[OcrMode] = None - languages: typing.List[OcrLanguageOrScript] - """List of OCR languages or scripts to use.""" - - -class ExtractDocumentTextV2Operation(core.ModelBase): - """ - Extract text across all pages using the v2 text extraction endpoint with per page text. - This only supports PDFs. - """ - - page_range: typing.Optional[PageRange] = pydantic.Field(alias=str("pageRange"), default=None) # type: ignore[literal-required] - config: ExtractDocumentTextV2Config - type: typing.Literal["extractTextV2"] = "extractTextV2" - - class ExtractFirstFrameOperation(core.ModelBase): """ Extracts the first full scene frame from the video. @@ -778,13 +689,6 @@ class ExtractTextFromPagesToArrayOperation(core.ModelBase): type: typing.Literal["extractTextFromPagesToArray"] = "extractTextFromPagesToArray" -class ExtractTextPreprocessingWrapper(core.ModelBase): - """Wrapper for text extraction preprocessing.""" - - extract_text: ExtractDocumentTextV2Config = pydantic.Field(alias=str("extractText")) # type: ignore[literal-required] - type: typing.Literal["extractText"] = "extractText" - - class ExtractUnstructuredTextFromPageOperation(core.ModelBase): """Extracts unstructured text from a specified page.""" @@ -794,20 +698,6 @@ class ExtractUnstructuredTextFromPageOperation(core.ModelBase): type: typing.Literal["extractUnstructuredTextFromPage"] = "extractUnstructuredTextFromPage" -class ExtractVlmTextOperation(core.ModelBase): - """ - Extract text from a document using vision language models (VLMs). - VLMs can understand document layout and structure more intelligently than traditional OCR. - """ - - llm_spec: LlmSpec = pydantic.Field(alias=str("llmSpec")) # type: ignore[literal-required] - preprocessing_configuration: typing.Optional[VlmPreprocessingConfig] = pydantic.Field(alias=str("preprocessingConfiguration"), default=None) # type: ignore[literal-required] - image_spec: typing.Optional[ImageSpec] = pydantic.Field(alias=str("imageSpec"), default=None) # type: ignore[literal-required] - output_format: TextOutputFormat = pydantic.Field(alias=str("outputFormat")) # type: ignore[literal-required] - page_range: typing.Optional[PageRange] = pydantic.Field(alias=str("pageRange"), default=None) # type: ignore[literal-required] - type: typing.Literal["extractVlmText"] = "extractVlmText" - - FlipAxis = typing.Literal["HORIZONTAL", "VERTICAL", "UNKNOWN"] """The flip axis from EXIF orientation.""" @@ -860,10 +750,6 @@ class GetMediaItemInfoResponse(core.ModelBase): path: typing.Optional[core_models.MediaItemPath] = None logical_timestamp: LogicalTimestamp = pydantic.Field(alias=str("logicalTimestamp")) # type: ignore[literal-required] attribution: typing.Optional[MediaAttribution] = None - originally_uploaded_file_mime_type: typing.Optional[core_models.MediaType] = pydantic.Field(alias=str("originallyUploadedFileMimeType"), default=None) # type: ignore[literal-required] - mime_type: typing.Optional[core_models.MediaType] = pydantic.Field(alias=str("mimeType"), default=None) # type: ignore[literal-required] - size_bytes: typing.Optional[int] = pydantic.Field(alias=str("sizeBytes"), default=None) # type: ignore[literal-required] - """The size of the media item in bytes.""" class GetMediaItemRidByPathResponse(core.ModelBase): @@ -872,17 +758,6 @@ class GetMediaItemRidByPathResponse(core.ModelBase): media_item_rid: typing.Optional[core_models.MediaItemRid] = pydantic.Field(alias=str("mediaItemRid"), default=None) # type: ignore[literal-required] -class GetMediaSetResponse(core.ModelBase): - """Information about a media set.""" - - rid: core_models.MediaSetRid - media_schema: MediaSchema = pydantic.Field(alias=str("mediaSchema")) # type: ignore[literal-required] - default_branch_name: BranchName = pydantic.Field(alias=str("defaultBranchName")) # type: ignore[literal-required] - transaction_policy: TransactionPolicy = pydantic.Field(alias=str("transactionPolicy")) # type: ignore[literal-required] - paths_required: bool = pydantic.Field(alias=str("pathsRequired")) # type: ignore[literal-required] - """Whether media items in this media set require paths.""" - - class GetPdfPageDimensionsOperation(core.ModelBase): """Returns the dimensions of each page in a PDF document as JSON (in points).""" @@ -1011,22 +886,6 @@ class ImagePixelCoordinate(core.ModelBase): """ -class ImageSpec(core.ModelBase): - """ - Specification for image processing parameters used in vision-based extraction. - Controls how document pages are converted to images before being sent to vision models. - """ - - resizing_mode: ResizingMode = pydantic.Field(alias=str("resizingMode")) # type: ignore[literal-required] - height: typing.Optional[int] = None - """Target height in pixels.""" - - width: typing.Optional[int] = None - """Target width in pixels.""" - - mime_type: ImageryDecodeFormat = pydantic.Field(alias=str("mimeType")) # type: ignore[literal-required] - - class ImageToDocumentTransformation(core.ModelBase): """Converts images to documents.""" @@ -1123,20 +982,6 @@ class LayoutAwareExtractionParameters(core.ModelBase): """The languages to use for extraction.""" -class LayoutAwareExtractionPreprocessingConfig(core.ModelBase): - """Configuration for layout-aware extraction preprocessing.""" - - transformation_config: ExtractDocumentLayoutAwareTextV2Config = pydantic.Field(alias=str("transformationConfig")) # type: ignore[literal-required] - crop_config: typing.Optional[CropConfig] = pydantic.Field(alias=str("cropConfig"), default=None) # type: ignore[literal-required] - - -class LayoutAwarePreprocessingWrapper(core.ModelBase): - """Wrapper for layout-aware preprocessing.""" - - layout_aware: LayoutAwareExtractionPreprocessingConfig = pydantic.Field(alias=str("layoutAware")) # type: ignore[literal-required] - type: typing.Literal["layoutAware"] = "layoutAware" - - LogicalTimestamp = core.Long """ A number representing a logical ordering to be used for transactions, etc. @@ -1185,7 +1030,6 @@ class MediaAttribution(core.ModelBase): "SpreadsheetMediaItemMetadata", "UntypedMediaItemMetadata", "AudioMediaItemMetadata", - "Model3dMediaItemMetadata", "VideoMediaItemMetadata", "DicomMediaItemMetadata", "EmailMediaItemMetadata", @@ -1202,21 +1046,6 @@ class MediaAttribution(core.ModelBase): """Format of the media item attempted to be decoded based on the XML structure.""" -MediaSchema = typing.Literal[ - "AUDIO", - "DICOM", - "DOCUMENT", - "IMAGERY", - "MODEL_3D", - "MULTIMODAL", - "SPREADSHEET", - "STREAMING_VIDEO", - "VIDEO", - "EMAIL", -] -"""The schema type of a media set, indicating what type of media items it can contain.""" - - class MkvVideoContainerFormat(core.ModelBase): """MKV (Matroska) video container format.""" @@ -1319,25 +1148,6 @@ class MkvVideoContainerFormat(core.ModelBase): """ -Model3dDecodeFormat = typing.Literal["LAS", "PLY", "OBJ"] -"""The format of a 3D model media item.""" - - -class Model3dMediaItemMetadata(core.ModelBase): - """Metadata for 3D model media items.""" - - format: Model3dDecodeFormat - model_type: Model3dType = pydantic.Field(alias=str("modelType")) # type: ignore[literal-required] - size_bytes: int = pydantic.Field(alias=str("sizeBytes")) # type: ignore[literal-required] - """The size of the media item in bytes.""" - - type: typing.Literal["model3d"] = "model3d" - - -Model3dType = typing.Literal["POINT_CLOUD", "MESH"] -"""The type of 3D model representation.""" - - class MovVideoContainerFormat(core.ModelBase): """MOV (QuickTime) video container format.""" @@ -1356,15 +1166,6 @@ class Mp4VideoContainerFormat(core.ModelBase): type: typing.Literal["mp4"] = "mp4" -class NoTransactionsTransactionPolicy(core.ModelBase): - """ - Writes are not part of a transaction and are immediately visible. - Calls to create transaction or commit transaction will error. - """ - - type: typing.Literal["noTransactions"] = "noTransactions" - - class NumberOfChannels(core.ModelBase): """Specifies the number of audio channels. Defaults to 2 (stereo).""" @@ -1521,10 +1322,6 @@ class OcrLanguageWrapper(core.ModelBase): type: typing.Literal["language"] = "language" -OcrMode = typing.Literal["AUTO", "ELECTRONIC", "SCAN"] -"""OCR mode for document extraction.""" - - class OcrOnPageOperation(core.ModelBase): """Performs OCR (Optical Character Recognition) on a specific page of a document.""" @@ -1621,16 +1418,6 @@ class Orientation(core.ModelBase): flip_axis: typing.Optional[FlipAxis] = pydantic.Field(alias=str("flipAxis"), default=None) # type: ignore[literal-required] -class PageRange(core.ModelBase): - """Page range for document extraction.""" - - start_page_inclusive: typing.Optional[int] = pydantic.Field(alias=str("startPageInclusive"), default=None) # type: ignore[literal-required] - """Start page index (0-based, inclusive). If not provided, defaults to start of document.""" - - end_page_exclusive: typing.Optional[int] = pydantic.Field(alias=str("endPageExclusive"), default=None) # type: ignore[literal-required] - """End page index (0-based, exclusive). If not provided, defaults to end of document.""" - - PaletteInterpretation = typing.Literal["GRAY", "RGB", "RGBA", "CMYK", "HLS"] """The palette interpretation of a band.""" @@ -1670,23 +1457,6 @@ class PutMediaItemResponse(core.ModelBase): """PutMediaItemResponse""" media_item_rid: core_models.MediaItemRid = pydantic.Field(alias=str("mediaItemRid")) # type: ignore[literal-required] - media_set_view_rid: core_models.MediaSetViewRid = pydantic.Field(alias=str("mediaSetViewRid")) # type: ignore[literal-required] - - -class RegisterMediaItemRequest(core.ModelBase): - """Request to register a media item from a federated store.""" - - physical_item_name: str = pydantic.Field(alias=str("physicalItemName")) # type: ignore[literal-required] - """The relative path within the federated media store where the media item exists.""" - - media_item_path: typing.Optional[core_models.MediaItemPath] = pydantic.Field(alias=str("mediaItemPath"), default=None) # type: ignore[literal-required] - - -class RegisterMediaItemResponse(core.ModelBase): - """Response after successfully registering a media item.""" - - media_item_rid: core_models.MediaItemRid = pydantic.Field(alias=str("mediaItemRid")) # type: ignore[literal-required] - media_type: core_models.MediaType = pydantic.Field(alias=str("mediaType")) # type: ignore[literal-required] class RenderImageLayerOperation(core.ModelBase): @@ -1770,10 +1540,6 @@ class ResizeToFitBoundingBoxOperation(core.ModelBase): type: typing.Literal["resizeToFitBoundingBox"] = "resizeToFitBoundingBox" -ResizingMode = typing.Literal["RESIZING", "FIT_INTO_BOUNDING_BOX"] -"""Image resizing strategy.""" - - class RotateImageOperation(core.ModelBase): """Rotates an image clockwise by the specified angle.""" @@ -1843,10 +1609,6 @@ class TarFormat(core.ModelBase): type: typing.Literal["tar"] = "tar" -TextOutputFormat = typing.Literal["TEXT", "MARKDOWN", "HTML"] -"""Format in which to return extracted text.""" - - class TiffFormat(core.ModelBase): """TIFF image format.""" @@ -1904,13 +1666,6 @@ class TrackedTransformationSuccessfulResponse(core.ModelBase): """An identifier which represents a transaction on a media set.""" -TransactionPolicy = typing_extensions.Annotated[ - typing.Union["BatchTransactionsTransactionPolicy", "NoTransactionsTransactionPolicy"], - pydantic.Field(discriminator="type"), -] -"""The transaction policy for a media set, determining how writes are handled.""" - - class TranscodeOperation(core.ModelBase): """Encodes video to the specified format.""" @@ -2348,13 +2103,6 @@ class VideoTransformation(core.ModelBase): type: typing.Literal["video"] = "video" -VlmPreprocessingConfig = typing_extensions.Annotated[ - typing.Union["LayoutAwarePreprocessingWrapper", "ExtractTextPreprocessingWrapper"], - pydantic.Field(discriminator="type"), -] -"""Preprocessing configuration for VLM extraction.""" - - class WavEncodeFormat(core.ModelBase): """WAV audio format with optional sample rate and channel layout.""" @@ -2423,14 +2171,6 @@ class WebpFormat(core.ModelBase): """The operation to perform for image to embedding conversion.""" -LanguageModelLocator = ApiNameLocatorWrapper -"""Locator for identifying a language model.""" - - -LlmSpec = ChatLlmSpecWrapper -"""Specification for language model requests.""" - - SpreadsheetToTextOperation = ConvertSheetToJsonOperation """The operation to perform for spreadsheet to text conversion.""" @@ -2463,20 +2203,17 @@ class WebpFormat(core.ModelBase): core.resolve_forward_references(OcrLanguageOrScript, globalns=globals(), localns=locals()) core.resolve_forward_references(OcrOutputFormat, globalns=globals(), localns=locals()) core.resolve_forward_references(TrackedTransformationResponse, globalns=globals(), localns=locals()) -core.resolve_forward_references(TransactionPolicy, globalns=globals(), localns=locals()) core.resolve_forward_references(TranscribeTextEncodeFormat, globalns=globals(), localns=locals()) core.resolve_forward_references(Transformation, globalns=globals(), localns=locals()) core.resolve_forward_references(VideoEncodeFormat, globalns=globals(), localns=locals()) core.resolve_forward_references(VideoOperation, globalns=globals(), localns=locals()) core.resolve_forward_references(VideoToImageOperation, globalns=globals(), localns=locals()) -core.resolve_forward_references(VlmPreprocessingConfig, globalns=globals(), localns=locals()) __all__ = [ "AffineTransform", "AnnotateGeometry", "AnnotateImageOperation", "Annotation", - "ApiNameLocatorWrapper", "ArchiveEncodeFormat", "AudioChannelLayout", "AudioChannelOperation", @@ -2491,13 +2228,10 @@ class WebpFormat(core.ModelBase): "AudioTransformation", "AvailableEmbeddingModelIds", "BandInfo", - "BatchTransactionsTransactionPolicy", "BoundingBox", "BoundingBoxGeometry", "BranchName", "BranchRid", - "ChatLlmSpec", - "ChatLlmSpecWrapper", "Color", "ColorInterpretation", "CommonDicomDataElements", @@ -2511,7 +2245,6 @@ class WebpFormat(core.ModelBase): "ConvertSheetToJsonOperation", "CoordinateReferenceSystem", "CreatePdfOperation", - "CropConfig", "CropImageOperation", "DataType", "DecryptImageOperation", @@ -2544,19 +2277,13 @@ class WebpFormat(core.ModelBase): "EncryptImageOperation", "ExtractAllTextOperation", "ExtractAudioOperation", - "ExtractDocumentLayoutAwareTextV2Config", - "ExtractDocumentLayoutAwareTextV2Operation", - "ExtractDocumentTextV2Config", - "ExtractDocumentTextV2Operation", "ExtractFirstFrameOperation", "ExtractFormFieldsOperation", "ExtractFramesAtTimestampsOperation", "ExtractSceneFramesOperation", "ExtractTableOfContentsOperation", "ExtractTextFromPagesToArrayOperation", - "ExtractTextPreprocessingWrapper", "ExtractUnstructuredTextFromPageOperation", - "ExtractVlmTextOperation", "FlipAxis", "GcpList", "GenerateEmbeddingOperation", @@ -2565,7 +2292,6 @@ class WebpFormat(core.ModelBase): "GetEmailBodyOperation", "GetMediaItemInfoResponse", "GetMediaItemRidByPathResponse", - "GetMediaSetResponse", "GetPdfPageDimensionsOperation", "GetTimestampsForSceneFramesOperation", "GetTransformationJobStatusResponse", @@ -2581,7 +2307,6 @@ class WebpFormat(core.ModelBase): "ImageOperation", "ImagePixelCoordinate", "ImageRegionPolygon", - "ImageSpec", "ImageToDocumentOperation", "ImageToDocumentTransformation", "ImageToEmbeddingOperation", @@ -2593,11 +2318,7 @@ class WebpFormat(core.ModelBase): "ImageryEncodeFormat", "ImageryMediaItemMetadata", "JpgFormat", - "LanguageModelLocator", "LayoutAwareExtractionParameters", - "LayoutAwareExtractionPreprocessingConfig", - "LayoutAwarePreprocessingWrapper", - "LlmSpec", "LogicalTimestamp", "Mailbox", "MailboxOrGroup", @@ -2605,22 +2326,16 @@ class WebpFormat(core.ModelBase): "MediaAttribution", "MediaItemMetadata", "MediaItemXmlFormat", - "MediaSchema", "MkvVideoContainerFormat", "Modality", - "Model3dDecodeFormat", - "Model3dMediaItemMetadata", - "Model3dType", "MovVideoContainerFormat", "Mp3Format", "Mp4VideoContainerFormat", - "NoTransactionsTransactionPolicy", "NumberOfChannels", "OcrHocrOutputFormat", "OcrLanguage", "OcrLanguageOrScript", "OcrLanguageWrapper", - "OcrMode", "OcrOnPageOperation", "OcrOnPagesOperation", "OcrOutputFormat", @@ -2629,7 +2344,6 @@ class WebpFormat(core.ModelBase): "OcrScriptWrapper", "OcrTextOutputFormat", "Orientation", - "PageRange", "PaletteInterpretation", "PdfFormat", "PerformanceMode", @@ -2637,14 +2351,11 @@ class WebpFormat(core.ModelBase): "PngFormat", "Pttml", "PutMediaItemResponse", - "RegisterMediaItemRequest", - "RegisterMediaItemResponse", "RenderImageLayerOperation", "RenderPageOperation", "RenderPageToFitBoundingBoxOperation", "ResizeImageOperation", "ResizeToFitBoundingBoxOperation", - "ResizingMode", "RotateImageOperation", "RotationAngle", "SceneScore", @@ -2654,7 +2365,6 @@ class WebpFormat(core.ModelBase): "SpreadsheetToTextOperation", "SpreadsheetToTextTransformation", "TarFormat", - "TextOutputFormat", "TiffFormat", "TileImageOperation", "TrackedTransformationFailedResponse", @@ -2662,7 +2372,6 @@ class WebpFormat(core.ModelBase): "TrackedTransformationResponse", "TrackedTransformationSuccessfulResponse", "TransactionId", - "TransactionPolicy", "TranscodeOperation", "TranscribeJson", "TranscribeOperation", @@ -2692,7 +2401,6 @@ class WebpFormat(core.ModelBase): "VideoToTextOperation", "VideoToTextTransformation", "VideoTransformation", - "VlmPreprocessingConfig", "WavEncodeFormat", "WaveformOperation", "WebpFormat", diff --git a/foundry_sdk/v2/models/_client.py b/foundry_sdk/v2/models/_client.py index 5c0d779c1..9fc6550b6 100644 --- a/foundry_sdk/v2/models/_client.py +++ b/foundry_sdk/v2/models/_client.py @@ -43,16 +43,6 @@ def __init__( self._config = config - @cached_property - def LiveDeployment(self): - from foundry_sdk.v2.models.live_deployment import LiveDeploymentClient - - return LiveDeploymentClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - @cached_property def Model(self): from foundry_sdk.v2.models.model import ModelClient @@ -63,26 +53,6 @@ def Model(self): config=self._config, ) - @cached_property - def ModelStudio(self): - from foundry_sdk.v2.models.model_studio import ModelStudioClient - - return ModelStudioClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - - @cached_property - def ModelStudioTrainer(self): - from foundry_sdk.v2.models.model_studio_trainer import ModelStudioTrainerClient - - return ModelStudioTrainerClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - class AsyncModelsClient: """ @@ -99,17 +69,6 @@ def __init__( hostname: typing.Union[str, core.HostnameSupplier], config: typing.Optional[core.Config] = None, ): - from foundry_sdk.v2.models.live_deployment import AsyncLiveDeploymentClient from foundry_sdk.v2.models.model import AsyncModelClient - from foundry_sdk.v2.models.model_studio import AsyncModelStudioClient - from foundry_sdk.v2.models.model_studio_trainer import AsyncModelStudioTrainerClient # NOQA - - self.LiveDeployment = AsyncLiveDeploymentClient(auth=auth, hostname=hostname, config=config) self.Model = AsyncModelClient(auth=auth, hostname=hostname, config=config) - - self.ModelStudio = AsyncModelStudioClient(auth=auth, hostname=hostname, config=config) - - self.ModelStudioTrainer = AsyncModelStudioTrainerClient( - auth=auth, hostname=hostname, config=config - ) diff --git a/foundry_sdk/v2/models/errors.py b/foundry_sdk/v2/models/errors.py index 80bb563c8..788dc1e22 100644 --- a/foundry_sdk/v2/models/errors.py +++ b/foundry_sdk/v2/models/errors.py @@ -18,7 +18,6 @@ import typing_extensions -from foundry_sdk import _core as core from foundry_sdk import _errors as errors from foundry_sdk.v2.models import models as models_models @@ -39,50 +38,6 @@ class CondaSolveFailureForProvidedPackages(errors.BadRequestError): error_instance_id: str -class CreateConfigValidationErrorParameters(typing_extensions.TypedDict): - """The provided configuration is invalid.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - studioRid: models_models.ModelStudioRid - validationFailures: typing.List[models_models.CreateConfigValidationFailureReason] - - -@dataclass -class CreateConfigValidationError(errors.BadRequestError): - name: typing.Literal["CreateConfigValidationError"] - parameters: CreateConfigValidationErrorParameters - error_instance_id: str - - -class CreateLiveDeploymentPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not create the LiveDeployment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class CreateLiveDeploymentPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["CreateLiveDeploymentPermissionDenied"] - parameters: CreateLiveDeploymentPermissionDeniedParameters - error_instance_id: str - - -class CreateModelFunctionPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not create the ModelFunction.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - liveDeploymentRid: models_models.LiveDeploymentRid - - -@dataclass -class CreateModelFunctionPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["CreateModelFunctionPermissionDenied"] - parameters: CreateModelFunctionPermissionDeniedParameters - error_instance_id: str - - class CreateModelPermissionDeniedParameters(typing_extensions.TypedDict): """Could not create the Model.""" @@ -96,34 +51,6 @@ class CreateModelPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class CreateModelStudioConfigVersionPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not create the ModelStudioConfigVersion.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - modelStudioRid: models_models.ModelStudioRid - - -@dataclass -class CreateModelStudioConfigVersionPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["CreateModelStudioConfigVersionPermissionDenied"] - parameters: CreateModelStudioConfigVersionPermissionDeniedParameters - error_instance_id: str - - -class CreateModelStudioPermissionDeniedParameters(typing_extensions.TypedDict): - """Permission denied to create a Model Studio.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class CreateModelStudioPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["CreateModelStudioPermissionDenied"] - parameters: CreateModelStudioPermissionDeniedParameters - error_instance_id: str - - class CreateModelVersionPermissionDeniedParameters(typing_extensions.TypedDict): """Could not create the ModelVersion.""" @@ -139,206 +66,6 @@ class CreateModelVersionPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class ExperimentArtifactNotFoundParameters(typing_extensions.TypedDict): - """The requested artifact was not found in the experiment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - modelRid: core.RID - experimentRid: core.RID - artifactName: str - - -@dataclass -class ExperimentArtifactNotFound(errors.NotFoundError): - name: typing.Literal["ExperimentArtifactNotFound"] - parameters: ExperimentArtifactNotFoundParameters - error_instance_id: str - - -class ExperimentNotFoundParameters(typing_extensions.TypedDict): - """The given Experiment could not be found.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - experimentRid: models_models.ExperimentRid - modelRid: models_models.ModelRid - - -@dataclass -class ExperimentNotFound(errors.NotFoundError): - name: typing.Literal["ExperimentNotFound"] - parameters: ExperimentNotFoundParameters - error_instance_id: str - - -class ExperimentSeriesNotFoundParameters(typing_extensions.TypedDict): - """The requested series was not found in the experiment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - modelRid: core.RID - experimentRid: core.RID - seriesName: str - - -@dataclass -class ExperimentSeriesNotFound(errors.NotFoundError): - name: typing.Literal["ExperimentSeriesNotFound"] - parameters: ExperimentSeriesNotFoundParameters - error_instance_id: str - - -class FunctionAlreadyExistsParameters(typing_extensions.TypedDict): - """A function already exists for this live deployment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - liveDeploymentRid: models_models.LiveDeploymentRid - - -@dataclass -class FunctionAlreadyExists(errors.ConflictError): - name: typing.Literal["FunctionAlreadyExists"] - parameters: FunctionAlreadyExistsParameters - error_instance_id: str - - -class GpuTypeNotAvailableParameters(typing_extensions.TypedDict): - """ - The requested GPU type is not available. Use a GPU type that is available in - the deployment's resource queue. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - requestedGpuType: models_models.GpuType - """The GPU type that was requested.""" - - availableGpuTypes: typing.List[models_models.GpuType] - """The GPU types available in the resource queue.""" - - -@dataclass -class GpuTypeNotAvailable(errors.BadRequestError): - name: typing.Literal["GpuTypeNotAvailable"] - parameters: GpuTypeNotAvailableParameters - error_instance_id: str - - -class InferenceFailureParameters(typing_extensions.TypedDict): - """ - The inference request failed due to a model execution error or unexpected internal issue. - This typically indicates a problem with the model itself rather than the input data. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - liveDeploymentRid: models_models.LiveDeploymentRid - errorMessage: str - - -@dataclass -class InferenceFailure(errors.BadRequestError): - name: typing.Literal["InferenceFailure"] - parameters: InferenceFailureParameters - error_instance_id: str - - -class InferenceInvalidInputParameters(typing_extensions.TypedDict): - """ - The inference request contains invalid input data that does not match the model's API specification. - Check the error type for specific validation failure details. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - liveDeploymentRid: models_models.LiveDeploymentRid - errorType: models_models.InferenceInputErrorType - """The specific type and details of the input validation error""" - - -@dataclass -class InferenceInvalidInput(errors.BadRequestError): - name: typing.Literal["InferenceInvalidInput"] - parameters: InferenceInvalidInputParameters - error_instance_id: str - - -class InferenceTimeoutParameters(typing_extensions.TypedDict): - """ - The live deployment took longer than 5 minutes to respond to the inference request. - This typically indicates the model execution is taking too long or the deployment is under heavy load. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - liveDeploymentRid: models_models.LiveDeploymentRid - - -@dataclass -class InferenceTimeout(errors.InternalServerError): - name: typing.Literal["InferenceTimeout"] - parameters: InferenceTimeoutParameters - error_instance_id: str - - -class InvalidExperimentSearchFilterParameters(typing_extensions.TypedDict): - """ - The search filter is invalid. This can occur when using an unsupported operator and value type - combination in a parameter filter, filtering by an unsupported status, or providing a malformed filter. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - reason: str - """A human-readable description of why the filter is invalid.""" - - -@dataclass -class InvalidExperimentSearchFilter(errors.BadRequestError): - name: typing.Literal["InvalidExperimentSearchFilter"] - parameters: InvalidExperimentSearchFilterParameters - error_instance_id: str - - -class InvalidFunctionApiNameParameters(typing_extensions.TypedDict): - """The provided API name for the function is invalid.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: str - - -@dataclass -class InvalidFunctionApiName(errors.BadRequestError): - name: typing.Literal["InvalidFunctionApiName"] - parameters: InvalidFunctionApiNameParameters - error_instance_id: str - - -class InvalidGpuCountParameters(typing_extensions.TypedDict): - """ - The GPU count is invalid. The GPU count must be between 1 and the maximum allowed - for the requested GPU type. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - providedGpuCount: int - """The GPU count that was provided in the request.""" - - maxGpuCount: int - """The maximum allowed GPU count for the requested GPU type.""" - - -@dataclass -class InvalidGpuCount(errors.BadRequestError): - name: typing.Literal["InvalidGpuCount"] - parameters: InvalidGpuCountParameters - error_instance_id: str - - class InvalidModelApiParameters(typing_extensions.TypedDict): """The model api failed validations""" @@ -355,145 +82,6 @@ class InvalidModelApi(errors.BadRequestError): error_instance_id: str -class InvalidModelStudioCreateRequestParameters(typing_extensions.TypedDict): - """The request to create a Model Studio contains invalid arguments.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class InvalidModelStudioCreateRequest(errors.BadRequestError): - name: typing.Literal["InvalidModelStudioCreateRequest"] - parameters: InvalidModelStudioCreateRequestParameters - error_instance_id: str - - -class JsonExperimentArtifactTablePermissionDeniedParameters(typing_extensions.TypedDict): - """Could not json the ExperimentArtifactTable.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - experimentRid: models_models.ExperimentRid - experimentArtifactTableName: models_models.ExperimentArtifactName - modelRid: models_models.ModelRid - - -@dataclass -class JsonExperimentArtifactTablePermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["JsonExperimentArtifactTablePermissionDenied"] - parameters: JsonExperimentArtifactTablePermissionDeniedParameters - error_instance_id: str - - -class JsonExperimentSeriesPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not json the ExperimentSeries.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - experimentSeriesName: models_models.SeriesName - experimentRid: models_models.ExperimentRid - modelRid: models_models.ModelRid - - -@dataclass -class JsonExperimentSeriesPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["JsonExperimentSeriesPermissionDenied"] - parameters: JsonExperimentSeriesPermissionDeniedParameters - error_instance_id: str - - -class LatestModelStudioConfigVersionsPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not latest the ModelStudioConfigVersion.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - modelStudioRid: models_models.ModelStudioRid - - -@dataclass -class LatestModelStudioConfigVersionsPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["LatestModelStudioConfigVersionsPermissionDenied"] - parameters: LatestModelStudioConfigVersionsPermissionDeniedParameters - error_instance_id: str - - -class LaunchModelStudioPermissionDeniedParameters(typing_extensions.TypedDict): - """Permission denied to launch a Model Studio run.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - studioRid: models_models.ModelStudioRid - - -@dataclass -class LaunchModelStudioPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["LaunchModelStudioPermissionDenied"] - parameters: LaunchModelStudioPermissionDeniedParameters - error_instance_id: str - - -class LiveDeploymentNotFoundParameters(typing_extensions.TypedDict): - """The specified live deployment was not found.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - liveDeploymentRid: models_models.LiveDeploymentRid - - -@dataclass -class LiveDeploymentNotFound(errors.NotFoundError): - name: typing.Literal["LiveDeploymentNotFound"] - parameters: LiveDeploymentNotFoundParameters - error_instance_id: str - - -class ModelApiTypeUnsupportedForFunctionParameters(typing_extensions.TypedDict): - """The model API contains a data type that is not supported for Ontology function creation.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fieldName: str - unsupportedType: str - - -@dataclass -class ModelApiTypeUnsupportedForFunction(errors.BadRequestError): - name: typing.Literal["ModelApiTypeUnsupportedForFunction"] - parameters: ModelApiTypeUnsupportedForFunctionParameters - error_instance_id: str - - -class ModelExperimentNotFoundParameters(typing_extensions.TypedDict): - """The requested experiment was not found or the user lacks permission to access it.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - modelRid: core.RID - experimentRid: core.RID - - -@dataclass -class ModelExperimentNotFound(errors.NotFoundError): - name: typing.Literal["ModelExperimentNotFound"] - parameters: ModelExperimentNotFoundParameters - error_instance_id: str - - -class ModelFunctionNotFoundParameters(typing_extensions.TypedDict): - """The given ModelFunction could not be found.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - liveDeploymentRid: models_models.LiveDeploymentRid - - -@dataclass -class ModelFunctionNotFound(errors.NotFoundError): - name: typing.Literal["ModelFunctionNotFound"] - parameters: ModelFunctionNotFoundParameters - error_instance_id: str - - class ModelNotFoundParameters(typing_extensions.TypedDict): """The given Model could not be found.""" @@ -509,52 +97,6 @@ class ModelNotFound(errors.NotFoundError): error_instance_id: str -class ModelStudioConfigVersionNotFoundParameters(typing_extensions.TypedDict): - """The requested Model Studio configuration version was not found.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - studioRid: models_models.ModelStudioRid - configVersion: models_models.ModelStudioConfigVersionNumber - - -@dataclass -class ModelStudioConfigVersionNotFound(errors.NotFoundError): - name: typing.Literal["ModelStudioConfigVersionNotFound"] - parameters: ModelStudioConfigVersionNotFoundParameters - error_instance_id: str - - -class ModelStudioNotFoundParameters(typing_extensions.TypedDict): - """The requested Model Studio was not found.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - studioRid: models_models.ModelStudioRid - - -@dataclass -class ModelStudioNotFound(errors.NotFoundError): - name: typing.Literal["ModelStudioNotFound"] - parameters: ModelStudioNotFoundParameters - error_instance_id: str - - -class ModelStudioTrainerNotFoundParameters(typing_extensions.TypedDict): - """The given ModelStudioTrainer could not be found.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - modelStudioTrainerTrainerId: models_models.TrainerId - - -@dataclass -class ModelStudioTrainerNotFound(errors.NotFoundError): - name: typing.Literal["ModelStudioTrainerNotFound"] - parameters: ModelStudioTrainerNotFoundParameters - error_instance_id: str - - class ModelVersionNotFoundParameters(typing_extensions.TypedDict): """The given ModelVersion could not be found.""" @@ -571,249 +113,11 @@ class ModelVersionNotFound(errors.NotFoundError): error_instance_id: str -class OntologyBindingRequiredParameters(typing_extensions.TypedDict): - """An ontologyBinding is required when creating or replacing a model function.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class OntologyBindingRequired(errors.BadRequestError): - name: typing.Literal["OntologyBindingRequired"] - parameters: OntologyBindingRequiredParameters - error_instance_id: str - - -class OntologyNotFoundParameters(typing_extensions.TypedDict): - """The specified ontology was not found.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - ontologyRid: core.RID - - -@dataclass -class OntologyNotFound(errors.NotFoundError): - name: typing.Literal["OntologyNotFound"] - parameters: OntologyNotFoundParameters - error_instance_id: str - - -class ParquetExperimentArtifactTablePermissionDeniedParameters(typing_extensions.TypedDict): - """Could not parquet the ExperimentArtifactTable.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - experimentRid: models_models.ExperimentRid - experimentArtifactTableName: models_models.ExperimentArtifactName - modelRid: models_models.ModelRid - - -@dataclass -class ParquetExperimentArtifactTablePermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["ParquetExperimentArtifactTablePermissionDenied"] - parameters: ParquetExperimentArtifactTablePermissionDeniedParameters - error_instance_id: str - - -class ParquetExperimentSeriesPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not parquet the ExperimentSeries.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - experimentSeriesName: models_models.SeriesName - experimentRid: models_models.ExperimentRid - modelRid: models_models.ModelRid - - -@dataclass -class ParquetExperimentSeriesPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["ParquetExperimentSeriesPermissionDenied"] - parameters: ParquetExperimentSeriesPermissionDeniedParameters - error_instance_id: str - - -class PromoteVersionModelPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not promoteVersion the Model.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - modelRid: models_models.ModelRid - - -@dataclass -class PromoteVersionModelPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["PromoteVersionModelPermissionDenied"] - parameters: PromoteVersionModelPermissionDeniedParameters - error_instance_id: str - - -class ReplaceLiveDeploymentPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not replace the LiveDeployment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - liveDeploymentRid: models_models.LiveDeploymentRid - - -@dataclass -class ReplaceLiveDeploymentPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["ReplaceLiveDeploymentPermissionDenied"] - parameters: ReplaceLiveDeploymentPermissionDeniedParameters - error_instance_id: str - - -class ReplaceModelFunctionPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not replace the ModelFunction.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - liveDeploymentRid: models_models.LiveDeploymentRid - - -@dataclass -class ReplaceModelFunctionPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["ReplaceModelFunctionPermissionDenied"] - parameters: ReplaceModelFunctionPermissionDeniedParameters - error_instance_id: str - - -class SearchExperimentsPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not search the Experiment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - modelRid: models_models.ModelRid - - -@dataclass -class SearchExperimentsPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["SearchExperimentsPermissionDenied"] - parameters: SearchExperimentsPermissionDeniedParameters - error_instance_id: str - - -class ThreadCountTooHighParameters(typing_extensions.TypedDict): - """The specified thread count exceeds the maximum allowed value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - maxThreadCount: int - """The maximum allowed thread count.""" - - providedThreadCount: int - """The thread count that was provided in the request.""" - - -@dataclass -class ThreadCountTooHigh(errors.BadRequestError): - name: typing.Literal["ThreadCountTooHigh"] - parameters: ThreadCountTooHighParameters - error_instance_id: str - - -class TrainerNotFoundParameters(typing_extensions.TypedDict): - """The specified trainer does not exist.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - trainerId: str - - -@dataclass -class TrainerNotFound(errors.NotFoundError): - name: typing.Literal["TrainerNotFound"] - parameters: TrainerNotFoundParameters - error_instance_id: str - - -class TransformJsonLiveDeploymentPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not transformJson the LiveDeployment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - liveDeploymentRid: models_models.LiveDeploymentRid - - -@dataclass -class TransformJsonLiveDeploymentPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["TransformJsonLiveDeploymentPermissionDenied"] - parameters: TransformJsonLiveDeploymentPermissionDeniedParameters - error_instance_id: str - - -class UnsupportedLiveDeploymentParameters(typing_extensions.TypedDict): - """The Live Deployment type is not supported by the API.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class UnsupportedLiveDeployment(errors.BadRequestError): - name: typing.Literal["UnsupportedLiveDeployment"] - parameters: UnsupportedLiveDeploymentParameters - error_instance_id: str - - -class UnsupportedModelSourceParameters(typing_extensions.TypedDict): - """The Model Version has a source type that is not supported by the API. This can occur when the model was created through a legacy or internal workflow that is not exposed through the public API.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class UnsupportedModelSource(errors.BadRequestError): - name: typing.Literal["UnsupportedModelSource"] - parameters: UnsupportedModelSourceParameters - error_instance_id: str - - __all__ = [ "CondaSolveFailureForProvidedPackages", - "CreateConfigValidationError", - "CreateLiveDeploymentPermissionDenied", - "CreateModelFunctionPermissionDenied", "CreateModelPermissionDenied", - "CreateModelStudioConfigVersionPermissionDenied", - "CreateModelStudioPermissionDenied", "CreateModelVersionPermissionDenied", - "ExperimentArtifactNotFound", - "ExperimentNotFound", - "ExperimentSeriesNotFound", - "FunctionAlreadyExists", - "GpuTypeNotAvailable", - "InferenceFailure", - "InferenceInvalidInput", - "InferenceTimeout", - "InvalidExperimentSearchFilter", - "InvalidFunctionApiName", - "InvalidGpuCount", "InvalidModelApi", - "InvalidModelStudioCreateRequest", - "JsonExperimentArtifactTablePermissionDenied", - "JsonExperimentSeriesPermissionDenied", - "LatestModelStudioConfigVersionsPermissionDenied", - "LaunchModelStudioPermissionDenied", - "LiveDeploymentNotFound", - "ModelApiTypeUnsupportedForFunction", - "ModelExperimentNotFound", - "ModelFunctionNotFound", "ModelNotFound", - "ModelStudioConfigVersionNotFound", - "ModelStudioNotFound", - "ModelStudioTrainerNotFound", "ModelVersionNotFound", - "OntologyBindingRequired", - "OntologyNotFound", - "ParquetExperimentArtifactTablePermissionDenied", - "ParquetExperimentSeriesPermissionDenied", - "PromoteVersionModelPermissionDenied", - "ReplaceLiveDeploymentPermissionDenied", - "ReplaceModelFunctionPermissionDenied", - "SearchExperimentsPermissionDenied", - "ThreadCountTooHigh", - "TrainerNotFound", - "TransformJsonLiveDeploymentPermissionDenied", - "UnsupportedLiveDeployment", - "UnsupportedModelSource", ] diff --git a/foundry_sdk/v2/models/experiment.py b/foundry_sdk/v2/models/experiment.py deleted file mode 100644 index de213c38b..000000000 --- a/foundry_sdk/v2/models/experiment.py +++ /dev/null @@ -1,418 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing -from functools import cached_property - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.core import models as core_models -from foundry_sdk.v2.models import errors as models_errors -from foundry_sdk.v2.models import models as models_models - - -class ExperimentClient: - """ - The API client for the Experiment Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _ExperimentClientStreaming(self) - self.with_raw_response = _ExperimentClientRaw(self) - - @cached_property - def Series(self): - from foundry_sdk.v2.models.experiment_series import ExperimentSeriesClient - - return ExperimentSeriesClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - - @cached_property - def ArtifactTable(self): - from foundry_sdk.v2.models.experiment_artifact_table import ( - ExperimentArtifactTableClient, - ) # NOQA - - return ExperimentArtifactTableClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - model_rid: models_models.ModelRid, - experiment_rid: models_models.ExperimentRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.Experiment: - """ - Retrieve a single experiment with all metadata, parameters, series metadata, and summary metrics. - - :param model_rid: - :type model_rid: ModelRid - :param experiment_rid: - :type experiment_rid: ExperimentRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.Experiment - - :raises ExperimentNotFound: The given Experiment could not be found. - :raises ModelExperimentNotFound: The requested experiment was not found or the user lacks permission to access it. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/{modelRid}/experiments/{experimentRid}", - query_params={ - "preview": preview, - }, - path_params={ - "modelRid": model_rid, - "experimentRid": experiment_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.Experiment, - request_timeout=request_timeout, - throwable_errors={ - "ExperimentNotFound": models_errors.ExperimentNotFound, - "ModelExperimentNotFound": models_errors.ModelExperimentNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def search( - self, - model_rid: models_models.ModelRid, - *, - order_by: typing.Optional[models_models.SearchExperimentsOrderBy] = None, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - where: typing.Optional[models_models.SearchExperimentsFilter] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.SearchExperimentsResponse: - """ - Search experiments using complex nested queries on experiment metadata, parameters, series, - and summary metrics. Supports AND/OR/NOT combinations and various predicates. - Returns a maximum of 100 results per page. - - :param model_rid: - :type model_rid: ModelRid - :param order_by: The field to sort by. Default is to sort by relevance. - :type order_by: Optional[SearchExperimentsOrderBy] - :param page_size: The maximum number of results to return. Default 50, maximum of 100. - :type page_size: Optional[PageSize] - :param page_token: PageToken to identify the next page to retrieve. Leave empty for the first request. - :type page_token: Optional[PageToken] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param where: Optional search filter for filtering experiments. If not provided, all experiments for the model are returned. - :type where: Optional[SearchExperimentsFilter] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.SearchExperimentsResponse - - :raises InvalidExperimentSearchFilter: The search filter is invalid. This can occur when using an unsupported operator and value type combination in a parameter filter, filtering by an unsupported status, or providing a malformed filter. - :raises SearchExperimentsPermissionDenied: Could not search the Experiment. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/{modelRid}/experiments/search", - query_params={ - "preview": preview, - }, - path_params={ - "modelRid": model_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.SearchExperimentsRequest( - where=where, - order_by=order_by, - page_size=page_size, - page_token=page_token, - ), - response_type=models_models.SearchExperimentsResponse, - request_timeout=request_timeout, - throwable_errors={ - "InvalidExperimentSearchFilter": models_errors.InvalidExperimentSearchFilter, - "SearchExperimentsPermissionDenied": models_errors.SearchExperimentsPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _ExperimentClientRaw: - def __init__(self, client: ExperimentClient) -> None: - def get(_: models_models.Experiment): ... - def search(_: models_models.SearchExperimentsResponse): ... - - self.get = core.with_raw_response(get, client.get) - self.search = core.with_raw_response(search, client.search) - - -class _ExperimentClientStreaming: - def __init__(self, client: ExperimentClient) -> None: - def get(_: models_models.Experiment): ... - def search(_: models_models.SearchExperimentsResponse): ... - - self.get = core.with_streaming_response(get, client.get) - self.search = core.with_streaming_response(search, client.search) - - -class AsyncExperimentClient: - """ - The API client for the Experiment Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncExperimentClientStreaming(self) - self.with_raw_response = _AsyncExperimentClientRaw(self) - - @cached_property - def Series(self): - from foundry_sdk.v2.models.experiment_series import AsyncExperimentSeriesClient - - return AsyncExperimentSeriesClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - - @cached_property - def ArtifactTable(self): - from foundry_sdk.v2.models.experiment_artifact_table import ( - AsyncExperimentArtifactTableClient, - ) # NOQA - - return AsyncExperimentArtifactTableClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - model_rid: models_models.ModelRid, - experiment_rid: models_models.ExperimentRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.Experiment]: - """ - Retrieve a single experiment with all metadata, parameters, series metadata, and summary metrics. - - :param model_rid: - :type model_rid: ModelRid - :param experiment_rid: - :type experiment_rid: ExperimentRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.Experiment] - - :raises ExperimentNotFound: The given Experiment could not be found. - :raises ModelExperimentNotFound: The requested experiment was not found or the user lacks permission to access it. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/{modelRid}/experiments/{experimentRid}", - query_params={ - "preview": preview, - }, - path_params={ - "modelRid": model_rid, - "experimentRid": experiment_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.Experiment, - request_timeout=request_timeout, - throwable_errors={ - "ExperimentNotFound": models_errors.ExperimentNotFound, - "ModelExperimentNotFound": models_errors.ModelExperimentNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def search( - self, - model_rid: models_models.ModelRid, - *, - order_by: typing.Optional[models_models.SearchExperimentsOrderBy] = None, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - where: typing.Optional[models_models.SearchExperimentsFilter] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.SearchExperimentsResponse]: - """ - Search experiments using complex nested queries on experiment metadata, parameters, series, - and summary metrics. Supports AND/OR/NOT combinations and various predicates. - Returns a maximum of 100 results per page. - - :param model_rid: - :type model_rid: ModelRid - :param order_by: The field to sort by. Default is to sort by relevance. - :type order_by: Optional[SearchExperimentsOrderBy] - :param page_size: The maximum number of results to return. Default 50, maximum of 100. - :type page_size: Optional[PageSize] - :param page_token: PageToken to identify the next page to retrieve. Leave empty for the first request. - :type page_token: Optional[PageToken] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param where: Optional search filter for filtering experiments. If not provided, all experiments for the model are returned. - :type where: Optional[SearchExperimentsFilter] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.SearchExperimentsResponse] - - :raises InvalidExperimentSearchFilter: The search filter is invalid. This can occur when using an unsupported operator and value type combination in a parameter filter, filtering by an unsupported status, or providing a malformed filter. - :raises SearchExperimentsPermissionDenied: Could not search the Experiment. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/{modelRid}/experiments/search", - query_params={ - "preview": preview, - }, - path_params={ - "modelRid": model_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.SearchExperimentsRequest( - where=where, - order_by=order_by, - page_size=page_size, - page_token=page_token, - ), - response_type=models_models.SearchExperimentsResponse, - request_timeout=request_timeout, - throwable_errors={ - "InvalidExperimentSearchFilter": models_errors.InvalidExperimentSearchFilter, - "SearchExperimentsPermissionDenied": models_errors.SearchExperimentsPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _AsyncExperimentClientRaw: - def __init__(self, client: AsyncExperimentClient) -> None: - def get(_: models_models.Experiment): ... - def search(_: models_models.SearchExperimentsResponse): ... - - self.get = core.async_with_raw_response(get, client.get) - self.search = core.async_with_raw_response(search, client.search) - - -class _AsyncExperimentClientStreaming: - def __init__(self, client: AsyncExperimentClient) -> None: - def get(_: models_models.Experiment): ... - def search(_: models_models.SearchExperimentsResponse): ... - - self.get = core.async_with_streaming_response(get, client.get) - self.search = core.async_with_streaming_response(search, client.search) diff --git a/foundry_sdk/v2/models/experiment_artifact_table.py b/foundry_sdk/v2/models/experiment_artifact_table.py deleted file mode 100644 index 72cf822f3..000000000 --- a/foundry_sdk/v2/models/experiment_artifact_table.py +++ /dev/null @@ -1,387 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.core import models as core_models -from foundry_sdk.v2.models import errors as models_errors -from foundry_sdk.v2.models import models as models_models - - -class ExperimentArtifactTableClient: - """ - The API client for the ExperimentArtifactTable Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _ExperimentArtifactTableClientStreaming(self) - self.with_raw_response = _ExperimentArtifactTableClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def json( - self, - model_rid: models_models.ModelRid, - experiment_rid: models_models.ExperimentRid, - experiment_artifact_table_name: models_models.ExperimentArtifactName, - *, - offset: typing.Optional[int] = None, - page_size: typing.Optional[core_models.PageSize] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> bytes: - """ - Read table data from an experiment artifact as a streamed binary response containing JSON. - The response body is a JSON array of row objects, where each object maps column names to values. - Results are paginated by row count with a default page size of 10 and a maximum of 100. - - :param model_rid: - :type model_rid: ModelRid - :param experiment_rid: - :type experiment_rid: ExperimentRid - :param experiment_artifact_table_name: - :type experiment_artifact_table_name: ExperimentArtifactName - :param offset: Number of rows to skip from the beginning. Defaults to 0. - :type offset: Optional[int] - :param page_size: Maximum number of rows to return. Default is 10, maximum is 100. - :type page_size: Optional[PageSize] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: bytes - - :raises ExperimentArtifactNotFound: The requested artifact was not found in the experiment. - :raises JsonExperimentArtifactTablePermissionDenied: Could not json the ExperimentArtifactTable. - :raises ModelExperimentNotFound: The requested experiment was not found or the user lacks permission to access it. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/{modelRid}/experiments/{experimentRid}/artifactTables/{experimentArtifactTableName}/json", - query_params={ - "offset": offset, - "pageSize": page_size, - "preview": preview, - }, - path_params={ - "modelRid": model_rid, - "experimentRid": experiment_rid, - "experimentArtifactTableName": experiment_artifact_table_name, - }, - header_params={ - "Accept": "application/octet-stream", - }, - body=None, - response_type=bytes, - request_timeout=request_timeout, - throwable_errors={ - "ExperimentArtifactNotFound": models_errors.ExperimentArtifactNotFound, - "JsonExperimentArtifactTablePermissionDenied": models_errors.JsonExperimentArtifactTablePermissionDenied, - "ModelExperimentNotFound": models_errors.ModelExperimentNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def parquet( - self, - model_rid: models_models.ModelRid, - experiment_rid: models_models.ExperimentRid, - experiment_artifact_table_name: models_models.ExperimentArtifactName, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> core.TableResponse: - """ - Read raw table data from experiment artifacts in Parquet format. - - :param model_rid: - :type model_rid: ModelRid - :param experiment_rid: - :type experiment_rid: ExperimentRid - :param experiment_artifact_table_name: - :type experiment_artifact_table_name: ExperimentArtifactName - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: core.TableResponse - - - :raises ExperimentArtifactNotFound: The requested artifact was not found in the experiment. - :raises ModelExperimentNotFound: The requested experiment was not found or the user lacks permission to access it. - :raises ParquetExperimentArtifactTablePermissionDenied: Could not parquet the ExperimentArtifactTable. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/{modelRid}/experiments/{experimentRid}/artifactTables/{experimentArtifactTableName}/parquet", - query_params={ - "preview": preview, - }, - path_params={ - "modelRid": model_rid, - "experimentRid": experiment_rid, - "experimentArtifactTableName": experiment_artifact_table_name, - }, - header_params={ - "Accept": "application/octet-stream", - }, - body=None, - response_type=bytes, - request_timeout=request_timeout, - throwable_errors={ - "ExperimentArtifactNotFound": models_errors.ExperimentArtifactNotFound, - "ModelExperimentNotFound": models_errors.ModelExperimentNotFound, - "ParquetExperimentArtifactTablePermissionDenied": models_errors.ParquetExperimentArtifactTablePermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode", "PARQUET_TABLE"), - ), - ) - - -class _ExperimentArtifactTableClientRaw: - def __init__(self, client: ExperimentArtifactTableClient) -> None: - def json(_: bytes): ... - def parquet(_: bytes): ... - - self.json = core.with_raw_response(json, client.json) - self.parquet = core.with_raw_response(parquet, client.parquet) - - -class _ExperimentArtifactTableClientStreaming: - def __init__(self, client: ExperimentArtifactTableClient) -> None: - def json(_: bytes): ... - def parquet(_: bytes): ... - - self.json = core.with_streaming_response(json, client.json) - self.parquet = core.with_streaming_response(parquet, client.parquet) - - -class AsyncExperimentArtifactTableClient: - """ - The API client for the ExperimentArtifactTable Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncExperimentArtifactTableClientStreaming(self) - self.with_raw_response = _AsyncExperimentArtifactTableClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def json( - self, - model_rid: models_models.ModelRid, - experiment_rid: models_models.ExperimentRid, - experiment_artifact_table_name: models_models.ExperimentArtifactName, - *, - offset: typing.Optional[int] = None, - page_size: typing.Optional[core_models.PageSize] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[bytes]: - """ - Read table data from an experiment artifact as a streamed binary response containing JSON. - The response body is a JSON array of row objects, where each object maps column names to values. - Results are paginated by row count with a default page size of 10 and a maximum of 100. - - :param model_rid: - :type model_rid: ModelRid - :param experiment_rid: - :type experiment_rid: ExperimentRid - :param experiment_artifact_table_name: - :type experiment_artifact_table_name: ExperimentArtifactName - :param offset: Number of rows to skip from the beginning. Defaults to 0. - :type offset: Optional[int] - :param page_size: Maximum number of rows to return. Default is 10, maximum is 100. - :type page_size: Optional[PageSize] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[bytes] - - :raises ExperimentArtifactNotFound: The requested artifact was not found in the experiment. - :raises JsonExperimentArtifactTablePermissionDenied: Could not json the ExperimentArtifactTable. - :raises ModelExperimentNotFound: The requested experiment was not found or the user lacks permission to access it. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/{modelRid}/experiments/{experimentRid}/artifactTables/{experimentArtifactTableName}/json", - query_params={ - "offset": offset, - "pageSize": page_size, - "preview": preview, - }, - path_params={ - "modelRid": model_rid, - "experimentRid": experiment_rid, - "experimentArtifactTableName": experiment_artifact_table_name, - }, - header_params={ - "Accept": "application/octet-stream", - }, - body=None, - response_type=bytes, - request_timeout=request_timeout, - throwable_errors={ - "ExperimentArtifactNotFound": models_errors.ExperimentArtifactNotFound, - "JsonExperimentArtifactTablePermissionDenied": models_errors.JsonExperimentArtifactTablePermissionDenied, - "ModelExperimentNotFound": models_errors.ModelExperimentNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def parquet( - self, - model_rid: models_models.ModelRid, - experiment_rid: models_models.ExperimentRid, - experiment_artifact_table_name: models_models.ExperimentArtifactName, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[core.TableResponse]: - """ - Read raw table data from experiment artifacts in Parquet format. - - :param model_rid: - :type model_rid: ModelRid - :param experiment_rid: - :type experiment_rid: ExperimentRid - :param experiment_artifact_table_name: - :type experiment_artifact_table_name: ExperimentArtifactName - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[core.TableResponse - ] - - :raises ExperimentArtifactNotFound: The requested artifact was not found in the experiment. - :raises ModelExperimentNotFound: The requested experiment was not found or the user lacks permission to access it. - :raises ParquetExperimentArtifactTablePermissionDenied: Could not parquet the ExperimentArtifactTable. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/{modelRid}/experiments/{experimentRid}/artifactTables/{experimentArtifactTableName}/parquet", - query_params={ - "preview": preview, - }, - path_params={ - "modelRid": model_rid, - "experimentRid": experiment_rid, - "experimentArtifactTableName": experiment_artifact_table_name, - }, - header_params={ - "Accept": "application/octet-stream", - }, - body=None, - response_type=bytes, - request_timeout=request_timeout, - throwable_errors={ - "ExperimentArtifactNotFound": models_errors.ExperimentArtifactNotFound, - "ModelExperimentNotFound": models_errors.ModelExperimentNotFound, - "ParquetExperimentArtifactTablePermissionDenied": models_errors.ParquetExperimentArtifactTablePermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode", "PARQUET_TABLE"), - ), - ) - - -class _AsyncExperimentArtifactTableClientRaw: - def __init__(self, client: AsyncExperimentArtifactTableClient) -> None: - def json(_: bytes): ... - def parquet(_: bytes): ... - - self.json = core.async_with_raw_response(json, client.json) - self.parquet = core.async_with_raw_response(parquet, client.parquet) - - -class _AsyncExperimentArtifactTableClientStreaming: - def __init__(self, client: AsyncExperimentArtifactTableClient) -> None: - def json(_: bytes): ... - def parquet(_: bytes): ... - - self.json = core.async_with_streaming_response(json, client.json) - self.parquet = core.async_with_streaming_response(parquet, client.parquet) diff --git a/foundry_sdk/v2/models/experiment_series.py b/foundry_sdk/v2/models/experiment_series.py deleted file mode 100644 index 4ef8b57ca..000000000 --- a/foundry_sdk/v2/models/experiment_series.py +++ /dev/null @@ -1,385 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.core import models as core_models -from foundry_sdk.v2.models import errors as models_errors -from foundry_sdk.v2.models import models as models_models - - -class ExperimentSeriesClient: - """ - The API client for the ExperimentSeries Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _ExperimentSeriesClientStreaming(self) - self.with_raw_response = _ExperimentSeriesClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def json( - self, - model_rid: models_models.ModelRid, - experiment_rid: models_models.ExperimentRid, - experiment_series_name: models_models.SeriesName, - *, - offset: typing.Optional[int] = None, - page_size: typing.Optional[core_models.PageSize] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.Series: - """ - Retrieve raw time-series data for a single series in JSON format. - Results are paginated with a default page size of 200 and a maximum of 1000. - - :param model_rid: - :type model_rid: ModelRid - :param experiment_rid: - :type experiment_rid: ExperimentRid - :param experiment_series_name: - :type experiment_series_name: SeriesName - :param offset: Number of values to skip from the beginning. Defaults to 0. - :type offset: Optional[int] - :param page_size: Maximum number of values to return per page. Default is 200, maximum is 1000. - :type page_size: Optional[PageSize] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.Series - - :raises ExperimentSeriesNotFound: The requested series was not found in the experiment. - :raises JsonExperimentSeriesPermissionDenied: Could not json the ExperimentSeries. - :raises ModelExperimentNotFound: The requested experiment was not found or the user lacks permission to access it. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/json", - query_params={ - "offset": offset, - "pageSize": page_size, - "preview": preview, - }, - path_params={ - "modelRid": model_rid, - "experimentRid": experiment_rid, - "experimentSeriesName": experiment_series_name, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.Series, - request_timeout=request_timeout, - throwable_errors={ - "ExperimentSeriesNotFound": models_errors.ExperimentSeriesNotFound, - "JsonExperimentSeriesPermissionDenied": models_errors.JsonExperimentSeriesPermissionDenied, - "ModelExperimentNotFound": models_errors.ModelExperimentNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def parquet( - self, - model_rid: models_models.ModelRid, - experiment_rid: models_models.ExperimentRid, - experiment_series_name: models_models.SeriesName, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> core.TableResponse: - """ - Retrieve raw time-series data for a single series as a streamed binary response in Apache Parquet format. - - :param model_rid: - :type model_rid: ModelRid - :param experiment_rid: - :type experiment_rid: ExperimentRid - :param experiment_series_name: - :type experiment_series_name: SeriesName - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: core.TableResponse - - - :raises ExperimentSeriesNotFound: The requested series was not found in the experiment. - :raises ModelExperimentNotFound: The requested experiment was not found or the user lacks permission to access it. - :raises ParquetExperimentSeriesPermissionDenied: Could not parquet the ExperimentSeries. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/parquet", - query_params={ - "preview": preview, - }, - path_params={ - "modelRid": model_rid, - "experimentRid": experiment_rid, - "experimentSeriesName": experiment_series_name, - }, - header_params={ - "Accept": "application/octet-stream", - }, - body=None, - response_type=bytes, - request_timeout=request_timeout, - throwable_errors={ - "ExperimentSeriesNotFound": models_errors.ExperimentSeriesNotFound, - "ModelExperimentNotFound": models_errors.ModelExperimentNotFound, - "ParquetExperimentSeriesPermissionDenied": models_errors.ParquetExperimentSeriesPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode", "PARQUET_TABLE"), - ), - ) - - -class _ExperimentSeriesClientRaw: - def __init__(self, client: ExperimentSeriesClient) -> None: - def json(_: models_models.Series): ... - def parquet(_: bytes): ... - - self.json = core.with_raw_response(json, client.json) - self.parquet = core.with_raw_response(parquet, client.parquet) - - -class _ExperimentSeriesClientStreaming: - def __init__(self, client: ExperimentSeriesClient) -> None: - def json(_: models_models.Series): ... - def parquet(_: bytes): ... - - self.json = core.with_streaming_response(json, client.json) - self.parquet = core.with_streaming_response(parquet, client.parquet) - - -class AsyncExperimentSeriesClient: - """ - The API client for the ExperimentSeries Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncExperimentSeriesClientStreaming(self) - self.with_raw_response = _AsyncExperimentSeriesClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def json( - self, - model_rid: models_models.ModelRid, - experiment_rid: models_models.ExperimentRid, - experiment_series_name: models_models.SeriesName, - *, - offset: typing.Optional[int] = None, - page_size: typing.Optional[core_models.PageSize] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.Series]: - """ - Retrieve raw time-series data for a single series in JSON format. - Results are paginated with a default page size of 200 and a maximum of 1000. - - :param model_rid: - :type model_rid: ModelRid - :param experiment_rid: - :type experiment_rid: ExperimentRid - :param experiment_series_name: - :type experiment_series_name: SeriesName - :param offset: Number of values to skip from the beginning. Defaults to 0. - :type offset: Optional[int] - :param page_size: Maximum number of values to return per page. Default is 200, maximum is 1000. - :type page_size: Optional[PageSize] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.Series] - - :raises ExperimentSeriesNotFound: The requested series was not found in the experiment. - :raises JsonExperimentSeriesPermissionDenied: Could not json the ExperimentSeries. - :raises ModelExperimentNotFound: The requested experiment was not found or the user lacks permission to access it. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/json", - query_params={ - "offset": offset, - "pageSize": page_size, - "preview": preview, - }, - path_params={ - "modelRid": model_rid, - "experimentRid": experiment_rid, - "experimentSeriesName": experiment_series_name, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.Series, - request_timeout=request_timeout, - throwable_errors={ - "ExperimentSeriesNotFound": models_errors.ExperimentSeriesNotFound, - "JsonExperimentSeriesPermissionDenied": models_errors.JsonExperimentSeriesPermissionDenied, - "ModelExperimentNotFound": models_errors.ModelExperimentNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def parquet( - self, - model_rid: models_models.ModelRid, - experiment_rid: models_models.ExperimentRid, - experiment_series_name: models_models.SeriesName, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[core.TableResponse]: - """ - Retrieve raw time-series data for a single series as a streamed binary response in Apache Parquet format. - - :param model_rid: - :type model_rid: ModelRid - :param experiment_rid: - :type experiment_rid: ExperimentRid - :param experiment_series_name: - :type experiment_series_name: SeriesName - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[core.TableResponse - ] - - :raises ExperimentSeriesNotFound: The requested series was not found in the experiment. - :raises ModelExperimentNotFound: The requested experiment was not found or the user lacks permission to access it. - :raises ParquetExperimentSeriesPermissionDenied: Could not parquet the ExperimentSeries. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/parquet", - query_params={ - "preview": preview, - }, - path_params={ - "modelRid": model_rid, - "experimentRid": experiment_rid, - "experimentSeriesName": experiment_series_name, - }, - header_params={ - "Accept": "application/octet-stream", - }, - body=None, - response_type=bytes, - request_timeout=request_timeout, - throwable_errors={ - "ExperimentSeriesNotFound": models_errors.ExperimentSeriesNotFound, - "ModelExperimentNotFound": models_errors.ModelExperimentNotFound, - "ParquetExperimentSeriesPermissionDenied": models_errors.ParquetExperimentSeriesPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode", "PARQUET_TABLE"), - ), - ) - - -class _AsyncExperimentSeriesClientRaw: - def __init__(self, client: AsyncExperimentSeriesClient) -> None: - def json(_: models_models.Series): ... - def parquet(_: bytes): ... - - self.json = core.async_with_raw_response(json, client.json) - self.parquet = core.async_with_raw_response(parquet, client.parquet) - - -class _AsyncExperimentSeriesClientStreaming: - def __init__(self, client: AsyncExperimentSeriesClient) -> None: - def json(_: models_models.Series): ... - def parquet(_: bytes): ... - - self.json = core.async_with_streaming_response(json, client.json) - self.parquet = core.async_with_streaming_response(parquet, client.parquet) diff --git a/foundry_sdk/v2/models/live_deployment.py b/foundry_sdk/v2/models/live_deployment.py deleted file mode 100644 index 480feee15..000000000 --- a/foundry_sdk/v2/models/live_deployment.py +++ /dev/null @@ -1,642 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing -from functools import cached_property - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.core import models as core_models -from foundry_sdk.v2.models import errors as models_errors -from foundry_sdk.v2.models import models as models_models - - -class LiveDeploymentClient: - """ - The API client for the LiveDeployment Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _LiveDeploymentClientStreaming(self) - self.with_raw_response = _LiveDeploymentClientRaw(self) - - @cached_property - def Function(self): - from foundry_sdk.v2.models.model_function import ModelFunctionClient - - return ModelFunctionClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def create( - self, - *, - deployment_type: models_models.CreateLiveDeploymentTarget, - runtime_configuration: models_models.LiveDeploymentRuntimeConfiguration, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.LiveDeployment: - """ - Creates a new live deployment for a model version with the specified runtime configuration. The deployment will begin provisioning compute resources and deploying the target model version. - - :param deployment_type: The target model source for the live deployment. Determines which model and version selection strategy to use when creating the deployment. - :type deployment_type: CreateLiveDeploymentTarget - :param runtime_configuration: The compute resource configuration for the deployment. - :type runtime_configuration: LiveDeploymentRuntimeConfiguration - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.LiveDeployment - - :raises CreateLiveDeploymentPermissionDenied: Could not create the LiveDeployment. - :raises GpuTypeNotAvailable: The requested GPU type is not available. Use a GPU type that is available in the deployment's resource queue. - :raises InvalidGpuCount: The GPU count is invalid. The GPU count must be between 1 and the maximum allowed for the requested GPU type. - :raises ModelNotFound: The given Model could not be found. - :raises ThreadCountTooHigh: The specified thread count exceeds the maximum allowed value. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/liveDeployments", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.CreateLiveDeploymentRequest( - deployment_type=deployment_type, - runtime_configuration=runtime_configuration, - ), - response_type=models_models.LiveDeployment, - request_timeout=request_timeout, - throwable_errors={ - "CreateLiveDeploymentPermissionDenied": models_errors.CreateLiveDeploymentPermissionDenied, - "GpuTypeNotAvailable": models_errors.GpuTypeNotAvailable, - "InvalidGpuCount": models_errors.InvalidGpuCount, - "ModelNotFound": models_errors.ModelNotFound, - "ThreadCountTooHigh": models_errors.ThreadCountTooHigh, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - live_deployment_rid: models_models.LiveDeploymentRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.LiveDeployment: - """ - Retrieves a live deployment by its Resource Identifier (RID), including its deployed model version and runtime configuration. - - :param live_deployment_rid: - :type live_deployment_rid: LiveDeploymentRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.LiveDeployment - - :raises LiveDeploymentNotFound: The specified live deployment was not found. - :raises UnsupportedLiveDeployment: The Live Deployment type is not supported by the API. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/liveDeployments/{liveDeploymentRid}", - query_params={ - "preview": preview, - }, - path_params={ - "liveDeploymentRid": live_deployment_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.LiveDeployment, - request_timeout=request_timeout, - throwable_errors={ - "LiveDeploymentNotFound": models_errors.LiveDeploymentNotFound, - "UnsupportedLiveDeployment": models_errors.UnsupportedLiveDeployment, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def replace( - self, - live_deployment_rid: models_models.LiveDeploymentRid, - *, - runtime_configuration: models_models.LiveDeploymentRuntimeConfiguration, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.LiveDeployment: - """ - Updates the runtime configuration of the live deployment. The deployment will apply the new configuration to the running replicas. - - :param live_deployment_rid: - :type live_deployment_rid: LiveDeploymentRid - :param runtime_configuration: The compute resource configuration for the deployment. - :type runtime_configuration: LiveDeploymentRuntimeConfiguration - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.LiveDeployment - - :raises GpuTypeNotAvailable: The requested GPU type is not available. Use a GPU type that is available in the deployment's resource queue. - :raises InvalidGpuCount: The GPU count is invalid. The GPU count must be between 1 and the maximum allowed for the requested GPU type. - :raises LiveDeploymentNotFound: The specified live deployment was not found. - :raises ReplaceLiveDeploymentPermissionDenied: Could not replace the LiveDeployment. - :raises ThreadCountTooHigh: The specified thread count exceeds the maximum allowed value. - :raises UnsupportedLiveDeployment: The Live Deployment type is not supported by the API. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="PUT", - resource_path="/v2/models/liveDeployments/{liveDeploymentRid}", - query_params={ - "preview": preview, - }, - path_params={ - "liveDeploymentRid": live_deployment_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.ReplaceLiveDeploymentRequest( - runtime_configuration=runtime_configuration, - ), - response_type=models_models.LiveDeployment, - request_timeout=request_timeout, - throwable_errors={ - "GpuTypeNotAvailable": models_errors.GpuTypeNotAvailable, - "InvalidGpuCount": models_errors.InvalidGpuCount, - "LiveDeploymentNotFound": models_errors.LiveDeploymentNotFound, - "ReplaceLiveDeploymentPermissionDenied": models_errors.ReplaceLiveDeploymentPermissionDenied, - "ThreadCountTooHigh": models_errors.ThreadCountTooHigh, - "UnsupportedLiveDeployment": models_errors.UnsupportedLiveDeployment, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def transform_json( - self, - live_deployment_rid: models_models.LiveDeploymentRid, - *, - input: typing.Dict[str, typing.Any], - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.TransformLiveDeploymentResponse: - """ - Performs inference on the live deployment. - - :param live_deployment_rid: - :type live_deployment_rid: LiveDeploymentRid - :param input: The input data for the model inference. The structure should match the model's transform API specification, where each key is an input name and the value is the corresponding input data. - :type input: Dict[str, Any] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.TransformLiveDeploymentResponse - - :raises InferenceFailure: The inference request failed due to a model execution error or unexpected internal issue. This typically indicates a problem with the model itself rather than the input data. - :raises InferenceInvalidInput: The inference request contains invalid input data that does not match the model's API specification. Check the error type for specific validation failure details. - :raises InferenceTimeout: The live deployment took longer than 5 minutes to respond to the inference request. This typically indicates the model execution is taking too long or the deployment is under heavy load. - :raises LiveDeploymentNotFound: The specified live deployment was not found. - :raises TransformJsonLiveDeploymentPermissionDenied: Could not transformJson the LiveDeployment. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/liveDeployments/{liveDeploymentRid}/transformJson", - query_params={ - "preview": preview, - }, - path_params={ - "liveDeploymentRid": live_deployment_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.TransformJsonLiveDeploymentRequest( - input=input, - ), - response_type=models_models.TransformLiveDeploymentResponse, - request_timeout=request_timeout, - throwable_errors={ - "InferenceFailure": models_errors.InferenceFailure, - "InferenceInvalidInput": models_errors.InferenceInvalidInput, - "InferenceTimeout": models_errors.InferenceTimeout, - "LiveDeploymentNotFound": models_errors.LiveDeploymentNotFound, - "TransformJsonLiveDeploymentPermissionDenied": models_errors.TransformJsonLiveDeploymentPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _LiveDeploymentClientRaw: - def __init__(self, client: LiveDeploymentClient) -> None: - def create(_: models_models.LiveDeployment): ... - def get(_: models_models.LiveDeployment): ... - def replace(_: models_models.LiveDeployment): ... - def transform_json(_: models_models.TransformLiveDeploymentResponse): ... - - self.create = core.with_raw_response(create, client.create) - self.get = core.with_raw_response(get, client.get) - self.replace = core.with_raw_response(replace, client.replace) - self.transform_json = core.with_raw_response(transform_json, client.transform_json) - - -class _LiveDeploymentClientStreaming: - def __init__(self, client: LiveDeploymentClient) -> None: - def create(_: models_models.LiveDeployment): ... - def get(_: models_models.LiveDeployment): ... - def replace(_: models_models.LiveDeployment): ... - def transform_json(_: models_models.TransformLiveDeploymentResponse): ... - - self.create = core.with_streaming_response(create, client.create) - self.get = core.with_streaming_response(get, client.get) - self.replace = core.with_streaming_response(replace, client.replace) - self.transform_json = core.with_streaming_response(transform_json, client.transform_json) - - -class AsyncLiveDeploymentClient: - """ - The API client for the LiveDeployment Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncLiveDeploymentClientStreaming(self) - self.with_raw_response = _AsyncLiveDeploymentClientRaw(self) - - @cached_property - def Function(self): - from foundry_sdk.v2.models.model_function import AsyncModelFunctionClient - - return AsyncModelFunctionClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def create( - self, - *, - deployment_type: models_models.CreateLiveDeploymentTarget, - runtime_configuration: models_models.LiveDeploymentRuntimeConfiguration, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.LiveDeployment]: - """ - Creates a new live deployment for a model version with the specified runtime configuration. The deployment will begin provisioning compute resources and deploying the target model version. - - :param deployment_type: The target model source for the live deployment. Determines which model and version selection strategy to use when creating the deployment. - :type deployment_type: CreateLiveDeploymentTarget - :param runtime_configuration: The compute resource configuration for the deployment. - :type runtime_configuration: LiveDeploymentRuntimeConfiguration - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.LiveDeployment] - - :raises CreateLiveDeploymentPermissionDenied: Could not create the LiveDeployment. - :raises GpuTypeNotAvailable: The requested GPU type is not available. Use a GPU type that is available in the deployment's resource queue. - :raises InvalidGpuCount: The GPU count is invalid. The GPU count must be between 1 and the maximum allowed for the requested GPU type. - :raises ModelNotFound: The given Model could not be found. - :raises ThreadCountTooHigh: The specified thread count exceeds the maximum allowed value. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/liveDeployments", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.CreateLiveDeploymentRequest( - deployment_type=deployment_type, - runtime_configuration=runtime_configuration, - ), - response_type=models_models.LiveDeployment, - request_timeout=request_timeout, - throwable_errors={ - "CreateLiveDeploymentPermissionDenied": models_errors.CreateLiveDeploymentPermissionDenied, - "GpuTypeNotAvailable": models_errors.GpuTypeNotAvailable, - "InvalidGpuCount": models_errors.InvalidGpuCount, - "ModelNotFound": models_errors.ModelNotFound, - "ThreadCountTooHigh": models_errors.ThreadCountTooHigh, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - live_deployment_rid: models_models.LiveDeploymentRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.LiveDeployment]: - """ - Retrieves a live deployment by its Resource Identifier (RID), including its deployed model version and runtime configuration. - - :param live_deployment_rid: - :type live_deployment_rid: LiveDeploymentRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.LiveDeployment] - - :raises LiveDeploymentNotFound: The specified live deployment was not found. - :raises UnsupportedLiveDeployment: The Live Deployment type is not supported by the API. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/liveDeployments/{liveDeploymentRid}", - query_params={ - "preview": preview, - }, - path_params={ - "liveDeploymentRid": live_deployment_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.LiveDeployment, - request_timeout=request_timeout, - throwable_errors={ - "LiveDeploymentNotFound": models_errors.LiveDeploymentNotFound, - "UnsupportedLiveDeployment": models_errors.UnsupportedLiveDeployment, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def replace( - self, - live_deployment_rid: models_models.LiveDeploymentRid, - *, - runtime_configuration: models_models.LiveDeploymentRuntimeConfiguration, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.LiveDeployment]: - """ - Updates the runtime configuration of the live deployment. The deployment will apply the new configuration to the running replicas. - - :param live_deployment_rid: - :type live_deployment_rid: LiveDeploymentRid - :param runtime_configuration: The compute resource configuration for the deployment. - :type runtime_configuration: LiveDeploymentRuntimeConfiguration - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.LiveDeployment] - - :raises GpuTypeNotAvailable: The requested GPU type is not available. Use a GPU type that is available in the deployment's resource queue. - :raises InvalidGpuCount: The GPU count is invalid. The GPU count must be between 1 and the maximum allowed for the requested GPU type. - :raises LiveDeploymentNotFound: The specified live deployment was not found. - :raises ReplaceLiveDeploymentPermissionDenied: Could not replace the LiveDeployment. - :raises ThreadCountTooHigh: The specified thread count exceeds the maximum allowed value. - :raises UnsupportedLiveDeployment: The Live Deployment type is not supported by the API. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="PUT", - resource_path="/v2/models/liveDeployments/{liveDeploymentRid}", - query_params={ - "preview": preview, - }, - path_params={ - "liveDeploymentRid": live_deployment_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.ReplaceLiveDeploymentRequest( - runtime_configuration=runtime_configuration, - ), - response_type=models_models.LiveDeployment, - request_timeout=request_timeout, - throwable_errors={ - "GpuTypeNotAvailable": models_errors.GpuTypeNotAvailable, - "InvalidGpuCount": models_errors.InvalidGpuCount, - "LiveDeploymentNotFound": models_errors.LiveDeploymentNotFound, - "ReplaceLiveDeploymentPermissionDenied": models_errors.ReplaceLiveDeploymentPermissionDenied, - "ThreadCountTooHigh": models_errors.ThreadCountTooHigh, - "UnsupportedLiveDeployment": models_errors.UnsupportedLiveDeployment, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def transform_json( - self, - live_deployment_rid: models_models.LiveDeploymentRid, - *, - input: typing.Dict[str, typing.Any], - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.TransformLiveDeploymentResponse]: - """ - Performs inference on the live deployment. - - :param live_deployment_rid: - :type live_deployment_rid: LiveDeploymentRid - :param input: The input data for the model inference. The structure should match the model's transform API specification, where each key is an input name and the value is the corresponding input data. - :type input: Dict[str, Any] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.TransformLiveDeploymentResponse] - - :raises InferenceFailure: The inference request failed due to a model execution error or unexpected internal issue. This typically indicates a problem with the model itself rather than the input data. - :raises InferenceInvalidInput: The inference request contains invalid input data that does not match the model's API specification. Check the error type for specific validation failure details. - :raises InferenceTimeout: The live deployment took longer than 5 minutes to respond to the inference request. This typically indicates the model execution is taking too long or the deployment is under heavy load. - :raises LiveDeploymentNotFound: The specified live deployment was not found. - :raises TransformJsonLiveDeploymentPermissionDenied: Could not transformJson the LiveDeployment. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/liveDeployments/{liveDeploymentRid}/transformJson", - query_params={ - "preview": preview, - }, - path_params={ - "liveDeploymentRid": live_deployment_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.TransformJsonLiveDeploymentRequest( - input=input, - ), - response_type=models_models.TransformLiveDeploymentResponse, - request_timeout=request_timeout, - throwable_errors={ - "InferenceFailure": models_errors.InferenceFailure, - "InferenceInvalidInput": models_errors.InferenceInvalidInput, - "InferenceTimeout": models_errors.InferenceTimeout, - "LiveDeploymentNotFound": models_errors.LiveDeploymentNotFound, - "TransformJsonLiveDeploymentPermissionDenied": models_errors.TransformJsonLiveDeploymentPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _AsyncLiveDeploymentClientRaw: - def __init__(self, client: AsyncLiveDeploymentClient) -> None: - def create(_: models_models.LiveDeployment): ... - def get(_: models_models.LiveDeployment): ... - def replace(_: models_models.LiveDeployment): ... - def transform_json(_: models_models.TransformLiveDeploymentResponse): ... - - self.create = core.async_with_raw_response(create, client.create) - self.get = core.async_with_raw_response(get, client.get) - self.replace = core.async_with_raw_response(replace, client.replace) - self.transform_json = core.async_with_raw_response(transform_json, client.transform_json) - - -class _AsyncLiveDeploymentClientStreaming: - def __init__(self, client: AsyncLiveDeploymentClient) -> None: - def create(_: models_models.LiveDeployment): ... - def get(_: models_models.LiveDeployment): ... - def replace(_: models_models.LiveDeployment): ... - def transform_json(_: models_models.TransformLiveDeploymentResponse): ... - - self.create = core.async_with_streaming_response(create, client.create) - self.get = core.async_with_streaming_response(get, client.get) - self.replace = core.async_with_streaming_response(replace, client.replace) - self.transform_json = core.async_with_streaming_response( - transform_json, client.transform_json - ) diff --git a/foundry_sdk/v2/models/model.py b/foundry_sdk/v2/models/model.py index bd668e01d..ab16cc6a2 100644 --- a/foundry_sdk/v2/models/model.py +++ b/foundry_sdk/v2/models/model.py @@ -22,7 +22,6 @@ from foundry_sdk import _core as core from foundry_sdk import _errors as errors from foundry_sdk.v2.core import models as core_models -from foundry_sdk.v2.filesystem import errors as filesystem_errors from foundry_sdk.v2.filesystem import models as filesystem_models from foundry_sdk.v2.models import errors as models_errors from foundry_sdk.v2.models import models as models_models @@ -57,16 +56,6 @@ def __init__( self.with_streaming_response = _ModelClientStreaming(self) self.with_raw_response = _ModelClientRaw(self) - @cached_property - def Experiment(self): - from foundry_sdk.v2.models.experiment import ExperimentClient - - return ExperimentClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - @cached_property def Version(self): from foundry_sdk.v2.models.model_version import ModelVersionClient @@ -103,8 +92,6 @@ def create( :rtype: models_models.Model :raises CreateModelPermissionDenied: Could not create the Model. - :raises InvalidDisplayName: The display name of a Resource should not be exactly `.` or `..`, contain a forward slash `/` and must be less than or equal to 700 characters. - :raises ResourceNameAlreadyExists: The provided resource name is already in use by another resource in the same folder. """ return self._api_client.call_api( @@ -127,8 +114,6 @@ def create( request_timeout=request_timeout, throwable_errors={ "CreateModelPermissionDenied": models_errors.CreateModelPermissionDenied, - "InvalidDisplayName": filesystem_errors.InvalidDisplayName, - "ResourceNameAlreadyExists": filesystem_errors.ResourceNameAlreadyExists, }, response_mode=_sdk_internal.get("response_mode"), ), @@ -182,92 +167,23 @@ def get( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def promote_version( - self, - model_rid: models_models.ModelRid, - *, - source_model_version_rid: models_models.ModelVersionRid, - branch: typing.Optional[core_models.BranchName] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.ModelVersion: - """ - Promotes an existing Model Version to the target Model. The promoted Model Version will be copied to the target Model as the latest version on the specified branch, but will have a new Model Version RID. - - :param model_rid: - :type model_rid: ModelRid - :param source_model_version_rid: - :type source_model_version_rid: ModelVersionRid - :param branch: The branch to promote the version to. Defaults to master on most enrollments. - :type branch: Optional[BranchName] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.ModelVersion - - :raises ModelNotFound: The given Model could not be found. - :raises ModelVersionNotFound: The given ModelVersion could not be found. - :raises PromoteVersionModelPermissionDenied: Could not promoteVersion the Model. - :raises UnsupportedModelSource: The Model Version has a source type that is not supported by the API. This can occur when the model was created through a legacy or internal workflow that is not exposed through the public API. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/{modelRid}/promoteVersion", - query_params={ - "preview": preview, - }, - path_params={ - "modelRid": model_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.PromoteVersionModelRequest( - source_model_version_rid=source_model_version_rid, - branch=branch, - ), - response_type=models_models.ModelVersion, - request_timeout=request_timeout, - throwable_errors={ - "ModelNotFound": models_errors.ModelNotFound, - "ModelVersionNotFound": models_errors.ModelVersionNotFound, - "PromoteVersionModelPermissionDenied": models_errors.PromoteVersionModelPermissionDenied, - "UnsupportedModelSource": models_errors.UnsupportedModelSource, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _ModelClientRaw: def __init__(self, client: ModelClient) -> None: def create(_: models_models.Model): ... def get(_: models_models.Model): ... - def promote_version(_: models_models.ModelVersion): ... self.create = core.with_raw_response(create, client.create) self.get = core.with_raw_response(get, client.get) - self.promote_version = core.with_raw_response(promote_version, client.promote_version) class _ModelClientStreaming: def __init__(self, client: ModelClient) -> None: def create(_: models_models.Model): ... def get(_: models_models.Model): ... - def promote_version(_: models_models.ModelVersion): ... self.create = core.with_streaming_response(create, client.create) self.get = core.with_streaming_response(get, client.get) - self.promote_version = core.with_streaming_response(promote_version, client.promote_version) class AsyncModelClient: @@ -299,16 +215,6 @@ def __init__( self.with_streaming_response = _AsyncModelClientStreaming(self) self.with_raw_response = _AsyncModelClientRaw(self) - @cached_property - def Experiment(self): - from foundry_sdk.v2.models.experiment import AsyncExperimentClient - - return AsyncExperimentClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - @cached_property def Version(self): from foundry_sdk.v2.models.model_version import AsyncModelVersionClient @@ -345,8 +251,6 @@ def create( :rtype: typing.Awaitable[models_models.Model] :raises CreateModelPermissionDenied: Could not create the Model. - :raises InvalidDisplayName: The display name of a Resource should not be exactly `.` or `..`, contain a forward slash `/` and must be less than or equal to 700 characters. - :raises ResourceNameAlreadyExists: The provided resource name is already in use by another resource in the same folder. """ return self._api_client.call_api( @@ -369,8 +273,6 @@ def create( request_timeout=request_timeout, throwable_errors={ "CreateModelPermissionDenied": models_errors.CreateModelPermissionDenied, - "InvalidDisplayName": filesystem_errors.InvalidDisplayName, - "ResourceNameAlreadyExists": filesystem_errors.ResourceNameAlreadyExists, }, response_mode=_sdk_internal.get("response_mode"), ), @@ -424,91 +326,20 @@ def get( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def promote_version( - self, - model_rid: models_models.ModelRid, - *, - source_model_version_rid: models_models.ModelVersionRid, - branch: typing.Optional[core_models.BranchName] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.ModelVersion]: - """ - Promotes an existing Model Version to the target Model. The promoted Model Version will be copied to the target Model as the latest version on the specified branch, but will have a new Model Version RID. - - :param model_rid: - :type model_rid: ModelRid - :param source_model_version_rid: - :type source_model_version_rid: ModelVersionRid - :param branch: The branch to promote the version to. Defaults to master on most enrollments. - :type branch: Optional[BranchName] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.ModelVersion] - - :raises ModelNotFound: The given Model could not be found. - :raises ModelVersionNotFound: The given ModelVersion could not be found. - :raises PromoteVersionModelPermissionDenied: Could not promoteVersion the Model. - :raises UnsupportedModelSource: The Model Version has a source type that is not supported by the API. This can occur when the model was created through a legacy or internal workflow that is not exposed through the public API. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/{modelRid}/promoteVersion", - query_params={ - "preview": preview, - }, - path_params={ - "modelRid": model_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.PromoteVersionModelRequest( - source_model_version_rid=source_model_version_rid, - branch=branch, - ), - response_type=models_models.ModelVersion, - request_timeout=request_timeout, - throwable_errors={ - "ModelNotFound": models_errors.ModelNotFound, - "ModelVersionNotFound": models_errors.ModelVersionNotFound, - "PromoteVersionModelPermissionDenied": models_errors.PromoteVersionModelPermissionDenied, - "UnsupportedModelSource": models_errors.UnsupportedModelSource, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _AsyncModelClientRaw: def __init__(self, client: AsyncModelClient) -> None: def create(_: models_models.Model): ... def get(_: models_models.Model): ... - def promote_version(_: models_models.ModelVersion): ... self.create = core.async_with_raw_response(create, client.create) self.get = core.async_with_raw_response(get, client.get) - self.promote_version = core.async_with_raw_response(promote_version, client.promote_version) class _AsyncModelClientStreaming: def __init__(self, client: AsyncModelClient) -> None: def create(_: models_models.Model): ... def get(_: models_models.Model): ... - def promote_version(_: models_models.ModelVersion): ... self.create = core.async_with_streaming_response(create, client.create) self.get = core.async_with_streaming_response(get, client.get) - self.promote_version = core.async_with_streaming_response( - promote_version, client.promote_version - ) diff --git a/foundry_sdk/v2/models/model_function.py b/foundry_sdk/v2/models/model_function.py deleted file mode 100644 index c24de5b92..000000000 --- a/foundry_sdk/v2/models/model_function.py +++ /dev/null @@ -1,546 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.core import models as core_models -from foundry_sdk.v2.models import errors as models_errors -from foundry_sdk.v2.models import models as models_models -from foundry_sdk.v2.ontologies import models as ontologies_models - - -class ModelFunctionClient: - """ - The API client for the ModelFunction Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _ModelFunctionClientStreaming(self) - self.with_raw_response = _ModelFunctionClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def create( - self, - live_deployment_rid: models_models.LiveDeploymentRid, - *, - api_name: models_models.ModelFunctionApiName, - display_name: models_models.ModelFunctionDisplayName, - is_row_wise: models_models.ModelFunctionIsRowWise, - ontology_binding: typing.Optional[ontologies_models.OntologyRid] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.ModelFunction: - """ - Creates a function for the live deployment. - :param live_deployment_rid: - :type live_deployment_rid: LiveDeploymentRid - :param api_name: - :type api_name: ModelFunctionApiName - :param display_name: - :type display_name: ModelFunctionDisplayName - :param is_row_wise: - :type is_row_wise: ModelFunctionIsRowWise - :param ontology_binding: - :type ontology_binding: Optional[OntologyRid] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.ModelFunction - - :raises CreateModelFunctionPermissionDenied: Could not create the ModelFunction. - :raises FunctionAlreadyExists: A function already exists for this live deployment. - :raises InvalidFunctionApiName: The provided API name for the function is invalid. - :raises LiveDeploymentNotFound: The specified live deployment was not found. - :raises ModelApiTypeUnsupportedForFunction: The model API contains a data type that is not supported for Ontology function creation. - :raises OntologyBindingRequired: An ontologyBinding is required when creating or replacing a model function. - :raises OntologyNotFound: The specified ontology was not found. - :raises UnsupportedLiveDeployment: The Live Deployment type is not supported by the API. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/liveDeployments/{liveDeploymentRid}/function", - query_params={ - "preview": preview, - }, - path_params={ - "liveDeploymentRid": live_deployment_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.CreateModelFunctionRequest( - api_name=api_name, - ontology_binding=ontology_binding, - is_row_wise=is_row_wise, - display_name=display_name, - ), - response_type=models_models.ModelFunction, - request_timeout=request_timeout, - throwable_errors={ - "CreateModelFunctionPermissionDenied": models_errors.CreateModelFunctionPermissionDenied, - "FunctionAlreadyExists": models_errors.FunctionAlreadyExists, - "InvalidFunctionApiName": models_errors.InvalidFunctionApiName, - "LiveDeploymentNotFound": models_errors.LiveDeploymentNotFound, - "ModelApiTypeUnsupportedForFunction": models_errors.ModelApiTypeUnsupportedForFunction, - "OntologyBindingRequired": models_errors.OntologyBindingRequired, - "OntologyNotFound": models_errors.OntologyNotFound, - "UnsupportedLiveDeployment": models_errors.UnsupportedLiveDeployment, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - live_deployment_rid: models_models.LiveDeploymentRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.ModelFunction: - """ - Gets the function for the live deployment. - :param live_deployment_rid: - :type live_deployment_rid: LiveDeploymentRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.ModelFunction - - :raises LiveDeploymentNotFound: The specified live deployment was not found. - :raises ModelFunctionNotFound: The given ModelFunction could not be found. - :raises UnsupportedLiveDeployment: The Live Deployment type is not supported by the API. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/liveDeployments/{liveDeploymentRid}/function", - query_params={ - "preview": preview, - }, - path_params={ - "liveDeploymentRid": live_deployment_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ModelFunction, - request_timeout=request_timeout, - throwable_errors={ - "LiveDeploymentNotFound": models_errors.LiveDeploymentNotFound, - "ModelFunctionNotFound": models_errors.ModelFunctionNotFound, - "UnsupportedLiveDeployment": models_errors.UnsupportedLiveDeployment, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def replace( - self, - live_deployment_rid: models_models.LiveDeploymentRid, - *, - api_name: models_models.ModelFunctionApiName, - is_row_wise: models_models.ModelFunctionIsRowWise, - ontology_binding: typing.Optional[ontologies_models.OntologyRid] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.ModelFunction: - """ - Replaces the function for the live deployment. - :param live_deployment_rid: - :type live_deployment_rid: LiveDeploymentRid - :param api_name: - :type api_name: ModelFunctionApiName - :param is_row_wise: - :type is_row_wise: ModelFunctionIsRowWise - :param ontology_binding: - :type ontology_binding: Optional[OntologyRid] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.ModelFunction - - :raises InvalidFunctionApiName: The provided API name for the function is invalid. - :raises LiveDeploymentNotFound: The specified live deployment was not found. - :raises ModelApiTypeUnsupportedForFunction: The model API contains a data type that is not supported for Ontology function creation. - :raises ModelFunctionNotFound: The given ModelFunction could not be found. - :raises OntologyBindingRequired: An ontologyBinding is required when creating or replacing a model function. - :raises OntologyNotFound: The specified ontology was not found. - :raises ReplaceModelFunctionPermissionDenied: Could not replace the ModelFunction. - :raises UnsupportedLiveDeployment: The Live Deployment type is not supported by the API. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="PUT", - resource_path="/v2/models/liveDeployments/{liveDeploymentRid}/function", - query_params={ - "preview": preview, - }, - path_params={ - "liveDeploymentRid": live_deployment_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.ReplaceModelFunctionRequest( - api_name=api_name, - ontology_binding=ontology_binding, - is_row_wise=is_row_wise, - ), - response_type=models_models.ModelFunction, - request_timeout=request_timeout, - throwable_errors={ - "InvalidFunctionApiName": models_errors.InvalidFunctionApiName, - "LiveDeploymentNotFound": models_errors.LiveDeploymentNotFound, - "ModelApiTypeUnsupportedForFunction": models_errors.ModelApiTypeUnsupportedForFunction, - "ModelFunctionNotFound": models_errors.ModelFunctionNotFound, - "OntologyBindingRequired": models_errors.OntologyBindingRequired, - "OntologyNotFound": models_errors.OntologyNotFound, - "ReplaceModelFunctionPermissionDenied": models_errors.ReplaceModelFunctionPermissionDenied, - "UnsupportedLiveDeployment": models_errors.UnsupportedLiveDeployment, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _ModelFunctionClientRaw: - def __init__(self, client: ModelFunctionClient) -> None: - def create(_: models_models.ModelFunction): ... - def get(_: models_models.ModelFunction): ... - def replace(_: models_models.ModelFunction): ... - - self.create = core.with_raw_response(create, client.create) - self.get = core.with_raw_response(get, client.get) - self.replace = core.with_raw_response(replace, client.replace) - - -class _ModelFunctionClientStreaming: - def __init__(self, client: ModelFunctionClient) -> None: - def create(_: models_models.ModelFunction): ... - def get(_: models_models.ModelFunction): ... - def replace(_: models_models.ModelFunction): ... - - self.create = core.with_streaming_response(create, client.create) - self.get = core.with_streaming_response(get, client.get) - self.replace = core.with_streaming_response(replace, client.replace) - - -class AsyncModelFunctionClient: - """ - The API client for the ModelFunction Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncModelFunctionClientStreaming(self) - self.with_raw_response = _AsyncModelFunctionClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def create( - self, - live_deployment_rid: models_models.LiveDeploymentRid, - *, - api_name: models_models.ModelFunctionApiName, - display_name: models_models.ModelFunctionDisplayName, - is_row_wise: models_models.ModelFunctionIsRowWise, - ontology_binding: typing.Optional[ontologies_models.OntologyRid] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.ModelFunction]: - """ - Creates a function for the live deployment. - :param live_deployment_rid: - :type live_deployment_rid: LiveDeploymentRid - :param api_name: - :type api_name: ModelFunctionApiName - :param display_name: - :type display_name: ModelFunctionDisplayName - :param is_row_wise: - :type is_row_wise: ModelFunctionIsRowWise - :param ontology_binding: - :type ontology_binding: Optional[OntologyRid] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.ModelFunction] - - :raises CreateModelFunctionPermissionDenied: Could not create the ModelFunction. - :raises FunctionAlreadyExists: A function already exists for this live deployment. - :raises InvalidFunctionApiName: The provided API name for the function is invalid. - :raises LiveDeploymentNotFound: The specified live deployment was not found. - :raises ModelApiTypeUnsupportedForFunction: The model API contains a data type that is not supported for Ontology function creation. - :raises OntologyBindingRequired: An ontologyBinding is required when creating or replacing a model function. - :raises OntologyNotFound: The specified ontology was not found. - :raises UnsupportedLiveDeployment: The Live Deployment type is not supported by the API. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/liveDeployments/{liveDeploymentRid}/function", - query_params={ - "preview": preview, - }, - path_params={ - "liveDeploymentRid": live_deployment_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.CreateModelFunctionRequest( - api_name=api_name, - ontology_binding=ontology_binding, - is_row_wise=is_row_wise, - display_name=display_name, - ), - response_type=models_models.ModelFunction, - request_timeout=request_timeout, - throwable_errors={ - "CreateModelFunctionPermissionDenied": models_errors.CreateModelFunctionPermissionDenied, - "FunctionAlreadyExists": models_errors.FunctionAlreadyExists, - "InvalidFunctionApiName": models_errors.InvalidFunctionApiName, - "LiveDeploymentNotFound": models_errors.LiveDeploymentNotFound, - "ModelApiTypeUnsupportedForFunction": models_errors.ModelApiTypeUnsupportedForFunction, - "OntologyBindingRequired": models_errors.OntologyBindingRequired, - "OntologyNotFound": models_errors.OntologyNotFound, - "UnsupportedLiveDeployment": models_errors.UnsupportedLiveDeployment, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - live_deployment_rid: models_models.LiveDeploymentRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.ModelFunction]: - """ - Gets the function for the live deployment. - :param live_deployment_rid: - :type live_deployment_rid: LiveDeploymentRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.ModelFunction] - - :raises LiveDeploymentNotFound: The specified live deployment was not found. - :raises ModelFunctionNotFound: The given ModelFunction could not be found. - :raises UnsupportedLiveDeployment: The Live Deployment type is not supported by the API. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/liveDeployments/{liveDeploymentRid}/function", - query_params={ - "preview": preview, - }, - path_params={ - "liveDeploymentRid": live_deployment_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ModelFunction, - request_timeout=request_timeout, - throwable_errors={ - "LiveDeploymentNotFound": models_errors.LiveDeploymentNotFound, - "ModelFunctionNotFound": models_errors.ModelFunctionNotFound, - "UnsupportedLiveDeployment": models_errors.UnsupportedLiveDeployment, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def replace( - self, - live_deployment_rid: models_models.LiveDeploymentRid, - *, - api_name: models_models.ModelFunctionApiName, - is_row_wise: models_models.ModelFunctionIsRowWise, - ontology_binding: typing.Optional[ontologies_models.OntologyRid] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.ModelFunction]: - """ - Replaces the function for the live deployment. - :param live_deployment_rid: - :type live_deployment_rid: LiveDeploymentRid - :param api_name: - :type api_name: ModelFunctionApiName - :param is_row_wise: - :type is_row_wise: ModelFunctionIsRowWise - :param ontology_binding: - :type ontology_binding: Optional[OntologyRid] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.ModelFunction] - - :raises InvalidFunctionApiName: The provided API name for the function is invalid. - :raises LiveDeploymentNotFound: The specified live deployment was not found. - :raises ModelApiTypeUnsupportedForFunction: The model API contains a data type that is not supported for Ontology function creation. - :raises ModelFunctionNotFound: The given ModelFunction could not be found. - :raises OntologyBindingRequired: An ontologyBinding is required when creating or replacing a model function. - :raises OntologyNotFound: The specified ontology was not found. - :raises ReplaceModelFunctionPermissionDenied: Could not replace the ModelFunction. - :raises UnsupportedLiveDeployment: The Live Deployment type is not supported by the API. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="PUT", - resource_path="/v2/models/liveDeployments/{liveDeploymentRid}/function", - query_params={ - "preview": preview, - }, - path_params={ - "liveDeploymentRid": live_deployment_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.ReplaceModelFunctionRequest( - api_name=api_name, - ontology_binding=ontology_binding, - is_row_wise=is_row_wise, - ), - response_type=models_models.ModelFunction, - request_timeout=request_timeout, - throwable_errors={ - "InvalidFunctionApiName": models_errors.InvalidFunctionApiName, - "LiveDeploymentNotFound": models_errors.LiveDeploymentNotFound, - "ModelApiTypeUnsupportedForFunction": models_errors.ModelApiTypeUnsupportedForFunction, - "ModelFunctionNotFound": models_errors.ModelFunctionNotFound, - "OntologyBindingRequired": models_errors.OntologyBindingRequired, - "OntologyNotFound": models_errors.OntologyNotFound, - "ReplaceModelFunctionPermissionDenied": models_errors.ReplaceModelFunctionPermissionDenied, - "UnsupportedLiveDeployment": models_errors.UnsupportedLiveDeployment, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _AsyncModelFunctionClientRaw: - def __init__(self, client: AsyncModelFunctionClient) -> None: - def create(_: models_models.ModelFunction): ... - def get(_: models_models.ModelFunction): ... - def replace(_: models_models.ModelFunction): ... - - self.create = core.async_with_raw_response(create, client.create) - self.get = core.async_with_raw_response(get, client.get) - self.replace = core.async_with_raw_response(replace, client.replace) - - -class _AsyncModelFunctionClientStreaming: - def __init__(self, client: AsyncModelFunctionClient) -> None: - def create(_: models_models.ModelFunction): ... - def get(_: models_models.ModelFunction): ... - def replace(_: models_models.ModelFunction): ... - - self.create = core.async_with_streaming_response(create, client.create) - self.get = core.async_with_streaming_response(get, client.get) - self.replace = core.async_with_streaming_response(replace, client.replace) diff --git a/foundry_sdk/v2/models/model_studio.py b/foundry_sdk/v2/models/model_studio.py deleted file mode 100644 index 0eb98bfb8..000000000 --- a/foundry_sdk/v2/models/model_studio.py +++ /dev/null @@ -1,490 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing -from functools import cached_property - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.core import models as core_models -from foundry_sdk.v2.filesystem import errors as filesystem_errors -from foundry_sdk.v2.filesystem import models as filesystem_models -from foundry_sdk.v2.models import errors as models_errors -from foundry_sdk.v2.models import models as models_models - - -class ModelStudioClient: - """ - The API client for the ModelStudio Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _ModelStudioClientStreaming(self) - self.with_raw_response = _ModelStudioClientRaw(self) - - @cached_property - def Run(self): - from foundry_sdk.v2.models.model_studio_run import ModelStudioRunClient - - return ModelStudioRunClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - - @cached_property - def ConfigVersion(self): - from foundry_sdk.v2.models.model_studio_config_version import ( - ModelStudioConfigVersionClient, - ) # NOQA - - return ModelStudioConfigVersionClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def create( - self, - *, - name: str, - parent_folder_rid: filesystem_models.FolderRid, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.ModelStudio: - """ - Creates a new Model Studio. - :param name: The name of the Model Studio. - :type name: str - :param parent_folder_rid: The RID of the parent folder where the studio will be created. - :type parent_folder_rid: FolderRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.ModelStudio - - :raises CreateModelStudioPermissionDenied: Permission denied to create a Model Studio. - :raises InvalidDisplayName: The display name of a Resource should not be exactly `.` or `..`, contain a forward slash `/` and must be less than or equal to 700 characters. - :raises InvalidModelStudioCreateRequest: The request to create a Model Studio contains invalid arguments. - :raises ResourceNameAlreadyExists: The provided resource name is already in use by another resource in the same folder. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/modelStudios", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.CreateModelStudioRequest( - name=name, - parent_folder_rid=parent_folder_rid, - ), - response_type=models_models.ModelStudio, - request_timeout=request_timeout, - throwable_errors={ - "CreateModelStudioPermissionDenied": models_errors.CreateModelStudioPermissionDenied, - "InvalidDisplayName": filesystem_errors.InvalidDisplayName, - "InvalidModelStudioCreateRequest": models_errors.InvalidModelStudioCreateRequest, - "ResourceNameAlreadyExists": filesystem_errors.ResourceNameAlreadyExists, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - model_studio_rid: models_models.ModelStudioRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.ModelStudio: - """ - Gets details about a Model Studio by its RID. - :param model_studio_rid: - :type model_studio_rid: ModelStudioRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.ModelStudio - - :raises ModelStudioNotFound: The requested Model Studio was not found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/modelStudios/{modelStudioRid}", - query_params={ - "preview": preview, - }, - path_params={ - "modelStudioRid": model_studio_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ModelStudio, - request_timeout=request_timeout, - throwable_errors={ - "ModelStudioNotFound": models_errors.ModelStudioNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def launch( - self, - model_studio_rid: models_models.ModelStudioRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.ModelStudioRun: - """ - Launches a new training run for the Model Studio using the latest configuration version. - :param model_studio_rid: - :type model_studio_rid: ModelStudioRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.ModelStudioRun - - :raises LaunchModelStudioPermissionDenied: Permission denied to launch a Model Studio run. - :raises ModelStudioNotFound: The requested Model Studio was not found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/modelStudios/{modelStudioRid}/launch", - query_params={ - "preview": preview, - }, - path_params={ - "modelStudioRid": model_studio_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ModelStudioRun, - request_timeout=request_timeout, - throwable_errors={ - "LaunchModelStudioPermissionDenied": models_errors.LaunchModelStudioPermissionDenied, - "ModelStudioNotFound": models_errors.ModelStudioNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _ModelStudioClientRaw: - def __init__(self, client: ModelStudioClient) -> None: - def create(_: models_models.ModelStudio): ... - def get(_: models_models.ModelStudio): ... - def launch(_: models_models.ModelStudioRun): ... - - self.create = core.with_raw_response(create, client.create) - self.get = core.with_raw_response(get, client.get) - self.launch = core.with_raw_response(launch, client.launch) - - -class _ModelStudioClientStreaming: - def __init__(self, client: ModelStudioClient) -> None: - def create(_: models_models.ModelStudio): ... - def get(_: models_models.ModelStudio): ... - def launch(_: models_models.ModelStudioRun): ... - - self.create = core.with_streaming_response(create, client.create) - self.get = core.with_streaming_response(get, client.get) - self.launch = core.with_streaming_response(launch, client.launch) - - -class AsyncModelStudioClient: - """ - The API client for the ModelStudio Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncModelStudioClientStreaming(self) - self.with_raw_response = _AsyncModelStudioClientRaw(self) - - @cached_property - def Run(self): - from foundry_sdk.v2.models.model_studio_run import AsyncModelStudioRunClient - - return AsyncModelStudioRunClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - - @cached_property - def ConfigVersion(self): - from foundry_sdk.v2.models.model_studio_config_version import ( - AsyncModelStudioConfigVersionClient, - ) # NOQA - - return AsyncModelStudioConfigVersionClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def create( - self, - *, - name: str, - parent_folder_rid: filesystem_models.FolderRid, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.ModelStudio]: - """ - Creates a new Model Studio. - :param name: The name of the Model Studio. - :type name: str - :param parent_folder_rid: The RID of the parent folder where the studio will be created. - :type parent_folder_rid: FolderRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.ModelStudio] - - :raises CreateModelStudioPermissionDenied: Permission denied to create a Model Studio. - :raises InvalidDisplayName: The display name of a Resource should not be exactly `.` or `..`, contain a forward slash `/` and must be less than or equal to 700 characters. - :raises InvalidModelStudioCreateRequest: The request to create a Model Studio contains invalid arguments. - :raises ResourceNameAlreadyExists: The provided resource name is already in use by another resource in the same folder. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/modelStudios", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.CreateModelStudioRequest( - name=name, - parent_folder_rid=parent_folder_rid, - ), - response_type=models_models.ModelStudio, - request_timeout=request_timeout, - throwable_errors={ - "CreateModelStudioPermissionDenied": models_errors.CreateModelStudioPermissionDenied, - "InvalidDisplayName": filesystem_errors.InvalidDisplayName, - "InvalidModelStudioCreateRequest": models_errors.InvalidModelStudioCreateRequest, - "ResourceNameAlreadyExists": filesystem_errors.ResourceNameAlreadyExists, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - model_studio_rid: models_models.ModelStudioRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.ModelStudio]: - """ - Gets details about a Model Studio by its RID. - :param model_studio_rid: - :type model_studio_rid: ModelStudioRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.ModelStudio] - - :raises ModelStudioNotFound: The requested Model Studio was not found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/modelStudios/{modelStudioRid}", - query_params={ - "preview": preview, - }, - path_params={ - "modelStudioRid": model_studio_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ModelStudio, - request_timeout=request_timeout, - throwable_errors={ - "ModelStudioNotFound": models_errors.ModelStudioNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def launch( - self, - model_studio_rid: models_models.ModelStudioRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.ModelStudioRun]: - """ - Launches a new training run for the Model Studio using the latest configuration version. - :param model_studio_rid: - :type model_studio_rid: ModelStudioRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.ModelStudioRun] - - :raises LaunchModelStudioPermissionDenied: Permission denied to launch a Model Studio run. - :raises ModelStudioNotFound: The requested Model Studio was not found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/modelStudios/{modelStudioRid}/launch", - query_params={ - "preview": preview, - }, - path_params={ - "modelStudioRid": model_studio_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ModelStudioRun, - request_timeout=request_timeout, - throwable_errors={ - "LaunchModelStudioPermissionDenied": models_errors.LaunchModelStudioPermissionDenied, - "ModelStudioNotFound": models_errors.ModelStudioNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _AsyncModelStudioClientRaw: - def __init__(self, client: AsyncModelStudioClient) -> None: - def create(_: models_models.ModelStudio): ... - def get(_: models_models.ModelStudio): ... - def launch(_: models_models.ModelStudioRun): ... - - self.create = core.async_with_raw_response(create, client.create) - self.get = core.async_with_raw_response(get, client.get) - self.launch = core.async_with_raw_response(launch, client.launch) - - -class _AsyncModelStudioClientStreaming: - def __init__(self, client: AsyncModelStudioClient) -> None: - def create(_: models_models.ModelStudio): ... - def get(_: models_models.ModelStudio): ... - def launch(_: models_models.ModelStudioRun): ... - - self.create = core.async_with_streaming_response(create, client.create) - self.get = core.async_with_streaming_response(get, client.get) - self.launch = core.async_with_streaming_response(launch, client.launch) diff --git a/foundry_sdk/v2/models/model_studio_config_version.py b/foundry_sdk/v2/models/model_studio_config_version.py deleted file mode 100644 index 919b562a7..000000000 --- a/foundry_sdk/v2/models/model_studio_config_version.py +++ /dev/null @@ -1,609 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.core import models as core_models -from foundry_sdk.v2.models import errors as models_errors -from foundry_sdk.v2.models import models as models_models - - -class ModelStudioConfigVersionClient: - """ - The API client for the ModelStudioConfigVersion Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _ModelStudioConfigVersionClientStreaming(self) - self.with_raw_response = _ModelStudioConfigVersionClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def create( - self, - model_studio_rid: models_models.ModelStudioRid, - *, - name: models_models.ModelStudioConfigVersionName, - resources: models_models.ResourceConfiguration, - trainer_id: models_models.TrainerId, - worker_config: models_models.ModelStudioWorkerConfig, - changelog: typing.Optional[str] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.ModelStudioConfigVersion: - """ - Creates a new Model Studio configuration version. - :param model_studio_rid: - :type model_studio_rid: ModelStudioRid - :param name: Human readable name of the configuration version and experiment. - :type name: ModelStudioConfigVersionName - :param resources: The compute resources allocated for training runs. - :type resources: ResourceConfiguration - :param trainer_id: The identifier of the trainer to use for this configuration. - :type trainer_id: TrainerId - :param worker_config: The worker configuration including inputs, outputs, and custom settings. - :type worker_config: ModelStudioWorkerConfig - :param changelog: Changelog describing changes in this version. - :type changelog: Optional[str] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.ModelStudioConfigVersion - - :raises CreateConfigValidationError: The provided configuration is invalid. - :raises CreateModelStudioConfigVersionPermissionDenied: Could not create the ModelStudioConfigVersion. - :raises ModelStudioNotFound: The requested Model Studio was not found. - :raises TrainerNotFound: The specified trainer does not exist. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/modelStudios/{modelStudioRid}/configVersions", - query_params={ - "preview": preview, - }, - path_params={ - "modelStudioRid": model_studio_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.CreateModelStudioConfigVersionRequest( - name=name, - resources=resources, - changelog=changelog, - worker_config=worker_config, - trainer_id=trainer_id, - ), - response_type=models_models.ModelStudioConfigVersion, - request_timeout=request_timeout, - throwable_errors={ - "CreateConfigValidationError": models_errors.CreateConfigValidationError, - "CreateModelStudioConfigVersionPermissionDenied": models_errors.CreateModelStudioConfigVersionPermissionDenied, - "ModelStudioNotFound": models_errors.ModelStudioNotFound, - "TrainerNotFound": models_errors.TrainerNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - model_studio_rid: models_models.ModelStudioRid, - model_studio_config_version_version: models_models.ModelStudioConfigVersionNumber, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.ModelStudioConfigVersion: - """ - Gets a specific Model Studio configuration version. - :param model_studio_rid: - :type model_studio_rid: ModelStudioRid - :param model_studio_config_version_version: The version number of this configuration. - :type model_studio_config_version_version: ModelStudioConfigVersionNumber - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.ModelStudioConfigVersion - - :raises ModelStudioConfigVersionNotFound: The requested Model Studio configuration version was not found. - :raises ModelStudioNotFound: The requested Model Studio was not found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/modelStudios/{modelStudioRid}/configVersions/{modelStudioConfigVersionVersion}", - query_params={ - "preview": preview, - }, - path_params={ - "modelStudioRid": model_studio_rid, - "modelStudioConfigVersionVersion": model_studio_config_version_version, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ModelStudioConfigVersion, - request_timeout=request_timeout, - throwable_errors={ - "ModelStudioConfigVersionNotFound": models_errors.ModelStudioConfigVersionNotFound, - "ModelStudioNotFound": models_errors.ModelStudioNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def latest( - self, - model_studio_rid: models_models.ModelStudioRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Optional[models_models.ModelStudioConfigVersion]: - """ - Gets the latest configuration version for a Model Studio. - :param model_studio_rid: - :type model_studio_rid: ModelStudioRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Optional[models_models.ModelStudioConfigVersion] - - :raises LatestModelStudioConfigVersionsPermissionDenied: Could not latest the ModelStudioConfigVersion. - :raises ModelStudioNotFound: The requested Model Studio was not found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/modelStudios/{modelStudioRid}/configVersions/latest", - query_params={ - "preview": preview, - }, - path_params={ - "modelStudioRid": model_studio_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=typing.Optional[models_models.ModelStudioConfigVersion], - request_timeout=request_timeout, - throwable_errors={ - "LatestModelStudioConfigVersionsPermissionDenied": models_errors.LatestModelStudioConfigVersionsPermissionDenied, - "ModelStudioNotFound": models_errors.ModelStudioNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def list( - self, - model_studio_rid: models_models.ModelStudioRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> core.ResourceIterator[models_models.ModelStudioConfigVersion]: - """ - Lists all configuration versions for a Model Studio. - :param model_studio_rid: - :type model_studio_rid: ModelStudioRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. - :type page_token: Optional[PageToken] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: core.ResourceIterator[models_models.ModelStudioConfigVersion] - - :raises ModelStudioNotFound: The requested Model Studio was not found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/modelStudios/{modelStudioRid}/configVersions", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "modelStudioRid": model_studio_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ListModelStudioConfigVersionsResponse, - request_timeout=request_timeout, - throwable_errors={ - "ModelStudioNotFound": models_errors.ModelStudioNotFound, - }, - response_mode=_sdk_internal.get("response_mode", "ITERATOR"), - ), - ) - - -class _ModelStudioConfigVersionClientRaw: - def __init__(self, client: ModelStudioConfigVersionClient) -> None: - def create(_: models_models.ModelStudioConfigVersion): ... - def get(_: models_models.ModelStudioConfigVersion): ... - def latest(_: typing.Optional[models_models.ModelStudioConfigVersion]): ... - def list(_: models_models.ListModelStudioConfigVersionsResponse): ... - - self.create = core.with_raw_response(create, client.create) - self.get = core.with_raw_response(get, client.get) - self.latest = core.with_raw_response(latest, client.latest) - self.list = core.with_raw_response(list, client.list) - - -class _ModelStudioConfigVersionClientStreaming: - def __init__(self, client: ModelStudioConfigVersionClient) -> None: - def create(_: models_models.ModelStudioConfigVersion): ... - def get(_: models_models.ModelStudioConfigVersion): ... - def latest(_: typing.Optional[models_models.ModelStudioConfigVersion]): ... - def list(_: models_models.ListModelStudioConfigVersionsResponse): ... - - self.create = core.with_streaming_response(create, client.create) - self.get = core.with_streaming_response(get, client.get) - self.latest = core.with_streaming_response(latest, client.latest) - self.list = core.with_streaming_response(list, client.list) - - -class AsyncModelStudioConfigVersionClient: - """ - The API client for the ModelStudioConfigVersion Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncModelStudioConfigVersionClientStreaming(self) - self.with_raw_response = _AsyncModelStudioConfigVersionClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def create( - self, - model_studio_rid: models_models.ModelStudioRid, - *, - name: models_models.ModelStudioConfigVersionName, - resources: models_models.ResourceConfiguration, - trainer_id: models_models.TrainerId, - worker_config: models_models.ModelStudioWorkerConfig, - changelog: typing.Optional[str] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.ModelStudioConfigVersion]: - """ - Creates a new Model Studio configuration version. - :param model_studio_rid: - :type model_studio_rid: ModelStudioRid - :param name: Human readable name of the configuration version and experiment. - :type name: ModelStudioConfigVersionName - :param resources: The compute resources allocated for training runs. - :type resources: ResourceConfiguration - :param trainer_id: The identifier of the trainer to use for this configuration. - :type trainer_id: TrainerId - :param worker_config: The worker configuration including inputs, outputs, and custom settings. - :type worker_config: ModelStudioWorkerConfig - :param changelog: Changelog describing changes in this version. - :type changelog: Optional[str] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.ModelStudioConfigVersion] - - :raises CreateConfigValidationError: The provided configuration is invalid. - :raises CreateModelStudioConfigVersionPermissionDenied: Could not create the ModelStudioConfigVersion. - :raises ModelStudioNotFound: The requested Model Studio was not found. - :raises TrainerNotFound: The specified trainer does not exist. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/models/modelStudios/{modelStudioRid}/configVersions", - query_params={ - "preview": preview, - }, - path_params={ - "modelStudioRid": model_studio_rid, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=models_models.CreateModelStudioConfigVersionRequest( - name=name, - resources=resources, - changelog=changelog, - worker_config=worker_config, - trainer_id=trainer_id, - ), - response_type=models_models.ModelStudioConfigVersion, - request_timeout=request_timeout, - throwable_errors={ - "CreateConfigValidationError": models_errors.CreateConfigValidationError, - "CreateModelStudioConfigVersionPermissionDenied": models_errors.CreateModelStudioConfigVersionPermissionDenied, - "ModelStudioNotFound": models_errors.ModelStudioNotFound, - "TrainerNotFound": models_errors.TrainerNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - model_studio_rid: models_models.ModelStudioRid, - model_studio_config_version_version: models_models.ModelStudioConfigVersionNumber, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.ModelStudioConfigVersion]: - """ - Gets a specific Model Studio configuration version. - :param model_studio_rid: - :type model_studio_rid: ModelStudioRid - :param model_studio_config_version_version: The version number of this configuration. - :type model_studio_config_version_version: ModelStudioConfigVersionNumber - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.ModelStudioConfigVersion] - - :raises ModelStudioConfigVersionNotFound: The requested Model Studio configuration version was not found. - :raises ModelStudioNotFound: The requested Model Studio was not found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/modelStudios/{modelStudioRid}/configVersions/{modelStudioConfigVersionVersion}", - query_params={ - "preview": preview, - }, - path_params={ - "modelStudioRid": model_studio_rid, - "modelStudioConfigVersionVersion": model_studio_config_version_version, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ModelStudioConfigVersion, - request_timeout=request_timeout, - throwable_errors={ - "ModelStudioConfigVersionNotFound": models_errors.ModelStudioConfigVersionNotFound, - "ModelStudioNotFound": models_errors.ModelStudioNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def latest( - self, - model_studio_rid: models_models.ModelStudioRid, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[typing.Optional[models_models.ModelStudioConfigVersion]]: - """ - Gets the latest configuration version for a Model Studio. - :param model_studio_rid: - :type model_studio_rid: ModelStudioRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[typing.Optional[models_models.ModelStudioConfigVersion]] - - :raises LatestModelStudioConfigVersionsPermissionDenied: Could not latest the ModelStudioConfigVersion. - :raises ModelStudioNotFound: The requested Model Studio was not found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/modelStudios/{modelStudioRid}/configVersions/latest", - query_params={ - "preview": preview, - }, - path_params={ - "modelStudioRid": model_studio_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=typing.Optional[models_models.ModelStudioConfigVersion], - request_timeout=request_timeout, - throwable_errors={ - "LatestModelStudioConfigVersionsPermissionDenied": models_errors.LatestModelStudioConfigVersionsPermissionDenied, - "ModelStudioNotFound": models_errors.ModelStudioNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def list( - self, - model_studio_rid: models_models.ModelStudioRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> core.AsyncResourceIterator[models_models.ModelStudioConfigVersion]: - """ - Lists all configuration versions for a Model Studio. - :param model_studio_rid: - :type model_studio_rid: ModelStudioRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. - :type page_token: Optional[PageToken] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: core.AsyncResourceIterator[models_models.ModelStudioConfigVersion] - - :raises ModelStudioNotFound: The requested Model Studio was not found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/modelStudios/{modelStudioRid}/configVersions", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "modelStudioRid": model_studio_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ListModelStudioConfigVersionsResponse, - request_timeout=request_timeout, - throwable_errors={ - "ModelStudioNotFound": models_errors.ModelStudioNotFound, - }, - response_mode=_sdk_internal.get("response_mode", "ITERATOR"), - ), - ) - - -class _AsyncModelStudioConfigVersionClientRaw: - def __init__(self, client: AsyncModelStudioConfigVersionClient) -> None: - def create(_: models_models.ModelStudioConfigVersion): ... - def get(_: models_models.ModelStudioConfigVersion): ... - def latest(_: typing.Optional[models_models.ModelStudioConfigVersion]): ... - def list(_: models_models.ListModelStudioConfigVersionsResponse): ... - - self.create = core.async_with_raw_response(create, client.create) - self.get = core.async_with_raw_response(get, client.get) - self.latest = core.async_with_raw_response(latest, client.latest) - self.list = core.async_with_raw_response(list, client.list) - - -class _AsyncModelStudioConfigVersionClientStreaming: - def __init__(self, client: AsyncModelStudioConfigVersionClient) -> None: - def create(_: models_models.ModelStudioConfigVersion): ... - def get(_: models_models.ModelStudioConfigVersion): ... - def latest(_: typing.Optional[models_models.ModelStudioConfigVersion]): ... - def list(_: models_models.ListModelStudioConfigVersionsResponse): ... - - self.create = core.async_with_streaming_response(create, client.create) - self.get = core.async_with_streaming_response(get, client.get) - self.latest = core.async_with_streaming_response(latest, client.latest) - self.list = core.async_with_streaming_response(list, client.list) diff --git a/foundry_sdk/v2/models/model_studio_run.py b/foundry_sdk/v2/models/model_studio_run.py deleted file mode 100644 index f92c6becb..000000000 --- a/foundry_sdk/v2/models/model_studio_run.py +++ /dev/null @@ -1,237 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.core import models as core_models -from foundry_sdk.v2.models import errors as models_errors -from foundry_sdk.v2.models import models as models_models - - -class ModelStudioRunClient: - """ - The API client for the ModelStudioRun Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _ModelStudioRunClientStreaming(self) - self.with_raw_response = _ModelStudioRunClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def list( - self, - model_studio_rid: models_models.ModelStudioRid, - *, - config_version: typing.Optional[models_models.ModelStudioConfigVersionNumber] = None, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> core.ResourceIterator[models_models.ModelStudioRun]: - """ - Lists all runs for a Model Studio. - :param model_studio_rid: - :type model_studio_rid: ModelStudioRid - :param config_version: Filter runs by configuration version. - :type config_version: Optional[ModelStudioConfigVersionNumber] - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. - :type page_token: Optional[PageToken] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: core.ResourceIterator[models_models.ModelStudioRun] - - :raises ModelStudioConfigVersionNotFound: The requested Model Studio configuration version was not found. - :raises ModelStudioNotFound: The requested Model Studio was not found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/modelStudios/{modelStudioRid}/runs", - query_params={ - "configVersion": config_version, - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "modelStudioRid": model_studio_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ListModelStudioRunsResponse, - request_timeout=request_timeout, - throwable_errors={ - "ModelStudioConfigVersionNotFound": models_errors.ModelStudioConfigVersionNotFound, - "ModelStudioNotFound": models_errors.ModelStudioNotFound, - }, - response_mode=_sdk_internal.get("response_mode", "ITERATOR"), - ), - ) - - -class _ModelStudioRunClientRaw: - def __init__(self, client: ModelStudioRunClient) -> None: - def list(_: models_models.ListModelStudioRunsResponse): ... - - self.list = core.with_raw_response(list, client.list) - - -class _ModelStudioRunClientStreaming: - def __init__(self, client: ModelStudioRunClient) -> None: - def list(_: models_models.ListModelStudioRunsResponse): ... - - self.list = core.with_streaming_response(list, client.list) - - -class AsyncModelStudioRunClient: - """ - The API client for the ModelStudioRun Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncModelStudioRunClientStreaming(self) - self.with_raw_response = _AsyncModelStudioRunClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def list( - self, - model_studio_rid: models_models.ModelStudioRid, - *, - config_version: typing.Optional[models_models.ModelStudioConfigVersionNumber] = None, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> core.AsyncResourceIterator[models_models.ModelStudioRun]: - """ - Lists all runs for a Model Studio. - :param model_studio_rid: - :type model_studio_rid: ModelStudioRid - :param config_version: Filter runs by configuration version. - :type config_version: Optional[ModelStudioConfigVersionNumber] - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. - :type page_token: Optional[PageToken] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: core.AsyncResourceIterator[models_models.ModelStudioRun] - - :raises ModelStudioConfigVersionNotFound: The requested Model Studio configuration version was not found. - :raises ModelStudioNotFound: The requested Model Studio was not found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/modelStudios/{modelStudioRid}/runs", - query_params={ - "configVersion": config_version, - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "modelStudioRid": model_studio_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ListModelStudioRunsResponse, - request_timeout=request_timeout, - throwable_errors={ - "ModelStudioConfigVersionNotFound": models_errors.ModelStudioConfigVersionNotFound, - "ModelStudioNotFound": models_errors.ModelStudioNotFound, - }, - response_mode=_sdk_internal.get("response_mode", "ITERATOR"), - ), - ) - - -class _AsyncModelStudioRunClientRaw: - def __init__(self, client: AsyncModelStudioRunClient) -> None: - def list(_: models_models.ListModelStudioRunsResponse): ... - - self.list = core.async_with_raw_response(list, client.list) - - -class _AsyncModelStudioRunClientStreaming: - def __init__(self, client: AsyncModelStudioRunClient) -> None: - def list(_: models_models.ListModelStudioRunsResponse): ... - - self.list = core.async_with_streaming_response(list, client.list) diff --git a/foundry_sdk/v2/models/model_studio_trainer.py b/foundry_sdk/v2/models/model_studio_trainer.py deleted file mode 100644 index 48e92e8e2..000000000 --- a/foundry_sdk/v2/models/model_studio_trainer.py +++ /dev/null @@ -1,307 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.core import models as core_models -from foundry_sdk.v2.models import errors as models_errors -from foundry_sdk.v2.models import models as models_models - - -class ModelStudioTrainerClient: - """ - The API client for the ModelStudioTrainer Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _ModelStudioTrainerClientStreaming(self) - self.with_raw_response = _ModelStudioTrainerClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - model_studio_trainer_trainer_id: models_models.TrainerId, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - version: typing.Optional[models_models.TrainerVersion] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.ModelStudioTrainer: - """ - Gets details about a specific trainer by its ID and optional version. - :param model_studio_trainer_trainer_id: - :type model_studio_trainer_trainer_id: TrainerId - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param version: Specific version of the trainer to retrieve. If not specified, returns the latest version. - :type version: Optional[TrainerVersion] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.ModelStudioTrainer - - :raises ModelStudioTrainerNotFound: The given ModelStudioTrainer could not be found. - :raises TrainerNotFound: The specified trainer does not exist. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/modelStudioTrainers/{modelStudioTrainerTrainerId}", - query_params={ - "preview": preview, - "version": version, - }, - path_params={ - "modelStudioTrainerTrainerId": model_studio_trainer_trainer_id, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ModelStudioTrainer, - request_timeout=request_timeout, - throwable_errors={ - "ModelStudioTrainerNotFound": models_errors.ModelStudioTrainerNotFound, - "TrainerNotFound": models_errors.TrainerNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def list( - self, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> models_models.ListModelStudioTrainersResponse: - """ - Lists all available trainers for Model Studios. - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: models_models.ListModelStudioTrainersResponse - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/modelStudioTrainers", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ListModelStudioTrainersResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _ModelStudioTrainerClientRaw: - def __init__(self, client: ModelStudioTrainerClient) -> None: - def get(_: models_models.ModelStudioTrainer): ... - def list(_: models_models.ListModelStudioTrainersResponse): ... - - self.get = core.with_raw_response(get, client.get) - self.list = core.with_raw_response(list, client.list) - - -class _ModelStudioTrainerClientStreaming: - def __init__(self, client: ModelStudioTrainerClient) -> None: - def get(_: models_models.ModelStudioTrainer): ... - def list(_: models_models.ListModelStudioTrainersResponse): ... - - self.get = core.with_streaming_response(get, client.get) - self.list = core.with_streaming_response(list, client.list) - - -class AsyncModelStudioTrainerClient: - """ - The API client for the ModelStudioTrainer Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncModelStudioTrainerClientStreaming(self) - self.with_raw_response = _AsyncModelStudioTrainerClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - model_studio_trainer_trainer_id: models_models.TrainerId, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - version: typing.Optional[models_models.TrainerVersion] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.ModelStudioTrainer]: - """ - Gets details about a specific trainer by its ID and optional version. - :param model_studio_trainer_trainer_id: - :type model_studio_trainer_trainer_id: TrainerId - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param version: Specific version of the trainer to retrieve. If not specified, returns the latest version. - :type version: Optional[TrainerVersion] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.ModelStudioTrainer] - - :raises ModelStudioTrainerNotFound: The given ModelStudioTrainer could not be found. - :raises TrainerNotFound: The specified trainer does not exist. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/modelStudioTrainers/{modelStudioTrainerTrainerId}", - query_params={ - "preview": preview, - "version": version, - }, - path_params={ - "modelStudioTrainerTrainerId": model_studio_trainer_trainer_id, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ModelStudioTrainer, - request_timeout=request_timeout, - throwable_errors={ - "ModelStudioTrainerNotFound": models_errors.ModelStudioTrainerNotFound, - "TrainerNotFound": models_errors.TrainerNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def list( - self, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[models_models.ListModelStudioTrainersResponse]: - """ - Lists all available trainers for Model Studios. - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[models_models.ListModelStudioTrainersResponse] - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/models/modelStudioTrainers", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=models_models.ListModelStudioTrainersResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _AsyncModelStudioTrainerClientRaw: - def __init__(self, client: AsyncModelStudioTrainerClient) -> None: - def get(_: models_models.ModelStudioTrainer): ... - def list(_: models_models.ListModelStudioTrainersResponse): ... - - self.get = core.async_with_raw_response(get, client.get) - self.list = core.async_with_raw_response(list, client.list) - - -class _AsyncModelStudioTrainerClientStreaming: - def __init__(self, client: AsyncModelStudioTrainerClient) -> None: - def get(_: models_models.ModelStudioTrainer): ... - def list(_: models_models.ListModelStudioTrainersResponse): ... - - self.get = core.async_with_streaming_response(get, client.get) - self.list = core.async_with_streaming_response(list, client.list) diff --git a/foundry_sdk/v2/models/model_version.py b/foundry_sdk/v2/models/model_version.py index 2881f29ee..529b7077d 100644 --- a/foundry_sdk/v2/models/model_version.py +++ b/foundry_sdk/v2/models/model_version.py @@ -88,11 +88,7 @@ def create( :return: Returns the result object. :rtype: models_models.ModelVersion - :raises CondaSolveFailureForProvidedPackages: Thrown when conda solve fails for the provided input packages. :raises CreateModelVersionPermissionDenied: Could not create the ModelVersion. - :raises InvalidModelApi: The model api failed validations - :raises ModelNotFound: The given Model could not be found. - :raises UnsupportedModelSource: The Model Version has a source type that is not supported by the API. This can occur when the model was created through a legacy or internal workflow that is not exposed through the public API. """ return self._api_client.call_api( @@ -118,11 +114,7 @@ def create( response_type=models_models.ModelVersion, request_timeout=request_timeout, throwable_errors={ - "CondaSolveFailureForProvidedPackages": models_errors.CondaSolveFailureForProvidedPackages, "CreateModelVersionPermissionDenied": models_errors.CreateModelVersionPermissionDenied, - "InvalidModelApi": models_errors.InvalidModelApi, - "ModelNotFound": models_errors.ModelNotFound, - "UnsupportedModelSource": models_errors.UnsupportedModelSource, }, response_mode=_sdk_internal.get("response_mode"), ), @@ -154,7 +146,6 @@ def get( :rtype: models_models.ModelVersion :raises ModelVersionNotFound: The given ModelVersion could not be found. - :raises UnsupportedModelSource: The Model Version has a source type that is not supported by the API. This can occur when the model was created through a legacy or internal workflow that is not exposed through the public API. """ return self._api_client.call_api( @@ -176,7 +167,6 @@ def get( request_timeout=request_timeout, throwable_errors={ "ModelVersionNotFound": models_errors.ModelVersionNotFound, - "UnsupportedModelSource": models_errors.UnsupportedModelSource, }, response_mode=_sdk_internal.get("response_mode"), ), @@ -189,7 +179,6 @@ def list( self, model_rid: models_models.ModelRid, *, - branch: typing.Optional[core_models.BranchName] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, preview: typing.Optional[core_models.PreviewMode] = None, @@ -200,8 +189,6 @@ def list( Lists all Model Versions for a given Model. :param model_rid: :type model_rid: ModelRid - :param branch: The branch to list versions from. Defaults to master on most enrollments. - :type branch: Optional[BranchName] :param page_size: The page size to use for the endpoint. :type page_size: Optional[PageSize] :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. @@ -212,9 +199,6 @@ def list( :type request_timeout: Optional[int] :return: Returns the result object. :rtype: core.ResourceIterator[models_models.ModelVersion] - - :raises ModelNotFound: The given Model could not be found. - :raises UnsupportedModelSource: The Model Version has a source type that is not supported by the API. This can occur when the model was created through a legacy or internal workflow that is not exposed through the public API. """ return self._api_client.call_api( @@ -222,7 +206,6 @@ def list( method="GET", resource_path="/v2/models/{modelRid}/versions", query_params={ - "branch": branch, "pageSize": page_size, "pageToken": page_token, "preview": preview, @@ -236,10 +219,7 @@ def list( body=None, response_type=models_models.ListModelVersionsResponse, request_timeout=request_timeout, - throwable_errors={ - "ModelNotFound": models_errors.ModelNotFound, - "UnsupportedModelSource": models_errors.UnsupportedModelSource, - }, + throwable_errors={}, response_mode=_sdk_internal.get("response_mode", "ITERATOR"), ), ) @@ -330,11 +310,7 @@ def create( :return: Returns the result object. :rtype: typing.Awaitable[models_models.ModelVersion] - :raises CondaSolveFailureForProvidedPackages: Thrown when conda solve fails for the provided input packages. :raises CreateModelVersionPermissionDenied: Could not create the ModelVersion. - :raises InvalidModelApi: The model api failed validations - :raises ModelNotFound: The given Model could not be found. - :raises UnsupportedModelSource: The Model Version has a source type that is not supported by the API. This can occur when the model was created through a legacy or internal workflow that is not exposed through the public API. """ return self._api_client.call_api( @@ -360,11 +336,7 @@ def create( response_type=models_models.ModelVersion, request_timeout=request_timeout, throwable_errors={ - "CondaSolveFailureForProvidedPackages": models_errors.CondaSolveFailureForProvidedPackages, "CreateModelVersionPermissionDenied": models_errors.CreateModelVersionPermissionDenied, - "InvalidModelApi": models_errors.InvalidModelApi, - "ModelNotFound": models_errors.ModelNotFound, - "UnsupportedModelSource": models_errors.UnsupportedModelSource, }, response_mode=_sdk_internal.get("response_mode"), ), @@ -396,7 +368,6 @@ def get( :rtype: typing.Awaitable[models_models.ModelVersion] :raises ModelVersionNotFound: The given ModelVersion could not be found. - :raises UnsupportedModelSource: The Model Version has a source type that is not supported by the API. This can occur when the model was created through a legacy or internal workflow that is not exposed through the public API. """ return self._api_client.call_api( @@ -418,7 +389,6 @@ def get( request_timeout=request_timeout, throwable_errors={ "ModelVersionNotFound": models_errors.ModelVersionNotFound, - "UnsupportedModelSource": models_errors.UnsupportedModelSource, }, response_mode=_sdk_internal.get("response_mode"), ), @@ -431,7 +401,6 @@ def list( self, model_rid: models_models.ModelRid, *, - branch: typing.Optional[core_models.BranchName] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, preview: typing.Optional[core_models.PreviewMode] = None, @@ -442,8 +411,6 @@ def list( Lists all Model Versions for a given Model. :param model_rid: :type model_rid: ModelRid - :param branch: The branch to list versions from. Defaults to master on most enrollments. - :type branch: Optional[BranchName] :param page_size: The page size to use for the endpoint. :type page_size: Optional[PageSize] :param page_token: The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. @@ -454,9 +421,6 @@ def list( :type request_timeout: Optional[int] :return: Returns the result object. :rtype: core.AsyncResourceIterator[models_models.ModelVersion] - - :raises ModelNotFound: The given Model could not be found. - :raises UnsupportedModelSource: The Model Version has a source type that is not supported by the API. This can occur when the model was created through a legacy or internal workflow that is not exposed through the public API. """ return self._api_client.call_api( @@ -464,7 +428,6 @@ def list( method="GET", resource_path="/v2/models/{modelRid}/versions", query_params={ - "branch": branch, "pageSize": page_size, "pageToken": page_token, "preview": preview, @@ -478,10 +441,7 @@ def list( body=None, response_type=models_models.ListModelVersionsResponse, request_timeout=request_timeout, - throwable_errors={ - "ModelNotFound": models_errors.ModelNotFound, - "UnsupportedModelSource": models_errors.UnsupportedModelSource, - }, + throwable_errors={}, response_mode=_sdk_internal.get("response_mode", "ITERATOR"), ), ) diff --git a/foundry_sdk/v2/models/models.py b/foundry_sdk/v2/models/models.py index 368f58f5d..6cb328c96 100644 --- a/foundry_sdk/v2/models/models.py +++ b/foundry_sdk/v2/models/models.py @@ -23,74 +23,6 @@ from foundry_sdk import _core as core from foundry_sdk.v2.core import models as core_models from foundry_sdk.v2.filesystem import models as filesystem_models -from foundry_sdk.v2.ontologies import models as ontologies_models -from foundry_sdk.v2.orchestration import models as orchestration_models - - -class BooleanParameter(core.ModelBase): - """A boolean parameter value.""" - - value: bool - type: typing.Literal["boolean"] = "boolean" - - -class ChangelogTooLongError(core.ModelBase): - """The provided changelog exceeds the maximum allowed length.""" - - max_length: int = pydantic.Field(alias=str("maxLength")) # type: ignore[literal-required] - """The maximum allowed changelog length.""" - - actual_length: int = pydantic.Field(alias=str("actualLength")) # type: ignore[literal-required] - """The actual length of the provided changelog.""" - - type: typing.Literal["changelogTooLong"] = "changelogTooLong" - - -ColumnTypeSpecId = str -"""An identifier for a column type specification.""" - - -CreateConfigValidationFailureReason = typing_extensions.Annotated[ - typing.Union[ - "JsonSchemaValidationError", - "OutputResourceInDifferentProjectError", - "OtherValidationError", - "MissingWorkerConfigOutputError", - "MissingRequiredDatasetColumnError", - "MultiplePropertiesNotAllowedForTrainerError", - "FieldValidationError", - "ChangelogTooLongError", - "UnknownColumnSpecIdInConfigColumnMappingError", - "MultipleColumnsNotAllowedForTrainerError", - "MissingWorkerConfigInputDatasetColumnMappingError", - "DatasetSchemaNotFoundError", - "MissingWorkerConfigInputError", - "MissingWorkerConfigInputObjectSetPropertyMappingError", - "OutputResourceNotFoundError", - "InvalidResourceConfigurationError", - ], - pydantic.Field(discriminator="type"), -] -"""A specific reason why configuration validation failed.""" - - -class CreateLiveDeploymentRequest(core.ModelBase): - """CreateLiveDeploymentRequest""" - - deployment_type: CreateLiveDeploymentTarget = pydantic.Field(alias=str("deploymentType")) # type: ignore[literal-required] - """The target model source for the live deployment. Determines which model and version selection strategy to use when creating the deployment.""" - - runtime_configuration: LiveDeploymentRuntimeConfiguration = pydantic.Field(alias=str("runtimeConfiguration")) # type: ignore[literal-required] - """The compute resource configuration for the deployment.""" - - -class CreateModelFunctionRequest(core.ModelBase): - """CreateModelFunctionRequest""" - - api_name: ModelFunctionApiName = pydantic.Field(alias=str("apiName")) # type: ignore[literal-required] - ontology_binding: typing.Optional[ontologies_models.OntologyRid] = pydantic.Field(alias=str("ontologyBinding"), default=None) # type: ignore[literal-required] - is_row_wise: ModelFunctionIsRowWise = pydantic.Field(alias=str("isRowWise")) # type: ignore[literal-required] - display_name: ModelFunctionDisplayName = pydantic.Field(alias=str("displayName")) # type: ignore[literal-required] class CreateModelRequest(core.ModelBase): @@ -100,35 +32,6 @@ class CreateModelRequest(core.ModelBase): parent_folder_rid: filesystem_models.FolderRid = pydantic.Field(alias=str("parentFolderRid")) # type: ignore[literal-required] -class CreateModelStudioConfigVersionRequest(core.ModelBase): - """CreateModelStudioConfigVersionRequest""" - - name: ModelStudioConfigVersionName - """Human readable name of the configuration version and experiment.""" - - resources: ResourceConfiguration - """The compute resources allocated for training runs.""" - - changelog: typing.Optional[str] = None - """Changelog describing changes in this version.""" - - worker_config: ModelStudioWorkerConfig = pydantic.Field(alias=str("workerConfig")) # type: ignore[literal-required] - """The worker configuration including inputs, outputs, and custom settings.""" - - trainer_id: TrainerId = pydantic.Field(alias=str("trainerId")) # type: ignore[literal-required] - """The identifier of the trainer to use for this configuration.""" - - -class CreateModelStudioRequest(core.ModelBase): - """CreateModelStudioRequest""" - - name: str - """The name of the Model Studio.""" - - parent_folder_rid: filesystem_models.FolderRid = pydantic.Field(alias=str("parentFolderRid")) # type: ignore[literal-required] - """The RID of the parent folder where the studio will be created.""" - - class CreateModelVersionRequest(core.ModelBase): """CreateModelVersionRequest""" @@ -138,40 +41,6 @@ class CreateModelVersionRequest(core.ModelBase): model_api: ModelApi = pydantic.Field(alias=str("modelApi")) # type: ignore[literal-required] -class DatasetInput(core.ModelBase): - """Dataset input configuration.""" - - rid: core.RID - """The RID of the input dataset.""" - - column_mapping: typing.Dict[ColumnTypeSpecId, typing.List[core_models.ColumnName]] = pydantic.Field(alias=str("columnMapping")) # type: ignore[literal-required] - """Mapping of column type spec IDs to column names.""" - - ignore_columns: typing.List[core_models.ColumnName] = pydantic.Field(alias=str("ignoreColumns")) # type: ignore[literal-required] - """Columns to ignore from the dataset.""" - - select_columns: typing.List[core_models.ColumnName] = pydantic.Field(alias=str("selectColumns")) # type: ignore[literal-required] - """Columns to select from the dataset. If empty, all columns not in ignoreColumns will be used.""" - - type: typing.Literal["dataset"] = "dataset" - - -class DatasetSchemaNotFoundError(core.ModelBase): - """A schema could not be found for the specified dataset.""" - - dataset_rid: core.RID = pydantic.Field(alias=str("datasetRid")) # type: ignore[literal-required] - """The RID of the dataset whose schema was not found.""" - - type: typing.Literal["datasetSchemaNotFound"] = "datasetSchemaNotFound" - - -class DatetimeParameter(core.ModelBase): - """A datetime parameter value.""" - - value: core.AwareDatetime - type: typing.Literal["datetime"] = "datetime" - - class DillModelFiles(core.ModelBase): """DillModelFiles""" @@ -179,274 +48,6 @@ class DillModelFiles(core.ModelBase): type: typing.Literal["dill"] = "dill" -class DirectCreateLiveDeploymentTarget(core.ModelBase): - """Creates a live deployment that tracks the latest model version on a branch.""" - - model_rid: ModelRid = pydantic.Field(alias=str("modelRid")) # type: ignore[literal-required] - branch: str - """The model branch for the deployment.""" - - type: typing.Literal["direct"] = "direct" - - -class DoubleParameter(core.ModelBase): - """A double parameter value.""" - - value: float - type: typing.Literal["double"] = "double" - - -class DoubleSeriesAggregations(core.ModelBase): - """Aggregated statistics for numeric series.""" - - min: typing.Optional[float] = None - """Minimum value in the series. Absent if the metric has not been computed.""" - - max: typing.Optional[float] = None - """Maximum value in the series. Absent if the metric has not been computed.""" - - last: typing.Optional[float] = None - """Most recent value in the series. Absent if the metric has not been computed.""" - - type: typing.Literal["double"] = "double" - - -class DoubleSeriesV1(core.ModelBase): - """A series of double values.""" - - series: typing.List[DoubleSeriesValueV1] - type: typing.Literal["doubleV1"] = "doubleV1" - - -class DoubleSeriesValueV1(core.ModelBase): - """A single double value in a series.""" - - value: float - timestamp: EpochMillis - """Milliseconds since unix time zero""" - - step: core.Long - - -EpochMillis = core.Long -""" -Milliseconds since unix time zero. This representation is used to maintain consistency with the Parquet -format. -""" - - -class Experiment(core.ModelBase): - """Experiment""" - - rid: ExperimentRid - model_rid: ModelRid = pydantic.Field(alias=str("modelRid")) # type: ignore[literal-required] - created_time: core_models.CreatedTime = pydantic.Field(alias=str("createdTime")) # type: ignore[literal-required] - created_by: core_models.CreatedBy = pydantic.Field(alias=str("createdBy")) # type: ignore[literal-required] - source: ExperimentSource - status: ExperimentStatus - status_message: typing.Optional[str] = pydantic.Field(alias=str("statusMessage"), default=None) # type: ignore[literal-required] - branch: ExperimentBranch - parameters: typing.List[Parameter] - series: typing.List[SeriesAggregations] - summary_metrics: typing.List[SummaryMetric] = pydantic.Field(alias=str("summaryMetrics")) # type: ignore[literal-required] - artifacts: typing.Dict[ExperimentArtifactName, ExperimentArtifactMetadata] - tags: typing.List[ExperimentTagText] - linked_model_version: typing.Optional[ModelVersionRid] = pydantic.Field(alias=str("linkedModelVersion"), default=None) # type: ignore[literal-required] - job_rid: typing.Optional[core_models.JobRid] = pydantic.Field(alias=str("jobRid"), default=None) # type: ignore[literal-required] - - -class ExperimentArtifactMetadata(core.ModelBase): - """Metadata about an experiment artifact.""" - - name: ExperimentArtifactName - description: typing.Optional[str] = None - size_bytes: core_models.SizeBytes = pydantic.Field(alias=str("sizeBytes")) # type: ignore[literal-required] - details: ExperimentArtifactDetails - - -ExperimentArtifactName = str -"""The name of an experiment artifact.""" - - -class ExperimentAuthoringSource(core.ModelBase): - """Experiment created from an authoring repository.""" - - stemma_rid: core.RID = pydantic.Field(alias=str("stemmaRid")) # type: ignore[literal-required] - type: typing.Literal["authoring"] = "authoring" - - -ExperimentBranch = str -"""ExperimentBranch""" - - -class ExperimentCodeWorkspaceSource(core.ModelBase): - """Experiment created from a code workspace.""" - - container_rid: core.RID = pydantic.Field(alias=str("containerRid")) # type: ignore[literal-required] - deployment_rid: typing.Optional[core.RID] = pydantic.Field(alias=str("deploymentRid"), default=None) # type: ignore[literal-required] - type: typing.Literal["codeWorkspace"] = "codeWorkspace" - - -ExperimentRid = core.RID -"""The Resource Identifier (RID) of an Experiment.""" - - -class ExperimentSdkSource(core.ModelBase): - """Experiment created from the SDK.""" - - type: typing.Literal["sdk"] = "sdk" - - -ExperimentSource = typing_extensions.Annotated[ - typing.Union[ - "ExperimentCodeWorkspaceSource", "ExperimentAuthoringSource", "ExperimentSdkSource" - ], - pydantic.Field(discriminator="type"), -] -"""The source from which the experiment was created.""" - - -ExperimentStatus = typing.Literal["RUNNING", "SUCCEEDED", "FAILED"] -"""The current status of an experiment.""" - - -ExperimentTagText = str -"""A tag associated with an experiment.""" - - -class FieldValidationError(core.ModelBase): - """A dataset column type is not compatible with the trainer's supported column types.""" - - dataset_rid: core.RID = pydantic.Field(alias=str("datasetRid")) # type: ignore[literal-required] - """The RID of the dataset containing the invalid field.""" - - field_name: typing.Optional[str] = pydantic.Field(alias=str("fieldName"), default=None) # type: ignore[literal-required] - """The name of the dataset column or field that failed validation.""" - - field_type: str = pydantic.Field(alias=str("fieldType")) # type: ignore[literal-required] - """The type of the dataset field.""" - - type: typing.Literal["fieldValidationFailure"] = "fieldValidationFailure" - - -GpuType = typing.Literal["A100", "A10G", "A16", "H100", "H200", "L4", "L40S", "T4", "V100"] -"""The specific type of GPU hardware to use.""" - - -class InconsistentArrayDimensionsError(core.ModelBase): - """Array elements have inconsistent dimensions.""" - - first_element_shape: typing.List[int] = pydantic.Field(alias=str("firstElementShape")) # type: ignore[literal-required] - """The shape of the first array element""" - - conflicting_element_shape: typing.List[int] = pydantic.Field(alias=str("conflictingElementShape")) # type: ignore[literal-required] - """The shape of the conflicting array element""" - - type: typing.Literal["inconsistentArrayDimensions"] = "inconsistentArrayDimensions" - - -InferenceInputErrorType = typing_extensions.Annotated[ - typing.Union[ - "InvalidArrayShapeError", - "TypeMismatchError", - "UnsupportedTypeError", - "UnknownInputNameError", - "InvalidTabularFormatError", - "InconsistentArrayDimensionsError", - "RequiredValueMissingError", - "InvalidMapFormatError", - ], - pydantic.Field(discriminator="type"), -] -""" -The specific type and details of an input validation error for inference requests. -Each variant carries parameters relevant to that specific error category. -""" - - -InputAlias = str -"""A string alias used to identify inputs in a Model Studio configuration.""" - - -class IntegerParameter(core.ModelBase): - """An integer parameter value.""" - - value: core.Long - type: typing.Literal["integer"] = "integer" - - -class InvalidArrayShapeError(core.ModelBase): - """Array dimensions do not match expected ndarray shape.""" - - expected_shape: typing.List[int] = pydantic.Field(alias=str("expectedShape")) # type: ignore[literal-required] - """The expected array shape from the model API specification""" - - actual_shape: typing.Optional[typing.List[int]] = pydantic.Field(alias=str("actualShape"), default=None) # type: ignore[literal-required] - """The actual shape of the provided array""" - - type: typing.Literal["invalidArrayShape"] = "invalidArrayShape" - - -class InvalidMapFormatError(core.ModelBase): - """Map input has incorrect structure or null keys.""" - - type: typing.Literal["invalidMapFormat"] = "invalidMapFormat" - - -class InvalidResourceConfigurationError(core.ModelBase): - """A resource configuration field has an invalid format.""" - - field: str - """The name of the invalid field (e.g. "cpu", "memory").""" - - message: str - """A description of why the value is invalid.""" - - type: typing.Literal["invalidResourceConfiguration"] = "invalidResourceConfiguration" - - -class InvalidTabularFormatError(core.ModelBase): - """Tabular input has incorrect JSON structure.""" - - input_field_name: str = pydantic.Field(alias=str("inputFieldName")) # type: ignore[literal-required] - """The name of the tabular input field with incorrect format""" - - type: typing.Literal["invalidTabularFormat"] = "invalidTabularFormat" - - -class JsonSchemaValidationError(core.ModelBase): - """The custom configuration failed JSON schema validation.""" - - field: str - """The field in the provided JSON that is invalid.""" - - message: str - """A description of the validation failure.""" - - type: typing.Literal["jsonSchemaValidationFailure"] = "jsonSchemaValidationFailure" - - -class ListModelStudioConfigVersionsResponse(core.ModelBase): - """ListModelStudioConfigVersionsResponse""" - - data: typing.List[ModelStudioConfigVersion] - next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] - - -class ListModelStudioRunsResponse(core.ModelBase): - """ListModelStudioRunsResponse""" - - data: typing.List[ModelStudioRun] - next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] - - -class ListModelStudioTrainersResponse(core.ModelBase): - """ListModelStudioTrainersResponse""" - - data: typing.List[ModelStudioTrainer] - next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] - - class ListModelVersionsResponse(core.ModelBase): """ListModelVersionsResponse""" @@ -454,164 +55,6 @@ class ListModelVersionsResponse(core.ModelBase): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] -class LiveDeployment(core.ModelBase): - """LiveDeployment""" - - rid: LiveDeploymentRid - model_version: LiveDeploymentModelVersion = pydantic.Field(alias=str("modelVersion")) # type: ignore[literal-required] - """The currently deployed model version.""" - - runtime_configuration: LiveDeploymentRuntimeConfiguration = pydantic.Field(alias=str("runtimeConfiguration")) # type: ignore[literal-required] - """The compute resource configuration for the deployment.""" - - status: LiveDeploymentStatus - """The current operational status of the deployment.""" - - -class LiveDeploymentGpu(core.ModelBase): - """GPU resource configuration for a live deployment.""" - - count: int - """The number of GPU units requested (e.g. 1).""" - - type: typing.Optional[GpuType] = None - """The specific type of GPU to use. Not setting a type means any type is acceptable.""" - - -class LiveDeploymentModelVersion(core.ModelBase): - """Identifies the model and model version associated with a live deployment.""" - - model_rid: ModelRid = pydantic.Field(alias=str("modelRid")) # type: ignore[literal-required] - model_version_rid: ModelVersionRid = pydantic.Field(alias=str("modelVersionRid")) # type: ignore[literal-required] - - -LiveDeploymentRid = core.RID -"""The Resource Identifier (RID) of a Live Deployment.""" - - -class LiveDeploymentRuntimeConfiguration(core.ModelBase): - """The compute resource configuration for a live deployment, controlling replica scaling, CPU, memory, and GPU resources.""" - - min_replicas: int = pydantic.Field(alias=str("minReplicas")) # type: ignore[literal-required] - """The minimum number of replicas to keep running.""" - - max_replicas: int = pydantic.Field(alias=str("maxReplicas")) # type: ignore[literal-required] - """The maximum number of replicas to scale to under load.""" - - cpu: typing.Optional[float] = None - """The number of CPU units requested. This is also set as the limit.""" - - memory: typing.Optional[str] = None - """The amount of memory requested in human-readable format (e.g. "256MiB", "1GiB"). This is also set as the limit.""" - - gpu: typing.Optional[LiveDeploymentGpu] = None - """Optional GPU resources for the deployment.""" - - thread_count: typing.Optional[int] = pydantic.Field(alias=str("threadCount"), default=None) # type: ignore[literal-required] - """The number of threads used for query handling. Defaults to 32 if not specified. Also affects how many concurrent requests will be sent to a single replica.""" - - scaling_configuration: typing.Optional[LiveDeploymentScalingConfiguration] = pydantic.Field(alias=str("scalingConfiguration"), default=None) # type: ignore[literal-required] - """Autoscaling configuration for the deployment. Controls how the deployment scales replicas up and down based on load.""" - - -class LiveDeploymentScalingConfiguration(core.ModelBase): - """Autoscaling configuration that controls how the deployment scales replicas based on load thresholds and cooldown delays.""" - - scale_up_load_threshold: float = pydantic.Field(alias=str("scaleUpLoadThreshold")) # type: ignore[literal-required] - """A threshold between 0.0 and 1.0. If the ratio of running jobs to job capacity exceeds this threshold for the duration of the scale-up delay, the deployment will scale up. Job capacity is the number of running replicas multiplied by the thread count (concurrency limit).""" - - scale_up_delay: core_models.Duration = pydantic.Field(alias=str("scaleUpDelay")) # type: ignore[literal-required] - """The duration that load must exceed the scale-up threshold before scaling up.""" - - scale_down_delay: core_models.Duration = pydantic.Field(alias=str("scaleDownDelay")) # type: ignore[literal-required] - """The duration that load must be below the scale-down threshold before scaling down.""" - - -LiveDeploymentState = typing.Literal["ACTIVE", "STARTING", "DEGRADED", "DISABLED", "FAILED"] -""" -The operational state of a live deployment. - -| Value | Description | -| --- | --- | -| ACTIVE | The deployment is active. It may have zero replicas due to autoscaling and still not be ready. | -| STARTING | The deployment is starting up. | -| DEGRADED | At least one replica is ready, but not all replicas are healthy. | -| DISABLED | The deployment is disabled. | -| FAILED | The deployment has failed. No healthy replicas are available. | -""" - - -class LiveDeploymentStatus(core.ModelBase): - """The current operational status of a live deployment.""" - - state: LiveDeploymentState - """The current operational state of the deployment.""" - - is_ready: bool = pydantic.Field(alias=str("isReady")) # type: ignore[literal-required] - """Whether the deployment is ready to serve inference requests. A deployment may be active but not ready if it has been autoscaled to zero replicas.""" - - -class MissingRequiredDatasetColumnError(core.ModelBase): - """The user-provided dataset is missing a column required by the trainer.""" - - dataset_rid: core.RID = pydantic.Field(alias=str("datasetRid")) # type: ignore[literal-required] - """The RID of the dataset missing the required column.""" - - column_type_spec_id: ColumnTypeSpecId = pydantic.Field(alias=str("columnTypeSpecId")) # type: ignore[literal-required] - """The trainer column type spec ID for the required column.""" - - column_names: typing.List[core_models.ColumnName] = pydantic.Field(alias=str("columnNames")) # type: ignore[literal-required] - """The valid dataset column names that could map to this trainer column.""" - - type: typing.Literal["missingRequiredDatasetColumn"] = "missingRequiredDatasetColumn" - - -class MissingWorkerConfigInputDatasetColumnMappingError(core.ModelBase): - """The provided worker config input dataset is missing a column mapping required by the trainer.""" - - dataset_rid: core.RID = pydantic.Field(alias=str("datasetRid")) # type: ignore[literal-required] - """The RID of the dataset with the missing column mapping.""" - - column_type_spec_id: ColumnTypeSpecId = pydantic.Field(alias=str("columnTypeSpecId")) # type: ignore[literal-required] - """The column type spec ID for the missing column.""" - - type: typing.Literal["missingWorkerConfigInputDatasetColumnMapping"] = ( - "missingWorkerConfigInputDatasetColumnMapping" - ) - - -class MissingWorkerConfigInputError(core.ModelBase): - """The worker configuration is missing an input required by the trainer.""" - - input_alias: InputAlias = pydantic.Field(alias=str("inputAlias")) # type: ignore[literal-required] - """The alias of the missing input.""" - - type: typing.Literal["missingWorkerConfigInput"] = "missingWorkerConfigInput" - - -class MissingWorkerConfigInputObjectSetPropertyMappingError(core.ModelBase): - """The provided worker config input object set is missing a property mapping required by the trainer.""" - - object_set_rid: core.RID = pydantic.Field(alias=str("objectSetRid")) # type: ignore[literal-required] - """The RID of the object set with the missing property mapping.""" - - property_type_spec_id: str = pydantic.Field(alias=str("propertyTypeSpecId")) # type: ignore[literal-required] - """The property type spec ID for the missing property.""" - - type: typing.Literal["missingWorkerConfigInputObjectSetPropertyMapping"] = ( - "missingWorkerConfigInputObjectSetPropertyMapping" - ) - - -class MissingWorkerConfigOutputError(core.ModelBase): - """The worker configuration is missing an output required by the trainer.""" - - output_alias: OutputAlias = pydantic.Field(alias=str("outputAlias")) # type: ignore[literal-required] - """The alias of the missing output.""" - - type: typing.Literal["missingWorkerConfigOutput"] = "missingWorkerConfigOutput" - - class Model(core.ModelBase): """Model""" @@ -719,789 +162,25 @@ class ModelApiTabularType(core.ModelBase): type: typing.Literal["tabular"] = "tabular" -class ModelFunction(core.ModelBase): - """ModelFunction""" - - function_rid: ModelFunctionFunctionRid = pydantic.Field(alias=str("functionRid")) # type: ignore[literal-required] - function_version: ModelFunctionFunctionVersion = pydantic.Field(alias=str("functionVersion")) # type: ignore[literal-required] - display_name: ModelFunctionDisplayName = pydantic.Field(alias=str("displayName")) # type: ignore[literal-required] - api_name: ModelFunctionApiName = pydantic.Field(alias=str("apiName")) # type: ignore[literal-required] - is_row_wise: ModelFunctionIsRowWise = pydantic.Field(alias=str("isRowWise")) # type: ignore[literal-required] - ontology_binding: typing.Optional[ontologies_models.OntologyRid] = pydantic.Field(alias=str("ontologyBinding"), default=None) # type: ignore[literal-required] - - -ModelFunctionApiName = str -"""ModelFunctionApiName""" - - -ModelFunctionDisplayName = str -"""ModelFunctionDisplayName""" - - -ModelFunctionFunctionRid = core.RID -"""ModelFunctionFunctionRid""" - - -ModelFunctionFunctionVersion = str -"""ModelFunctionFunctionVersion""" - - -ModelFunctionIsRowWise = bool -"""ModelFunctionIsRowWise""" - - ModelName = str """ModelName""" -class ModelOutput(core.ModelBase): - """Model output configuration.""" - - model_rid: core.RID = pydantic.Field(alias=str("modelRid")) # type: ignore[literal-required] - """The RID of the output model.""" - - type: typing.Literal["model"] = "model" - - ModelRid = core.RID """The Resource Identifier (RID) of a Model.""" -class ModelStudio(core.ModelBase): - """ModelStudio""" - - rid: ModelStudioRid - folder_rid: filesystem_models.FolderRid = pydantic.Field(alias=str("folderRid")) # type: ignore[literal-required] - """The parent folder containing this Model Studio.""" - - created_time: core_models.CreatedTime = pydantic.Field(alias=str("createdTime")) # type: ignore[literal-required] - - -class ModelStudioConfigVersion(core.ModelBase): - """ModelStudioConfigVersion""" - - name: ModelStudioConfigVersionName - """Human readable name of the configuration version and experiment.""" - - version: ModelStudioConfigVersionNumber - """The version number of this configuration.""" +class ModelVersion(core.ModelBase): + """ModelVersion""" - trainer_id: TrainerId = pydantic.Field(alias=str("trainerId")) # type: ignore[literal-required] - """The identifier of the trainer to use for this configuration.""" + rid: ModelVersionRid + model_api: ModelApi = pydantic.Field(alias=str("modelApi")) # type: ignore[literal-required] + conda_requirements: typing.List[str] = pydantic.Field(alias=str("condaRequirements")) # type: ignore[literal-required] + backing_repositories: typing.List[core.RID] = pydantic.Field(alias=str("backingRepositories")) # type: ignore[literal-required] - trainer: TrainerVersionLocator - """The trainer and version used for this configuration.""" - worker_config: ModelStudioWorkerConfig = pydantic.Field(alias=str("workerConfig")) # type: ignore[literal-required] - """The worker configuration including inputs, outputs, and custom settings.""" - - resources: ResourceConfiguration - """The compute resources allocated for training runs.""" - - changelog: typing.Optional[str] = None - """Changelog describing changes in this version.""" - - created_by: core_models.CreatedBy = pydantic.Field(alias=str("createdBy")) # type: ignore[literal-required] - created_time: core_models.CreatedTime = pydantic.Field(alias=str("createdTime")) # type: ignore[literal-required] - - -ModelStudioConfigVersionName = str -"""Human readable name of the configuration version and experiment.""" - - -ModelStudioConfigVersionNumber = int -"""The version number of a Model Studio Configuration.""" - - -ModelStudioRid = core.RID -"""The Resource Identifier (RID) of a Model Studio.""" - - -class ModelStudioRun(core.ModelBase): - """ModelStudioRun""" - - run_id: RunId = pydantic.Field(alias=str("runId")) # type: ignore[literal-required] - """A unique identifier for this run, derived from the studio, config, and build.""" - - build_rid: ModelStudioRunBuildRid = pydantic.Field(alias=str("buildRid")) # type: ignore[literal-required] - """The RID of the build associated with this run.""" - - job_rid: ModelStudioRunJobRid = pydantic.Field(alias=str("jobRid")) # type: ignore[literal-required] - """The RID of the job associated with this run.""" - - config_version: ModelStudioConfigVersionNumber = pydantic.Field(alias=str("configVersion")) # type: ignore[literal-required] - """The configuration version used for this run.""" - - started_by: core_models.CreatedBy = pydantic.Field(alias=str("startedBy")) # type: ignore[literal-required] - """The user who started this run.""" - - started_time: core_models.CreatedTime = pydantic.Field(alias=str("startedTime")) # type: ignore[literal-required] - """When this run was started.""" - - build_status: typing.Optional[orchestration_models.BuildStatus] = pydantic.Field(alias=str("buildStatus"), default=None) # type: ignore[literal-required] - """Status of the build.""" - - resolved_outputs: typing.Dict[OutputAlias, ModelStudioRunOutput] = pydantic.Field(alias=str("resolvedOutputs")) # type: ignore[literal-required] - """Map of alias to resolved output details (e.g., for models, contains the version RID and experiment).""" - - -ModelStudioRunBuildRid = core.RID -"""The RID of the build associated with this run.""" - - -ModelStudioRunJobRid = core.RID -"""The RID of the job associated with this run.""" - - -class ModelStudioRunModelOutput(core.ModelBase): - """Resolved model output details for a Model Studio run.""" - - model_rid: core.RID = pydantic.Field(alias=str("modelRid")) # type: ignore[literal-required] - """The RID of the model.""" - - model_version_rid: core.RID = pydantic.Field(alias=str("modelVersionRid")) # type: ignore[literal-required] - """The RID of the model version created by this run.""" - - experiment_rid: typing.Optional[core.RID] = pydantic.Field(alias=str("experimentRid"), default=None) # type: ignore[literal-required] - """The RID of the experiment associated with this run, if any.""" - - type: typing.Literal["model"] = "model" - - -class ModelStudioTrainer(core.ModelBase): - """ModelStudioTrainer""" - - trainer_id: TrainerId = pydantic.Field(alias=str("trainerId")) # type: ignore[literal-required] - version: TrainerVersion - """The version of this trainer.""" - - name: TrainerName - """Human-readable name of the trainer.""" - - type: TrainerType - """The type/category of this trainer (e.g., TABULAR_CLASSIFICATION, TIME_SERIES).""" - - description: TrainerDescription - """Description of what this trainer does and its capabilities.""" - - custom_config_schema: TrainerSchemaDefinition = pydantic.Field(alias=str("customConfigSchema")) # type: ignore[literal-required] - """JSON schema defining the custom configuration parameters for this trainer.""" - - inputs: TrainerInputsSpecification - """Input specifications for this trainer.""" - - outputs: TrainerOutputsSpecification - """Output specifications for this trainer.""" - - experimental: ModelStudioTrainerExperimental - """Whether this trainer is experimental and may have breaking changes.""" - - -ModelStudioTrainerExperimental = bool -"""Whether this trainer is experimental and may have breaking changes.""" - - -class ModelStudioWorkerConfig(core.ModelBase): - """Configuration for the Model Studio worker.""" - - custom_config: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(alias=str("customConfig"), default=None) # type: ignore[literal-required] - """Custom configuration matching the trainer's JSON schema.""" - - inputs: typing.Dict[InputAlias, ModelStudioInput] - """Input configurations keyed by alias.""" - - outputs: typing.Dict[OutputAlias, ModelStudioOutput] - """Output configurations keyed by alias.""" - - -class ModelVersion(core.ModelBase): - """ModelVersion""" - - rid: ModelVersionRid - model_api: ModelApi = pydantic.Field(alias=str("modelApi")) # type: ignore[literal-required] - conda_requirements: typing.List[str] = pydantic.Field(alias=str("condaRequirements")) # type: ignore[literal-required] - backing_repositories: typing.List[core.RID] = pydantic.Field(alias=str("backingRepositories")) # type: ignore[literal-required] - created_time: core_models.CreatedTime = pydantic.Field(alias=str("createdTime")) # type: ignore[literal-required] - source: typing.Optional[ModelVersionSource] = None - linked_experiment: typing.Optional[ExperimentRid] = pydantic.Field(alias=str("linkedExperiment"), default=None) # type: ignore[literal-required] - """The Experiment linked to this Model Version, if one exists.""" - - -class ModelVersionCodeRepositorySource(core.ModelBase): - """Model version created from a code repository.""" - - repository_rid: core.RID = pydantic.Field(alias=str("repositoryRid")) # type: ignore[literal-required] - branch: str - type: typing.Literal["codeRepository"] = "codeRepository" - - -class ModelVersionCodeWorkspaceSource(core.ModelBase): - """Model version created from a code workspace.""" - - code_workspace_rid: core.RID = pydantic.Field(alias=str("codeWorkspaceRid")) # type: ignore[literal-required] - branch: str - type: typing.Literal["codeWorkspace"] = "codeWorkspace" - - -class ModelVersionContainerizedSource(core.ModelBase): - """Model version imported from a containerized model.""" - - type: typing.Literal["importedContainerizedModel"] = "importedContainerizedModel" - - -class ModelVersionExternalSource(core.ModelBase): - """Model version backed by an external model.""" - - type: typing.Literal["external"] = "external" - - -class ModelVersionModelStudioSource(core.ModelBase): - """Model version created from Model Studio.""" - - model_studio_rid: core.RID = pydantic.Field(alias=str("modelStudioRid")) # type: ignore[literal-required] - type: typing.Literal["modelStudio"] = "modelStudio" - - -class ModelVersionPromotedSource(core.ModelBase): - """Model version promoted from another model version.""" - - previous_model_rid: ModelRid = pydantic.Field(alias=str("previousModelRid")) # type: ignore[literal-required] - previous_model_version_rid: ModelVersionRid = pydantic.Field(alias=str("previousModelVersionRid")) # type: ignore[literal-required] - type: typing.Literal["promoted"] = "promoted" - - -ModelVersionRid = core.RID -"""The Resource Identifier (RID) of a Model Version.""" - - -class ModelVersionSdkSource(core.ModelBase): - """Model version created via the SDK.""" - - type: typing.Literal["sdk"] = "sdk" - - -ModelVersionSource = typing_extensions.Annotated[ - typing.Union[ - "ModelVersionContainerizedSource", - "ModelVersionExternalSource", - "ModelVersionCodeWorkspaceSource", - "ModelVersionModelStudioSource", - "ModelVersionCodeRepositorySource", - "ModelVersionSdkSource", - "ModelVersionPromotedSource", - ], - pydantic.Field(discriminator="type"), -] -"""The source from which this model version was created.""" - - -class MultipleColumnsNotAllowedForTrainerError(core.ModelBase): - """Multiple columns were mapped but the trainer only allows a single column for this spec.""" - - dataset_rid: core.RID = pydantic.Field(alias=str("datasetRid")) # type: ignore[literal-required] - """The RID of the dataset with multiple columns mapped.""" - - column_type_spec_id: ColumnTypeSpecId = pydantic.Field(alias=str("columnTypeSpecId")) # type: ignore[literal-required] - """The column type spec ID that does not allow multiple columns.""" - - type: typing.Literal["multipleColumnsNotAllowedForTrainer"] = ( - "multipleColumnsNotAllowedForTrainer" - ) - - -class MultiplePropertiesNotAllowedForTrainerError(core.ModelBase): - """Multiple properties were mapped but the trainer only allows a single property for this spec.""" - - object_set_rid: core.RID = pydantic.Field(alias=str("objectSetRid")) # type: ignore[literal-required] - """The RID of the object set with multiple properties mapped.""" - - property_type_spec_id: str = pydantic.Field(alias=str("propertyTypeSpecId")) # type: ignore[literal-required] - """The property type spec ID that does not allow multiple properties.""" - - type: typing.Literal["multiplePropertiesNotAllowedForTrainer"] = ( - "multiplePropertiesNotAllowedForTrainer" - ) - - -class OtherValidationError(core.ModelBase): - """A validation error that does not match any specific known type.""" - - message: str - """A description of the validation failure.""" - - type: typing.Literal["other"] = "other" - - -OutputAlias = str -"""A string alias used to identify outputs in a Model Studio configuration.""" - - -class OutputResourceInDifferentProjectError(core.ModelBase): - """The output resource is in a different project than the Model Studio.""" - - resource_rid: core.RID = pydantic.Field(alias=str("resourceRid")) # type: ignore[literal-required] - """The RID of the resource in a different project.""" - - output_alias: OutputAlias = pydantic.Field(alias=str("outputAlias")) # type: ignore[literal-required] - """The alias of the output referencing the resource.""" - - type: typing.Literal["outputResourceInDifferentProject"] = "outputResourceInDifferentProject" - - -class OutputResourceNotFoundError(core.ModelBase): - """The output resource does not exist or is in the trash.""" - - resource_rid: core.RID = pydantic.Field(alias=str("resourceRid")) # type: ignore[literal-required] - """The RID of the resource that was not found.""" - - output_alias: OutputAlias = pydantic.Field(alias=str("outputAlias")) # type: ignore[literal-required] - """The alias of the output referencing the missing resource.""" - - type: typing.Literal["outputResourceNotFound"] = "outputResourceNotFound" - - -class Parameter(core.ModelBase): - """A parameter with its name and value.""" - - name: ParameterName - """The parameter name""" - - value: ParameterValue - """The parameter value""" - - -ParameterName = str -"""The name of an experiment parameter.""" - - -ParameterValue = typing_extensions.Annotated[ - typing.Union[ - "DatetimeParameter", - "BooleanParameter", - "StringParameter", - "DoubleParameter", - "IntegerParameter", - ], - pydantic.Field(discriminator="type"), -] -"""A parameter value logged for an experiment.""" - - -class PromoteVersionModelRequest(core.ModelBase): - """PromoteVersionModelRequest""" - - source_model_version_rid: ModelVersionRid = pydantic.Field(alias=str("sourceModelVersionRid")) # type: ignore[literal-required] - branch: typing.Optional[core_models.BranchName] = None - """The branch to promote the version to. Defaults to master on most enrollments.""" - - -class ReplaceLiveDeploymentRequest(core.ModelBase): - """ReplaceLiveDeploymentRequest""" - - runtime_configuration: LiveDeploymentRuntimeConfiguration = pydantic.Field(alias=str("runtimeConfiguration")) # type: ignore[literal-required] - """The compute resource configuration for the deployment.""" - - -class ReplaceModelFunctionRequest(core.ModelBase): - """ReplaceModelFunctionRequest""" - - api_name: ModelFunctionApiName = pydantic.Field(alias=str("apiName")) # type: ignore[literal-required] - ontology_binding: typing.Optional[ontologies_models.OntologyRid] = pydantic.Field(alias=str("ontologyBinding"), default=None) # type: ignore[literal-required] - is_row_wise: ModelFunctionIsRowWise = pydantic.Field(alias=str("isRowWise")) # type: ignore[literal-required] - - -class RequiredValueMissingError(core.ModelBase): - """Required input field is null or missing.""" - - field_name: str = pydantic.Field(alias=str("fieldName")) # type: ignore[literal-required] - """The name of the required field that was null or missing""" - - type: typing.Literal["requiredValueMissing"] = "requiredValueMissing" - - -class ResourceConfiguration(core.ModelBase): - """Compute resource configuration for training runs.""" - - memory: str - """Memory allocation (e.g., "4G").""" - - cpu: str - """CPU allocation (e.g., "2").""" - - gpu: typing.Optional[GpuType] = None - """GPU allocation (must be available in the project's resource queue).""" - - -RunId = str -"""A unique identifier for a Model Studio run, derived from the studio, config, and build.""" - - -class SearchExperimentsAndFilter(core.ModelBase): - """Returns experiments where every filter is satisfied.""" - - filters: typing.List[SearchExperimentsFilter] - type: typing.Literal["and"] = "and" - - -class SearchExperimentsContainsFilter(core.ModelBase): - """Filter for substring containment matches.""" - - field: SearchExperimentsContainsFilterField - value: typing.Any - type: typing.Literal["contains"] = "contains" - - -SearchExperimentsContainsFilterField = typing.Literal[ - "EXPERIMENT_NAME", "PARAMETER_NAME", "SERIES_NAME" -] -"""Fields that support substring containment filtering.""" - - -class SearchExperimentsEqualsFilter(core.ModelBase): - """Filter for exact field value matches.""" - - field: SearchExperimentsEqualsFilterField - value: typing.Any - type: typing.Literal["eq"] = "eq" - - -SearchExperimentsEqualsFilterField = typing.Literal[ - "STATUS", - "BRANCH", - "EXPERIMENT_NAME", - "EXPERIMENT_RID", - "JOB_RID", - "TAG", - "PARAMETER_NAME", - "SERIES_NAME", -] -"""Fields that support equality filtering.""" - - -SearchExperimentsFilter = typing_extensions.Annotated[ - typing.Union[ - "SearchExperimentsSeriesFilter", - "SearchExperimentsContainsFilter", - "SearchExperimentsNotFilter", - "SearchExperimentsOrFilter", - "SearchExperimentsAndFilter", - "SearchExperimentsParameterFilter", - "SearchExperimentsSummaryMetricFilter", - "SearchExperimentsEqualsFilter", - "SearchExperimentsStartsWithFilter", - ], - pydantic.Field(discriminator="type"), -] -""" -Filter for searching experiments using operator-based composition. -Supports equality, text matching, boolean combination operators, and compound filters -that atomically bind a name to a value comparison. - -Example filters: -- Simple status: {"eq": {"field": "STATUS", "value": "RUNNING"}} -- Branch match: {"eq": {"field": "BRANCH", "value": "master"}} -- Parameter filter: {"parameterFilter": {"parameterName": "learning_rate", "operator": "GT", "value": 0.01}} -- Combined: {"and": {"filters": [ - {"eq": {"field": "STATUS", "value": "SUCCEEDED"}}, - {"parameterFilter": {"parameterName": "learning_rate", "operator": "GT", "value": 0.5}} - ]}} -""" - - -class SearchExperimentsNotFilter(core.ModelBase): - """Returns experiments where the filter is not satisfied.""" - - value: SearchExperimentsFilter - type: typing.Literal["not"] = "not" - - -SearchExperimentsNumericFilterOperator = typing.Literal["EQ", "GT", "LT"] -"""Comparison operator for numeric filter predicates (series and summary metrics).""" - - -class SearchExperimentsOrFilter(core.ModelBase): - """Returns experiments where at least one filter is satisfied.""" - - filters: typing.List[SearchExperimentsFilter] - type: typing.Literal["or"] = "or" - - -class SearchExperimentsOrderBy(core.ModelBase): - """Ordering configuration for experiment search results.""" - - field: SearchExperimentsOrderByField - direction: core_models.OrderByDirection - - -SearchExperimentsOrderByField = typing.Literal["EXPERIMENT_NAME", "CREATED_TIME"] -"""Fields to order experiment search results by.""" - - -class SearchExperimentsParameterFilter(core.ModelBase): - """ - Filter that atomically binds a parameter name to a value comparison, - ensuring both conditions are evaluated on the same parameter. - Supported combinations: - - EQ: boolean, double, integer, or datetime value - - GT/LT: double, integer, or datetime value - - CONTAINS: string value (substring match on the parameter's string value) - """ - - parameter_name: ParameterName = pydantic.Field(alias=str("parameterName")) # type: ignore[literal-required] - """The exact name of the parameter to filter on.""" - - operator: SearchExperimentsParameterFilterOperator - """The comparison operator to apply.""" - - value: typing.Any - """The value to compare against.""" - - type: typing.Literal["parameterFilter"] = "parameterFilter" - - -SearchExperimentsParameterFilterOperator = typing.Literal["EQ", "GT", "LT", "CONTAINS"] -"""Comparison operator for parameter filter predicates.""" - - -class SearchExperimentsRequest(core.ModelBase): - """SearchExperimentsRequest""" - - where: typing.Optional[SearchExperimentsFilter] = None - """Optional search filter for filtering experiments. If not provided, all experiments for the model are returned.""" - - order_by: typing.Optional[SearchExperimentsOrderBy] = pydantic.Field(alias=str("orderBy"), default=None) # type: ignore[literal-required] - """The field to sort by. Default is to sort by relevance.""" - - page_size: typing.Optional[core_models.PageSize] = pydantic.Field(alias=str("pageSize"), default=None) # type: ignore[literal-required] - """The maximum number of results to return. Default 50, maximum of 100.""" - - page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("pageToken"), default=None) # type: ignore[literal-required] - """PageToken to identify the next page to retrieve. Leave empty for the first request.""" - - -class SearchExperimentsResponse(core.ModelBase): - """Response from searching experiments.""" - - data: typing.List[Experiment] - """List of experiments matching the search criteria.""" - - next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] - """Token for retrieving the next page of results, if more results are available.""" - - -class SearchExperimentsSeriesFilter(core.ModelBase): - """ - Filter that atomically binds a series name to a metric comparison, - ensuring all conditions are evaluated on the same series. - """ - - series_name: SeriesName = pydantic.Field(alias=str("seriesName")) # type: ignore[literal-required] - """The name of the series to filter on.""" - - field: SearchExperimentsSeriesFilterField - """The series metric to compare.""" - - operator: SearchExperimentsNumericFilterOperator - """The comparison operator (EQ, GT, or LT).""" - - value: typing.Any - """The value to compare against.""" - - type: typing.Literal["seriesFilter"] = "seriesFilter" - - -SearchExperimentsSeriesFilterField = typing.Literal[ - "LENGTH", "AGGREGATION_MIN", "AGGREGATION_MAX", "AGGREGATION_LAST" -] -"""The series metric to filter on.""" - - -class SearchExperimentsStartsWithFilter(core.ModelBase): - """Filter for prefix matches.""" - - field: SearchExperimentsStartsWithFilterField - value: typing.Any - type: typing.Literal["startsWith"] = "startsWith" - - -SearchExperimentsStartsWithFilterField = typing.Literal[ - "EXPERIMENT_NAME", "PARAMETER_NAME", "SERIES_NAME" -] -"""Fields that support prefix filtering.""" - - -class SearchExperimentsSummaryMetricFilter(core.ModelBase): - """ - Filter that atomically binds a series name and aggregation type to a value comparison, - ensuring all conditions are evaluated on the same summary metric. - """ - - series_name: SeriesName = pydantic.Field(alias=str("seriesName")) # type: ignore[literal-required] - """The name of the series this metric belongs to.""" - - aggregation: SummaryMetricAggregation - """The aggregation type (MIN, MAX, LAST).""" - - operator: SearchExperimentsNumericFilterOperator - """The comparison operator (EQ, GT, or LT).""" - - value: typing.Any - """The value to compare against.""" - - type: typing.Literal["summaryMetricFilter"] = "summaryMetricFilter" - - -class SeriesAggregations(core.ModelBase): - """Series with precomputed aggregation values.""" - - name: SeriesName - """The series name""" - - length: typing.Optional[core.Long] = None - """Number of values in the series. This field may be absent when series aggregations are derived from summary metrics rather than the full series data.""" - - value: SeriesAggregationsValue - """Aggregated values for this series""" - - -SeriesName = str -"""The name of a series (metrics tracked over time).""" - - -class StringParameter(core.ModelBase): - """A string parameter value.""" - - value: str - type: typing.Literal["string"] = "string" - - -class SummaryMetric(core.ModelBase): - """A summary metric with series name, aggregation type, and computed value.""" - - series_name: SeriesName = pydantic.Field(alias=str("seriesName")) # type: ignore[literal-required] - """Name of the series this metric belongs to""" - - aggregation: SummaryMetricAggregation - """Type of aggregation (MIN, MAX, LAST)""" - - value: float - """The computed value""" - - -SummaryMetricAggregation = typing.Literal["MIN", "MAX", "LAST"] -"""The type of aggregation computed for a summary metric.""" - - -class TableArtifactDetails(core.ModelBase): - """Details about a table artifact.""" - - row_count: core.Long = pydantic.Field(alias=str("rowCount")) # type: ignore[literal-required] - type: typing.Literal["table"] = "table" - - -TrainerDescription = str -"""Description of what a trainer does and its capabilities.""" - - -TrainerId = str -"""The identifier for a trainer.""" - - -TrainerInputsSpecification = typing.Any -"""Specification of the inputs required by a trainer. When creating a ModelStudioConfigVersion, the workerConfig.inputs must conform to this specification, providing entries for each required input defined here.""" - - -TrainerName = str -"""Human-readable name of a trainer.""" - - -TrainerOutputsSpecification = typing.Any -"""Specification of the outputs produced by a trainer. When creating a ModelStudioConfigVersion, the workerConfig.outputs must conform to this specification, providing entries for each required output defined here.""" - - -TrainerSchemaDefinition = typing.Any -"""JSON schema defining the custom configuration parameters for a trainer.""" - - -TrainerType = str -"""The type/category of a trainer.""" - - -TrainerVersion = str -"""A specific version identifier for a trainer.""" - - -class TrainerVersionLocator(core.ModelBase): - """Identifies a specific version of a trainer.""" - - trainer_id: TrainerId = pydantic.Field(alias=str("trainerId")) # type: ignore[literal-required] - version: str - - -class TransformJsonLiveDeploymentRequest(core.ModelBase): - """TransformJsonLiveDeploymentRequest""" - - input: typing.Dict[str, typing.Any] - """The input data for the model inference. The structure should match the model's transform API specification, where each key is an input name and the value is the corresponding input data.""" - - -class TransformLiveDeploymentResponse(core.ModelBase): - """The response from transforming input data using a live deployment.""" - - output: typing.Dict[str, typing.Any] - """The output data from the model inference. The structure depends on the model's defined API specification, where each key is an output name and the value is the corresponding output data.""" - - -class TypeMismatchError(core.ModelBase): - """Input type does not match expected type in model API.""" - - expected_type: str = pydantic.Field(alias=str("expectedType")) # type: ignore[literal-required] - """The expected type from the model API specification""" - - actual_type: str = pydantic.Field(alias=str("actualType")) # type: ignore[literal-required] - """The actual type provided in the input""" - - type: typing.Literal["typeMismatch"] = "typeMismatch" - - -class UnknownColumnSpecIdInConfigColumnMappingError(core.ModelBase): - """The worker config column mapping contains an unknown column spec ID not found in the trainer's column specification.""" - - dataset_rid: core.RID = pydantic.Field(alias=str("datasetRid")) # type: ignore[literal-required] - """The RID of the dataset containing the unknown column mapping.""" - - column_type_spec_id: ColumnTypeSpecId = pydantic.Field(alias=str("columnTypeSpecId")) # type: ignore[literal-required] - """The unknown column type spec ID.""" - - type: typing.Literal["unknownColumnSpecIdInConfigColumnMapping"] = ( - "unknownColumnSpecIdInConfigColumnMapping" - ) - - -class UnknownInputNameError(core.ModelBase): - """Provided input name not found in model API specification.""" - - input_name: str = pydantic.Field(alias=str("inputName")) # type: ignore[literal-required] - """The input name that was not found in the model API specification""" - - type: typing.Literal["unknownInputName"] = "unknownInputName" - - -class UnsupportedTypeError(core.ModelBase): - """Input contains an unsupported data type.""" - - unsupported_type: str = pydantic.Field(alias=str("unsupportedType")) # type: ignore[literal-required] - """The unsupported data type""" - - type: typing.Literal["unsupportedType"] = "unsupportedType" - - -CreateLiveDeploymentTarget = DirectCreateLiveDeploymentTarget -"""The target model source for the live deployment. Determines which model and version selection strategy to use when creating the deployment.""" - - -ExperimentArtifactDetails = TableArtifactDetails -"""Details about an experiment artifact.""" +ModelVersionRid = core.RID +"""The Resource Identifier (RID) of a Model Version.""" ModelFiles = DillModelFiles @@ -1511,100 +190,15 @@ class UnsupportedTypeError(core.ModelBase): """ -ModelStudioInput = DatasetInput -"""Input specification for a Model Studio configuration.""" - - -ModelStudioOutput = ModelOutput -"""Output specification for a Model Studio configuration.""" - - -ModelStudioRunOutput = ModelStudioRunModelOutput -"""Resolved output details for a Model Studio run.""" - - -Series = DoubleSeriesV1 -"""A series of values logged over time.""" - - -SeriesAggregationsValue = DoubleSeriesAggregations -"""Union of aggregation values by series type.""" - - -core.resolve_forward_references( - CreateConfigValidationFailureReason, globalns=globals(), localns=locals() -) -core.resolve_forward_references(ExperimentSource, globalns=globals(), localns=locals()) -core.resolve_forward_references(InferenceInputErrorType, globalns=globals(), localns=locals()) core.resolve_forward_references(ModelApiDataType, globalns=globals(), localns=locals()) core.resolve_forward_references(ModelApiInput, globalns=globals(), localns=locals()) core.resolve_forward_references(ModelApiOutput, globalns=globals(), localns=locals()) -core.resolve_forward_references(ModelVersionSource, globalns=globals(), localns=locals()) -core.resolve_forward_references(ParameterValue, globalns=globals(), localns=locals()) -core.resolve_forward_references(SearchExperimentsFilter, globalns=globals(), localns=locals()) __all__ = [ - "BooleanParameter", - "ChangelogTooLongError", - "ColumnTypeSpecId", - "CreateConfigValidationFailureReason", - "CreateLiveDeploymentRequest", - "CreateLiveDeploymentTarget", - "CreateModelFunctionRequest", "CreateModelRequest", - "CreateModelStudioConfigVersionRequest", - "CreateModelStudioRequest", "CreateModelVersionRequest", - "DatasetInput", - "DatasetSchemaNotFoundError", - "DatetimeParameter", "DillModelFiles", - "DirectCreateLiveDeploymentTarget", - "DoubleParameter", - "DoubleSeriesAggregations", - "DoubleSeriesV1", - "DoubleSeriesValueV1", - "EpochMillis", - "Experiment", - "ExperimentArtifactDetails", - "ExperimentArtifactMetadata", - "ExperimentArtifactName", - "ExperimentAuthoringSource", - "ExperimentBranch", - "ExperimentCodeWorkspaceSource", - "ExperimentRid", - "ExperimentSdkSource", - "ExperimentSource", - "ExperimentStatus", - "ExperimentTagText", - "FieldValidationError", - "GpuType", - "InconsistentArrayDimensionsError", - "InferenceInputErrorType", - "InputAlias", - "IntegerParameter", - "InvalidArrayShapeError", - "InvalidMapFormatError", - "InvalidResourceConfigurationError", - "InvalidTabularFormatError", - "JsonSchemaValidationError", - "ListModelStudioConfigVersionsResponse", - "ListModelStudioRunsResponse", - "ListModelStudioTrainersResponse", "ListModelVersionsResponse", - "LiveDeployment", - "LiveDeploymentGpu", - "LiveDeploymentModelVersion", - "LiveDeploymentRid", - "LiveDeploymentRuntimeConfiguration", - "LiveDeploymentScalingConfiguration", - "LiveDeploymentState", - "LiveDeploymentStatus", - "MissingRequiredDatasetColumnError", - "MissingWorkerConfigInputDatasetColumnMappingError", - "MissingWorkerConfigInputError", - "MissingWorkerConfigInputObjectSetPropertyMappingError", - "MissingWorkerConfigOutputError", "Model", "ModelApi", "ModelApiAnyType", @@ -1618,96 +212,8 @@ class UnsupportedTypeError(core.ModelBase): "ModelApiTabularFormat", "ModelApiTabularType", "ModelFiles", - "ModelFunction", - "ModelFunctionApiName", - "ModelFunctionDisplayName", - "ModelFunctionFunctionRid", - "ModelFunctionFunctionVersion", - "ModelFunctionIsRowWise", "ModelName", - "ModelOutput", "ModelRid", - "ModelStudio", - "ModelStudioConfigVersion", - "ModelStudioConfigVersionName", - "ModelStudioConfigVersionNumber", - "ModelStudioInput", - "ModelStudioOutput", - "ModelStudioRid", - "ModelStudioRun", - "ModelStudioRunBuildRid", - "ModelStudioRunJobRid", - "ModelStudioRunModelOutput", - "ModelStudioRunOutput", - "ModelStudioTrainer", - "ModelStudioTrainerExperimental", - "ModelStudioWorkerConfig", "ModelVersion", - "ModelVersionCodeRepositorySource", - "ModelVersionCodeWorkspaceSource", - "ModelVersionContainerizedSource", - "ModelVersionExternalSource", - "ModelVersionModelStudioSource", - "ModelVersionPromotedSource", "ModelVersionRid", - "ModelVersionSdkSource", - "ModelVersionSource", - "MultipleColumnsNotAllowedForTrainerError", - "MultiplePropertiesNotAllowedForTrainerError", - "OtherValidationError", - "OutputAlias", - "OutputResourceInDifferentProjectError", - "OutputResourceNotFoundError", - "Parameter", - "ParameterName", - "ParameterValue", - "PromoteVersionModelRequest", - "ReplaceLiveDeploymentRequest", - "ReplaceModelFunctionRequest", - "RequiredValueMissingError", - "ResourceConfiguration", - "RunId", - "SearchExperimentsAndFilter", - "SearchExperimentsContainsFilter", - "SearchExperimentsContainsFilterField", - "SearchExperimentsEqualsFilter", - "SearchExperimentsEqualsFilterField", - "SearchExperimentsFilter", - "SearchExperimentsNotFilter", - "SearchExperimentsNumericFilterOperator", - "SearchExperimentsOrFilter", - "SearchExperimentsOrderBy", - "SearchExperimentsOrderByField", - "SearchExperimentsParameterFilter", - "SearchExperimentsParameterFilterOperator", - "SearchExperimentsRequest", - "SearchExperimentsResponse", - "SearchExperimentsSeriesFilter", - "SearchExperimentsSeriesFilterField", - "SearchExperimentsStartsWithFilter", - "SearchExperimentsStartsWithFilterField", - "SearchExperimentsSummaryMetricFilter", - "Series", - "SeriesAggregations", - "SeriesAggregationsValue", - "SeriesName", - "StringParameter", - "SummaryMetric", - "SummaryMetricAggregation", - "TableArtifactDetails", - "TrainerDescription", - "TrainerId", - "TrainerInputsSpecification", - "TrainerName", - "TrainerOutputsSpecification", - "TrainerSchemaDefinition", - "TrainerType", - "TrainerVersion", - "TrainerVersionLocator", - "TransformJsonLiveDeploymentRequest", - "TransformLiveDeploymentResponse", - "TypeMismatchError", - "UnknownColumnSpecIdInConfigColumnMappingError", - "UnknownInputNameError", - "UnsupportedTypeError", ] diff --git a/foundry_sdk/v2/ontologies/action.py b/foundry_sdk/v2/ontologies/action.py index c16d9c069..4e76038ba 100644 --- a/foundry_sdk/v2/ontologies/action.py +++ b/foundry_sdk/v2/ontologies/action.py @@ -68,8 +68,6 @@ def apply( options: typing.Optional[ontologies_models.ApplyActionRequestOptions] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, transaction_id: typing.Optional[ontologies_models.OntologyTransactionId] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -100,10 +98,6 @@ def apply( :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The version of the generated SDK. :type sdk_version: Optional[SdkVersion] - :param trace_parent: The W3C trace parent header included in the request. - :type trace_parent: Optional[TraceParent] - :param trace_state: The W3C trace state header included in the request. - :type trace_state: Optional[TraceState] :param transaction_id: The ID of an Ontology transaction to apply the action against. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[OntologyTransactionId] :param request_timeout: timeout setting for this request in seconds. @@ -127,8 +121,6 @@ def apply( "action": action, }, header_params={ - "traceParent": trace_parent, - "traceState": trace_state, "Content-Type": "application/json", "Accept": "application/json", }, @@ -361,8 +353,6 @@ def apply( options: typing.Optional[ontologies_models.ApplyActionRequestOptions] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, transaction_id: typing.Optional[ontologies_models.OntologyTransactionId] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -393,10 +383,6 @@ def apply( :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The version of the generated SDK. :type sdk_version: Optional[SdkVersion] - :param trace_parent: The W3C trace parent header included in the request. - :type trace_parent: Optional[TraceParent] - :param trace_state: The W3C trace state header included in the request. - :type trace_state: Optional[TraceState] :param transaction_id: The ID of an Ontology transaction to apply the action against. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[OntologyTransactionId] :param request_timeout: timeout setting for this request in seconds. @@ -420,8 +406,6 @@ def apply( "action": action, }, header_params={ - "traceParent": trace_parent, - "traceState": trace_state, "Content-Type": "application/json", "Accept": "application/json", }, diff --git a/foundry_sdk/v2/ontologies/action_type.py b/foundry_sdk/v2/ontologies/action_type.py index bbc972450..6fc47ec20 100644 --- a/foundry_sdk/v2/ontologies/action_type.py +++ b/foundry_sdk/v2/ontologies/action_type.py @@ -15,7 +15,6 @@ import typing -import annotated_types import pydantic import typing_extensions @@ -152,69 +151,6 @@ def get_by_rid( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get_by_rid_batch( - self, - ontology: ontologies_models.OntologyIdentifier, - *, - requests: typing_extensions.Annotated[ - typing.List[ontologies_models.GetActionTypeByRidBatchRequestElement], - annotated_types.Len(min_length=1, max_length=100), - ], - branch: typing.Optional[core_models.FoundryBranch] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.GetActionTypeByRidBatchResponse: - """ - Gets a list of action types by RID in bulk. - - Action types are filtered from the response if they don't exist or the requesting token lacks the required - permissions. - - The maximum batch size for this endpoint is 100. - - :param ontology: - :type ontology: OntologyIdentifier - :param requests: - :type requests: List[GetActionTypeByRidBatchRequestElement] - :param branch: The Foundry branch to load the action type definitions 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 preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.GetActionTypeByRidBatchResponse - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/actionTypes/getByRidBatch", - query_params={ - "branch": branch, - "preview": preview, - }, - path_params={ - "ontology": ontology, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=ontologies_models.GetActionTypeByRidBatchRequest( - requests=requests, - ), - response_type=ontologies_models.GetActionTypeByRidBatchResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -276,12 +212,10 @@ class _ActionTypeClientRaw: def __init__(self, client: ActionTypeClient) -> None: def get(_: ontologies_models.ActionTypeV2): ... def get_by_rid(_: ontologies_models.ActionTypeV2): ... - def get_by_rid_batch(_: ontologies_models.GetActionTypeByRidBatchResponse): ... def list(_: ontologies_models.ListActionTypesResponseV2): ... self.get = core.with_raw_response(get, client.get) self.get_by_rid = core.with_raw_response(get_by_rid, client.get_by_rid) - self.get_by_rid_batch = core.with_raw_response(get_by_rid_batch, client.get_by_rid_batch) self.list = core.with_raw_response(list, client.list) @@ -289,14 +223,10 @@ class _ActionTypeClientStreaming: def __init__(self, client: ActionTypeClient) -> None: def get(_: ontologies_models.ActionTypeV2): ... def get_by_rid(_: ontologies_models.ActionTypeV2): ... - def get_by_rid_batch(_: ontologies_models.GetActionTypeByRidBatchResponse): ... def list(_: ontologies_models.ListActionTypesResponseV2): ... self.get = core.with_streaming_response(get, client.get) self.get_by_rid = core.with_streaming_response(get_by_rid, client.get_by_rid) - self.get_by_rid_batch = core.with_streaming_response( - get_by_rid_batch, client.get_by_rid_batch - ) self.list = core.with_streaming_response(list, client.list) @@ -427,69 +357,6 @@ def get_by_rid( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get_by_rid_batch( - self, - ontology: ontologies_models.OntologyIdentifier, - *, - requests: typing_extensions.Annotated[ - typing.List[ontologies_models.GetActionTypeByRidBatchRequestElement], - annotated_types.Len(min_length=1, max_length=100), - ], - branch: typing.Optional[core_models.FoundryBranch] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[ontologies_models.GetActionTypeByRidBatchResponse]: - """ - Gets a list of action types by RID in bulk. - - Action types are filtered from the response if they don't exist or the requesting token lacks the required - permissions. - - The maximum batch size for this endpoint is 100. - - :param ontology: - :type ontology: OntologyIdentifier - :param requests: - :type requests: List[GetActionTypeByRidBatchRequestElement] - :param branch: The Foundry branch to load the action type definitions 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 preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[ontologies_models.GetActionTypeByRidBatchResponse] - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/actionTypes/getByRidBatch", - query_params={ - "branch": branch, - "preview": preview, - }, - path_params={ - "ontology": ontology, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=ontologies_models.GetActionTypeByRidBatchRequest( - requests=requests, - ), - response_type=ontologies_models.GetActionTypeByRidBatchResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -551,14 +418,10 @@ class _AsyncActionTypeClientRaw: def __init__(self, client: AsyncActionTypeClient) -> None: def get(_: ontologies_models.ActionTypeV2): ... def get_by_rid(_: ontologies_models.ActionTypeV2): ... - def get_by_rid_batch(_: ontologies_models.GetActionTypeByRidBatchResponse): ... def list(_: ontologies_models.ListActionTypesResponseV2): ... self.get = core.async_with_raw_response(get, client.get) self.get_by_rid = core.async_with_raw_response(get_by_rid, client.get_by_rid) - self.get_by_rid_batch = core.async_with_raw_response( - get_by_rid_batch, client.get_by_rid_batch - ) self.list = core.async_with_raw_response(list, client.list) @@ -566,12 +429,8 @@ class _AsyncActionTypeClientStreaming: def __init__(self, client: AsyncActionTypeClient) -> None: def get(_: ontologies_models.ActionTypeV2): ... def get_by_rid(_: ontologies_models.ActionTypeV2): ... - def get_by_rid_batch(_: ontologies_models.GetActionTypeByRidBatchResponse): ... def list(_: ontologies_models.ListActionTypesResponseV2): ... self.get = core.async_with_streaming_response(get, client.get) self.get_by_rid = core.async_with_streaming_response(get_by_rid, client.get_by_rid) - self.get_by_rid_batch = core.async_with_streaming_response( - get_by_rid_batch, client.get_by_rid_batch - ) self.list = core.async_with_streaming_response(list, client.list) diff --git a/foundry_sdk/v2/ontologies/errors.py b/foundry_sdk/v2/ontologies/errors.py index c5daa0333..6d88f0d3c 100644 --- a/foundry_sdk/v2/ontologies/errors.py +++ b/foundry_sdk/v2/ontologies/errors.py @@ -52,19 +52,6 @@ class ActionEditedPropertiesNotFound(errors.BadRequestError): error_instance_id: str -class ActionEditsNotSupportedWithMarketplaceParameters(typing_extensions.TypedDict): - """Returning action edits is not supported when using marketplace bindings.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class ActionEditsNotSupportedWithMarketplace(errors.BadRequestError): - name: typing.Literal["ActionEditsNotSupportedWithMarketplace"] - parameters: ActionEditsNotSupportedWithMarketplaceParameters - error_instance_id: str - - class ActionEditsReadOnlyEntityParameters(typing_extensions.TypedDict): """The given action request performs edits on a type that is read-only or does not allow edits.""" @@ -339,19 +326,6 @@ class AttachmentSizeExceededLimit(errors.BadRequestError): error_instance_id: str -class BranchNotSupportedWithMarketplaceQueryParameters(typing_extensions.TypedDict): - """The branch parameter is not supported when executing queries with marketplace bindings.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class BranchNotSupportedWithMarketplaceQuery(errors.BadRequestError): - name: typing.Literal["BranchNotSupportedWithMarketplaceQuery"] - parameters: BranchNotSupportedWithMarketplaceQueryParameters - error_instance_id: str - - class CipherChannelNotFoundParameters(typing_extensions.TypedDict): """ The Cipher Channel was not found. @@ -433,21 +407,6 @@ class DerivedPropertyApiNamesNotUnique(errors.BadRequestError): error_instance_id: str -class DistinctEnumValuesExceededLimitParameters(typing_extensions.TypedDict): - """An enum time series contained too many distinct enum values. Check that the time series sync is using the correct value column.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - maxDistinctValues: typing_extensions.NotRequired[int] - - -@dataclass -class DistinctEnumValuesExceededLimit(errors.BadRequestError): - name: typing.Literal["DistinctEnumValuesExceededLimit"] - parameters: DistinctEnumValuesExceededLimitParameters - error_instance_id: str - - class DuplicateOrderByParameters(typing_extensions.TypedDict): """The requested sort order includes duplicate properties.""" @@ -543,23 +502,6 @@ class FunctionInvalidInput(errors.BadRequestError): error_instance_id: str -class FunctionNotSupportedWithTransactionParameters(typing_extensions.TypedDict): - """The function runtime does not support execution with a transaction.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - functionRid: ontologies_models.FunctionRid - functionVersion: ontologies_models.FunctionVersion - message: str - - -@dataclass -class FunctionNotSupportedWithTransaction(errors.BadRequestError): - name: typing.Literal["FunctionNotSupportedWithTransaction"] - parameters: FunctionNotSupportedWithTransactionParameters - error_instance_id: str - - class HighScaleComputationNotEnabledParameters(typing_extensions.TypedDict): """High-scale compute was required for this Ontology query but is not enabled on this enrollment.""" @@ -868,25 +810,6 @@ class InvalidDerivedPropertyDefinition(errors.BadRequestError): error_instance_id: str -class InvalidDerivedPropertyDefinitionOnInterfaceParameters(typing_extensions.TypedDict): - """ - Derived property definition on an interface-typed object set was invalid due to shape of query or type - checking. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - interfaceType: ontologies_models.InterfaceTypeApiName - derivedProperty: ontologies_models.DerivedPropertyApiName - - -@dataclass -class InvalidDerivedPropertyDefinitionOnInterface(errors.BadRequestError): - name: typing.Literal["InvalidDerivedPropertyDefinitionOnInterface"] - parameters: InvalidDerivedPropertyDefinitionOnInterfaceParameters - error_instance_id: str - - class InvalidDurationGroupByPropertyTypeParameters(typing_extensions.TypedDict): """Invalid property type for duration groupBy.""" @@ -1729,25 +1652,6 @@ class OntologyApiNameNotUnique(errors.BadRequestError): error_instance_id: str -class OntologyDefinitionOutOfSyncParameters(typing_extensions.TypedDict): - """ - The ontology definition is temporarily out of sync. The indexed definition does not yet - reflect the latest saved definition for this type. This is typically a transient condition that - resolves as indexing completes. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectTypeRid: ontologies_models.ObjectTypeRid - - -@dataclass -class OntologyDefinitionOutOfSync(errors.ConflictError): - name: typing.Literal["OntologyDefinitionOutOfSync"] - parameters: OntologyDefinitionOutOfSyncParameters - error_instance_id: str - - class OntologyEditsExceededLimitParameters(typing_extensions.TypedDict): """ The number of edits to the Ontology exceeded the allowed limit. @@ -2474,7 +2378,6 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): __all__ = [ "ActionContainsDuplicateEdits", "ActionEditedPropertiesNotFound", - "ActionEditsNotSupportedWithMarketplace", "ActionEditsReadOnlyEntity", "ActionNotFound", "ActionParameterInterfaceTypeNotFound", @@ -2491,20 +2394,17 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): "AttachmentNotFound", "AttachmentRidAlreadyExists", "AttachmentSizeExceededLimit", - "BranchNotSupportedWithMarketplaceQuery", "CipherChannelNotFound", "CompositePrimaryKeyNotSupported", "ConsistentSnapshotError", "DefaultAndNullGroupsNotSupported", "DerivedPropertyApiNamesNotUnique", - "DistinctEnumValuesExceededLimit", "DuplicateOrderBy", "EditObjectPermissionDenied", "FunctionEncounteredUserFacingError", "FunctionExecutionFailed", "FunctionExecutionTimedOut", "FunctionInvalidInput", - "FunctionNotSupportedWithTransaction", "HighScaleComputationNotEnabled", "IncompatibleNestedObjectSet", "InterfaceBasedObjectSetNotSupported", @@ -2525,7 +2425,6 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): "InvalidContentLength", "InvalidContentType", "InvalidDerivedPropertyDefinition", - "InvalidDerivedPropertyDefinitionOnInterface", "InvalidDurationGroupByPropertyType", "InvalidDurationGroupByPropertyTypeForInterface", "InvalidDurationGroupByValue", @@ -2575,7 +2474,6 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): "ObjectsExceededLimit", "ObjectsModifiedConcurrently", "OntologyApiNameNotUnique", - "OntologyDefinitionOutOfSync", "OntologyEditsExceededLimit", "OntologyNotFound", "OntologySyncing", diff --git a/foundry_sdk/v2/ontologies/models.py b/foundry_sdk/v2/ontologies/models.py index e514a12cc..5f1ec89e4 100644 --- a/foundry_sdk/v2/ontologies/models.py +++ b/foundry_sdk/v2/ontologies/models.py @@ -18,7 +18,6 @@ import typing from datetime import date -import annotated_types import pydantic import typing_extensions @@ -259,54 +258,26 @@ class AggregateTimeSeries(core.ModelBase): AggregationAccuracyRequest = typing.Literal["REQUIRE_ACCURATE", "ALLOW_APPROXIMATE"] -""" -Specifies the accuracy requirement for aggregation results. - -- `REQUIRE_ACCURATE`: Only return results if they are guaranteed to be accurate. If accuracy cannot be - guaranteed (e.g., due to a low `maxGroupCount` relative to distinct values), the request will fail - with an `AggregationAccuracyNotSupported` error. -- `ALLOW_APPROXIMATE`: Allow approximate results when exact computation is not feasible. This is the - default behavior if not specified. -""" +"""AggregationAccuracyRequest""" class AggregationDurationGroupingV2(core.ModelBase): """ Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. - Either `field` or `propertyIdentifier` must be supplied, but not both. """ - field: typing.Optional[PropertyApiName] = None - property_identifier: typing.Optional[PropertyIdentifier] = pydantic.Field(alias=str("propertyIdentifier"), default=None) # type: ignore[literal-required] + field: PropertyApiName value: int unit: TimeUnit type: typing.Literal["duration"] = "duration" class AggregationExactGroupingV2(core.ModelBase): - """ - Divides objects into groups according to an exact value. - Either `field` or `propertyIdentifier` must be supplied, but not both. - """ + """Divides objects into groups according to an exact value.""" - field: typing.Optional[PropertyApiName] = None - property_identifier: typing.Optional[PropertyIdentifier] = pydantic.Field(alias=str("propertyIdentifier"), default=None) # type: ignore[literal-required] + field: PropertyApiName max_group_count: typing.Optional[int] = pydantic.Field(alias=str("maxGroupCount"), default=None) # type: ignore[literal-required] - """ - The maximum number of groups to return. If omitted, defaults to 10,000. - - The server allocates resources based on the specified `maxGroupCount`. When the number of distinct - values in your data is within this limit, results are accurate and the top N values are returned - correctly. When distinct values exceed what the allocated resources can handle, results may become - approximate. - - If you need accurate results with high-cardinality properties, set `maxGroupCount` high enough to - cover your distinct values. Items exceeding the limit are excluded from results and counted in - `excludedItems`. The response `accuracy` field indicates whether the results are `ACCURATE` or - `APPROXIMATE`. - """ - default_value: typing.Optional[str] = pydantic.Field(alias=str("defaultValue"), default=None) # type: ignore[literal-required] """ Includes a group with the specified default value that includes all objects where the specified field's value is null. @@ -323,13 +294,9 @@ class AggregationExactGroupingV2(core.ModelBase): class AggregationFixedWidthGroupingV2(core.ModelBase): - """ - Divides objects into groups with the specified width. - Either `field` or `propertyIdentifier` must be supplied, but not both. - """ + """Divides objects into groups with the specified width.""" - field: typing.Optional[PropertyApiName] = None - property_identifier: typing.Optional[PropertyIdentifier] = pydantic.Field(alias=str("propertyIdentifier"), default=None) # type: ignore[literal-required] + field: PropertyApiName fixed_width: int = pydantic.Field(alias=str("fixedWidth")) # type: ignore[literal-required] type: typing.Literal["fixedWidth"] = "fixedWidth" @@ -380,13 +347,9 @@ class AggregationRangeV2(core.ModelBase): class AggregationRangesGroupingV2(core.ModelBase): - """ - Divides objects into groups according to specified ranges. - Either `field` or `propertyIdentifier` must be supplied, but not both. - """ + """Divides objects into groups according to specified ranges.""" - field: typing.Optional[PropertyApiName] = None - property_identifier: typing.Optional[PropertyIdentifier] = pydantic.Field(alias=str("propertyIdentifier"), default=None) # type: ignore[literal-required] + field: PropertyApiName ranges: typing.List[AggregationRangeV2] type: typing.Literal["ranges"] = "ranges" @@ -479,26 +442,18 @@ class ApplyReducersLoadLevel(core.ModelBase): class ApproximateDistinctAggregationV2(core.ModelBase): - """ - Computes an approximate number of distinct values for the provided field. - Either `field` or `propertyIdentifier` must be supplied, but not both. - """ + """Computes an approximate number of distinct values for the provided field.""" - field: typing.Optional[PropertyApiName] = None - property_identifier: typing.Optional[PropertyIdentifier] = pydantic.Field(alias=str("propertyIdentifier"), default=None) # type: ignore[literal-required] + field: PropertyApiName name: typing.Optional[AggregationMetricName] = None direction: typing.Optional[OrderByDirection] = None type: typing.Literal["approximateDistinct"] = "approximateDistinct" class ApproximatePercentileAggregationV2(core.ModelBase): - """ - Computes the approximate percentile value for the provided field. Requires Object Storage V2. - Either `field` or `propertyIdentifier` must be supplied, but not both. - """ + """Computes the approximate percentile value for the provided field. Requires Object Storage V2.""" - field: typing.Optional[PropertyApiName] = None - property_identifier: typing.Optional[PropertyIdentifier] = pydantic.Field(alias=str("propertyIdentifier"), default=None) # type: ignore[literal-required] + field: PropertyApiName name: typing.Optional[AggregationMetricName] = None approximate_percentile: float = pydantic.Field(alias=str("approximatePercentile")) # type: ignore[literal-required] direction: typing.Optional[OrderByDirection] = None @@ -572,13 +527,9 @@ class AttachmentV2(core.ModelBase): class AvgAggregationV2(core.ModelBase): - """ - Computes the average value for the provided field. - Either `field` or `propertyIdentifier` must be supplied, but not both. - """ + """Computes the average value for the provided field.""" - field: typing.Optional[PropertyApiName] = None - property_identifier: typing.Optional[PropertyIdentifier] = pydantic.Field(alias=str("propertyIdentifier"), default=None) # type: ignore[literal-required] + field: PropertyApiName name: typing.Optional[AggregationMetricName] = None direction: typing.Optional[OrderByDirection] = None type: typing.Literal["avg"] = "avg" @@ -672,7 +623,6 @@ class BoundingBoxValue(core.ModelBase): top_left: WithinBoundingBoxPoint = pydantic.Field(alias=str("topLeft")) # type: ignore[literal-required] bottom_right: WithinBoundingBoxPoint = pydantic.Field(alias=str("bottomRight")) # type: ignore[literal-required] - type: typing.Literal["envelope"] = "envelope" class CenterPoint(core.ModelBase): @@ -1222,26 +1172,12 @@ class DoubleVector(core.ModelBase): """EditHistoryEdit""" -EditsHistoryFilter = typing_extensions.Annotated[ - typing.Union["EditsHistoryTimestampFilter", "EditsHistoryOperationIdsFilter"], - pydantic.Field(discriminator="type"), -] -"""EditsHistoryFilter""" +EditTypeFilter = typing.Literal["create", "modify", "delete"] +"""EditTypeFilter""" -class EditsHistoryOperationIdsFilter(core.ModelBase): - """EditsHistoryOperationIdsFilter""" - - operation_ids: typing.List[ActionRid] = pydantic.Field(alias=str("operationIds")) # type: ignore[literal-required] - type: typing.Literal["operationIdsFilter"] = "operationIdsFilter" - - -EditsHistorySortOrder = typing.Literal["newest_first", "oldest_first"] -"""EditsHistorySortOrder""" - - -class EditsHistoryTimestampFilter(core.ModelBase): - """EditsHistoryTimestampFilter""" +class EditsHistoryFilters(core.ModelBase): + """EditsHistoryFilters""" start_time: typing.Optional[core.AwareDatetime] = pydantic.Field(alias=str("startTime"), default=None) # type: ignore[literal-required] """ @@ -1255,7 +1191,27 @@ class EditsHistoryTimestampFilter(core.ModelBase): ISO 8601 format. Example: "2024-12-31T23:59:59Z" """ - type: typing.Literal["timestampFilter"] = "timestampFilter" + action_types: typing.List[ActionTypeApiName] = pydantic.Field(alias=str("actionTypes")) # type: ignore[literal-required] + """ + Filter edits to only those caused by specific action types. + If not specified, edits from all action types are returned. + """ + + edit_types: typing.List[EditTypeFilter] = pydantic.Field(alias=str("editTypes")) # type: ignore[literal-required] + """ + Filter edits by operation type (create, modify, or delete). + If not specified, all edit types are returned. + """ + + user_ids: typing.List[str] = pydantic.Field(alias=str("userIds")) # type: ignore[literal-required] + """ + Filter edits to only those performed by specific users. + If not specified, edits from all users are returned. + """ + + +EditsHistorySortOrder = typing.Literal["newest_first", "oldest_first"] +"""EditsHistorySortOrder""" class EntrySetType(core.ModelBase): @@ -1277,8 +1233,6 @@ class EqualsQueryV2(core.ModelBase): """ Returns objects where the specified field is equal to a value. Allows you to specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - - For string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager. """ field: typing.Optional[PropertyApiName] = None @@ -1306,14 +1260,9 @@ class ErrorComputingSecurity(core.ModelBase): 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. - Either `field` or `propertyIdentifier` must be supplied, but not both. - """ + """Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.""" - field: typing.Optional[PropertyApiName] = None - property_identifier: typing.Optional[PropertyIdentifier] = pydantic.Field(alias=str("propertyIdentifier"), default=None) # type: ignore[literal-required] + field: PropertyApiName name: typing.Optional[AggregationMetricName] = None direction: typing.Optional[OrderByDirection] = None type: typing.Literal["exactDistinct"] = "exactDistinct" @@ -1399,58 +1348,10 @@ class FunctionLogicRule(core.ModelBase): """ -class FuzzyRule(core.ModelBase): - """ - Matches intervals containing terms that are similar to the provided term, within an edit distance - defined by fuzziness. An edit is a single character change needed to make a term match, including - character insertion, deletion, substitution, or transposition of two adjacent characters. - """ - - term: str - """The term to match.""" - - fuzziness: typing.Optional[int] = None - """Maximum edit distance allowed for matching. Valid values are 0, 1, or 2. Defaults to 2.""" - - type: typing.Literal["fuzzy"] = "fuzzy" - - FuzzyV2 = bool """Setting fuzzy to `true` allows approximate matching in search queries that support it.""" -class GeoJsonString(core.ModelBase): - """A GeoJSON geometry specification.""" - - geo_json: str = pydantic.Field(alias=str("geoJson")) # type: ignore[literal-required] - """ - A GeoJSON geometry string. Supported geometry types include Point, MultiPoint, LineString, - MultiLineString, Polygon, MultiPolygon, and GeometryCollection. - """ - - type: typing.Literal["geoJson"] = "geoJson" - - -GeoShapeV2Geometry = typing_extensions.Annotated[ - typing.Union["BoundingBoxValue", "GeoJsonString"], pydantic.Field(discriminator="type") -] -"""Geometry specification for a GeoShapeV2Query. Supports bounding box envelopes and arbitrary GeoJSON geometries.""" - - -class GeoShapeV2Query(core.ModelBase): - """ - Returns objects where the specified field satisfies the provided geometry query with the given spatial operator. - Supports both envelope (bounding box) and GeoJSON geometries for filtering geopoint or geoshape properties. - Either `field` or `propertyIdentifier` can be supplied, but not both. - """ - - field: typing.Optional[PropertyApiName] = None - property_identifier: typing.Optional[PropertyIdentifier] = pydantic.Field(alias=str("propertyIdentifier"), default=None) # type: ignore[literal-required] - geometry: GeoShapeV2Geometry - spatial_filter_mode: SpatialFilterMode = pydantic.Field(alias=str("spatialFilterMode")) # type: ignore[literal-required] - type: typing.Literal["geoShapeV2"] = "geoShapeV2" - - class GeotemporalSeriesEntry(core.ModelBase): """A single geotemporal data point representing the location of an entity at a specific point in time.""" @@ -1468,74 +1369,6 @@ class GeotimeSeriesValue(core.ModelBase): type: typing.Literal["geotimeSeriesValue"] = "geotimeSeriesValue" -class GetActionTypeByRidBatchRequest(core.ModelBase): - """GetActionTypeByRidBatchRequest""" - - requests: typing_extensions.Annotated[ - typing.List[GetActionTypeByRidBatchRequestElement], - annotated_types.Len(min_length=1, max_length=100), - ] - - -class GetActionTypeByRidBatchRequestElement(core.ModelBase): - """GetActionTypeByRidBatchRequestElement""" - - action_type_rid: ActionTypeRid = pydantic.Field(alias=str("actionTypeRid")) # type: ignore[literal-required] - - -class GetActionTypeByRidBatchResponse(core.ModelBase): - """GetActionTypeByRidBatchResponse""" - - data: typing.List[ActionTypeV2] - - -class GetObjectTypeByRidBatchRequest(core.ModelBase): - """GetObjectTypeByRidBatchRequest""" - - requests: typing_extensions.Annotated[ - typing.List[GetObjectTypeByRidBatchRequestElement], - annotated_types.Len(min_length=1, max_length=100), - ] - - -class GetObjectTypeByRidBatchRequestElement(core.ModelBase): - """GetObjectTypeByRidBatchRequestElement""" - - object_type_rid: ObjectTypeRid = pydantic.Field(alias=str("objectTypeRid")) # type: ignore[literal-required] - - -class GetObjectTypeByRidBatchResponse(core.ModelBase): - """GetObjectTypeByRidBatchResponse""" - - data: typing.List[ObjectTypeV2] - - -class GetOutgoingLinkTypesByObjectTypeRidBatchRequest(core.ModelBase): - """GetOutgoingLinkTypesByObjectTypeRidBatchRequest""" - - requests: typing_extensions.Annotated[ - typing.List[GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement], - annotated_types.Len(min_length=1, max_length=100), - ] - filter_link_type_rids: typing.List[LinkTypeRid] = pydantic.Field(alias=str("filterLinkTypeRids")) # type: ignore[literal-required] - """ - If provided, only return outgoing link types with RIDs in this list. - If omitted, all outgoing link types for each requested object type are returned. - """ - - -class GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement(core.ModelBase): - """GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement""" - - object_type_rid: ObjectTypeRid = pydantic.Field(alias=str("objectTypeRid")) # type: ignore[literal-required] - - -class GetOutgoingLinkTypesByObjectTypeRidBatchResponse(core.ModelBase): - """GetOutgoingLinkTypesByObjectTypeRidBatchResponse""" - - data: typing.Dict[ObjectTypeRid, typing.List[LinkTypeSideV2]] - - class GetSelectedPropertyOperation(core.ModelBase): """ Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could @@ -1599,8 +1432,6 @@ 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. 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. - - For string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager. """ field: typing.Optional[PropertyApiName] = None @@ -1913,7 +1744,7 @@ class IntervalQuery(core.ModelBase): IntervalQueryRule = typing_extensions.Annotated[ - typing.Union["AllOfRule", "MatchRule", "AnyOfRule", "PrefixOnLastTokenRule", "FuzzyRule"], + typing.Union["AllOfRule", "MatchRule", "AnyOfRule", "PrefixOnLastTokenRule"], pydantic.Field(discriminator="type"), ] """Sub-rule used for evaluating an IntervalQuery""" @@ -2314,7 +2145,6 @@ class LoadObjectSetV2ObjectsOrInterfacesResponse(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] - transaction_id: typing.Optional[OntologyTransactionId] = pydantic.Field(alias=str("transactionId"), default=None) # type: ignore[literal-required] class LoadOntologyMetadataRequest(core.ModelBase): @@ -2411,13 +2241,9 @@ class MatchRule(core.ModelBase): class MaxAggregationV2(core.ModelBase): - """ - Computes the maximum value for the provided field. - Either `field` or `propertyIdentifier` must be supplied, but not both. - """ + """Computes the maximum value for the provided field.""" - field: typing.Optional[PropertyApiName] = None - property_identifier: typing.Optional[PropertyIdentifier] = pydantic.Field(alias=str("propertyIdentifier"), default=None) # type: ignore[literal-required] + field: PropertyApiName name: typing.Optional[AggregationMetricName] = None direction: typing.Optional[OrderByDirection] = None type: typing.Literal["max"] = "max" @@ -2432,13 +2258,9 @@ class MediaMetadata(core.ModelBase): class MinAggregationV2(core.ModelBase): - """ - Computes the minimum value for the provided field. - Either `field` or `propertyIdentifier` must be supplied, but not both. - """ + """Computes the minimum value for the provided field.""" - field: typing.Optional[PropertyApiName] = None - property_identifier: typing.Optional[PropertyIdentifier] = pydantic.Field(alias=str("propertyIdentifier"), default=None) # type: ignore[literal-required] + field: PropertyApiName name: typing.Optional[AggregationMetricName] = None direction: typing.Optional[OrderByDirection] = None type: typing.Literal["min"] = "min" @@ -2756,7 +2578,6 @@ class ObjectEditHistoryEntry(core.ModelBase): created, modified, or deleted as part of an action execution. """ - object_primary_key: ObjectPrimaryKeyV2 = pydantic.Field(alias=str("objectPrimaryKey")) # type: ignore[literal-required] operation_id: ActionRid = pydantic.Field(alias=str("operationId")) # type: ignore[literal-required] action_type_rid: ActionTypeRid = pydantic.Field(alias=str("actionTypeRid")) # type: ignore[literal-required] user_id: str = pydantic.Field(alias=str("userId")) # type: ignore[literal-required] @@ -3124,7 +2945,7 @@ class ObjectTypeEditsHistoryRequest(core.ModelBase): """ object_primary_key: typing.Optional[ObjectPrimaryKeyV2] = pydantic.Field(alias=str("objectPrimaryKey"), default=None) # type: ignore[literal-required] - filters: typing.Optional[EditsHistoryFilter] = None + filters: typing.Optional[EditsHistoryFilters] = None sort_order: typing.Optional[EditsHistorySortOrder] = pydantic.Field(alias=str("sortOrder"), default=None) # type: ignore[literal-required] include_all_previous_properties: typing.Optional[bool] = pydantic.Field(alias=str("includeAllPreviousProperties"), default=None) # type: ignore[literal-required] page_size: typing.Optional[int] = pydantic.Field(alias=str("pageSize"), default=None) # type: ignore[literal-required] @@ -3257,7 +3078,6 @@ class OntologyArrayType(core.ModelBase): core_models.CipherTextType, core_models.MarkingType, core_models.UnsupportedType, - core_models.MediaReferenceType, "OntologyArrayType", "OntologyObjectSetType", core_models.BinaryType, @@ -3936,28 +3756,25 @@ class QueryArrayType(core.ModelBase): core_models.DateType, "OntologyInterfaceObjectType", "QueryStructType", + "QuerySetType", core_models.StringType, + "EntrySetType", + core_models.DoubleType, core_models.IntegerType, "ThreeDimensionalAggregation", + "QueryUnionType", core_models.FloatType, core_models.LongType, + core_models.BooleanType, core_models.UnsupportedType, core_models.AttachmentType, + core_models.NullType, "QueryArrayType", "OntologyObjectSetType", "TwoDimensionalAggregation", - "QueryTypeReferenceType", - core_models.TimestampType, - "QuerySetType", - core_models.VoidType, - "EntrySetType", - core_models.DoubleType, - "QueryUnionType", - core_models.BooleanType, - core_models.MediaReferenceType, - core_models.NullType, "OntologyInterfaceObjectSetType", "OntologyObjectType", + core_models.TimestampType, ], pydantic.Field(discriminator="type"), ] @@ -3969,7 +3786,6 @@ class QueryParameterV2(core.ModelBase): description: typing.Optional[str] = None data_type: QueryDataType = pydantic.Field(alias=str("dataType")) # type: ignore[literal-required] - required: bool QueryRuntimeErrorParameter = str @@ -4009,16 +3825,6 @@ class QueryTwoDimensionalAggregation(core.ModelBase): groups: typing.List[QueryAggregation] -class QueryTypeReferenceType(core.ModelBase): - """ - A reference to a type that is defined in the `typeReferences` map of the enclosing Query. - This enables support for recursive type definitions where a type may reference itself. - """ - - type_id: TypeReferenceIdentifier = pydantic.Field(alias=str("typeId")) # type: ignore[literal-required] - type: typing.Literal["typeReference"] = "typeReference" - - class QueryTypeV2(core.ModelBase): """Represents a query type in the Ontology.""" @@ -4029,7 +3835,6 @@ class QueryTypeV2(core.ModelBase): output: QueryDataType rid: FunctionRid version: FunctionVersion - type_references: typing.Dict[TypeReferenceIdentifier, QueryDataType] = pydantic.Field(alias=str("typeReferences")) # type: ignore[literal-required] class QueryUnionType(core.ModelBase): @@ -4109,26 +3914,7 @@ class RegexConstraint(core.ModelBase): class RegexQuery(core.ModelBase): """ Returns objects where the specified field matches the regex pattern provided. This applies to the non-analyzed - form of text fields. Supported operators: - - `.` matches any character. - - `?` repeats the previous character 0 or 1 times. - - `+` repeats the previous character 1 or more times. - - `*` repeats the previous character 0 or more times. - - `{}` defines the minimum and maximum number of times the preceding character can repeat. `{2}` means the - previous character must repeat only twice, `{2,}` means the previous character must repeat at least twice, - and `{2,4}` means the previous character must repeat between 2-4 times. - - `|` is the OR operator. - - `()` forms a group within an expression such that the group can be treated as a single character. - - `[]` matches a single one of the characters contained inside the brackets, meaning [abc] matches `a`, `b` or - `c`. Unless `-` is the first character or escaped with `\\` (in which case it is treated as a normal character), - `-` can be used inside the bracket to create a range of characters, meaning [a-c] matches `a`, `b`, or `c`. - If the character sequence inside the brackets begins with `^`, the set of characters is negated, meaning - [^abc] does not match `a`, `b`, or `c`. Otherwise, `^` is treated as a normal character. - - `"` creates groups of string literals. - - `\\` is used as an escape character. However, \\d and \\D match digit and non-digit characters respectively, \\s - and \\S match whitespace and non whitespace characters respectively, and \\w and \\W match word and non word - characters respectively. - + form of text fields and supports standard regex syntax of dot (.), star(*) and question mark(?). Either `field` or `propertyIdentifier` can be supplied, but not both. """ @@ -4293,7 +4079,6 @@ class RollingAggregateWindowPoints(core.ModelBase): "IsNullQueryV2", "ContainsAnyTermQuery", "IntervalQuery", - "GeoShapeV2Query", "StartsWithQuery", ], pydantic.Field(discriminator="type"), @@ -4583,14 +4368,6 @@ class SharedPropertyType(core.ModelBase): """The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs.""" -SpatialFilterMode = typing.Literal["INTERSECTS", "DISJOINT", "WITHIN", "CONTAINS"] -""" -The spatial relation operator for a GeoShapeV2Query. INTERSECTS matches objects that intersect the provided -geometry, DISJOINT matches objects that do not intersect the provided geometry, WITHIN matches objects that -lie within the provided geometry, and CONTAINS matches objects that contain the provided geometry. -""" - - class StartsWithQuery(core.ModelBase): """ Deprecated alias for `containsAllTermsInOrderPrefixLastTerm`, which is preferred because the name `startsWith` is misleading. @@ -4885,13 +4662,9 @@ class SubtractPropertyExpression(core.ModelBase): class SumAggregationV2(core.ModelBase): - """ - Computes the sum of values for the provided field. - Either `field` or `propertyIdentifier` must be supplied, but not both. - """ + """Computes the sum of values for the provided field.""" - field: typing.Optional[PropertyApiName] = None - property_identifier: typing.Optional[PropertyIdentifier] = pydantic.Field(alias=str("propertyIdentifier"), default=None) # type: ignore[literal-required] + field: PropertyApiName name: typing.Optional[AggregationMetricName] = None direction: typing.Optional[OrderByDirection] = None type: typing.Literal["sum"] = "sum" @@ -4900,7 +4673,6 @@ class SumAggregationV2(core.ModelBase): class SyncApplyActionResponseV2(core.ModelBase): """SyncApplyActionResponseV2""" - operation_id: typing.Optional[core.RID] = pydantic.Field(alias=str("operationId"), default=None) # type: ignore[literal-required] validation: typing.Optional[ValidateActionResponseV2] = None edits: typing.Optional[ActionResults] = None @@ -5088,13 +4860,6 @@ class TypeClass(core.ModelBase): """The value of the type class.""" -TypeReferenceIdentifier = str -""" -The unique identifier of a type reference. This identifier is used to look up the -type definition in the `typeReferences` map of the enclosing Query. -""" - - class UnevaluableConstraint(core.ModelBase): """ The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. @@ -5404,8 +5169,6 @@ class WithinPolygonQuery(core.ModelBase): core.resolve_forward_references(DisjunctiveMarkingSummary, globalns=globals(), localns=locals()) core.resolve_forward_references(DurationFormatStyle, globalns=globals(), localns=locals()) core.resolve_forward_references(EditHistoryEdit, globalns=globals(), localns=locals()) -core.resolve_forward_references(EditsHistoryFilter, globalns=globals(), localns=locals()) -core.resolve_forward_references(GeoShapeV2Geometry, globalns=globals(), localns=locals()) core.resolve_forward_references( InterfaceLinkTypeLinkedEntityApiName, globalns=globals(), localns=locals() ) @@ -5610,10 +5373,9 @@ class WithinPolygonQuery(core.ModelBase): "DurationFormatStyle", "DurationPrecision", "EditHistoryEdit", - "EditsHistoryFilter", - "EditsHistoryOperationIdsFilter", + "EditTypeFilter", + "EditsHistoryFilters", "EditsHistorySortOrder", - "EditsHistoryTimestampFilter", "EntrySetType", "EnumConstraint", "EqualsQueryV2", @@ -5634,22 +5396,9 @@ class WithinPolygonQuery(core.ModelBase): "FunctionParameterName", "FunctionRid", "FunctionVersion", - "FuzzyRule", "FuzzyV2", - "GeoJsonString", - "GeoShapeV2Geometry", - "GeoShapeV2Query", "GeotemporalSeriesEntry", "GeotimeSeriesValue", - "GetActionTypeByRidBatchRequest", - "GetActionTypeByRidBatchRequestElement", - "GetActionTypeByRidBatchResponse", - "GetObjectTypeByRidBatchRequest", - "GetObjectTypeByRidBatchRequestElement", - "GetObjectTypeByRidBatchResponse", - "GetOutgoingLinkTypesByObjectTypeRidBatchRequest", - "GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement", - "GetOutgoingLinkTypesByObjectTypeRidBatchResponse", "GetSelectedPropertyOperation", "GreatestPropertyExpression", "GroupMemberConstraint", @@ -5894,7 +5643,6 @@ class WithinPolygonQuery(core.ModelBase): "QueryStructType", "QueryThreeDimensionalAggregation", "QueryTwoDimensionalAggregation", - "QueryTypeReferenceType", "QueryTypeV2", "QueryUnionType", "RangeConstraint", @@ -5945,7 +5693,6 @@ class WithinPolygonQuery(core.ModelBase): "SharedPropertyType", "SharedPropertyTypeApiName", "SharedPropertyTypeRid", - "SpatialFilterMode", "StartsWithQuery", "StaticArgument", "StreamGeotemporalSeriesValuesRequest", @@ -5999,7 +5746,6 @@ class WithinPolygonQuery(core.ModelBase): "TransactionEdit", "TwoDimensionalAggregation", "TypeClass", - "TypeReferenceIdentifier", "UnevaluableConstraint", "UniqueIdentifierArgument", "UniqueIdentifierLinkId", diff --git a/foundry_sdk/v2/ontologies/object_type.py b/foundry_sdk/v2/ontologies/object_type.py index 10a9beee1..447ec6ef1 100644 --- a/foundry_sdk/v2/ontologies/object_type.py +++ b/foundry_sdk/v2/ontologies/object_type.py @@ -15,7 +15,6 @@ import typing -import annotated_types import pydantic import typing_extensions @@ -103,69 +102,6 @@ def get( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get_by_rid_batch( - self, - ontology: ontologies_models.OntologyIdentifier, - *, - requests: typing_extensions.Annotated[ - typing.List[ontologies_models.GetObjectTypeByRidBatchRequestElement], - annotated_types.Len(min_length=1, max_length=100), - ], - branch: typing.Optional[core_models.FoundryBranch] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.GetObjectTypeByRidBatchResponse: - """ - Gets a list of object types by RID in bulk. - - Object types are filtered from the response if they don't exist or the requesting token lacks the required - permissions. - - The maximum batch size for this endpoint is 100. - - :param ontology: - :type ontology: OntologyIdentifier - :param requests: - :type requests: List[GetObjectTypeByRidBatchRequestElement] - :param branch: The Foundry branch to load the object type definitions 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 preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.GetObjectTypeByRidBatchResponse - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/objectTypes/getByRidBatch", - query_params={ - "branch": branch, - "preview": preview, - }, - path_params={ - "ontology": ontology, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=ontologies_models.GetObjectTypeByRidBatchRequest( - requests=requests, - ), - response_type=ontologies_models.GetObjectTypeByRidBatchResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -175,7 +111,7 @@ def get_edits_history( object_type: ontologies_models.ObjectTypeApiName, *, branch: typing.Optional[core_models.FoundryBranch] = None, - filters: typing.Optional[ontologies_models.EditsHistoryFilter] = None, + filters: typing.Optional[ontologies_models.EditsHistoryFilters] = None, include_all_previous_properties: typing.Optional[bool] = None, object_primary_key: typing.Optional[ontologies_models.ObjectPrimaryKeyV2] = None, page_size: typing.Optional[int] = None, @@ -189,9 +125,10 @@ def get_edits_history( specific object type. This endpoint provides visibility into all actions that have modified objects of this type. - The edits are returned in reverse chronological order (most recent first) by default. + The edits are returned in reverse chronological order (most recent first). - Note that filters are ignored for OSv1 object types. + WARNING: right now this endpoint works only if you pass in an object primary key, i.e. it does not function + as a global object type edits history. Global object type edits history is currently under development. :param ontology: The ontology RID or API name :type ontology: OntologyIdentifier @@ -200,7 +137,7 @@ def get_edits_history( :param branch: The Foundry branch from which we will get edits history. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. :type branch: Optional[FoundryBranch] :param filters: - :type filters: Optional[EditsHistoryFilter] + :type filters: Optional[EditsHistoryFilters] :param include_all_previous_properties: :type include_all_previous_properties: Optional[bool] :param object_primary_key: @@ -361,76 +298,6 @@ def get_outgoing_link_type( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get_outgoing_link_types_by_object_type_rid_batch( - self, - ontology: ontologies_models.OntologyIdentifier, - *, - filter_link_type_rids: typing.List[ontologies_models.LinkTypeRid], - requests: typing_extensions.Annotated[ - typing.List[ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement], - annotated_types.Len(min_length=1, max_length=100), - ], - branch: typing.Optional[core_models.FoundryBranch] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse: - """ - Gets outgoing link types for a batch of object types, identified by their RIDs. - - For each requested object type, returns the list of outgoing link types visible to the - requesting token. Optionally, results can be filtered to only include specific link type RIDs. - - Object types that don't exist or that the requesting token lacks permissions for are - silently omitted from the response. - - The maximum batch size for this endpoint is 100. - - :param ontology: - :type ontology: OntologyIdentifier - :param filter_link_type_rids: If provided, only return outgoing link types with RIDs in this list. If omitted, all outgoing link types for each requested object type are returned. - :type filter_link_type_rids: List[LinkTypeRid] - :param requests: - :type requests: List[GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement] - :param branch: The Foundry branch to load the outgoing link type definitions 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 preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/outgoingLinkTypes/getByRidBatch", - query_params={ - "branch": branch, - "preview": preview, - }, - path_params={ - "ontology": ontology, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchRequest( - requests=requests, - filter_link_type_rids=filter_link_type_rids, - ), - response_type=ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -549,27 +416,18 @@ def list_outgoing_link_types( class _ObjectTypeClientRaw: def __init__(self, client: ObjectTypeClient) -> None: def get(_: ontologies_models.ObjectTypeV2): ... - def get_by_rid_batch(_: ontologies_models.GetObjectTypeByRidBatchResponse): ... def get_edits_history(_: ontologies_models.ObjectTypeEditsHistoryResponse): ... def get_full_metadata(_: ontologies_models.ObjectTypeFullMetadata): ... def get_outgoing_link_type(_: ontologies_models.LinkTypeSideV2): ... - def get_outgoing_link_types_by_object_type_rid_batch( - _: ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse, - ): ... def list(_: ontologies_models.ListObjectTypesV2Response): ... def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV2): ... self.get = core.with_raw_response(get, client.get) - self.get_by_rid_batch = core.with_raw_response(get_by_rid_batch, client.get_by_rid_batch) self.get_edits_history = core.with_raw_response(get_edits_history, client.get_edits_history) self.get_full_metadata = core.with_raw_response(get_full_metadata, client.get_full_metadata) self.get_outgoing_link_type = core.with_raw_response( get_outgoing_link_type, client.get_outgoing_link_type ) - self.get_outgoing_link_types_by_object_type_rid_batch = core.with_raw_response( - get_outgoing_link_types_by_object_type_rid_batch, - client.get_outgoing_link_types_by_object_type_rid_batch, - ) self.list = core.with_raw_response(list, client.list) self.list_outgoing_link_types = core.with_raw_response( list_outgoing_link_types, client.list_outgoing_link_types @@ -579,20 +437,13 @@ def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV class _ObjectTypeClientStreaming: def __init__(self, client: ObjectTypeClient) -> None: def get(_: ontologies_models.ObjectTypeV2): ... - def get_by_rid_batch(_: ontologies_models.GetObjectTypeByRidBatchResponse): ... def get_edits_history(_: ontologies_models.ObjectTypeEditsHistoryResponse): ... def get_full_metadata(_: ontologies_models.ObjectTypeFullMetadata): ... def get_outgoing_link_type(_: ontologies_models.LinkTypeSideV2): ... - def get_outgoing_link_types_by_object_type_rid_batch( - _: ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse, - ): ... def list(_: ontologies_models.ListObjectTypesV2Response): ... def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV2): ... self.get = core.with_streaming_response(get, client.get) - self.get_by_rid_batch = core.with_streaming_response( - get_by_rid_batch, client.get_by_rid_batch - ) self.get_edits_history = core.with_streaming_response( get_edits_history, client.get_edits_history ) @@ -602,10 +453,6 @@ def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV self.get_outgoing_link_type = core.with_streaming_response( get_outgoing_link_type, client.get_outgoing_link_type ) - self.get_outgoing_link_types_by_object_type_rid_batch = core.with_streaming_response( - get_outgoing_link_types_by_object_type_rid_batch, - client.get_outgoing_link_types_by_object_type_rid_batch, - ) self.list = core.with_streaming_response(list, client.list) self.list_outgoing_link_types = core.with_streaming_response( list_outgoing_link_types, client.list_outgoing_link_types @@ -690,69 +537,6 @@ def get( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get_by_rid_batch( - self, - ontology: ontologies_models.OntologyIdentifier, - *, - requests: typing_extensions.Annotated[ - typing.List[ontologies_models.GetObjectTypeByRidBatchRequestElement], - annotated_types.Len(min_length=1, max_length=100), - ], - branch: typing.Optional[core_models.FoundryBranch] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[ontologies_models.GetObjectTypeByRidBatchResponse]: - """ - Gets a list of object types by RID in bulk. - - Object types are filtered from the response if they don't exist or the requesting token lacks the required - permissions. - - The maximum batch size for this endpoint is 100. - - :param ontology: - :type ontology: OntologyIdentifier - :param requests: - :type requests: List[GetObjectTypeByRidBatchRequestElement] - :param branch: The Foundry branch to load the object type definitions 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 preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[ontologies_models.GetObjectTypeByRidBatchResponse] - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/objectTypes/getByRidBatch", - query_params={ - "branch": branch, - "preview": preview, - }, - path_params={ - "ontology": ontology, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=ontologies_models.GetObjectTypeByRidBatchRequest( - requests=requests, - ), - response_type=ontologies_models.GetObjectTypeByRidBatchResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -762,7 +546,7 @@ def get_edits_history( object_type: ontologies_models.ObjectTypeApiName, *, branch: typing.Optional[core_models.FoundryBranch] = None, - filters: typing.Optional[ontologies_models.EditsHistoryFilter] = None, + filters: typing.Optional[ontologies_models.EditsHistoryFilters] = None, include_all_previous_properties: typing.Optional[bool] = None, object_primary_key: typing.Optional[ontologies_models.ObjectPrimaryKeyV2] = None, page_size: typing.Optional[int] = None, @@ -776,9 +560,10 @@ def get_edits_history( specific object type. This endpoint provides visibility into all actions that have modified objects of this type. - The edits are returned in reverse chronological order (most recent first) by default. + The edits are returned in reverse chronological order (most recent first). - Note that filters are ignored for OSv1 object types. + WARNING: right now this endpoint works only if you pass in an object primary key, i.e. it does not function + as a global object type edits history. Global object type edits history is currently under development. :param ontology: The ontology RID or API name :type ontology: OntologyIdentifier @@ -787,7 +572,7 @@ def get_edits_history( :param branch: The Foundry branch from which we will get edits history. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. :type branch: Optional[FoundryBranch] :param filters: - :type filters: Optional[EditsHistoryFilter] + :type filters: Optional[EditsHistoryFilters] :param include_all_previous_properties: :type include_all_previous_properties: Optional[bool] :param object_primary_key: @@ -948,76 +733,6 @@ def get_outgoing_link_type( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get_outgoing_link_types_by_object_type_rid_batch( - self, - ontology: ontologies_models.OntologyIdentifier, - *, - filter_link_type_rids: typing.List[ontologies_models.LinkTypeRid], - requests: typing_extensions.Annotated[ - typing.List[ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement], - annotated_types.Len(min_length=1, max_length=100), - ], - branch: typing.Optional[core_models.FoundryBranch] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse]: - """ - Gets outgoing link types for a batch of object types, identified by their RIDs. - - For each requested object type, returns the list of outgoing link types visible to the - requesting token. Optionally, results can be filtered to only include specific link type RIDs. - - Object types that don't exist or that the requesting token lacks permissions for are - silently omitted from the response. - - The maximum batch size for this endpoint is 100. - - :param ontology: - :type ontology: OntologyIdentifier - :param filter_link_type_rids: If provided, only return outgoing link types with RIDs in this list. If omitted, all outgoing link types for each requested object type are returned. - :type filter_link_type_rids: List[LinkTypeRid] - :param requests: - :type requests: List[GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement] - :param branch: The Foundry branch to load the outgoing link type definitions 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 preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse] - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/outgoingLinkTypes/getByRidBatch", - query_params={ - "branch": branch, - "preview": preview, - }, - path_params={ - "ontology": ontology, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchRequest( - requests=requests, - filter_link_type_rids=filter_link_type_rids, - ), - response_type=ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -1136,20 +851,13 @@ def list_outgoing_link_types( class _AsyncObjectTypeClientRaw: def __init__(self, client: AsyncObjectTypeClient) -> None: def get(_: ontologies_models.ObjectTypeV2): ... - def get_by_rid_batch(_: ontologies_models.GetObjectTypeByRidBatchResponse): ... def get_edits_history(_: ontologies_models.ObjectTypeEditsHistoryResponse): ... def get_full_metadata(_: ontologies_models.ObjectTypeFullMetadata): ... def get_outgoing_link_type(_: ontologies_models.LinkTypeSideV2): ... - def get_outgoing_link_types_by_object_type_rid_batch( - _: ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse, - ): ... def list(_: ontologies_models.ListObjectTypesV2Response): ... def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV2): ... self.get = core.async_with_raw_response(get, client.get) - self.get_by_rid_batch = core.async_with_raw_response( - get_by_rid_batch, client.get_by_rid_batch - ) self.get_edits_history = core.async_with_raw_response( get_edits_history, client.get_edits_history ) @@ -1159,10 +867,6 @@ def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV self.get_outgoing_link_type = core.async_with_raw_response( get_outgoing_link_type, client.get_outgoing_link_type ) - self.get_outgoing_link_types_by_object_type_rid_batch = core.async_with_raw_response( - get_outgoing_link_types_by_object_type_rid_batch, - client.get_outgoing_link_types_by_object_type_rid_batch, - ) self.list = core.async_with_raw_response(list, client.list) self.list_outgoing_link_types = core.async_with_raw_response( list_outgoing_link_types, client.list_outgoing_link_types @@ -1172,20 +876,13 @@ def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV class _AsyncObjectTypeClientStreaming: def __init__(self, client: AsyncObjectTypeClient) -> None: def get(_: ontologies_models.ObjectTypeV2): ... - def get_by_rid_batch(_: ontologies_models.GetObjectTypeByRidBatchResponse): ... def get_edits_history(_: ontologies_models.ObjectTypeEditsHistoryResponse): ... def get_full_metadata(_: ontologies_models.ObjectTypeFullMetadata): ... def get_outgoing_link_type(_: ontologies_models.LinkTypeSideV2): ... - def get_outgoing_link_types_by_object_type_rid_batch( - _: ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse, - ): ... def list(_: ontologies_models.ListObjectTypesV2Response): ... def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV2): ... self.get = core.async_with_streaming_response(get, client.get) - self.get_by_rid_batch = core.async_with_streaming_response( - get_by_rid_batch, client.get_by_rid_batch - ) self.get_edits_history = core.async_with_streaming_response( get_edits_history, client.get_edits_history ) @@ -1195,10 +892,6 @@ def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV self.get_outgoing_link_type = core.async_with_streaming_response( get_outgoing_link_type, client.get_outgoing_link_type ) - self.get_outgoing_link_types_by_object_type_rid_batch = core.async_with_streaming_response( - get_outgoing_link_types_by_object_type_rid_batch, - client.get_outgoing_link_types_by_object_type_rid_batch, - ) self.list = core.async_with_streaming_response(list, client.list) self.list_outgoing_link_types = core.async_with_streaming_response( list_outgoing_link_types, client.list_outgoing_link_types diff --git a/foundry_sdk/v2/ontologies/ontology_interface.py b/foundry_sdk/v2/ontologies/ontology_interface.py index 90225b445..a43829723 100644 --- a/foundry_sdk/v2/ontologies/ontology_interface.py +++ b/foundry_sdk/v2/ontologies/ontology_interface.py @@ -417,7 +417,6 @@ def list_objects_for_interface( order_by: typing.Optional[ontologies_models.OrderBy] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, select: typing.Optional[typing.List[ontologies_models.SelectedPropertyApiName]] = None, snapshot: typing.Optional[bool] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -452,8 +451,6 @@ def list_objects_for_interface( :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] :param select: The properties of the interface type that should be included in the response. Omit this parameter to get all the properties. :type select: Optional[List[SelectedPropertyApiName]] :param snapshot: 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. @@ -474,7 +471,6 @@ def list_objects_for_interface( "orderBy": order_by, "pageSize": page_size, "pageToken": page_token, - "preview": preview, "select": select, "snapshot": snapshot, }, @@ -1139,7 +1135,6 @@ def list_objects_for_interface( order_by: typing.Optional[ontologies_models.OrderBy] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, select: typing.Optional[typing.List[ontologies_models.SelectedPropertyApiName]] = None, snapshot: typing.Optional[bool] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -1174,8 +1169,6 @@ def list_objects_for_interface( :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :type preview: Optional[PreviewMode] :param select: The properties of the interface type that should be included in the response. Omit this parameter to get all the properties. :type select: Optional[List[SelectedPropertyApiName]] :param snapshot: 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. @@ -1196,7 +1189,6 @@ def list_objects_for_interface( "orderBy": order_by, "pageSize": page_size, "pageToken": page_token, - "preview": preview, "select": select, "snapshot": snapshot, }, diff --git a/foundry_sdk/v2/ontologies/ontology_object_set.py b/foundry_sdk/v2/ontologies/ontology_object_set.py index f442d7ea8..ccc7599b8 100644 --- a/foundry_sdk/v2/ontologies/ontology_object_set.py +++ b/foundry_sdk/v2/ontologies/ontology_object_set.py @@ -68,8 +68,6 @@ def aggregate( include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, transaction_id: typing.Optional[ontologies_models.OntologyTransactionId] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -95,10 +93,6 @@ def aggregate( :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The package version of the generated SDK. :type sdk_version: Optional[SdkVersion] - :param trace_parent: The W3C trace parent header included in the request. - :type trace_parent: Optional[TraceParent] - :param trace_state: The W3C trace state header included in the request. - :type trace_state: Optional[TraceState] :param transaction_id: The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[OntologyTransactionId] :param request_timeout: timeout setting for this request in seconds. @@ -121,8 +115,6 @@ def aggregate( "ontology": ontology, }, header_params={ - "traceParent": trace_parent, - "traceState": trace_state, "Content-Type": "application/json", "Accept": "application/json", }, @@ -151,8 +143,6 @@ def create_temporary( branch: typing.Optional[core_models.FoundryBranch] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> ontologies_models.CreateTemporaryObjectSetResponseV2: @@ -169,10 +159,6 @@ def create_temporary( :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The package version of the generated SDK. :type sdk_version: Optional[SdkVersion] - :param trace_parent: The W3C trace parent header included in the request. - :type trace_parent: Optional[TraceParent] - :param trace_state: The W3C trace state header included in the request. - :type trace_state: Optional[TraceState] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -192,8 +178,6 @@ def create_temporary( "ontology": ontology, }, header_params={ - "traceParent": trace_parent, - "traceState": trace_state, "Content-Type": "application/json", "Accept": "application/json", }, @@ -271,8 +255,6 @@ def load( sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, snapshot: typing.Optional[bool] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, transaction_id: typing.Optional[ontologies_models.OntologyTransactionId] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -315,10 +297,6 @@ def load( :type select_v2: Optional[List[PropertyIdentifier]] :param snapshot: 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. :type snapshot: Optional[bool] - :param trace_parent: The W3C trace parent header included in the request. - :type trace_parent: Optional[TraceParent] - :param trace_state: The W3C trace state header included in the request. - :type trace_state: Optional[TraceState] :param transaction_id: The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[OntologyTransactionId] :param request_timeout: timeout setting for this request in seconds. @@ -341,8 +319,6 @@ def load( "ontology": ontology, }, header_params={ - "traceParent": trace_parent, - "traceState": trace_state, "Content-Type": "application/json", "Accept": "application/json", }, @@ -380,8 +356,6 @@ def load_links( preview: typing.Optional[core_models.PreviewMode] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> ontologies_models.LoadObjectSetLinksResponseV2: @@ -419,10 +393,6 @@ def load_links( :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The package version of the generated SDK. :type sdk_version: Optional[SdkVersion] - :param trace_parent: The W3C trace parent header included in the request. - :type trace_parent: Optional[TraceParent] - :param trace_state: The W3C trace state header included in the request. - :type trace_state: Optional[TraceState] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -443,8 +413,6 @@ def load_links( "ontology": ontology, }, header_params={ - "traceParent": trace_parent, - "traceState": trace_state, "Content-Type": "application/json", "Accept": "application/json", }, @@ -482,8 +450,6 @@ def load_multiple_object_types( sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, snapshot: typing.Optional[bool] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, transaction_id: typing.Optional[ontologies_models.OntologyTransactionId] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -533,10 +499,6 @@ def load_multiple_object_types( :type select_v2: Optional[List[PropertyIdentifier]] :param snapshot: 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. :type snapshot: Optional[bool] - :param trace_parent: The W3C trace parent header included in the request. - :type trace_parent: Optional[TraceParent] - :param trace_state: The W3C trace state header included in the request. - :type trace_state: Optional[TraceState] :param transaction_id: The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[OntologyTransactionId] :param request_timeout: timeout setting for this request in seconds. @@ -560,8 +522,6 @@ def load_multiple_object_types( "ontology": ontology, }, header_params={ - "traceParent": trace_parent, - "traceState": trace_state, "Content-Type": "application/json", "Accept": "application/json", }, @@ -603,9 +563,6 @@ def load_objects_or_interfaces( sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, snapshot: typing.Optional[bool] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, - transaction_id: typing.Optional[ontologies_models.OntologyTransactionId] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> ontologies_models.LoadObjectSetV2ObjectsOrInterfacesResponse: @@ -652,12 +609,6 @@ def load_objects_or_interfaces( :type select_v2: Optional[List[PropertyIdentifier]] :param snapshot: 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. :type snapshot: Optional[bool] - :param trace_parent: The W3C trace parent header included in the request. - :type trace_parent: Optional[TraceParent] - :param trace_state: The W3C trace state header included in the request. - :type trace_state: Optional[TraceState] - :param transaction_id: The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. - :type transaction_id: Optional[OntologyTransactionId] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -673,14 +624,11 @@ def load_objects_or_interfaces( "preview": preview, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, - "transactionId": transaction_id, }, path_params={ "ontology": ontology, }, header_params={ - "traceParent": trace_parent, - "traceState": trace_state, "Content-Type": "application/json", "Accept": "application/json", }, @@ -802,8 +750,6 @@ def aggregate( include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, transaction_id: typing.Optional[ontologies_models.OntologyTransactionId] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -829,10 +775,6 @@ def aggregate( :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The package version of the generated SDK. :type sdk_version: Optional[SdkVersion] - :param trace_parent: The W3C trace parent header included in the request. - :type trace_parent: Optional[TraceParent] - :param trace_state: The W3C trace state header included in the request. - :type trace_state: Optional[TraceState] :param transaction_id: The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[OntologyTransactionId] :param request_timeout: timeout setting for this request in seconds. @@ -855,8 +797,6 @@ def aggregate( "ontology": ontology, }, header_params={ - "traceParent": trace_parent, - "traceState": trace_state, "Content-Type": "application/json", "Accept": "application/json", }, @@ -885,8 +825,6 @@ def create_temporary( branch: typing.Optional[core_models.FoundryBranch] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[ontologies_models.CreateTemporaryObjectSetResponseV2]: @@ -903,10 +841,6 @@ def create_temporary( :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The package version of the generated SDK. :type sdk_version: Optional[SdkVersion] - :param trace_parent: The W3C trace parent header included in the request. - :type trace_parent: Optional[TraceParent] - :param trace_state: The W3C trace state header included in the request. - :type trace_state: Optional[TraceState] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -926,8 +860,6 @@ def create_temporary( "ontology": ontology, }, header_params={ - "traceParent": trace_parent, - "traceState": trace_state, "Content-Type": "application/json", "Accept": "application/json", }, @@ -1005,8 +937,6 @@ def load( sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, snapshot: typing.Optional[bool] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, transaction_id: typing.Optional[ontologies_models.OntologyTransactionId] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -1049,10 +979,6 @@ def load( :type select_v2: Optional[List[PropertyIdentifier]] :param snapshot: 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. :type snapshot: Optional[bool] - :param trace_parent: The W3C trace parent header included in the request. - :type trace_parent: Optional[TraceParent] - :param trace_state: The W3C trace state header included in the request. - :type trace_state: Optional[TraceState] :param transaction_id: The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[OntologyTransactionId] :param request_timeout: timeout setting for this request in seconds. @@ -1075,8 +1001,6 @@ def load( "ontology": ontology, }, header_params={ - "traceParent": trace_parent, - "traceState": trace_state, "Content-Type": "application/json", "Accept": "application/json", }, @@ -1114,8 +1038,6 @@ def load_links( preview: typing.Optional[core_models.PreviewMode] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[ontologies_models.LoadObjectSetLinksResponseV2]: @@ -1153,10 +1075,6 @@ def load_links( :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The package version of the generated SDK. :type sdk_version: Optional[SdkVersion] - :param trace_parent: The W3C trace parent header included in the request. - :type trace_parent: Optional[TraceParent] - :param trace_state: The W3C trace state header included in the request. - :type trace_state: Optional[TraceState] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -1177,8 +1095,6 @@ def load_links( "ontology": ontology, }, header_params={ - "traceParent": trace_parent, - "traceState": trace_state, "Content-Type": "application/json", "Accept": "application/json", }, @@ -1216,8 +1132,6 @@ def load_multiple_object_types( sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, snapshot: typing.Optional[bool] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, transaction_id: typing.Optional[ontologies_models.OntologyTransactionId] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -1267,10 +1181,6 @@ def load_multiple_object_types( :type select_v2: Optional[List[PropertyIdentifier]] :param snapshot: 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. :type snapshot: Optional[bool] - :param trace_parent: The W3C trace parent header included in the request. - :type trace_parent: Optional[TraceParent] - :param trace_state: The W3C trace state header included in the request. - :type trace_state: Optional[TraceState] :param transaction_id: The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[OntologyTransactionId] :param request_timeout: timeout setting for this request in seconds. @@ -1294,8 +1204,6 @@ def load_multiple_object_types( "ontology": ontology, }, header_params={ - "traceParent": trace_parent, - "traceState": trace_state, "Content-Type": "application/json", "Accept": "application/json", }, @@ -1337,9 +1245,6 @@ def load_objects_or_interfaces( sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, snapshot: typing.Optional[bool] = None, - trace_parent: typing.Optional[core_models.TraceParent] = None, - trace_state: typing.Optional[core_models.TraceState] = None, - transaction_id: typing.Optional[ontologies_models.OntologyTransactionId] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[ontologies_models.LoadObjectSetV2ObjectsOrInterfacesResponse]: @@ -1386,12 +1291,6 @@ def load_objects_or_interfaces( :type select_v2: Optional[List[PropertyIdentifier]] :param snapshot: 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. :type snapshot: Optional[bool] - :param trace_parent: The W3C trace parent header included in the request. - :type trace_parent: Optional[TraceParent] - :param trace_state: The W3C trace state header included in the request. - :type trace_state: Optional[TraceState] - :param transaction_id: The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. - :type transaction_id: Optional[OntologyTransactionId] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -1407,14 +1306,11 @@ def load_objects_or_interfaces( "preview": preview, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, - "transactionId": transaction_id, }, path_params={ "ontology": ontology, }, header_params={ - "traceParent": trace_parent, - "traceState": trace_state, "Content-Type": "application/json", "Accept": "application/json", }, diff --git a/foundry_sdk/v2/ontologies/query.py b/foundry_sdk/v2/ontologies/query.py index 4723cc66f..49bc16bf1 100644 --- a/foundry_sdk/v2/ontologies/query.py +++ b/foundry_sdk/v2/ontologies/query.py @@ -65,7 +65,6 @@ def execute( ontologies_models.ParameterId, typing.Optional[ontologies_models.DataValue] ], attribution: typing.Optional[core_models.Attribution] = None, - branch: typing.Optional[core_models.FoundryBranch] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, trace_parent: typing.Optional[core_models.TraceParent] = None, @@ -88,8 +87,6 @@ def execute( :type parameters: Dict[ParameterId, Optional[DataValue]] :param attribution: The Attribution to be used when executing this request. :type attribution: Optional[Attribution] - :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. When provided without `version`, the latest version on this branch is used, including pre-release versions. When provided with `version`, the specified version must exist on the branch. - :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 version of the generated SDK. @@ -100,7 +97,7 @@ def execute( :type trace_state: Optional[TraceState] :param transaction_id: The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[OntologyTransactionId] - :param version: The version of the Query to execute. When used with `branch`, the specified version must exist on the branch. + :param version: The version of the Query to execute. :type version: Optional[FunctionVersion] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] @@ -113,7 +110,6 @@ def execute( method="POST", resource_path="/v2/ontologies/{ontology}/queries/{queryApiName}/execute", query_params={ - "branch": branch, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, "transactionId": transaction_id, @@ -196,7 +192,6 @@ def execute( ontologies_models.ParameterId, typing.Optional[ontologies_models.DataValue] ], attribution: typing.Optional[core_models.Attribution] = None, - branch: typing.Optional[core_models.FoundryBranch] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, trace_parent: typing.Optional[core_models.TraceParent] = None, @@ -219,8 +214,6 @@ def execute( :type parameters: Dict[ParameterId, Optional[DataValue]] :param attribution: The Attribution to be used when executing this request. :type attribution: Optional[Attribution] - :param branch: The Foundry branch to execute the query from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. When provided without `version`, the latest version on this branch is used, including pre-release versions. When provided with `version`, the specified version must exist on the branch. - :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 version of the generated SDK. @@ -231,7 +224,7 @@ def execute( :type trace_state: Optional[TraceState] :param transaction_id: The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[OntologyTransactionId] - :param version: The version of the Query to execute. When used with `branch`, the specified version must exist on the branch. + :param version: The version of the Query to execute. :type version: Optional[FunctionVersion] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] @@ -244,7 +237,6 @@ def execute( method="POST", resource_path="/v2/ontologies/{ontology}/queries/{queryApiName}/execute", query_params={ - "branch": branch, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, "transactionId": transaction_id, diff --git a/foundry_sdk/v2/ontologies/query_type.py b/foundry_sdk/v2/ontologies/query_type.py index f3a1de71a..607053eef 100644 --- a/foundry_sdk/v2/ontologies/query_type.py +++ b/foundry_sdk/v2/ontologies/query_type.py @@ -117,7 +117,6 @@ def list( self, ontology: ontologies_models.OntologyIdentifier, *, - branch: typing.Optional[core_models.FoundryBranch] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -131,8 +130,6 @@ def list( :param ontology: :type ontology: OntologyIdentifier - :param branch: The Foundry branch to list queries 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 page_size: The desired size of the page to be returned. Defaults to 100. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: @@ -148,7 +145,6 @@ def list( method="GET", resource_path="/v2/ontologies/{ontology}/queryTypes", query_params={ - "branch": branch, "pageSize": page_size, "pageToken": page_token, }, @@ -278,7 +274,6 @@ def list( self, ontology: ontologies_models.OntologyIdentifier, *, - branch: typing.Optional[core_models.FoundryBranch] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -292,8 +287,6 @@ def list( :param ontology: :type ontology: OntologyIdentifier - :param branch: The Foundry branch to list queries 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 page_size: The desired size of the page to be returned. Defaults to 100. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: @@ -309,7 +302,6 @@ def list( method="GET", resource_path="/v2/ontologies/{ontology}/queryTypes", query_params={ - "branch": branch, "pageSize": page_size, "pageToken": page_token, }, diff --git a/foundry_sdk/v2/orchestration/build.py b/foundry_sdk/v2/orchestration/build.py index 6ab81c7a1..5d103bf9f 100644 --- a/foundry_sdk/v2/orchestration/build.py +++ b/foundry_sdk/v2/orchestration/build.py @@ -181,9 +181,6 @@ def get( ) -> orchestration_models.Build: """ Get the Build with the specified rid. - - Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - :param build_rid: The RID of a Build. :type build_rid: BuildRid :param request_timeout: timeout setting for this request in seconds. @@ -231,9 +228,6 @@ def get_batch( """ Execute multiple get requests on Build. - Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - - The maximum batch size for this endpoint is 100. :param body: Body of the request :type body: List[GetBuildsBatchRequestElement] @@ -558,9 +552,6 @@ def get( ) -> typing.Awaitable[orchestration_models.Build]: """ Get the Build with the specified rid. - - Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - :param build_rid: The RID of a Build. :type build_rid: BuildRid :param request_timeout: timeout setting for this request in seconds. @@ -608,9 +599,6 @@ def get_batch( """ Execute multiple get requests on Build. - Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - - The maximum batch size for this endpoint is 100. :param body: Body of the request :type body: List[GetBuildsBatchRequestElement] diff --git a/foundry_sdk/v2/orchestration/job.py b/foundry_sdk/v2/orchestration/job.py index f5e6b730d..837a059ea 100644 --- a/foundry_sdk/v2/orchestration/job.py +++ b/foundry_sdk/v2/orchestration/job.py @@ -68,9 +68,6 @@ def get( ) -> orchestration_models.Job: """ Get the Job with the specified rid. - - Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - :param job_rid: The RID of a Job. :type job_rid: JobRid :param preview: Enables the use of preview functionality. @@ -123,9 +120,6 @@ def get_batch( """ Execute multiple get requests on Job. - Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - - The maximum batch size for this endpoint is 500. :param body: Body of the request :type body: List[GetJobsBatchRequestElement] @@ -218,9 +212,6 @@ def get( ) -> typing.Awaitable[orchestration_models.Job]: """ Get the Job with the specified rid. - - Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - :param job_rid: The RID of a Job. :type job_rid: JobRid :param preview: Enables the use of preview functionality. @@ -273,9 +264,6 @@ def get_batch( """ Execute multiple get requests on Job. - Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. - - The maximum batch size for this endpoint is 500. :param body: Body of the request :type body: List[GetJobsBatchRequestElement] diff --git a/foundry_sdk/v2/orchestration/models.py b/foundry_sdk/v2/orchestration/models.py index 1651661fb..3211bfbee 100644 --- a/foundry_sdk/v2/orchestration/models.py +++ b/foundry_sdk/v2/orchestration/models.py @@ -81,9 +81,6 @@ class Build(core.ModelBase): retry_backoff_duration: RetryBackoffDuration = pydantic.Field(alias=str("retryBackoffDuration")) # type: ignore[literal-required] abort_on_failure: AbortOnFailure = pydantic.Field(alias=str("abortOnFailure")) # type: ignore[literal-required] status: BuildStatus - finished_time: typing.Optional[core.AwareDatetime] = pydantic.Field(alias=str("finishedTime"), default=None) # type: ignore[literal-required] - """The time the build finished processing. Will be empty while the build is still running.""" - schedule_rid: typing.Optional[core_models.ScheduleRid] = pydantic.Field(alias=str("scheduleRid"), default=None) # type: ignore[literal-required] """Schedule RID of the Schedule that triggered this build. If a user triggered the build, Schedule RID will be empty.""" @@ -602,13 +599,13 @@ class ScheduleRunError(core.ModelBase): ScheduleRunErrorName = typing.Literal[ - "TARGETRESOLUTIONFAILURE", - "CYCLICDEPENDENCY", - "INCOMPATIBLETARGETS", - "PERMISSIONDENIED", - "JOBSPECNOTFOUND", - "SCHEDULEOWNERNOTFOUND", - "INTERNAL", + "TargetResolutionFailure", + "CyclicDependency", + "IncompatibleTargets", + "PermissionDenied", + "JobSpecNotFound", + "ScheduleOwnerNotFound", + "Internal", ] """ScheduleRunErrorName""" diff --git a/foundry_sdk/v2/orchestration/schedule.py b/foundry_sdk/v2/orchestration/schedule.py index da3df73a1..e76a6c2ed 100644 --- a/foundry_sdk/v2/orchestration/schedule.py +++ b/foundry_sdk/v2/orchestration/schedule.py @@ -72,13 +72,6 @@ def create( ) -> orchestration_models.Schedule: """ Creates a new Schedule. - - :::callout{theme=warning title=Warning} - If the schedule is created in user-scoped mode, outputs to build will be discovered based on resources - that the user has access to. If the user's permissions change later, this could change the outputs that - will be built or cause builds to fail. Consider using a project-scoped schedule instead. - ::: - :param action: :type action: CreateScheduleRequestAction :param description: @@ -372,14 +365,7 @@ def replace( _sdk_internal: core.SdkInternal = {}, ) -> orchestration_models.Schedule: """ - Replaces the Schedule with the specified rid. - - :::callout{theme=warning title=Warning} - If the schedule is configured in user-scoped mode, outputs to build will be discovered based on resources - that the user has access to. If the user's permissions change later, this could change the outputs that - will be built or cause builds to fail. Consider using a project-scoped schedule instead. - ::: - + Replace the Schedule with the specified rid. :param schedule_rid: :type schedule_rid: ScheduleRid :param action: @@ -660,13 +646,6 @@ def create( ) -> typing.Awaitable[orchestration_models.Schedule]: """ Creates a new Schedule. - - :::callout{theme=warning title=Warning} - If the schedule is created in user-scoped mode, outputs to build will be discovered based on resources - that the user has access to. If the user's permissions change later, this could change the outputs that - will be built or cause builds to fail. Consider using a project-scoped schedule instead. - ::: - :param action: :type action: CreateScheduleRequestAction :param description: @@ -960,14 +939,7 @@ def replace( _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[orchestration_models.Schedule]: """ - Replaces the Schedule with the specified rid. - - :::callout{theme=warning title=Warning} - If the schedule is configured in user-scoped mode, outputs to build will be discovered based on resources - that the user has access to. If the user's permissions change later, this could change the outputs that - will be built or cause builds to fail. Consider using a project-scoped schedule instead. - ::: - + Replace the Schedule with the specified rid. :param schedule_rid: :type schedule_rid: ScheduleRid :param action: diff --git a/foundry_sdk/v2/sql_queries/errors.py b/foundry_sdk/v2/sql_queries/errors.py index b3d971404..3d996d5ca 100644 --- a/foundry_sdk/v2/sql_queries/errors.py +++ b/foundry_sdk/v2/sql_queries/errors.py @@ -20,6 +20,7 @@ from foundry_sdk import _core as core from foundry_sdk import _errors as errors +from foundry_sdk.v2.sql_queries import models as sql_queries_models class CancelSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): @@ -27,6 +28,9 @@ class CancelSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore + sqlQueryId: sql_queries_models.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.""" + @dataclass class CancelSqlQueryPermissionDenied(errors.PermissionDeniedError): @@ -35,32 +39,6 @@ class CancelSqlQueryPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class ColumnTypesNotSupportedParameters(typing_extensions.TypedDict): - """The query result contains column types that are not supported by the requested serialization format.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class ColumnTypesNotSupported(errors.BadRequestError): - name: typing.Literal["ColumnTypesNotSupported"] - parameters: ColumnTypesNotSupportedParameters - error_instance_id: str - - -class ExecuteOntologySqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not executeOntology the SqlQuery.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class ExecuteOntologySqlQueryPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["ExecuteOntologySqlQueryPermissionDenied"] - parameters: ExecuteOntologySqlQueryPermissionDeniedParameters - error_instance_id: str - - class ExecuteSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): """Could not execute the SqlQuery.""" @@ -79,6 +57,9 @@ class GetResultsSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore + sqlQueryId: sql_queries_models.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.""" + @dataclass class GetResultsSqlQueryPermissionDenied(errors.PermissionDeniedError): @@ -92,6 +73,9 @@ class GetStatusSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore + sqlQueryId: sql_queries_models.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.""" + @dataclass class GetStatusSqlQueryPermissionDenied(errors.PermissionDeniedError): @@ -100,26 +84,13 @@ class GetStatusSqlQueryPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class OntologyQueryFailedParameters(typing_extensions.TypedDict): - """The Ontology query failed.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - errorMessage: str - - -@dataclass -class OntologyQueryFailed(errors.InternalServerError): - name: typing.Literal["OntologyQueryFailed"] - parameters: OntologyQueryFailedParameters - error_instance_id: str - - class QueryCanceledParameters(typing_extensions.TypedDict): """The query was canceled.""" __pydantic_config__ = {"extra": "allow"} # type: ignore + queryId: sql_queries_models.SqlQueryId + @dataclass class QueryCanceled(errors.BadRequestError): @@ -133,6 +104,7 @@ class QueryFailedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore + queryId: sql_queries_models.SqlQueryId errorMessage: str @@ -163,6 +135,8 @@ class QueryPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore + queryId: sql_queries_models.SqlQueryId + @dataclass class QueryPermissionDenied(errors.PermissionDeniedError): @@ -176,6 +150,8 @@ class QueryRunningParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore + queryId: sql_queries_models.SqlQueryId + @dataclass class QueryRunning(errors.BadRequestError): @@ -202,12 +178,9 @@ class ReadQueryInputsPermissionDenied(errors.PermissionDeniedError): __all__ = [ "CancelSqlQueryPermissionDenied", - "ColumnTypesNotSupported", - "ExecuteOntologySqlQueryPermissionDenied", "ExecuteSqlQueryPermissionDenied", "GetResultsSqlQueryPermissionDenied", "GetStatusSqlQueryPermissionDenied", - "OntologyQueryFailed", "QueryCanceled", "QueryFailed", "QueryParseError", diff --git a/foundry_sdk/v2/sql_queries/models.py b/foundry_sdk/v2/sql_queries/models.py index 443f0e7ee..e69a3f0a4 100644 --- a/foundry_sdk/v2/sql_queries/models.py +++ b/foundry_sdk/v2/sql_queries/models.py @@ -15,9 +15,7 @@ from __future__ import annotations -import decimal import typing -from datetime import date import pydantic import typing_extensions @@ -26,68 +24,12 @@ from foundry_sdk.v2.core import models as core_models -class AnyColumnType(core.ModelBase): - """AnyColumnType""" - - type: typing.Literal["any"] = "any" - - class CanceledQueryStatus(core.ModelBase): """CanceledQueryStatus""" type: typing.Literal["canceled"] = "canceled" -ColumnType = typing_extensions.Annotated[ - typing.Union[ - core_models.DateType, - "StructColumnType", - core_models.StringType, - core_models.DoubleType, - core_models.IntegerType, - core_models.FloatType, - "ListColumnType", - "AnyColumnType", - core_models.LongType, - core_models.BooleanType, - core_models.BinaryType, - core_models.ShortType, - "DecimalColumnType", - "MapColumnType", - core_models.TimestampType, - ], - pydantic.Field(discriminator="type"), -] -"""The type of a column in a SQL query result or parameter.""" - - -class DecimalColumnType(core.ModelBase): - """DecimalColumnType""" - - precision: int - scale: int - type: typing.Literal["decimal"] = "decimal" - - -class ExecuteOntologySqlQueryRequest(core.ModelBase): - """ExecuteOntologySqlQueryRequest""" - - query: str - """The SQL query to execute.""" - - parameters: typing.Optional[Parameters] = None - """ - Parameters for the SQL query. Can be either unnamed positional parameters - or a named parameter mapping. - """ - - row_limit: typing.Optional[int] = pydantic.Field(alias=str("rowLimit"), default=None) # type: ignore[literal-required] - """Maximum number of rows to return.""" - - dry_run: typing.Optional[bool] = pydantic.Field(alias=str("dryRun"), default=None) # type: ignore[literal-required] - """If true, parse and validate the query without executing it. Defaults to false.""" - - class ExecuteSqlQueryRequest(core.ModelBase): """ExecuteSqlQueryRequest""" @@ -108,9 +50,6 @@ class ExecuteSqlQueryRequest(core.ModelBase): `master` for most enrollments. """ - serialization_format: typing.Optional[SerializationFormat] = pydantic.Field(alias=str("serializationFormat"), default=None) # type: ignore[literal-required] - """The format used to serialize query results. If not specified, defaults to `ARROW`.""" - class FailedQueryStatus(core.ModelBase): """FailedQueryStatus""" @@ -121,178 +60,6 @@ class FailedQueryStatus(core.ModelBase): type: typing.Literal["failed"] = "failed" -class ListColumnType(core.ModelBase): - """ListColumnType""" - - element_type: ColumnType = pydantic.Field(alias=str("elementType")) # type: ignore[literal-required] - type: typing.Literal["list"] = "list" - - -class MapColumnType(core.ModelBase): - """MapColumnType""" - - key_type: ColumnType = pydantic.Field(alias=str("keyType")) # type: ignore[literal-required] - value_type: ColumnType = pydantic.Field(alias=str("valueType")) # type: ignore[literal-required] - type: typing.Literal["map"] = "map" - - -MapParameterKey = str -"""A key for a map parameter value.""" - - -class NamedParameterMapping(core.ModelBase): - """A named mapping of parameter names to values.""" - - mapping: ParameterMapping - type: typing.Literal["namedParameterMapping"] = "namedParameterMapping" - - -class ParameterAnyValue(core.ModelBase): - """An untyped parameter value.""" - - value: typing.Any - type: typing.Literal["any"] = "any" - - -class ParameterBooleanValue(core.ModelBase): - """A boolean parameter value.""" - - value: bool - type: typing.Literal["boolean"] = "boolean" - - -class ParameterDateValue(core.ModelBase): - """A date parameter value.""" - - value: date - type: typing.Literal["date"] = "date" - - -class ParameterDecimalValue(core.ModelBase): - """A decimal parameter value.""" - - value: decimal.Decimal - type: typing.Literal["decimal"] = "decimal" - - -class ParameterDoubleValue(core.ModelBase): - """A double parameter value.""" - - value: float - type: typing.Literal["double"] = "double" - - -class ParameterFloatValue(core.ModelBase): - """A float parameter value.""" - - value: float - type: typing.Literal["float"] = "float" - - -class ParameterIntegerValue(core.ModelBase): - """An integer parameter value.""" - - value: int - type: typing.Literal["integer"] = "integer" - - -class ParameterListValue(core.ModelBase): - """A parameter value that is a list of other parameter values. All values in the list must be of the same type.""" - - values: typing.List[ParameterValue] - element_type: ColumnType = pydantic.Field(alias=str("elementType")) # type: ignore[literal-required] - type: typing.Literal["list"] = "list" - - -class ParameterLongValue(core.ModelBase): - """A long integer parameter value.""" - - value: core.Long - type: typing.Literal["long"] = "long" - - -class ParameterMapValue(core.ModelBase): - """A map parameter value.""" - - values: typing.Dict[MapParameterKey, ParameterValue] - type: typing.Literal["map"] = "map" - - -ParameterMapping = typing.Dict["ParameterName", "ParameterValue"] -"""A mapping of named parameters to their values.""" - - -ParameterName = str -"""The name of a SQL query parameter.""" - - -class ParameterNullValue(core.ModelBase): - """A null parameter value.""" - - type: typing.Literal["null"] = "null" - - -class ParameterShortValue(core.ModelBase): - """A short integer parameter value.""" - - value: int - type: typing.Literal["short"] = "short" - - -class ParameterStringValue(core.ModelBase): - """A string parameter value.""" - - value: str - type: typing.Literal["string"] = "string" - - -class ParameterStructValue(core.ModelBase): - """A struct composed of ordered elements, each with a name and value.""" - - struct_elements: typing.List[StructElement] = pydantic.Field(alias=str("structElements")) # type: ignore[literal-required] - type: typing.Literal["struct"] = "struct" - - -class ParameterTimestampValue(core.ModelBase): - """A timestamp parameter value.""" - - value: core.AwareDatetime - type: typing.Literal["timestamp"] = "timestamp" - - -ParameterValue = typing_extensions.Annotated[ - typing.Union[ - "ParameterDateValue", - "ParameterStructValue", - "ParameterStringValue", - "ParameterDoubleValue", - "ParameterIntegerValue", - "ParameterFloatValue", - "ParameterListValue", - "ParameterAnyValue", - "ParameterLongValue", - "ParameterBooleanValue", - "ParameterNullValue", - "ParameterShortValue", - "ParameterDecimalValue", - "ParameterMapValue", - "ParameterTimestampValue", - ], - pydantic.Field(discriminator="type"), -] -"""A typed parameter value for SQL query execution.""" - - -Parameters = typing_extensions.Annotated[ - typing.Union["UnnamedParameterValues", "NamedParameterMapping"], - pydantic.Field(discriminator="type"), -] -""" -Parameters for SQL query execution. Can be either unnamed positional parameters -or named parameter mappings. -""" - - QueryStatus = typing_extensions.Annotated[ typing.Union[ "RunningQueryStatus", "CanceledQueryStatus", "FailedQueryStatus", "SucceededQueryStatus" @@ -309,55 +76,10 @@ class RunningQueryStatus(core.ModelBase): type: typing.Literal["running"] = "running" -SerializationFormat = typing.Literal["ARROW", "CSV"] -"""Format for SQL query result serialization.""" - - SqlQueryId = str """The identifier of a SQL Query.""" -class StructColumnFieldType(core.ModelBase): - """StructColumnFieldType""" - - name: str - type: ColumnType - - -class StructColumnType(core.ModelBase): - """StructColumnType""" - - fields: typing.List[StructColumnFieldType] - type: typing.Literal["struct"] = "struct" - - -class StructElement(core.ModelBase): - """Represents an entry in a struct.""" - - struct_element_name: StructElementName = pydantic.Field(alias=str("structElementName")) # type: ignore[literal-required] - struct_element_value: ParameterValue = pydantic.Field(alias=str("structElementValue")) # type: ignore[literal-required] - - -StructElementName = typing_extensions.Annotated[ - typing.Union["StructFieldRid", "StructFieldKeyValue"], pydantic.Field(discriminator="type") -] -"""The name of a struct element.""" - - -class StructFieldKeyValue(core.ModelBase): - """A string key for a struct field.""" - - value: str - type: typing.Literal["structFieldKey"] = "structFieldKey" - - -class StructFieldRid(core.ModelBase): - """A unique identifier for a field of a struct property type.""" - - value: core.RID - type: typing.Literal["structFieldRid"] = "structFieldRid" - - class SucceededQueryStatus(core.ModelBase): """SucceededQueryStatus""" @@ -365,61 +87,14 @@ class SucceededQueryStatus(core.ModelBase): type: typing.Literal["succeeded"] = "succeeded" -class UnnamedParameterValues(core.ModelBase): - """An ordered list of unnamed positional parameter values.""" - - values: typing.List[ParameterValue] - type: typing.Literal["unnamedParameterValues"] = "unnamedParameterValues" - - -core.resolve_forward_references(ColumnType, globalns=globals(), localns=locals()) -core.resolve_forward_references(ParameterMapping, globalns=globals(), localns=locals()) -core.resolve_forward_references(ParameterValue, globalns=globals(), localns=locals()) -core.resolve_forward_references(Parameters, globalns=globals(), localns=locals()) core.resolve_forward_references(QueryStatus, globalns=globals(), localns=locals()) -core.resolve_forward_references(StructElementName, globalns=globals(), localns=locals()) __all__ = [ - "AnyColumnType", "CanceledQueryStatus", - "ColumnType", - "DecimalColumnType", - "ExecuteOntologySqlQueryRequest", "ExecuteSqlQueryRequest", "FailedQueryStatus", - "ListColumnType", - "MapColumnType", - "MapParameterKey", - "NamedParameterMapping", - "ParameterAnyValue", - "ParameterBooleanValue", - "ParameterDateValue", - "ParameterDecimalValue", - "ParameterDoubleValue", - "ParameterFloatValue", - "ParameterIntegerValue", - "ParameterListValue", - "ParameterLongValue", - "ParameterMapValue", - "ParameterMapping", - "ParameterName", - "ParameterNullValue", - "ParameterShortValue", - "ParameterStringValue", - "ParameterStructValue", - "ParameterTimestampValue", - "ParameterValue", - "Parameters", "QueryStatus", "RunningQueryStatus", - "SerializationFormat", "SqlQueryId", - "StructColumnFieldType", - "StructColumnType", - "StructElement", - "StructElementName", - "StructFieldKeyValue", - "StructFieldRid", "SucceededQueryStatus", - "UnnamedParameterValues", ] diff --git a/foundry_sdk/v2/sql_queries/sql_query.py b/foundry_sdk/v2/sql_queries/sql_query.py index a8ad92df2..33f4626a6 100644 --- a/foundry_sdk/v2/sql_queries/sql_query.py +++ b/foundry_sdk/v2/sql_queries/sql_query.py @@ -116,7 +116,6 @@ def execute( *, query: str, fallback_branch_ids: typing.Optional[typing.List[core_models.BranchName]] = None, - serialization_format: typing.Optional[sql_queries_models.SerializationFormat] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> sql_queries_models.QueryStatus: @@ -129,14 +128,11 @@ def execute( :type query: str :param fallback_branch_ids: The list of branch ids to use as fallbacks if the query fails to execute on the primary branch. If a is not explicitly provided in the SQL query, the resource will be queried on the first fallback branch provided that exists. If no fallback branches are provided the default branch is used. This is `master` for most enrollments. :type fallback_branch_ids: Optional[List[BranchName]] - :param serialization_format: The format used to serialize query results. If not specified, defaults to `ARROW`. - :type serialization_format: Optional[SerializationFormat] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. :rtype: sql_queries_models.QueryStatus - :raises ColumnTypesNotSupported: The query result contains column types that are not supported by the requested serialization format. :raises ExecuteSqlQueryPermissionDenied: Could not execute the SqlQuery. :raises QueryCanceled: The query was canceled. :raises QueryFailed: The query failed. @@ -159,12 +155,10 @@ def execute( body=sql_queries_models.ExecuteSqlQueryRequest( query=query, fallback_branch_ids=fallback_branch_ids, - serialization_format=serialization_format, ), response_type=sql_queries_models.QueryStatus, request_timeout=request_timeout, throwable_errors={ - "ColumnTypesNotSupported": sql_queries_errors.ColumnTypesNotSupported, "ExecuteSqlQueryPermissionDenied": sql_queries_errors.ExecuteSqlQueryPermissionDenied, "QueryCanceled": sql_queries_errors.QueryCanceled, "QueryFailed": sql_queries_errors.QueryFailed, @@ -177,73 +171,6 @@ def execute( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def execute_ontology( - self, - *, - query: str, - dry_run: typing.Optional[bool] = None, - parameters: typing.Optional[sql_queries_models.Parameters] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - row_limit: typing.Optional[int] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> bytes: - """ - Executes a SQL query against the Ontology. Results are returned synchronously in - [Apache Arrow](https://arrow.apache.org/) format. - - :param query: The SQL query to execute. - :type query: str - :param dry_run: If true, parse and validate the query without executing it. Defaults to false. - :type dry_run: Optional[bool] - :param parameters: Parameters for the SQL query. Can be either unnamed positional parameters or a named parameter mapping. - :type parameters: Optional[Parameters] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param row_limit: Maximum number of rows to return. - :type row_limit: Optional[int] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: bytes - - :raises ExecuteOntologySqlQueryPermissionDenied: Could not executeOntology the SqlQuery. - :raises OntologyQueryFailed: The Ontology query failed. - :raises QueryParseError: The query cannot be parsed. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/sqlQueries/executeOntology", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Content-Type": "application/json", - "Accept": "application/octet-stream", - }, - body=sql_queries_models.ExecuteOntologySqlQueryRequest( - query=query, - parameters=parameters, - row_limit=row_limit, - dry_run=dry_run, - ), - response_type=bytes, - request_timeout=request_timeout, - throwable_errors={ - "ExecuteOntologySqlQueryPermissionDenied": sql_queries_errors.ExecuteOntologySqlQueryPermissionDenied, - "OntologyQueryFailed": sql_queries_errors.OntologyQueryFailed, - "QueryParseError": sql_queries_errors.QueryParseError, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -255,8 +182,8 @@ def get_results( _sdk_internal: core.SdkInternal = {}, ) -> core.TableResponse: """ - Gets the results of a query. Results are returned in the `serializationFormat` specified at execute time - (defaulting to [Apache Arrow](https://arrow.apache.org/) if no format is provided). + Gets the results of a query. The results of the query are returned in the + [Apache Arrow](https://arrow.apache.org/) format. This endpoint implements long polling and requests will time out after one minute. They can be safely retried while the query is still running. @@ -366,13 +293,11 @@ class _SqlQueryClientRaw: def __init__(self, client: SqlQueryClient) -> None: def cancel(_: None): ... def execute(_: sql_queries_models.QueryStatus): ... - def execute_ontology(_: bytes): ... def get_results(_: bytes): ... def get_status(_: sql_queries_models.QueryStatus): ... self.cancel = core.with_raw_response(cancel, client.cancel) self.execute = core.with_raw_response(execute, client.execute) - self.execute_ontology = core.with_raw_response(execute_ontology, client.execute_ontology) self.get_results = core.with_raw_response(get_results, client.get_results) self.get_status = core.with_raw_response(get_status, client.get_status) @@ -380,14 +305,10 @@ def get_status(_: sql_queries_models.QueryStatus): ... class _SqlQueryClientStreaming: def __init__(self, client: SqlQueryClient) -> None: def execute(_: sql_queries_models.QueryStatus): ... - def execute_ontology(_: bytes): ... def get_results(_: bytes): ... def get_status(_: sql_queries_models.QueryStatus): ... self.execute = core.with_streaming_response(execute, client.execute) - self.execute_ontology = core.with_streaming_response( - execute_ontology, client.execute_ontology - ) self.get_results = core.with_streaming_response(get_results, client.get_results) self.get_status = core.with_streaming_response(get_status, client.get_status) @@ -483,7 +404,6 @@ def execute( *, query: str, fallback_branch_ids: typing.Optional[typing.List[core_models.BranchName]] = None, - serialization_format: typing.Optional[sql_queries_models.SerializationFormat] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[sql_queries_models.QueryStatus]: @@ -496,14 +416,11 @@ def execute( :type query: str :param fallback_branch_ids: The list of branch ids to use as fallbacks if the query fails to execute on the primary branch. If a is not explicitly provided in the SQL query, the resource will be queried on the first fallback branch provided that exists. If no fallback branches are provided the default branch is used. This is `master` for most enrollments. :type fallback_branch_ids: Optional[List[BranchName]] - :param serialization_format: The format used to serialize query results. If not specified, defaults to `ARROW`. - :type serialization_format: Optional[SerializationFormat] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. :rtype: typing.Awaitable[sql_queries_models.QueryStatus] - :raises ColumnTypesNotSupported: The query result contains column types that are not supported by the requested serialization format. :raises ExecuteSqlQueryPermissionDenied: Could not execute the SqlQuery. :raises QueryCanceled: The query was canceled. :raises QueryFailed: The query failed. @@ -526,12 +443,10 @@ def execute( body=sql_queries_models.ExecuteSqlQueryRequest( query=query, fallback_branch_ids=fallback_branch_ids, - serialization_format=serialization_format, ), response_type=sql_queries_models.QueryStatus, request_timeout=request_timeout, throwable_errors={ - "ColumnTypesNotSupported": sql_queries_errors.ColumnTypesNotSupported, "ExecuteSqlQueryPermissionDenied": sql_queries_errors.ExecuteSqlQueryPermissionDenied, "QueryCanceled": sql_queries_errors.QueryCanceled, "QueryFailed": sql_queries_errors.QueryFailed, @@ -544,73 +459,6 @@ def execute( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def execute_ontology( - self, - *, - query: str, - dry_run: typing.Optional[bool] = None, - parameters: typing.Optional[sql_queries_models.Parameters] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - row_limit: typing.Optional[int] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[bytes]: - """ - Executes a SQL query against the Ontology. Results are returned synchronously in - [Apache Arrow](https://arrow.apache.org/) format. - - :param query: The SQL query to execute. - :type query: str - :param dry_run: If true, parse and validate the query without executing it. Defaults to false. - :type dry_run: Optional[bool] - :param parameters: Parameters for the SQL query. Can be either unnamed positional parameters or a named parameter mapping. - :type parameters: Optional[Parameters] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param row_limit: Maximum number of rows to return. - :type row_limit: Optional[int] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[bytes] - - :raises ExecuteOntologySqlQueryPermissionDenied: Could not executeOntology the SqlQuery. - :raises OntologyQueryFailed: The Ontology query failed. - :raises QueryParseError: The query cannot be parsed. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/sqlQueries/executeOntology", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Content-Type": "application/json", - "Accept": "application/octet-stream", - }, - body=sql_queries_models.ExecuteOntologySqlQueryRequest( - query=query, - parameters=parameters, - row_limit=row_limit, - dry_run=dry_run, - ), - response_type=bytes, - request_timeout=request_timeout, - throwable_errors={ - "ExecuteOntologySqlQueryPermissionDenied": sql_queries_errors.ExecuteOntologySqlQueryPermissionDenied, - "OntologyQueryFailed": sql_queries_errors.OntologyQueryFailed, - "QueryParseError": sql_queries_errors.QueryParseError, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -622,8 +470,8 @@ def get_results( _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[core.TableResponse]: """ - Gets the results of a query. Results are returned in the `serializationFormat` specified at execute time - (defaulting to [Apache Arrow](https://arrow.apache.org/) if no format is provided). + Gets the results of a query. The results of the query are returned in the + [Apache Arrow](https://arrow.apache.org/) format. This endpoint implements long polling and requests will time out after one minute. They can be safely retried while the query is still running. @@ -733,15 +581,11 @@ class _AsyncSqlQueryClientRaw: def __init__(self, client: AsyncSqlQueryClient) -> None: def cancel(_: None): ... def execute(_: sql_queries_models.QueryStatus): ... - def execute_ontology(_: bytes): ... def get_results(_: bytes): ... def get_status(_: sql_queries_models.QueryStatus): ... self.cancel = core.async_with_raw_response(cancel, client.cancel) self.execute = core.async_with_raw_response(execute, client.execute) - self.execute_ontology = core.async_with_raw_response( - execute_ontology, client.execute_ontology - ) self.get_results = core.async_with_raw_response(get_results, client.get_results) self.get_status = core.async_with_raw_response(get_status, client.get_status) @@ -749,13 +593,9 @@ def get_status(_: sql_queries_models.QueryStatus): ... class _AsyncSqlQueryClientStreaming: def __init__(self, client: AsyncSqlQueryClient) -> None: def execute(_: sql_queries_models.QueryStatus): ... - def execute_ontology(_: bytes): ... def get_results(_: bytes): ... def get_status(_: sql_queries_models.QueryStatus): ... self.execute = core.async_with_streaming_response(execute, client.execute) - self.execute_ontology = core.async_with_streaming_response( - execute_ontology, client.execute_ontology - ) self.get_results = core.async_with_streaming_response(get_results, client.get_results) self.get_status = core.async_with_streaming_response(get_status, client.get_status) diff --git a/foundry_sdk/v2/streams/errors.py b/foundry_sdk/v2/streams/errors.py index 4e047905c..d9cd9d03a 100644 --- a/foundry_sdk/v2/streams/errors.py +++ b/foundry_sdk/v2/streams/errors.py @@ -54,23 +54,6 @@ class CannotWriteToTrashedStream(errors.BadRequestError): error_instance_id: str -class CommitSubscriberOffsetsPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not commitOffsets the Subscriber.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - datasetRid: core_models.DatasetRid - subscriberSubscriberId: streams_models.SubscriberId - streamBranchName: core_models.BranchName - - -@dataclass -class CommitSubscriberOffsetsPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["CommitSubscriberOffsetsPermissionDenied"] - parameters: CommitSubscriberOffsetsPermissionDeniedParameters - error_instance_id: str - - class CreateStreamPermissionDeniedParameters(typing_extensions.TypedDict): """Could not create the Stream.""" @@ -100,40 +83,6 @@ class CreateStreamingDatasetPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class CreateSubscriberPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not create the Subscriber.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - datasetRid: core_models.DatasetRid - subscriberSubscriberId: streams_models.SubscriberId - streamBranchName: core_models.BranchName - - -@dataclass -class CreateSubscriberPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["CreateSubscriberPermissionDenied"] - parameters: CreateSubscriberPermissionDeniedParameters - error_instance_id: str - - -class DeleteSubscriberPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not delete the Subscriber.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - datasetRid: core_models.DatasetRid - subscriberSubscriberId: streams_models.SubscriberId - streamBranchName: core_models.BranchName - - -@dataclass -class DeleteSubscriberPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["DeleteSubscriberPermissionDenied"] - parameters: DeleteSubscriberPermissionDeniedParameters - error_instance_id: str - - class FailedToProcessBinaryRecordParameters(typing_extensions.TypedDict): """The byte stream could not be processed.""" @@ -179,23 +128,6 @@ class GetRecordsFromStreamPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class GetSubscriberReadPositionPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not getReadPosition the Subscriber.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - datasetRid: core_models.DatasetRid - subscriberSubscriberId: streams_models.SubscriberId - streamBranchName: core_models.BranchName - - -@dataclass -class GetSubscriberReadPositionPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["GetSubscriberReadPositionPermissionDenied"] - parameters: GetSubscriberReadPositionPermissionDeniedParameters - error_instance_id: str - - class InvalidStreamNoSchemaParameters(typing_extensions.TypedDict): """The requested stream exists but is invalid, as it does not have a schema.""" @@ -276,23 +208,6 @@ class PublishRecordsToStreamPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class ReadRecordsFromSubscriberPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not readRecords the Subscriber.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - datasetRid: core_models.DatasetRid - subscriberSubscriberId: streams_models.SubscriberId - streamBranchName: core_models.BranchName - - -@dataclass -class ReadRecordsFromSubscriberPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["ReadRecordsFromSubscriberPermissionDenied"] - parameters: ReadRecordsFromSubscriberPermissionDeniedParameters - error_instance_id: str - - class RecordDoesNotMatchStreamSchemaParameters(typing_extensions.TypedDict): """A provided record does not match the stream schema""" @@ -339,23 +254,6 @@ class ResetStreamPermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class ResetSubscriberOffsetsPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not resetOffsets the Subscriber.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - datasetRid: core_models.DatasetRid - subscriberSubscriberId: streams_models.SubscriberId - streamBranchName: core_models.BranchName - - -@dataclass -class ResetSubscriberOffsetsPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["ResetSubscriberOffsetsPermissionDenied"] - parameters: ResetSubscriberOffsetsPermissionDeniedParameters - error_instance_id: str - - class StreamNotFoundParameters(typing_extensions.TypedDict): """The given Stream could not be found.""" @@ -372,38 +270,6 @@ class StreamNotFound(errors.NotFoundError): error_instance_id: str -class SubscriberAlreadyExistsParameters(typing_extensions.TypedDict): - """A subscriber with this ID already exists for a different stream.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subscriberId: streams_models.SubscriberId - existingDatasetRid: core_models.DatasetRid - existingBranchName: core_models.BranchName - - -@dataclass -class SubscriberAlreadyExists(errors.ConflictError): - name: typing.Literal["SubscriberAlreadyExists"] - parameters: SubscriberAlreadyExistsParameters - error_instance_id: str - - -class SubscriberNotFoundParameters(typing_extensions.TypedDict): - """No subscriber with the given ID was found.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subscriberId: streams_models.SubscriberId - - -@dataclass -class SubscriberNotFound(errors.NotFoundError): - name: typing.Literal["SubscriberNotFound"] - parameters: SubscriberNotFoundParameters - error_instance_id: str - - class ViewNotFoundParameters(typing_extensions.TypedDict): """No view for the provided view RID provided could be found.""" @@ -422,27 +288,19 @@ class ViewNotFound(errors.NotFoundError): __all__ = [ "CannotCreateStreamingDatasetInUserFolder", "CannotWriteToTrashedStream", - "CommitSubscriberOffsetsPermissionDenied", "CreateStreamPermissionDenied", "CreateStreamingDatasetPermissionDenied", - "CreateSubscriberPermissionDenied", - "DeleteSubscriberPermissionDenied", "FailedToProcessBinaryRecord", "GetEndOffsetsForStreamPermissionDenied", "GetRecordsFromStreamPermissionDenied", - "GetSubscriberReadPositionPermissionDenied", "InvalidStreamNoSchema", "InvalidStreamType", "PublishBinaryRecordToStreamPermissionDenied", "PublishRecordToStreamPermissionDenied", "PublishRecordsToStreamPermissionDenied", - "ReadRecordsFromSubscriberPermissionDenied", "RecordDoesNotMatchStreamSchema", "RecordTooLarge", "ResetStreamPermissionDenied", - "ResetSubscriberOffsetsPermissionDenied", "StreamNotFound", - "SubscriberAlreadyExists", - "SubscriberNotFound", "ViewNotFound", ] diff --git a/foundry_sdk/v2/streams/models.py b/foundry_sdk/v2/streams/models.py index ca6925734..073329445 100644 --- a/foundry_sdk/v2/streams/models.py +++ b/foundry_sdk/v2/streams/models.py @@ -18,30 +18,12 @@ import typing import pydantic -import typing_extensions from foundry_sdk import _core as core from foundry_sdk.v2.core import models as core_models from foundry_sdk.v2.datasets import models as datasets_models from foundry_sdk.v2.filesystem import models as filesystem_models - -class CommitSubscriberOffsetsRequest(core.ModelBase): - """CommitSubscriberOffsetsRequest""" - - view_rid: typing.Optional[ViewRid] = pydantic.Field(alias=str("viewRid"), default=None) # type: ignore[literal-required] - """ - The view RID to commit offsets for. If not provided, uses the latest view for the - dataset/branch. - """ - - offsets: PartitionOffsets - """ - The last processed offset for each partition. The server will store these as - read positions (offset + 1), so the next read starts after the committed offset. - """ - - Compressed = bool """ Compression helps reduce the size of the data being sent, resulting in lower network usage and @@ -141,24 +123,6 @@ class CreateStreamingDatasetRequest(core.ModelBase): """Whether or not compression is enabled for the stream. Defaults to false.""" -class CreateSubscriberRequest(core.ModelBase): - """CreateSubscriberRequest""" - - subscriber_id: SubscriberId = pydantic.Field(alias=str("subscriberId")) # type: ignore[literal-required] - read_position: typing.Optional[ReadPosition] = pydantic.Field(alias=str("readPosition"), default=None) # type: ignore[literal-required] - """ - Where to start reading from. Defaults to `earliest` if not specified. - - The `readPosition` determines where the subscriber will start reading: - - `earliest`: Start from the beginning of each partition (offset 0). Use this to process - all historical data. - - `latest`: Start from the current end of each partition. Use this to skip historical data - and only process new records arriving after registration. - - `specific`: Start from explicit offsets for each partition. Use this to resume from a - known checkpoint. - """ - - class Dataset(core.ModelBase): """Dataset""" @@ -167,15 +131,6 @@ class Dataset(core.ModelBase): parent_folder_rid: filesystem_models.FolderRid = pydantic.Field(alias=str("parentFolderRid")) # type: ignore[literal-required] -class EarliestPosition(core.ModelBase): - """ - Start reading from the beginning of the stream. Sets offset to 0 for all partitions, - allowing the subscriber to read all historical data from the start. - """ - - type: typing.Literal["earliest"] = "earliest" - - GetEndOffsetsResponse = typing.Dict["PartitionId", core.Long] """The end offsets for each partition of a stream.""" @@ -184,28 +139,10 @@ class EarliestPosition(core.ModelBase): """A list of records from a stream with their offsets.""" -class LatestPosition(core.ModelBase): - """ - Start reading from the current end of the stream. Sets offsets to the latest available - offset for each partition, meaning the subscriber will only receive records published - after this point. - """ - - type: typing.Literal["latest"] = "latest" - - PartitionId = str """The identifier for a partition of a Foundry stream.""" -PartitionOffsets = typing.Dict["PartitionId", core.Long] -"""A map of partition IDs to offsets.""" - - -PartitionRecords = typing.List["RecordWithOffset"] -"""Records from a single partition with their offsets.""" - - PartitionsCount = int """The number of partitions for a Foundry stream.""" @@ -242,56 +179,6 @@ class PublishRecordsToStreamRequest(core.ModelBase): """ -ReadPosition = typing_extensions.Annotated[ - typing.Union["SpecificPosition", "EarliestPosition", "LatestPosition"], - pydantic.Field(discriminator="type"), -] -""" -Position to start reading from when registering a subscriber or resetting offsets. - -- `earliest`: Start reading from the beginning of each partition (offset 0). Use this to - reprocess all historical data in the stream. -- `latest`: Start reading from the current end of each partition. Use this to skip - historical data and only process new records arriving after registration. -- `specific`: Start reading from explicit offsets for each partition. Use this for precise - replay scenarios or to resume from a known checkpoint. -""" - - -class ReadRecordsFromSubscriberRequest(core.ModelBase): - """ReadRecordsFromSubscriberRequest""" - - view_rid: typing.Optional[ViewRid] = pydantic.Field(alias=str("viewRid"), default=None) # type: ignore[literal-required] - """ - The view RID to read from. If not provided, reads from the latest view for the - dataset/branch. - """ - - limit: typing.Optional[int] = None - """ - Maximum number of records to return across all partitions. Defaults to 100, max 1000. If a value - greater than 1000 is requested, only 1000 records will be returned. - """ - - partition_ids: typing.Optional[typing.List[PartitionId]] = pydantic.Field(alias=str("partitionIds"), default=None) # type: ignore[literal-required] - """If specified, only read from these partitions. Otherwise, read from all partitions.""" - - auto_commit: typing.Optional[bool] = pydantic.Field(alias=str("autoCommit"), default=None) # type: ignore[literal-required] - """ - If true, the read position is automatically committed after reading records. - The committed position will be the offset after the last record read. - If false, you must call the `commitOffsets` endpoint to commit offsets. - Defaults to false. - """ - - -class ReadSubscriberRecordsResponse(core.ModelBase): - """Response containing records grouped by partition ID.""" - - records_by_partition: typing.Dict[PartitionId, PartitionRecords] = pydantic.Field(alias=str("recordsByPartition")) # type: ignore[literal-required] - """Records grouped by partition ID.""" - - Record = typing.Dict[str, typing.Optional[typing.Any]] """A record to be published to a stream.""" @@ -341,28 +228,6 @@ class ResetStreamRequest(core.ModelBase): """ -class ResetSubscriberOffsetsRequest(core.ModelBase): - """ResetSubscriberOffsetsRequest""" - - position: ReadPosition - """The position to reset offsets to.""" - - -class SpecificPosition(core.ModelBase): - """ - Start reading from specific offsets for each partition. Useful for resuming from a known - checkpoint or replaying from a specific point in time. - """ - - offsets: PartitionOffsets - """ - Specific offsets for each partition. Offsets must be valid (non-negative and not - beyond the end of the partition). - """ - - type: typing.Literal["specific"] = "specific" - - class Stream(core.ModelBase): """Stream""" @@ -400,93 +265,37 @@ class Stream(core.ModelBase): recommended if you inspect your stream metrics in-platform and observe that the average batch size is equal to the max match size, or if jobs using the stream are failing due to Kafka producer batches expiring. For additional information on inspecting stream metrics, refer to the -[stream monitoring](https://palantir.com/docs/foundry/data-integration/stream-monitoring/#viewing-metrics) documentation. +(stream monitoring)[/docs/foundry/data-integration/stream-monitoring/#viewing-metrics] documentation. For more information, refer to the [stream types](https://palantir.com/docs/foundry/data-integration/streams/#stream-types) documentation. """ -class Subscriber(core.ModelBase): - """Subscriber""" - - subscriber_id: SubscriberId = pydantic.Field(alias=str("subscriberId")) # type: ignore[literal-required] - read_position: typing.Optional[ReadPosition] = pydantic.Field(alias=str("readPosition"), default=None) # type: ignore[literal-required] - """ - Where to start reading from. Defaults to `earliest` if not specified. - - The `readPosition` determines where the subscriber will start reading: - - `earliest`: Start from the beginning of each partition (offset 0). Use this to process - all historical data. - - `latest`: Start from the current end of each partition. Use this to skip historical data - and only process new records arriving after registration. - - `specific`: Start from explicit offsets for each partition. Use this to resume from a - known checkpoint. - """ - - dataset_rid: core_models.DatasetRid = pydantic.Field(alias=str("datasetRid")) # type: ignore[literal-required] - """The RID of the dataset the subscriber is bound to.""" - - branch_name: core_models.BranchName = pydantic.Field(alias=str("branchName")) # type: ignore[literal-required] - """The branch of the stream the subscriber is bound to.""" - - view_rid: ViewRid = pydantic.Field(alias=str("viewRid")) # type: ignore[literal-required] - """ - The current view RID being read from. This may change over time if the stream's - schema is migrated to a new view. - """ - - start_offsets: PartitionOffsets = pydantic.Field(alias=str("startOffsets")) # type: ignore[literal-required] - """The offsets where reading began for each partition, based on the initial read position.""" - - created_time: core_models.CreatedTime = pydantic.Field(alias=str("createdTime")) # type: ignore[literal-required] - """Timestamp when the subscriber was registered.""" - - -SubscriberId = str -"""A unique identifier for a stream subscriber. Must be unique within the scope of a stream.""" - - ViewRid = core.RID """The resource identifier (RID) of the view that represents a stream.""" core.resolve_forward_references(GetEndOffsetsResponse, globalns=globals(), localns=locals()) core.resolve_forward_references(GetRecordsResponse, globalns=globals(), localns=locals()) -core.resolve_forward_references(PartitionOffsets, globalns=globals(), localns=locals()) -core.resolve_forward_references(PartitionRecords, globalns=globals(), localns=locals()) -core.resolve_forward_references(ReadPosition, globalns=globals(), localns=locals()) core.resolve_forward_references(Record, globalns=globals(), localns=locals()) __all__ = [ - "CommitSubscriberOffsetsRequest", "Compressed", "CreateStreamRequest", "CreateStreamRequestStreamSchema", "CreateStreamingDatasetRequest", - "CreateSubscriberRequest", "Dataset", - "EarliestPosition", "GetEndOffsetsResponse", "GetRecordsResponse", - "LatestPosition", "PartitionId", - "PartitionOffsets", - "PartitionRecords", "PartitionsCount", "PublishRecordToStreamRequest", "PublishRecordsToStreamRequest", - "ReadPosition", - "ReadRecordsFromSubscriberRequest", - "ReadSubscriberRecordsResponse", "Record", "RecordWithOffset", "ResetStreamRequest", - "ResetSubscriberOffsetsRequest", - "SpecificPosition", "Stream", "StreamType", - "Subscriber", - "SubscriberId", "ViewRid", ] diff --git a/foundry_sdk/v2/streams/stream.py b/foundry_sdk/v2/streams/stream.py index 77e60f8c3..1e75b3fae 100644 --- a/foundry_sdk/v2/streams/stream.py +++ b/foundry_sdk/v2/streams/stream.py @@ -14,7 +14,6 @@ import typing -from functools import cached_property import pydantic import typing_extensions @@ -57,16 +56,6 @@ def __init__( self.with_streaming_response = _StreamClientStreaming(self) self.with_raw_response = _StreamClientRaw(self) - @cached_property - def Subscriber(self): - from foundry_sdk.v2.streams.subscriber import SubscriberClient - - return SubscriberClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -154,6 +143,7 @@ def get( dataset_rid: core_models.DatasetRid, stream_branch_name: core_models.BranchName, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> streams_models.Stream: @@ -165,6 +155,8 @@ def get( :type dataset_rid: DatasetRid :param stream_branch_name: :type stream_branch_name: BranchName + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -180,7 +172,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/streams/datasets/{datasetRid}/streams/{streamBranchName}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "datasetRid": dataset_rid, "streamBranchName": stream_branch_name, @@ -339,6 +333,7 @@ def publish_binary_record( stream_branch_name: core_models.BranchName, body: bytes, *, + preview: typing.Optional[core_models.PreviewMode] = None, view_rid: typing.Optional[streams_models.ViewRid] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -352,6 +347,8 @@ def publish_binary_record( :type stream_branch_name: BranchName :param body: The binary record to publish to the stream :type body: bytes + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param view_rid: If provided, this endpoint will only write to the stream corresponding to the specified view RID. If not provided, this endpoint will write to the latest stream on the branch. Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed. :type view_rid: Optional[ViewRid] :param request_timeout: timeout setting for this request in seconds. @@ -367,6 +364,7 @@ def publish_binary_record( method="POST", resource_path="/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishBinaryRecord", query_params={ + "preview": preview, "viewRid": view_rid, }, path_params={ @@ -396,6 +394,7 @@ def publish_record( stream_branch_name: core_models.BranchName, *, record: streams_models.Record, + preview: typing.Optional[core_models.PreviewMode] = None, view_rid: typing.Optional[streams_models.ViewRid] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -410,6 +409,8 @@ def publish_record( :type stream_branch_name: BranchName :param record: The record to publish to the stream :type record: Record + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param view_rid: If provided, this endpoint will only write to the stream corresponding to the specified view RID. If not provided, this endpoint will write the latest stream on the branch. Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed. :type view_rid: Optional[ViewRid] :param request_timeout: timeout setting for this request in seconds. @@ -424,7 +425,9 @@ def publish_record( core.RequestInfo( method="POST", resource_path="/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecord", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "datasetRid": dataset_rid, "streamBranchName": stream_branch_name, @@ -455,6 +458,7 @@ def publish_records( stream_branch_name: core_models.BranchName, *, records: typing.List[streams_models.Record], + preview: typing.Optional[core_models.PreviewMode] = None, view_rid: typing.Optional[streams_models.ViewRid] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -469,6 +473,8 @@ def publish_records( :type stream_branch_name: BranchName :param records: The records to publish to the stream :type records: List[Record] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param view_rid: If provided, this endpoint will only write to the stream corresponding to the specified view RID. If not provided, this endpoint will write to the latest stream on the branch. Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed. :type view_rid: Optional[ViewRid] :param request_timeout: timeout setting for this request in seconds. @@ -483,7 +489,9 @@ def publish_records( core.RequestInfo( method="POST", resource_path="/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecords", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "datasetRid": dataset_rid, "streamBranchName": stream_branch_name, @@ -660,16 +668,6 @@ def __init__( self.with_streaming_response = _AsyncStreamClientStreaming(self) self.with_raw_response = _AsyncStreamClientRaw(self) - @cached_property - def Subscriber(self): - from foundry_sdk.v2.streams.subscriber import AsyncSubscriberClient - - return AsyncSubscriberClient( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -757,6 +755,7 @@ def get( dataset_rid: core_models.DatasetRid, stream_branch_name: core_models.BranchName, *, + preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[streams_models.Stream]: @@ -768,6 +767,8 @@ def get( :type dataset_rid: DatasetRid :param stream_branch_name: :type stream_branch_name: BranchName + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -783,7 +784,9 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/streams/datasets/{datasetRid}/streams/{streamBranchName}", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "datasetRid": dataset_rid, "streamBranchName": stream_branch_name, @@ -942,6 +945,7 @@ def publish_binary_record( stream_branch_name: core_models.BranchName, body: bytes, *, + preview: typing.Optional[core_models.PreviewMode] = None, view_rid: typing.Optional[streams_models.ViewRid] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -955,6 +959,8 @@ def publish_binary_record( :type stream_branch_name: BranchName :param body: The binary record to publish to the stream :type body: bytes + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param view_rid: If provided, this endpoint will only write to the stream corresponding to the specified view RID. If not provided, this endpoint will write to the latest stream on the branch. Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed. :type view_rid: Optional[ViewRid] :param request_timeout: timeout setting for this request in seconds. @@ -970,6 +976,7 @@ def publish_binary_record( method="POST", resource_path="/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishBinaryRecord", query_params={ + "preview": preview, "viewRid": view_rid, }, path_params={ @@ -999,6 +1006,7 @@ def publish_record( stream_branch_name: core_models.BranchName, *, record: streams_models.Record, + preview: typing.Optional[core_models.PreviewMode] = None, view_rid: typing.Optional[streams_models.ViewRid] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -1013,6 +1021,8 @@ def publish_record( :type stream_branch_name: BranchName :param record: The record to publish to the stream :type record: Record + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param view_rid: If provided, this endpoint will only write to the stream corresponding to the specified view RID. If not provided, this endpoint will write the latest stream on the branch. Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed. :type view_rid: Optional[ViewRid] :param request_timeout: timeout setting for this request in seconds. @@ -1027,7 +1037,9 @@ def publish_record( core.RequestInfo( method="POST", resource_path="/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecord", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "datasetRid": dataset_rid, "streamBranchName": stream_branch_name, @@ -1058,6 +1070,7 @@ def publish_records( stream_branch_name: core_models.BranchName, *, records: typing.List[streams_models.Record], + preview: typing.Optional[core_models.PreviewMode] = None, view_rid: typing.Optional[streams_models.ViewRid] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -1072,6 +1085,8 @@ def publish_records( :type stream_branch_name: BranchName :param records: The records to publish to the stream :type records: List[Record] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] :param view_rid: If provided, this endpoint will only write to the stream corresponding to the specified view RID. If not provided, this endpoint will write to the latest stream on the branch. Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed. :type view_rid: Optional[ViewRid] :param request_timeout: timeout setting for this request in seconds. @@ -1086,7 +1101,9 @@ def publish_records( core.RequestInfo( method="POST", resource_path="/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecords", - query_params={}, + query_params={ + "preview": preview, + }, path_params={ "datasetRid": dataset_rid, "streamBranchName": stream_branch_name, diff --git a/foundry_sdk/v2/streams/subscriber.py b/foundry_sdk/v2/streams/subscriber.py deleted file mode 100644 index c8dd64a9b..000000000 --- a/foundry_sdk/v2/streams/subscriber.py +++ /dev/null @@ -1,1007 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.core import models as core_models -from foundry_sdk.v2.streams import errors as streams_errors -from foundry_sdk.v2.streams import models as streams_models - - -class SubscriberClient: - """ - The API client for the Subscriber Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _SubscriberClientStreaming(self) - self.with_raw_response = _SubscriberClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def commit_offsets( - self, - dataset_rid: core_models.DatasetRid, - stream_branch_name: core_models.BranchName, - subscriber_subscriber_id: streams_models.SubscriberId, - *, - offsets: streams_models.PartitionOffsets, - preview: typing.Optional[core_models.PreviewMode] = None, - view_rid: typing.Optional[streams_models.ViewRid] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> streams_models.PartitionOffsets: - """ - Explicitly commit offsets for a subscriber. Required when `autoCommit` is false. - - Pass the last offset you processed for each partition. - - For example, if you processed a record at offset 50, commit `{"0": 50}` and the next - read from partition "0" will start at offset 51. - - :param dataset_rid: - :type dataset_rid: DatasetRid - :param stream_branch_name: - :type stream_branch_name: BranchName - :param subscriber_subscriber_id: - :type subscriber_subscriber_id: SubscriberId - :param offsets: The last processed offset for each partition. The server will store these as read positions (offset + 1), so the next read starts after the committed offset. - :type offsets: PartitionOffsets - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param view_rid: The view RID to commit offsets for. If not provided, uses the latest view for the dataset/branch. - :type view_rid: Optional[ViewRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: streams_models.PartitionOffsets - - :raises CommitSubscriberOffsetsPermissionDenied: Could not commitOffsets the Subscriber. - :raises SubscriberNotFound: No subscriber with the given ID was found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId}/commitOffsets", - query_params={ - "preview": preview, - }, - path_params={ - "datasetRid": dataset_rid, - "streamBranchName": stream_branch_name, - "subscriberSubscriberId": subscriber_subscriber_id, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=streams_models.CommitSubscriberOffsetsRequest( - view_rid=view_rid, - offsets=offsets, - ), - response_type=streams_models.PartitionOffsets, - request_timeout=request_timeout, - throwable_errors={ - "CommitSubscriberOffsetsPermissionDenied": streams_errors.CommitSubscriberOffsetsPermissionDenied, - "SubscriberNotFound": streams_errors.SubscriberNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - endpoint_type=core.EndpointType.HIGH_SCALE, - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def create( - self, - dataset_rid: core_models.DatasetRid, - stream_branch_name: core_models.BranchName, - *, - subscriber_id: streams_models.SubscriberId, - preview: typing.Optional[core_models.PreviewMode] = None, - read_position: typing.Optional[streams_models.ReadPosition] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> streams_models.Subscriber: - """ - Register a new subscriber for a stream. Subscribers maintain server-side offset tracking, - allowing reliable consumption without client-side state management. - - If a subscriber with the same ID already exists for this stream, the existing registration - is returned. If a subscriber with the same ID exists for a different stream, an error is returned. - - :param dataset_rid: - :type dataset_rid: DatasetRid - :param stream_branch_name: - :type stream_branch_name: BranchName - :param subscriber_id: - :type subscriber_id: SubscriberId - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param read_position: Where to start reading from. Defaults to `earliest` if not specified. The `readPosition` determines where the subscriber will start reading: - `earliest`: Start from the beginning of each partition (offset 0). Use this to process all historical data. - `latest`: Start from the current end of each partition. Use this to skip historical data and only process new records arriving after registration. - `specific`: Start from explicit offsets for each partition. Use this to resume from a known checkpoint. - :type read_position: Optional[ReadPosition] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: streams_models.Subscriber - - :raises CreateSubscriberPermissionDenied: Could not create the Subscriber. - :raises SubscriberAlreadyExists: A subscriber with this ID already exists for a different stream. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers", - query_params={ - "preview": preview, - }, - path_params={ - "datasetRid": dataset_rid, - "streamBranchName": stream_branch_name, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=streams_models.CreateSubscriberRequest( - subscriber_id=subscriber_id, - read_position=read_position, - ), - response_type=streams_models.Subscriber, - request_timeout=request_timeout, - throwable_errors={ - "CreateSubscriberPermissionDenied": streams_errors.CreateSubscriberPermissionDenied, - "SubscriberAlreadyExists": streams_errors.SubscriberAlreadyExists, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def delete( - self, - dataset_rid: core_models.DatasetRid, - stream_branch_name: core_models.BranchName, - subscriber_subscriber_id: streams_models.SubscriberId, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> None: - """ - Delete a subscriber and all its committed offset state. After deletion, the subscriber ID - can be reused to create a new subscriber. - - :param dataset_rid: - :type dataset_rid: DatasetRid - :param stream_branch_name: - :type stream_branch_name: BranchName - :param subscriber_subscriber_id: - :type subscriber_subscriber_id: SubscriberId - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - - :raises DeleteSubscriberPermissionDenied: Could not delete the Subscriber. - :raises SubscriberNotFound: No subscriber with the given ID was found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="DELETE", - resource_path="/v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId}", - query_params={ - "preview": preview, - }, - path_params={ - "datasetRid": dataset_rid, - "streamBranchName": stream_branch_name, - "subscriberSubscriberId": subscriber_subscriber_id, - }, - header_params={}, - body=None, - response_type=None, - request_timeout=request_timeout, - throwable_errors={ - "DeleteSubscriberPermissionDenied": streams_errors.DeleteSubscriberPermissionDenied, - "SubscriberNotFound": streams_errors.SubscriberNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get_read_position( - self, - dataset_rid: core_models.DatasetRid, - stream_branch_name: core_models.BranchName, - subscriber_subscriber_id: streams_models.SubscriberId, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - view_rid: typing.Optional[streams_models.ViewRid] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> streams_models.PartitionOffsets: - """ - Get the current read position for a subscriber. Returns the offset per partition where the next read - will begin. - - :param dataset_rid: - :type dataset_rid: DatasetRid - :param stream_branch_name: - :type stream_branch_name: BranchName - :param subscriber_subscriber_id: - :type subscriber_subscriber_id: SubscriberId - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param view_rid: The view RID to get positions for. If not provided, uses the latest view for the dataset/branch. - :type view_rid: Optional[ViewRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: streams_models.PartitionOffsets - - :raises GetSubscriberReadPositionPermissionDenied: Could not getReadPosition the Subscriber. - :raises SubscriberNotFound: No subscriber with the given ID was found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId}/getReadPosition", - query_params={ - "preview": preview, - "viewRid": view_rid, - }, - path_params={ - "datasetRid": dataset_rid, - "streamBranchName": stream_branch_name, - "subscriberSubscriberId": subscriber_subscriber_id, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=streams_models.PartitionOffsets, - request_timeout=request_timeout, - throwable_errors={ - "GetSubscriberReadPositionPermissionDenied": streams_errors.GetSubscriberReadPositionPermissionDenied, - "SubscriberNotFound": streams_errors.SubscriberNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - endpoint_type=core.EndpointType.HIGH_SCALE, - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def read_records( - self, - dataset_rid: core_models.DatasetRid, - stream_branch_name: core_models.BranchName, - subscriber_subscriber_id: streams_models.SubscriberId, - *, - auto_commit: typing.Optional[bool] = None, - limit: typing.Optional[int] = None, - partition_ids: typing.Optional[typing.List[streams_models.PartitionId]] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - view_rid: typing.Optional[streams_models.ViewRid] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> streams_models.ReadSubscriberRecordsResponse: - """ - Fetch records for a subscriber starting from their committed offset. Returns records - grouped by partition. - - If `autoCommit` is true, offsets are automatically committed after the records are - fetched, so the next read will start from where this one left off. - - If `autoCommit` is false, you must call `commitOffsets` to update the read position. - Use manual commits for at-least-once processing where you need to ensure records are - processed before acknowledging them. - - :param dataset_rid: - :type dataset_rid: DatasetRid - :param stream_branch_name: - :type stream_branch_name: BranchName - :param subscriber_subscriber_id: - :type subscriber_subscriber_id: SubscriberId - :param auto_commit: If true, the read position is automatically committed after reading records. The committed position will be the offset after the last record read. If false, you must call the `commitOffsets` endpoint to commit offsets. Defaults to false. - :type auto_commit: Optional[bool] - :param limit: Maximum number of records to return across all partitions. Defaults to 100, max 1000. If a value greater than 1000 is requested, only 1000 records will be returned. - :type limit: Optional[int] - :param partition_ids: If specified, only read from these partitions. Otherwise, read from all partitions. - :type partition_ids: Optional[List[PartitionId]] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param view_rid: The view RID to read from. If not provided, reads from the latest view for the dataset/branch. - :type view_rid: Optional[ViewRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: streams_models.ReadSubscriberRecordsResponse - - :raises ReadRecordsFromSubscriberPermissionDenied: Could not readRecords the Subscriber. - :raises SubscriberNotFound: No subscriber with the given ID was found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId}/readRecords", - query_params={ - "preview": preview, - }, - path_params={ - "datasetRid": dataset_rid, - "streamBranchName": stream_branch_name, - "subscriberSubscriberId": subscriber_subscriber_id, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=streams_models.ReadRecordsFromSubscriberRequest( - view_rid=view_rid, - limit=limit, - partition_ids=partition_ids, - auto_commit=auto_commit, - ), - response_type=streams_models.ReadSubscriberRecordsResponse, - request_timeout=request_timeout, - throwable_errors={ - "ReadRecordsFromSubscriberPermissionDenied": streams_errors.ReadRecordsFromSubscriberPermissionDenied, - "SubscriberNotFound": streams_errors.SubscriberNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - endpoint_type=core.EndpointType.HIGH_SCALE, - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def reset_offsets( - self, - dataset_rid: core_models.DatasetRid, - stream_branch_name: core_models.BranchName, - subscriber_subscriber_id: streams_models.SubscriberId, - *, - position: streams_models.ReadPosition, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> streams_models.PartitionOffsets: - """ - Reset subscriber offsets to a specific position. Use this to replay data from the - beginning, skip to the latest records, or jump to specific offsets. - - The `position` parameter determines where reading will resume: - - `earliest`: Reset to the beginning of each partition (offset 0) - - `latest`: Reset to the current end of each partition - - `specific`: Reset to explicit offsets for each partition - - :param dataset_rid: - :type dataset_rid: DatasetRid - :param stream_branch_name: - :type stream_branch_name: BranchName - :param subscriber_subscriber_id: - :type subscriber_subscriber_id: SubscriberId - :param position: The position to reset offsets to. - :type position: ReadPosition - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: streams_models.PartitionOffsets - - :raises ResetSubscriberOffsetsPermissionDenied: Could not resetOffsets the Subscriber. - :raises SubscriberNotFound: No subscriber with the given ID was found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId}/resetOffsets", - query_params={ - "preview": preview, - }, - path_params={ - "datasetRid": dataset_rid, - "streamBranchName": stream_branch_name, - "subscriberSubscriberId": subscriber_subscriber_id, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=streams_models.ResetSubscriberOffsetsRequest( - position=position, - ), - response_type=streams_models.PartitionOffsets, - request_timeout=request_timeout, - throwable_errors={ - "ResetSubscriberOffsetsPermissionDenied": streams_errors.ResetSubscriberOffsetsPermissionDenied, - "SubscriberNotFound": streams_errors.SubscriberNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - endpoint_type=core.EndpointType.HIGH_SCALE, - ), - ) - - -class _SubscriberClientRaw: - def __init__(self, client: SubscriberClient) -> None: - def commit_offsets(_: streams_models.PartitionOffsets): ... - def create(_: streams_models.Subscriber): ... - def delete(_: None): ... - def get_read_position(_: streams_models.PartitionOffsets): ... - def read_records(_: streams_models.ReadSubscriberRecordsResponse): ... - def reset_offsets(_: streams_models.PartitionOffsets): ... - - self.commit_offsets = core.with_raw_response(commit_offsets, client.commit_offsets) - self.create = core.with_raw_response(create, client.create) - self.delete = core.with_raw_response(delete, client.delete) - self.get_read_position = core.with_raw_response(get_read_position, client.get_read_position) - self.read_records = core.with_raw_response(read_records, client.read_records) - self.reset_offsets = core.with_raw_response(reset_offsets, client.reset_offsets) - - -class _SubscriberClientStreaming: - def __init__(self, client: SubscriberClient) -> None: - def commit_offsets(_: streams_models.PartitionOffsets): ... - def create(_: streams_models.Subscriber): ... - def get_read_position(_: streams_models.PartitionOffsets): ... - def read_records(_: streams_models.ReadSubscriberRecordsResponse): ... - def reset_offsets(_: streams_models.PartitionOffsets): ... - - self.commit_offsets = core.with_streaming_response(commit_offsets, client.commit_offsets) - self.create = core.with_streaming_response(create, client.create) - self.get_read_position = core.with_streaming_response( - get_read_position, client.get_read_position - ) - self.read_records = core.with_streaming_response(read_records, client.read_records) - self.reset_offsets = core.with_streaming_response(reset_offsets, client.reset_offsets) - - -class AsyncSubscriberClient: - """ - The API client for the Subscriber Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncSubscriberClientStreaming(self) - self.with_raw_response = _AsyncSubscriberClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def commit_offsets( - self, - dataset_rid: core_models.DatasetRid, - stream_branch_name: core_models.BranchName, - subscriber_subscriber_id: streams_models.SubscriberId, - *, - offsets: streams_models.PartitionOffsets, - preview: typing.Optional[core_models.PreviewMode] = None, - view_rid: typing.Optional[streams_models.ViewRid] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[streams_models.PartitionOffsets]: - """ - Explicitly commit offsets for a subscriber. Required when `autoCommit` is false. - - Pass the last offset you processed for each partition. - - For example, if you processed a record at offset 50, commit `{"0": 50}` and the next - read from partition "0" will start at offset 51. - - :param dataset_rid: - :type dataset_rid: DatasetRid - :param stream_branch_name: - :type stream_branch_name: BranchName - :param subscriber_subscriber_id: - :type subscriber_subscriber_id: SubscriberId - :param offsets: The last processed offset for each partition. The server will store these as read positions (offset + 1), so the next read starts after the committed offset. - :type offsets: PartitionOffsets - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param view_rid: The view RID to commit offsets for. If not provided, uses the latest view for the dataset/branch. - :type view_rid: Optional[ViewRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[streams_models.PartitionOffsets] - - :raises CommitSubscriberOffsetsPermissionDenied: Could not commitOffsets the Subscriber. - :raises SubscriberNotFound: No subscriber with the given ID was found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId}/commitOffsets", - query_params={ - "preview": preview, - }, - path_params={ - "datasetRid": dataset_rid, - "streamBranchName": stream_branch_name, - "subscriberSubscriberId": subscriber_subscriber_id, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=streams_models.CommitSubscriberOffsetsRequest( - view_rid=view_rid, - offsets=offsets, - ), - response_type=streams_models.PartitionOffsets, - request_timeout=request_timeout, - throwable_errors={ - "CommitSubscriberOffsetsPermissionDenied": streams_errors.CommitSubscriberOffsetsPermissionDenied, - "SubscriberNotFound": streams_errors.SubscriberNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - endpoint_type=core.EndpointType.HIGH_SCALE, - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def create( - self, - dataset_rid: core_models.DatasetRid, - stream_branch_name: core_models.BranchName, - *, - subscriber_id: streams_models.SubscriberId, - preview: typing.Optional[core_models.PreviewMode] = None, - read_position: typing.Optional[streams_models.ReadPosition] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[streams_models.Subscriber]: - """ - Register a new subscriber for a stream. Subscribers maintain server-side offset tracking, - allowing reliable consumption without client-side state management. - - If a subscriber with the same ID already exists for this stream, the existing registration - is returned. If a subscriber with the same ID exists for a different stream, an error is returned. - - :param dataset_rid: - :type dataset_rid: DatasetRid - :param stream_branch_name: - :type stream_branch_name: BranchName - :param subscriber_id: - :type subscriber_id: SubscriberId - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param read_position: Where to start reading from. Defaults to `earliest` if not specified. The `readPosition` determines where the subscriber will start reading: - `earliest`: Start from the beginning of each partition (offset 0). Use this to process all historical data. - `latest`: Start from the current end of each partition. Use this to skip historical data and only process new records arriving after registration. - `specific`: Start from explicit offsets for each partition. Use this to resume from a known checkpoint. - :type read_position: Optional[ReadPosition] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[streams_models.Subscriber] - - :raises CreateSubscriberPermissionDenied: Could not create the Subscriber. - :raises SubscriberAlreadyExists: A subscriber with this ID already exists for a different stream. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers", - query_params={ - "preview": preview, - }, - path_params={ - "datasetRid": dataset_rid, - "streamBranchName": stream_branch_name, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=streams_models.CreateSubscriberRequest( - subscriber_id=subscriber_id, - read_position=read_position, - ), - response_type=streams_models.Subscriber, - request_timeout=request_timeout, - throwable_errors={ - "CreateSubscriberPermissionDenied": streams_errors.CreateSubscriberPermissionDenied, - "SubscriberAlreadyExists": streams_errors.SubscriberAlreadyExists, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def delete( - self, - dataset_rid: core_models.DatasetRid, - stream_branch_name: core_models.BranchName, - subscriber_subscriber_id: streams_models.SubscriberId, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[None]: - """ - Delete a subscriber and all its committed offset state. After deletion, the subscriber ID - can be reused to create a new subscriber. - - :param dataset_rid: - :type dataset_rid: DatasetRid - :param stream_branch_name: - :type stream_branch_name: BranchName - :param subscriber_subscriber_id: - :type subscriber_subscriber_id: SubscriberId - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[None] - - :raises DeleteSubscriberPermissionDenied: Could not delete the Subscriber. - :raises SubscriberNotFound: No subscriber with the given ID was found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="DELETE", - resource_path="/v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId}", - query_params={ - "preview": preview, - }, - path_params={ - "datasetRid": dataset_rid, - "streamBranchName": stream_branch_name, - "subscriberSubscriberId": subscriber_subscriber_id, - }, - header_params={}, - body=None, - response_type=None, - request_timeout=request_timeout, - throwable_errors={ - "DeleteSubscriberPermissionDenied": streams_errors.DeleteSubscriberPermissionDenied, - "SubscriberNotFound": streams_errors.SubscriberNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get_read_position( - self, - dataset_rid: core_models.DatasetRid, - stream_branch_name: core_models.BranchName, - subscriber_subscriber_id: streams_models.SubscriberId, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - view_rid: typing.Optional[streams_models.ViewRid] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[streams_models.PartitionOffsets]: - """ - Get the current read position for a subscriber. Returns the offset per partition where the next read - will begin. - - :param dataset_rid: - :type dataset_rid: DatasetRid - :param stream_branch_name: - :type stream_branch_name: BranchName - :param subscriber_subscriber_id: - :type subscriber_subscriber_id: SubscriberId - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param view_rid: The view RID to get positions for. If not provided, uses the latest view for the dataset/branch. - :type view_rid: Optional[ViewRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[streams_models.PartitionOffsets] - - :raises GetSubscriberReadPositionPermissionDenied: Could not getReadPosition the Subscriber. - :raises SubscriberNotFound: No subscriber with the given ID was found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId}/getReadPosition", - query_params={ - "preview": preview, - "viewRid": view_rid, - }, - path_params={ - "datasetRid": dataset_rid, - "streamBranchName": stream_branch_name, - "subscriberSubscriberId": subscriber_subscriber_id, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=streams_models.PartitionOffsets, - request_timeout=request_timeout, - throwable_errors={ - "GetSubscriberReadPositionPermissionDenied": streams_errors.GetSubscriberReadPositionPermissionDenied, - "SubscriberNotFound": streams_errors.SubscriberNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - endpoint_type=core.EndpointType.HIGH_SCALE, - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def read_records( - self, - dataset_rid: core_models.DatasetRid, - stream_branch_name: core_models.BranchName, - subscriber_subscriber_id: streams_models.SubscriberId, - *, - auto_commit: typing.Optional[bool] = None, - limit: typing.Optional[int] = None, - partition_ids: typing.Optional[typing.List[streams_models.PartitionId]] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - view_rid: typing.Optional[streams_models.ViewRid] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[streams_models.ReadSubscriberRecordsResponse]: - """ - Fetch records for a subscriber starting from their committed offset. Returns records - grouped by partition. - - If `autoCommit` is true, offsets are automatically committed after the records are - fetched, so the next read will start from where this one left off. - - If `autoCommit` is false, you must call `commitOffsets` to update the read position. - Use manual commits for at-least-once processing where you need to ensure records are - processed before acknowledging them. - - :param dataset_rid: - :type dataset_rid: DatasetRid - :param stream_branch_name: - :type stream_branch_name: BranchName - :param subscriber_subscriber_id: - :type subscriber_subscriber_id: SubscriberId - :param auto_commit: If true, the read position is automatically committed after reading records. The committed position will be the offset after the last record read. If false, you must call the `commitOffsets` endpoint to commit offsets. Defaults to false. - :type auto_commit: Optional[bool] - :param limit: Maximum number of records to return across all partitions. Defaults to 100, max 1000. If a value greater than 1000 is requested, only 1000 records will be returned. - :type limit: Optional[int] - :param partition_ids: If specified, only read from these partitions. Otherwise, read from all partitions. - :type partition_ids: Optional[List[PartitionId]] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param view_rid: The view RID to read from. If not provided, reads from the latest view for the dataset/branch. - :type view_rid: Optional[ViewRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[streams_models.ReadSubscriberRecordsResponse] - - :raises ReadRecordsFromSubscriberPermissionDenied: Could not readRecords the Subscriber. - :raises SubscriberNotFound: No subscriber with the given ID was found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId}/readRecords", - query_params={ - "preview": preview, - }, - path_params={ - "datasetRid": dataset_rid, - "streamBranchName": stream_branch_name, - "subscriberSubscriberId": subscriber_subscriber_id, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=streams_models.ReadRecordsFromSubscriberRequest( - view_rid=view_rid, - limit=limit, - partition_ids=partition_ids, - auto_commit=auto_commit, - ), - response_type=streams_models.ReadSubscriberRecordsResponse, - request_timeout=request_timeout, - throwable_errors={ - "ReadRecordsFromSubscriberPermissionDenied": streams_errors.ReadRecordsFromSubscriberPermissionDenied, - "SubscriberNotFound": streams_errors.SubscriberNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - endpoint_type=core.EndpointType.HIGH_SCALE, - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def reset_offsets( - self, - dataset_rid: core_models.DatasetRid, - stream_branch_name: core_models.BranchName, - subscriber_subscriber_id: streams_models.SubscriberId, - *, - position: streams_models.ReadPosition, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[streams_models.PartitionOffsets]: - """ - Reset subscriber offsets to a specific position. Use this to replay data from the - beginning, skip to the latest records, or jump to specific offsets. - - The `position` parameter determines where reading will resume: - - `earliest`: Reset to the beginning of each partition (offset 0) - - `latest`: Reset to the current end of each partition - - `specific`: Reset to explicit offsets for each partition - - :param dataset_rid: - :type dataset_rid: DatasetRid - :param stream_branch_name: - :type stream_branch_name: BranchName - :param subscriber_subscriber_id: - :type subscriber_subscriber_id: SubscriberId - :param position: The position to reset offsets to. - :type position: ReadPosition - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[streams_models.PartitionOffsets] - - :raises ResetSubscriberOffsetsPermissionDenied: Could not resetOffsets the Subscriber. - :raises SubscriberNotFound: No subscriber with the given ID was found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/subscribers/{subscriberSubscriberId}/resetOffsets", - query_params={ - "preview": preview, - }, - path_params={ - "datasetRid": dataset_rid, - "streamBranchName": stream_branch_name, - "subscriberSubscriberId": subscriber_subscriber_id, - }, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=streams_models.ResetSubscriberOffsetsRequest( - position=position, - ), - response_type=streams_models.PartitionOffsets, - request_timeout=request_timeout, - throwable_errors={ - "ResetSubscriberOffsetsPermissionDenied": streams_errors.ResetSubscriberOffsetsPermissionDenied, - "SubscriberNotFound": streams_errors.SubscriberNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - endpoint_type=core.EndpointType.HIGH_SCALE, - ), - ) - - -class _AsyncSubscriberClientRaw: - def __init__(self, client: AsyncSubscriberClient) -> None: - def commit_offsets(_: streams_models.PartitionOffsets): ... - def create(_: streams_models.Subscriber): ... - def delete(_: None): ... - def get_read_position(_: streams_models.PartitionOffsets): ... - def read_records(_: streams_models.ReadSubscriberRecordsResponse): ... - def reset_offsets(_: streams_models.PartitionOffsets): ... - - self.commit_offsets = core.async_with_raw_response(commit_offsets, client.commit_offsets) - self.create = core.async_with_raw_response(create, client.create) - self.delete = core.async_with_raw_response(delete, client.delete) - self.get_read_position = core.async_with_raw_response( - get_read_position, client.get_read_position - ) - self.read_records = core.async_with_raw_response(read_records, client.read_records) - self.reset_offsets = core.async_with_raw_response(reset_offsets, client.reset_offsets) - - -class _AsyncSubscriberClientStreaming: - def __init__(self, client: AsyncSubscriberClient) -> None: - def commit_offsets(_: streams_models.PartitionOffsets): ... - def create(_: streams_models.Subscriber): ... - def get_read_position(_: streams_models.PartitionOffsets): ... - def read_records(_: streams_models.ReadSubscriberRecordsResponse): ... - def reset_offsets(_: streams_models.PartitionOffsets): ... - - self.commit_offsets = core.async_with_streaming_response( - commit_offsets, client.commit_offsets - ) - self.create = core.async_with_streaming_response(create, client.create) - self.get_read_position = core.async_with_streaming_response( - get_read_position, client.get_read_position - ) - self.read_records = core.async_with_streaming_response(read_records, client.read_records) - self.reset_offsets = core.async_with_streaming_response(reset_offsets, client.reset_offsets) diff --git a/foundry_sdk/v2/third_party_applications/errors.py b/foundry_sdk/v2/third_party_applications/errors.py index e07f20447..d025e2705 100644 --- a/foundry_sdk/v2/third_party_applications/errors.py +++ b/foundry_sdk/v2/third_party_applications/errors.py @@ -125,51 +125,6 @@ class InvalidVersion(errors.BadRequestError): error_instance_id: str -class ScanningErroredParameters(typing_extensions.TypedDict): - """An error occurred while scanning the website files for vulnerabilities. Please check the Website Hosting page in Developer Console for more information and try uploading again.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - version: third_party_applications_models.VersionVersion - - -@dataclass -class ScanningErrored(errors.BadRequestError): - name: typing.Literal["ScanningErrored"] - parameters: ScanningErroredParameters - error_instance_id: str - - -class ScanningInProgressParameters(typing_extensions.TypedDict): - """The website files are currently being scanned for vulnerabilities. Please wait for the scan to complete and confirm no vulnerabilities first.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - version: third_party_applications_models.VersionVersion - - -@dataclass -class ScanningInProgress(errors.BadRequestError): - name: typing.Literal["ScanningInProgress"] - parameters: ScanningInProgressParameters - error_instance_id: str - - -class SiteAssetHasVulnerabilitiesParameters(typing_extensions.TypedDict): - """Vulnerabilities were detected in these website files. Please check the Website Hosting page in Developer Console for more information and address these vulnerabilities before uploading again.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - version: third_party_applications_models.VersionVersion - - -@dataclass -class SiteAssetHasVulnerabilities(errors.BadRequestError): - name: typing.Literal["SiteAssetHasVulnerabilities"] - parameters: SiteAssetHasVulnerabilitiesParameters - error_instance_id: str - - class ThirdPartyApplicationNotFoundParameters(typing_extensions.TypedDict): """The given ThirdPartyApplication could not be found.""" @@ -309,9 +264,6 @@ class WebsiteNotFound(errors.NotFoundError): "FileCountLimitExceeded", "FileSizeLimitExceeded", "InvalidVersion", - "ScanningErrored", - "ScanningInProgress", - "SiteAssetHasVulnerabilities", "ThirdPartyApplicationNotFound", "UndeployWebsitePermissionDenied", "UploadSnapshotVersionPermissionDenied", diff --git a/foundry_sdk/v2/widgets/_client.py b/foundry_sdk/v2/widgets/_client.py index 1c9155c3c..77c280bd3 100644 --- a/foundry_sdk/v2/widgets/_client.py +++ b/foundry_sdk/v2/widgets/_client.py @@ -53,16 +53,6 @@ def DevModeSettings(self): config=self._config, ) - @cached_property - def DevModeSettingsV2(self): - from foundry_sdk.v2.widgets.dev_mode_settings_v2 import DevModeSettingsV2Client - - return DevModeSettingsV2Client( - auth=self._auth, - hostname=self._hostname_supplier, - config=self._config, - ) - @cached_property def Repository(self): from foundry_sdk.v2.widgets.repository import RepositoryClient @@ -100,7 +90,6 @@ def __init__( config: typing.Optional[core.Config] = None, ): from foundry_sdk.v2.widgets.dev_mode_settings import AsyncDevModeSettingsClient - from foundry_sdk.v2.widgets.dev_mode_settings_v2 import AsyncDevModeSettingsV2Client # NOQA from foundry_sdk.v2.widgets.repository import AsyncRepositoryClient from foundry_sdk.v2.widgets.widget_set import AsyncWidgetSetClient @@ -108,10 +97,6 @@ def __init__( auth=auth, hostname=hostname, config=config ) - self.DevModeSettingsV2 = AsyncDevModeSettingsV2Client( - auth=auth, hostname=hostname, config=config - ) - self.Repository = AsyncRepositoryClient(auth=auth, hostname=hostname, config=config) self.WidgetSet = AsyncWidgetSetClient(auth=auth, hostname=hostname, config=config) diff --git a/foundry_sdk/v2/widgets/dev_mode_settings.py b/foundry_sdk/v2/widgets/dev_mode_settings.py index ca082df6f..4c09d696c 100644 --- a/foundry_sdk/v2/widgets/dev_mode_settings.py +++ b/foundry_sdk/v2/widgets/dev_mode_settings.py @@ -54,6 +54,49 @@ def __init__( self.with_streaming_response = _DevModeSettingsClientStreaming(self) self.with_raw_response = _DevModeSettingsClientRaw(self) + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def disable( + self, + *, + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> widgets_models.DevModeSettings: + """ + Disable dev mode for the user associated with the provided token. + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: widgets_models.DevModeSettings + + :raises DisableDevModeSettingsPermissionDenied: Could not disable the DevModeSettings. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/widgets/devModeSettings/disable", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + response_type=widgets_models.DevModeSettings, + request_timeout=request_timeout, + throwable_errors={ + "DisableDevModeSettingsPermissionDenied": widgets_errors.DisableDevModeSettingsPermissionDenied, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -97,6 +140,145 @@ def enable( ), ) + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def get( + self, + *, + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> widgets_models.DevModeSettings: + """ + Get the dev mode settings for the user associated with the provided token. + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: widgets_models.DevModeSettings + + :raises DevModeSettingsNotFound: The given DevModeSettings could not be found. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="GET", + resource_path="/v2/widgets/devModeSettings", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + response_type=widgets_models.DevModeSettings, + request_timeout=request_timeout, + throwable_errors={ + "DevModeSettingsNotFound": widgets_errors.DevModeSettingsNotFound, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def pause( + self, + *, + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> widgets_models.DevModeSettings: + """ + Pause dev mode for the user associated with the provided token. + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: widgets_models.DevModeSettings + + :raises PauseDevModeSettingsPermissionDenied: Could not pause the DevModeSettings. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/widgets/devModeSettings/pause", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + response_type=widgets_models.DevModeSettings, + request_timeout=request_timeout, + throwable_errors={ + "PauseDevModeSettingsPermissionDenied": widgets_errors.PauseDevModeSettingsPermissionDenied, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def set_widget_set( + self, + *, + settings: widgets_models.WidgetSetDevModeSettings, + widget_set_rid: widgets_models.WidgetSetRid, + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> widgets_models.DevModeSettings: + """ + Set the dev mode settings for the given widget set for the user associated with the provided token. + :param settings: + :type settings: WidgetSetDevModeSettings + :param widget_set_rid: + :type widget_set_rid: WidgetSetRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: widgets_models.DevModeSettings + + :raises SetWidgetSetDevModeSettingsPermissionDenied: Could not setWidgetSet the DevModeSettings. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/widgets/devModeSettings/setWidgetSet", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body=widgets_models.SetWidgetSetDevModeSettingsRequest( + widget_set_rid=widget_set_rid, + settings=settings, + ), + response_type=widgets_models.DevModeSettings, + request_timeout=request_timeout, + throwable_errors={ + "SetWidgetSetDevModeSettingsPermissionDenied": widgets_errors.SetWidgetSetDevModeSettingsPermissionDenied, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -155,10 +337,18 @@ def set_widget_set_by_id( class _DevModeSettingsClientRaw: def __init__(self, client: DevModeSettingsClient) -> None: + def disable(_: widgets_models.DevModeSettings): ... def enable(_: widgets_models.DevModeSettings): ... + def get(_: widgets_models.DevModeSettings): ... + def pause(_: widgets_models.DevModeSettings): ... + def set_widget_set(_: widgets_models.DevModeSettings): ... def set_widget_set_by_id(_: widgets_models.DevModeSettings): ... + self.disable = core.with_raw_response(disable, client.disable) self.enable = core.with_raw_response(enable, client.enable) + self.get = core.with_raw_response(get, client.get) + self.pause = core.with_raw_response(pause, client.pause) + self.set_widget_set = core.with_raw_response(set_widget_set, client.set_widget_set) self.set_widget_set_by_id = core.with_raw_response( set_widget_set_by_id, client.set_widget_set_by_id ) @@ -166,10 +356,18 @@ def set_widget_set_by_id(_: widgets_models.DevModeSettings): ... class _DevModeSettingsClientStreaming: def __init__(self, client: DevModeSettingsClient) -> None: + def disable(_: widgets_models.DevModeSettings): ... def enable(_: widgets_models.DevModeSettings): ... + def get(_: widgets_models.DevModeSettings): ... + def pause(_: widgets_models.DevModeSettings): ... + def set_widget_set(_: widgets_models.DevModeSettings): ... def set_widget_set_by_id(_: widgets_models.DevModeSettings): ... + self.disable = core.with_streaming_response(disable, client.disable) self.enable = core.with_streaming_response(enable, client.enable) + self.get = core.with_streaming_response(get, client.get) + self.pause = core.with_streaming_response(pause, client.pause) + self.set_widget_set = core.with_streaming_response(set_widget_set, client.set_widget_set) self.set_widget_set_by_id = core.with_streaming_response( set_widget_set_by_id, client.set_widget_set_by_id ) @@ -204,6 +402,49 @@ def __init__( self.with_streaming_response = _AsyncDevModeSettingsClientStreaming(self) self.with_raw_response = _AsyncDevModeSettingsClientRaw(self) + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def disable( + self, + *, + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> typing.Awaitable[widgets_models.DevModeSettings]: + """ + Disable dev mode for the user associated with the provided token. + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: typing.Awaitable[widgets_models.DevModeSettings] + + :raises DisableDevModeSettingsPermissionDenied: Could not disable the DevModeSettings. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/widgets/devModeSettings/disable", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + response_type=widgets_models.DevModeSettings, + request_timeout=request_timeout, + throwable_errors={ + "DisableDevModeSettingsPermissionDenied": widgets_errors.DisableDevModeSettingsPermissionDenied, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -247,6 +488,145 @@ def enable( ), ) + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def get( + self, + *, + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> typing.Awaitable[widgets_models.DevModeSettings]: + """ + Get the dev mode settings for the user associated with the provided token. + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: typing.Awaitable[widgets_models.DevModeSettings] + + :raises DevModeSettingsNotFound: The given DevModeSettings could not be found. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="GET", + resource_path="/v2/widgets/devModeSettings", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + response_type=widgets_models.DevModeSettings, + request_timeout=request_timeout, + throwable_errors={ + "DevModeSettingsNotFound": widgets_errors.DevModeSettingsNotFound, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def pause( + self, + *, + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> typing.Awaitable[widgets_models.DevModeSettings]: + """ + Pause dev mode for the user associated with the provided token. + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: typing.Awaitable[widgets_models.DevModeSettings] + + :raises PauseDevModeSettingsPermissionDenied: Could not pause the DevModeSettings. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/widgets/devModeSettings/pause", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + response_type=widgets_models.DevModeSettings, + request_timeout=request_timeout, + throwable_errors={ + "PauseDevModeSettingsPermissionDenied": widgets_errors.PauseDevModeSettingsPermissionDenied, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def set_widget_set( + self, + *, + settings: widgets_models.WidgetSetDevModeSettings, + widget_set_rid: widgets_models.WidgetSetRid, + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> typing.Awaitable[widgets_models.DevModeSettings]: + """ + Set the dev mode settings for the given widget set for the user associated with the provided token. + :param settings: + :type settings: WidgetSetDevModeSettings + :param widget_set_rid: + :type widget_set_rid: WidgetSetRid + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: typing.Awaitable[widgets_models.DevModeSettings] + + :raises SetWidgetSetDevModeSettingsPermissionDenied: Could not setWidgetSet the DevModeSettings. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/widgets/devModeSettings/setWidgetSet", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body=widgets_models.SetWidgetSetDevModeSettingsRequest( + widget_set_rid=widget_set_rid, + settings=settings, + ), + response_type=widgets_models.DevModeSettings, + request_timeout=request_timeout, + throwable_errors={ + "SetWidgetSetDevModeSettingsPermissionDenied": widgets_errors.SetWidgetSetDevModeSettingsPermissionDenied, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -305,10 +685,18 @@ def set_widget_set_by_id( class _AsyncDevModeSettingsClientRaw: def __init__(self, client: AsyncDevModeSettingsClient) -> None: + def disable(_: widgets_models.DevModeSettings): ... def enable(_: widgets_models.DevModeSettings): ... + def get(_: widgets_models.DevModeSettings): ... + def pause(_: widgets_models.DevModeSettings): ... + def set_widget_set(_: widgets_models.DevModeSettings): ... def set_widget_set_by_id(_: widgets_models.DevModeSettings): ... + self.disable = core.async_with_raw_response(disable, client.disable) self.enable = core.async_with_raw_response(enable, client.enable) + self.get = core.async_with_raw_response(get, client.get) + self.pause = core.async_with_raw_response(pause, client.pause) + self.set_widget_set = core.async_with_raw_response(set_widget_set, client.set_widget_set) self.set_widget_set_by_id = core.async_with_raw_response( set_widget_set_by_id, client.set_widget_set_by_id ) @@ -316,10 +704,20 @@ def set_widget_set_by_id(_: widgets_models.DevModeSettings): ... class _AsyncDevModeSettingsClientStreaming: def __init__(self, client: AsyncDevModeSettingsClient) -> None: + def disable(_: widgets_models.DevModeSettings): ... def enable(_: widgets_models.DevModeSettings): ... + def get(_: widgets_models.DevModeSettings): ... + def pause(_: widgets_models.DevModeSettings): ... + def set_widget_set(_: widgets_models.DevModeSettings): ... def set_widget_set_by_id(_: widgets_models.DevModeSettings): ... + self.disable = core.async_with_streaming_response(disable, client.disable) self.enable = core.async_with_streaming_response(enable, client.enable) + self.get = core.async_with_streaming_response(get, client.get) + self.pause = core.async_with_streaming_response(pause, client.pause) + self.set_widget_set = core.async_with_streaming_response( + set_widget_set, client.set_widget_set + ) self.set_widget_set_by_id = core.async_with_streaming_response( set_widget_set_by_id, client.set_widget_set_by_id ) diff --git a/foundry_sdk/v2/widgets/dev_mode_settings_v2.py b/foundry_sdk/v2/widgets/dev_mode_settings_v2.py deleted file mode 100644 index 73a956c2e..000000000 --- a/foundry_sdk/v2/widgets/dev_mode_settings_v2.py +++ /dev/null @@ -1,379 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import typing - -import pydantic -import typing_extensions - -from foundry_sdk import _core as core -from foundry_sdk import _errors as errors -from foundry_sdk.v2.core import models as core_models -from foundry_sdk.v2.widgets import errors as widgets_errors -from foundry_sdk.v2.widgets import models as widgets_models - - -class DevModeSettingsV2Client: - """ - The API client for the DevModeSettingsV2 Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.ApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _DevModeSettingsV2ClientStreaming(self) - self.with_raw_response = _DevModeSettingsV2ClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def enable( - self, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> widgets_models.DevModeSettingsV2: - """ - Enable dev mode for the user associated with the provided token. - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: widgets_models.DevModeSettingsV2 - - :raises EnableDevModeSettingsV2PermissionDenied: Could not enable the DevModeSettingsV2. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/widgets/devModeSettingsV2/enable", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=widgets_models.DevModeSettingsV2, - request_timeout=request_timeout, - throwable_errors={ - "EnableDevModeSettingsV2PermissionDenied": widgets_errors.EnableDevModeSettingsV2PermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def set_widget_set_manifest( - self, - *, - manifest: typing.Any, - widget_set_rid: widgets_models.WidgetSetRid, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> widgets_models.DevModeSettingsV2: - """ - Set the dev mode settings for the given widget set using the manifest format. - The request body is a dev settings manifest JSON object with the following - structure: - - { - "manifestVersion": "1.0.0", - "devSettings": { - "baseHref": "...", - "widgets": { ... }, - "inputSpec": { ... } - } - } - - See https://github.com/palantir/osdk-ts for the widget library API types for the - dev settings manifest. - - :param manifest: - :type manifest: Any - :param widget_set_rid: - :type widget_set_rid: WidgetSetRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: widgets_models.DevModeSettingsV2 - - :raises InvalidDevModeBaseHref: The base href in the dev mode settings is invalid. It must be a valid localhost URL with an optional port. - :raises InvalidDevModeEntrypointCssCount: The dev mode settings contains too many CSS entrypoints. You must limit the number of CSS entrypoints to the maximum allowed. - :raises InvalidDevModeEntrypointJsCount: The dev mode settings contains too many JavaScript entrypoints. You must limit the number of JavaScript entrypoints to the maximum allowed. - :raises InvalidDevModeFilePath: The dev mode settings contains an invalid entrypoint file path. The file path must be a valid localhost URL with an optional port and a file path. - :raises InvalidDevModeWidgetSettingsCount: The dev mode settings contains too many widget settings. You must limit the number of widget settings to the maximum allowed. - :raises InvalidManifest: The provided manifest could not be parsed or is not well formed. - :raises SetWidgetSetManifestDevModeSettingsV2PermissionDenied: Could not setWidgetSetManifest the DevModeSettingsV2. - :raises WidgetIdNotFound: A non-existent widget id was provided. If creating a new widget, you must first publish your changes before previewing with developer mode. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/widgets/devModeSettingsV2/setWidgetSetManifest", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=widgets_models.SetWidgetSetManifestDevModeSettingsV2Request( - widget_set_rid=widget_set_rid, - manifest=manifest, - ), - response_type=widgets_models.DevModeSettingsV2, - request_timeout=request_timeout, - throwable_errors={ - "InvalidDevModeBaseHref": widgets_errors.InvalidDevModeBaseHref, - "InvalidDevModeEntrypointCssCount": widgets_errors.InvalidDevModeEntrypointCssCount, - "InvalidDevModeEntrypointJsCount": widgets_errors.InvalidDevModeEntrypointJsCount, - "InvalidDevModeFilePath": widgets_errors.InvalidDevModeFilePath, - "InvalidDevModeWidgetSettingsCount": widgets_errors.InvalidDevModeWidgetSettingsCount, - "InvalidManifest": widgets_errors.InvalidManifest, - "SetWidgetSetManifestDevModeSettingsV2PermissionDenied": widgets_errors.SetWidgetSetManifestDevModeSettingsV2PermissionDenied, - "WidgetIdNotFound": widgets_errors.WidgetIdNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _DevModeSettingsV2ClientRaw: - def __init__(self, client: DevModeSettingsV2Client) -> None: - def enable(_: widgets_models.DevModeSettingsV2): ... - def set_widget_set_manifest(_: widgets_models.DevModeSettingsV2): ... - - self.enable = core.with_raw_response(enable, client.enable) - self.set_widget_set_manifest = core.with_raw_response( - set_widget_set_manifest, client.set_widget_set_manifest - ) - - -class _DevModeSettingsV2ClientStreaming: - def __init__(self, client: DevModeSettingsV2Client) -> None: - def enable(_: widgets_models.DevModeSettingsV2): ... - def set_widget_set_manifest(_: widgets_models.DevModeSettingsV2): ... - - self.enable = core.with_streaming_response(enable, client.enable) - self.set_widget_set_manifest = core.with_streaming_response( - set_widget_set_manifest, client.set_widget_set_manifest - ) - - -class AsyncDevModeSettingsV2Client: - """ - The API client for the DevModeSettingsV2 Resource. - - :param auth: Your auth configuration. - :param hostname: The hostname supplier for resolving base URLs. - :param config: Optionally specify the configuration for the HTTP session. - """ - - def __init__( - self, - auth: core.Auth, - hostname: typing.Union[str, core.HostnameSupplier], - config: typing.Optional[core.Config] = None, - ): - self._auth = auth - if isinstance(hostname, core.HostnameSupplier): - self._hostname_supplier = hostname - else: - self._hostname_supplier = core.create_hostname_supplier(hostname, config) - self._hostname = self._hostname_supplier.get_hostname() - self._config = config - self._api_client = core.AsyncApiClient( - auth=auth, hostname=self._hostname_supplier, config=config - ) - - self.with_streaming_response = _AsyncDevModeSettingsV2ClientStreaming(self) - self.with_raw_response = _AsyncDevModeSettingsV2ClientRaw(self) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def enable( - self, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[widgets_models.DevModeSettingsV2]: - """ - Enable dev mode for the user associated with the provided token. - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[widgets_models.DevModeSettingsV2] - - :raises EnableDevModeSettingsV2PermissionDenied: Could not enable the DevModeSettingsV2. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/widgets/devModeSettingsV2/enable", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=widgets_models.DevModeSettingsV2, - request_timeout=request_timeout, - throwable_errors={ - "EnableDevModeSettingsV2PermissionDenied": widgets_errors.EnableDevModeSettingsV2PermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def set_widget_set_manifest( - self, - *, - manifest: typing.Any, - widget_set_rid: widgets_models.WidgetSetRid, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[widgets_models.DevModeSettingsV2]: - """ - Set the dev mode settings for the given widget set using the manifest format. - The request body is a dev settings manifest JSON object with the following - structure: - - { - "manifestVersion": "1.0.0", - "devSettings": { - "baseHref": "...", - "widgets": { ... }, - "inputSpec": { ... } - } - } - - See https://github.com/palantir/osdk-ts for the widget library API types for the - dev settings manifest. - - :param manifest: - :type manifest: Any - :param widget_set_rid: - :type widget_set_rid: WidgetSetRid - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: typing.Awaitable[widgets_models.DevModeSettingsV2] - - :raises InvalidDevModeBaseHref: The base href in the dev mode settings is invalid. It must be a valid localhost URL with an optional port. - :raises InvalidDevModeEntrypointCssCount: The dev mode settings contains too many CSS entrypoints. You must limit the number of CSS entrypoints to the maximum allowed. - :raises InvalidDevModeEntrypointJsCount: The dev mode settings contains too many JavaScript entrypoints. You must limit the number of JavaScript entrypoints to the maximum allowed. - :raises InvalidDevModeFilePath: The dev mode settings contains an invalid entrypoint file path. The file path must be a valid localhost URL with an optional port and a file path. - :raises InvalidDevModeWidgetSettingsCount: The dev mode settings contains too many widget settings. You must limit the number of widget settings to the maximum allowed. - :raises InvalidManifest: The provided manifest could not be parsed or is not well formed. - :raises SetWidgetSetManifestDevModeSettingsV2PermissionDenied: Could not setWidgetSetManifest the DevModeSettingsV2. - :raises WidgetIdNotFound: A non-existent widget id was provided. If creating a new widget, you must first publish your changes before previewing with developer mode. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/widgets/devModeSettingsV2/setWidgetSetManifest", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=widgets_models.SetWidgetSetManifestDevModeSettingsV2Request( - widget_set_rid=widget_set_rid, - manifest=manifest, - ), - response_type=widgets_models.DevModeSettingsV2, - request_timeout=request_timeout, - throwable_errors={ - "InvalidDevModeBaseHref": widgets_errors.InvalidDevModeBaseHref, - "InvalidDevModeEntrypointCssCount": widgets_errors.InvalidDevModeEntrypointCssCount, - "InvalidDevModeEntrypointJsCount": widgets_errors.InvalidDevModeEntrypointJsCount, - "InvalidDevModeFilePath": widgets_errors.InvalidDevModeFilePath, - "InvalidDevModeWidgetSettingsCount": widgets_errors.InvalidDevModeWidgetSettingsCount, - "InvalidManifest": widgets_errors.InvalidManifest, - "SetWidgetSetManifestDevModeSettingsV2PermissionDenied": widgets_errors.SetWidgetSetManifestDevModeSettingsV2PermissionDenied, - "WidgetIdNotFound": widgets_errors.WidgetIdNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - -class _AsyncDevModeSettingsV2ClientRaw: - def __init__(self, client: AsyncDevModeSettingsV2Client) -> None: - def enable(_: widgets_models.DevModeSettingsV2): ... - def set_widget_set_manifest(_: widgets_models.DevModeSettingsV2): ... - - self.enable = core.async_with_raw_response(enable, client.enable) - self.set_widget_set_manifest = core.async_with_raw_response( - set_widget_set_manifest, client.set_widget_set_manifest - ) - - -class _AsyncDevModeSettingsV2ClientStreaming: - def __init__(self, client: AsyncDevModeSettingsV2Client) -> None: - def enable(_: widgets_models.DevModeSettingsV2): ... - def set_widget_set_manifest(_: widgets_models.DevModeSettingsV2): ... - - self.enable = core.async_with_streaming_response(enable, client.enable) - self.set_widget_set_manifest = core.async_with_streaming_response( - set_widget_set_manifest, client.set_widget_set_manifest - ) diff --git a/foundry_sdk/v2/widgets/errors.py b/foundry_sdk/v2/widgets/errors.py index 195ca56ba..10baf0b2f 100644 --- a/foundry_sdk/v2/widgets/errors.py +++ b/foundry_sdk/v2/widgets/errors.py @@ -42,29 +42,42 @@ class DeleteReleasePermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class EnableDevModeSettingsPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not enable the DevModeSettings.""" +class DevModeSettingsNotFoundParameters(typing_extensions.TypedDict): + """The given DevModeSettings could not be found.""" __pydantic_config__ = {"extra": "allow"} # type: ignore @dataclass -class EnableDevModeSettingsPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["EnableDevModeSettingsPermissionDenied"] - parameters: EnableDevModeSettingsPermissionDeniedParameters +class DevModeSettingsNotFound(errors.NotFoundError): + name: typing.Literal["DevModeSettingsNotFound"] + parameters: DevModeSettingsNotFoundParameters + error_instance_id: str + + +class DisableDevModeSettingsPermissionDeniedParameters(typing_extensions.TypedDict): + """Could not disable the DevModeSettings.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + +@dataclass +class DisableDevModeSettingsPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["DisableDevModeSettingsPermissionDenied"] + parameters: DisableDevModeSettingsPermissionDeniedParameters error_instance_id: str -class EnableDevModeSettingsV2PermissionDeniedParameters(typing_extensions.TypedDict): - """Could not enable the DevModeSettingsV2.""" +class EnableDevModeSettingsPermissionDeniedParameters(typing_extensions.TypedDict): + """Could not enable the DevModeSettings.""" __pydantic_config__ = {"extra": "allow"} # type: ignore @dataclass -class EnableDevModeSettingsV2PermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["EnableDevModeSettingsV2PermissionDenied"] - parameters: EnableDevModeSettingsV2PermissionDeniedParameters +class EnableDevModeSettingsPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["EnableDevModeSettingsPermissionDenied"] + parameters: EnableDevModeSettingsPermissionDeniedParameters error_instance_id: str @@ -103,6 +116,19 @@ class FileSizeLimitExceeded(errors.BadRequestError): error_instance_id: str +class GetDevModeSettingsPermissionDeniedParameters(typing_extensions.TypedDict): + """The provided token does not have permission to access dev mode settings.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + +@dataclass +class GetDevModeSettingsPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["GetDevModeSettingsPermissionDenied"] + parameters: GetDevModeSettingsPermissionDeniedParameters + error_instance_id: str + + class InvalidDevModeBaseHrefParameters(typing_extensions.TypedDict): """ The base href in the dev mode settings is invalid. It must be a valid localhost URL @@ -364,7 +390,10 @@ class InvalidFilePath(errors.BadRequestError): class InvalidManifestParameters(typing_extensions.TypedDict): - """The provided manifest could not be parsed or is not well formed.""" + """ + The manifest file in the .zip archive at the path `.palantir/widgets.config.json` + could not be found or is not well formed. + """ __pydantic_config__ = {"extra": "allow"} # type: ignore @@ -588,6 +617,19 @@ class OntologySdkNotFound(errors.NotFoundError): error_instance_id: str +class PauseDevModeSettingsPermissionDeniedParameters(typing_extensions.TypedDict): + """Could not pause the DevModeSettings.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + +@dataclass +class PauseDevModeSettingsPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["PauseDevModeSettingsPermissionDenied"] + parameters: PauseDevModeSettingsPermissionDeniedParameters + error_instance_id: str + + class PublishReleasePermissionDeniedParameters(typing_extensions.TypedDict): """Could not publish the Repository.""" @@ -652,16 +694,16 @@ class SetWidgetSetDevModeSettingsByIdPermissionDenied(errors.PermissionDeniedErr error_instance_id: str -class SetWidgetSetManifestDevModeSettingsV2PermissionDeniedParameters(typing_extensions.TypedDict): - """Could not setWidgetSetManifest the DevModeSettingsV2.""" +class SetWidgetSetDevModeSettingsPermissionDeniedParameters(typing_extensions.TypedDict): + """Could not setWidgetSet the DevModeSettings.""" __pydantic_config__ = {"extra": "allow"} # type: ignore @dataclass -class SetWidgetSetManifestDevModeSettingsV2PermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["SetWidgetSetManifestDevModeSettingsV2PermissionDenied"] - parameters: SetWidgetSetManifestDevModeSettingsV2PermissionDeniedParameters +class SetWidgetSetDevModeSettingsPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["SetWidgetSetDevModeSettingsPermissionDenied"] + parameters: SetWidgetSetDevModeSettingsPermissionDeniedParameters error_instance_id: str @@ -753,10 +795,12 @@ class WidgetSetNotFound(errors.NotFoundError): __all__ = [ "DeleteReleasePermissionDenied", + "DevModeSettingsNotFound", + "DisableDevModeSettingsPermissionDenied", "EnableDevModeSettingsPermissionDenied", - "EnableDevModeSettingsV2PermissionDenied", "FileCountLimitExceeded", "FileSizeLimitExceeded", + "GetDevModeSettingsPermissionDenied", "InvalidDevModeBaseHref", "InvalidDevModeEntrypointCssCount", "InvalidDevModeEntrypointJsCount", @@ -786,11 +830,12 @@ class WidgetSetNotFound(errors.NotFoundError): "InvalidWidgetId", "InvalidWidgetName", "OntologySdkNotFound", + "PauseDevModeSettingsPermissionDenied", "PublishReleasePermissionDenied", "ReleaseNotFound", "RepositoryNotFound", "SetWidgetSetDevModeSettingsByIdPermissionDenied", - "SetWidgetSetManifestDevModeSettingsV2PermissionDenied", + "SetWidgetSetDevModeSettingsPermissionDenied", "VersionAlreadyExists", "VersionLimitExceeded", "WidgetIdNotFound", diff --git a/foundry_sdk/v2/widgets/models.py b/foundry_sdk/v2/widgets/models.py index 3ea2c4e7e..3880ba401 100644 --- a/foundry_sdk/v2/widgets/models.py +++ b/foundry_sdk/v2/widgets/models.py @@ -31,31 +31,6 @@ class DevModeSettings(core.ModelBase): """The dev mode settings for each widget set, keyed by widget set RID.""" -class DevModeSettingsV2(core.ModelBase): - """DevModeSettingsV2""" - - status: DevModeStatus - snapshot: typing.Optional[DevModeSnapshot] = None - """The content-addressed snapshot of the current dev mode settings, if any.""" - - -class DevModeSnapshot(core.ModelBase): - """ - A content-addressed snapshot of the dev mode settings. Snapshots are immutable - and identified by their content-addressed ID. - """ - - snapshot_id: DevModeSnapshotId = pydantic.Field(alias=str("snapshotId")) # type: ignore[literal-required] - """The content-addressed identifier for this snapshot.""" - - widget_set_settings: typing.Dict[WidgetSetRid, WidgetSetDevModeSettingsV2] = pydantic.Field(alias=str("widgetSetSettings")) # type: ignore[literal-required] - """The dev mode settings for each widget set, keyed by widget set RID.""" - - -DevModeSnapshotId = str -"""A content-addressed identifier for a dev mode settings snapshot.""" - - DevModeStatus = typing.Literal["ENABLED", "PAUSED", "DISABLED"] """The user's global development mode status for widget sets.""" @@ -71,24 +46,6 @@ class ListReleasesResponse(core.ModelBase): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] -class OntologySdkInputSpec(core.ModelBase): - """A specification of an Ontology SDK used by a widget set.""" - - sdk_package_rid: OntologySdkPackageRid = pydantic.Field(alias=str("sdkPackageRid")) # type: ignore[literal-required] - """The RID of the Ontology SDK package.""" - - sdk_version: OntologySdkVersion = pydantic.Field(alias=str("sdkVersion")) # type: ignore[literal-required] - """The version of the Ontology SDK.""" - - -OntologySdkPackageRid = core.RID -"""A Resource Identifier (RID) identifying an Ontology SDK package.""" - - -OntologySdkVersion = str -"""A limited semver version string of the format major.minor.patch.""" - - class Release(core.ModelBase): """Release""" @@ -169,11 +126,11 @@ class SetWidgetSetDevModeSettingsByIdRequest(core.ModelBase): settings: WidgetSetDevModeSettingsById -class SetWidgetSetManifestDevModeSettingsV2Request(core.ModelBase): - """SetWidgetSetManifestDevModeSettingsV2Request""" +class SetWidgetSetDevModeSettingsRequest(core.ModelBase): + """SetWidgetSetDevModeSettingsRequest""" widget_set_rid: WidgetSetRid = pydantic.Field(alias=str("widgetSetRid")) # type: ignore[literal-required] - manifest: typing.Any + settings: WidgetSetDevModeSettings class StylesheetEntrypoint(core.ModelBase): @@ -199,22 +156,6 @@ class WidgetDevModeSettings(core.ModelBase): """The entrypoint CSS files for the widget.""" -class WidgetDevModeSettingsV2(core.ModelBase): - """The settings for a given widget in development mode (v2).""" - - name: typing.Optional[str] = None - """The display name of the widget.""" - - description: typing.Optional[str] = None - """A description of the widget.""" - - script_entrypoints: typing.List[ScriptEntrypoint] = pydantic.Field(alias=str("scriptEntrypoints")) # type: ignore[literal-required] - """The entrypoint JavaScript files for the widget.""" - - stylesheet_entrypoints: typing.List[StylesheetEntrypoint] = pydantic.Field(alias=str("stylesheetEntrypoints")) # type: ignore[literal-required] - """The entrypoint CSS files for the widget.""" - - WidgetId = str """ Human readable ID for a widget. Must be unique within a widget set. @@ -264,44 +205,15 @@ class WidgetSetDevModeSettingsById(core.ModelBase): """The dev mode settings for each widget in the widget set, keyed by widget IDs.""" -class WidgetSetDevModeSettingsV2(core.ModelBase): - """The settings for a widget set in development mode (v2), keyed by widget ID.""" - - base_href: str = pydantic.Field(alias=str("baseHref")) # type: ignore[literal-required] - """The base path for the HTML file used to render the widget in dev mode.""" - - input_spec: typing.Optional[WidgetSetInputSpec] = pydantic.Field(alias=str("inputSpec"), default=None) # type: ignore[literal-required] - """The input spec for the widget set in dev mode.""" - - widget_settings: typing.Dict[WidgetId, WidgetDevModeSettingsV2] = pydantic.Field(alias=str("widgetSettings")) # type: ignore[literal-required] - """The dev mode settings for each widget in the widget set, keyed by widget IDs.""" - - -class WidgetSetInputSpec(core.ModelBase): - """ - A specification of the Foundry data inputs that a widget set uses. This restricts - the data access that a widget set has at runtime. - """ - - sdks: typing.List[OntologySdkInputSpec] - """The Ontology SDK specifications used by the widget set.""" - - WidgetSetRid = core.RID """A Resource Identifier (RID) identifying a widget set.""" __all__ = [ "DevModeSettings", - "DevModeSettingsV2", - "DevModeSnapshot", - "DevModeSnapshotId", "DevModeStatus", "FilePath", "ListReleasesResponse", - "OntologySdkInputSpec", - "OntologySdkPackageRid", - "OntologySdkVersion", "Release", "ReleaseLocator", "ReleaseVersion", @@ -311,16 +223,13 @@ class WidgetSetInputSpec(core.ModelBase): "ScriptEntrypoint", "ScriptType", "SetWidgetSetDevModeSettingsByIdRequest", - "SetWidgetSetManifestDevModeSettingsV2Request", + "SetWidgetSetDevModeSettingsRequest", "StylesheetEntrypoint", "WidgetDevModeSettings", - "WidgetDevModeSettingsV2", "WidgetId", "WidgetRid", "WidgetSet", "WidgetSetDevModeSettings", "WidgetSetDevModeSettingsById", - "WidgetSetDevModeSettingsV2", - "WidgetSetInputSpec", "WidgetSetRid", ] diff --git a/tests/test_resource_import.py b/tests/test_resource_import.py index bbf66fcf6..651aabc7a 100644 --- a/tests/test_resource_import.py +++ b/tests/test_resource_import.py @@ -91,18 +91,6 @@ def test_admin_v2_authentication_provider_import(): assert AuthenticationProviderClient is not None -def test_admin_v2_cbac_banner_import(): - from foundry_sdk.v2.admin.cbac_banner import CbacBannerClient - - assert CbacBannerClient is not None - - -def test_admin_v2_cbac_marking_restrictions_import(): - from foundry_sdk.v2.admin.cbac_marking_restrictions import CbacMarkingRestrictionsClient # NOQA - - assert CbacMarkingRestrictionsClient is not None - - def test_admin_v2_enrollment_import(): from foundry_sdk.v2.admin.enrollment import EnrollmentClient @@ -193,12 +181,6 @@ def test_admin_v2_organization_import(): assert OrganizationClient is not None -def test_admin_v2_organization_guest_member_import(): - from foundry_sdk.v2.admin.organization_guest_member import OrganizationGuestMemberClient # NOQA - - assert OrganizationGuestMemberClient is not None - - def test_admin_v2_organization_role_assignment_import(): from foundry_sdk.v2.admin.organization_role_assignment import ( OrganizationRoleAssignmentClient, @@ -351,14 +333,6 @@ def test_filesystem_v2_project_import(): assert ProjectClient is not None -def test_filesystem_v2_project_resource_reference_import(): - from foundry_sdk.v2.filesystem.project_resource_reference import ( - ProjectResourceReferenceClient, - ) # NOQA - - assert ProjectResourceReferenceClient is not None - - def test_filesystem_v2_resource_import(): from foundry_sdk.v2.filesystem.resource import ResourceClient @@ -377,12 +351,6 @@ def test_filesystem_v2_space_import(): assert SpaceClient is not None -def test_functions_v2_execution_import(): - from foundry_sdk.v2.functions.execution import ExecutionClient - - assert ExecutionClient is not None - - def test_functions_v2_query_import(): from foundry_sdk.v2.functions.query import QueryClient @@ -419,70 +387,12 @@ def test_media_sets_v2_media_set_import(): assert MediaSetClient is not None -def test_models_v2_experiment_import(): - from foundry_sdk.v2.models.experiment import ExperimentClient - - assert ExperimentClient is not None - - -def test_models_v2_experiment_artifact_table_import(): - from foundry_sdk.v2.models.experiment_artifact_table import ( - ExperimentArtifactTableClient, - ) # NOQA - - assert ExperimentArtifactTableClient is not None - - -def test_models_v2_experiment_series_import(): - from foundry_sdk.v2.models.experiment_series import ExperimentSeriesClient - - assert ExperimentSeriesClient is not None - - -def test_models_v2_live_deployment_import(): - from foundry_sdk.v2.models.live_deployment import LiveDeploymentClient - - assert LiveDeploymentClient is not None - - def test_models_v2_model_import(): from foundry_sdk.v2.models.model import ModelClient assert ModelClient is not None -def test_models_v2_model_function_import(): - from foundry_sdk.v2.models.model_function import ModelFunctionClient - - assert ModelFunctionClient is not None - - -def test_models_v2_model_studio_import(): - from foundry_sdk.v2.models.model_studio import ModelStudioClient - - assert ModelStudioClient is not None - - -def test_models_v2_model_studio_config_version_import(): - from foundry_sdk.v2.models.model_studio_config_version import ( - ModelStudioConfigVersionClient, - ) # NOQA - - assert ModelStudioConfigVersionClient is not None - - -def test_models_v2_model_studio_run_import(): - from foundry_sdk.v2.models.model_studio_run import ModelStudioRunClient - - assert ModelStudioRunClient is not None - - -def test_models_v2_model_studio_trainer_import(): - from foundry_sdk.v2.models.model_studio_trainer import ModelStudioTrainerClient - - assert ModelStudioTrainerClient is not None - - def test_models_v2_model_version_import(): from foundry_sdk.v2.models.model_version import ModelVersionClient @@ -665,12 +575,6 @@ def test_streams_v2_stream_import(): assert StreamClient is not None -def test_streams_v2_subscriber_import(): - from foundry_sdk.v2.streams.subscriber import SubscriberClient - - assert SubscriberClient is not None - - def test_third_party_applications_v2_third_party_application_import(): from foundry_sdk.v2.third_party_applications.third_party_application import ( ThirdPartyApplicationClient, @@ -697,12 +601,6 @@ def test_widgets_v2_dev_mode_settings_import(): assert DevModeSettingsClient is not None -def test_widgets_v2_dev_mode_settings_v2_import(): - from foundry_sdk.v2.widgets.dev_mode_settings_v2 import DevModeSettingsV2Client - - assert DevModeSettingsV2Client is not None - - def test_widgets_v2_release_import(): from foundry_sdk.v2.widgets.release import ReleaseClient