From adf261d4a59a1b4190c52740f3f304bec683a259 Mon Sep 17 00:00:00 2001 From: Michele Dolfi <97102151+dolfim-ibm@users.noreply.github.com> Date: Mon, 5 Aug 2024 19:59:31 +0200 Subject: [PATCH] feat!: Release v1.0.0 with docling-core, python 3.8 removal (#183) - Update deps - Remove python 3.8 support - Use docling-core - Add cells to results iterator - Fix pre-commit scripts - Regenerate apis --------- Signed-off-by: Michele Dolfi --- .github/actions/setup-poetry/action.yml | 2 +- .github/workflows/checks.yml | 2 +- .pylintrc | 2 +- deepsearch/cps/apis/public_v2/__init__.py | 8 + .../public_v2/api/data_indices_upload_api.py | 1267 ++++++-- .../cps/apis/public_v2/api/project_api.py | 590 +++- .../cps/apis/public_v2/models/__init__.py | 8 + .../cps/apis/public_v2/models/ccs_task.py | 91 + .../models/convert_document_request.py | 97 + .../models/convert_documents_request_body.py | 49 +- .../models/convert_documents_sources.py | 103 + .../convert_upload_documents_request_body.py | 117 + .../cps/apis/public_v2/models/file_source.py | 89 + .../apis/public_v2/models/gen_ai_params.py | 10 +- .../public_v2/models/gen_ai_partial_params.py | 10 +- .../cps/apis/public_v2/models/http_source.py | 89 + .../models/target_conversion_parameters.py | 89 + .../models/upload_elastic_request_body.py | 100 + deepsearch/documents/cli/main.py | 3 +- deepsearch/documents/core/export.py | 75 +- deepsearch/documents/core/utils.py | 18 +- deepsearch/model/server/config.py | 2 + docs/apis/public/AnnotateApi.md | 328 -- docs/apis/public/AnnotateDocumentRequest.md | 14 - docs/apis/public/AnnotateObjectOptions.md | 11 - docs/apis/public/AnnotateObjectOptions1.md | 14 - docs/apis/public/AnnotatedDocumentReport.md | 13 - docs/apis/public/AnnotatedImage.md | 13 - docs/apis/public/AnnotatedObject.md | 12 - docs/apis/public/AnnotatedObject1.md | 12 - docs/apis/public/AnnotatedTable.md | 13 - docs/apis/public/AnnotatedText.md | 13 - docs/apis/public/AnnotatedTextLines.md | 13 - docs/apis/public/AnnotatorImageInput.md | 11 - docs/apis/public/AnnotatorInput.md | 12 - docs/apis/public/AnnotatorMetadata.md | 14 - docs/apis/public/AnnotatorParametersOrRef.md | 13 - ...AnnotatorSupportedAnnotationsParameters.md | 11 - ...sembleDataFlowIntoKnowledgeGraphOptions.md | 12 - ...embleDataFlowIntoKnowledgeGraphOptions1.md | 12 - docs/apis/public/AssembleSettings.md | 11 - docs/apis/public/AssembleSettingsMode.md | 11 - docs/apis/public/AttachmentUploadData.md | 11 - .../public/AttachmentUploadDataUploadData.md | 12 - docs/apis/public/BackendFlavour.md | 11 - ...BagsBagKeyTasksAssembleDataflowDataFlow.md | 13 - ...asksAssembleDataflowDataFlowRawDataFlow.md | 12 - ...eyBagsBagKeyTasksAssembleDataflowRender.md | 10 - .../public/BackupKnowledgeGraphOptions.md | 11 - docs/apis/public/Bag.md | 20 - docs/apis/public/BagAmqpBackend.md | 10 - docs/apis/public/BagBackendAware.md | 18 - docs/apis/public/BagBackends.md | 11 - docs/apis/public/BagCallback.md | 10 - docs/apis/public/BagComponentStatus.md | 11 - docs/apis/public/BagComponentStatusEnum.md | 9 - docs/apis/public/BagFlavour.md | 12 - docs/apis/public/BagFlavourDefaultQuota.md | 12 - docs/apis/public/BagFlavourFullData.md | 18 - docs/apis/public/BagKgLegacyApiBackend.md | 14 - docs/apis/public/BagStatus.md | 11 - docs/apis/public/BagStatusBackendAware.md | 12 - .../public/BagStatusBackendAwareKgAmqp.md | 10 - docs/apis/public/BagStatusComponents.md | 12 - docs/apis/public/CatalogReference.md | 12 - docs/apis/public/CcsCollectionReference.md | 12 - docs/apis/public/CcsTask.md | 12 - docs/apis/public/CeleryTask.md | 12 - docs/apis/public/CeleryTask1.md | 21 - docs/apis/public/CeleryTaskPromise.md | 12 - docs/apis/public/CloneDataCatalogOptions.md | 14 - docs/apis/public/CloneDataCatalogResult.md | 11 - docs/apis/public/CloneDictionaryOptions.md | 14 - .../public/ClonePublicDataCatalogOptions.md | 15 - .../public/ClonePublicDictionaryOptions.md | 15 - docs/apis/public/CollectionListCoordinates.md | 10 - .../apis/public/CollectionMetadataSettings.md | 14 - docs/apis/public/CpsModelReference.md | 11 - docs/apis/public/CpsPackage.md | 14 - docs/apis/public/CpsTask.md | 12 - .../CreateCollectionInDictionaryOptions.md | 10 - .../CreateDataCatalogCollectionOptions.md | 10 - docs/apis/public/CreateDataCatalogOptions.md | 15 - .../public/CreateDataFlowTemplateOptions.md | 14 - docs/apis/public/CreateDictionaryOptions.md | 12 - .../public/CreateKnowledgeGraphOptions.md | 13 - .../public/CreateKnowledgeGraphOptions1.md | 13 - .../public/CreateProjectModelConfigOptions.md | 14 - docs/apis/public/DataCatalogCategorySchema.md | 11 - docs/apis/public/DataCatalogCollection.md | 11 - docs/apis/public/DataCatalogDataFlow.md | 11 - docs/apis/public/DataCatalogImportOptions.md | 11 - docs/apis/public/DataCatalogImportResult.md | 11 - docs/apis/public/DataCatalogProvenanceLog.md | 13 - .../public/DataCatalogProvenanceLogSource.md | 15 - .../public/DataCatalogProvenanceLogUser.md | 12 - docs/apis/public/DataCatalogSchema.md | 11 - docs/apis/public/DataCatalogTopology.md | 11 - docs/apis/public/DataCatalogTopologyEdge.md | 14 - docs/apis/public/DataCatalogTopologyNode.md | 11 - .../public/DataCatalogUrlImportOptions.md | 11 - docs/apis/public/DataCatalogsApi.md | 2273 -------------- docs/apis/public/DataCatalogue.md | 22 - docs/apis/public/DataCollection.md | 15 - docs/apis/public/DataCollectionMetadata.md | 17 - docs/apis/public/DataCollectionSource.md | 12 - docs/apis/public/DataFlow.md | 18 - .../DataFlowAssembleIntoKnowledgeGraphTask.md | 11 - docs/apis/public/DataFlowAssembleReport.md | 11 - .../public/DataFlowAssembleReportCause.md | 11 - .../public/DataFlowAssembleReportChunks.md | 14 - .../public/DataFlowAssembleReportErrors.md | 11 - .../public/DataFlowAssembleReportOptions.md | 11 - .../DataFlowAssembleReportSingleTask.md | 14 - .../DataFlowLoadIntoKnowledgeGraphTask.md | 12 - docs/apis/public/DataFlowTemplate.md | 11 - docs/apis/public/DataFlowTemplateListItem.md | 16 - docs/apis/public/DataFlowTemplateVariable.md | 9 - docs/apis/public/DataFlowTopologyOptions.md | 10 - docs/apis/public/DataFlowsApi.md | 1718 ----------- docs/apis/public/DataIndexUploadFileSource.md | 13 - .../apis/public/DataIndexUploadFileSource1.md | 11 - docs/apis/public/DataIndicesApi.md | 915 ------ docs/apis/public/DictionariesApi.md | 1730 ----------- docs/apis/public/Dictionary.md | 18 - docs/apis/public/DictionaryCloneResult.md | 11 - docs/apis/public/DictionaryCollection.md | 11 - .../public/DictionaryCollectionCsvData.md | 11 - docs/apis/public/DictionaryCollectionPatch.md | 12 - docs/apis/public/DictionaryEntry.md | 11 - docs/apis/public/DictionaryImportOptions.md | 11 - docs/apis/public/DictionaryImportResult.md | 11 - docs/apis/public/DocumentInspectionApi.md | 497 ---- docs/apis/public/ElasticApi.md | 401 --- docs/apis/public/ElasticCoordinates.md | 12 - .../public/ElasticIndexSearchQueryOptions.md | 15 - docs/apis/public/EntityAnnotation.md | 13 - .../apis/public/EntityAnnotationDescriptor.md | 12 - docs/apis/public/ErrorResponse.md | 11 - docs/apis/public/FlavoursQuota.md | 12 - docs/apis/public/FullyRenderedDataFlow.md | 11 - docs/apis/public/ImageCells.md | 10 - docs/apis/public/ImageInfo.md | 11 - docs/apis/public/ImageMetadata.md | 11 - docs/apis/public/ImageSource.md | 12 - .../ImportFromElasticToDataCatalogOptions.md | 12 - ...omElasticToDataCatalogOptionsParameters.md | 14 - ...ataCatalogOptionsParametersQueryOptions.md | 12 - .../ImportFromElasticToDataCatalogS3Coords.md | 18 - .../ImportToDataCatalogCollectionOptions.md | 12 - .../apis/public/ImportToDataCatalogOptions.md | 11 - .../InferProjectDataCatalogCategorySchema.md | 10 - docs/apis/public/IngestDocumentQARequest.md | 10 - docs/apis/public/InlineObject.md | 10 - docs/apis/public/InlineObject1.md | 15 - docs/apis/public/InlineObject2.md | 10 - docs/apis/public/InlineObject3.md | 10 - docs/apis/public/InlineObject4.md | 10 - docs/apis/public/InlineObject5.md | 11 - docs/apis/public/InlineResponse200.md | 10 - docs/apis/public/InlineResponse2001.md | 10 - docs/apis/public/InlineResponse2002.md | 13 - docs/apis/public/InlineResponse2003.md | 17 - docs/apis/public/InspectionReport.md | 14 - docs/apis/public/KgSnapshot.md | 15 - docs/apis/public/KgcDataInput.md | 11 - docs/apis/public/KibanaSavedQueriesResult.md | 13 - .../KnowledgeGraphAuthenticationCallback.md | 10 - .../KnowledgeGraphChartUpgradeOptions.md | 10 - ...owledgeGraphDeploymentRecreationOptions.md | 10 - .../public/KnowledgeGraphSnapshotOptions.md | 10 - .../public/KnowledgeGraphSystemInformation.md | 19 - docs/apis/public/KnowledgeGraphsApi.md | 2647 ----------------- docs/apis/public/LinkedCcsInstances.md | 11 - .../LoadDataFlowIntoKnowledgeGraphOptions.md | 12 - .../LoadDataFlowIntoKnowledgeGraphOptions1.md | 11 - docs/apis/public/LoadKgcDataInput.md | 11 - docs/apis/public/LoadKgcDataInputDataflow.md | 11 - docs/apis/public/LoadKgcDataInputTarget.md | 11 - docs/apis/public/ModelConfiguration.md | 18 - docs/apis/public/ModelConfigurationsApi.md | 644 ---- docs/apis/public/ModelPipelineSettings.md | 13 - .../ModelSupportedAnnotationsParameters.md | 12 - docs/apis/public/MongoCoordinates.md | 11 - docs/apis/public/MongoS3Coordinates.md | 11 - .../MongoS3CoordinatesWithCollectionList.md | 12 - docs/apis/public/OCRSettings.md | 13 - docs/apis/public/PatchDataCatalogOptions.md | 15 - docs/apis/public/PatchDictionaryOptions.md | 12 - .../apis/public/PatchKnowledgeGraphOptions.md | 12 - .../public/PatchKnowledgeGraphOptions1.md | 12 - docs/apis/public/Problem.md | 13 - docs/apis/public/ProcessingModel.md | 11 - docs/apis/public/ProcessingModelApi.md | 160 - docs/apis/public/ProcessingModelDataFlow.md | 11 - .../apis/public/ProcessingModelDescription.md | 12 - docs/apis/public/ProjectApi.md | 488 --- .../ProjectDataIndexConversionSettings.md | 16 - docs/apis/public/ProjectDataIndexNonView.md | 13 - .../public/ProjectDataIndexS3Coordinates.md | 19 - docs/apis/public/ProjectDataIndexSource.md | 11 - docs/apis/public/ProjectDataIndexView.md | 13 - docs/apis/public/ProjectDataIndexViewOf.md | 13 - .../apis/public/ProjectDataIndexWithStatus.md | 22 - .../ProjectDataIndexWithStatusViewOf.md | 13 - docs/apis/public/ProjectDefaultValues.md | 11 - .../public/ProjectDefaultValuesCcsProject.md | 12 - .../public/ProjectDefaultValuesDataflow.md | 11 - docs/apis/public/ProjectFlavourTotalKgs.md | 12 - docs/apis/public/ProjectFlavours.md | 11 - .../ProjectPackageInstalationManifest.md | 10 - ...ctProjKeyAnnotateDocumentReportDocument.md | 11 - ...jectProjKeyAnnotateDocumentReportReport.md | 11 - ...BagsBagKeyTasksAssembleDataflowDataFlow.md | 12 - ...ksAssembleDataflowDataFlowRenderOptions.md | 11 - ...ProjKeyBagsBagKeyTasksExportDatasetInfo.md | 14 - ...yBagsBagKeyTasksExportDatasetInfoCoords.md | 11 - ...ksExportDatasetInfoCoordsNodeCollection.md | 13 - ...agsBagKeyTasksExportDatasetInfoNodeList.md | 11 - ...ctProjKeyBagsBagKeyTasksSuspendSnapshot.md | 10 - ...llectionsCollectionNameActionsImportCcs.md | 14 - ...tionsImportCcsExportPackageMongoOptions.md | 13 - ...xportPackageMongoOptionsAssembleOptions.md | 11 - ...tPackageMongoOptionsAssembleOptionsMode.md | 11 - ...ckageMongoOptionsAssembleOptionsOptions.md | 10 - ...mportCcsExportPackageMongoOptionsInputs.md | 10 - ...ExportPackageMongoOptionsPackageOptions.md | 11 - ...ctProjKeyDataCataloguesFromMongoOptions.md | 10 - ...ectProjKeyDataCataloguesFromMongoTarget.md | 12 - ...jectProjKeyDataCataloguesFromUrlOptions.md | 10 - ...IndexKeyActionsCcsConvertUploadS3Source.md | 12 - ...ojectProjKeyDictionariesFromMongoTarget.md | 12 - ...DataflowTemplatesDebugDfTplKeyTargetBag.md | 11 - ...aflowTemplatesDfTplKeyActionsLoadRender.md | 11 - ...latesDfTplKeyActionsLoadRenderTargetBag.md | 11 - ...aflowTemplatesDfTplKeyActionsLoadTarget.md | 10 - ...ectProjKeyKgcDataflowTemplatesVariables.md | 11 - ...cRawDataflowTemplatesActionsRunDataFlow.md | 11 - ...flowTemplatesActionsRunDataFlowTemplate.md | 11 - ...rojectProjKeyModelConfigsConfigurations.md | 10 - .../public/ProjectProjKeyPackagesPackages.md | 11 - docs/apis/public/ProjectTask.md | 19 - docs/apis/public/ProjectsFlavours.md | 12 - docs/apis/public/ProjectsFlavoursFlavours.md | 11 - docs/apis/public/ProjectsFlavoursQuota.md | 12 - docs/apis/public/RelatedTask.md | 11 - .../public/RelationshipAnnotationColumn.md | 11 - .../RelationshipAnnotationDescriptor.md | 12 - .../public/RenderDataFlowTemplateOptions.md | 11 - .../RestoreKnowledgeGraphBackupOptions.md | 10 - .../public/ResumeKnowledgeGraphOptions.md | 11 - .../apis/public/RunDataFlowTemplateOptions.md | 11 - .../public/RunDataFlowTemplateOptions1.md | 12 - docs/apis/public/S3Coordinates.md | 19 - .../apis/public/S3CoordinatesWithBackupKey.md | 19 - .../S3CoordinatesWithBackupKeyPresigned.md | 11 - docs/apis/public/SemanticApi.md | 168 -- docs/apis/public/SemanticIngestReqParams.md | 10 - docs/apis/public/SemanticIngestRequest.md | 11 - docs/apis/public/StorageSummaryDC.md | 15 - docs/apis/public/StorageSummaryKG.md | 16 - .../StorageSummaryKGCategoriesFraction.md | 14 - docs/apis/public/StorageSummaryTask.md | 14 - .../public/SupportedAnnotatorAnnotations.md | 12 - .../public/SuspendKnowledgeGraphOptions.md | 11 - docs/apis/public/SystemApi.md | 1790 ----------- .../SystemCeleryTasksFailureFailures.md | 13 - docs/apis/public/SystemInfo.md | 13 - docs/apis/public/SystemInfoApi.md | 12 - docs/apis/public/SystemInfoDeployment.md | 14 - .../SystemInfoDeploymentLinkedCcsApi.md | 11 - docs/apis/public/SystemInfoToolkit.md | 14 - docs/apis/public/SystemKgsBackend.md | 11 - docs/apis/public/SystemKgsDeployment.md | 13 - .../public/SystemKgsDeploymentResources.md | 11 - .../apis/public/SystemModulesConfiguration.md | 12 - docs/apis/public/SystemModulesTasks.md | 10 - docs/apis/public/SystemModulesTasksTasks.md | 10 - docs/apis/public/TakeSnapshotSettings.md | 12 - .../TakeSnapshotSettingsBackendAware.md | 12 - docs/apis/public/Task.md | 16 - docs/apis/public/TasksApi.md | 563 ---- docs/apis/public/TemporaryUploadFileResult.md | 16 - .../TemporaryUploadFileResultDownload.md | 11 - ...emporaryUploadFileResultDownloadPrivate.md | 11 - .../TemporaryUploadFileResultMetadata.md | 11 - ...emporaryUploadFileResultMetadataPrivate.md | 11 - .../public/TemporaryUploadFileResultUpload.md | 12 - .../TemporaryUploadFileResultUploadPrivate.md | 12 - docs/apis/public/TokenResponse.md | 10 - docs/apis/public/Topology.md | 11 - docs/apis/public/TopologyEdge.md | 12 - docs/apis/public/TopologyNode.md | 10 - docs/apis/public/UpdateDataFlowOptions.md | 14 - .../public/UpdateProjectModelConfigOptions.md | 13 - docs/apis/public/UploadedFile.md | 14 - docs/apis/public/UploadedFileResult.md | 11 - docs/apis/public/UploadsApi.md | 336 --- docs/apis/public/UsageStats.md | 12 - .../public/WellKnownDfTemplateVariable.md | 12 - docs/apis/public_v2/CcsTask.md | 31 + docs/apis/public_v2/ConvertDocumentRequest.md | 30 + .../public_v2/ConvertDocumentsRequestBody.md | 8 +- .../apis/public_v2/ConvertDocumentsSources.md | 31 + .../ConvertUploadDocumentsRequestBody.md | 34 + docs/apis/public_v2/DataIndicesUploadApi.md | 268 +- docs/apis/public_v2/FileSource.md | 30 + docs/apis/public_v2/GenAIParams.md | 1 + docs/apis/public_v2/GenAIPartialParams.md | 1 + docs/apis/public_v2/HttpSource.md | 30 + docs/apis/public_v2/ProjectApi.md | 169 ++ .../public_v2/TargetConversionParameters.md | 31 + .../public_v2/UploadElasticRequestBody.md | 30 + docs/apis/user/AccessToken.md | 10 - docs/apis/user/AdminApi.md | 650 ---- docs/apis/user/ApiKey.md | 11 - docs/apis/user/AuditRecord.md | 16 - docs/apis/user/CreateProjectRequestBody.md | 11 - docs/apis/user/CreateProjectRequestBody1.md | 11 - docs/apis/user/CreateTokensRequestBody.md | 11 - docs/apis/user/ErrorResponse.md | 10 - docs/apis/user/GetAccessTokenRequestBody.md | 10 - .../user/ImpersonateUserTokenRequestBody.md | 11 - docs/apis/user/InlineResponse200.md | 10 - docs/apis/user/OidcApi.md | 253 -- docs/apis/user/OidcTokenResponse.md | 12 - docs/apis/user/Project.md | 13 - docs/apis/user/ProjectUserAssignment.md | 12 - docs/apis/user/ProjectsApi.md | 1065 ------- docs/apis/user/RegisterUserRequestBody.md | 11 - docs/apis/user/ServiceAccount.md | 12 - docs/apis/user/ServiceAccountCredentials.md | 11 - docs/apis/user/SettingsApi.md | 82 - docs/apis/user/SuccessMessage.md | 10 - docs/apis/user/TokenResponse.md | 10 - docs/apis/user/UserApi.md | 81 - docs/apis/user/UserDetails.md | 12 - docs/apis/user/UserType.md | 9 - docs/apis/user/UsersApi.md | 640 ---- poetry.lock | 1735 +++++++---- pyproject.toml | 19 +- .../generate-client.sh | 63 +- .../openapi-ds-v2.json | 2 +- .../swagger-cps-kg.json | 2 +- .../swagger-client-generator/swagger-cps.json | 2 +- .../swagger-user.json | 2 +- 346 files changed, 4424 insertions(+), 21801 deletions(-) create mode 100644 deepsearch/cps/apis/public_v2/models/ccs_task.py create mode 100644 deepsearch/cps/apis/public_v2/models/convert_document_request.py create mode 100644 deepsearch/cps/apis/public_v2/models/convert_documents_sources.py create mode 100644 deepsearch/cps/apis/public_v2/models/convert_upload_documents_request_body.py create mode 100644 deepsearch/cps/apis/public_v2/models/file_source.py create mode 100644 deepsearch/cps/apis/public_v2/models/http_source.py create mode 100644 deepsearch/cps/apis/public_v2/models/target_conversion_parameters.py create mode 100644 deepsearch/cps/apis/public_v2/models/upload_elastic_request_body.py delete mode 100644 docs/apis/public/AnnotateApi.md delete mode 100644 docs/apis/public/AnnotateDocumentRequest.md delete mode 100644 docs/apis/public/AnnotateObjectOptions.md delete mode 100644 docs/apis/public/AnnotateObjectOptions1.md delete mode 100644 docs/apis/public/AnnotatedDocumentReport.md delete mode 100644 docs/apis/public/AnnotatedImage.md delete mode 100644 docs/apis/public/AnnotatedObject.md delete mode 100644 docs/apis/public/AnnotatedObject1.md delete mode 100644 docs/apis/public/AnnotatedTable.md delete mode 100644 docs/apis/public/AnnotatedText.md delete mode 100644 docs/apis/public/AnnotatedTextLines.md delete mode 100644 docs/apis/public/AnnotatorImageInput.md delete mode 100644 docs/apis/public/AnnotatorInput.md delete mode 100644 docs/apis/public/AnnotatorMetadata.md delete mode 100644 docs/apis/public/AnnotatorParametersOrRef.md delete mode 100644 docs/apis/public/AnnotatorSupportedAnnotationsParameters.md delete mode 100644 docs/apis/public/AssembleDataFlowIntoKnowledgeGraphOptions.md delete mode 100644 docs/apis/public/AssembleDataFlowIntoKnowledgeGraphOptions1.md delete mode 100644 docs/apis/public/AssembleSettings.md delete mode 100644 docs/apis/public/AssembleSettingsMode.md delete mode 100644 docs/apis/public/AttachmentUploadData.md delete mode 100644 docs/apis/public/AttachmentUploadDataUploadData.md delete mode 100644 docs/apis/public/BackendFlavour.md delete mode 100644 docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md delete mode 100644 docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRawDataFlow.md delete mode 100644 docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender.md delete mode 100644 docs/apis/public/BackupKnowledgeGraphOptions.md delete mode 100644 docs/apis/public/Bag.md delete mode 100644 docs/apis/public/BagAmqpBackend.md delete mode 100644 docs/apis/public/BagBackendAware.md delete mode 100644 docs/apis/public/BagBackends.md delete mode 100644 docs/apis/public/BagCallback.md delete mode 100644 docs/apis/public/BagComponentStatus.md delete mode 100644 docs/apis/public/BagComponentStatusEnum.md delete mode 100644 docs/apis/public/BagFlavour.md delete mode 100644 docs/apis/public/BagFlavourDefaultQuota.md delete mode 100644 docs/apis/public/BagFlavourFullData.md delete mode 100644 docs/apis/public/BagKgLegacyApiBackend.md delete mode 100644 docs/apis/public/BagStatus.md delete mode 100644 docs/apis/public/BagStatusBackendAware.md delete mode 100644 docs/apis/public/BagStatusBackendAwareKgAmqp.md delete mode 100644 docs/apis/public/BagStatusComponents.md delete mode 100644 docs/apis/public/CatalogReference.md delete mode 100644 docs/apis/public/CcsCollectionReference.md delete mode 100644 docs/apis/public/CcsTask.md delete mode 100644 docs/apis/public/CeleryTask.md delete mode 100644 docs/apis/public/CeleryTask1.md delete mode 100644 docs/apis/public/CeleryTaskPromise.md delete mode 100644 docs/apis/public/CloneDataCatalogOptions.md delete mode 100644 docs/apis/public/CloneDataCatalogResult.md delete mode 100644 docs/apis/public/CloneDictionaryOptions.md delete mode 100644 docs/apis/public/ClonePublicDataCatalogOptions.md delete mode 100644 docs/apis/public/ClonePublicDictionaryOptions.md delete mode 100644 docs/apis/public/CollectionListCoordinates.md delete mode 100644 docs/apis/public/CollectionMetadataSettings.md delete mode 100644 docs/apis/public/CpsModelReference.md delete mode 100644 docs/apis/public/CpsPackage.md delete mode 100644 docs/apis/public/CpsTask.md delete mode 100644 docs/apis/public/CreateCollectionInDictionaryOptions.md delete mode 100644 docs/apis/public/CreateDataCatalogCollectionOptions.md delete mode 100644 docs/apis/public/CreateDataCatalogOptions.md delete mode 100644 docs/apis/public/CreateDataFlowTemplateOptions.md delete mode 100644 docs/apis/public/CreateDictionaryOptions.md delete mode 100644 docs/apis/public/CreateKnowledgeGraphOptions.md delete mode 100644 docs/apis/public/CreateKnowledgeGraphOptions1.md delete mode 100644 docs/apis/public/CreateProjectModelConfigOptions.md delete mode 100644 docs/apis/public/DataCatalogCategorySchema.md delete mode 100644 docs/apis/public/DataCatalogCollection.md delete mode 100644 docs/apis/public/DataCatalogDataFlow.md delete mode 100644 docs/apis/public/DataCatalogImportOptions.md delete mode 100644 docs/apis/public/DataCatalogImportResult.md delete mode 100644 docs/apis/public/DataCatalogProvenanceLog.md delete mode 100644 docs/apis/public/DataCatalogProvenanceLogSource.md delete mode 100644 docs/apis/public/DataCatalogProvenanceLogUser.md delete mode 100644 docs/apis/public/DataCatalogSchema.md delete mode 100644 docs/apis/public/DataCatalogTopology.md delete mode 100644 docs/apis/public/DataCatalogTopologyEdge.md delete mode 100644 docs/apis/public/DataCatalogTopologyNode.md delete mode 100644 docs/apis/public/DataCatalogUrlImportOptions.md delete mode 100644 docs/apis/public/DataCatalogsApi.md delete mode 100644 docs/apis/public/DataCatalogue.md delete mode 100644 docs/apis/public/DataCollection.md delete mode 100644 docs/apis/public/DataCollectionMetadata.md delete mode 100644 docs/apis/public/DataCollectionSource.md delete mode 100644 docs/apis/public/DataFlow.md delete mode 100644 docs/apis/public/DataFlowAssembleIntoKnowledgeGraphTask.md delete mode 100644 docs/apis/public/DataFlowAssembleReport.md delete mode 100644 docs/apis/public/DataFlowAssembleReportCause.md delete mode 100644 docs/apis/public/DataFlowAssembleReportChunks.md delete mode 100644 docs/apis/public/DataFlowAssembleReportErrors.md delete mode 100644 docs/apis/public/DataFlowAssembleReportOptions.md delete mode 100644 docs/apis/public/DataFlowAssembleReportSingleTask.md delete mode 100644 docs/apis/public/DataFlowLoadIntoKnowledgeGraphTask.md delete mode 100644 docs/apis/public/DataFlowTemplate.md delete mode 100644 docs/apis/public/DataFlowTemplateListItem.md delete mode 100644 docs/apis/public/DataFlowTemplateVariable.md delete mode 100644 docs/apis/public/DataFlowTopologyOptions.md delete mode 100644 docs/apis/public/DataFlowsApi.md delete mode 100644 docs/apis/public/DataIndexUploadFileSource.md delete mode 100644 docs/apis/public/DataIndexUploadFileSource1.md delete mode 100644 docs/apis/public/DataIndicesApi.md delete mode 100644 docs/apis/public/DictionariesApi.md delete mode 100644 docs/apis/public/Dictionary.md delete mode 100644 docs/apis/public/DictionaryCloneResult.md delete mode 100644 docs/apis/public/DictionaryCollection.md delete mode 100644 docs/apis/public/DictionaryCollectionCsvData.md delete mode 100644 docs/apis/public/DictionaryCollectionPatch.md delete mode 100644 docs/apis/public/DictionaryEntry.md delete mode 100644 docs/apis/public/DictionaryImportOptions.md delete mode 100644 docs/apis/public/DictionaryImportResult.md delete mode 100644 docs/apis/public/DocumentInspectionApi.md delete mode 100644 docs/apis/public/ElasticApi.md delete mode 100644 docs/apis/public/ElasticCoordinates.md delete mode 100644 docs/apis/public/ElasticIndexSearchQueryOptions.md delete mode 100644 docs/apis/public/EntityAnnotation.md delete mode 100644 docs/apis/public/EntityAnnotationDescriptor.md delete mode 100644 docs/apis/public/ErrorResponse.md delete mode 100644 docs/apis/public/FlavoursQuota.md delete mode 100644 docs/apis/public/FullyRenderedDataFlow.md delete mode 100644 docs/apis/public/ImageCells.md delete mode 100644 docs/apis/public/ImageInfo.md delete mode 100644 docs/apis/public/ImageMetadata.md delete mode 100644 docs/apis/public/ImageSource.md delete mode 100644 docs/apis/public/ImportFromElasticToDataCatalogOptions.md delete mode 100644 docs/apis/public/ImportFromElasticToDataCatalogOptionsParameters.md delete mode 100644 docs/apis/public/ImportFromElasticToDataCatalogOptionsParametersQueryOptions.md delete mode 100644 docs/apis/public/ImportFromElasticToDataCatalogS3Coords.md delete mode 100644 docs/apis/public/ImportToDataCatalogCollectionOptions.md delete mode 100644 docs/apis/public/ImportToDataCatalogOptions.md delete mode 100644 docs/apis/public/InferProjectDataCatalogCategorySchema.md delete mode 100644 docs/apis/public/IngestDocumentQARequest.md delete mode 100644 docs/apis/public/InlineObject.md delete mode 100644 docs/apis/public/InlineObject1.md delete mode 100644 docs/apis/public/InlineObject2.md delete mode 100644 docs/apis/public/InlineObject3.md delete mode 100644 docs/apis/public/InlineObject4.md delete mode 100644 docs/apis/public/InlineObject5.md delete mode 100644 docs/apis/public/InlineResponse200.md delete mode 100644 docs/apis/public/InlineResponse2001.md delete mode 100644 docs/apis/public/InlineResponse2002.md delete mode 100644 docs/apis/public/InlineResponse2003.md delete mode 100644 docs/apis/public/InspectionReport.md delete mode 100644 docs/apis/public/KgSnapshot.md delete mode 100644 docs/apis/public/KgcDataInput.md delete mode 100644 docs/apis/public/KibanaSavedQueriesResult.md delete mode 100644 docs/apis/public/KnowledgeGraphAuthenticationCallback.md delete mode 100644 docs/apis/public/KnowledgeGraphChartUpgradeOptions.md delete mode 100644 docs/apis/public/KnowledgeGraphDeploymentRecreationOptions.md delete mode 100644 docs/apis/public/KnowledgeGraphSnapshotOptions.md delete mode 100644 docs/apis/public/KnowledgeGraphSystemInformation.md delete mode 100644 docs/apis/public/KnowledgeGraphsApi.md delete mode 100644 docs/apis/public/LinkedCcsInstances.md delete mode 100644 docs/apis/public/LoadDataFlowIntoKnowledgeGraphOptions.md delete mode 100644 docs/apis/public/LoadDataFlowIntoKnowledgeGraphOptions1.md delete mode 100644 docs/apis/public/LoadKgcDataInput.md delete mode 100644 docs/apis/public/LoadKgcDataInputDataflow.md delete mode 100644 docs/apis/public/LoadKgcDataInputTarget.md delete mode 100644 docs/apis/public/ModelConfiguration.md delete mode 100644 docs/apis/public/ModelConfigurationsApi.md delete mode 100644 docs/apis/public/ModelPipelineSettings.md delete mode 100644 docs/apis/public/ModelSupportedAnnotationsParameters.md delete mode 100644 docs/apis/public/MongoCoordinates.md delete mode 100644 docs/apis/public/MongoS3Coordinates.md delete mode 100644 docs/apis/public/MongoS3CoordinatesWithCollectionList.md delete mode 100644 docs/apis/public/OCRSettings.md delete mode 100644 docs/apis/public/PatchDataCatalogOptions.md delete mode 100644 docs/apis/public/PatchDictionaryOptions.md delete mode 100644 docs/apis/public/PatchKnowledgeGraphOptions.md delete mode 100644 docs/apis/public/PatchKnowledgeGraphOptions1.md delete mode 100644 docs/apis/public/Problem.md delete mode 100644 docs/apis/public/ProcessingModel.md delete mode 100644 docs/apis/public/ProcessingModelApi.md delete mode 100644 docs/apis/public/ProcessingModelDataFlow.md delete mode 100644 docs/apis/public/ProcessingModelDescription.md delete mode 100644 docs/apis/public/ProjectApi.md delete mode 100644 docs/apis/public/ProjectDataIndexConversionSettings.md delete mode 100644 docs/apis/public/ProjectDataIndexNonView.md delete mode 100644 docs/apis/public/ProjectDataIndexS3Coordinates.md delete mode 100644 docs/apis/public/ProjectDataIndexSource.md delete mode 100644 docs/apis/public/ProjectDataIndexView.md delete mode 100644 docs/apis/public/ProjectDataIndexViewOf.md delete mode 100644 docs/apis/public/ProjectDataIndexWithStatus.md delete mode 100644 docs/apis/public/ProjectDataIndexWithStatusViewOf.md delete mode 100644 docs/apis/public/ProjectDefaultValues.md delete mode 100644 docs/apis/public/ProjectDefaultValuesCcsProject.md delete mode 100644 docs/apis/public/ProjectDefaultValuesDataflow.md delete mode 100644 docs/apis/public/ProjectFlavourTotalKgs.md delete mode 100644 docs/apis/public/ProjectFlavours.md delete mode 100644 docs/apis/public/ProjectPackageInstalationManifest.md delete mode 100644 docs/apis/public/ProjectProjKeyAnnotateDocumentReportDocument.md delete mode 100644 docs/apis/public/ProjectProjKeyAnnotateDocumentReportReport.md delete mode 100644 docs/apis/public/ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md delete mode 100644 docs/apis/public/ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRenderOptions.md delete mode 100644 docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfo.md delete mode 100644 docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoords.md delete mode 100644 docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoordsNodeCollection.md delete mode 100644 docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoNodeList.md delete mode 100644 docs/apis/public/ProjectProjKeyBagsBagKeyTasksSuspendSnapshot.md delete mode 100644 docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcs.md delete mode 100644 docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptions.md delete mode 100644 docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptions.md delete mode 100644 docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsMode.md delete mode 100644 docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsOptions.md delete mode 100644 docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsInputs.md delete mode 100644 docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsPackageOptions.md delete mode 100644 docs/apis/public/ProjectProjKeyDataCataloguesFromMongoOptions.md delete mode 100644 docs/apis/public/ProjectProjKeyDataCataloguesFromMongoTarget.md delete mode 100644 docs/apis/public/ProjectProjKeyDataCataloguesFromUrlOptions.md delete mode 100644 docs/apis/public/ProjectProjKeyDataIndicesIndexKeyActionsCcsConvertUploadS3Source.md delete mode 100644 docs/apis/public/ProjectProjKeyDictionariesFromMongoTarget.md delete mode 100644 docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDebugDfTplKeyTargetBag.md delete mode 100644 docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRender.md delete mode 100644 docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag.md delete mode 100644 docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadTarget.md delete mode 100644 docs/apis/public/ProjectProjKeyKgcDataflowTemplatesVariables.md delete mode 100644 docs/apis/public/ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlow.md delete mode 100644 docs/apis/public/ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlowTemplate.md delete mode 100644 docs/apis/public/ProjectProjKeyModelConfigsConfigurations.md delete mode 100644 docs/apis/public/ProjectProjKeyPackagesPackages.md delete mode 100644 docs/apis/public/ProjectTask.md delete mode 100644 docs/apis/public/ProjectsFlavours.md delete mode 100644 docs/apis/public/ProjectsFlavoursFlavours.md delete mode 100644 docs/apis/public/ProjectsFlavoursQuota.md delete mode 100644 docs/apis/public/RelatedTask.md delete mode 100644 docs/apis/public/RelationshipAnnotationColumn.md delete mode 100644 docs/apis/public/RelationshipAnnotationDescriptor.md delete mode 100644 docs/apis/public/RenderDataFlowTemplateOptions.md delete mode 100644 docs/apis/public/RestoreKnowledgeGraphBackupOptions.md delete mode 100644 docs/apis/public/ResumeKnowledgeGraphOptions.md delete mode 100644 docs/apis/public/RunDataFlowTemplateOptions.md delete mode 100644 docs/apis/public/RunDataFlowTemplateOptions1.md delete mode 100644 docs/apis/public/S3Coordinates.md delete mode 100644 docs/apis/public/S3CoordinatesWithBackupKey.md delete mode 100644 docs/apis/public/S3CoordinatesWithBackupKeyPresigned.md delete mode 100644 docs/apis/public/SemanticApi.md delete mode 100644 docs/apis/public/SemanticIngestReqParams.md delete mode 100644 docs/apis/public/SemanticIngestRequest.md delete mode 100644 docs/apis/public/StorageSummaryDC.md delete mode 100644 docs/apis/public/StorageSummaryKG.md delete mode 100644 docs/apis/public/StorageSummaryKGCategoriesFraction.md delete mode 100644 docs/apis/public/StorageSummaryTask.md delete mode 100644 docs/apis/public/SupportedAnnotatorAnnotations.md delete mode 100644 docs/apis/public/SuspendKnowledgeGraphOptions.md delete mode 100644 docs/apis/public/SystemApi.md delete mode 100644 docs/apis/public/SystemCeleryTasksFailureFailures.md delete mode 100644 docs/apis/public/SystemInfo.md delete mode 100644 docs/apis/public/SystemInfoApi.md delete mode 100644 docs/apis/public/SystemInfoDeployment.md delete mode 100644 docs/apis/public/SystemInfoDeploymentLinkedCcsApi.md delete mode 100644 docs/apis/public/SystemInfoToolkit.md delete mode 100644 docs/apis/public/SystemKgsBackend.md delete mode 100644 docs/apis/public/SystemKgsDeployment.md delete mode 100644 docs/apis/public/SystemKgsDeploymentResources.md delete mode 100644 docs/apis/public/SystemModulesConfiguration.md delete mode 100644 docs/apis/public/SystemModulesTasks.md delete mode 100644 docs/apis/public/SystemModulesTasksTasks.md delete mode 100644 docs/apis/public/TakeSnapshotSettings.md delete mode 100644 docs/apis/public/TakeSnapshotSettingsBackendAware.md delete mode 100644 docs/apis/public/Task.md delete mode 100644 docs/apis/public/TasksApi.md delete mode 100644 docs/apis/public/TemporaryUploadFileResult.md delete mode 100644 docs/apis/public/TemporaryUploadFileResultDownload.md delete mode 100644 docs/apis/public/TemporaryUploadFileResultDownloadPrivate.md delete mode 100644 docs/apis/public/TemporaryUploadFileResultMetadata.md delete mode 100644 docs/apis/public/TemporaryUploadFileResultMetadataPrivate.md delete mode 100644 docs/apis/public/TemporaryUploadFileResultUpload.md delete mode 100644 docs/apis/public/TemporaryUploadFileResultUploadPrivate.md delete mode 100644 docs/apis/public/TokenResponse.md delete mode 100644 docs/apis/public/Topology.md delete mode 100644 docs/apis/public/TopologyEdge.md delete mode 100644 docs/apis/public/TopologyNode.md delete mode 100644 docs/apis/public/UpdateDataFlowOptions.md delete mode 100644 docs/apis/public/UpdateProjectModelConfigOptions.md delete mode 100644 docs/apis/public/UploadedFile.md delete mode 100644 docs/apis/public/UploadedFileResult.md delete mode 100644 docs/apis/public/UploadsApi.md delete mode 100644 docs/apis/public/UsageStats.md delete mode 100644 docs/apis/public/WellKnownDfTemplateVariable.md create mode 100644 docs/apis/public_v2/CcsTask.md create mode 100644 docs/apis/public_v2/ConvertDocumentRequest.md create mode 100644 docs/apis/public_v2/ConvertDocumentsSources.md create mode 100644 docs/apis/public_v2/ConvertUploadDocumentsRequestBody.md create mode 100644 docs/apis/public_v2/FileSource.md create mode 100644 docs/apis/public_v2/HttpSource.md create mode 100644 docs/apis/public_v2/TargetConversionParameters.md create mode 100644 docs/apis/public_v2/UploadElasticRequestBody.md delete mode 100644 docs/apis/user/AccessToken.md delete mode 100644 docs/apis/user/AdminApi.md delete mode 100644 docs/apis/user/ApiKey.md delete mode 100644 docs/apis/user/AuditRecord.md delete mode 100644 docs/apis/user/CreateProjectRequestBody.md delete mode 100644 docs/apis/user/CreateProjectRequestBody1.md delete mode 100644 docs/apis/user/CreateTokensRequestBody.md delete mode 100644 docs/apis/user/ErrorResponse.md delete mode 100644 docs/apis/user/GetAccessTokenRequestBody.md delete mode 100644 docs/apis/user/ImpersonateUserTokenRequestBody.md delete mode 100644 docs/apis/user/InlineResponse200.md delete mode 100644 docs/apis/user/OidcApi.md delete mode 100644 docs/apis/user/OidcTokenResponse.md delete mode 100644 docs/apis/user/Project.md delete mode 100644 docs/apis/user/ProjectUserAssignment.md delete mode 100644 docs/apis/user/ProjectsApi.md delete mode 100644 docs/apis/user/RegisterUserRequestBody.md delete mode 100644 docs/apis/user/ServiceAccount.md delete mode 100644 docs/apis/user/ServiceAccountCredentials.md delete mode 100644 docs/apis/user/SettingsApi.md delete mode 100644 docs/apis/user/SuccessMessage.md delete mode 100644 docs/apis/user/TokenResponse.md delete mode 100644 docs/apis/user/UserApi.md delete mode 100644 docs/apis/user/UserDetails.md delete mode 100644 docs/apis/user/UserType.md delete mode 100644 docs/apis/user/UsersApi.md diff --git a/.github/actions/setup-poetry/action.yml b/.github/actions/setup-poetry/action.yml index ffc5d3c6..53c48b91 100644 --- a/.github/actions/setup-poetry/action.yml +++ b/.github/actions/setup-poetry/action.yml @@ -8,7 +8,7 @@ runs: using: 'composite' steps: - name: Install poetry - run: pipx install poetry==1.6.1 + run: pipx install poetry==1.8.3 shell: bash - uses: actions/setup-python@v4 with: diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 79ca2f06..0e7dcbdc 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -6,7 +6,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - python-version: ['3.8', '3.9', '3.10', '3.11'] + python-version: ['3.9', '3.10', '3.11', '3.12'] steps: - uses: actions/checkout@v3 - uses: ./.github/actions/setup-poetry diff --git a/.pylintrc b/.pylintrc index 2dd3f3cd..cbeeda81 100644 --- a/.pylintrc +++ b/.pylintrc @@ -52,7 +52,7 @@ persistent=yes # Minimum Python version to use for version dependent checks. Will default to # the version used to run pylint. -py-version=3.8 +py-version=3.9 # When enabled, pylint would attempt to guess common misconfiguration and emit # user-friendly hints instead of false-positive error messages. diff --git a/deepsearch/cps/apis/public_v2/__init__.py b/deepsearch/cps/apis/public_v2/__init__.py index bfd9a910..0347f6a8 100644 --- a/deepsearch/cps/apis/public_v2/__init__.py +++ b/deepsearch/cps/apis/public_v2/__init__.py @@ -50,9 +50,13 @@ from deepsearch.cps.apis.public_v2.models.ccs_project import CCSProject from deepsearch.cps.apis.public_v2.models.cps_package import CPSPackage from deepsearch.cps.apis.public_v2.models.cps_summary import CPSSummary +from deepsearch.cps.apis.public_v2.models.ccs_task import CcsTask from deepsearch.cps.apis.public_v2.models.collection_metadata_settings import CollectionMetadataSettings from deepsearch.cps.apis.public_v2.models.config import Config +from deepsearch.cps.apis.public_v2.models.convert_document_request import ConvertDocumentRequest from deepsearch.cps.apis.public_v2.models.convert_documents_request_body import ConvertDocumentsRequestBody +from deepsearch.cps.apis.public_v2.models.convert_documents_sources import ConvertDocumentsSources +from deepsearch.cps.apis.public_v2.models.convert_upload_documents_request_body import ConvertUploadDocumentsRequestBody from deepsearch.cps.apis.public_v2.models.cps_task import CpsTask from deepsearch.cps.apis.public_v2.models.data import Data from deepsearch.cps.apis.public_v2.models.data_flow import DataFlow @@ -70,6 +74,7 @@ from deepsearch.cps.apis.public_v2.models.elastic_index_source import ElasticIndexSource from deepsearch.cps.apis.public_v2.models.elastic_instance_data_index import ElasticInstanceDataIndex from deepsearch.cps.apis.public_v2.models.elastic_metadata import ElasticMetadata +from deepsearch.cps.apis.public_v2.models.file_source import FileSource from deepsearch.cps.apis.public_v2.models.flavour import Flavour from deepsearch.cps.apis.public_v2.models.flavours_default_quota import FlavoursDefaultQuota from deepsearch.cps.apis.public_v2.models.flavours_quota import FlavoursQuota @@ -85,6 +90,7 @@ from deepsearch.cps.apis.public_v2.models.gen_ai_watsonx_config import GenAIWatsonxConfig from deepsearch.cps.apis.public_v2.models.grouped_project_documents import GroupedProjectDocuments from deepsearch.cps.apis.public_v2.models.http_validation_error import HTTPValidationError +from deepsearch.cps.apis.public_v2.models.http_source import HttpSource from deepsearch.cps.apis.public_v2.models.internal_url import InternalUrl from deepsearch.cps.apis.public_v2.models.json_upload_request_body import JsonUploadRequestBody from deepsearch.cps.apis.public_v2.models.list_project_flavours import ListProjectFlavours @@ -128,6 +134,7 @@ from deepsearch.cps.apis.public_v2.models.source1 import Source1 from deepsearch.cps.apis.public_v2.models.storage_summary_task import StorageSummaryTask from deepsearch.cps.apis.public_v2.models.system_info import SystemInfo +from deepsearch.cps.apis.public_v2.models.target_conversion_parameters import TargetConversionParameters from deepsearch.cps.apis.public_v2.models.task_context import TaskContext from deepsearch.cps.apis.public_v2.models.task_result import TaskResult from deepsearch.cps.apis.public_v2.models.temporary_upload_file_result import TemporaryUploadFileResult @@ -135,6 +142,7 @@ from deepsearch.cps.apis.public_v2.models.temporary_url_fields import TemporaryUrlFields from deepsearch.cps.apis.public_v2.models.token_response import TokenResponse from deepsearch.cps.apis.public_v2.models.upload_date import UploadDate +from deepsearch.cps.apis.public_v2.models.upload_elastic_request_body import UploadElasticRequestBody from deepsearch.cps.apis.public_v2.models.upload_job import UploadJob from deepsearch.cps.apis.public_v2.models.urls import Urls from deepsearch.cps.apis.public_v2.models.validation_error import ValidationError diff --git a/deepsearch/cps/apis/public_v2/api/data_indices_upload_api.py b/deepsearch/cps/apis/public_v2/api/data_indices_upload_api.py index 1f9157dc..8b372161 100644 --- a/deepsearch/cps/apis/public_v2/api/data_indices_upload_api.py +++ b/deepsearch/cps/apis/public_v2/api/data_indices_upload_api.py @@ -20,9 +20,12 @@ from deepsearch.cps.apis.public_v2.models.attachment_upload_data import AttachmentUploadData from deepsearch.cps.apis.public_v2.models.attachment_upload_request_body import AttachmentUploadRequestBody from deepsearch.cps.apis.public_v2.models.convert_documents_request_body import ConvertDocumentsRequestBody +from deepsearch.cps.apis.public_v2.models.convert_documents_sources import ConvertDocumentsSources +from deepsearch.cps.apis.public_v2.models.convert_upload_documents_request_body import ConvertUploadDocumentsRequestBody from deepsearch.cps.apis.public_v2.models.cps_task import CpsTask from deepsearch.cps.apis.public_v2.models.data_index_upload_file_source import DataIndexUploadFileSource from deepsearch.cps.apis.public_v2.models.json_upload_request_body import JsonUploadRequestBody +from deepsearch.cps.apis.public_v2.models.upload_elastic_request_body import UploadElasticRequestBody from deepsearch.cps.apis.public_v2.api_client import ApiClient, RequestSerialized from deepsearch.cps.apis.public_v2.api_response import ApiResponse @@ -43,7 +46,7 @@ def __init__(self, api_client=None) -> None: @validate_call - def ccs_convert_upload_file_project_data_index( + def ccs_convert_file_project_data_index( self, index_key: StrictStr, proj_key: StrictStr, @@ -61,9 +64,9 @@ def ccs_convert_upload_file_project_data_index( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> CpsTask: - """Ccs Convert Upload File Project Data Index + """Ccs Convert File Project Data Index - Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + Convert files via CCS previously registered and in a project data index. :param index_key: (required) :type index_key: str @@ -93,7 +96,7 @@ def ccs_convert_upload_file_project_data_index( :return: Returns the result object. """ # noqa: E501 - _param = self._ccs_convert_upload_file_project_data_index_serialize( + _param = self._ccs_convert_file_project_data_index_serialize( index_key=index_key, proj_key=proj_key, convert_documents_request_body=convert_documents_request_body, @@ -119,7 +122,7 @@ def ccs_convert_upload_file_project_data_index( @validate_call - def ccs_convert_upload_file_project_data_index_with_http_info( + def ccs_convert_file_project_data_index_with_http_info( self, index_key: StrictStr, proj_key: StrictStr, @@ -137,9 +140,9 @@ def ccs_convert_upload_file_project_data_index_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[CpsTask]: - """Ccs Convert Upload File Project Data Index + """Ccs Convert File Project Data Index - Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + Convert files via CCS previously registered and in a project data index. :param index_key: (required) :type index_key: str @@ -169,7 +172,7 @@ def ccs_convert_upload_file_project_data_index_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._ccs_convert_upload_file_project_data_index_serialize( + _param = self._ccs_convert_file_project_data_index_serialize( index_key=index_key, proj_key=proj_key, convert_documents_request_body=convert_documents_request_body, @@ -195,7 +198,7 @@ def ccs_convert_upload_file_project_data_index_with_http_info( @validate_call - def ccs_convert_upload_file_project_data_index_without_preload_content( + def ccs_convert_file_project_data_index_without_preload_content( self, index_key: StrictStr, proj_key: StrictStr, @@ -213,9 +216,9 @@ def ccs_convert_upload_file_project_data_index_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Ccs Convert Upload File Project Data Index + """Ccs Convert File Project Data Index - Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + Convert files via CCS previously registered and in a project data index. :param index_key: (required) :type index_key: str @@ -245,7 +248,7 @@ def ccs_convert_upload_file_project_data_index_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._ccs_convert_upload_file_project_data_index_serialize( + _param = self._ccs_convert_file_project_data_index_serialize( index_key=index_key, proj_key=proj_key, convert_documents_request_body=convert_documents_request_body, @@ -266,7 +269,7 @@ def ccs_convert_upload_file_project_data_index_without_preload_content( return response_data.response - def _ccs_convert_upload_file_project_data_index_serialize( + def _ccs_convert_file_project_data_index_serialize( self, index_key, proj_key, @@ -330,7 +333,7 @@ def _ccs_convert_upload_file_project_data_index_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload', + resource_path='/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -347,12 +350,11 @@ def _ccs_convert_upload_file_project_data_index_serialize( @validate_call - def get_attachment_upload_data( + def ccs_convert_upload_file_project_data_index( self, index_key: StrictStr, - index_item_id: StrictStr, - filename: StrictStr, proj_key: StrictStr, + convert_upload_documents_request_body: ConvertUploadDocumentsRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -365,19 +367,931 @@ def get_attachment_upload_data( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> AttachmentUploadData: - """Get Attachment Upload Data + ) -> CpsTask: + """Ccs Convert Upload File Project Data Index - Get url and path to upload an attachment to a project data index. + Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + + :param index_key: (required) + :type index_key: str + :param proj_key: (required) + :type proj_key: str + :param convert_upload_documents_request_body: (required) + :type convert_upload_documents_request_body: ConvertUploadDocumentsRequestBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ccs_convert_upload_file_project_data_index_serialize( + index_key=index_key, + proj_key=proj_key, + convert_upload_documents_request_body=convert_upload_documents_request_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CpsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ccs_convert_upload_file_project_data_index_with_http_info( + self, + index_key: StrictStr, + proj_key: StrictStr, + convert_upload_documents_request_body: ConvertUploadDocumentsRequestBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CpsTask]: + """Ccs Convert Upload File Project Data Index + + Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + + :param index_key: (required) + :type index_key: str + :param proj_key: (required) + :type proj_key: str + :param convert_upload_documents_request_body: (required) + :type convert_upload_documents_request_body: ConvertUploadDocumentsRequestBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ccs_convert_upload_file_project_data_index_serialize( + index_key=index_key, + proj_key=proj_key, + convert_upload_documents_request_body=convert_upload_documents_request_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CpsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ccs_convert_upload_file_project_data_index_without_preload_content( + self, + index_key: StrictStr, + proj_key: StrictStr, + convert_upload_documents_request_body: ConvertUploadDocumentsRequestBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Ccs Convert Upload File Project Data Index + + Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + + :param index_key: (required) + :type index_key: str + :param proj_key: (required) + :type proj_key: str + :param convert_upload_documents_request_body: (required) + :type convert_upload_documents_request_body: ConvertUploadDocumentsRequestBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ccs_convert_upload_file_project_data_index_serialize( + index_key=index_key, + proj_key=proj_key, + convert_upload_documents_request_body=convert_upload_documents_request_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CpsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ccs_convert_upload_file_project_data_index_serialize( + self, + index_key, + proj_key, + convert_upload_documents_request_body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if index_key is not None: + _path_params['index_key'] = index_key + if proj_key is not None: + _path_params['proj_key'] = proj_key + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if convert_upload_documents_request_body is not None: + _body_params = convert_upload_documents_request_body + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_attachment_upload_data( + self, + index_key: StrictStr, + index_item_id: StrictStr, + filename: StrictStr, + proj_key: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AttachmentUploadData: + """Get Attachment Upload Data + + Get url and path to upload an attachment to a project data index. + + :param index_key: (required) + :type index_key: str + :param index_item_id: (required) + :type index_item_id: str + :param filename: (required) + :type filename: str + :param proj_key: (required) + :type proj_key: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_attachment_upload_data_serialize( + index_key=index_key, + index_item_id=index_item_id, + filename=filename, + proj_key=proj_key, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AttachmentUploadData", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_attachment_upload_data_with_http_info( + self, + index_key: StrictStr, + index_item_id: StrictStr, + filename: StrictStr, + proj_key: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AttachmentUploadData]: + """Get Attachment Upload Data + + Get url and path to upload an attachment to a project data index. + + :param index_key: (required) + :type index_key: str + :param index_item_id: (required) + :type index_item_id: str + :param filename: (required) + :type filename: str + :param proj_key: (required) + :type proj_key: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_attachment_upload_data_serialize( + index_key=index_key, + index_item_id=index_item_id, + filename=filename, + proj_key=proj_key, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AttachmentUploadData", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_attachment_upload_data_without_preload_content( + self, + index_key: StrictStr, + index_item_id: StrictStr, + filename: StrictStr, + proj_key: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Attachment Upload Data + + Get url and path to upload an attachment to a project data index. + + :param index_key: (required) + :type index_key: str + :param index_item_id: (required) + :type index_item_id: str + :param filename: (required) + :type filename: str + :param proj_key: (required) + :type proj_key: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_attachment_upload_data_serialize( + index_key=index_key, + index_item_id=index_item_id, + filename=filename, + proj_key=proj_key, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AttachmentUploadData", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_attachment_upload_data_serialize( + self, + index_key, + index_item_id, + filename, + proj_key, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if index_key is not None: + _path_params['index_key'] = index_key + if index_item_id is not None: + _path_params['index_item_id'] = index_item_id + if filename is not None: + _path_params['filename'] = filename + if proj_key is not None: + _path_params['proj_key'] = proj_key + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def html_print_convert_upload( + self, + index_key: StrictStr, + proj_key: StrictStr, + data_index_upload_file_source: DataIndexUploadFileSource, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CpsTask: + """Html Print Convert Upload + + Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + + :param index_key: (required) + :type index_key: str + :param proj_key: (required) + :type proj_key: str + :param data_index_upload_file_source: (required) + :type data_index_upload_file_source: DataIndexUploadFileSource + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._html_print_convert_upload_serialize( + index_key=index_key, + proj_key=proj_key, + data_index_upload_file_source=data_index_upload_file_source, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CpsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def html_print_convert_upload_with_http_info( + self, + index_key: StrictStr, + proj_key: StrictStr, + data_index_upload_file_source: DataIndexUploadFileSource, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CpsTask]: + """Html Print Convert Upload + + Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + + :param index_key: (required) + :type index_key: str + :param proj_key: (required) + :type proj_key: str + :param data_index_upload_file_source: (required) + :type data_index_upload_file_source: DataIndexUploadFileSource + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._html_print_convert_upload_serialize( + index_key=index_key, + proj_key=proj_key, + data_index_upload_file_source=data_index_upload_file_source, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CpsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def html_print_convert_upload_without_preload_content( + self, + index_key: StrictStr, + proj_key: StrictStr, + data_index_upload_file_source: DataIndexUploadFileSource, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Html Print Convert Upload + + Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + + :param index_key: (required) + :type index_key: str + :param proj_key: (required) + :type proj_key: str + :param data_index_upload_file_source: (required) + :type data_index_upload_file_source: DataIndexUploadFileSource + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._html_print_convert_upload_serialize( + index_key=index_key, + proj_key=proj_key, + data_index_upload_file_source=data_index_upload_file_source, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CpsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _html_print_convert_upload_serialize( + self, + index_key, + proj_key, + data_index_upload_file_source, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if index_key is not None: + _path_params['index_key'] = index_key + if proj_key is not None: + _path_params['proj_key'] = proj_key + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if data_index_upload_file_source is not None: + _body_params = data_index_upload_file_source + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def load_project_data_index_files_elastic( + self, + index_key: StrictStr, + proj_key: StrictStr, + upload_elastic_request_body: UploadElasticRequestBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CpsTask: + """Load Project Data Index Files Elastic + + Load file(s) in a project data index to elastic. :param index_key: (required) :type index_key: str - :param index_item_id: (required) - :type index_item_id: str - :param filename: (required) - :type filename: str :param proj_key: (required) :type proj_key: str + :param upload_elastic_request_body: (required) + :type upload_elastic_request_body: UploadElasticRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -400,11 +1314,10 @@ def get_attachment_upload_data( :return: Returns the result object. """ # noqa: E501 - _param = self._get_attachment_upload_data_serialize( + _param = self._load_project_data_index_files_elastic_serialize( index_key=index_key, - index_item_id=index_item_id, - filename=filename, proj_key=proj_key, + upload_elastic_request_body=upload_elastic_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -412,7 +1325,7 @@ def get_attachment_upload_data( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "AttachmentUploadData", + '200': "CpsTask", '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -427,12 +1340,11 @@ def get_attachment_upload_data( @validate_call - def get_attachment_upload_data_with_http_info( + def load_project_data_index_files_elastic_with_http_info( self, index_key: StrictStr, - index_item_id: StrictStr, - filename: StrictStr, proj_key: StrictStr, + upload_elastic_request_body: UploadElasticRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -445,19 +1357,17 @@ def get_attachment_upload_data_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[AttachmentUploadData]: - """Get Attachment Upload Data + ) -> ApiResponse[CpsTask]: + """Load Project Data Index Files Elastic - Get url and path to upload an attachment to a project data index. + Load file(s) in a project data index to elastic. :param index_key: (required) :type index_key: str - :param index_item_id: (required) - :type index_item_id: str - :param filename: (required) - :type filename: str :param proj_key: (required) :type proj_key: str + :param upload_elastic_request_body: (required) + :type upload_elastic_request_body: UploadElasticRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -480,11 +1390,10 @@ def get_attachment_upload_data_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._get_attachment_upload_data_serialize( + _param = self._load_project_data_index_files_elastic_serialize( index_key=index_key, - index_item_id=index_item_id, - filename=filename, proj_key=proj_key, + upload_elastic_request_body=upload_elastic_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -492,7 +1401,7 @@ def get_attachment_upload_data_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "AttachmentUploadData", + '200': "CpsTask", '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -507,12 +1416,11 @@ def get_attachment_upload_data_with_http_info( @validate_call - def get_attachment_upload_data_without_preload_content( + def load_project_data_index_files_elastic_without_preload_content( self, index_key: StrictStr, - index_item_id: StrictStr, - filename: StrictStr, proj_key: StrictStr, + upload_elastic_request_body: UploadElasticRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -526,18 +1434,16 @@ def get_attachment_upload_data_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Get Attachment Upload Data + """Load Project Data Index Files Elastic - Get url and path to upload an attachment to a project data index. + Load file(s) in a project data index to elastic. :param index_key: (required) :type index_key: str - :param index_item_id: (required) - :type index_item_id: str - :param filename: (required) - :type filename: str :param proj_key: (required) :type proj_key: str + :param upload_elastic_request_body: (required) + :type upload_elastic_request_body: UploadElasticRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -560,11 +1466,10 @@ def get_attachment_upload_data_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._get_attachment_upload_data_serialize( + _param = self._load_project_data_index_files_elastic_serialize( index_key=index_key, - index_item_id=index_item_id, - filename=filename, proj_key=proj_key, + upload_elastic_request_body=upload_elastic_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -572,7 +1477,7 @@ def get_attachment_upload_data_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "AttachmentUploadData", + '200': "CpsTask", '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -582,12 +1487,11 @@ def get_attachment_upload_data_without_preload_content( return response_data.response - def _get_attachment_upload_data_serialize( + def _load_project_data_index_files_elastic_serialize( self, index_key, - index_item_id, - filename, proj_key, + upload_elastic_request_body, _request_auth, _content_type, _headers, @@ -609,16 +1513,14 @@ def _get_attachment_upload_data_serialize( # process the path parameters if index_key is not None: _path_params['index_key'] = index_key - if index_item_id is not None: - _path_params['index_item_id'] = index_item_id - if filename is not None: - _path_params['filename'] = filename if proj_key is not None: _path_params['proj_key'] = proj_key # process the query parameters # process the header parameters # process the form parameters # process the body parameter + if upload_elastic_request_body is not None: + _body_params = upload_elastic_request_body # set the HTTP header `Accept` @@ -628,6 +1530,19 @@ def _get_attachment_upload_data_serialize( ] ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -635,8 +1550,8 @@ def _get_attachment_upload_data_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename}', + method='POST', + resource_path='/project/{proj_key}/data_indices/{index_key}/actions/load_elastic', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -653,11 +1568,12 @@ def _get_attachment_upload_data_serialize( @validate_call - def html_print_convert_upload( + def register_attachment( self, index_key: StrictStr, + index_item_id: StrictStr, proj_key: StrictStr, - data_index_upload_file_source: DataIndexUploadFileSource, + attachment_upload_request_body: AttachmentUploadRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -670,17 +1586,19 @@ def html_print_convert_upload( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> CpsTask: - """Html Print Convert Upload + ) -> None: + """Register Attachment - Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + Notify upload completion of an attachment to a project data index. :param index_key: (required) :type index_key: str + :param index_item_id: (required) + :type index_item_id: str :param proj_key: (required) :type proj_key: str - :param data_index_upload_file_source: (required) - :type data_index_upload_file_source: DataIndexUploadFileSource + :param attachment_upload_request_body: (required) + :type attachment_upload_request_body: AttachmentUploadRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -703,10 +1621,11 @@ def html_print_convert_upload( :return: Returns the result object. """ # noqa: E501 - _param = self._html_print_convert_upload_serialize( + _param = self._register_attachment_serialize( index_key=index_key, + index_item_id=index_item_id, proj_key=proj_key, - data_index_upload_file_source=data_index_upload_file_source, + attachment_upload_request_body=attachment_upload_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -714,7 +1633,7 @@ def html_print_convert_upload( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "CpsTask", + '204': None, '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -729,11 +1648,12 @@ def html_print_convert_upload( @validate_call - def html_print_convert_upload_with_http_info( + def register_attachment_with_http_info( self, index_key: StrictStr, + index_item_id: StrictStr, proj_key: StrictStr, - data_index_upload_file_source: DataIndexUploadFileSource, + attachment_upload_request_body: AttachmentUploadRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -746,17 +1666,19 @@ def html_print_convert_upload_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[CpsTask]: - """Html Print Convert Upload + ) -> ApiResponse[None]: + """Register Attachment - Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + Notify upload completion of an attachment to a project data index. :param index_key: (required) :type index_key: str + :param index_item_id: (required) + :type index_item_id: str :param proj_key: (required) :type proj_key: str - :param data_index_upload_file_source: (required) - :type data_index_upload_file_source: DataIndexUploadFileSource + :param attachment_upload_request_body: (required) + :type attachment_upload_request_body: AttachmentUploadRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -779,10 +1701,11 @@ def html_print_convert_upload_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._html_print_convert_upload_serialize( + _param = self._register_attachment_serialize( index_key=index_key, + index_item_id=index_item_id, proj_key=proj_key, - data_index_upload_file_source=data_index_upload_file_source, + attachment_upload_request_body=attachment_upload_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -790,7 +1713,7 @@ def html_print_convert_upload_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "CpsTask", + '204': None, '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -805,11 +1728,12 @@ def html_print_convert_upload_with_http_info( @validate_call - def html_print_convert_upload_without_preload_content( + def register_attachment_without_preload_content( self, index_key: StrictStr, + index_item_id: StrictStr, proj_key: StrictStr, - data_index_upload_file_source: DataIndexUploadFileSource, + attachment_upload_request_body: AttachmentUploadRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -823,16 +1747,18 @@ def html_print_convert_upload_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Html Print Convert Upload + """Register Attachment - Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + Notify upload completion of an attachment to a project data index. :param index_key: (required) :type index_key: str + :param index_item_id: (required) + :type index_item_id: str :param proj_key: (required) :type proj_key: str - :param data_index_upload_file_source: (required) - :type data_index_upload_file_source: DataIndexUploadFileSource + :param attachment_upload_request_body: (required) + :type attachment_upload_request_body: AttachmentUploadRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -855,10 +1781,11 @@ def html_print_convert_upload_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._html_print_convert_upload_serialize( + _param = self._register_attachment_serialize( index_key=index_key, + index_item_id=index_item_id, proj_key=proj_key, - data_index_upload_file_source=data_index_upload_file_source, + attachment_upload_request_body=attachment_upload_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -866,7 +1793,7 @@ def html_print_convert_upload_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "CpsTask", + '204': None, '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -876,11 +1803,12 @@ def html_print_convert_upload_without_preload_content( return response_data.response - def _html_print_convert_upload_serialize( + def _register_attachment_serialize( self, index_key, + index_item_id, proj_key, - data_index_upload_file_source, + attachment_upload_request_body, _request_auth, _content_type, _headers, @@ -902,14 +1830,16 @@ def _html_print_convert_upload_serialize( # process the path parameters if index_key is not None: _path_params['index_key'] = index_key + if index_item_id is not None: + _path_params['index_item_id'] = index_item_id if proj_key is not None: _path_params['proj_key'] = proj_key # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if data_index_upload_file_source is not None: - _body_params = data_index_upload_file_source + if attachment_upload_request_body is not None: + _body_params = attachment_upload_request_body # set the HTTP header `Accept` @@ -940,7 +1870,7 @@ def _html_print_convert_upload_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload', + resource_path='/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -957,12 +1887,11 @@ def _html_print_convert_upload_serialize( @validate_call - def register_attachment( + def upload_project_data_index_file( self, index_key: StrictStr, - index_item_id: StrictStr, proj_key: StrictStr, - attachment_upload_request_body: AttachmentUploadRequestBody, + json_upload_request_body: JsonUploadRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -975,19 +1904,17 @@ def register_attachment( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> None: - """Register Attachment + ) -> CpsTask: + """Upload Project Data Index File - Notify upload completion of an attachment to a project data index. + Upload a file to a project data index. :param index_key: (required) :type index_key: str - :param index_item_id: (required) - :type index_item_id: str :param proj_key: (required) :type proj_key: str - :param attachment_upload_request_body: (required) - :type attachment_upload_request_body: AttachmentUploadRequestBody + :param json_upload_request_body: (required) + :type json_upload_request_body: JsonUploadRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1010,11 +1937,10 @@ def register_attachment( :return: Returns the result object. """ # noqa: E501 - _param = self._register_attachment_serialize( + _param = self._upload_project_data_index_file_serialize( index_key=index_key, - index_item_id=index_item_id, proj_key=proj_key, - attachment_upload_request_body=attachment_upload_request_body, + json_upload_request_body=json_upload_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1022,7 +1948,7 @@ def register_attachment( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "CpsTask", '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -1037,12 +1963,11 @@ def register_attachment( @validate_call - def register_attachment_with_http_info( + def upload_project_data_index_file_with_http_info( self, index_key: StrictStr, - index_item_id: StrictStr, proj_key: StrictStr, - attachment_upload_request_body: AttachmentUploadRequestBody, + json_upload_request_body: JsonUploadRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1055,19 +1980,17 @@ def register_attachment_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[None]: - """Register Attachment + ) -> ApiResponse[CpsTask]: + """Upload Project Data Index File - Notify upload completion of an attachment to a project data index. + Upload a file to a project data index. :param index_key: (required) :type index_key: str - :param index_item_id: (required) - :type index_item_id: str :param proj_key: (required) :type proj_key: str - :param attachment_upload_request_body: (required) - :type attachment_upload_request_body: AttachmentUploadRequestBody + :param json_upload_request_body: (required) + :type json_upload_request_body: JsonUploadRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1090,11 +2013,10 @@ def register_attachment_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._register_attachment_serialize( + _param = self._upload_project_data_index_file_serialize( index_key=index_key, - index_item_id=index_item_id, proj_key=proj_key, - attachment_upload_request_body=attachment_upload_request_body, + json_upload_request_body=json_upload_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1102,7 +2024,7 @@ def register_attachment_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "CpsTask", '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -1117,12 +2039,11 @@ def register_attachment_with_http_info( @validate_call - def register_attachment_without_preload_content( + def upload_project_data_index_file_without_preload_content( self, index_key: StrictStr, - index_item_id: StrictStr, proj_key: StrictStr, - attachment_upload_request_body: AttachmentUploadRequestBody, + json_upload_request_body: JsonUploadRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1136,18 +2057,16 @@ def register_attachment_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Register Attachment + """Upload Project Data Index File - Notify upload completion of an attachment to a project data index. + Upload a file to a project data index. :param index_key: (required) :type index_key: str - :param index_item_id: (required) - :type index_item_id: str :param proj_key: (required) :type proj_key: str - :param attachment_upload_request_body: (required) - :type attachment_upload_request_body: AttachmentUploadRequestBody + :param json_upload_request_body: (required) + :type json_upload_request_body: JsonUploadRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1170,11 +2089,10 @@ def register_attachment_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._register_attachment_serialize( + _param = self._upload_project_data_index_file_serialize( index_key=index_key, - index_item_id=index_item_id, proj_key=proj_key, - attachment_upload_request_body=attachment_upload_request_body, + json_upload_request_body=json_upload_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1182,7 +2100,7 @@ def register_attachment_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "CpsTask", '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -1192,12 +2110,11 @@ def register_attachment_without_preload_content( return response_data.response - def _register_attachment_serialize( + def _upload_project_data_index_file_serialize( self, index_key, - index_item_id, proj_key, - attachment_upload_request_body, + json_upload_request_body, _request_auth, _content_type, _headers, @@ -1219,16 +2136,14 @@ def _register_attachment_serialize( # process the path parameters if index_key is not None: _path_params['index_key'] = index_key - if index_item_id is not None: - _path_params['index_item_id'] = index_item_id if proj_key is not None: _path_params['proj_key'] = proj_key # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if attachment_upload_request_body is not None: - _body_params = attachment_upload_request_body + if json_upload_request_body is not None: + _body_params = json_upload_request_body # set the HTTP header `Accept` @@ -1259,7 +2174,7 @@ def _register_attachment_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment', + resource_path='/project/{proj_key}/data_indices/{index_key}/actions/upload', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1276,11 +2191,11 @@ def _register_attachment_serialize( @validate_call - def upload_project_data_index_file( + def upload_register_project_documents( self, index_key: StrictStr, proj_key: StrictStr, - json_upload_request_body: JsonUploadRequestBody, + convert_documents_sources: ConvertDocumentsSources, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1294,16 +2209,16 @@ def upload_project_data_index_file( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> CpsTask: - """Upload Project Data Index File + """Upload Register Project Documents - Upload a file to a project data index. + Upload and register documents to be converted later. :param index_key: (required) :type index_key: str :param proj_key: (required) :type proj_key: str - :param json_upload_request_body: (required) - :type json_upload_request_body: JsonUploadRequestBody + :param convert_documents_sources: (required) + :type convert_documents_sources: ConvertDocumentsSources :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1326,10 +2241,10 @@ def upload_project_data_index_file( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_project_data_index_file_serialize( + _param = self._upload_register_project_documents_serialize( index_key=index_key, proj_key=proj_key, - json_upload_request_body=json_upload_request_body, + convert_documents_sources=convert_documents_sources, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1352,11 +2267,11 @@ def upload_project_data_index_file( @validate_call - def upload_project_data_index_file_with_http_info( + def upload_register_project_documents_with_http_info( self, index_key: StrictStr, proj_key: StrictStr, - json_upload_request_body: JsonUploadRequestBody, + convert_documents_sources: ConvertDocumentsSources, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1370,16 +2285,16 @@ def upload_project_data_index_file_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[CpsTask]: - """Upload Project Data Index File + """Upload Register Project Documents - Upload a file to a project data index. + Upload and register documents to be converted later. :param index_key: (required) :type index_key: str :param proj_key: (required) :type proj_key: str - :param json_upload_request_body: (required) - :type json_upload_request_body: JsonUploadRequestBody + :param convert_documents_sources: (required) + :type convert_documents_sources: ConvertDocumentsSources :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1402,10 +2317,10 @@ def upload_project_data_index_file_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_project_data_index_file_serialize( + _param = self._upload_register_project_documents_serialize( index_key=index_key, proj_key=proj_key, - json_upload_request_body=json_upload_request_body, + convert_documents_sources=convert_documents_sources, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1428,11 +2343,11 @@ def upload_project_data_index_file_with_http_info( @validate_call - def upload_project_data_index_file_without_preload_content( + def upload_register_project_documents_without_preload_content( self, index_key: StrictStr, proj_key: StrictStr, - json_upload_request_body: JsonUploadRequestBody, + convert_documents_sources: ConvertDocumentsSources, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1446,16 +2361,16 @@ def upload_project_data_index_file_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Upload Project Data Index File + """Upload Register Project Documents - Upload a file to a project data index. + Upload and register documents to be converted later. :param index_key: (required) :type index_key: str :param proj_key: (required) :type proj_key: str - :param json_upload_request_body: (required) - :type json_upload_request_body: JsonUploadRequestBody + :param convert_documents_sources: (required) + :type convert_documents_sources: ConvertDocumentsSources :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1478,10 +2393,10 @@ def upload_project_data_index_file_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_project_data_index_file_serialize( + _param = self._upload_register_project_documents_serialize( index_key=index_key, proj_key=proj_key, - json_upload_request_body=json_upload_request_body, + convert_documents_sources=convert_documents_sources, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1499,11 +2414,11 @@ def upload_project_data_index_file_without_preload_content( return response_data.response - def _upload_project_data_index_file_serialize( + def _upload_register_project_documents_serialize( self, index_key, proj_key, - json_upload_request_body, + convert_documents_sources, _request_auth, _content_type, _headers, @@ -1531,8 +2446,8 @@ def _upload_project_data_index_file_serialize( # process the header parameters # process the form parameters # process the body parameter - if json_upload_request_body is not None: - _body_params = json_upload_request_body + if convert_documents_sources is not None: + _body_params = convert_documents_sources # set the HTTP header `Accept` @@ -1563,7 +2478,7 @@ def _upload_project_data_index_file_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/project/{proj_key}/data_indices/{index_key}/actions/upload', + resource_path='/project/{proj_key}/data_indices/{index_key}/actions/upload_register_documents', path_params=_path_params, query_params=_query_params, header_params=_header_params, diff --git a/deepsearch/cps/apis/public_v2/api/project_api.py b/deepsearch/cps/apis/public_v2/api/project_api.py index 587a1c30..90905223 100644 --- a/deepsearch/cps/apis/public_v2/api/project_api.py +++ b/deepsearch/cps/apis/public_v2/api/project_api.py @@ -16,13 +16,17 @@ from typing import Any, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated -from pydantic import StrictBool, StrictStr -from typing import Optional +from pydantic import Field, StrictBool, StrictStr +from typing import Optional, Union +from typing_extensions import Annotated +from deepsearch.cps.apis.public_v2.models.ccs_task import CcsTask from deepsearch.cps.apis.public_v2.models.config import Config +from deepsearch.cps.apis.public_v2.models.convert_document_request import ConvertDocumentRequest from deepsearch.cps.apis.public_v2.models.default_values import DefaultValues from deepsearch.cps.apis.public_v2.models.project_package_instalation_manifest import ProjectPackageInstalationManifest from deepsearch.cps.apis.public_v2.models.response_get_project_integration_config_genai import ResponseGetProjectIntegrationConfigGenai from deepsearch.cps.apis.public_v2.models.task_context import TaskContext +from deepsearch.cps.apis.public_v2.models.task_result import TaskResult from deepsearch.cps.apis.public_v2.api_client import ApiClient, RequestSerialized from deepsearch.cps.apis.public_v2.api_response import ApiResponse @@ -42,6 +46,588 @@ def __init__(self, api_client=None) -> None: self.api_client = api_client + @validate_call + def check_wait_ccs_task_task( + self, + task_id: StrictStr, + proj_key: StrictStr, + wait: Annotated[Optional[Union[Annotated[float, Field(le=30.0, strict=True)], Annotated[int, Field(le=30, strict=True)]]], Field(description="Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> TaskResult: + """Check Wait Ccs Task Task + + Check status of a CCS conversion task. + + :param task_id: (required) + :type task_id: str + :param proj_key: (required) + :type proj_key: str + :param wait: Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls. + :type wait: float + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._check_wait_ccs_task_task_serialize( + task_id=task_id, + proj_key=proj_key, + wait=wait, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TaskResult", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def check_wait_ccs_task_task_with_http_info( + self, + task_id: StrictStr, + proj_key: StrictStr, + wait: Annotated[Optional[Union[Annotated[float, Field(le=30.0, strict=True)], Annotated[int, Field(le=30, strict=True)]]], Field(description="Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[TaskResult]: + """Check Wait Ccs Task Task + + Check status of a CCS conversion task. + + :param task_id: (required) + :type task_id: str + :param proj_key: (required) + :type proj_key: str + :param wait: Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls. + :type wait: float + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._check_wait_ccs_task_task_serialize( + task_id=task_id, + proj_key=proj_key, + wait=wait, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TaskResult", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def check_wait_ccs_task_task_without_preload_content( + self, + task_id: StrictStr, + proj_key: StrictStr, + wait: Annotated[Optional[Union[Annotated[float, Field(le=30.0, strict=True)], Annotated[int, Field(le=30, strict=True)]]], Field(description="Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Check Wait Ccs Task Task + + Check status of a CCS conversion task. + + :param task_id: (required) + :type task_id: str + :param proj_key: (required) + :type proj_key: str + :param wait: Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls. + :type wait: float + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._check_wait_ccs_task_task_serialize( + task_id=task_id, + proj_key=proj_key, + wait=wait, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TaskResult", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _check_wait_ccs_task_task_serialize( + self, + task_id, + proj_key, + wait, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if task_id is not None: + _path_params['task_id'] = task_id + if proj_key is not None: + _path_params['proj_key'] = proj_key + # process the query parameters + if wait is not None: + + _query_params.append(('wait', wait)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/project/{proj_key}/convert_tasks/{task_id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def convert_pdf_document( + self, + proj_key: StrictStr, + convert_document_request: ConvertDocumentRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CcsTask: + """Convert Pdf Document + + Convert a PDF document directly to CCS. + + :param proj_key: (required) + :type proj_key: str + :param convert_document_request: (required) + :type convert_document_request: ConvertDocumentRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._convert_pdf_document_serialize( + proj_key=proj_key, + convert_document_request=convert_document_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CcsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def convert_pdf_document_with_http_info( + self, + proj_key: StrictStr, + convert_document_request: ConvertDocumentRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CcsTask]: + """Convert Pdf Document + + Convert a PDF document directly to CCS. + + :param proj_key: (required) + :type proj_key: str + :param convert_document_request: (required) + :type convert_document_request: ConvertDocumentRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._convert_pdf_document_serialize( + proj_key=proj_key, + convert_document_request=convert_document_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CcsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def convert_pdf_document_without_preload_content( + self, + proj_key: StrictStr, + convert_document_request: ConvertDocumentRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Convert Pdf Document + + Convert a PDF document directly to CCS. + + :param proj_key: (required) + :type proj_key: str + :param convert_document_request: (required) + :type convert_document_request: ConvertDocumentRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._convert_pdf_document_serialize( + proj_key=proj_key, + convert_document_request=convert_document_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CcsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _convert_pdf_document_serialize( + self, + proj_key, + convert_document_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if proj_key is not None: + _path_params['proj_key'] = proj_key + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if convert_document_request is not None: + _body_params = convert_document_request + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/project/{proj_key}/convert', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def delete_project_integration_config_genai( self, diff --git a/deepsearch/cps/apis/public_v2/models/__init__.py b/deepsearch/cps/apis/public_v2/models/__init__.py index 13f55924..f8eb7591 100644 --- a/deepsearch/cps/apis/public_v2/models/__init__.py +++ b/deepsearch/cps/apis/public_v2/models/__init__.py @@ -22,9 +22,13 @@ from deepsearch.cps.apis.public_v2.models.ccs_project import CCSProject from deepsearch.cps.apis.public_v2.models.cps_package import CPSPackage from deepsearch.cps.apis.public_v2.models.cps_summary import CPSSummary +from deepsearch.cps.apis.public_v2.models.ccs_task import CcsTask from deepsearch.cps.apis.public_v2.models.collection_metadata_settings import CollectionMetadataSettings from deepsearch.cps.apis.public_v2.models.config import Config +from deepsearch.cps.apis.public_v2.models.convert_document_request import ConvertDocumentRequest from deepsearch.cps.apis.public_v2.models.convert_documents_request_body import ConvertDocumentsRequestBody +from deepsearch.cps.apis.public_v2.models.convert_documents_sources import ConvertDocumentsSources +from deepsearch.cps.apis.public_v2.models.convert_upload_documents_request_body import ConvertUploadDocumentsRequestBody from deepsearch.cps.apis.public_v2.models.cps_task import CpsTask from deepsearch.cps.apis.public_v2.models.data import Data from deepsearch.cps.apis.public_v2.models.data_flow import DataFlow @@ -42,6 +46,7 @@ from deepsearch.cps.apis.public_v2.models.elastic_index_source import ElasticIndexSource from deepsearch.cps.apis.public_v2.models.elastic_instance_data_index import ElasticInstanceDataIndex from deepsearch.cps.apis.public_v2.models.elastic_metadata import ElasticMetadata +from deepsearch.cps.apis.public_v2.models.file_source import FileSource from deepsearch.cps.apis.public_v2.models.flavour import Flavour from deepsearch.cps.apis.public_v2.models.flavours_default_quota import FlavoursDefaultQuota from deepsearch.cps.apis.public_v2.models.flavours_quota import FlavoursQuota @@ -57,6 +62,7 @@ from deepsearch.cps.apis.public_v2.models.gen_ai_watsonx_config import GenAIWatsonxConfig from deepsearch.cps.apis.public_v2.models.grouped_project_documents import GroupedProjectDocuments from deepsearch.cps.apis.public_v2.models.http_validation_error import HTTPValidationError +from deepsearch.cps.apis.public_v2.models.http_source import HttpSource from deepsearch.cps.apis.public_v2.models.internal_url import InternalUrl from deepsearch.cps.apis.public_v2.models.json_upload_request_body import JsonUploadRequestBody from deepsearch.cps.apis.public_v2.models.list_project_flavours import ListProjectFlavours @@ -100,6 +106,7 @@ from deepsearch.cps.apis.public_v2.models.source1 import Source1 from deepsearch.cps.apis.public_v2.models.storage_summary_task import StorageSummaryTask from deepsearch.cps.apis.public_v2.models.system_info import SystemInfo +from deepsearch.cps.apis.public_v2.models.target_conversion_parameters import TargetConversionParameters from deepsearch.cps.apis.public_v2.models.task_context import TaskContext from deepsearch.cps.apis.public_v2.models.task_result import TaskResult from deepsearch.cps.apis.public_v2.models.temporary_upload_file_result import TemporaryUploadFileResult @@ -107,6 +114,7 @@ from deepsearch.cps.apis.public_v2.models.temporary_url_fields import TemporaryUrlFields from deepsearch.cps.apis.public_v2.models.token_response import TokenResponse from deepsearch.cps.apis.public_v2.models.upload_date import UploadDate +from deepsearch.cps.apis.public_v2.models.upload_elastic_request_body import UploadElasticRequestBody from deepsearch.cps.apis.public_v2.models.upload_job import UploadJob from deepsearch.cps.apis.public_v2.models.urls import Urls from deepsearch.cps.apis.public_v2.models.validation_error import ValidationError diff --git a/deepsearch/cps/apis/public_v2/models/ccs_task.py b/deepsearch/cps/apis/public_v2/models/ccs_task.py new file mode 100644 index 00000000..0753215b --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/ccs_task.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class CcsTask(BaseModel): + """ + CcsTask + """ # noqa: E501 + task_id: StrictStr + ccs_project_key: StrictStr + ccs_collection_name: StrictStr + __properties: ClassVar[List[str]] = ["task_id", "ccs_project_key", "ccs_collection_name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CcsTask from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CcsTask from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "task_id": obj.get("task_id"), + "ccs_project_key": obj.get("ccs_project_key"), + "ccs_collection_name": obj.get("ccs_collection_name") + }) + return _obj + + diff --git a/deepsearch/cps/apis/public_v2/models/convert_document_request.py b/deepsearch/cps/apis/public_v2/models/convert_document_request.py new file mode 100644 index 00000000..e1e86c03 --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/convert_document_request.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from deepsearch.cps.apis.public_v2.models.file_source import FileSource +from deepsearch.cps.apis.public_v2.models.http_source import HttpSource +from typing import Optional, Set +from typing_extensions import Self + +class ConvertDocumentRequest(BaseModel): + """ + ConvertDocumentRequest + """ # noqa: E501 + http_source: Optional[HttpSource] = None + file_source: Optional[FileSource] = None + __properties: ClassVar[List[str]] = ["http_source", "file_source"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ConvertDocumentRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of http_source + if self.http_source: + _dict['http_source'] = self.http_source.to_dict() + # override the default output from pydantic by calling `to_dict()` of file_source + if self.file_source: + _dict['file_source'] = self.file_source.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ConvertDocumentRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "http_source": HttpSource.from_dict(obj["http_source"]) if obj.get("http_source") is not None else None, + "file_source": FileSource.from_dict(obj["file_source"]) if obj.get("file_source") is not None else None + }) + return _obj + + diff --git a/deepsearch/cps/apis/public_v2/models/convert_documents_request_body.py b/deepsearch/cps/apis/public_v2/models/convert_documents_request_body.py index 0a52951d..204cb0f5 100644 --- a/deepsearch/cps/apis/public_v2/models/convert_documents_request_body.py +++ b/deepsearch/cps/apis/public_v2/models/convert_documents_request_body.py @@ -17,11 +17,10 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from deepsearch.cps.apis.public_v2.models.internal_url import InternalUrl from deepsearch.cps.apis.public_v2.models.partial_direct_conversion_parameters import PartialDirectConversionParameters -from deepsearch.cps.apis.public_v2.models.s3_document_source import S3DocumentSource +from deepsearch.cps.apis.public_v2.models.target_conversion_parameters import TargetConversionParameters from typing import Optional, Set from typing_extensions import Self @@ -29,12 +28,23 @@ class ConvertDocumentsRequestBody(BaseModel): """ ConvertDocumentsRequestBody """ # noqa: E501 - file_url: Optional[List[StrictStr]] = Field(default=None, description="List of File's URL to be converted and uploaded to the data index.") - internal_file_url: Optional[List[InternalUrl]] = Field(default=None, description="List of Internal File's URLs to be converted and uploaded to the data index.") - s3_source: Optional[S3DocumentSource] = Field(default=None, description="Coordinates to object store to get files to convert. Can specify which files with object keys.") - upload_to_elastic: Optional[StrictBool] = None conversion_settings: Optional[PartialDirectConversionParameters] = Field(default=None, description="Specify the conversion settings to use.") - __properties: ClassVar[List[str]] = ["file_url", "internal_file_url", "s3_source", "upload_to_elastic", "conversion_settings"] + target_settings: Optional[TargetConversionParameters] = Field(default=None, description="Specify the target settings to use.") + document_hashes: Optional[List[StrictStr]] = Field(default=None, description="List of document hashes to be used as filter.") + without_operations: Optional[List[StrictStr]] = Field(default=None, description="List of Operation Status documents don't have to be used as filter.") + upload_to_elastic: Optional[StrictBool] = None + __properties: ClassVar[List[str]] = ["conversion_settings", "target_settings", "document_hashes", "without_operations", "upload_to_elastic"] + + @field_validator('without_operations') + def without_operations_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['PENDING', 'FAILURE', 'SUCCESS']): + raise ValueError("each list item must be one of ('PENDING', 'FAILURE', 'SUCCESS')") + return value model_config = ConfigDict( populate_by_name=True, @@ -75,19 +85,12 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # override the default output from pydantic by calling `to_dict()` of each item in internal_file_url (list) - _items = [] - if self.internal_file_url: - for _item in self.internal_file_url: - if _item: - _items.append(_item.to_dict()) - _dict['internal_file_url'] = _items - # override the default output from pydantic by calling `to_dict()` of s3_source - if self.s3_source: - _dict['s3_source'] = self.s3_source.to_dict() # override the default output from pydantic by calling `to_dict()` of conversion_settings if self.conversion_settings: _dict['conversion_settings'] = self.conversion_settings.to_dict() + # override the default output from pydantic by calling `to_dict()` of target_settings + if self.target_settings: + _dict['target_settings'] = self.target_settings.to_dict() return _dict @classmethod @@ -100,11 +103,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "file_url": obj.get("file_url"), - "internal_file_url": [InternalUrl.from_dict(_item) for _item in obj["internal_file_url"]] if obj.get("internal_file_url") is not None else None, - "s3_source": S3DocumentSource.from_dict(obj["s3_source"]) if obj.get("s3_source") is not None else None, - "upload_to_elastic": obj.get("upload_to_elastic"), - "conversion_settings": PartialDirectConversionParameters.from_dict(obj["conversion_settings"]) if obj.get("conversion_settings") is not None else None + "conversion_settings": PartialDirectConversionParameters.from_dict(obj["conversion_settings"]) if obj.get("conversion_settings") is not None else None, + "target_settings": TargetConversionParameters.from_dict(obj["target_settings"]) if obj.get("target_settings") is not None else None, + "document_hashes": obj.get("document_hashes"), + "without_operations": obj.get("without_operations"), + "upload_to_elastic": obj.get("upload_to_elastic") }) return _obj diff --git a/deepsearch/cps/apis/public_v2/models/convert_documents_sources.py b/deepsearch/cps/apis/public_v2/models/convert_documents_sources.py new file mode 100644 index 00000000..72596258 --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/convert_documents_sources.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from deepsearch.cps.apis.public_v2.models.internal_url import InternalUrl +from deepsearch.cps.apis.public_v2.models.s3_document_source import S3DocumentSource +from typing import Optional, Set +from typing_extensions import Self + +class ConvertDocumentsSources(BaseModel): + """ + ConvertDocumentsSources + """ # noqa: E501 + file_url: Optional[List[StrictStr]] = Field(default=None, description="List of File's URL to be converted and uploaded to the data index.") + internal_file_url: Optional[List[InternalUrl]] = Field(default=None, description="List of Internal File's URLs to be converted and uploaded to the data index.") + s3_source: Optional[S3DocumentSource] = Field(default=None, description="Coordinates to object store to get files to convert. Can specify which files with object keys.") + __properties: ClassVar[List[str]] = ["file_url", "internal_file_url", "s3_source"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ConvertDocumentsSources from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in internal_file_url (list) + _items = [] + if self.internal_file_url: + for _item in self.internal_file_url: + if _item: + _items.append(_item.to_dict()) + _dict['internal_file_url'] = _items + # override the default output from pydantic by calling `to_dict()` of s3_source + if self.s3_source: + _dict['s3_source'] = self.s3_source.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ConvertDocumentsSources from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "file_url": obj.get("file_url"), + "internal_file_url": [InternalUrl.from_dict(_item) for _item in obj["internal_file_url"]] if obj.get("internal_file_url") is not None else None, + "s3_source": S3DocumentSource.from_dict(obj["s3_source"]) if obj.get("s3_source") is not None else None + }) + return _obj + + diff --git a/deepsearch/cps/apis/public_v2/models/convert_upload_documents_request_body.py b/deepsearch/cps/apis/public_v2/models/convert_upload_documents_request_body.py new file mode 100644 index 00000000..b316700a --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/convert_upload_documents_request_body.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from deepsearch.cps.apis.public_v2.models.internal_url import InternalUrl +from deepsearch.cps.apis.public_v2.models.partial_direct_conversion_parameters import PartialDirectConversionParameters +from deepsearch.cps.apis.public_v2.models.s3_document_source import S3DocumentSource +from deepsearch.cps.apis.public_v2.models.target_conversion_parameters import TargetConversionParameters +from typing import Optional, Set +from typing_extensions import Self + +class ConvertUploadDocumentsRequestBody(BaseModel): + """ + ConvertUploadDocumentsRequestBody + """ # noqa: E501 + file_url: Optional[List[StrictStr]] = Field(default=None, description="List of File's URL to be converted and uploaded to the data index.") + internal_file_url: Optional[List[InternalUrl]] = Field(default=None, description="List of Internal File's URLs to be converted and uploaded to the data index.") + s3_source: Optional[S3DocumentSource] = Field(default=None, description="Coordinates to object store to get files to convert. Can specify which files with object keys.") + upload_to_elastic: Optional[StrictBool] = None + conversion_settings: Optional[PartialDirectConversionParameters] = Field(default=None, description="Specify the conversion settings to use.") + target_settings: Optional[TargetConversionParameters] = Field(default=None, description="Specify the target settings to use.") + __properties: ClassVar[List[str]] = ["file_url", "internal_file_url", "s3_source", "upload_to_elastic", "conversion_settings", "target_settings"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ConvertUploadDocumentsRequestBody from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in internal_file_url (list) + _items = [] + if self.internal_file_url: + for _item in self.internal_file_url: + if _item: + _items.append(_item.to_dict()) + _dict['internal_file_url'] = _items + # override the default output from pydantic by calling `to_dict()` of s3_source + if self.s3_source: + _dict['s3_source'] = self.s3_source.to_dict() + # override the default output from pydantic by calling `to_dict()` of conversion_settings + if self.conversion_settings: + _dict['conversion_settings'] = self.conversion_settings.to_dict() + # override the default output from pydantic by calling `to_dict()` of target_settings + if self.target_settings: + _dict['target_settings'] = self.target_settings.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ConvertUploadDocumentsRequestBody from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "file_url": obj.get("file_url"), + "internal_file_url": [InternalUrl.from_dict(_item) for _item in obj["internal_file_url"]] if obj.get("internal_file_url") is not None else None, + "s3_source": S3DocumentSource.from_dict(obj["s3_source"]) if obj.get("s3_source") is not None else None, + "upload_to_elastic": obj.get("upload_to_elastic"), + "conversion_settings": PartialDirectConversionParameters.from_dict(obj["conversion_settings"]) if obj.get("conversion_settings") is not None else None, + "target_settings": TargetConversionParameters.from_dict(obj["target_settings"]) if obj.get("target_settings") is not None else None + }) + return _obj + + diff --git a/deepsearch/cps/apis/public_v2/models/file_source.py b/deepsearch/cps/apis/public_v2/models/file_source.py new file mode 100644 index 00000000..d11ee4e3 --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/file_source.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class FileSource(BaseModel): + """ + FileSource + """ # noqa: E501 + base64_string: StrictStr + filename: StrictStr + __properties: ClassVar[List[str]] = ["base64_string", "filename"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of FileSource from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of FileSource from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "base64_string": obj.get("base64_string"), + "filename": obj.get("filename") + }) + return _obj + + diff --git a/deepsearch/cps/apis/public_v2/models/gen_ai_params.py b/deepsearch/cps/apis/public_v2/models/gen_ai_params.py index 80a2f1dd..f803bb54 100644 --- a/deepsearch/cps/apis/public_v2/models/gen_ai_params.py +++ b/deepsearch/cps/apis/public_v2/models/gen_ai_params.py @@ -17,8 +17,8 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictStr -from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Union from typing import Optional, Set from typing_extensions import Self @@ -29,7 +29,8 @@ class GenAIParams(BaseModel): model_id: StrictStr prompt_template: StrictStr params: Dict[str, Any] - __properties: ClassVar[List[str]] = ["model_id", "prompt_template", "params"] + timeout: Union[StrictFloat, StrictInt] + __properties: ClassVar[List[str]] = ["model_id", "prompt_template", "params", "timeout"] model_config = ConfigDict( populate_by_name=True, @@ -84,7 +85,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "model_id": obj.get("model_id"), "prompt_template": obj.get("prompt_template"), - "params": obj.get("params") + "params": obj.get("params"), + "timeout": obj.get("timeout") }) return _obj diff --git a/deepsearch/cps/apis/public_v2/models/gen_ai_partial_params.py b/deepsearch/cps/apis/public_v2/models/gen_ai_partial_params.py index ab54fbda..efec0e4c 100644 --- a/deepsearch/cps/apis/public_v2/models/gen_ai_partial_params.py +++ b/deepsearch/cps/apis/public_v2/models/gen_ai_partial_params.py @@ -17,8 +17,8 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictStr -from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union from typing import Optional, Set from typing_extensions import Self @@ -29,7 +29,8 @@ class GenAIPartialParams(BaseModel): model_id: Optional[StrictStr] = None prompt_template: Optional[StrictStr] = None params: Optional[Dict[str, Any]] = None - __properties: ClassVar[List[str]] = ["model_id", "prompt_template", "params"] + timeout: Optional[Union[StrictFloat, StrictInt]] = None + __properties: ClassVar[List[str]] = ["model_id", "prompt_template", "params", "timeout"] model_config = ConfigDict( populate_by_name=True, @@ -84,7 +85,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "model_id": obj.get("model_id"), "prompt_template": obj.get("prompt_template"), - "params": obj.get("params") + "params": obj.get("params"), + "timeout": obj.get("timeout") }) return _obj diff --git a/deepsearch/cps/apis/public_v2/models/http_source.py b/deepsearch/cps/apis/public_v2/models/http_source.py new file mode 100644 index 00000000..3aa2f191 --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/http_source.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class HttpSource(BaseModel): + """ + HttpSource + """ # noqa: E501 + url: StrictStr + headers: Dict[str, Any] + __properties: ClassVar[List[str]] = ["url", "headers"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of HttpSource from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of HttpSource from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "url": obj.get("url"), + "headers": obj.get("headers") + }) + return _obj + + diff --git a/deepsearch/cps/apis/public_v2/models/target_conversion_parameters.py b/deepsearch/cps/apis/public_v2/models/target_conversion_parameters.py new file mode 100644 index 00000000..8bc9339b --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/target_conversion_parameters.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class TargetConversionParameters(BaseModel): + """ + Specify target settings (add_raw_pages, add_annotations). Fields left null are set to platform defaults. + """ # noqa: E501 + add_raw_pages: Optional[StrictBool] = None + add_annotations: Optional[StrictBool] = None + __properties: ClassVar[List[str]] = ["add_raw_pages", "add_annotations"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TargetConversionParameters from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TargetConversionParameters from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "add_raw_pages": obj.get("add_raw_pages"), + "add_annotations": obj.get("add_annotations") + }) + return _obj + + diff --git a/deepsearch/cps/apis/public_v2/models/upload_elastic_request_body.py b/deepsearch/cps/apis/public_v2/models/upload_elastic_request_body.py new file mode 100644 index 00000000..48226e25 --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/upload_elastic_request_body.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class UploadElasticRequestBody(BaseModel): + """ + UploadElasticRequestBody + """ # noqa: E501 + document_hashes: Optional[List[StrictStr]] = Field(default=None, description="List of document hashes to be used as filter.") + with_operations: Optional[List[StrictStr]] = Field(default=None, description="List of Operation Status documents don't have to be used as filter.") + __properties: ClassVar[List[str]] = ["document_hashes", "with_operations"] + + @field_validator('with_operations') + def with_operations_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['PENDING', 'FAILURE', 'SUCCESS']): + raise ValueError("each list item must be one of ('PENDING', 'FAILURE', 'SUCCESS')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UploadElasticRequestBody from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UploadElasticRequestBody from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "document_hashes": obj.get("document_hashes"), + "with_operations": obj.get("with_operations") + }) + return _obj + + diff --git a/deepsearch/documents/cli/main.py b/deepsearch/documents/cli/main.py index 4ed25b5b..7ac3eac2 100644 --- a/deepsearch/documents/cli/main.py +++ b/deepsearch/documents/cli/main.py @@ -4,7 +4,6 @@ import urllib3 from deepsearch.core.cli.utils import cli_handler -from deepsearch.documents.core.export import export_to_markdown urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning) @@ -109,7 +108,7 @@ def convert( exported_filename = ( markdown_output_dir / f"{clean_archive_name}_{clean_filename}.md" ) - markdown_content = export_to_markdown(converted_document.document) + markdown_content = converted_document.document.export_to_markdown() with exported_filename.open("w") as f: f.write(markdown_content) diff --git a/deepsearch/documents/core/export.py b/deepsearch/documents/core/export.py index 48fc2f82..245908ab 100644 --- a/deepsearch/documents/core/export.py +++ b/deepsearch/documents/core/export.py @@ -1,10 +1,9 @@ import html import logging +import warnings from typing import Any, Dict -from tabulate import tabulate - -from deepsearch.documents.core.lookup import _resolve_item +from docling_core.types import Document as DsDocument _log = logging.getLogger(__name__) @@ -858,68 +857,10 @@ def export_to_html(document: Dict[str, Any]) -> str: def export_to_markdown(document: Dict[str, Any]) -> str: """ """ - markdown_text = "" - prev_text = "" - has_title = False - - for item in document["main-text"]: - - item = _resolve_item(item, document) - - if item == None: - continue - - item_type = item["type"] - - if ( - item_type in ("title", "subtitle-level-1", "paragraph", "caption") - and "text" in item - ): - - text = item["text"] - - # Ignore repeated text - if prev_text == text: - continue - else: - prev_text = text - - # The first match of a title type - if item_type == "title" and (not has_title): - markdown_text += f"# {text}\n\n" - has_title = True - - # Secondary titles - elif item_type in ("title", "subtitle-level-1") or ( - has_title and item_type == "title" - ): - markdown_text += f"## {text}\n\n" - - # Normal text - else: - markdown_text += f"{text}\n\n" - - elif item_type in ("table") and item.get("data", []): - table = [] - for row in item["data"]: - - tmp = [] - for col in row: - tmp.append(col.get("text", "")) - table.append(tmp) - - if len(table) > 1 and len(table[0]) > 0: - try: - md_table = tabulate(table[1:], headers=table[0], tablefmt="github") - except ValueError: - md_table = tabulate( - table[1:], - headers=table[0], - tablefmt="github", - disable_numparse=True, - ) - - markdown_text += md_table - markdown_text += "\n\n" + warnings.warn( + "export_to_markdown() is deprecated and will be removed in a future version. Use the docling_core package instead.", + DeprecationWarning, + ) - return markdown_text + d: DsDocument = DsDocument.model_validate(document) + return d.export_to_markdown() diff --git a/deepsearch/documents/core/utils.py b/deepsearch/documents/core/utils.py index c8ace652..1d80cb81 100644 --- a/deepsearch/documents/core/utils.py +++ b/deepsearch/documents/core/utils.py @@ -6,9 +6,10 @@ import urllib import zipfile as z from pathlib import Path -from typing import Any, Dict, Iterator, List +from typing import Any, Dict, Iterator, List, Optional import requests +from docling_core.types import Document as DsDocument from pydantic import BaseModel from tqdm import tqdm @@ -264,7 +265,8 @@ def write_taskids(result_dir: Path, list_to_write: List[str]) -> None: class IteratedDocument(BaseModel): archive_path: Path file_path: Path - document: Dict[str, Any] + document: DsDocument + cells: Optional[Dict[str, Any]] = None def iterate_converted_files(result_dir: Path) -> Iterator[IteratedDocument]: @@ -279,9 +281,17 @@ def iterate_converted_files(result_dir: Path) -> Iterator[IteratedDocument]: continue basename = name.rstrip(".json") - doc_jsondata = json.loads(archive.read(f"{basename}.json")) + doc: DsDocument = DsDocument.model_validate_json( + archive.read(f"{basename}.json") + ) + + cells_data = None + if f"{basename}.cells" in all_files: + cells_data = json.loads(archive.read(f"{basename}.cells")) + yield IteratedDocument( archive_path=output_file, file_path=Path(name), - document=doc_jsondata, + document=doc, + cells=cells_data, ) diff --git a/deepsearch/model/server/config.py b/deepsearch/model/server/config.py index 73c7056e..4e48a7d3 100644 --- a/deepsearch/model/server/config.py +++ b/deepsearch/model/server/config.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from pydantic import SecretStr from pydantic_settings import BaseSettings, SettingsConfigDict diff --git a/docs/apis/public/AnnotateApi.md b/docs/apis/public/AnnotateApi.md deleted file mode 100644 index 03683bd2..00000000 --- a/docs/apis/public/AnnotateApi.md +++ /dev/null @@ -1,328 +0,0 @@ -# deepsearch.cps.apis.public.AnnotateApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**generate_project_object_annotations**](AnnotateApi.md#generate_project_object_annotations) | **POST** /project/{proj_key}/object_annotations | -[**generate_project_object_annotations_async**](AnnotateApi.md#generate_project_object_annotations_async) | **POST** /project/{proj_key}/object_annotations_async | -[**get_cached_annotator_metadata**](AnnotateApi.md#get_cached_annotator_metadata) | **POST** /project/{proj_key}/annotator/metadata | -[**get_project_annotator_supported_annotations**](AnnotateApi.md#get_project_annotator_supported_annotations) | **POST** /project/{proj_key}/annotate/supported_annotations | - - -# **generate_project_object_annotations** -> AnnotatedObject1 generate_project_object_annotations(proj_key, options) - - - -Run an annotator on an object, using resources from the project. *DEPRECATED*, please use generate_project_object_annotations_async instead. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.AnnotateApi(api_client) - proj_key = 'proj_key_example' # str | -options = deepsearch.cps.apis.public.AnnotateObjectOptions() # AnnotateObjectOptions | - - try: - api_response = api_instance.generate_project_object_annotations(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling AnnotateApi->generate_project_object_annotations: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | [**AnnotateObjectOptions**](AnnotateObjectOptions.md)| | - -### Return type - -[**AnnotatedObject1**](AnnotatedObject1.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **generate_project_object_annotations_async** -> Task generate_project_object_annotations_async(proj_key, options) - - - -Run an annotator on an object, using resources from the project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.AnnotateApi(api_client) - proj_key = 'proj_key_example' # str | -options = deepsearch.cps.apis.public.AnnotateObjectOptions1() # AnnotateObjectOptions1 | - - try: - api_response = api_instance.generate_project_object_annotations_async(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling AnnotateApi->generate_project_object_annotations_async: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | [**AnnotateObjectOptions1**](AnnotateObjectOptions1.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_cached_annotator_metadata** -> AnnotatorMetadata get_cached_annotator_metadata(proj_key, options) - - - -Get annotator's metadata - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.AnnotateApi(api_client) - proj_key = 'proj_key_example' # str | -options = None # object | - - try: - api_response = api_instance.get_cached_annotator_metadata(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling AnnotateApi->get_cached_annotator_metadata: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | **object**| | - -### Return type - -[**AnnotatorMetadata**](AnnotatorMetadata.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, text/html - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_annotator_supported_annotations** -> SupportedAnnotatorAnnotations get_project_annotator_supported_annotations(proj_key, options) - - - -Get supported annotations for an annotator - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.AnnotateApi(api_client) - proj_key = 'proj_key_example' # str | -options = None # object | - - try: - api_response = api_instance.get_project_annotator_supported_annotations(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling AnnotateApi->get_project_annotator_supported_annotations: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | **object**| | - -### Return type - -[**SupportedAnnotatorAnnotations**](SupportedAnnotatorAnnotations.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, text/html - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/AnnotateDocumentRequest.md b/docs/apis/public/AnnotateDocumentRequest.md deleted file mode 100644 index 3b990288..00000000 --- a/docs/apis/public/AnnotateDocumentRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# AnnotateDocumentRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**document** | [**object**](.md) | | -**image_annotators** | [**list[AnnotatorParametersOrRef]**](AnnotatorParametersOrRef.md) | | -**table_annotators** | [**list[AnnotatorParametersOrRef]**](AnnotatorParametersOrRef.md) | | -**text_annotators** | [**list[AnnotatorParametersOrRef]**](AnnotatorParametersOrRef.md) | | -**use_cache** | **bool** | | [optional] [default to True] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotateObjectOptions.md b/docs/apis/public/AnnotateObjectOptions.md deleted file mode 100644 index 96c1b2dc..00000000 --- a/docs/apis/public/AnnotateObjectOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# AnnotateObjectOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**input** | [**AnnotatorInput**](AnnotatorInput.md) | | -**parameters** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotateObjectOptions1.md b/docs/apis/public/AnnotateObjectOptions1.md deleted file mode 100644 index 452a7442..00000000 --- a/docs/apis/public/AnnotateObjectOptions1.md +++ /dev/null @@ -1,14 +0,0 @@ -# AnnotateObjectOptions1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**input** | [**AnnotatorInput**](AnnotatorInput.md) | | -**model_config_key** | **str** | | [optional] -**parameters** | **dict(str, object)** | | -**proj_key** | **str** | | [optional] -**public** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatedDocumentReport.md b/docs/apis/public/AnnotatedDocumentReport.md deleted file mode 100644 index 9324ec65..00000000 --- a/docs/apis/public/AnnotatedDocumentReport.md +++ /dev/null @@ -1,13 +0,0 @@ -# AnnotatedDocumentReport - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**document** | [**ProjectProjKeyAnnotateDocumentReportDocument**](ProjectProjKeyAnnotateDocumentReportDocument.md) | | -**document_annotation_parameters** | [**object**](.md) | | [optional] -**document_conversion_parameters** | [**object**](.md) | | [optional] -**report** | [**ProjectProjKeyAnnotateDocumentReportReport**](ProjectProjKeyAnnotateDocumentReportReport.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatedImage.md b/docs/apis/public/AnnotatedImage.md deleted file mode 100644 index 0fdaaeff..00000000 --- a/docs/apis/public/AnnotatedImage.md +++ /dev/null @@ -1,13 +0,0 @@ -# AnnotatedImage - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**entities** | **dict(str, list[EntityAnnotation])** | | -**properties** | [**object**](.md) | | -**relationships** | **dict(str, list[object])** | | -**text** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatedObject.md b/docs/apis/public/AnnotatedObject.md deleted file mode 100644 index b5602f3b..00000000 --- a/docs/apis/public/AnnotatedObject.md +++ /dev/null @@ -1,12 +0,0 @@ -# AnnotatedObject - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**image** | [**AnnotatedImage**](AnnotatedImage.md) | | [optional] -**table** | [**AnnotatedTable**](AnnotatedTable.md) | | [optional] -**text** | [**AnnotatedTextLines**](AnnotatedTextLines.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatedObject1.md b/docs/apis/public/AnnotatedObject1.md deleted file mode 100644 index 1678dd95..00000000 --- a/docs/apis/public/AnnotatedObject1.md +++ /dev/null @@ -1,12 +0,0 @@ -# AnnotatedObject1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**image** | [**AnnotatedImage**](AnnotatedImage.md) | | [optional] -**table** | [**AnnotatedTable**](AnnotatedTable.md) | | [optional] -**text** | [**AnnotatedTextLines**](AnnotatedTextLines.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatedTable.md b/docs/apis/public/AnnotatedTable.md deleted file mode 100644 index 8f6bde54..00000000 --- a/docs/apis/public/AnnotatedTable.md +++ /dev/null @@ -1,13 +0,0 @@ -# AnnotatedTable - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**entities** | **dict(str, list[EntityAnnotation])** | | -**properties** | [**object**](.md) | | -**relationships** | **dict(str, list[object])** | | -**text** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatedText.md b/docs/apis/public/AnnotatedText.md deleted file mode 100644 index 62a5c0bd..00000000 --- a/docs/apis/public/AnnotatedText.md +++ /dev/null @@ -1,13 +0,0 @@ -# AnnotatedText - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**entities** | **dict(str, list[EntityAnnotation])** | | -**properties** | [**object**](.md) | | -**relationships** | **dict(str, list[object])** | | -**text** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatedTextLines.md b/docs/apis/public/AnnotatedTextLines.md deleted file mode 100644 index cb2cb61d..00000000 --- a/docs/apis/public/AnnotatedTextLines.md +++ /dev/null @@ -1,13 +0,0 @@ -# AnnotatedTextLines - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**entities** | **list[dict(str, list[EntityAnnotation])]** | One item per line on the original text. | -**properties** | **list[object]** | One item per line on the original text. | -**relationships** | **list[dict(str, list[object])]** | One item per line on the original text. | -**text** | **str** | Input text after clean up. The annotation indexes will be based on this text and not the input text. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatorImageInput.md b/docs/apis/public/AnnotatorImageInput.md deleted file mode 100644 index 8bd222b6..00000000 --- a/docs/apis/public/AnnotatorImageInput.md +++ /dev/null @@ -1,11 +0,0 @@ -# AnnotatorImageInput - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**metadata** | [**ImageMetadata**](ImageMetadata.md) | | [optional] -**source** | [**ImageSource**](ImageSource.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatorInput.md b/docs/apis/public/AnnotatorInput.md deleted file mode 100644 index cfc21245..00000000 --- a/docs/apis/public/AnnotatorInput.md +++ /dev/null @@ -1,12 +0,0 @@ -# AnnotatorInput - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**image** | [**AnnotatorImageInput**](AnnotatorImageInput.md) | | [optional] -**table** | **list[list[object]]** | A table, specified as an array of arrays. Each outer array represents a row, and each item in the inner array represents the column. | [optional] -**text** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatorMetadata.md b/docs/apis/public/AnnotatorMetadata.md deleted file mode 100644 index 000ff2be..00000000 --- a/docs/apis/public/AnnotatorMetadata.md +++ /dev/null @@ -1,14 +0,0 @@ -# AnnotatorMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**author** | **str** | | -**description** | **str** | | -**name** | **str** | | -**url** | **str** | | -**version** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatorParametersOrRef.md b/docs/apis/public/AnnotatorParametersOrRef.md deleted file mode 100644 index 574899d9..00000000 --- a/docs/apis/public/AnnotatorParametersOrRef.md +++ /dev/null @@ -1,13 +0,0 @@ -# AnnotatorParametersOrRef - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**model_config_key** | **str** | | [optional] -**proj_key** | **str** | | [optional] -**public** | **bool** | | [optional] -**type** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatorSupportedAnnotationsParameters.md b/docs/apis/public/AnnotatorSupportedAnnotationsParameters.md deleted file mode 100644 index 50c4b3cb..00000000 --- a/docs/apis/public/AnnotatorSupportedAnnotationsParameters.md +++ /dev/null @@ -1,11 +0,0 @@ -# AnnotatorSupportedAnnotationsParameters - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**annotator** | **str** | | -**annotator_settings** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AssembleDataFlowIntoKnowledgeGraphOptions.md b/docs/apis/public/AssembleDataFlowIntoKnowledgeGraphOptions.md deleted file mode 100644 index 8e70572b..00000000 --- a/docs/apis/public/AssembleDataFlowIntoKnowledgeGraphOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# AssembleDataFlowIntoKnowledgeGraphOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flow** | [**BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow**](BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md) | | -**render** | [**BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender**](BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender.md) | | -**snapshot** | [**TakeSnapshotSettingsBackendAware**](TakeSnapshotSettingsBackendAware.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AssembleDataFlowIntoKnowledgeGraphOptions1.md b/docs/apis/public/AssembleDataFlowIntoKnowledgeGraphOptions1.md deleted file mode 100644 index efea0b23..00000000 --- a/docs/apis/public/AssembleDataFlowIntoKnowledgeGraphOptions1.md +++ /dev/null @@ -1,12 +0,0 @@ -# AssembleDataFlowIntoKnowledgeGraphOptions1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flow** | [**BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow**](BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md) | | -**render** | [**BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender**](BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender.md) | | -**snapshot** | [**TakeSnapshotSettings**](TakeSnapshotSettings.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AssembleSettings.md b/docs/apis/public/AssembleSettings.md deleted file mode 100644 index 35590f9f..00000000 --- a/docs/apis/public/AssembleSettings.md +++ /dev/null @@ -1,11 +0,0 @@ -# AssembleSettings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**include_incomplete_documents** | **bool** | | -**mode** | [**AssembleSettingsMode**](AssembleSettingsMode.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AssembleSettingsMode.md b/docs/apis/public/AssembleSettingsMode.md deleted file mode 100644 index dfb7ef91..00000000 --- a/docs/apis/public/AssembleSettingsMode.md +++ /dev/null @@ -1,11 +0,0 @@ -# AssembleSettingsMode - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**page_elements** | **list[str]** | | -**tables** | **list[str]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AttachmentUploadData.md b/docs/apis/public/AttachmentUploadData.md deleted file mode 100644 index d40fe5c9..00000000 --- a/docs/apis/public/AttachmentUploadData.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttachmentUploadData - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**attachment_path** | **str** | Attachment path. | -**upload_data** | [**AttachmentUploadDataUploadData**](AttachmentUploadDataUploadData.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AttachmentUploadDataUploadData.md b/docs/apis/public/AttachmentUploadDataUploadData.md deleted file mode 100644 index 6f26d557..00000000 --- a/docs/apis/public/AttachmentUploadDataUploadData.md +++ /dev/null @@ -1,12 +0,0 @@ -# AttachmentUploadDataUploadData - -Data to upload the temporary file. Example using requests 'requests(dot)post(url, data=fields, files=file)'. More information can be found on aws s3 documentation here https://docs.aws.amazon.com/AmazonS3/latest/userguide/PresignedUrlUploadObject.html -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fields** | [**object**](.md) | fields to use in request body. | [optional] -**url** | **str** | url of the host. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BackendFlavour.md b/docs/apis/public/BackendFlavour.md deleted file mode 100644 index 49134a69..00000000 --- a/docs/apis/public/BackendFlavour.md +++ /dev/null @@ -1,11 +0,0 @@ -# BackendFlavour - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**kg_amqp** | **str** | | [optional] -**kg_legacy_api** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md b/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md deleted file mode 100644 index 4b255851..00000000 --- a/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md +++ /dev/null @@ -1,13 +0,0 @@ -# BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**df_tpl_key** | **str** | If set, the data flow with this key will be used. | [optional] -**proj_key** | **str** | If set, allows for cross-project data flows to be used. | [optional] -**public** | **bool** | Must be set if the data flow template is public | [optional] -**raw_data_flow** | [**BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRawDataFlow**](BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRawDataFlow.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRawDataFlow.md b/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRawDataFlow.md deleted file mode 100644 index 8ff2ea30..00000000 --- a/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRawDataFlow.md +++ /dev/null @@ -1,12 +0,0 @@ -# BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRawDataFlow - -If this is set, the raw data flow contents will be used. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**template** | **str** | Must be valid JSON | -**variables** | [**object**](.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender.md b/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender.md deleted file mode 100644 index c0d8b40c..00000000 --- a/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender.md +++ /dev/null @@ -1,10 +0,0 @@ -# BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**variables** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BackupKnowledgeGraphOptions.md b/docs/apis/public/BackupKnowledgeGraphOptions.md deleted file mode 100644 index a2ce5c01..00000000 --- a/docs/apis/public/BackupKnowledgeGraphOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# BackupKnowledgeGraphOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**backup_s3** | **bool** | | [optional] [default to True] -**coordinates** | [**S3CoordinatesWithBackupKey**](S3CoordinatesWithBackupKey.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/Bag.md b/docs/apis/public/Bag.md deleted file mode 100644 index 269aa15f..00000000 --- a/docs/apis/public/Bag.md +++ /dev/null @@ -1,20 +0,0 @@ -# Bag - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**svc_endpoint** | **str** | | -**bag_domain** | **str** | | -**bag_key** | **str** | | -**bag_url** | **str** | | -**flavour** | **str** | | -**name** | **str** | | -**proj_key** | **str** | | -**public** | **bool** | | -**slug** | **str** | | -**timestamp** | **float** | | -**token** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagAmqpBackend.md b/docs/apis/public/BagAmqpBackend.md deleted file mode 100644 index 76571a2f..00000000 --- a/docs/apis/public/BagAmqpBackend.md +++ /dev/null @@ -1,10 +0,0 @@ -# BagAmqpBackend - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**flavour** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagBackendAware.md b/docs/apis/public/BagBackendAware.md deleted file mode 100644 index 41434ae9..00000000 --- a/docs/apis/public/BagBackendAware.md +++ /dev/null @@ -1,18 +0,0 @@ -# BagBackendAware - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**backend** | [**BagBackends**](BagBackends.md) | | -**bag_key** | **str** | | -**description** | **str** | | -**last_coords_resolution** | **float** | | [optional] -**name** | **str** | | -**proj_key** | **str** | | -**public** | **bool** | | -**slug** | **str** | | -**timestamp** | **float** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagBackends.md b/docs/apis/public/BagBackends.md deleted file mode 100644 index 480052e2..00000000 --- a/docs/apis/public/BagBackends.md +++ /dev/null @@ -1,11 +0,0 @@ -# BagBackends - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**kg_amqp** | [**BagAmqpBackend**](BagAmqpBackend.md) | | [optional] -**kg_legacy_api** | [**BagKgLegacyApiBackend**](BagKgLegacyApiBackend.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagCallback.md b/docs/apis/public/BagCallback.md deleted file mode 100644 index ee0e953b..00000000 --- a/docs/apis/public/BagCallback.md +++ /dev/null @@ -1,10 +0,0 @@ -# BagCallback - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**callback_url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagComponentStatus.md b/docs/apis/public/BagComponentStatus.md deleted file mode 100644 index 66998ddd..00000000 --- a/docs/apis/public/BagComponentStatus.md +++ /dev/null @@ -1,11 +0,0 @@ -# BagComponentStatus - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**start_time** | **float** | | -**status** | [**BagComponentStatusEnum**](BagComponentStatusEnum.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagComponentStatusEnum.md b/docs/apis/public/BagComponentStatusEnum.md deleted file mode 100644 index fe4e4320..00000000 --- a/docs/apis/public/BagComponentStatusEnum.md +++ /dev/null @@ -1,9 +0,0 @@ -# BagComponentStatusEnum - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagFlavour.md b/docs/apis/public/BagFlavour.md deleted file mode 100644 index eeec2e62..00000000 --- a/docs/apis/public/BagFlavour.md +++ /dev/null @@ -1,12 +0,0 @@ -# BagFlavour - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | [optional] -**display_name** | **str** | | [optional] -**name** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagFlavourDefaultQuota.md b/docs/apis/public/BagFlavourDefaultQuota.md deleted file mode 100644 index 0698d090..00000000 --- a/docs/apis/public/BagFlavourDefaultQuota.md +++ /dev/null @@ -1,12 +0,0 @@ -# BagFlavourDefaultQuota - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**default_quota** | **float** | | [optional] -**display_name** | **str** | | -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagFlavourFullData.md b/docs/apis/public/BagFlavourFullData.md deleted file mode 100644 index 8927f95a..00000000 --- a/docs/apis/public/BagFlavourFullData.md +++ /dev/null @@ -1,18 +0,0 @@ -# BagFlavourFullData - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**backend** | **str** | | -**config** | [**object**](.md) | | -**default_quota** | **int** | | [optional] -**description** | **str** | | -**display_name** | **str** | | -**is_from_deployment** | **bool** | | [optional] -**name** | **str** | | [optional] -**order** | **float** | | [optional] -**project_specific** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagKgLegacyApiBackend.md b/docs/apis/public/BagKgLegacyApiBackend.md deleted file mode 100644 index eb596398..00000000 --- a/docs/apis/public/BagKgLegacyApiBackend.md +++ /dev/null @@ -1,14 +0,0 @@ -# BagKgLegacyApiBackend - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**svc_endpoint** | **str** | | [optional] -**bag_domain** | **str** | | [optional] -**bag_url** | **str** | | [optional] -**flavour** | **str** | | [optional] -**token** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagStatus.md b/docs/apis/public/BagStatus.md deleted file mode 100644 index 971f6b04..00000000 --- a/docs/apis/public/BagStatus.md +++ /dev/null @@ -1,11 +0,0 @@ -# BagStatus - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**components** | [**BagStatusComponents**](BagStatusComponents.md) | | -**status** | [**BagComponentStatusEnum**](BagComponentStatusEnum.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagStatusBackendAware.md b/docs/apis/public/BagStatusBackendAware.md deleted file mode 100644 index 9235b3b3..00000000 --- a/docs/apis/public/BagStatusBackendAware.md +++ /dev/null @@ -1,12 +0,0 @@ -# BagStatusBackendAware - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**kg_amqp** | [**BagStatusBackendAwareKgAmqp**](BagStatusBackendAwareKgAmqp.md) | | [optional] -**kg_legacy_api** | [**BagStatus**](BagStatus.md) | | [optional] -**overall_status** | [**BagComponentStatusEnum**](BagComponentStatusEnum.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagStatusBackendAwareKgAmqp.md b/docs/apis/public/BagStatusBackendAwareKgAmqp.md deleted file mode 100644 index 27f07380..00000000 --- a/docs/apis/public/BagStatusBackendAwareKgAmqp.md +++ /dev/null @@ -1,10 +0,0 @@ -# BagStatusBackendAwareKgAmqp - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | [**BagComponentStatusEnum**](BagComponentStatusEnum.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagStatusComponents.md b/docs/apis/public/BagStatusComponents.md deleted file mode 100644 index 073d60a1..00000000 --- a/docs/apis/public/BagStatusComponents.md +++ /dev/null @@ -1,12 +0,0 @@ -# BagStatusComponents - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**erlenmeyer_api** | [**BagComponentStatus**](BagComponentStatus.md) | Status of the Erlenmeyer API for this Graph | -**erlenmeyer_ui** | [**BagComponentStatus**](BagComponentStatus.md) | Status of the Erlenmeyer UI for this Graph | -**kg** | [**BagComponentStatus**](BagComponentStatus.md) | Status of the Knowledge Graph and its API | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CatalogReference.md b/docs/apis/public/CatalogReference.md deleted file mode 100644 index 6f5b2e8a..00000000 --- a/docs/apis/public/CatalogReference.md +++ /dev/null @@ -1,12 +0,0 @@ -# CatalogReference - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection_name** | **str** | | -**dc_key** | **str** | | -**proj_key** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CcsCollectionReference.md b/docs/apis/public/CcsCollectionReference.md deleted file mode 100644 index 857cd5b6..00000000 --- a/docs/apis/public/CcsCollectionReference.md +++ /dev/null @@ -1,12 +0,0 @@ -# CcsCollectionReference - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection_name** | **str** | | -**language** | **str** | | [optional] -**proj_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CcsTask.md b/docs/apis/public/CcsTask.md deleted file mode 100644 index a28b11b9..00000000 --- a/docs/apis/public/CcsTask.md +++ /dev/null @@ -1,12 +0,0 @@ -# CcsTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ccs_collection_name** | **str** | | -**ccs_project_key** | **str** | | -**task_id** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CeleryTask.md b/docs/apis/public/CeleryTask.md deleted file mode 100644 index e7455ef4..00000000 --- a/docs/apis/public/CeleryTask.md +++ /dev/null @@ -1,12 +0,0 @@ -# CeleryTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**failures** | [**list[SystemCeleryTasksFailureFailures]**](SystemCeleryTasksFailureFailures.md) | | -**proj_key** | **str** | | -**task_id** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CeleryTask1.md b/docs/apis/public/CeleryTask1.md deleted file mode 100644 index 7c1eee05..00000000 --- a/docs/apis/public/CeleryTask1.md +++ /dev/null @@ -1,21 +0,0 @@ -# CeleryTask1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**completed_at** | **float** | | -**created_at** | **float** | | -**meta** | **dict(str, object)** | | -**metrics** | [**object**](.md) | | [optional] -**proj_key** | **str** | | -**project_task_id** | **str** | | -**project_task_type** | **str** | | [optional] -**started_at** | **float** | | -**task_id** | **str** | | -**task_status** | **str** | | -**task_type** | **str** | | -**worker_name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CeleryTaskPromise.md b/docs/apis/public/CeleryTaskPromise.md deleted file mode 100644 index 54bd123e..00000000 --- a/docs/apis/public/CeleryTaskPromise.md +++ /dev/null @@ -1,12 +0,0 @@ -# CeleryTaskPromise - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**result** | [**object**](.md) | | -**task_id** | **str** | | -**task_status** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CloneDataCatalogOptions.md b/docs/apis/public/CloneDataCatalogOptions.md deleted file mode 100644 index 91511811..00000000 --- a/docs/apis/public/CloneDataCatalogOptions.md +++ /dev/null @@ -1,14 +0,0 @@ -# CloneDataCatalogOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collections** | **list[str]** | | [optional] -**copy_s3** | **bool** | Should the catalog's S3 data also be copied? | [optional] [default to True] -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CloneDataCatalogResult.md b/docs/apis/public/CloneDataCatalogResult.md deleted file mode 100644 index 55a264f6..00000000 --- a/docs/apis/public/CloneDataCatalogResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# CloneDataCatalogResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**clone_task** | [**Task**](Task.md) | | -**data_catalogue** | [**DataCatalogue**](DataCatalogue.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CloneDictionaryOptions.md b/docs/apis/public/CloneDictionaryOptions.md deleted file mode 100644 index d873fc21..00000000 --- a/docs/apis/public/CloneDictionaryOptions.md +++ /dev/null @@ -1,14 +0,0 @@ -# CloneDictionaryOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collections** | **list[str]** | | [optional] -**copy_s3** | **bool** | Should the dictionary's S3 data also be copied? | [optional] [default to True] -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ClonePublicDataCatalogOptions.md b/docs/apis/public/ClonePublicDataCatalogOptions.md deleted file mode 100644 index 954ab2e0..00000000 --- a/docs/apis/public/ClonePublicDataCatalogOptions.md +++ /dev/null @@ -1,15 +0,0 @@ -# ClonePublicDataCatalogOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collections** | **list[str]** | | [optional] -**copy_s3** | **bool** | Should the catalog's S3 data also be copied? | [optional] [default to True] -**description** | **str** | | -**name** | **str** | | -**proj_key** | **str** | The project key of the project to store the resulting data catalogue | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ClonePublicDictionaryOptions.md b/docs/apis/public/ClonePublicDictionaryOptions.md deleted file mode 100644 index 22817550..00000000 --- a/docs/apis/public/ClonePublicDictionaryOptions.md +++ /dev/null @@ -1,15 +0,0 @@ -# ClonePublicDictionaryOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collections** | **list[str]** | | [optional] -**copy_s3** | **bool** | Should the dictionary's S3 data also be copied? | [optional] [default to True] -**description** | **str** | | -**name** | **str** | | -**proj_key** | **str** | The project key of the project to store the resulting dictionary | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CollectionListCoordinates.md b/docs/apis/public/CollectionListCoordinates.md deleted file mode 100644 index f8e4e2a8..00000000 --- a/docs/apis/public/CollectionListCoordinates.md +++ /dev/null @@ -1,10 +0,0 @@ -# CollectionListCoordinates - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collections** | **list[str]** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CollectionMetadataSettings.md b/docs/apis/public/CollectionMetadataSettings.md deleted file mode 100644 index 04b294e6..00000000 --- a/docs/apis/public/CollectionMetadataSettings.md +++ /dev/null @@ -1,14 +0,0 @@ -# CollectionMetadataSettings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | [optional] -**display_name** | **str** | | [optional] -**licence** | **str** | | [optional] -**source** | **str** | | [optional] -**version** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CpsModelReference.md b/docs/apis/public/CpsModelReference.md deleted file mode 100644 index 2f0011a3..00000000 --- a/docs/apis/public/CpsModelReference.md +++ /dev/null @@ -1,11 +0,0 @@ -# CpsModelReference - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**model_config_key** | **str** | | -**proj_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CpsPackage.md b/docs/apis/public/CpsPackage.md deleted file mode 100644 index 4e4ac75d..00000000 --- a/docs/apis/public/CpsPackage.md +++ /dev/null @@ -1,14 +0,0 @@ -# CpsPackage - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dependencies** | **list[str]** | | -**description** | **str** | | -**name** | **str** | | -**package_id** | **str** | | -**type** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CpsTask.md b/docs/apis/public/CpsTask.md deleted file mode 100644 index d82be6c0..00000000 --- a/docs/apis/public/CpsTask.md +++ /dev/null @@ -1,12 +0,0 @@ -# CpsTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**task_id** | **str** | | -**task_status** | **str** | | -**task_type** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateCollectionInDictionaryOptions.md b/docs/apis/public/CreateCollectionInDictionaryOptions.md deleted file mode 100644 index 8d3d8a19..00000000 --- a/docs/apis/public/CreateCollectionInDictionaryOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# CreateCollectionInDictionaryOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection_name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateDataCatalogCollectionOptions.md b/docs/apis/public/CreateDataCatalogCollectionOptions.md deleted file mode 100644 index 89511314..00000000 --- a/docs/apis/public/CreateDataCatalogCollectionOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# CreateDataCatalogCollectionOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection_name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateDataCatalogOptions.md b/docs/apis/public/CreateDataCatalogOptions.md deleted file mode 100644 index 3e30e068..00000000 --- a/docs/apis/public/CreateDataCatalogOptions.md +++ /dev/null @@ -1,15 +0,0 @@ -# CreateDataCatalogOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category_schemas** | [**list[DataCatalogCategorySchema]**](DataCatalogCategorySchema.md) | | [optional] -**collections_data_flows** | [**list[DataCatalogDataFlow]**](DataCatalogDataFlow.md) | | [optional] -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | -**topologydata_flows** | [**list[DataCatalogTopology]**](DataCatalogTopology.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateDataFlowTemplateOptions.md b/docs/apis/public/CreateDataFlowTemplateOptions.md deleted file mode 100644 index 82d4a5f9..00000000 --- a/docs/apis/public/CreateDataFlowTemplateOptions.md +++ /dev/null @@ -1,14 +0,0 @@ -# CreateDataFlowTemplateOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | -**template** | [**DataFlowTemplate**](DataFlowTemplate.md) | | -**variables** | [**dict(str, ProjectProjKeyKgcDataflowTemplatesVariables)**](ProjectProjKeyKgcDataflowTemplatesVariables.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateDictionaryOptions.md b/docs/apis/public/CreateDictionaryOptions.md deleted file mode 100644 index 5959032a..00000000 --- a/docs/apis/public/CreateDictionaryOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateDictionaryOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateKnowledgeGraphOptions.md b/docs/apis/public/CreateKnowledgeGraphOptions.md deleted file mode 100644 index 1606eebf..00000000 --- a/docs/apis/public/CreateKnowledgeGraphOptions.md +++ /dev/null @@ -1,13 +0,0 @@ -# CreateKnowledgeGraphOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | Description of the BAG | [optional] -**flavours** | **list[str]** | Flavours names of the bag. Determines its available resources | -**name** | **str** | Name of the BAG | -**public** | **bool** | If true, the BAG will be publicly available | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateKnowledgeGraphOptions1.md b/docs/apis/public/CreateKnowledgeGraphOptions1.md deleted file mode 100644 index 5a60e866..00000000 --- a/docs/apis/public/CreateKnowledgeGraphOptions1.md +++ /dev/null @@ -1,13 +0,0 @@ -# CreateKnowledgeGraphOptions1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | Description of the BAG | [optional] -**flavour** | **str** | \"Flavour\" of the BAG, determines its available resources. | -**name** | **str** | Name of the BAG | -**public** | **bool** | If true, the BAG will be publicly available | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateProjectModelConfigOptions.md b/docs/apis/public/CreateProjectModelConfigOptions.md deleted file mode 100644 index 2cb8a926..00000000 --- a/docs/apis/public/CreateProjectModelConfigOptions.md +++ /dev/null @@ -1,14 +0,0 @@ -# CreateProjectModelConfigOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**configurations** | [**ProjectProjKeyModelConfigsConfigurations**](ProjectProjKeyModelConfigsConfigurations.md) | | -**description** | **str** | | -**model_config_key** | **str** | | [optional] -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogCategorySchema.md b/docs/apis/public/DataCatalogCategorySchema.md deleted file mode 100644 index c33487f8..00000000 --- a/docs/apis/public/DataCatalogCategorySchema.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogCategorySchema - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**key** | **str** | | -**schema** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogCollection.md b/docs/apis/public/DataCatalogCollection.md deleted file mode 100644 index 7023e52d..00000000 --- a/docs/apis/public/DataCatalogCollection.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogCollection - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**item_count** | **int** | | -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogDataFlow.md b/docs/apis/public/DataCatalogDataFlow.md deleted file mode 100644 index 6f32a327..00000000 --- a/docs/apis/public/DataCatalogDataFlow.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogDataFlow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flows** | **list[object]** | | -**key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogImportOptions.md b/docs/apis/public/DataCatalogImportOptions.md deleted file mode 100644 index 4ebe9ae6..00000000 --- a/docs/apis/public/DataCatalogImportOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogImportOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**options** | [**ProjectProjKeyDataCataloguesFromMongoOptions**](ProjectProjKeyDataCataloguesFromMongoOptions.md) | | -**target** | [**ProjectProjKeyDataCataloguesFromMongoTarget**](ProjectProjKeyDataCataloguesFromMongoTarget.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogImportResult.md b/docs/apis/public/DataCatalogImportResult.md deleted file mode 100644 index 32553551..00000000 --- a/docs/apis/public/DataCatalogImportResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogImportResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_catalogue** | [**DataCatalogue**](DataCatalogue.md) | | -**import_task** | [**Task**](Task.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogProvenanceLog.md b/docs/apis/public/DataCatalogProvenanceLog.md deleted file mode 100644 index 76a12361..00000000 --- a/docs/apis/public/DataCatalogProvenanceLog.md +++ /dev/null @@ -1,13 +0,0 @@ -# DataCatalogProvenanceLog - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection_name** | **str** | | -**source** | [**DataCatalogProvenanceLogSource**](DataCatalogProvenanceLogSource.md) | | -**timestamp** | **float** | | -**user** | [**DataCatalogProvenanceLogUser**](DataCatalogProvenanceLogUser.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogProvenanceLogSource.md b/docs/apis/public/DataCatalogProvenanceLogSource.md deleted file mode 100644 index e4188498..00000000 --- a/docs/apis/public/DataCatalogProvenanceLogSource.md +++ /dev/null @@ -1,15 +0,0 @@ -# DataCatalogProvenanceLogSource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ccs** | [**object**](.md) | | [optional] -**clone** | [**object**](.md) | | [optional] -**elastic** | [**object**](.md) | | [optional] -**file** | [**object**](.md) | | [optional] -**mongo_s3** | [**object**](.md) | | [optional] -**url** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogProvenanceLogUser.md b/docs/apis/public/DataCatalogProvenanceLogUser.md deleted file mode 100644 index 999760ac..00000000 --- a/docs/apis/public/DataCatalogProvenanceLogUser.md +++ /dev/null @@ -1,12 +0,0 @@ -# DataCatalogProvenanceLogUser - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**email** | **str** | | -**name** | **str** | | -**user_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogSchema.md b/docs/apis/public/DataCatalogSchema.md deleted file mode 100644 index 82cc9b32..00000000 --- a/docs/apis/public/DataCatalogSchema.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogSchema - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | [optional] -**schema** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogTopology.md b/docs/apis/public/DataCatalogTopology.md deleted file mode 100644 index 6777fddb..00000000 --- a/docs/apis/public/DataCatalogTopology.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogTopology - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**categories** | [**list[DataCatalogTopologyNode]**](DataCatalogTopologyNode.md) | | -**edges** | [**list[DataCatalogTopologyEdge]**](DataCatalogTopologyEdge.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogTopologyEdge.md b/docs/apis/public/DataCatalogTopologyEdge.md deleted file mode 100644 index 83babab9..00000000 --- a/docs/apis/public/DataCatalogTopologyEdge.md +++ /dev/null @@ -1,14 +0,0 @@ -# DataCatalogTopologyEdge - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**source** | **list[str]** | | -**source_field** | **str** | | -**target** | **list[str]** | | -**target_field** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogTopologyNode.md b/docs/apis/public/DataCatalogTopologyNode.md deleted file mode 100644 index e1fef115..00000000 --- a/docs/apis/public/DataCatalogTopologyNode.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogTopologyNode - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_fields** | **list[str]** | | -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogUrlImportOptions.md b/docs/apis/public/DataCatalogUrlImportOptions.md deleted file mode 100644 index 1899a327..00000000 --- a/docs/apis/public/DataCatalogUrlImportOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogUrlImportOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**options** | [**ProjectProjKeyDataCataloguesFromUrlOptions**](ProjectProjKeyDataCataloguesFromUrlOptions.md) | | -**target** | [**ProjectProjKeyDataCataloguesFromMongoTarget**](ProjectProjKeyDataCataloguesFromMongoTarget.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogsApi.md b/docs/apis/public/DataCatalogsApi.md deleted file mode 100644 index 89595474..00000000 --- a/docs/apis/public/DataCatalogsApi.md +++ /dev/null @@ -1,2273 +0,0 @@ -# deepsearch.cps.apis.public.DataCatalogsApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**clone_project_data_catalog**](DataCatalogsApi.md#clone_project_data_catalog) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/actions/clone | -[**clone_public_data_catalog**](DataCatalogsApi.md#clone_public_data_catalog) | **POST** /project/public/data_catalogues/{dc_key}/actions/clone | -[**create_project_data_catalog**](DataCatalogsApi.md#create_project_data_catalog) | **POST** /project/{proj_key}/data_catalogues | -[**create_project_data_catalog_collection**](DataCatalogsApi.md#create_project_data_catalog_collection) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/collections | -[**create_project_data_catalog_delete_token**](DataCatalogsApi.md#create_project_data_catalog_delete_token) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/delete_token | -[**delete_project_data_catalog**](DataCatalogsApi.md#delete_project_data_catalog) | **DELETE** /project/{proj_key}/data_catalogues/{dc_key} | -[**delete_project_data_catalog_collection**](DataCatalogsApi.md#delete_project_data_catalog_collection) | **DELETE** /project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name} | -[**export_dataset**](DataCatalogsApi.md#export_dataset) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/export_dataset | -[**export_project_data_catalog_collection_data**](DataCatalogsApi.md#export_project_data_catalog_collection_data) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/export | -[**export_project_data_catalog_data**](DataCatalogsApi.md#export_project_data_catalog_data) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/actions/export | -[**get_data_catalog_collection_data**](DataCatalogsApi.md#get_data_catalog_collection_data) | **GET** /project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/data | -[**get_project_data_catalog**](DataCatalogsApi.md#get_project_data_catalog) | **GET** /project/{proj_key}/data_catalogues/{dc_key} | -[**get_public_data_catalog**](DataCatalogsApi.md#get_public_data_catalog) | **GET** /project/public/data_catalogues/{dc_key} | -[**import_project_data_catalog_collection_data**](DataCatalogsApi.md#import_project_data_catalog_collection_data) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/import | -[**import_project_data_catalog_data**](DataCatalogsApi.md#import_project_data_catalog_data) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/actions/import | -[**import_project_data_catalog_from_mongo**](DataCatalogsApi.md#import_project_data_catalog_from_mongo) | **POST** /project/{proj_key}/data_catalogues/from_mongo | -[**import_project_data_catalog_from_url**](DataCatalogsApi.md#import_project_data_catalog_from_url) | **POST** /project/{proj_key}/data_catalogues/from_url | -[**infer_project_data_catalog_category_schema**](DataCatalogsApi.md#infer_project_data_catalog_category_schema) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/infer_schema | -[**list_data_catalogs_and_collections_from_schema**](DataCatalogsApi.md#list_data_catalogs_and_collections_from_schema) | **POST** /project/data_catalogues/with_schema | -[**list_known_data_catalog_schemas**](DataCatalogsApi.md#list_known_data_catalog_schemas) | **GET** /project/data_cataloges/known_schemas | -[**list_project_data_catalog_collections**](DataCatalogsApi.md#list_project_data_catalog_collections) | **GET** /project/{proj_key}/data_catalogues/{dc_key}/collections | -[**list_project_data_catalogs**](DataCatalogsApi.md#list_project_data_catalogs) | **GET** /project/{proj_key}/data_catalogues | -[**list_public_data_catalog_collections**](DataCatalogsApi.md#list_public_data_catalog_collections) | **GET** /project/public/data_catalogues/{dc_key}/collections | -[**list_public_data_catalogs**](DataCatalogsApi.md#list_public_data_catalogs) | **GET** /project/public/data_catalogues | -[**patch_project_data_catalog**](DataCatalogsApi.md#patch_project_data_catalog) | **PATCH** /project/{proj_key}/data_catalogues/{dc_key} | -[**upload_project_data_catalog_collection_data**](DataCatalogsApi.md#upload_project_data_catalog_collection_data) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/upload | -[**upload_project_data_catalog_data**](DataCatalogsApi.md#upload_project_data_catalog_data) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/actions/upload | - - -# **clone_project_data_catalog** -> CloneDataCatalogResult clone_project_data_catalog(proj_key, dc_key, options) - - - -Clone an existing data catalogue - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -options = deepsearch.cps.apis.public.CloneDataCatalogOptions() # CloneDataCatalogOptions | - - try: - api_response = api_instance.clone_project_data_catalog(proj_key, dc_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->clone_project_data_catalog: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **options** | [**CloneDataCatalogOptions**](CloneDataCatalogOptions.md)| | - -### Return type - -[**CloneDataCatalogResult**](CloneDataCatalogResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalogue cloned, and data is being copied. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **clone_public_data_catalog** -> CloneDataCatalogResult clone_public_data_catalog(dc_key, options) - - - -Clone an existing public data catalogue - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - dc_key = 'dc_key_example' # str | -options = deepsearch.cps.apis.public.ClonePublicDataCatalogOptions() # ClonePublicDataCatalogOptions | - - try: - api_response = api_instance.clone_public_data_catalog(dc_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->clone_public_data_catalog: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dc_key** | **str**| | - **options** | [**ClonePublicDataCatalogOptions**](ClonePublicDataCatalogOptions.md)| | - -### Return type - -[**CloneDataCatalogResult**](CloneDataCatalogResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalogue cloned, and data is being copied. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_data_catalog** -> DataCatalogue create_project_data_catalog(proj_key, options) - - - -Create an empty data catalog - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -options = deepsearch.cps.apis.public.CreateDataCatalogOptions() # CreateDataCatalogOptions | - - try: - api_response = api_instance.create_project_data_catalog(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->create_project_data_catalog: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | [**CreateDataCatalogOptions**](CreateDataCatalogOptions.md)| | - -### Return type - -[**DataCatalogue**](DataCatalogue.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalog created. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_data_catalog_collection** -> create_project_data_catalog_collection(proj_key, dc_key, body) - - - -Create a collection in a data catalog - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -body = deepsearch.cps.apis.public.CreateDataCatalogCollectionOptions() # CreateDataCatalogCollectionOptions | - - try: - api_instance.create_project_data_catalog_collection(proj_key, dc_key, body) - except ApiException as e: - print("Exception when calling DataCatalogsApi->create_project_data_catalog_collection: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **body** | [**CreateDataCatalogCollectionOptions**](CreateDataCatalogCollectionOptions.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Collection created. | - | -**404** | Dictionary doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_data_catalog_delete_token** -> TokenResponse create_project_data_catalog_delete_token(proj_key, dc_key) - - - -Get a token used to confirm the deletion of a data catalog. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | - - try: - api_response = api_instance.create_project_data_catalog_delete_token(proj_key, dc_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->create_project_data_catalog_delete_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalog deletion token. | - | -**404** | Data flow template not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_data_catalog** -> delete_project_data_catalog(proj_key, dc_key, confirmation_token) - - - -Delete a single data catalog - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -confirmation_token = 'confirmation_token_example' # str | - - try: - api_instance.delete_project_data_catalog(proj_key, dc_key, confirmation_token) - except ApiException as e: - print("Exception when calling DataCatalogsApi->delete_project_data_catalog: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **confirmation_token** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Data catalog deleted. | - | -**404** | Data catalog doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_data_catalog_collection** -> delete_project_data_catalog_collection(proj_key, dc_key, collection_name) - - - -Delete a single data catalog's collection - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -collection_name = 'collection_name_example' # str | - - try: - api_instance.delete_project_data_catalog_collection(proj_key, dc_key, collection_name) - except ApiException as e: - print("Exception when calling DataCatalogsApi->delete_project_data_catalog_collection: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **collection_name** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Collection deleted. | - | -**404** | Collection doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **export_dataset** -> ProjectTask export_dataset(proj_key, bag_key, data) - - - -Export dataset from a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure API key authorization: KGAuth -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'X-CPS-KG-Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['X-CPS-KG-Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -data = deepsearch.cps.apis.public.InlineObject3() # InlineObject3 | - - try: - api_response = api_instance.export_dataset(proj_key, bag_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->export_dataset: %s\n" % e) -``` - -* Api Key Authentication (KGAuth): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure API key authorization: KGAuth -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'X-CPS-KG-Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['X-CPS-KG-Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -data = deepsearch.cps.apis.public.InlineObject3() # InlineObject3 | - - try: - api_response = api_instance.export_dataset(proj_key, bag_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->export_dataset: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **data** | [**InlineObject3**](InlineObject3.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer), [KGAuth](../README.md#KGAuth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task | - | -**404** | Task not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **export_project_data_catalog_collection_data** -> file export_project_data_catalog_collection_data(proj_key, dc_key, collection_name) - - - -Export the contents of a data catalog's collection - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -collection_name = 'collection_name_example' # str | - - try: - api_response = api_instance.export_project_data_catalog_collection_data(proj_key, dc_key, collection_name) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->export_project_data_catalog_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **collection_name** | **str**| | - -### Return type - -**file** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/zip, application/json, application/x-jsonlines - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalog collection contents. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **export_project_data_catalog_data** -> file export_project_data_catalog_data(proj_key, dc_key) - - - -Export the contents of a data catalog. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | - - try: - api_response = api_instance.export_project_data_catalog_data(proj_key, dc_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->export_project_data_catalog_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - -### Return type - -**file** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/zip - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalog contents. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_data_catalog_collection_data** -> get_data_catalog_collection_data(proj_key, dc_key, collection_name, after=after, limit=limit) - - - -Get Data Catalog Collection data. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -collection_name = 'collection_name_example' # str | -after = 'after_example' # str | (optional) -limit = 50 # int | (optional) (default to 50) - - try: - api_instance.get_data_catalog_collection_data(proj_key, dc_key, collection_name, after=after, limit=limit) - except ApiException as e: - print("Exception when calling DataCatalogsApi->get_data_catalog_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **collection_name** | **str**| | - **after** | **str**| | [optional] - **limit** | **int**| | [optional] [default to 50] - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Get Data Catalog Collection data. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_data_catalog** -> DataCatalogue get_project_data_catalog(proj_key, dc_key, include_collections=include_collections) - - - -Get a single data catalogue - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -include_collections = False # bool | (optional) (default to False) - - try: - api_response = api_instance.get_project_data_catalog(proj_key, dc_key, include_collections=include_collections) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->get_project_data_catalog: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **include_collections** | **bool**| | [optional] [default to False] - -### Return type - -[**DataCatalogue**](DataCatalogue.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalogue | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_public_data_catalog** -> DataCatalogue get_public_data_catalog(dc_key, include_collections=include_collections) - - - -Get a single data catalogue that was made public - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - dc_key = 'dc_key_example' # str | -include_collections = False # bool | (optional) (default to False) - - try: - api_response = api_instance.get_public_data_catalog(dc_key, include_collections=include_collections) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->get_public_data_catalog: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dc_key** | **str**| | - **include_collections** | **bool**| | [optional] [default to False] - -### Return type - -[**DataCatalogue**](DataCatalogue.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalogue | - | -**404** | Data catalogue not found or is not public | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **import_project_data_catalog_collection_data** -> Task import_project_data_catalog_collection_data(proj_key, dc_key, collection_name, body) - - - -Import data to a data catalog collection. The collection will be created if it doesn't exist. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -collection_name = 'collection_name_example' # str | -body = deepsearch.cps.apis.public.ImportToDataCatalogCollectionOptions() # ImportToDataCatalogCollectionOptions | - - try: - api_response = api_instance.import_project_data_catalog_collection_data(proj_key, dc_key, collection_name, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->import_project_data_catalog_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **collection_name** | **str**| | - **body** | [**ImportToDataCatalogCollectionOptions**](ImportToDataCatalogCollectionOptions.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data is being processed. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **import_project_data_catalog_data** -> Task import_project_data_catalog_data(proj_key, dc_key, body) - - - -Import data to a data catalog. The collections will be created if they don't exist. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -body = deepsearch.cps.apis.public.ImportToDataCatalogOptions() # ImportToDataCatalogOptions | - - try: - api_response = api_instance.import_project_data_catalog_data(proj_key, dc_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->import_project_data_catalog_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **body** | [**ImportToDataCatalogOptions**](ImportToDataCatalogOptions.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data is being processed. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **import_project_data_catalog_from_mongo** -> DataCatalogImportResult import_project_data_catalog_from_mongo(proj_key, body) - - - -Create a data catalogue from a mongo database - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.DataCatalogImportOptions() # DataCatalogImportOptions | - - try: - api_response = api_instance.import_project_data_catalog_from_mongo(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->import_project_data_catalog_from_mongo: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**DataCatalogImportOptions**](DataCatalogImportOptions.md)| | - -### Return type - -[**DataCatalogImportResult**](DataCatalogImportResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalogue created, and data is being imported. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **import_project_data_catalog_from_url** -> DataCatalogImportResult import_project_data_catalog_from_url(proj_key, body) - - - -Create a data catalogue from a URL to a file - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.DataCatalogUrlImportOptions() # DataCatalogUrlImportOptions | - - try: - api_response = api_instance.import_project_data_catalog_from_url(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->import_project_data_catalog_from_url: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**DataCatalogUrlImportOptions**](DataCatalogUrlImportOptions.md)| | - -### Return type - -[**DataCatalogImportResult**](DataCatalogImportResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalogue created, and data is being imported. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **infer_project_data_catalog_category_schema** -> Task infer_project_data_catalog_category_schema(proj_key, dc_key, collection_name, body) - - - -Infer the schema for a data catalog's collection. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -collection_name = 'collection_name_example' # str | -body = deepsearch.cps.apis.public.InferProjectDataCatalogCategorySchema() # InferProjectDataCatalogCategorySchema | - - try: - api_response = api_instance.infer_project_data_catalog_category_schema(proj_key, dc_key, collection_name, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->infer_project_data_catalog_category_schema: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **collection_name** | **str**| | - **body** | [**InferProjectDataCatalogCategorySchema**](InferProjectDataCatalogCategorySchema.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_data_catalogs_and_collections_from_schema** -> list[DataCatalogue] list_data_catalogs_and_collections_from_schema(schema, proj_key=proj_key) - - - -List data catalogues with specific schema - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - schema = None # dict(str, object) | -proj_key = 'proj_key_example' # str | (optional) - - try: - api_response = api_instance.list_data_catalogs_and_collections_from_schema(schema, proj_key=proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->list_data_catalogs_and_collections_from_schema: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **schema** | [**dict(str, object)**](object.md)| | - **proj_key** | **str**| | [optional] - -### Return type - -[**list[DataCatalogue]**](DataCatalogue.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of data catalogues | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_known_data_catalog_schemas** -> list[DataCatalogSchema] list_known_data_catalog_schemas() - - - -List System Known Data Catalog Schemas. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - - try: - api_response = api_instance.list_known_data_catalog_schemas() - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->list_known_data_catalog_schemas: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[DataCatalogSchema]**](DataCatalogSchema.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of Known Data Catalog Schemas. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_data_catalog_collections** -> list[DataCatalogCollection] list_project_data_catalog_collections(proj_key, dc_key) - - - -Get the collections of a data catalog. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | - - try: - api_response = api_instance.list_project_data_catalog_collections(proj_key, dc_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->list_project_data_catalog_collections: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - -### Return type - -[**list[DataCatalogCollection]**](DataCatalogCollection.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalog collections | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_data_catalogs** -> list[DataCatalogue] list_project_data_catalogs(proj_key, query=query) - - - -List data catalogues for a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -query = 'query_example' # str | (optional) - - try: - api_response = api_instance.list_project_data_catalogs(proj_key, query=query) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->list_project_data_catalogs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **query** | **str**| | [optional] - -### Return type - -[**list[DataCatalogue]**](DataCatalogue.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of data catalogues | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_public_data_catalog_collections** -> list[DataCatalogCollection] list_public_data_catalog_collections(dc_key) - - - -Get the collections of a data catalog. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - dc_key = 'dc_key_example' # str | - - try: - api_response = api_instance.list_public_data_catalog_collections(dc_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->list_public_data_catalog_collections: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dc_key** | **str**| | - -### Return type - -[**list[DataCatalogCollection]**](DataCatalogCollection.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalog collections | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_public_data_catalogs** -> list[DataCatalogue] list_public_data_catalogs(query=query) - - - -List public data catalogues - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - query = 'query_example' # str | (optional) - - try: - api_response = api_instance.list_public_data_catalogs(query=query) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->list_public_data_catalogs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **query** | **str**| | [optional] - -### Return type - -[**list[DataCatalogue]**](DataCatalogue.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of public data catalogues | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_project_data_catalog** -> DataCatalogue patch_project_data_catalog(proj_key, dc_key, options) - - - -Update the metadata of a data catalog. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -options = deepsearch.cps.apis.public.PatchDataCatalogOptions() # PatchDataCatalogOptions | - - try: - api_response = api_instance.patch_project_data_catalog(proj_key, dc_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->patch_project_data_catalog: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **options** | [**PatchDataCatalogOptions**](PatchDataCatalogOptions.md)| | - -### Return type - -[**DataCatalogue**](DataCatalogue.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalog updated. | - | -**404** | Data catalog not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_project_data_catalog_collection_data** -> Task upload_project_data_catalog_collection_data(proj_key, dc_key, collection_name, file) - - - -Upload data to a data catalog collection. The collection will be created if it doesn't exist. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -collection_name = 'collection_name_example' # str | -file = '/path/to/file' # file | - - try: - api_response = api_instance.upload_project_data_catalog_collection_data(proj_key, dc_key, collection_name, file) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->upload_project_data_catalog_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **collection_name** | **str**| | - **file** | **file**| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data is being processed. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_project_data_catalog_data** -> Task upload_project_data_catalog_data(proj_key, dc_key, file) - - - -Upload data to a data catalog. The collection name(s) will be inferred from the file name(s). - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -file = '/path/to/file' # file | - - try: - api_response = api_instance.upload_project_data_catalog_data(proj_key, dc_key, file) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->upload_project_data_catalog_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **file** | **file**| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data is being processed. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/DataCatalogue.md b/docs/apis/public/DataCatalogue.md deleted file mode 100644 index dba37559..00000000 --- a/docs/apis/public/DataCatalogue.md +++ /dev/null @@ -1,22 +0,0 @@ -# DataCatalogue - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category_schemas** | [**list[DataCatalogCategorySchema]**](DataCatalogCategorySchema.md) | | -**collections** | [**list[DataCatalogCollection]**](DataCatalogCollection.md) | | [optional] -**collections_data_flows** | [**list[DataCatalogDataFlow]**](DataCatalogDataFlow.md) | | -**copy_of** | **str** | | -**created_at** | **float** | | -**created_by** | **str** | | -**dc_key** | **str** | | -**description** | **str** | | -**name** | **str** | | -**proj_key** | **str** | | -**provenance_logs** | [**list[DataCatalogProvenanceLog]**](DataCatalogProvenanceLog.md) | | -**public** | **bool** | | -**topology** | [**DataCatalogTopology**](DataCatalogTopology.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCollection.md b/docs/apis/public/DataCollection.md deleted file mode 100644 index 2bb3dc9a..00000000 --- a/docs/apis/public/DataCollection.md +++ /dev/null @@ -1,15 +0,0 @@ -# DataCollection - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**documents** | **float** | | -**health** | **str** | | -**metadata** | [**DataCollectionMetadata**](DataCollectionMetadata.md) | | -**name** | **str** | | -**source** | [**DataCollectionSource**](DataCollectionSource.md) | | [optional] -**status** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCollectionMetadata.md b/docs/apis/public/DataCollectionMetadata.md deleted file mode 100644 index e5cd4ceb..00000000 --- a/docs/apis/public/DataCollectionMetadata.md +++ /dev/null @@ -1,17 +0,0 @@ -# DataCollectionMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**aliases** | **list[str]** | | -**created** | **str** | | -**description** | **str** | | -**domain** | **list[str]** | | -**source** | **str** | | -**storage** | **str** | | [optional] -**type** | **str** | | -**version** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCollectionSource.md b/docs/apis/public/DataCollectionSource.md deleted file mode 100644 index 454180f6..00000000 --- a/docs/apis/public/DataCollectionSource.md +++ /dev/null @@ -1,12 +0,0 @@ -# DataCollectionSource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**elastic_id** | **str** | | [optional] -**index_key** | **str** | | -**proj_key** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlow.md b/docs/apis/public/DataFlow.md deleted file mode 100644 index 854dfc29..00000000 --- a/docs/apis/public/DataFlow.md +++ /dev/null @@ -1,18 +0,0 @@ -# DataFlow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created_at** | **float** | | [optional] -**description** | **str** | | [optional] -**df_tpl_key** | **str** | | [optional] -**name** | **str** | | [optional] -**proj_key** | **str** | | [optional] -**public** | **bool** | | [optional] -**template** | [**object**](.md) | | [optional] -**updated_at** | **float** | | [optional] -**variables** | **dict(str, object)** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowAssembleIntoKnowledgeGraphTask.md b/docs/apis/public/DataFlowAssembleIntoKnowledgeGraphTask.md deleted file mode 100644 index 76db2866..00000000 --- a/docs/apis/public/DataFlowAssembleIntoKnowledgeGraphTask.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataFlowAssembleIntoKnowledgeGraphTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flow** | [**ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow**](ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md) | | [optional] -**timestamp** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowAssembleReport.md b/docs/apis/public/DataFlowAssembleReport.md deleted file mode 100644 index 76a06d18..00000000 --- a/docs/apis/public/DataFlowAssembleReport.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataFlowAssembleReport - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dataflow_tasks** | [**dict(str, DataFlowAssembleReportSingleTask)**](DataFlowAssembleReportSingleTask.md) | | [optional] -**task_id** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowAssembleReportCause.md b/docs/apis/public/DataFlowAssembleReportCause.md deleted file mode 100644 index 3ae90245..00000000 --- a/docs/apis/public/DataFlowAssembleReportCause.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataFlowAssembleReportCause - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | [optional] -**value** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowAssembleReportChunks.md b/docs/apis/public/DataFlowAssembleReportChunks.md deleted file mode 100644 index cfd50e28..00000000 --- a/docs/apis/public/DataFlowAssembleReportChunks.md +++ /dev/null @@ -1,14 +0,0 @@ -# DataFlowAssembleReportChunks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**completed** | **int** | | [optional] -**failure** | **int** | | [optional] -**spawned** | **int** | | [optional] -**success** | **int** | | [optional] -**total** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowAssembleReportErrors.md b/docs/apis/public/DataFlowAssembleReportErrors.md deleted file mode 100644 index dd885616..00000000 --- a/docs/apis/public/DataFlowAssembleReportErrors.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataFlowAssembleReportErrors - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cause** | [**DataFlowAssembleReportCause**](DataFlowAssembleReportCause.md) | | [optional] -**timestamp** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowAssembleReportOptions.md b/docs/apis/public/DataFlowAssembleReportOptions.md deleted file mode 100644 index 075f4b5b..00000000 --- a/docs/apis/public/DataFlowAssembleReportOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataFlowAssembleReportOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**event_log_level** | **str** | | [optional] [default to 'error'] -**max_errors** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowAssembleReportSingleTask.md b/docs/apis/public/DataFlowAssembleReportSingleTask.md deleted file mode 100644 index 06e66fa6..00000000 --- a/docs/apis/public/DataFlowAssembleReportSingleTask.md +++ /dev/null @@ -1,14 +0,0 @@ -# DataFlowAssembleReportSingleTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chunks** | [**DataFlowAssembleReportChunks**](DataFlowAssembleReportChunks.md) | | [optional] -**errors** | [**list[DataFlowAssembleReportErrors]**](DataFlowAssembleReportErrors.md) | | [optional] -**progress** | **float** | | [optional] -**status** | **str** | | [optional] -**task_type** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowLoadIntoKnowledgeGraphTask.md b/docs/apis/public/DataFlowLoadIntoKnowledgeGraphTask.md deleted file mode 100644 index 4ff3e855..00000000 --- a/docs/apis/public/DataFlowLoadIntoKnowledgeGraphTask.md +++ /dev/null @@ -1,12 +0,0 @@ -# DataFlowLoadIntoKnowledgeGraphTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flow** | [**ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow**](ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md) | | [optional] -**save** | [**object**](.md) | | [optional] -**timestamp** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowTemplate.md b/docs/apis/public/DataFlowTemplate.md deleted file mode 100644 index 21f7ac51..00000000 --- a/docs/apis/public/DataFlowTemplate.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataFlowTemplate - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**config** | [**object**](.md) | | -**data_flow** | **list[object]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowTemplateListItem.md b/docs/apis/public/DataFlowTemplateListItem.md deleted file mode 100644 index 2311da37..00000000 --- a/docs/apis/public/DataFlowTemplateListItem.md +++ /dev/null @@ -1,16 +0,0 @@ -# DataFlowTemplateListItem - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created_at** | **float** | | [optional] -**description** | **str** | | [optional] -**df_tpl_key** | **str** | | [optional] -**name** | **str** | | [optional] -**proj_key** | **str** | | [optional] -**public** | **bool** | | [optional] -**updated_at** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowTemplateVariable.md b/docs/apis/public/DataFlowTemplateVariable.md deleted file mode 100644 index bf7c3f25..00000000 --- a/docs/apis/public/DataFlowTemplateVariable.md +++ /dev/null @@ -1,9 +0,0 @@ -# DataFlowTemplateVariable - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowTopologyOptions.md b/docs/apis/public/DataFlowTopologyOptions.md deleted file mode 100644 index 4957eec7..00000000 --- a/docs/apis/public/DataFlowTopologyOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# DataFlowTopologyOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**variables** | **dict(str, object)** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowsApi.md b/docs/apis/public/DataFlowsApi.md deleted file mode 100644 index 34c145ef..00000000 --- a/docs/apis/public/DataFlowsApi.md +++ /dev/null @@ -1,1718 +0,0 @@ -# deepsearch.cps.apis.public.DataFlowsApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**assemble_project_data_flow**](DataFlowsApi.md#assemble_project_data_flow) | **POST** /project/{proj_key}/kgc/dataflows/actions/run | -[**assemble_project_data_flow_template_into_knowledge_graph**](DataFlowsApi.md#assemble_project_data_flow_template_into_knowledge_graph) | **POST** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/run | -[**assemble_project_raw_data_flow_template_into_knowledge_graph**](DataFlowsApi.md#assemble_project_raw_data_flow_template_into_knowledge_graph) | **POST** /project/{proj_key}/kgc/raw_dataflow_templates/actions/run | -[**create_project_data_flow_template**](DataFlowsApi.md#create_project_data_flow_template) | **POST** /project/{proj_key}/kgc/dataflow_templates | -[**create_project_data_flow_template_delete_token**](DataFlowsApi.md#create_project_data_flow_template_delete_token) | **POST** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/delete_token | -[**create_project_knowledge_graph_assemble_report**](DataFlowsApi.md#create_project_knowledge_graph_assemble_report) | **POST** /project/{proj_key}/dataset_assembles/{task_id}/report | -[**debug_project_data_flow_template**](DataFlowsApi.md#debug_project_data_flow_template) | **POST** /project/{proj_key}/kgc_dataflow_templates/debug/{df_tpl_key} | -[**delete_project_data_flow_template**](DataFlowsApi.md#delete_project_data_flow_template) | **DELETE** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key} | -[**export_project_data_flow_template**](DataFlowsApi.md#export_project_data_flow_template) | **POST** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/export.json | -[**export_public_data_flow_template**](DataFlowsApi.md#export_public_data_flow_template) | **POST** /project/public/kgc/dataflow_templates/{df_tpl_key}/export.json | -[**get_project_data_flow**](DataFlowsApi.md#get_project_data_flow) | **GET** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key} | -[**get_project_data_flow_template_topology**](DataFlowsApi.md#get_project_data_flow_template_topology) | **POST** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/topology | -[**get_public_data_flow_template**](DataFlowsApi.md#get_public_data_flow_template) | **GET** /project/public/kgc/dataflow_templates/{df_tpl_key} | -[**list_project_data_flow_templates**](DataFlowsApi.md#list_project_data_flow_templates) | **GET** /project/{proj_key}/kgc/dataflow_templates | -[**list_public_data_flow_templates**](DataFlowsApi.md#list_public_data_flow_templates) | **GET** /project/public/kgc/dataflow_templates | -[**load_project_data_flow**](DataFlowsApi.md#load_project_data_flow) | **POST** /project/{proj_key}/kgc/dataflows/actions/load | -[**load_project_data_flow_template_into_knowledge_graph**](DataFlowsApi.md#load_project_data_flow_template_into_knowledge_graph) | **POST** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/load | -[**render_project_data_flow_template**](DataFlowsApi.md#render_project_data_flow_template) | **POST** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/render | -[**update_project_data_flow_template**](DataFlowsApi.md#update_project_data_flow_template) | **PUT** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key} | -[**upload_project_data_flow_template**](DataFlowsApi.md#upload_project_data_flow_template) | **POST** /project/{proj_key}/kgc/dataflow_templates/from_json | -[**validate_project_data_flow**](DataFlowsApi.md#validate_project_data_flow) | **POST** /project/{proj_key}/kgc/dataflows/actions/validate | - - -# **assemble_project_data_flow** -> Task assemble_project_data_flow(proj_key, dataflow) - - - -Run a dataflow - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -dataflow = deepsearch.cps.apis.public.KgcDataInput() # KgcDataInput | - - try: - api_response = api_instance.assemble_project_data_flow(proj_key, dataflow) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->assemble_project_data_flow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dataflow** | [**KgcDataInput**](KgcDataInput.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **assemble_project_data_flow_template_into_knowledge_graph** -> Task assemble_project_data_flow_template_into_knowledge_graph(proj_key, df_tpl_key, options) - - - -Render a single data flow template, replacing the variable placeholders by their actual values and run it. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | -options = deepsearch.cps.apis.public.RunDataFlowTemplateOptions() # RunDataFlowTemplateOptions | - - try: - api_response = api_instance.assemble_project_data_flow_template_into_knowledge_graph(proj_key, df_tpl_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->assemble_project_data_flow_template_into_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - **options** | [**RunDataFlowTemplateOptions**](RunDataFlowTemplateOptions.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **assemble_project_raw_data_flow_template_into_knowledge_graph** -> Task assemble_project_raw_data_flow_template_into_knowledge_graph(proj_key, options) - - - -Render a single data flow template, replacing the variable placeholders by their actual values and run it. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -options = deepsearch.cps.apis.public.RunDataFlowTemplateOptions1() # RunDataFlowTemplateOptions1 | - - try: - api_response = api_instance.assemble_project_raw_data_flow_template_into_knowledge_graph(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->assemble_project_raw_data_flow_template_into_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | [**RunDataFlowTemplateOptions1**](RunDataFlowTemplateOptions1.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_data_flow_template** -> DataFlow create_project_data_flow_template(proj_key, options) - - - -Create a data flow template - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -options = deepsearch.cps.apis.public.CreateDataFlowTemplateOptions() # CreateDataFlowTemplateOptions | - - try: - api_response = api_instance.create_project_data_flow_template(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->create_project_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | [**CreateDataFlowTemplateOptions**](CreateDataFlowTemplateOptions.md)| | - -### Return type - -[**DataFlow**](DataFlow.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dataflow created. | - | -**400** | Invalid dataflow. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_data_flow_template_delete_token** -> TokenResponse create_project_data_flow_template_delete_token(proj_key, df_tpl_key) - - - -Get a token used to confirm the deletion of a data flow template. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | - - try: - api_response = api_instance.create_project_data_flow_template_delete_token(proj_key, df_tpl_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->create_project_data_flow_template_delete_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data flow deletion token. | - | -**404** | Data flow template not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_knowledge_graph_assemble_report** -> DataFlowAssembleReport create_project_knowledge_graph_assemble_report(proj_key, task_id, options) - - - -Create a report for a data flow task assemble. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -task_id = 'task_id_example' # str | -options = deepsearch.cps.apis.public.DataFlowAssembleReportOptions() # DataFlowAssembleReportOptions | - - try: - api_response = api_instance.create_project_knowledge_graph_assemble_report(proj_key, task_id, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->create_project_knowledge_graph_assemble_report: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **task_id** | **str**| | - **options** | [**DataFlowAssembleReportOptions**](DataFlowAssembleReportOptions.md)| | - -### Return type - -[**DataFlowAssembleReport**](DataFlowAssembleReport.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Report. | - | -**404** | Task not found, or is not a data flow assemble. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **debug_project_data_flow_template** -> object debug_project_data_flow_template(proj_key, df_tpl_key, options) - - - -(Debug) get the fully rendered data flow, with all the coordinates set. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | -options = deepsearch.cps.apis.public.FullyRenderedDataFlow() # FullyRenderedDataFlow | - - try: - api_response = api_instance.debug_project_data_flow_template(proj_key, df_tpl_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->debug_project_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - **options** | [**FullyRenderedDataFlow**](FullyRenderedDataFlow.md)| | - -### Return type - -**object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Rendered data flow. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_data_flow_template** -> delete_project_data_flow_template(proj_key, df_tpl_key, confirmation_token) - - - -Delete a single data flow template - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | -confirmation_token = 'confirmation_token_example' # str | - - try: - api_instance.delete_project_data_flow_template(proj_key, df_tpl_key, confirmation_token) - except ApiException as e: - print("Exception when calling DataFlowsApi->delete_project_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - **confirmation_token** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Data flow deleted. | - | -**404** | Data flow template doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **export_project_data_flow_template** -> file export_project_data_flow_template(proj_key, df_tpl_key) - - - -Export a single data flow template - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | - - try: - api_response = api_instance.export_project_data_flow_template(proj_key, df_tpl_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->export_project_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - -### Return type - -**file** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.ibm.cps.df-template+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data flow template. | - | -**404** | Data flow template doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **export_public_data_flow_template** -> file export_public_data_flow_template(df_tpl_key) - - - -Export a single public data flow template - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - df_tpl_key = 'df_tpl_key_example' # str | - - try: - api_response = api_instance.export_public_data_flow_template(df_tpl_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->export_public_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **df_tpl_key** | **str**| | - -### Return type - -**file** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.ibm.cps.df-template+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data flow template. | - | -**404** | Data flow template doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_data_flow** -> DataFlow get_project_data_flow(proj_key, df_tpl_key) - - - -Get a single data flow template - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | - - try: - api_response = api_instance.get_project_data_flow(proj_key, df_tpl_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->get_project_data_flow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - -### Return type - -[**DataFlow**](DataFlow.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data flow template. | - | -**404** | Data flow template doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_data_flow_template_topology** -> Topology get_project_data_flow_template_topology(proj_key, df_tpl_key, options) - - - -Render a single data flow template, replacing the variable placeholders by their actual values and get the resulting Knowledge Graph topology from it. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | -options = deepsearch.cps.apis.public.DataFlowTopologyOptions() # DataFlowTopologyOptions | - - try: - api_response = api_instance.get_project_data_flow_template_topology(proj_key, df_tpl_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->get_project_data_flow_template_topology: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - **options** | [**DataFlowTopologyOptions**](DataFlowTopologyOptions.md)| | - -### Return type - -[**Topology**](Topology.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data flow topology. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_public_data_flow_template** -> DataFlow get_public_data_flow_template(df_tpl_key) - - - -Get a single data flow template - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - df_tpl_key = 'df_tpl_key_example' # str | - - try: - api_response = api_instance.get_public_data_flow_template(df_tpl_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->get_public_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **df_tpl_key** | **str**| | - -### Return type - -[**DataFlow**](DataFlow.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data flow. | - | -**404** | Data flow template doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_data_flow_templates** -> list[DataFlowTemplateListItem] list_project_data_flow_templates(proj_key, query=query) - - - -List a data flow templates - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -query = 'query_example' # str | (optional) - - try: - api_response = api_instance.list_project_data_flow_templates(proj_key, query=query) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->list_project_data_flow_templates: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **query** | **str**| | [optional] - -### Return type - -[**list[DataFlowTemplateListItem]**](DataFlowTemplateListItem.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of data flow templates. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_public_data_flow_templates** -> list[DataFlowTemplateListItem] list_public_data_flow_templates(query=query) - - - -List public data flow templates - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - query = 'query_example' # str | (optional) - - try: - api_response = api_instance.list_public_data_flow_templates(query=query) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->list_public_data_flow_templates: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **query** | **str**| | [optional] - -### Return type - -[**list[DataFlowTemplateListItem]**](DataFlowTemplateListItem.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of data flow templates. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **load_project_data_flow** -> Task load_project_data_flow(proj_key, options) - - - -Load a dataflow into a KG - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -options = deepsearch.cps.apis.public.LoadKgcDataInput() # LoadKgcDataInput | - - try: - api_response = api_instance.load_project_data_flow(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->load_project_data_flow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | [**LoadKgcDataInput**](LoadKgcDataInput.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **load_project_data_flow_template_into_knowledge_graph** -> Task load_project_data_flow_template_into_knowledge_graph(proj_key, df_tpl_key, options) - - - -Render a single data flow template, replacing the variable placeholders by their actual values and load it into a Knowledge Graph. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | -options = deepsearch.cps.apis.public.LoadDataFlowIntoKnowledgeGraphOptions1() # LoadDataFlowIntoKnowledgeGraphOptions1 | - - try: - api_response = api_instance.load_project_data_flow_template_into_knowledge_graph(proj_key, df_tpl_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->load_project_data_flow_template_into_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - **options** | [**LoadDataFlowIntoKnowledgeGraphOptions1**](LoadDataFlowIntoKnowledgeGraphOptions1.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **render_project_data_flow_template** -> object render_project_data_flow_template(proj_key, df_tpl_key, options) - - - -Render a single data flow template, replacing the variable placeholders by their actual values. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | -options = deepsearch.cps.apis.public.RenderDataFlowTemplateOptions() # RenderDataFlowTemplateOptions | - - try: - api_response = api_instance.render_project_data_flow_template(proj_key, df_tpl_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->render_project_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - **options** | [**RenderDataFlowTemplateOptions**](RenderDataFlowTemplateOptions.md)| | - -### Return type - -**object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Rendered data flow | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_data_flow_template** -> DataFlow update_project_data_flow_template(proj_key, df_tpl_key, options) - - - -Update a data flow template - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | -options = deepsearch.cps.apis.public.UpdateDataFlowOptions() # UpdateDataFlowOptions | - - try: - api_response = api_instance.update_project_data_flow_template(proj_key, df_tpl_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->update_project_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - **options** | [**UpdateDataFlowOptions**](UpdateDataFlowOptions.md)| | - -### Return type - -[**DataFlow**](DataFlow.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dataflow updated. | - | -**400** | Invalid dataflow. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_project_data_flow_template** -> DataFlow upload_project_data_flow_template(proj_key, contents, name=name, description=description, public=public) - - - -Create a data flow template from a JSON file. **DEPRECATED**: use `create_project_data_flow_template` - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -contents = '/path/to/file' # file | -name = 'name_example' # str | (optional) -description = 'description_example' # str | (optional) -public = True # bool | (optional) - - try: - api_response = api_instance.upload_project_data_flow_template(proj_key, contents, name=name, description=description, public=public) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->upload_project_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **contents** | **file**| | - **name** | **str**| | [optional] - **description** | **str**| | [optional] - **public** | **bool**| | [optional] - -### Return type - -[**DataFlow**](DataFlow.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dataflow created. | - | -**400** | Invalid dataflow. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **validate_project_data_flow** -> validate_project_data_flow(proj_key, dataflow) - - - -Validate a dataflow - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -dataflow = deepsearch.cps.apis.public.KgcDataInput() # KgcDataInput | - - try: - api_instance.validate_project_data_flow(proj_key, dataflow) - except ApiException as e: - print("Exception when calling DataFlowsApi->validate_project_data_flow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dataflow** | [**KgcDataInput**](KgcDataInput.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Validation successful. | - | -**400** | Invalid dataflow. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/DataIndexUploadFileSource.md b/docs/apis/public/DataIndexUploadFileSource.md deleted file mode 100644 index 88defe08..00000000 --- a/docs/apis/public/DataIndexUploadFileSource.md +++ /dev/null @@ -1,13 +0,0 @@ -# DataIndexUploadFileSource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**conversion_settings** | [**ProjectDataIndexConversionSettings**](ProjectDataIndexConversionSettings.md) | | [optional] -**file_url** | **list[str]** | List of File's URL to be converted and uploaded to the data index | [optional] -**s3_source** | [**ProjectProjKeyDataIndicesIndexKeyActionsCcsConvertUploadS3Source**](ProjectProjKeyDataIndicesIndexKeyActionsCcsConvertUploadS3Source.md) | | [optional] -**scratch_files_id** | **list[str]** | List of CCS's scratch files id to be converted and uploaded to the data index | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataIndexUploadFileSource1.md b/docs/apis/public/DataIndexUploadFileSource1.md deleted file mode 100644 index 78c7dc00..00000000 --- a/docs/apis/public/DataIndexUploadFileSource1.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataIndexUploadFileSource1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**conversion_settings** | [**ProjectDataIndexConversionSettings**](ProjectDataIndexConversionSettings.md) | | [optional] -**urls** | **list[object]** | List of URLs to be printed to PDF, converted and uploaded to the data index | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataIndicesApi.md b/docs/apis/public/DataIndicesApi.md deleted file mode 100644 index fe3849f6..00000000 --- a/docs/apis/public/DataIndicesApi.md +++ /dev/null @@ -1,915 +0,0 @@ -# deepsearch.cps.apis.public.DataIndicesApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**ccs_convert_upload_file_project_data_index**](DataIndicesApi.md#ccs_convert_upload_file_project_data_index) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload | -[**create_project_data_index**](DataIndicesApi.md#create_project_data_index) | **POST** /project/{proj_key}/data_indices | -[**create_project_data_index_delete_token**](DataIndicesApi.md#create_project_data_index_delete_token) | **POST** /project/{proj_key}/data_indices/{index_key}/delete_token | -[**delete_project_data_index**](DataIndicesApi.md#delete_project_data_index) | **DELETE** /project/{proj_key}/data_indices/{index_key} | -[**get_attachment_upload_data**](DataIndicesApi.md#get_attachment_upload_data) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename} | -[**get_project_data_index**](DataIndicesApi.md#get_project_data_index) | **GET** /project/{proj_key}/data_indices/{index_key} | -[**get_project_data_indices**](DataIndicesApi.md#get_project_data_indices) | **GET** /project/{proj_key}/data_indices | -[**html_print_convert_upload**](DataIndicesApi.md#html_print_convert_upload) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload | -[**register_attachment**](DataIndicesApi.md#register_attachment) | **POST** /project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment | -[**update_project_data_index**](DataIndicesApi.md#update_project_data_index) | **PATCH** /project/{proj_key}/data_indices/{index_key} | -[**upload_project_data_index_file**](DataIndicesApi.md#upload_project_data_index_file) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/upload | - - -# **ccs_convert_upload_file_project_data_index** -> CpsTask ccs_convert_upload_file_project_data_index(proj_key, index_key, body) - - - -Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema) - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | -body = deepsearch.cps.apis.public.DataIndexUploadFileSource() # DataIndexUploadFileSource | - - try: - api_response = api_instance.ccs_convert_upload_file_project_data_index(proj_key, index_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->ccs_convert_upload_file_project_data_index: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - **body** | [**DataIndexUploadFileSource**](DataIndexUploadFileSource.md)| | - -### Return type - -[**CpsTask**](CpsTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | CPS task info | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_data_index** -> ProjectDataIndexWithStatus create_project_data_index(proj_key, data) - - - -Create a project data index - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -data = None # object | - - try: - api_response = api_instance.create_project_data_index(proj_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->create_project_data_index: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **data** | **object**| | - -### Return type - -[**ProjectDataIndexWithStatus**](ProjectDataIndexWithStatus.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Project data index. | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_data_index_delete_token** -> TokenResponse create_project_data_index_delete_token(proj_key, index_key) - - - -Get a token used to confirm the deletion of a project data index. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | - - try: - api_response = api_instance.create_project_data_index_delete_token(proj_key, index_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->create_project_data_index_delete_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Project data index deletion token. | - | -**404** | Data flow template not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_data_index** -> delete_project_data_index(proj_key, index_key, confirmation_token) - - - -Delete a project index data - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | -confirmation_token = 'confirmation_token_example' # str | The delete confirmation token - - try: - api_instance.delete_project_data_index(proj_key, index_key, confirmation_token) - except ApiException as e: - print("Exception when calling DataIndicesApi->delete_project_data_index: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - **confirmation_token** | **str**| The delete confirmation token | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Project data index deleted successfully. | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_attachment_upload_data** -> AttachmentUploadData get_attachment_upload_data(proj_key, index_key, index_item_id, filename) - - - -Get url and path to upload an attachment to a project data index - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | -index_item_id = 'index_item_id_example' # str | -filename = 'filename_example' # str | - - try: - api_response = api_instance.get_attachment_upload_data(proj_key, index_key, index_item_id, filename) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->get_attachment_upload_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - **index_item_id** | **str**| | - **filename** | **str**| | - -### Return type - -[**AttachmentUploadData**](AttachmentUploadData.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Attachment upload url and path | - | -**404** | Project data index or document ID not found. | - | -**500** | Error occured on the server | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_data_index** -> ProjectDataIndexWithStatus get_project_data_index(proj_key, index_key) - - - -Get project data index - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | - - try: - api_response = api_instance.get_project_data_index(proj_key, index_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->get_project_data_index: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - -### Return type - -[**ProjectDataIndexWithStatus**](ProjectDataIndexWithStatus.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Project data index. | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_data_indices** -> list[ProjectDataIndexWithStatus] get_project_data_indices(proj_key) - - - -Get project data indices - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | - - try: - api_response = api_instance.get_project_data_indices(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->get_project_data_indices: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - -### Return type - -[**list[ProjectDataIndexWithStatus]**](ProjectDataIndexWithStatus.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Project data indices. | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **html_print_convert_upload** -> CpsTask html_print_convert_upload(proj_key, index_key, body) - - - -Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema) - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | -body = deepsearch.cps.apis.public.DataIndexUploadFileSource1() # DataIndexUploadFileSource1 | - - try: - api_response = api_instance.html_print_convert_upload(proj_key, index_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->html_print_convert_upload: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - **body** | [**DataIndexUploadFileSource1**](DataIndexUploadFileSource1.md)| | - -### Return type - -[**CpsTask**](CpsTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | CPS task info | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **register_attachment** -> register_attachment(proj_key, index_key, index_item_id, params) - - - -Notify upload completion of an attachment to a project data index - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | -index_item_id = 'index_item_id_example' # str | -params = deepsearch.cps.apis.public.InlineObject5() # InlineObject5 | - - try: - api_instance.register_attachment(proj_key, index_key, index_item_id, params) - except ApiException as e: - print("Exception when calling DataIndicesApi->register_attachment: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - **index_item_id** | **str**| | - **params** | [**InlineObject5**](InlineObject5.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Attachment notify successfull | - | -**404** | Project data index or document ID not found. | - | -**500** | Error occured on the server | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_data_index** -> ProjectDataIndexWithStatus update_project_data_index(proj_key, index_key, data) - - - -Update a project data index - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | -data = None # object | - - try: - api_response = api_instance.update_project_data_index(proj_key, index_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->update_project_data_index: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - **data** | **object**| | - -### Return type - -[**ProjectDataIndexWithStatus**](ProjectDataIndexWithStatus.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Updated project data index. | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_project_data_index_file** -> CpsTask upload_project_data_index_file(proj_key, index_key, params) - - - -Upload a file to a project data index - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | -params = deepsearch.cps.apis.public.InlineObject4() # InlineObject4 | - - try: - api_response = api_instance.upload_project_data_index_file(proj_key, index_key, params) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->upload_project_data_index_file: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - **params** | [**InlineObject4**](InlineObject4.md)| | - -### Return type - -[**CpsTask**](CpsTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | CPS task info | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/DictionariesApi.md b/docs/apis/public/DictionariesApi.md deleted file mode 100644 index e8dfdc0d..00000000 --- a/docs/apis/public/DictionariesApi.md +++ /dev/null @@ -1,1730 +0,0 @@ -# deepsearch.cps.apis.public.DictionariesApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**clone_project_dictionary**](DictionariesApi.md#clone_project_dictionary) | **POST** /project/{proj_key}/dictionaries/{dict_key}/actions/clone | -[**clone_public_dictionary**](DictionariesApi.md#clone_public_dictionary) | **POST** /project/public/dictionaries/{dict_key}/actions/clone | -[**create_project_dictionary**](DictionariesApi.md#create_project_dictionary) | **POST** /project/{proj_key}/dictionaries | -[**create_project_dictionary_collection**](DictionariesApi.md#create_project_dictionary_collection) | **POST** /project/{proj_key}/dictionaries/{dict_key}/collections | -[**create_project_dictionary_delete_token**](DictionariesApi.md#create_project_dictionary_delete_token) | **POST** /project/{proj_key}/dictionaries/{dict_key}/delete_token | -[**delete_project_dictionary**](DictionariesApi.md#delete_project_dictionary) | **DELETE** /project/{proj_key}/dictionaries/{dict_key} | -[**delete_project_dictionary_collection**](DictionariesApi.md#delete_project_dictionary_collection) | **DELETE** /project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name} | -[**export_project_dictionary_collection_data**](DictionariesApi.md#export_project_dictionary_collection_data) | **POST** /project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/export | -[**export_project_dictionary_data**](DictionariesApi.md#export_project_dictionary_data) | **POST** /project/{proj_key}/dictionaries/{dict_key}/actions/export | -[**get_project_dictionary**](DictionariesApi.md#get_project_dictionary) | **GET** /project/{proj_key}/dictionaries/{dict_key} | -[**get_project_dictionary_collection_data**](DictionariesApi.md#get_project_dictionary_collection_data) | **GET** /project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/data | -[**get_public_dictionary**](DictionariesApi.md#get_public_dictionary) | **GET** /project/public/dictionaries/{dict_key} | -[**import_project_dictionary_from_mongo**](DictionariesApi.md#import_project_dictionary_from_mongo) | **POST** /project/{proj_key}/dictionaries/from_mongo | -[**list_project_dictionaries**](DictionariesApi.md#list_project_dictionaries) | **GET** /project/{proj_key}/dictionaries | -[**list_project_dictionary_collections**](DictionariesApi.md#list_project_dictionary_collections) | **GET** /project/{proj_key}/dictionaries/{dict_key}/collections | -[**list_public_dictionaries**](DictionariesApi.md#list_public_dictionaries) | **GET** /project/public/dictionaries | -[**list_public_dictionary_collections**](DictionariesApi.md#list_public_dictionary_collections) | **GET** /project/public/dictionaries/{dict_key}/collections | -[**update_project_dictionary**](DictionariesApi.md#update_project_dictionary) | **PATCH** /project/{proj_key}/dictionaries/{dict_key} | -[**update_project_dictionary_collection_data**](DictionariesApi.md#update_project_dictionary_collection_data) | **PATCH** /project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/data | -[**upload_project_dictionary_collection_data**](DictionariesApi.md#upload_project_dictionary_collection_data) | **POST** /project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/upload | -[**upload_project_dictionary_data**](DictionariesApi.md#upload_project_dictionary_data) | **POST** /project/{proj_key}/dictionaries/{dict_key}/actions/upload | - - -# **clone_project_dictionary** -> DictionaryCloneResult clone_project_dictionary(proj_key, dict_key, body) - - - -Clone an existing dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -body = deepsearch.cps.apis.public.CloneDictionaryOptions() # CloneDictionaryOptions | - - try: - api_response = api_instance.clone_project_dictionary(proj_key, dict_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->clone_project_dictionary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **body** | [**CloneDictionaryOptions**](CloneDictionaryOptions.md)| | - -### Return type - -[**DictionaryCloneResult**](DictionaryCloneResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary cloned, and data is being copied. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **clone_public_dictionary** -> DictionaryCloneResult clone_public_dictionary(dict_key, body) - - - -Clone an existing public dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - dict_key = 'dict_key_example' # str | -body = deepsearch.cps.apis.public.ClonePublicDictionaryOptions() # ClonePublicDictionaryOptions | - - try: - api_response = api_instance.clone_public_dictionary(dict_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->clone_public_dictionary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dict_key** | **str**| | - **body** | [**ClonePublicDictionaryOptions**](ClonePublicDictionaryOptions.md)| | - -### Return type - -[**DictionaryCloneResult**](DictionaryCloneResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary cloned, and data is being copied. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_dictionary** -> Dictionary create_project_dictionary(proj_key, body) - - - -Create an empty dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.CreateDictionaryOptions() # CreateDictionaryOptions | - - try: - api_response = api_instance.create_project_dictionary(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->create_project_dictionary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**CreateDictionaryOptions**](CreateDictionaryOptions.md)| | - -### Return type - -[**Dictionary**](Dictionary.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary created. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_dictionary_collection** -> create_project_dictionary_collection(proj_key, dict_key, body) - - - -Create a collection in a dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -body = deepsearch.cps.apis.public.CreateCollectionInDictionaryOptions() # CreateCollectionInDictionaryOptions | - - try: - api_instance.create_project_dictionary_collection(proj_key, dict_key, body) - except ApiException as e: - print("Exception when calling DictionariesApi->create_project_dictionary_collection: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **body** | [**CreateCollectionInDictionaryOptions**](CreateCollectionInDictionaryOptions.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Collection created. | - | -**404** | Dictionary doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_dictionary_delete_token** -> TokenResponse create_project_dictionary_delete_token(proj_key, dict_key) - - - -Get a token used to confirm the deletion of a dictionary. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | - - try: - api_response = api_instance.create_project_dictionary_delete_token(proj_key, dict_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->create_project_dictionary_delete_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary deletion token. | - | -**404** | Data flow template not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_dictionary** -> delete_project_dictionary(proj_key, dict_key, confirmation_token) - - - -Delete a single dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -confirmation_token = 'confirmation_token_example' # str | - - try: - api_instance.delete_project_dictionary(proj_key, dict_key, confirmation_token) - except ApiException as e: - print("Exception when calling DictionariesApi->delete_project_dictionary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **confirmation_token** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Dictionary deleted. | - | -**404** | Dictionary doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_dictionary_collection** -> delete_project_dictionary_collection(proj_key, dict_key, collection_name) - - - -Delete a single dictionary's collection - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -collection_name = 'collection_name_example' # str | - - try: - api_instance.delete_project_dictionary_collection(proj_key, dict_key, collection_name) - except ApiException as e: - print("Exception when calling DictionariesApi->delete_project_dictionary_collection: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **collection_name** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Collection deleted. | - | -**404** | Collection doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **export_project_dictionary_collection_data** -> file export_project_dictionary_collection_data(proj_key, dict_key, collection_name, file_format=file_format) - - - -Export the contents of a dictionary's collection - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -collection_name = 'collection_name_example' # str | -file_format = 'file_format_example' # str | (optional) - - try: - api_response = api_instance.export_project_dictionary_collection_data(proj_key, dict_key, collection_name, file_format=file_format) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->export_project_dictionary_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **collection_name** | **str**| | - **file_format** | **str**| | [optional] - -### Return type - -**file** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/zip, application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary collection contents. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **export_project_dictionary_data** -> file export_project_dictionary_data(proj_key, dict_key) - - - -Export the contents of a dictionary. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | - - try: - api_response = api_instance.export_project_dictionary_data(proj_key, dict_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->export_project_dictionary_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - -### Return type - -**file** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/zip - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary contents. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_dictionary** -> Dictionary get_project_dictionary(proj_key, dict_key, include_collections=include_collections) - - - -Get a single dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -include_collections = False # bool | (optional) (default to False) - - try: - api_response = api_instance.get_project_dictionary(proj_key, dict_key, include_collections=include_collections) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->get_project_dictionary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **include_collections** | **bool**| | [optional] [default to False] - -### Return type - -[**Dictionary**](Dictionary.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_dictionary_collection_data** -> object get_project_dictionary_collection_data(proj_key, dict_key, collection_name, after=after, limit=limit, response_format=response_format) - - - -Get a preview of the data in a dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -collection_name = 'collection_name_example' # str | -after = 'after_example' # str | (optional) -limit = 1000 # int | (optional) (default to 1000) -response_format = 'object' # str | (optional) (default to 'object') - - try: - api_response = api_instance.get_project_dictionary_collection_data(proj_key, dict_key, collection_name, after=after, limit=limit, response_format=response_format) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->get_project_dictionary_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **collection_name** | **str**| | - **after** | **str**| | [optional] - **limit** | **int**| | [optional] [default to 1000] - **response_format** | **str**| | [optional] [default to 'object'] - -### Return type - -**object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary collection contents. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_public_dictionary** -> Dictionary get_public_dictionary(dict_key, include_collections=include_collections) - - - -Get a single dictionary that was made public - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - dict_key = 'dict_key_example' # str | -include_collections = False # bool | (optional) (default to False) - - try: - api_response = api_instance.get_public_dictionary(dict_key, include_collections=include_collections) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->get_public_dictionary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dict_key** | **str**| | - **include_collections** | **bool**| | [optional] [default to False] - -### Return type - -[**Dictionary**](Dictionary.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary | - | -**404** | Dictionary not found or is not public | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **import_project_dictionary_from_mongo** -> DictionaryImportResult import_project_dictionary_from_mongo(proj_key, body) - - - -Create a dictionary from a mongo database - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.DictionaryImportOptions() # DictionaryImportOptions | - - try: - api_response = api_instance.import_project_dictionary_from_mongo(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->import_project_dictionary_from_mongo: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**DictionaryImportOptions**](DictionaryImportOptions.md)| | - -### Return type - -[**DictionaryImportResult**](DictionaryImportResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary created, and data is being imported. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_dictionaries** -> list[Dictionary] list_project_dictionaries(proj_key, query=query) - - - -List dictionaries for a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -query = 'query_example' # str | (optional) - - try: - api_response = api_instance.list_project_dictionaries(proj_key, query=query) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->list_project_dictionaries: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **query** | **str**| | [optional] - -### Return type - -[**list[Dictionary]**](Dictionary.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of dictionaries | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_dictionary_collections** -> list[DictionaryCollection] list_project_dictionary_collections(proj_key, dict_key) - - - -Get the collections of a dictionary. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | - - try: - api_response = api_instance.list_project_dictionary_collections(proj_key, dict_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->list_project_dictionary_collections: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - -### Return type - -[**list[DictionaryCollection]**](DictionaryCollection.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary collections | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_public_dictionaries** -> list[Dictionary] list_public_dictionaries(query=query) - - - -List public dictionaries - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - query = 'query_example' # str | (optional) - - try: - api_response = api_instance.list_public_dictionaries(query=query) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->list_public_dictionaries: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **query** | **str**| | [optional] - -### Return type - -[**list[Dictionary]**](Dictionary.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of public dictionaries | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_public_dictionary_collections** -> list[DictionaryCollection] list_public_dictionary_collections(dict_key) - - - -Get the collections of a dictionary. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - dict_key = 'dict_key_example' # str | - - try: - api_response = api_instance.list_public_dictionary_collections(dict_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->list_public_dictionary_collections: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dict_key** | **str**| | - -### Return type - -[**list[DictionaryCollection]**](DictionaryCollection.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary collections | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_dictionary** -> Dictionary update_project_dictionary(proj_key, dict_key, options) - - - -Update the metadata of a dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -options = deepsearch.cps.apis.public.PatchDictionaryOptions() # PatchDictionaryOptions | - - try: - api_response = api_instance.update_project_dictionary(proj_key, dict_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->update_project_dictionary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **options** | [**PatchDictionaryOptions**](PatchDictionaryOptions.md)| | - -### Return type - -[**Dictionary**](Dictionary.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary updated. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_dictionary_collection_data** -> update_project_dictionary_collection_data(proj_key, dict_key, collection_name, body) - - - -Update the data in a dictionary's collection - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -collection_name = 'collection_name_example' # str | -body = [deepsearch.cps.apis.public.DictionaryCollectionPatch()] # list[DictionaryCollectionPatch] | A subset of JSON Patch operation list. Only `add`, `replace`, and `remove` is supported. See http://jsonpatch.com/ for more details. - - try: - api_instance.update_project_dictionary_collection_data(proj_key, dict_key, collection_name, body) - except ApiException as e: - print("Exception when calling DictionariesApi->update_project_dictionary_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **collection_name** | **str**| | - **body** | [**list[DictionaryCollectionPatch]**](DictionaryCollectionPatch.md)| A subset of JSON Patch operation list. Only `add`, `replace`, and `remove` is supported. See http://jsonpatch.com/ for more details. | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Data updated. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_project_dictionary_collection_data** -> Task upload_project_dictionary_collection_data(proj_key, dict_key, collection_name, file) - - - -Upload data to a dictionary collection. The collection will be created if it doesn't exist. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -collection_name = 'collection_name_example' # str | -file = '/path/to/file' # file | - - try: - api_response = api_instance.upload_project_dictionary_collection_data(proj_key, dict_key, collection_name, file) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->upload_project_dictionary_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **collection_name** | **str**| | - **file** | **file**| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data is being processed. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_project_dictionary_data** -> Task upload_project_dictionary_data(proj_key, dict_key, file) - - - -Upload data to a dictionary. The collection name(s) will be inferred from the file name(s). - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -file = '/path/to/file' # file | - - try: - api_response = api_instance.upload_project_dictionary_data(proj_key, dict_key, file) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->upload_project_dictionary_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **file** | **file**| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data is being processed. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/Dictionary.md b/docs/apis/public/Dictionary.md deleted file mode 100644 index a362521c..00000000 --- a/docs/apis/public/Dictionary.md +++ /dev/null @@ -1,18 +0,0 @@ -# Dictionary - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collections** | [**list[DictionaryCollection]**](DictionaryCollection.md) | | [optional] -**copy_of** | **str** | | -**created_at** | **float** | | -**created_by** | **str** | | -**description** | **str** | | -**dict_key** | **str** | | -**name** | **str** | | -**proj_key** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DictionaryCloneResult.md b/docs/apis/public/DictionaryCloneResult.md deleted file mode 100644 index ff328186..00000000 --- a/docs/apis/public/DictionaryCloneResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# DictionaryCloneResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**clone_task** | [**Task**](Task.md) | | [optional] -**dictionary** | [**Dictionary**](Dictionary.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DictionaryCollection.md b/docs/apis/public/DictionaryCollection.md deleted file mode 100644 index 89a9e51d..00000000 --- a/docs/apis/public/DictionaryCollection.md +++ /dev/null @@ -1,11 +0,0 @@ -# DictionaryCollection - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**item_count** | **int** | | -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DictionaryCollectionCsvData.md b/docs/apis/public/DictionaryCollectionCsvData.md deleted file mode 100644 index 680620ec..00000000 --- a/docs/apis/public/DictionaryCollectionCsvData.md +++ /dev/null @@ -1,11 +0,0 @@ -# DictionaryCollectionCsvData - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**body** | **str** | | -**header** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DictionaryCollectionPatch.md b/docs/apis/public/DictionaryCollectionPatch.md deleted file mode 100644 index 335109fd..00000000 --- a/docs/apis/public/DictionaryCollectionPatch.md +++ /dev/null @@ -1,12 +0,0 @@ -# DictionaryCollectionPatch - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**op** | **str** | | -**path** | **str** | A path (see JSON patch specification) in the format `/{objectid}` for existing objects, or `/-` for new objects (`add` operations). | -**value** | [**DictionaryEntry**](DictionaryEntry.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DictionaryEntry.md b/docs/apis/public/DictionaryEntry.md deleted file mode 100644 index 00ef66be..00000000 --- a/docs/apis/public/DictionaryEntry.md +++ /dev/null @@ -1,11 +0,0 @@ -# DictionaryEntry - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**synonyms** | **list[str]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DictionaryImportOptions.md b/docs/apis/public/DictionaryImportOptions.md deleted file mode 100644 index 0b939cab..00000000 --- a/docs/apis/public/DictionaryImportOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# DictionaryImportOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**options** | [**ProjectProjKeyDataCataloguesFromMongoOptions**](ProjectProjKeyDataCataloguesFromMongoOptions.md) | | -**target** | [**ProjectProjKeyDictionariesFromMongoTarget**](ProjectProjKeyDictionariesFromMongoTarget.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DictionaryImportResult.md b/docs/apis/public/DictionaryImportResult.md deleted file mode 100644 index 1a6581eb..00000000 --- a/docs/apis/public/DictionaryImportResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# DictionaryImportResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dictionary** | [**Dictionary**](Dictionary.md) | | [optional] -**import_task** | [**Task**](Task.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DocumentInspectionApi.md b/docs/apis/public/DocumentInspectionApi.md deleted file mode 100644 index a3de2385..00000000 --- a/docs/apis/public/DocumentInspectionApi.md +++ /dev/null @@ -1,497 +0,0 @@ -# deepsearch.cps.apis.public.DocumentInspectionApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**annotate_document**](DocumentInspectionApi.md#annotate_document) | **POST** /project/{proj_key}/annotate/document | -[**delete_document_annotation_result**](DocumentInspectionApi.md#delete_document_annotation_result) | **DELETE** /project/{proj_key}/annotate/document/results/{document_hash} | -[**get_annotate_document_result**](DocumentInspectionApi.md#get_annotate_document_result) | **GET** /project/{proj_key}/annotate/document/tasks/{task_id} | -[**ingest_documentqa**](DocumentInspectionApi.md#ingest_documentqa) | **POST** /project/{proj_key}/ingest/documentqa | -[**list_project_inspection_report**](DocumentInspectionApi.md#list_project_inspection_report) | **GET** /project/{proj_key}/annotate/inspection_report | -[**report_inspected_document**](DocumentInspectionApi.md#report_inspected_document) | **POST** /project/{proj_key}/annotate/document/report | - - -# **annotate_document** -> Task annotate_document(proj_key, body) - - - -Run an annotator on a document - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.AnnotateDocumentRequest() # AnnotateDocumentRequest | - - try: - api_response = api_instance.annotate_document(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DocumentInspectionApi->annotate_document: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**AnnotateDocumentRequest**](AnnotateDocumentRequest.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_document_annotation_result** -> delete_document_annotation_result(proj_key, document_hash) - - - -Delete annotation results for a document - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) - proj_key = 'proj_key_example' # str | -document_hash = 'document_hash_example' # str | - - try: - api_instance.delete_document_annotation_result(proj_key, document_hash) - except ApiException as e: - print("Exception when calling DocumentInspectionApi->delete_document_annotation_result: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **document_hash** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_annotate_document_result** -> InlineResponse2002 get_annotate_document_result(proj_key, task_id, wait=wait) - - - -Get the result of a previous document annotation - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) - proj_key = 'proj_key_example' # str | -task_id = 'task_id_example' # str | -wait = 3.4 # float | Allow the response to be delayed for a few seconds to wait for the result, instead of doing client-side polling. (optional) - - try: - api_response = api_instance.get_annotate_document_result(proj_key, task_id, wait=wait) - pprint(api_response) - except ApiException as e: - print("Exception when calling DocumentInspectionApi->get_annotate_document_result: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **task_id** | **str**| | - **wait** | **float**| Allow the response to be delayed for a few seconds to wait for the result, instead of doing client-side polling. | [optional] - -### Return type - -[**InlineResponse2002**](InlineResponse2002.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **ingest_documentqa** -> Task ingest_documentqa(proj_key, body) - - - -Ingest a document for QA - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.IngestDocumentQARequest() # IngestDocumentQARequest | - - try: - api_response = api_instance.ingest_documentqa(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DocumentInspectionApi->ingest_documentqa: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**IngestDocumentQARequest**](IngestDocumentQARequest.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_inspection_report** -> list[InspectionReport] list_project_inspection_report(proj_key, page=page, items_per_page=items_per_page, search_string=search_string, begin_date=begin_date, end_date=end_date) - - - -Get paginated list of inspection reports for a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) - proj_key = 'proj_key_example' # str | -page = 56 # int | page of the result list (optional) -items_per_page = 20 # int | items on one page of the result list (optional) (default to 20) -search_string = 'search_string_example' # str | search keyword (optional) -begin_date = 56 # int | begin date of the search date interval (optional) -end_date = 56 # int | end date of the search date interval (optional) - - try: - api_response = api_instance.list_project_inspection_report(proj_key, page=page, items_per_page=items_per_page, search_string=search_string, begin_date=begin_date, end_date=end_date) - pprint(api_response) - except ApiException as e: - print("Exception when calling DocumentInspectionApi->list_project_inspection_report: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **page** | **int**| page of the result list | [optional] - **items_per_page** | **int**| items on one page of the result list | [optional] [default to 20] - **search_string** | **str**| search keyword | [optional] - **begin_date** | **int**| begin date of the search date interval | [optional] - **end_date** | **int**| end date of the search date interval | [optional] - -### Return type - -[**list[InspectionReport]**](InspectionReport.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Reports | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **report_inspected_document** -> Task report_inspected_document(proj_key, body) - - - -Submit a report on an inspected document - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.AnnotatedDocumentReport() # AnnotatedDocumentReport | - - try: - api_response = api_instance.report_inspected_document(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DocumentInspectionApi->report_inspected_document: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**AnnotatedDocumentReport**](AnnotatedDocumentReport.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/ElasticApi.md b/docs/apis/public/ElasticApi.md deleted file mode 100644 index 39b9d592..00000000 --- a/docs/apis/public/ElasticApi.md +++ /dev/null @@ -1,401 +0,0 @@ -# deepsearch.cps.apis.public.ElasticApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_elastic_domains**](ElasticApi.md#get_elastic_domains) | **GET** /elastic/domains | -[**get_elastic_query_max_size**](ElasticApi.md#get_elastic_query_max_size) | **GET** /elastic/query_max_size | -[**get_index_properties**](ElasticApi.md#get_index_properties) | **GET** /elastic/{elastic_instance}/{elastic_index}/properties | -[**get_kibana_saved_queries**](ElasticApi.md#get_kibana_saved_queries) | **GET** /elastic/{elastic_instance}/{elastic_index}/saved_queries | -[**list_indices_from_elastic_instance**](ElasticApi.md#list_indices_from_elastic_instance) | **GET** /elastic/indices/{index_type}/{index_domain} | - - -# **get_elastic_domains** -> list[str] get_elastic_domains() - - - -List system elastic domains. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ElasticApi(api_client) - - try: - api_response = api_instance.get_elastic_domains() - pprint(api_response) - except ApiException as e: - print("Exception when calling ElasticApi->get_elastic_domains: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -**list[str]** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of Elastic Domains. | - | -**404** | Domains not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_elastic_query_max_size** -> InlineResponse200 get_elastic_query_max_size() - - - -Get the system maximum workable elastic query size. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ElasticApi(api_client) - - try: - api_response = api_instance.get_elastic_query_max_size() - pprint(api_response) - except ApiException as e: - print("Exception when calling ElasticApi->get_elastic_query_max_size: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**InlineResponse200**](InlineResponse200.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Maximum elastic query size. | - | -**404** | No maximum workable elastic query size found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_index_properties** -> object get_index_properties(elastic_instance, elastic_index) - - - -Get the property schema of the given index. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ElasticApi(api_client) - elastic_instance = 'elastic_instance_example' # str | -elastic_index = 'elastic_index_example' # str | - - try: - api_response = api_instance.get_index_properties(elastic_instance, elastic_index) - pprint(api_response) - except ApiException as e: - print("Exception when calling ElasticApi->get_index_properties: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **elastic_instance** | **str**| | - **elastic_index** | **str**| | - -### Return type - -**object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Property schema | - | -**404** | Instance index not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_kibana_saved_queries** -> list[KibanaSavedQueriesResult] get_kibana_saved_queries(elastic_instance, elastic_index) - - - -List Kibana saved queries. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ElasticApi(api_client) - elastic_instance = 'elastic_instance_example' # str | -elastic_index = 'elastic_index_example' # str | - - try: - api_response = api_instance.get_kibana_saved_queries(elastic_instance, elastic_index) - pprint(api_response) - except ApiException as e: - print("Exception when calling ElasticApi->get_kibana_saved_queries: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **elastic_instance** | **str**| | - **elastic_index** | **str**| | - -### Return type - -[**list[KibanaSavedQueriesResult]**](KibanaSavedQueriesResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of Kibana saved queries | - | -**404** | Instance indices not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_indices_from_elastic_instance** -> list[DataCollection] list_indices_from_elastic_instance(index_type, index_domain) - - - -List of indices for elastic instance. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ElasticApi(api_client) - index_type = 'all' # str | (default to 'all') -index_domain = 'all' # str | (default to 'all') - - try: - api_response = api_instance.list_indices_from_elastic_instance(index_type, index_domain) - pprint(api_response) - except ApiException as e: - print("Exception when calling ElasticApi->list_indices_from_elastic_instance: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **index_type** | **str**| | [default to 'all'] - **index_domain** | **str**| | [default to 'all'] - -### Return type - -[**list[DataCollection]**](DataCollection.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of Elastic Instance Indices | - | -**404** | Instance indices not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/ElasticCoordinates.md b/docs/apis/public/ElasticCoordinates.md deleted file mode 100644 index b82a22bf..00000000 --- a/docs/apis/public/ElasticCoordinates.md +++ /dev/null @@ -1,12 +0,0 @@ -# ElasticCoordinates - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ca_certificate_base64** | **str** | | [optional] -**dangerously_disable_ssl_validation** | **bool** | | [optional] -**hosts** | **list[str]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ElasticIndexSearchQueryOptions.md b/docs/apis/public/ElasticIndexSearchQueryOptions.md deleted file mode 100644 index afecc59b..00000000 --- a/docs/apis/public/ElasticIndexSearchQueryOptions.md +++ /dev/null @@ -1,15 +0,0 @@ -# ElasticIndexSearchQueryOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**source** | **list[str]** | | [optional] -**aggs** | [**object**](.md) | | [optional] -**_from** | **float** | | [optional] -**query** | **dict(str, object)** | | [optional] -**size** | **float** | | [optional] -**sort** | **list[object]** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/EntityAnnotation.md b/docs/apis/public/EntityAnnotation.md deleted file mode 100644 index 342d1cb3..00000000 --- a/docs/apis/public/EntityAnnotation.md +++ /dev/null @@ -1,13 +0,0 @@ -# EntityAnnotation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**match** | **str** | | -**range** | **list[int]** | 2-Tuple representing the low and high indexes of the matching substring | -**subtype** | **str** | | [optional] -**type** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/EntityAnnotationDescriptor.md b/docs/apis/public/EntityAnnotationDescriptor.md deleted file mode 100644 index ebfd5117..00000000 --- a/docs/apis/public/EntityAnnotationDescriptor.md +++ /dev/null @@ -1,12 +0,0 @@ -# EntityAnnotationDescriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_fields** | **list[str]** | | [optional] -**description** | **str** | | -**key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ErrorResponse.md b/docs/apis/public/ErrorResponse.md deleted file mode 100644 index b7236e04..00000000 --- a/docs/apis/public/ErrorResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# ErrorResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error_code** | **str** | | [optional] -**error_message** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/FlavoursQuota.md b/docs/apis/public/FlavoursQuota.md deleted file mode 100644 index ebd7dc1a..00000000 --- a/docs/apis/public/FlavoursQuota.md +++ /dev/null @@ -1,12 +0,0 @@ -# FlavoursQuota - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**display_name** | **str** | | -**name** | **str** | | -**quota** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/FullyRenderedDataFlow.md b/docs/apis/public/FullyRenderedDataFlow.md deleted file mode 100644 index ebdf17e8..00000000 --- a/docs/apis/public/FullyRenderedDataFlow.md +++ /dev/null @@ -1,11 +0,0 @@ -# FullyRenderedDataFlow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**target_bag** | [**ProjectProjKeyKgcDataflowTemplatesDebugDfTplKeyTargetBag**](ProjectProjKeyKgcDataflowTemplatesDebugDfTplKeyTargetBag.md) | | [optional] -**variables** | **dict(str, object)** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImageCells.md b/docs/apis/public/ImageCells.md deleted file mode 100644 index dad3b265..00000000 --- a/docs/apis/public/ImageCells.md +++ /dev/null @@ -1,10 +0,0 @@ -# ImageCells - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | **list[object]** | A 6-tuple consisting of x1, y1, x2, y2, font, coordinates | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImageInfo.md b/docs/apis/public/ImageInfo.md deleted file mode 100644 index 46812a42..00000000 --- a/docs/apis/public/ImageInfo.md +++ /dev/null @@ -1,11 +0,0 @@ -# ImageInfo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**height** | **float** | | -**width** | **float** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImageMetadata.md b/docs/apis/public/ImageMetadata.md deleted file mode 100644 index 95236b47..00000000 --- a/docs/apis/public/ImageMetadata.md +++ /dev/null @@ -1,11 +0,0 @@ -# ImageMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cells** | [**ImageCells**](ImageCells.md) | | -**info** | [**ImageInfo**](ImageInfo.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImageSource.md b/docs/apis/public/ImageSource.md deleted file mode 100644 index a74545db..00000000 --- a/docs/apis/public/ImageSource.md +++ /dev/null @@ -1,12 +0,0 @@ -# ImageSource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**proj_key** | **str** | | [optional] -**scratch_id** | **str** | | [optional] -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImportFromElasticToDataCatalogOptions.md b/docs/apis/public/ImportFromElasticToDataCatalogOptions.md deleted file mode 100644 index e86111ad..00000000 --- a/docs/apis/public/ImportFromElasticToDataCatalogOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# ImportFromElasticToDataCatalogOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**coordinates** | [**ElasticCoordinates**](ElasticCoordinates.md) | | [optional] -**elastic_id** | **str** | | [optional] -**parameters** | [**ImportFromElasticToDataCatalogOptionsParameters**](ImportFromElasticToDataCatalogOptionsParameters.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImportFromElasticToDataCatalogOptionsParameters.md b/docs/apis/public/ImportFromElasticToDataCatalogOptionsParameters.md deleted file mode 100644 index eb9acc9d..00000000 --- a/docs/apis/public/ImportFromElasticToDataCatalogOptionsParameters.md +++ /dev/null @@ -1,14 +0,0 @@ -# ImportFromElasticToDataCatalogOptionsParameters - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**import_s3_data** | **bool** | | [optional] -**index** | **str** | | -**page_size** | **float** | | [optional] -**query_options** | [**ImportFromElasticToDataCatalogOptionsParametersQueryOptions**](ImportFromElasticToDataCatalogOptionsParametersQueryOptions.md) | | -**s3** | [**ImportFromElasticToDataCatalogS3Coords**](ImportFromElasticToDataCatalogS3Coords.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImportFromElasticToDataCatalogOptionsParametersQueryOptions.md b/docs/apis/public/ImportFromElasticToDataCatalogOptionsParametersQueryOptions.md deleted file mode 100644 index 00a96386..00000000 --- a/docs/apis/public/ImportFromElasticToDataCatalogOptionsParametersQueryOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# ImportFromElasticToDataCatalogOptionsParametersQueryOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**source** | **list[str]** | | [optional] -**query** | **dict(str, object)** | | [optional] -**size** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImportFromElasticToDataCatalogS3Coords.md b/docs/apis/public/ImportFromElasticToDataCatalogS3Coords.md deleted file mode 100644 index 38787a3a..00000000 --- a/docs/apis/public/ImportFromElasticToDataCatalogS3Coords.md +++ /dev/null @@ -1,18 +0,0 @@ -# ImportFromElasticToDataCatalogS3Coords - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_key** | **str** | | -**bucket** | **str** | | -**host** | **str** | | -**key_prefix** | **str** | | -**location** | **str** | | -**port** | **int** | | -**secret_key** | **str** | | -**ssl** | **bool** | | -**verify_ssl** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImportToDataCatalogCollectionOptions.md b/docs/apis/public/ImportToDataCatalogCollectionOptions.md deleted file mode 100644 index 10477851..00000000 --- a/docs/apis/public/ImportToDataCatalogCollectionOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# ImportToDataCatalogCollectionOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ccs** | [**ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcs**](ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcs.md) | | [optional] -**elastic** | [**ImportFromElasticToDataCatalogOptions**](ImportFromElasticToDataCatalogOptions.md) | | [optional] -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImportToDataCatalogOptions.md b/docs/apis/public/ImportToDataCatalogOptions.md deleted file mode 100644 index 8e4ac0e6..00000000 --- a/docs/apis/public/ImportToDataCatalogOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# ImportToDataCatalogOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**coordinates** | [**MongoS3CoordinatesWithCollectionList**](MongoS3CoordinatesWithCollectionList.md) | | [optional] -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InferProjectDataCatalogCategorySchema.md b/docs/apis/public/InferProjectDataCatalogCategorySchema.md deleted file mode 100644 index 83c8bc7b..00000000 --- a/docs/apis/public/InferProjectDataCatalogCategorySchema.md +++ /dev/null @@ -1,10 +0,0 @@ -# InferProjectDataCatalogCategorySchema - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**sample_size** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/IngestDocumentQARequest.md b/docs/apis/public/IngestDocumentQARequest.md deleted file mode 100644 index 041b9cda..00000000 --- a/docs/apis/public/IngestDocumentQARequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# IngestDocumentQARequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**source** | [**object**](.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineObject.md b/docs/apis/public/InlineObject.md deleted file mode 100644 index 52ff6d6a..00000000 --- a/docs/apis/public/InlineObject.md +++ /dev/null @@ -1,10 +0,0 @@ -# InlineObject - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**snapshot** | [**TakeSnapshotSettingsBackendAware**](TakeSnapshotSettingsBackendAware.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineObject1.md b/docs/apis/public/InlineObject1.md deleted file mode 100644 index b0e1a998..00000000 --- a/docs/apis/public/InlineObject1.md +++ /dev/null @@ -1,15 +0,0 @@ -# InlineObject1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_token** | **str** | | -**catalog_document_collections** | [**list[CatalogReference]**](CatalogReference.md) | | -**ccs_document_collections** | [**list[CcsCollectionReference]**](CcsCollectionReference.md) | | -**data_catalogs** | [**list[CatalogReference]**](CatalogReference.md) | | [optional] -**entity_mappings** | **dict(str, str)** | | [optional] -**models** | [**list[CpsModelReference]**](CpsModelReference.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineObject2.md b/docs/apis/public/InlineObject2.md deleted file mode 100644 index be8935dd..00000000 --- a/docs/apis/public/InlineObject2.md +++ /dev/null @@ -1,10 +0,0 @@ -# InlineObject2 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**snapshot** | [**TakeSnapshotSettings**](TakeSnapshotSettings.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineObject3.md b/docs/apis/public/InlineObject3.md deleted file mode 100644 index c9d328eb..00000000 --- a/docs/apis/public/InlineObject3.md +++ /dev/null @@ -1,10 +0,0 @@ -# InlineObject3 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**info** | [**ProjectProjKeyBagsBagKeyTasksExportDatasetInfo**](ProjectProjKeyBagsBagKeyTasksExportDatasetInfo.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineObject4.md b/docs/apis/public/InlineObject4.md deleted file mode 100644 index 6b9a8a37..00000000 --- a/docs/apis/public/InlineObject4.md +++ /dev/null @@ -1,10 +0,0 @@ -# InlineObject4 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**file_url** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineObject5.md b/docs/apis/public/InlineObject5.md deleted file mode 100644 index 02266f6f..00000000 --- a/docs/apis/public/InlineObject5.md +++ /dev/null @@ -1,11 +0,0 @@ -# InlineObject5 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**attachment_key** | **str** | | [optional] -**attachment_path** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineResponse200.md b/docs/apis/public/InlineResponse200.md deleted file mode 100644 index 02231458..00000000 --- a/docs/apis/public/InlineResponse200.md +++ /dev/null @@ -1,10 +0,0 @@ -# InlineResponse200 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**elastic_query_max_size** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineResponse2001.md b/docs/apis/public/InlineResponse2001.md deleted file mode 100644 index ef940e8f..00000000 --- a/docs/apis/public/InlineResponse2001.md +++ /dev/null @@ -1,10 +0,0 @@ -# InlineResponse2001 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**processing_models** | [**list[ProcessingModelDescription]**](ProcessingModelDescription.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineResponse2002.md b/docs/apis/public/InlineResponse2002.md deleted file mode 100644 index d2221517..00000000 --- a/docs/apis/public/InlineResponse2002.md +++ /dev/null @@ -1,13 +0,0 @@ -# InlineResponse2002 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**done** | **bool** | | -**result** | [**object**](.md) | | -**task_id** | **str** | | -**task_status** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineResponse2003.md b/docs/apis/public/InlineResponse2003.md deleted file mode 100644 index 4d3f4b31..00000000 --- a/docs/apis/public/InlineResponse2003.md +++ /dev/null @@ -1,17 +0,0 @@ -# InlineResponse2003 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**avail_cpu_slots** | **int** | | [optional] -**avail_mem_slots** | **int** | | [optional] -**avail_slots** | **int** | | [optional] -**name** | **str** | | [optional] -**num_nodes** | **int** | | [optional] -**number_kgs** | **int** | | [optional] -**running_kgs** | **int** | | [optional] -**workers_pool** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InspectionReport.md b/docs/apis/public/InspectionReport.md deleted file mode 100644 index e35c541a..00000000 --- a/docs/apis/public/InspectionReport.md +++ /dev/null @@ -1,14 +0,0 @@ -# InspectionReport - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**document** | **str** | | -**id** | **str** | ID of the inpection report. | -**proj_key** | **str** | | -**timestamp** | **float** | | -**user_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KgSnapshot.md b/docs/apis/public/KgSnapshot.md deleted file mode 100644 index 68a20369..00000000 --- a/docs/apis/public/KgSnapshot.md +++ /dev/null @@ -1,15 +0,0 @@ -# KgSnapshot - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flow** | [**object**](.md) | | [optional] -**is_current** | **bool** | | [optional] -**name** | **str** | | [optional] -**project_task_id** | **str** | | [optional] -**task_type** | **str** | | [optional] -**timestamp** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KgcDataInput.md b/docs/apis/public/KgcDataInput.md deleted file mode 100644 index 59578c7b..00000000 --- a/docs/apis/public/KgcDataInput.md +++ /dev/null @@ -1,11 +0,0 @@ -# KgcDataInput - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**config** | [**object**](.md) | | -**data_flow** | **list[dict(str, object)]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KibanaSavedQueriesResult.md b/docs/apis/public/KibanaSavedQueriesResult.md deleted file mode 100644 index a89cb5f3..00000000 --- a/docs/apis/public/KibanaSavedQueriesResult.md +++ /dev/null @@ -1,13 +0,0 @@ -# KibanaSavedQueriesResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | [optional] -**fields** | **list[str]** | | [optional] -**query** | **str** | | [optional] -**title** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KnowledgeGraphAuthenticationCallback.md b/docs/apis/public/KnowledgeGraphAuthenticationCallback.md deleted file mode 100644 index f6e202e4..00000000 --- a/docs/apis/public/KnowledgeGraphAuthenticationCallback.md +++ /dev/null @@ -1,10 +0,0 @@ -# KnowledgeGraphAuthenticationCallback - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**callback_url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KnowledgeGraphChartUpgradeOptions.md b/docs/apis/public/KnowledgeGraphChartUpgradeOptions.md deleted file mode 100644 index fee3e38f..00000000 --- a/docs/apis/public/KnowledgeGraphChartUpgradeOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# KnowledgeGraphChartUpgradeOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chart** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KnowledgeGraphDeploymentRecreationOptions.md b/docs/apis/public/KnowledgeGraphDeploymentRecreationOptions.md deleted file mode 100644 index eb20ed9e..00000000 --- a/docs/apis/public/KnowledgeGraphDeploymentRecreationOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# KnowledgeGraphDeploymentRecreationOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**force** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KnowledgeGraphSnapshotOptions.md b/docs/apis/public/KnowledgeGraphSnapshotOptions.md deleted file mode 100644 index 7b3ae47b..00000000 --- a/docs/apis/public/KnowledgeGraphSnapshotOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# KnowledgeGraphSnapshotOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KnowledgeGraphSystemInformation.md b/docs/apis/public/KnowledgeGraphSystemInformation.md deleted file mode 100644 index f9596aeb..00000000 --- a/docs/apis/public/KnowledgeGraphSystemInformation.md +++ /dev/null @@ -1,19 +0,0 @@ -# KnowledgeGraphSystemInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**backend** | [**dict(str, SystemKgsBackend)**](SystemKgsBackend.md) | | [optional] -**bag_domain** | **str** | | [optional] -**bag_key** | **str** | | [optional] -**bag_url** | **str** | | [optional] -**name** | **str** | | [optional] -**proj_key** | **str** | | [optional] -**project_name** | **str** | | [optional] -**public** | **bool** | | [optional] -**slug** | **str** | | [optional] -**timestamp** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KnowledgeGraphsApi.md b/docs/apis/public/KnowledgeGraphsApi.md deleted file mode 100644 index ee1f85fc..00000000 --- a/docs/apis/public/KnowledgeGraphsApi.md +++ /dev/null @@ -1,2647 +0,0 @@ -# deepsearch.cps.apis.public.KnowledgeGraphsApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**assemble_project_knowledge_graph_data_flow**](KnowledgeGraphsApi.md#assemble_project_knowledge_graph_data_flow) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow | -[**backend_assemble_project_kg_data_flow**](KnowledgeGraphsApi.md#backend_assemble_project_kg_data_flow) | **POST** /backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow | -[**backend_create_project_kg**](KnowledgeGraphsApi.md#backend_create_project_kg) | **POST** /backend/project/{proj_key}/bags | -[**backend_create_project_kg_snapshot_from_data_flow_assembly**](KnowledgeGraphsApi.md#backend_create_project_kg_snapshot_from_data_flow_assembly) | **POST** /backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots | -[**backend_get_project_kg_status**](KnowledgeGraphsApi.md#backend_get_project_kg_status) | **GET** /backend/project/{proj_key}/bags/{bag_key}/status | -[**backend_list_project_kgs**](KnowledgeGraphsApi.md#backend_list_project_kgs) | **GET** /backend/project/{proj_key}/bags | -[**backend_update_project_kg_metadata**](KnowledgeGraphsApi.md#backend_update_project_kg_metadata) | **PATCH** /backend/project/{proj_key}/bags/{bag_key} | -[**create_project_knowledge_graph**](KnowledgeGraphsApi.md#create_project_knowledge_graph) | **POST** /project/{proj_key}/bags | -[**create_project_knowledge_graph_authentication_token**](KnowledgeGraphsApi.md#create_project_knowledge_graph_authentication_token) | **GET** /project/{proj_key}/bags/{bag_key}/auth_token | -[**create_project_knowledge_graph_backup**](KnowledgeGraphsApi.md#create_project_knowledge_graph_backup) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/backup | -[**create_project_knowledge_graph_delete_token**](KnowledgeGraphsApi.md#create_project_knowledge_graph_delete_token) | **POST** /project/{proj_key}/bags/{bag_key}/delete_token | -[**create_project_knowledge_graph_snapshot**](KnowledgeGraphsApi.md#create_project_knowledge_graph_snapshot) | **POST** /project/{proj_key}/bags/{bag_key}/snapshots | -[**create_project_knowledge_graph_snapshot_from_data_flow_assembly**](KnowledgeGraphsApi.md#create_project_knowledge_graph_snapshot_from_data_flow_assembly) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots | -[**delete_project_knowledge_graph**](KnowledgeGraphsApi.md#delete_project_knowledge_graph) | **DELETE** /project/{proj_key}/bags/{bag_key} | -[**delete_project_knowledge_graph_snapshot**](KnowledgeGraphsApi.md#delete_project_knowledge_graph_snapshot) | **DELETE** /project/{proj_key}/bags/{bag_key}/snapshots/{execution_id} | -[**download_project_knowledge_graph**](KnowledgeGraphsApi.md#download_project_knowledge_graph) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/export | -[**get_project_knowledge_graph_authentication_callback**](KnowledgeGraphsApi.md#get_project_knowledge_graph_authentication_callback) | **GET** /project/{proj_key}/bags/{bag_key}/auth_callback | -[**get_project_knowledge_graph_status**](KnowledgeGraphsApi.md#get_project_knowledge_graph_status) | **GET** /project/{proj_key}/bags/{bag_key}/status | -[**get_project_knowledge_graph_usage_stats**](KnowledgeGraphsApi.md#get_project_knowledge_graph_usage_stats) | **GET** /project/{proj_key}/bags/{bag_key}/usage_stats | -[**list_project_knowledge_graph_assemble_tasks**](KnowledgeGraphsApi.md#list_project_knowledge_graph_assemble_tasks) | **GET** /project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow | -[**list_project_knowledge_graph_load_tasks**](KnowledgeGraphsApi.md#list_project_knowledge_graph_load_tasks) | **GET** /project/{proj_key}/bags/{bag_key}/tasks/load_dataflow | -[**list_project_knowledge_graph_snapshots**](KnowledgeGraphsApi.md#list_project_knowledge_graph_snapshots) | **GET** /project/{proj_key}/bags/{bag_key}/snapshots | -[**list_project_knowledge_graphs**](KnowledgeGraphsApi.md#list_project_knowledge_graphs) | **GET** /project/{proj_key}/bags | -[**list_public_knowledge_graphs**](KnowledgeGraphsApi.md#list_public_knowledge_graphs) | **GET** /project/public/bags | -[**load_project_knowledge_graph_data_flow**](KnowledgeGraphsApi.md#load_project_knowledge_graph_data_flow) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/load_dataflow | -[**load_project_knowledge_graph_snapshot**](KnowledgeGraphsApi.md#load_project_knowledge_graph_snapshot) | **POST** /project/{proj_key}/bags/{bag_key}/snapshots/{execution_id}/actions/load | -[**recreate_project_knowledge_graph_deployment**](KnowledgeGraphsApi.md#recreate_project_knowledge_graph_deployment) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/recreate_deployment | -[**restore_project_knowledge_graph_backup**](KnowledgeGraphsApi.md#restore_project_knowledge_graph_backup) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/restore | -[**resume_project_knowledge_graph**](KnowledgeGraphsApi.md#resume_project_knowledge_graph) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/resume | -[**suspend_project_knowledge_graph**](KnowledgeGraphsApi.md#suspend_project_knowledge_graph) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/suspend | -[**update_project_knowledge_graph_metadata**](KnowledgeGraphsApi.md#update_project_knowledge_graph_metadata) | **PATCH** /project/{proj_key}/bags/{bag_key} | -[**upgrade_project_knowledge_graph_deployment**](KnowledgeGraphsApi.md#upgrade_project_knowledge_graph_deployment) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/upgrade | - - -# **assemble_project_knowledge_graph_data_flow** -> ProjectTask assemble_project_knowledge_graph_data_flow(proj_key, bag_key, options) - - - -Assemble a data flow on a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -options = deepsearch.cps.apis.public.AssembleDataFlowIntoKnowledgeGraphOptions1() # AssembleDataFlowIntoKnowledgeGraphOptions1 | - - try: - api_response = api_instance.assemble_project_knowledge_graph_data_flow(proj_key, bag_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->assemble_project_knowledge_graph_data_flow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **options** | [**AssembleDataFlowIntoKnowledgeGraphOptions1**](AssembleDataFlowIntoKnowledgeGraphOptions1.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **backend_assemble_project_kg_data_flow** -> ProjectTask backend_assemble_project_kg_data_flow(proj_key, bag_key, options) - - - -Assemble a data flow on a Knowledge Graph, backend-aware - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -options = deepsearch.cps.apis.public.AssembleDataFlowIntoKnowledgeGraphOptions() # AssembleDataFlowIntoKnowledgeGraphOptions | - - try: - api_response = api_instance.backend_assemble_project_kg_data_flow(proj_key, bag_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->backend_assemble_project_kg_data_flow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **options** | [**AssembleDataFlowIntoKnowledgeGraphOptions**](AssembleDataFlowIntoKnowledgeGraphOptions.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **backend_create_project_kg** -> BagBackendAware backend_create_project_kg(proj_key, data) - - - -Create new BAG, backend-aware - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -data = deepsearch.cps.apis.public.CreateKnowledgeGraphOptions() # CreateKnowledgeGraphOptions | - - try: - api_response = api_instance.backend_create_project_kg(proj_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->backend_create_project_kg: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **data** | [**CreateKnowledgeGraphOptions**](CreateKnowledgeGraphOptions.md)| | - -### Return type - -[**BagBackendAware**](BagBackendAware.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | OK | - | -**400** | Invalid parameters. | - | -**403** | Create knowledge graphs is disabled. | - | -**409** | Cannot create BAG because one already exists with that name. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **backend_create_project_kg_snapshot_from_data_flow_assembly** -> ProjectTask backend_create_project_kg_snapshot_from_data_flow_assembly(proj_key, bag_key, body) - - - -Create a snapshot of a Knowledge Graph from the last data flow assembly task, backend-aware - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -body = deepsearch.cps.apis.public.InlineObject() # InlineObject | - - try: - api_response = api_instance.backend_create_project_kg_snapshot_from_data_flow_assembly(proj_key, bag_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->backend_create_project_kg_snapshot_from_data_flow_assembly: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **body** | [**InlineObject**](InlineObject.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**404** | KG/BAG/Data Flow Assembly not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **backend_get_project_kg_status** -> BagStatusBackendAware backend_get_project_kg_status(proj_key, bag_key, details=details) - - - -Get the status of a Knowledge Graph, backend-aware - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -details = False # bool | (optional) (default to False) - - try: - api_response = api_instance.backend_get_project_kg_status(proj_key, bag_key, details=details) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->backend_get_project_kg_status: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **details** | **bool**| | [optional] [default to False] - -### Return type - -[**BagStatusBackendAware**](BagStatusBackendAware.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Knowledge Graph status. | - | -**404** | BAG not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **backend_list_project_kgs** -> list[BagBackendAware] backend_list_project_kgs(proj_key, term=term) - - - -List all bags in the project, backend-aware - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -term = 'term_example' # str | (optional) - - try: - api_response = api_instance.backend_list_project_kgs(proj_key, term=term) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->backend_list_project_kgs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **term** | **str**| | [optional] - -### Return type - -[**list[BagBackendAware]**](BagBackendAware.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **backend_update_project_kg_metadata** -> BagBackendAware backend_update_project_kg_metadata(proj_key, bag_key, data) - - - -Update the metadata of a Knowledge graph, backend-aware - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -data = deepsearch.cps.apis.public.PatchKnowledgeGraphOptions() # PatchKnowledgeGraphOptions | - - try: - api_response = api_instance.backend_update_project_kg_metadata(proj_key, bag_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->backend_update_project_kg_metadata: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **data** | [**PatchKnowledgeGraphOptions**](PatchKnowledgeGraphOptions.md)| | - -### Return type - -[**BagBackendAware**](BagBackendAware.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Knowledge graph metadata updated. | - | -**404** | Knowledge graph not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_knowledge_graph** -> Bag create_project_knowledge_graph(proj_key, data) - - - -Create new BAG - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -data = deepsearch.cps.apis.public.CreateKnowledgeGraphOptions1() # CreateKnowledgeGraphOptions1 | - - try: - api_response = api_instance.create_project_knowledge_graph(proj_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->create_project_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **data** | [**CreateKnowledgeGraphOptions1**](CreateKnowledgeGraphOptions1.md)| | - -### Return type - -[**Bag**](Bag.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | OK | - | -**400** | Invalid parameters. | - | -**403** | Create knowledge graphs is disabled. | - | -**409** | Cannot create BAG because one already exists with that name. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_knowledge_graph_authentication_token** -> TokenResponse create_project_knowledge_graph_authentication_token(proj_key, bag_key) - - - -Get a token used to authenticate in the Erlenmeyer / KG APIs of a BAG. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | - - try: - api_response = api_instance.create_project_knowledge_graph_authentication_token(proj_key, bag_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->create_project_knowledge_graph_authentication_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | BAG auth token. | - | -**404** | BAG not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_knowledge_graph_backup** -> Task create_project_knowledge_graph_backup(proj_key, bag_key, options) - - - -Back up a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -options = deepsearch.cps.apis.public.BackupKnowledgeGraphOptions() # BackupKnowledgeGraphOptions | - - try: - api_response = api_instance.create_project_knowledge_graph_backup(proj_key, bag_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->create_project_knowledge_graph_backup: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **options** | [**BackupKnowledgeGraphOptions**](BackupKnowledgeGraphOptions.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | OK | - | -**400** | Invalid parameters. | - | -**404** | KG/BAG not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_knowledge_graph_delete_token** -> TokenResponse create_project_knowledge_graph_delete_token(proj_key, bag_key) - - - -Get a token used to confirm the deletion of a BAG. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | - - try: - api_response = api_instance.create_project_knowledge_graph_delete_token(proj_key, bag_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->create_project_knowledge_graph_delete_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | BAG deletion token. | - | -**404** | BAG not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_knowledge_graph_snapshot** -> ProjectTask create_project_knowledge_graph_snapshot(proj_key, bag_key, body) - - - -Create a snapshot of a Knowledge Graph, with its current state. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -body = deepsearch.cps.apis.public.KnowledgeGraphSnapshotOptions() # KnowledgeGraphSnapshotOptions | - - try: - api_response = api_instance.create_project_knowledge_graph_snapshot(proj_key, bag_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->create_project_knowledge_graph_snapshot: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **body** | [**KnowledgeGraphSnapshotOptions**](KnowledgeGraphSnapshotOptions.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**403** | Feature is disabled on this instance. | - | -**404** | KG/BAG not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_knowledge_graph_snapshot_from_data_flow_assembly** -> ProjectTask create_project_knowledge_graph_snapshot_from_data_flow_assembly(proj_key, bag_key, body) - - - -Create a snapshot of a Knowledge Graph from the last data flow assembly task. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -body = deepsearch.cps.apis.public.InlineObject2() # InlineObject2 | - - try: - api_response = api_instance.create_project_knowledge_graph_snapshot_from_data_flow_assembly(proj_key, bag_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->create_project_knowledge_graph_snapshot_from_data_flow_assembly: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **body** | [**InlineObject2**](InlineObject2.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**404** | KG/BAG/Data Flow Assembly not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_knowledge_graph** -> delete_project_knowledge_graph(proj_key, bag_key, confirmation_token) - - - -Delete a BAG - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -confirmation_token = 'confirmation_token_example' # str | - - try: - api_instance.delete_project_knowledge_graph(proj_key, bag_key, confirmation_token) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->delete_project_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **confirmation_token** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | BAG deleted. | - | -**404** | BAG not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_knowledge_graph_snapshot** -> delete_project_knowledge_graph_snapshot(proj_key, bag_key, execution_id) - - - -Delete a snapshot resulting from an assembled data flow. The execution log itself is not deleted. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -execution_id = 'execution_id_example' # str | - - try: - api_instance.delete_project_knowledge_graph_snapshot(proj_key, bag_key, execution_id) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->delete_project_knowledge_graph_snapshot: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **execution_id** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | OK | - | -**400** | Invalid parameters. | - | -**404** | KG/BAG/Snapshot not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **download_project_knowledge_graph** -> Task download_project_knowledge_graph(proj_key, bag_key) - - - -Download a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | - - try: - api_response = api_instance.download_project_knowledge_graph(proj_key, bag_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->download_project_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | OK | - | -**400** | Invalid parameters. | - | -**404** | KG/BAG not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_knowledge_graph_authentication_callback** -> KnowledgeGraphAuthenticationCallback get_project_knowledge_graph_authentication_callback(proj_key, bag_key, bag_token) - - - -Final step of redirection for authentication on a BAG. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -bag_token = 'bag_token_example' # str | - - try: - api_response = api_instance.get_project_knowledge_graph_authentication_callback(proj_key, bag_key, bag_token) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->get_project_knowledge_graph_authentication_callback: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **bag_token** | **str**| | - -### Return type - -[**KnowledgeGraphAuthenticationCallback**](KnowledgeGraphAuthenticationCallback.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | BAG auth redirect URL. | - | -**401** | Unauthorized. | - | -**404** | BAG not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_knowledge_graph_status** -> BagStatus get_project_knowledge_graph_status(proj_key, bag_key, details=details) - - - -Get the status of a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -details = False # bool | (optional) (default to False) - - try: - api_response = api_instance.get_project_knowledge_graph_status(proj_key, bag_key, details=details) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->get_project_knowledge_graph_status: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **details** | **bool**| | [optional] [default to False] - -### Return type - -[**BagStatus**](BagStatus.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Knowledge Graph status. | - | -**404** | BAG not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_knowledge_graph_usage_stats** -> UsageStats get_project_knowledge_graph_usage_stats(proj_key, bag_key) - - - -Get the usage stats of a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | - - try: - api_response = api_instance.get_project_knowledge_graph_usage_stats(proj_key, bag_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->get_project_knowledge_graph_usage_stats: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - -### Return type - -[**UsageStats**](UsageStats.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Knowledge Graph usage stats. | - | -**404** | BAG not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_knowledge_graph_assemble_tasks** -> list[DataFlowAssembleIntoKnowledgeGraphTask] list_project_knowledge_graph_assemble_tasks(proj_key, bag_key, limit=limit, skip=skip) - - - -List assemble tasks for a Knowledge Graph. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -limit = 50 # int | (optional) (default to 50) -skip = 0 # int | (optional) (default to 0) - - try: - api_response = api_instance.list_project_knowledge_graph_assemble_tasks(proj_key, bag_key, limit=limit, skip=skip) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->list_project_knowledge_graph_assemble_tasks: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **limit** | **int**| | [optional] [default to 50] - **skip** | **int**| | [optional] [default to 0] - -### Return type - -[**list[DataFlowAssembleIntoKnowledgeGraphTask]**](DataFlowAssembleIntoKnowledgeGraphTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of tasks. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_knowledge_graph_load_tasks** -> list[DataFlowLoadIntoKnowledgeGraphTask] list_project_knowledge_graph_load_tasks(proj_key, bag_key, limit=limit, skip=skip) - - - -List load tasks for a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -limit = 50 # int | (optional) (default to 50) -skip = 0 # int | (optional) (default to 0) - - try: - api_response = api_instance.list_project_knowledge_graph_load_tasks(proj_key, bag_key, limit=limit, skip=skip) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->list_project_knowledge_graph_load_tasks: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **limit** | **int**| | [optional] [default to 50] - **skip** | **int**| | [optional] [default to 0] - -### Return type - -[**list[DataFlowLoadIntoKnowledgeGraphTask]**](DataFlowLoadIntoKnowledgeGraphTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of tasks. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_knowledge_graph_snapshots** -> list[KgSnapshot] list_project_knowledge_graph_snapshots(proj_key, bag_key) - - - -List snapshots for a knowledge graph from assembled data flows. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | - - try: - api_response = api_instance.list_project_knowledge_graph_snapshots(proj_key, bag_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->list_project_knowledge_graph_snapshots: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - -### Return type - -[**list[KgSnapshot]**](KgSnapshot.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Snapshots | - | -**404** | KG/BAG not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_knowledge_graphs** -> list[Bag] list_project_knowledge_graphs(proj_key, term=term) - - - -List all bags in the project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -term = 'term_example' # str | (optional) - - try: - api_response = api_instance.list_project_knowledge_graphs(proj_key, term=term) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->list_project_knowledge_graphs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **term** | **str**| | [optional] - -### Return type - -[**list[Bag]**](Bag.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_public_knowledge_graphs** -> list[Bag] list_public_knowledge_graphs(term=term) - - - -List all public BAGs - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - term = 'term_example' # str | (optional) - - try: - api_response = api_instance.list_public_knowledge_graphs(term=term) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->list_public_knowledge_graphs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **term** | **str**| | [optional] - -### Return type - -[**list[Bag]**](Bag.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **load_project_knowledge_graph_data_flow** -> ProjectTask load_project_knowledge_graph_data_flow(proj_key, bag_key, options) - - - -Load a data flow onto a Knowledge Graph. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -options = deepsearch.cps.apis.public.LoadDataFlowIntoKnowledgeGraphOptions() # LoadDataFlowIntoKnowledgeGraphOptions | - - try: - api_response = api_instance.load_project_knowledge_graph_data_flow(proj_key, bag_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->load_project_knowledge_graph_data_flow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **options** | [**LoadDataFlowIntoKnowledgeGraphOptions**](LoadDataFlowIntoKnowledgeGraphOptions.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **load_project_knowledge_graph_snapshot** -> Task load_project_knowledge_graph_snapshot(proj_key, bag_key, execution_id) - - - -Load a snapshot resulting from an assembled data flow - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -execution_id = 'execution_id_example' # str | - - try: - api_response = api_instance.load_project_knowledge_graph_snapshot(proj_key, bag_key, execution_id) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->load_project_knowledge_graph_snapshot: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **execution_id** | **str**| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Snapshot is being loaded. | - | -**400** | Invalid parameters. | - | -**403** | Feature is disabled on this instance. | - | -**404** | KG/BAG/Snapshot not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **recreate_project_knowledge_graph_deployment** -> recreate_project_knowledge_graph_deployment(proj_key, bag_key, body) - - - -(Re)create the deployment for a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -body = deepsearch.cps.apis.public.KnowledgeGraphDeploymentRecreationOptions() # KnowledgeGraphDeploymentRecreationOptions | - - try: - api_instance.recreate_project_knowledge_graph_deployment(proj_key, bag_key, body) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->recreate_project_knowledge_graph_deployment: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **body** | [**KnowledgeGraphDeploymentRecreationOptions**](KnowledgeGraphDeploymentRecreationOptions.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Deployment upgrading. | - | -**404** | Knowledge Graph doesn't exist. | - | -**409** | Refused to recreate the deployment since it already exists and the `force` flag is not `true`. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **restore_project_knowledge_graph_backup** -> Task restore_project_knowledge_graph_backup(proj_key, bag_key, options) - - - -Restore a back up of a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -options = deepsearch.cps.apis.public.RestoreKnowledgeGraphBackupOptions() # RestoreKnowledgeGraphBackupOptions | - - try: - api_response = api_instance.restore_project_knowledge_graph_backup(proj_key, bag_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->restore_project_knowledge_graph_backup: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **options** | [**RestoreKnowledgeGraphBackupOptions**](RestoreKnowledgeGraphBackupOptions.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | OK | - | -**400** | Invalid parameters. | - | -**404** | KG/BAG not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **resume_project_knowledge_graph** -> ProjectTask resume_project_knowledge_graph(proj_key, bag_key, body) - - - -Resume a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -body = deepsearch.cps.apis.public.ResumeKnowledgeGraphOptions() # ResumeKnowledgeGraphOptions | - - try: - api_response = api_instance.resume_project_knowledge_graph(proj_key, bag_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->resume_project_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **body** | [**ResumeKnowledgeGraphOptions**](ResumeKnowledgeGraphOptions.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**403** | Feature is disabled on this instance. | - | -**404** | Knowledge Graph doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **suspend_project_knowledge_graph** -> ProjectTask suspend_project_knowledge_graph(proj_key, bag_key, options) - - - -Suspend a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -options = deepsearch.cps.apis.public.SuspendKnowledgeGraphOptions() # SuspendKnowledgeGraphOptions | - - try: - api_response = api_instance.suspend_project_knowledge_graph(proj_key, bag_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->suspend_project_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **options** | [**SuspendKnowledgeGraphOptions**](SuspendKnowledgeGraphOptions.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**404** | Knowledge Graph doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_knowledge_graph_metadata** -> Bag update_project_knowledge_graph_metadata(proj_key, bag_key, data) - - - -Update the metadata of a Knowledge graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -data = deepsearch.cps.apis.public.PatchKnowledgeGraphOptions1() # PatchKnowledgeGraphOptions1 | - - try: - api_response = api_instance.update_project_knowledge_graph_metadata(proj_key, bag_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->update_project_knowledge_graph_metadata: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **data** | [**PatchKnowledgeGraphOptions1**](PatchKnowledgeGraphOptions1.md)| | - -### Return type - -[**Bag**](Bag.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Knowledge graph metadata updated. | - | -**404** | Knowledge graph not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upgrade_project_knowledge_graph_deployment** -> upgrade_project_knowledge_graph_deployment(proj_key, bag_key, body) - - - -Upgrade the deployment chart of a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -body = deepsearch.cps.apis.public.KnowledgeGraphChartUpgradeOptions() # KnowledgeGraphChartUpgradeOptions | - - try: - api_instance.upgrade_project_knowledge_graph_deployment(proj_key, bag_key, body) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->upgrade_project_knowledge_graph_deployment: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **body** | [**KnowledgeGraphChartUpgradeOptions**](KnowledgeGraphChartUpgradeOptions.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Chart upgrading. | - | -**404** | Knowledge Graph doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/LinkedCcsInstances.md b/docs/apis/public/LinkedCcsInstances.md deleted file mode 100644 index 71531dc3..00000000 --- a/docs/apis/public/LinkedCcsInstances.md +++ /dev/null @@ -1,11 +0,0 @@ -# LinkedCcsInstances - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**id** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/LoadDataFlowIntoKnowledgeGraphOptions.md b/docs/apis/public/LoadDataFlowIntoKnowledgeGraphOptions.md deleted file mode 100644 index 009f9a6d..00000000 --- a/docs/apis/public/LoadDataFlowIntoKnowledgeGraphOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# LoadDataFlowIntoKnowledgeGraphOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flow** | [**BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow**](BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md) | | -**render** | [**BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender**](BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender.md) | | -**save** | [**object**](.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/LoadDataFlowIntoKnowledgeGraphOptions1.md b/docs/apis/public/LoadDataFlowIntoKnowledgeGraphOptions1.md deleted file mode 100644 index 08cbfc01..00000000 --- a/docs/apis/public/LoadDataFlowIntoKnowledgeGraphOptions1.md +++ /dev/null @@ -1,11 +0,0 @@ -# LoadDataFlowIntoKnowledgeGraphOptions1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**render** | [**ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRender**](ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRender.md) | | [optional] -**target** | [**ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadTarget**](ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadTarget.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/LoadKgcDataInput.md b/docs/apis/public/LoadKgcDataInput.md deleted file mode 100644 index bb5de276..00000000 --- a/docs/apis/public/LoadKgcDataInput.md +++ /dev/null @@ -1,11 +0,0 @@ -# LoadKgcDataInput - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dataflow** | [**LoadKgcDataInputDataflow**](LoadKgcDataInputDataflow.md) | | -**target** | [**LoadKgcDataInputTarget**](LoadKgcDataInputTarget.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/LoadKgcDataInputDataflow.md b/docs/apis/public/LoadKgcDataInputDataflow.md deleted file mode 100644 index e7b08f73..00000000 --- a/docs/apis/public/LoadKgcDataInputDataflow.md +++ /dev/null @@ -1,11 +0,0 @@ -# LoadKgcDataInputDataflow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**config** | [**object**](.md) | | [optional] -**data_flow** | **list[object]** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/LoadKgcDataInputTarget.md b/docs/apis/public/LoadKgcDataInputTarget.md deleted file mode 100644 index b1deec22..00000000 --- a/docs/apis/public/LoadKgcDataInputTarget.md +++ /dev/null @@ -1,11 +0,0 @@ -# LoadKgcDataInputTarget - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bag_key** | **str** | | -**save** | [**object**](.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ModelConfiguration.md b/docs/apis/public/ModelConfiguration.md deleted file mode 100644 index 5840510a..00000000 --- a/docs/apis/public/ModelConfiguration.md +++ /dev/null @@ -1,18 +0,0 @@ -# ModelConfiguration - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**configurations** | **dict(str, object)** | | [optional] -**created_at** | **float** | | -**created_by** | **str** | | -**description** | **str** | | -**model_config_key** | **str** | | -**name** | **str** | | -**proj_key** | **str** | | -**public** | **bool** | | -**supported_annotations** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ModelConfigurationsApi.md b/docs/apis/public/ModelConfigurationsApi.md deleted file mode 100644 index b4d43e31..00000000 --- a/docs/apis/public/ModelConfigurationsApi.md +++ /dev/null @@ -1,644 +0,0 @@ -# deepsearch.cps.apis.public.ModelConfigurationsApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_project_model_config**](ModelConfigurationsApi.md#create_project_model_config) | **POST** /project/{proj_key}/model_configs | -[**delete_project_model_config**](ModelConfigurationsApi.md#delete_project_model_config) | **DELETE** /project/{proj_key}/model_configs/{model_config_key} | -[**get_project_models_with_supported_annotations**](ModelConfigurationsApi.md#get_project_models_with_supported_annotations) | **GET** /project/{proj_key}/models | -[**list_project_model_configs**](ModelConfigurationsApi.md#list_project_model_configs) | **GET** /project/{proj_key}/model_configs | -[**list_public_model_configs**](ModelConfigurationsApi.md#list_public_model_configs) | **GET** /project/public/model_configs | -[**read_project_model_config**](ModelConfigurationsApi.md#read_project_model_config) | **GET** /project/{proj_key}/model_configs/{model_config_key} | -[**read_public_model_config**](ModelConfigurationsApi.md#read_public_model_config) | **GET** /project/public/model_configs/{model_config_key} | -[**update_project_model_config**](ModelConfigurationsApi.md#update_project_model_config) | **PATCH** /project/{proj_key}/model_configs/{model_config_key} | - - -# **create_project_model_config** -> ModelConfiguration create_project_model_config(proj_key, body) - - - -Create a Model Configuration - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.CreateProjectModelConfigOptions() # CreateProjectModelConfigOptions | - - try: - api_response = api_instance.create_project_model_config(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->create_project_model_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**CreateProjectModelConfigOptions**](CreateProjectModelConfigOptions.md)| | - -### Return type - -[**ModelConfiguration**](ModelConfiguration.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Model Configuration created. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_model_config** -> delete_project_model_config(proj_key, model_config_key) - - - -Delete a single Model Configuration - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - proj_key = 'proj_key_example' # str | -model_config_key = 'model_config_key_example' # str | - - try: - api_instance.delete_project_model_config(proj_key, model_config_key) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->delete_project_model_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **model_config_key** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Model Configuration deleted. | - | -**404** | Model Configuration doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_models_with_supported_annotations** -> list[ModelConfiguration] get_project_models_with_supported_annotations(proj_key) - - - -List models with the supported annotations for a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - proj_key = 'proj_key_example' # str | - - try: - api_response = api_instance.get_project_models_with_supported_annotations(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->get_project_models_with_supported_annotations: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - -### Return type - -[**list[ModelConfiguration]**](ModelConfiguration.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of Models with the supported annotations | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_model_configs** -> list[ModelConfiguration] list_project_model_configs(proj_key) - - - -List Model Configurations for a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - proj_key = 'proj_key_example' # str | - - try: - api_response = api_instance.list_project_model_configs(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->list_project_model_configs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - -### Return type - -[**list[ModelConfiguration]**](ModelConfiguration.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of Model Configurations | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_public_model_configs** -> list[ModelConfiguration] list_public_model_configs() - - - -List public Model Configurations - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - - try: - api_response = api_instance.list_public_model_configs() - pprint(api_response) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->list_public_model_configs: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[ModelConfiguration]**](ModelConfiguration.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of public Model Configurations | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **read_project_model_config** -> ModelConfiguration read_project_model_config(proj_key, model_config_key, include_collections=include_collections) - - - -Get a single Model Configuration - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - proj_key = 'proj_key_example' # str | -model_config_key = 'model_config_key_example' # str | -include_collections = False # bool | (optional) (default to False) - - try: - api_response = api_instance.read_project_model_config(proj_key, model_config_key, include_collections=include_collections) - pprint(api_response) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->read_project_model_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **model_config_key** | **str**| | - **include_collections** | **bool**| | [optional] [default to False] - -### Return type - -[**ModelConfiguration**](ModelConfiguration.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Model Configuration | - | -**404** | Model Configuration not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **read_public_model_config** -> ModelConfiguration read_public_model_config(model_config_key, include_collections=include_collections) - - - -Get a single Model Configuration that was made public - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - model_config_key = 'model_config_key_example' # str | -include_collections = False # bool | (optional) (default to False) - - try: - api_response = api_instance.read_public_model_config(model_config_key, include_collections=include_collections) - pprint(api_response) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->read_public_model_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **model_config_key** | **str**| | - **include_collections** | **bool**| | [optional] [default to False] - -### Return type - -[**ModelConfiguration**](ModelConfiguration.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Model configuration | - | -**404** | Model configuration not found or is not public | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_model_config** -> update_project_model_config(proj_key, model_config_key, body) - - - -Update a single Model Configuration - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - proj_key = 'proj_key_example' # str | -model_config_key = 'model_config_key_example' # str | -body = deepsearch.cps.apis.public.UpdateProjectModelConfigOptions() # UpdateProjectModelConfigOptions | - - try: - api_instance.update_project_model_config(proj_key, model_config_key, body) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->update_project_model_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **model_config_key** | **str**| | - **body** | [**UpdateProjectModelConfigOptions**](UpdateProjectModelConfigOptions.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Model Configuration updated. | - | -**404** | Model Configuration doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/ModelPipelineSettings.md b/docs/apis/public/ModelPipelineSettings.md deleted file mode 100644 index a0b06016..00000000 --- a/docs/apis/public/ModelPipelineSettings.md +++ /dev/null @@ -1,13 +0,0 @@ -# ModelPipelineSettings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**clusters** | [**object**](.md) | | -**normalization** | [**object**](.md) | | -**page** | [**object**](.md) | | -**tables** | [**object**](.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ModelSupportedAnnotationsParameters.md b/docs/apis/public/ModelSupportedAnnotationsParameters.md deleted file mode 100644 index 43bc9eff..00000000 --- a/docs/apis/public/ModelSupportedAnnotationsParameters.md +++ /dev/null @@ -1,12 +0,0 @@ -# ModelSupportedAnnotationsParameters - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**model_config_key** | **str** | | -**proj_key** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/MongoCoordinates.md b/docs/apis/public/MongoCoordinates.md deleted file mode 100644 index 05d9806d..00000000 --- a/docs/apis/public/MongoCoordinates.md +++ /dev/null @@ -1,11 +0,0 @@ -# MongoCoordinates - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**database** | **str** | | -**uri** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/MongoS3Coordinates.md b/docs/apis/public/MongoS3Coordinates.md deleted file mode 100644 index 745ba033..00000000 --- a/docs/apis/public/MongoS3Coordinates.md +++ /dev/null @@ -1,11 +0,0 @@ -# MongoS3Coordinates - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mongo** | [**MongoCoordinates**](MongoCoordinates.md) | | [optional] -**s3** | [**S3Coordinates**](S3Coordinates.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/MongoS3CoordinatesWithCollectionList.md b/docs/apis/public/MongoS3CoordinatesWithCollectionList.md deleted file mode 100644 index 4c53ceb8..00000000 --- a/docs/apis/public/MongoS3CoordinatesWithCollectionList.md +++ /dev/null @@ -1,12 +0,0 @@ -# MongoS3CoordinatesWithCollectionList - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mongo** | [**MongoCoordinates**](MongoCoordinates.md) | | [optional] -**s3** | [**S3Coordinates**](S3Coordinates.md) | | [optional] -**collections** | **list[str]** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/OCRSettings.md b/docs/apis/public/OCRSettings.md deleted file mode 100644 index 06d968a0..00000000 --- a/docs/apis/public/OCRSettings.md +++ /dev/null @@ -1,13 +0,0 @@ -# OCRSettings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**backend** | **str** | | [optional] -**backend_settings** | [**object**](.md) | | [optional] -**enabled** | **bool** | | [optional] [default to False] -**merge_mode** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/PatchDataCatalogOptions.md b/docs/apis/public/PatchDataCatalogOptions.md deleted file mode 100644 index f5c89b54..00000000 --- a/docs/apis/public/PatchDataCatalogOptions.md +++ /dev/null @@ -1,15 +0,0 @@ -# PatchDataCatalogOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category_schemas** | [**list[DataCatalogCategorySchema]**](DataCatalogCategorySchema.md) | | [optional] -**collections_data_flows** | [**list[DataCatalogDataFlow]**](DataCatalogDataFlow.md) | | [optional] -**description** | **str** | | [optional] -**name** | **str** | | [optional] -**public** | **bool** | | [optional] -**topology** | [**DataCatalogTopology**](DataCatalogTopology.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/PatchDictionaryOptions.md b/docs/apis/public/PatchDictionaryOptions.md deleted file mode 100644 index da270a8e..00000000 --- a/docs/apis/public/PatchDictionaryOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# PatchDictionaryOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | [optional] -**name** | **str** | | [optional] -**public** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/PatchKnowledgeGraphOptions.md b/docs/apis/public/PatchKnowledgeGraphOptions.md deleted file mode 100644 index 07655d84..00000000 --- a/docs/apis/public/PatchKnowledgeGraphOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# PatchKnowledgeGraphOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/PatchKnowledgeGraphOptions1.md b/docs/apis/public/PatchKnowledgeGraphOptions1.md deleted file mode 100644 index 1e41fc61..00000000 --- a/docs/apis/public/PatchKnowledgeGraphOptions1.md +++ /dev/null @@ -1,12 +0,0 @@ -# PatchKnowledgeGraphOptions1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/Problem.md b/docs/apis/public/Problem.md deleted file mode 100644 index 73f536e0..00000000 --- a/docs/apis/public/Problem.md +++ /dev/null @@ -1,13 +0,0 @@ -# Problem - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**detail** | **str** | | [optional] -**status** | **int** | | [optional] -**title** | **str** | | [optional] -**type** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProcessingModel.md b/docs/apis/public/ProcessingModel.md deleted file mode 100644 index c93e36ca..00000000 --- a/docs/apis/public/ProcessingModel.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProcessingModel - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dataflow** | [**ProcessingModelDataFlow**](ProcessingModelDataFlow.md) | | -**variables** | [**dict(str, ProjectProjKeyModelConfigsConfigurations)**](ProjectProjKeyModelConfigsConfigurations.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProcessingModelApi.md b/docs/apis/public/ProcessingModelApi.md deleted file mode 100644 index df8b2f2e..00000000 --- a/docs/apis/public/ProcessingModelApi.md +++ /dev/null @@ -1,160 +0,0 @@ -# deepsearch.cps.apis.public.ProcessingModelApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_data_flow_from_df_wizard**](ProcessingModelApi.md#create_data_flow_from_df_wizard) | **POST** /processing_models/docs_graph_with_databases | -[**get_processing_models**](ProcessingModelApi.md#get_processing_models) | **GET** /processing_models | - - -# **create_data_flow_from_df_wizard** -> ProcessingModel create_data_flow_from_df_wizard(body) - - - -Create a Data Flow from a list of CCS Collections and CPS Models. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProcessingModelApi(api_client) - body = deepsearch.cps.apis.public.InlineObject1() # InlineObject1 | - - try: - api_response = api_instance.create_data_flow_from_df_wizard(body) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProcessingModelApi->create_data_flow_from_df_wizard: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**InlineObject1**](InlineObject1.md)| | - -### Return type - -[**ProcessingModel**](ProcessingModel.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Processing model generated successfully | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_processing_models** -> InlineResponse2001 get_processing_models() - - - -List the available processing models. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProcessingModelApi(api_client) - - try: - api_response = api_instance.get_processing_models() - pprint(api_response) - except ApiException as e: - print("Exception when calling ProcessingModelApi->get_processing_models: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**InlineResponse2001**](InlineResponse2001.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of processing models and their description | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/ProcessingModelDataFlow.md b/docs/apis/public/ProcessingModelDataFlow.md deleted file mode 100644 index 91b0fc69..00000000 --- a/docs/apis/public/ProcessingModelDataFlow.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProcessingModelDataFlow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**config** | [**object**](.md) | | -**data_flow** | **list[object]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProcessingModelDescription.md b/docs/apis/public/ProcessingModelDescription.md deleted file mode 100644 index e117671b..00000000 --- a/docs/apis/public/ProcessingModelDescription.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProcessingModelDescription - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**display_name** | **str** | | -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectApi.md b/docs/apis/public/ProjectApi.md deleted file mode 100644 index f994827c..00000000 --- a/docs/apis/public/ProjectApi.md +++ /dev/null @@ -1,488 +0,0 @@ -# deepsearch.cps.apis.public.ProjectApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**delete_project_integration_config**](ProjectApi.md#delete_project_integration_config) | **DELETE** /project/{proj_key}/integrations/{integration_name} | -[**get_project_default_values**](ProjectApi.md#get_project_default_values) | **GET** /project/{proj_key}/default_values | -[**get_project_integration_config**](ProjectApi.md#get_project_integration_config) | **GET** /project/{proj_key}/integrations/{integration_name} | -[**provision_project_packages**](ProjectApi.md#provision_project_packages) | **POST** /project/{proj_key}/packages | -[**update_project_default_values**](ProjectApi.md#update_project_default_values) | **POST** /project/{proj_key}/default_values | -[**update_project_integration_config**](ProjectApi.md#update_project_integration_config) | **POST** /project/{proj_key}/integrations/{integration_name} | - - -# **delete_project_integration_config** -> delete_project_integration_config(proj_key, integration_name) - - - -Delete the config for a given project integration - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) - proj_key = 'proj_key_example' # str | -integration_name = 'integration_name_example' # str | - - try: - api_instance.delete_project_integration_config(proj_key, integration_name) - except ApiException as e: - print("Exception when calling ProjectApi->delete_project_integration_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **integration_name** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_default_values** -> ProjectDefaultValues get_project_default_values(proj_key) - - - -List project's default values - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) - proj_key = 'proj_key_example' # str | - - try: - api_response = api_instance.get_project_default_values(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectApi->get_project_default_values: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - -### Return type - -[**ProjectDefaultValues**](ProjectDefaultValues.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_integration_config** -> object get_project_integration_config(proj_key, integration_name, decode_secrets=decode_secrets) - - - -Get the config for a given project integration - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) - proj_key = 'proj_key_example' # str | -integration_name = 'integration_name_example' # str | -decode_secrets = False # bool | Project owners can retrieve decoded secrets (optional) (default to False) - - try: - api_response = api_instance.get_project_integration_config(proj_key, integration_name, decode_secrets=decode_secrets) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectApi->get_project_integration_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **integration_name** | **str**| | - **decode_secrets** | **bool**| Project owners can retrieve decoded secrets | [optional] [default to False] - -### Return type - -**object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **provision_project_packages** -> Task provision_project_packages(proj_key, body=body) - - - -Install packages on a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.ProjectPackageInstalationManifest() # ProjectPackageInstalationManifest | (optional) - - try: - api_response = api_instance.provision_project_packages(proj_key, body=body) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectApi->provision_project_packages: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**ProjectPackageInstalationManifest**](ProjectPackageInstalationManifest.md)| | [optional] - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. It can be found in the tasks endpoint for the project. | - | -**404** | Package not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_default_values** -> update_project_default_values(proj_key, default_values) - - - -List project's default values - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) - proj_key = 'proj_key_example' # str | -default_values = deepsearch.cps.apis.public.ProjectDefaultValues() # ProjectDefaultValues | - - try: - api_instance.update_project_default_values(proj_key, default_values) - except ApiException as e: - print("Exception when calling ProjectApi->update_project_default_values: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **default_values** | [**ProjectDefaultValues**](ProjectDefaultValues.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_integration_config** -> update_project_integration_config(proj_key, integration_name, config) - - - -Update the config for a given project integration - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) - proj_key = 'proj_key_example' # str | -integration_name = 'integration_name_example' # str | -config = None # object | - - try: - api_instance.update_project_integration_config(proj_key, integration_name, config) - except ApiException as e: - print("Exception when calling ProjectApi->update_project_integration_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **integration_name** | **str**| | - **config** | **object**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/ProjectDataIndexConversionSettings.md b/docs/apis/public/ProjectDataIndexConversionSettings.md deleted file mode 100644 index 47af46be..00000000 --- a/docs/apis/public/ProjectDataIndexConversionSettings.md +++ /dev/null @@ -1,16 +0,0 @@ -# ProjectDataIndexConversionSettings - -Specify the conversion settings to use. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**assemble** | [**AssembleSettings**](AssembleSettings.md) | | [optional] -**metadata** | [**CollectionMetadataSettings**](CollectionMetadataSettings.md) | | [optional] -**model_pipeline** | [**ModelPipelineSettings**](ModelPipelineSettings.md) | | [optional] -**ocr** | [**OCRSettings**](OCRSettings.md) | | [optional] -**page_labels** | [**object**](.md) | | [optional] -**type** | **str** | | [optional] [default to 'direct'] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDataIndexNonView.md b/docs/apis/public/ProjectDataIndexNonView.md deleted file mode 100644 index fdafbf3b..00000000 --- a/docs/apis/public/ProjectDataIndexNonView.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectDataIndexNonView - -Object to create a project data index -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | Description of the Index | [optional] -**name** | **str** | Name of the data index | -**schema_key** | **str** | Schema key | [optional] [default to 'generic'] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDataIndexS3Coordinates.md b/docs/apis/public/ProjectDataIndexS3Coordinates.md deleted file mode 100644 index 2569d278..00000000 --- a/docs/apis/public/ProjectDataIndexS3Coordinates.md +++ /dev/null @@ -1,19 +0,0 @@ -# ProjectDataIndexS3Coordinates - -Coordinates to COS -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_key** | **str** | | -**bucket** | **str** | | -**host** | **str** | | -**key_prefix** | **str** | | [optional] -**location** | **str** | | -**port** | **float** | | -**secret_key** | **str** | | -**ssl** | **bool** | | -**verify_ssl** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDataIndexSource.md b/docs/apis/public/ProjectDataIndexSource.md deleted file mode 100644 index e571a6e2..00000000 --- a/docs/apis/public/ProjectDataIndexSource.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectDataIndexSource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**index_key** | **str** | | -**proj_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDataIndexView.md b/docs/apis/public/ProjectDataIndexView.md deleted file mode 100644 index 8bea90ef..00000000 --- a/docs/apis/public/ProjectDataIndexView.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectDataIndexView - -Object to create a project data index view -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | Description of the index view | [optional] -**name** | **str** | Name of the data index view | -**view_of** | [**ProjectDataIndexViewOf**](ProjectDataIndexViewOf.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDataIndexViewOf.md b/docs/apis/public/ProjectDataIndexViewOf.md deleted file mode 100644 index 04711ce4..00000000 --- a/docs/apis/public/ProjectDataIndexViewOf.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectDataIndexViewOf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**index_key** | **str** | Data index key | -**instance_id** | **str** | Instance id key, if the source is a data asset | [optional] -**proj_key** | **str** | Project id key, if the source is a project data index | [optional] -**query_options** | [**ElasticIndexSearchQueryOptions**](ElasticIndexSearchQueryOptions.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDataIndexWithStatus.md b/docs/apis/public/ProjectDataIndexWithStatus.md deleted file mode 100644 index c3cc3b9f..00000000 --- a/docs/apis/public/ProjectDataIndexWithStatus.md +++ /dev/null @@ -1,22 +0,0 @@ -# ProjectDataIndexWithStatus - -Project data index with elastic status -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**creation_date** | **str** | | -**description** | **str** | | -**documents** | **float** | | -**health** | **str** | | -**name** | **str** | | -**provenance** | **str** | | [optional] -**record_properties** | [**object**](.md) | | [optional] -**schema_key** | **str** | Index's schema key | [optional] -**source** | [**ProjectDataIndexSource**](ProjectDataIndexSource.md) | | -**status** | **str** | | -**type** | **str** | Index type, user friendly format | -**view_of** | [**ProjectDataIndexWithStatusViewOf**](ProjectDataIndexWithStatusViewOf.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDataIndexWithStatusViewOf.md b/docs/apis/public/ProjectDataIndexWithStatusViewOf.md deleted file mode 100644 index 1cd8d03b..00000000 --- a/docs/apis/public/ProjectDataIndexWithStatusViewOf.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectDataIndexWithStatusViewOf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**elastic_id** | **str** | | [optional] -**index_key** | **str** | | -**proj_key** | **str** | | [optional] -**query_options** | [**ElasticIndexSearchQueryOptions**](ElasticIndexSearchQueryOptions.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDefaultValues.md b/docs/apis/public/ProjectDefaultValues.md deleted file mode 100644 index e54e7d44..00000000 --- a/docs/apis/public/ProjectDefaultValues.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectDefaultValues - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ccs_project** | [**ProjectDefaultValuesCcsProject**](ProjectDefaultValuesCcsProject.md) | | [optional] -**dataflow** | [**ProjectDefaultValuesDataflow**](ProjectDefaultValuesDataflow.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDefaultValuesCcsProject.md b/docs/apis/public/ProjectDefaultValuesCcsProject.md deleted file mode 100644 index cf927cd3..00000000 --- a/docs/apis/public/ProjectDefaultValuesCcsProject.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectDefaultValuesCcsProject - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection_name** | **str** | | [optional] -**name** | **str** | | -**proj_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDefaultValuesDataflow.md b/docs/apis/public/ProjectDefaultValuesDataflow.md deleted file mode 100644 index baf8a67f..00000000 --- a/docs/apis/public/ProjectDefaultValuesDataflow.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectDefaultValuesDataflow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**df_tpl_key** | **str** | | -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectFlavourTotalKgs.md b/docs/apis/public/ProjectFlavourTotalKgs.md deleted file mode 100644 index 6677e918..00000000 --- a/docs/apis/public/ProjectFlavourTotalKgs.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectFlavourTotalKgs - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**flavour_name** | **str** | | -**proj_key** | **str** | | -**total_kgs** | **int** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectFlavours.md b/docs/apis/public/ProjectFlavours.md deleted file mode 100644 index 8bfb59c0..00000000 --- a/docs/apis/public/ProjectFlavours.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectFlavours - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**flavours** | [**list[BagFlavourFullData]**](BagFlavourFullData.md) | | -**proj_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectPackageInstalationManifest.md b/docs/apis/public/ProjectPackageInstalationManifest.md deleted file mode 100644 index 3cf693f7..00000000 --- a/docs/apis/public/ProjectPackageInstalationManifest.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectPackageInstalationManifest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**packages** | [**list[ProjectProjKeyPackagesPackages]**](ProjectProjKeyPackagesPackages.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyAnnotateDocumentReportDocument.md b/docs/apis/public/ProjectProjKeyAnnotateDocumentReportDocument.md deleted file mode 100644 index 6f229df8..00000000 --- a/docs/apis/public/ProjectProjKeyAnnotateDocumentReportDocument.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyAnnotateDocumentReportDocument - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**input_scratch_id** | **str** | | -**output_scratch_id** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyAnnotateDocumentReportReport.md b/docs/apis/public/ProjectProjKeyAnnotateDocumentReportReport.md deleted file mode 100644 index f3536c1e..00000000 --- a/docs/apis/public/ProjectProjKeyAnnotateDocumentReportReport.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyAnnotateDocumentReportReport - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | [optional] -**review_consent** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md b/docs/apis/public/ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md deleted file mode 100644 index f03c4a33..00000000 --- a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**render_options** | [**ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRenderOptions**](ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRenderOptions.md) | | [optional] -**template** | **str** | | [optional] -**variables** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRenderOptions.md b/docs/apis/public/ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRenderOptions.md deleted file mode 100644 index e4a5ecf1..00000000 --- a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRenderOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRenderOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**target_bag** | [**object**](.md) | | [optional] -**variables** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfo.md b/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfo.md deleted file mode 100644 index 5c1e809e..00000000 --- a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfo.md +++ /dev/null @@ -1,14 +0,0 @@ -# ProjectProjKeyBagsBagKeyTasksExportDatasetInfo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection_key** | **str** | | [optional] -**coords** | [**ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoords**](ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoords.md) | | -**include_s3_data** | **bool** | | [optional] [default to False] -**node_list** | [**list[ProjectProjKeyBagsBagKeyTasksExportDatasetInfoNodeList]**](ProjectProjKeyBagsBagKeyTasksExportDatasetInfoNodeList.md) | | [optional] -**projection** | [**object**](.md) | A dict specifying the fields to include or exclude. Use a dict to exclude fields from the result (e.g. projection={'main-text': false}). | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoords.md b/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoords.md deleted file mode 100644 index f62aa205..00000000 --- a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoords.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoords - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**databases** | [**object**](.md) | | -**node_collection** | [**ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoordsNodeCollection**](ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoordsNodeCollection.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoordsNodeCollection.md b/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoordsNodeCollection.md deleted file mode 100644 index d7688c04..00000000 --- a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoordsNodeCollection.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoordsNodeCollection - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection** | **str** | | -**collection_name_prefix** | **str** | | -**database** | **str** | | -**uri** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoNodeList.md b/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoNodeList.md deleted file mode 100644 index 61961962..00000000 --- a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoNodeList.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyBagsBagKeyTasksExportDatasetInfoNodeList - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**db** | **str** | | -**id** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksSuspendSnapshot.md b/docs/apis/public/ProjectProjKeyBagsBagKeyTasksSuspendSnapshot.md deleted file mode 100644 index af9decd5..00000000 --- a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksSuspendSnapshot.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectProjKeyBagsBagKeyTasksSuspendSnapshot - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcs.md b/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcs.md deleted file mode 100644 index 82282f3e..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcs.md +++ /dev/null @@ -1,14 +0,0 @@ -# ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcs - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**auth_token** | **str** | | [optional] -**export_package_mongo_options** | [**ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptions**](ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptions.md) | | [optional] -**proj_key** | **str** | | -**source_collection_name** | **str** | | [optional] -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptions.md b/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptions.md deleted file mode 100644 index 72d9239a..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptions.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**assemble_options** | [**ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptions**](ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptions.md) | | -**incremental** | **bool** | | -**inputs** | [**ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsInputs**](ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsInputs.md) | | [optional] -**package_options** | [**ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsPackageOptions**](ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsPackageOptions.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptions.md b/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptions.md deleted file mode 100644 index e83c0958..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mode** | [**ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsMode**](ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsMode.md) | | -**options** | [**ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsOptions**](ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsOptions.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsMode.md b/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsMode.md deleted file mode 100644 index 6b2db980..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsMode.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsMode - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**page_elements** | **list[str]** | Which type of annotations to filter for the page elements: H (human annotations), M (model generated) | -**tables** | **list[str]** | Which type of annotations to filter for the tables: H (human annotations), M (model generated) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsOptions.md b/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsOptions.md deleted file mode 100644 index dbafda64..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**include_incomplete_documents** | **bool** | Include documents with missing pages? (e.g. no annotations for some pages) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsInputs.md b/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsInputs.md deleted file mode 100644 index 3246d2df..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsInputs.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsInputs - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**document_hashes** | **list[str]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsPackageOptions.md b/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsPackageOptions.md deleted file mode 100644 index 1431be6b..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsPackageOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsPackageOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**match_mode** | **str** | | [optional] [default to 'document_hash'] -**redirect_keys_to_s3** | **list[str]** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesFromMongoOptions.md b/docs/apis/public/ProjectProjKeyDataCataloguesFromMongoOptions.md deleted file mode 100644 index 8547b629..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesFromMongoOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectProjKeyDataCataloguesFromMongoOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**coordinates** | [**MongoS3CoordinatesWithCollectionList**](MongoS3CoordinatesWithCollectionList.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesFromMongoTarget.md b/docs/apis/public/ProjectProjKeyDataCataloguesFromMongoTarget.md deleted file mode 100644 index 8369654c..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesFromMongoTarget.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectProjKeyDataCataloguesFromMongoTarget - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesFromUrlOptions.md b/docs/apis/public/ProjectProjKeyDataCataloguesFromUrlOptions.md deleted file mode 100644 index a68648e7..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesFromUrlOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectProjKeyDataCataloguesFromUrlOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataIndicesIndexKeyActionsCcsConvertUploadS3Source.md b/docs/apis/public/ProjectProjKeyDataIndicesIndexKeyActionsCcsConvertUploadS3Source.md deleted file mode 100644 index 41054b02..00000000 --- a/docs/apis/public/ProjectProjKeyDataIndicesIndexKeyActionsCcsConvertUploadS3Source.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectProjKeyDataIndicesIndexKeyActionsCcsConvertUploadS3Source - -Coordinates to object store to get files to convert. Can specify which files with object keys. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**coordinates** | [**ProjectDataIndexS3Coordinates**](ProjectDataIndexS3Coordinates.md) | | [optional] -**object_keys** | **list[str]** | List of s3 object keys to retrieve from bucket to be converted and uploaded to the data index | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDictionariesFromMongoTarget.md b/docs/apis/public/ProjectProjKeyDictionariesFromMongoTarget.md deleted file mode 100644 index c07fb23d..00000000 --- a/docs/apis/public/ProjectProjKeyDictionariesFromMongoTarget.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectProjKeyDictionariesFromMongoTarget - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDebugDfTplKeyTargetBag.md b/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDebugDfTplKeyTargetBag.md deleted file mode 100644 index e6d52966..00000000 --- a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDebugDfTplKeyTargetBag.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyKgcDataflowTemplatesDebugDfTplKeyTargetBag - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bag_key** | **str** | | -**proj_key** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRender.md b/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRender.md deleted file mode 100644 index 4720b35d..00000000 --- a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRender.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRender - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**target_bag** | [**ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag**](ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag.md) | | -**variables** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag.md b/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag.md deleted file mode 100644 index a3d7e30f..00000000 --- a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bag_key** | **str** | | -**proj_key** | **str** | If set, this will override the 'proj_key' parameter in the path, allowing cross-project KGs to be used. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadTarget.md b/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadTarget.md deleted file mode 100644 index 0b984d51..00000000 --- a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadTarget.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadTarget - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**save** | [**object**](.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesVariables.md b/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesVariables.md deleted file mode 100644 index a405d787..00000000 --- a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesVariables.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyKgcDataflowTemplatesVariables - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**default_value** | [**object**](.md) | | [optional] -**type** | [**DataFlowTemplateVariable**](DataFlowTemplateVariable.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlow.md b/docs/apis/public/ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlow.md deleted file mode 100644 index a1754669..00000000 --- a/docs/apis/public/ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlow.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**template** | [**ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlowTemplate**](ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlowTemplate.md) | | -**variables** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlowTemplate.md b/docs/apis/public/ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlowTemplate.md deleted file mode 100644 index aface6ef..00000000 --- a/docs/apis/public/ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlowTemplate.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlowTemplate - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**config** | [**object**](.md) | | -**data_flow** | **list[object]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyModelConfigsConfigurations.md b/docs/apis/public/ProjectProjKeyModelConfigsConfigurations.md deleted file mode 100644 index c874e95c..00000000 --- a/docs/apis/public/ProjectProjKeyModelConfigsConfigurations.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectProjKeyModelConfigsConfigurations - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyPackagesPackages.md b/docs/apis/public/ProjectProjKeyPackagesPackages.md deleted file mode 100644 index 94255ea2..00000000 --- a/docs/apis/public/ProjectProjKeyPackagesPackages.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyPackagesPackages - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**overrides** | [**object**](.md) | | [optional] -**package_id** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectTask.md b/docs/apis/public/ProjectTask.md deleted file mode 100644 index d54e624e..00000000 --- a/docs/apis/public/ProjectTask.md +++ /dev/null @@ -1,19 +0,0 @@ -# ProjectTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**completed_at** | **float** | | [optional] -**created_at** | **float** | | [optional] -**meta** | [**object**](.md) | | [optional] -**progress** | **float** | | [optional] -**proj_key** | **str** | | [optional] -**started_at** | **float** | | [optional] -**task_id** | **str** | | [optional] -**task_status** | **str** | | [optional] -**task_type** | **str** | | [optional] -**user_key** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectsFlavours.md b/docs/apis/public/ProjectsFlavours.md deleted file mode 100644 index c4ef2a31..00000000 --- a/docs/apis/public/ProjectsFlavours.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectsFlavours - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**flavours** | [**list[ProjectsFlavoursFlavours]**](ProjectsFlavoursFlavours.md) | | -**name** | **str** | | -**proj_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectsFlavoursFlavours.md b/docs/apis/public/ProjectsFlavoursFlavours.md deleted file mode 100644 index 0b89c6cd..00000000 --- a/docs/apis/public/ProjectsFlavoursFlavours.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectsFlavoursFlavours - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**display_name** | **str** | | [optional] -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectsFlavoursQuota.md b/docs/apis/public/ProjectsFlavoursQuota.md deleted file mode 100644 index d72a16c3..00000000 --- a/docs/apis/public/ProjectsFlavoursQuota.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectsFlavoursQuota - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**proj_key** | **str** | | -**quotas** | [**list[FlavoursQuota]**](FlavoursQuota.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/RelatedTask.md b/docs/apis/public/RelatedTask.md deleted file mode 100644 index 36282633..00000000 --- a/docs/apis/public/RelatedTask.md +++ /dev/null @@ -1,11 +0,0 @@ -# RelatedTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**task_id** | **str** | | -**task_type** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/RelationshipAnnotationColumn.md b/docs/apis/public/RelationshipAnnotationColumn.md deleted file mode 100644 index 46d6a362..00000000 --- a/docs/apis/public/RelationshipAnnotationColumn.md +++ /dev/null @@ -1,11 +0,0 @@ -# RelationshipAnnotationColumn - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**entities** | **list[str]** | | -**key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/RelationshipAnnotationDescriptor.md b/docs/apis/public/RelationshipAnnotationDescriptor.md deleted file mode 100644 index 7160014b..00000000 --- a/docs/apis/public/RelationshipAnnotationDescriptor.md +++ /dev/null @@ -1,12 +0,0 @@ -# RelationshipAnnotationDescriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**columns** | [**list[RelationshipAnnotationColumn]**](RelationshipAnnotationColumn.md) | | -**description** | **str** | | -**key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/RenderDataFlowTemplateOptions.md b/docs/apis/public/RenderDataFlowTemplateOptions.md deleted file mode 100644 index bb4fd209..00000000 --- a/docs/apis/public/RenderDataFlowTemplateOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# RenderDataFlowTemplateOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**target_bag** | [**ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag**](ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag.md) | | -**variables** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/RestoreKnowledgeGraphBackupOptions.md b/docs/apis/public/RestoreKnowledgeGraphBackupOptions.md deleted file mode 100644 index 998bfa4d..00000000 --- a/docs/apis/public/RestoreKnowledgeGraphBackupOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# RestoreKnowledgeGraphBackupOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**coordinates** | [**S3CoordinatesWithBackupKey**](S3CoordinatesWithBackupKey.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ResumeKnowledgeGraphOptions.md b/docs/apis/public/ResumeKnowledgeGraphOptions.md deleted file mode 100644 index e1af3d8b..00000000 --- a/docs/apis/public/ResumeKnowledgeGraphOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# ResumeKnowledgeGraphOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reset** | **bool** | | [optional] -**snapshot_to_restore_id** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/RunDataFlowTemplateOptions.md b/docs/apis/public/RunDataFlowTemplateOptions.md deleted file mode 100644 index ac3481d0..00000000 --- a/docs/apis/public/RunDataFlowTemplateOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# RunDataFlowTemplateOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**target_bag_key** | **str** | | [optional] -**variables** | **dict(str, object)** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/RunDataFlowTemplateOptions1.md b/docs/apis/public/RunDataFlowTemplateOptions1.md deleted file mode 100644 index 6492c0a7..00000000 --- a/docs/apis/public/RunDataFlowTemplateOptions1.md +++ /dev/null @@ -1,12 +0,0 @@ -# RunDataFlowTemplateOptions1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flow** | [**ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlow**](ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlow.md) | | -**log_task** | **bool** | | [default to True] -**variable_values** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/S3Coordinates.md b/docs/apis/public/S3Coordinates.md deleted file mode 100644 index 7c869b6b..00000000 --- a/docs/apis/public/S3Coordinates.md +++ /dev/null @@ -1,19 +0,0 @@ -# S3Coordinates - -If provided, the S3 data will be copied -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_key** | **str** | | -**bucket** | **str** | | -**host** | **str** | | -**key_prefix** | **str** | | -**location** | **str** | | -**port** | **int** | | -**secret_key** | **str** | | -**ssl** | **bool** | | -**verify_ssl** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/S3CoordinatesWithBackupKey.md b/docs/apis/public/S3CoordinatesWithBackupKey.md deleted file mode 100644 index e25787c5..00000000 --- a/docs/apis/public/S3CoordinatesWithBackupKey.md +++ /dev/null @@ -1,19 +0,0 @@ -# S3CoordinatesWithBackupKey - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_key** | **str** | | [optional] -**backup_key** | **str** | | -**bucket** | **str** | | -**host** | **str** | | [optional] -**location** | **str** | | [optional] -**port** | **int** | | [optional] -**presigned** | [**S3CoordinatesWithBackupKeyPresigned**](S3CoordinatesWithBackupKeyPresigned.md) | | [optional] -**secret_key** | **str** | | [optional] -**ssl** | **bool** | | [optional] -**verify_ssl** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/S3CoordinatesWithBackupKeyPresigned.md b/docs/apis/public/S3CoordinatesWithBackupKeyPresigned.md deleted file mode 100644 index 1b3d0922..00000000 --- a/docs/apis/public/S3CoordinatesWithBackupKeyPresigned.md +++ /dev/null @@ -1,11 +0,0 @@ -# S3CoordinatesWithBackupKeyPresigned - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fields** | **dict(str, object)** | | -**url** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SemanticApi.md b/docs/apis/public/SemanticApi.md deleted file mode 100644 index 8b2c85bf..00000000 --- a/docs/apis/public/SemanticApi.md +++ /dev/null @@ -1,168 +0,0 @@ -# deepsearch.cps.apis.public.SemanticApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**ingest**](SemanticApi.md#ingest) | **POST** /project/{proj_key}/semantic/ingest | -[**ingest_documentqa**](SemanticApi.md#ingest_documentqa) | **POST** /project/{proj_key}/ingest/documentqa | - - -# **ingest** -> Task ingest(proj_key, body) - - - -Ingest documents and collections for RAG - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SemanticApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.SemanticIngestRequest() # SemanticIngestRequest | - - try: - api_response = api_instance.ingest(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling SemanticApi->ingest: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**SemanticIngestRequest**](SemanticIngestRequest.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **ingest_documentqa** -> Task ingest_documentqa(proj_key, body) - - - -Ingest a document for QA - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SemanticApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.IngestDocumentQARequest() # IngestDocumentQARequest | - - try: - api_response = api_instance.ingest_documentqa(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling SemanticApi->ingest_documentqa: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**IngestDocumentQARequest**](IngestDocumentQARequest.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/SemanticIngestReqParams.md b/docs/apis/public/SemanticIngestReqParams.md deleted file mode 100644 index 4bacb6b9..00000000 --- a/docs/apis/public/SemanticIngestReqParams.md +++ /dev/null @@ -1,10 +0,0 @@ -# SemanticIngestReqParams - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**skip_ingested_docs** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SemanticIngestRequest.md b/docs/apis/public/SemanticIngestRequest.md deleted file mode 100644 index e78c90bb..00000000 --- a/docs/apis/public/SemanticIngestRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# SemanticIngestRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parameters** | [**SemanticIngestReqParams**](SemanticIngestReqParams.md) | | -**source** | [**object**](.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/StorageSummaryDC.md b/docs/apis/public/StorageSummaryDC.md deleted file mode 100644 index 74e5e1f3..00000000 --- a/docs/apis/public/StorageSummaryDC.md +++ /dev/null @@ -1,15 +0,0 @@ -# StorageSummaryDC - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dc_key** | **str** | | -**name** | **str** | | -**size_bytes_db** | **float** | | -**size_bytes_s3** | **float** | | -**size_converted_db** | **str** | | -**size_converted_s3** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/StorageSummaryKG.md b/docs/apis/public/StorageSummaryKG.md deleted file mode 100644 index 2d83d6e3..00000000 --- a/docs/apis/public/StorageSummaryKG.md +++ /dev/null @@ -1,16 +0,0 @@ -# StorageSummaryKG - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bag_key** | **str** | | -**categories_fraction** | [**list[StorageSummaryKGCategoriesFraction]**](StorageSummaryKGCategoriesFraction.md) | | -**name** | **str** | | -**size_bytes_db** | **float** | | -**size_bytes_s3** | **float** | | -**size_converted_db** | **str** | | -**size_converted_s3** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/StorageSummaryKGCategoriesFraction.md b/docs/apis/public/StorageSummaryKGCategoriesFraction.md deleted file mode 100644 index 50e71ff3..00000000 --- a/docs/apis/public/StorageSummaryKGCategoriesFraction.md +++ /dev/null @@ -1,14 +0,0 @@ -# StorageSummaryKGCategoriesFraction - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**color** | **str** | | [optional] -**name** | **str** | | -**percentage** | **float** | | -**size_bytes_db** | **float** | | -**size_converted_db** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/StorageSummaryTask.md b/docs/apis/public/StorageSummaryTask.md deleted file mode 100644 index 143491bd..00000000 --- a/docs/apis/public/StorageSummaryTask.md +++ /dev/null @@ -1,14 +0,0 @@ -# StorageSummaryTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dc_key** | **str** | | [optional] -**kg_key** | **str** | | [optional] -**kind** | **str** | | -**proj_key** | **str** | | -**task_id** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SupportedAnnotatorAnnotations.md b/docs/apis/public/SupportedAnnotatorAnnotations.md deleted file mode 100644 index 5d0afd48..00000000 --- a/docs/apis/public/SupportedAnnotatorAnnotations.md +++ /dev/null @@ -1,12 +0,0 @@ -# SupportedAnnotatorAnnotations - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**entities** | [**list[EntityAnnotationDescriptor]**](EntityAnnotationDescriptor.md) | | -**relationships** | [**list[RelationshipAnnotationDescriptor]**](RelationshipAnnotationDescriptor.md) | | -**supported_object_types** | **list[str]** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SuspendKnowledgeGraphOptions.md b/docs/apis/public/SuspendKnowledgeGraphOptions.md deleted file mode 100644 index b600c874..00000000 --- a/docs/apis/public/SuspendKnowledgeGraphOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# SuspendKnowledgeGraphOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**force** | **bool** | If true, the KG will be suspended even if it's busy | -**snapshot** | [**ProjectProjKeyBagsBagKeyTasksSuspendSnapshot**](ProjectProjKeyBagsBagKeyTasksSuspendSnapshot.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemApi.md b/docs/apis/public/SystemApi.md deleted file mode 100644 index 46b7630e..00000000 --- a/docs/apis/public/SystemApi.md +++ /dev/null @@ -1,1790 +0,0 @@ -# deepsearch.cps.apis.public.SystemApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**delete_flavour**](SystemApi.md#delete_flavour) | **DELETE** /system/admin/delete_flavour/{flavour_name} | -[**get_flavour**](SystemApi.md#get_flavour) | **GET** /system/admin/get_flavour/{flavour_name} | -[**get_flavours_default_quotas**](SystemApi.md#get_flavours_default_quotas) | **GET** /system/admin/get_flavours_default_quota | -[**get_project_flavour_total_kgs**](SystemApi.md#get_project_flavour_total_kgs) | **GET** /system/admin/get_project_flavour_total_kgs/{proj_key}/{flavour_name} | -[**get_project_flavours_quota**](SystemApi.md#get_project_flavours_quota) | **GET** /system/admin/get_project_flavours_quota/{proj_key} | -[**get_projects_flavours_quota**](SystemApi.md#get_projects_flavours_quota) | **GET** /system/admin/get_projects_flavours_quota | -[**get_system_information**](SystemApi.md#get_system_information) | **GET** /system/info | -[**get_system_modules_configuration**](SystemApi.md#get_system_modules_configuration) | **GET** /system/modules/configuration | -[**get_system_modules_tasks**](SystemApi.md#get_system_modules_tasks) | **GET** /system/modules/tasks | -[**get_version_report**](SystemApi.md#get_version_report) | **GET** /deployment/info | -[**list_all_flavours**](SystemApi.md#list_all_flavours) | **GET** /system/admin/list_all_flavours | -[**list_flavours_by_project**](SystemApi.md#list_flavours_by_project) | **GET** /system/admin/get_project_flavours/{proj_key} | -[**list_packages**](SystemApi.md#list_packages) | **GET** /system/packages | -[**list_projects_flavours**](SystemApi.md#list_projects_flavours) | **GET** /system/admin/list_projects_flavours | -[**list_system_knowledge_graphs**](SystemApi.md#list_system_knowledge_graphs) | **GET** /system/kgs | -[**save_flavour**](SystemApi.md#save_flavour) | **PUT** /system/admin/save_flavour | -[**save_flavours_default_quotas**](SystemApi.md#save_flavours_default_quotas) | **PUT** /system/admin/save_flavours_default_quota | -[**save_project_flavours**](SystemApi.md#save_project_flavours) | **PUT** /system/admin/save_project_flavours | -[**save_project_flavours_quota**](SystemApi.md#save_project_flavours_quota) | **PUT** /system/admin/save_project_flavours_quota | -[**system_get_all_dcs_admin**](SystemApi.md#system_get_all_dcs_admin) | **GET** /system/admin/get_all_dcs | -[**system_get_all_kgs_admin**](SystemApi.md#system_get_all_kgs_admin) | **GET** /system/admin/get_all_kgs | -[**system_get_cps_summary**](SystemApi.md#system_get_cps_summary) | **GET** /system/admin/summary | -[**system_get_dc_storage_summary_async**](SystemApi.md#system_get_dc_storage_summary_async) | **GET** /system/admin/dc_storage_summary/{dc_key} | -[**system_get_kg_storage_summary_async**](SystemApi.md#system_get_kg_storage_summary_async) | **GET** /system/admin/kg_storage_summary/{kg_key} | - - -# **delete_flavour** -> delete_flavour(flavour_name) - - - -Delete flavour from db - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - flavour_name = 'flavour_name_example' # str | - - try: - api_instance.delete_flavour(flavour_name) - except ApiException as e: - print("Exception when calling SystemApi->delete_flavour: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **flavour_name** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Deleted flavour successful | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_flavour** -> BagFlavourFullData get_flavour(flavour_name) - - - -Get flavour from db - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - flavour_name = 'flavour_name_example' # str | - - try: - api_response = api_instance.get_flavour(flavour_name) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_flavour: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **flavour_name** | **str**| | - -### Return type - -[**BagFlavourFullData**](BagFlavourFullData.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Get flavour successful | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_flavours_default_quotas** -> list[BagFlavourDefaultQuota] get_flavours_default_quotas() - - - -Get flavours default values - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.get_flavours_default_quotas() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_flavours_default_quotas: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[BagFlavourDefaultQuota]**](BagFlavourDefaultQuota.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Flavours default values | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_flavour_total_kgs** -> ProjectFlavourTotalKgs get_project_flavour_total_kgs(proj_key, flavour_name) - - - -Gets kg total number by proj_key and flavour_key - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - proj_key = 'proj_key_example' # str | -flavour_name = 'flavour_name_example' # str | - - try: - api_response = api_instance.get_project_flavour_total_kgs(proj_key, flavour_name) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_project_flavour_total_kgs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **flavour_name** | **str**| | - -### Return type - -[**ProjectFlavourTotalKgs**](ProjectFlavourTotalKgs.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Project flavours total kg number | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_flavours_quota** -> list[FlavoursQuota] get_project_flavours_quota(proj_key) - - - -Get project flavours quota - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - proj_key = 'proj_key_example' # str | - - try: - api_response = api_instance.get_project_flavours_quota(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_project_flavours_quota: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - -### Return type - -[**list[FlavoursQuota]**](FlavoursQuota.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Project flavours quota | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_projects_flavours_quota** -> list[ProjectsFlavoursQuota] get_projects_flavours_quota() - - - -Get projects flavours quotas - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.get_projects_flavours_quota() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_projects_flavours_quota: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[ProjectsFlavoursQuota]**](ProjectsFlavoursQuota.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Projects flavours quotas | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_system_information** -> SystemInfo get_system_information() - - - -Get system info - -### Example - -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient() as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.get_system_information() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_system_information: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**SystemInfo**](SystemInfo.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_system_modules_configuration** -> SystemModulesConfiguration get_system_modules_configuration() - - - -Get modules configuration - -### Example - -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient() as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.get_system_modules_configuration() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_system_modules_configuration: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**SystemModulesConfiguration**](SystemModulesConfiguration.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Modules configuration | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_system_modules_tasks** -> SystemModulesTasks get_system_modules_tasks() - - - -Get modules tasks - -### Example - -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient() as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.get_system_modules_tasks() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_system_modules_tasks: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**SystemModulesTasks**](SystemModulesTasks.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Modules tasks | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_version_report** -> get_version_report() - - - -Get deployment version report - -### Example - -* Api Key Authentication (ManagementKey): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: ManagementKey -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_instance.get_version_report() - except ApiException as e: - print("Exception when calling SystemApi->get_version_report: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -void (empty response body) - -### Authorization - -[ManagementKey](../README.md#ManagementKey) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Authentication failed, management api token is invalid or doesn't match | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_all_flavours** -> list[BagFlavourFullData] list_all_flavours() - - - -Get all KG flavours storage on db - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.list_all_flavours() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->list_all_flavours: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[BagFlavourFullData]**](BagFlavourFullData.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Flavours storage on db | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_flavours_by_project** -> ProjectFlavours list_flavours_by_project(proj_key) - - - -Get project assignment flavours - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - proj_key = 'proj_key_example' # str | - - try: - api_response = api_instance.list_flavours_by_project(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->list_flavours_by_project: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - -### Return type - -[**ProjectFlavours**](ProjectFlavours.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Ok | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_packages** -> list[CpsPackage] list_packages() - - - -Get packages available in this CPS installation for installing in a project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.list_packages() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->list_packages: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[CpsPackage]**](CpsPackage.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Packages available to this CPS installation | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_projects_flavours** -> list[ProjectsFlavours] list_projects_flavours() - - - -Get all projects and their flavours - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.list_projects_flavours() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->list_projects_flavours: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[ProjectsFlavours]**](ProjectsFlavours.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Flavours storage on db | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_system_knowledge_graphs** -> list[KnowledgeGraphSystemInformation] list_system_knowledge_graphs(proj_key=proj_key, term=term) - - - -List all Knowledge Graphs in the system - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - proj_key = 'proj_key_example' # str | (optional) -term = 'term_example' # str | (optional) - - try: - api_response = api_instance.list_system_knowledge_graphs(proj_key=proj_key, term=term) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->list_system_knowledge_graphs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | [optional] - **term** | **str**| | [optional] - -### Return type - -[**list[KnowledgeGraphSystemInformation]**](KnowledgeGraphSystemInformation.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **save_flavour** -> save_flavour(new_flavour, body) - - - -Save flavour on db - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - new_flavour = True # bool | -body = deepsearch.cps.apis.public.BagFlavourFullData() # BagFlavourFullData | - - try: - api_instance.save_flavour(new_flavour, body) - except ApiException as e: - print("Exception when calling SystemApi->save_flavour: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **new_flavour** | **bool**| | - **body** | [**BagFlavourFullData**](BagFlavourFullData.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Save flavour successful | - | -**409** | Flavour name already taken | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **save_flavours_default_quotas** -> list[BagFlavourDefaultQuota] save_flavours_default_quotas(flavours) - - - -Save flavours default quota - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - flavours = [deepsearch.cps.apis.public.BagFlavourDefaultQuota()] # list[BagFlavourDefaultQuota] | - - try: - api_response = api_instance.save_flavours_default_quotas(flavours) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->save_flavours_default_quotas: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **flavours** | [**list[BagFlavourDefaultQuota]**](BagFlavourDefaultQuota.md)| | - -### Return type - -[**list[BagFlavourDefaultQuota]**](BagFlavourDefaultQuota.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Save flavours default quotas successful | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **save_project_flavours** -> save_project_flavours(body) - - - -Save project flavours assignment on db - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - body = deepsearch.cps.apis.public.ProjectsFlavours() # ProjectsFlavours | - - try: - api_instance.save_project_flavours(body) - except ApiException as e: - print("Exception when calling SystemApi->save_project_flavours: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**ProjectsFlavours**](ProjectsFlavours.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Save project flavours successful | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **save_project_flavours_quota** -> save_project_flavours_quota(projects_flavours_quotas) - - - -Save project flavours quota - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - projects_flavours_quotas = deepsearch.cps.apis.public.ProjectsFlavoursQuota() # ProjectsFlavoursQuota | - - try: - api_instance.save_project_flavours_quota(projects_flavours_quotas) - except ApiException as e: - print("Exception when calling SystemApi->save_project_flavours_quota: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projects_flavours_quotas** | [**ProjectsFlavoursQuota**](ProjectsFlavoursQuota.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Save project flavours quota successful | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **system_get_all_dcs_admin** -> list[str] system_get_all_dcs_admin() - - - -Get all data catalogs (only dc_key) for admin use - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.system_get_all_dcs_admin() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->system_get_all_dcs_admin: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -**list[str]** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Array with all dcs's key | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **system_get_all_kgs_admin** -> list[str] system_get_all_kgs_admin() - - - -Get all kgs (only bag_key) for admin use - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.system_get_all_kgs_admin() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->system_get_all_kgs_admin: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -**list[str]** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Array with all kgs's key | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **system_get_cps_summary** -> list[InlineResponse2003] system_get_cps_summary() - - - -Get cps summary data. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.system_get_cps_summary() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->system_get_cps_summary: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[InlineResponse2003]**](InlineResponse2003.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Cps summary | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **system_get_dc_storage_summary_async** -> StorageSummaryTask system_get_dc_storage_summary_async(dc_key) - - - -Get dc storage summary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - dc_key = 'dc_key_example' # str | Data catalog key - - try: - api_response = api_instance.system_get_dc_storage_summary_async(dc_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->system_get_dc_storage_summary_async: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dc_key** | **str**| Data catalog key | - -### Return type - -[**StorageSummaryTask**](StorageSummaryTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | DC storage summary | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **system_get_kg_storage_summary_async** -> StorageSummaryTask system_get_kg_storage_summary_async(kg_key) - - - -Get kg storage summary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - kg_key = 'kg_key_example' # str | Knowledge graph key - - try: - api_response = api_instance.system_get_kg_storage_summary_async(kg_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->system_get_kg_storage_summary_async: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **kg_key** | **str**| Knowledge graph key | - -### Return type - -[**StorageSummaryTask**](StorageSummaryTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Kg storage summary | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/SystemCeleryTasksFailureFailures.md b/docs/apis/public/SystemCeleryTasksFailureFailures.md deleted file mode 100644 index 0b92c17a..00000000 --- a/docs/apis/public/SystemCeleryTasksFailureFailures.md +++ /dev/null @@ -1,13 +0,0 @@ -# SystemCeleryTasksFailureFailures - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**logs** | **dict(str, object)** | | [optional] -**meta** | **dict(str, object)** | | [optional] -**task_id** | **str** | | [optional] -**worker_name** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemInfo.md b/docs/apis/public/SystemInfo.md deleted file mode 100644 index d76a3b99..00000000 --- a/docs/apis/public/SystemInfo.md +++ /dev/null @@ -1,13 +0,0 @@ -# SystemInfo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**allow_non_admins_to_make_resources_public** | **bool** | | [optional] -**api** | [**SystemInfoApi**](SystemInfoApi.md) | | [optional] -**deployment** | [**SystemInfoDeployment**](SystemInfoDeployment.md) | | [optional] -**toolkit** | [**SystemInfoToolkit**](SystemInfoToolkit.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemInfoApi.md b/docs/apis/public/SystemInfoApi.md deleted file mode 100644 index 413682db..00000000 --- a/docs/apis/public/SystemInfoApi.md +++ /dev/null @@ -1,12 +0,0 @@ -# SystemInfoApi - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**build_date** | **int** | | [optional] -**commit_hash** | **str** | | [optional] -**version** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemInfoDeployment.md b/docs/apis/public/SystemInfoDeployment.md deleted file mode 100644 index d7f1926b..00000000 --- a/docs/apis/public/SystemInfoDeployment.md +++ /dev/null @@ -1,14 +0,0 @@ -# SystemInfoDeployment - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**disable_kg_actions** | **bool** | | [optional] -**disclaimer** | **str** | | [optional] -**linked_ccs_api** | [**SystemInfoDeploymentLinkedCcsApi**](SystemInfoDeploymentLinkedCcsApi.md) | | [optional] -**name** | **str** | | [optional] -**should_show_warning** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemInfoDeploymentLinkedCcsApi.md b/docs/apis/public/SystemInfoDeploymentLinkedCcsApi.md deleted file mode 100644 index 868c6073..00000000 --- a/docs/apis/public/SystemInfoDeploymentLinkedCcsApi.md +++ /dev/null @@ -1,11 +0,0 @@ -# SystemInfoDeploymentLinkedCcsApi - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**project_sync** | **bool** | | [optional] -**uri** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemInfoToolkit.md b/docs/apis/public/SystemInfoToolkit.md deleted file mode 100644 index 156a772b..00000000 --- a/docs/apis/public/SystemInfoToolkit.md +++ /dev/null @@ -1,14 +0,0 @@ -# SystemInfoToolkit - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cli_command** | **str** | | [optional] -**host** | **str** | | [optional] -**name** | **str** | | [optional] -**required_version** | **str** | | [optional] -**verify_ssl** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemKgsBackend.md b/docs/apis/public/SystemKgsBackend.md deleted file mode 100644 index e733ca8f..00000000 --- a/docs/apis/public/SystemKgsBackend.md +++ /dev/null @@ -1,11 +0,0 @@ -# SystemKgsBackend - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deployment** | [**SystemKgsDeployment**](SystemKgsDeployment.md) | | [optional] -**flavour** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemKgsDeployment.md b/docs/apis/public/SystemKgsDeployment.md deleted file mode 100644 index b575c7b3..00000000 --- a/docs/apis/public/SystemKgsDeployment.md +++ /dev/null @@ -1,13 +0,0 @@ -# SystemKgsDeployment - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chart** | **str** | | [optional] -**flavour** | **str** | | [optional] -**name** | **str** | | [optional] -**resources** | [**dict(str, SystemKgsDeploymentResources)**](SystemKgsDeploymentResources.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemKgsDeploymentResources.md b/docs/apis/public/SystemKgsDeploymentResources.md deleted file mode 100644 index 37d8a754..00000000 --- a/docs/apis/public/SystemKgsDeploymentResources.md +++ /dev/null @@ -1,11 +0,0 @@ -# SystemKgsDeploymentResources - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limits** | [**object**](.md) | | [optional] -**requests** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemModulesConfiguration.md b/docs/apis/public/SystemModulesConfiguration.md deleted file mode 100644 index 672613dd..00000000 --- a/docs/apis/public/SystemModulesConfiguration.md +++ /dev/null @@ -1,12 +0,0 @@ -# SystemModulesConfiguration - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**df_template_variables** | [**list[WellKnownDfTemplateVariable]**](WellKnownDfTemplateVariable.md) | | -**linked_ccs_instances** | [**list[LinkedCcsInstances]**](LinkedCcsInstances.md) | | -**linked_elastic_instances** | [**list[LinkedCcsInstances]**](LinkedCcsInstances.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemModulesTasks.md b/docs/apis/public/SystemModulesTasks.md deleted file mode 100644 index 44652789..00000000 --- a/docs/apis/public/SystemModulesTasks.md +++ /dev/null @@ -1,10 +0,0 @@ -# SystemModulesTasks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tasks** | [**dict(str, SystemModulesTasksTasks)**](SystemModulesTasksTasks.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemModulesTasksTasks.md b/docs/apis/public/SystemModulesTasksTasks.md deleted file mode 100644 index 327168fb..00000000 --- a/docs/apis/public/SystemModulesTasksTasks.md +++ /dev/null @@ -1,10 +0,0 @@ -# SystemModulesTasksTasks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**schema** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TakeSnapshotSettings.md b/docs/apis/public/TakeSnapshotSettings.md deleted file mode 100644 index a3a2c3d6..00000000 --- a/docs/apis/public/TakeSnapshotSettings.md +++ /dev/null @@ -1,12 +0,0 @@ -# TakeSnapshotSettings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**flavour** | **str** | | -**load_into_kg_after_created** | **bool** | | [optional] [default to False] -**name** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TakeSnapshotSettingsBackendAware.md b/docs/apis/public/TakeSnapshotSettingsBackendAware.md deleted file mode 100644 index 7f96d681..00000000 --- a/docs/apis/public/TakeSnapshotSettingsBackendAware.md +++ /dev/null @@ -1,12 +0,0 @@ -# TakeSnapshotSettingsBackendAware - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**backend_flavours** | [**BackendFlavour**](BackendFlavour.md) | | -**load_into_kg_after_created** | **bool** | | [optional] [default to False] -**name** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/Task.md b/docs/apis/public/Task.md deleted file mode 100644 index b28a47ac..00000000 --- a/docs/apis/public/Task.md +++ /dev/null @@ -1,16 +0,0 @@ -# Task - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error_reason** | **str** | | -**kind** | **str** | | -**proj_key** | **str** | | -**related_tasks** | [**list[RelatedTask]**](RelatedTask.md) | | [optional] -**task_id** | **str** | | -**task_status** | **str** | | -**task_type** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TasksApi.md b/docs/apis/public/TasksApi.md deleted file mode 100644 index 6d763798..00000000 --- a/docs/apis/public/TasksApi.md +++ /dev/null @@ -1,563 +0,0 @@ -# deepsearch.cps.apis.public.TasksApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**abort_project_task**](TasksApi.md#abort_project_task) | **POST** /project/{proj_key}/tasks/{task_id}/actions/abort | -[**get_project_celery_task**](TasksApi.md#get_project_celery_task) | **GET** /project/{proj_key}/celery_tasks/{task_id} | -[**get_project_task**](TasksApi.md#get_project_task) | **GET** /project/{proj_key}/tasks/{task_id} | -[**list_failure_celery_tasks**](TasksApi.md#list_failure_celery_tasks) | **GET** /system/celery_tasks/failure | -[**list_project_tasks**](TasksApi.md#list_project_tasks) | **GET** /project/{proj_key}/tasks | -[**list_system_celery_tasks**](TasksApi.md#list_system_celery_tasks) | **GET** /system/celery_tasks/status | - - -# **abort_project_task** -> abort_project_task(proj_key, task_id) - - - -Abort a task. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.TasksApi(api_client) - proj_key = 'proj_key_example' # str | -task_id = 'task_id_example' # str | - - try: - api_instance.abort_project_task(proj_key, task_id) - except ApiException as e: - print("Exception when calling TasksApi->abort_project_task: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **task_id** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Task aborted. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_celery_task** -> CeleryTaskPromise get_project_celery_task(proj_key, task_id) - - - -Get a celery task for a project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.TasksApi(api_client) - proj_key = 'proj_key_example' # str | -task_id = 'task_id_example' # str | - - try: - api_response = api_instance.get_project_celery_task(proj_key, task_id) - pprint(api_response) - except ApiException as e: - print("Exception when calling TasksApi->get_project_celery_task: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **task_id** | **str**| | - -### Return type - -[**CeleryTaskPromise**](CeleryTaskPromise.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task | - | -**404** | Task not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_task** -> ProjectTask get_project_task(proj_key, task_id) - - - -Get a task for a project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure API key authorization: KGAuth -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'X-CPS-KG-Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['X-CPS-KG-Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.TasksApi(api_client) - proj_key = 'proj_key_example' # str | -task_id = 'task_id_example' # str | - - try: - api_response = api_instance.get_project_task(proj_key, task_id) - pprint(api_response) - except ApiException as e: - print("Exception when calling TasksApi->get_project_task: %s\n" % e) -``` - -* Api Key Authentication (KGAuth): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure API key authorization: KGAuth -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'X-CPS-KG-Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['X-CPS-KG-Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.TasksApi(api_client) - proj_key = 'proj_key_example' # str | -task_id = 'task_id_example' # str | - - try: - api_response = api_instance.get_project_task(proj_key, task_id) - pprint(api_response) - except ApiException as e: - print("Exception when calling TasksApi->get_project_task: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **task_id** | **str**| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer), [KGAuth](../README.md#KGAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task | - | -**404** | Task not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_failure_celery_tasks** -> list[CeleryTask] list_failure_celery_tasks(proj_key, task_id) - - - -Get celery tasks that failed. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.TasksApi(api_client) - proj_key = 'proj_key_example' # str | -task_id = 'task_id_example' # str | - - try: - api_response = api_instance.list_failure_celery_tasks(proj_key, task_id) - pprint(api_response) - except ApiException as e: - print("Exception when calling TasksApi->list_failure_celery_tasks: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **task_id** | **str**| | - -### Return type - -[**list[CeleryTask]**](CeleryTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Celery tasks | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_tasks** -> list[ProjectTask] list_project_tasks(proj_key, task_type=task_type, limit=limit, skip=skip, sort_by=sort_by, sort_order=sort_order) - - - -List tasks for a project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.TasksApi(api_client) - proj_key = 'proj_key_example' # str | -task_type = 'task_type_example' # str | (optional) -limit = 50 # int | (optional) (default to 50) -skip = 0 # int | (optional) (default to 0) -sort_by = 'sort_by_example' # str | (optional) -sort_order = 'asc' # str | (optional) (default to 'asc') - - try: - api_response = api_instance.list_project_tasks(proj_key, task_type=task_type, limit=limit, skip=skip, sort_by=sort_by, sort_order=sort_order) - pprint(api_response) - except ApiException as e: - print("Exception when calling TasksApi->list_project_tasks: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **task_type** | **str**| | [optional] - **limit** | **int**| | [optional] [default to 50] - **skip** | **int**| | [optional] [default to 0] - **sort_by** | **str**| | [optional] - **sort_order** | **str**| | [optional] [default to 'asc'] - -### Return type - -[**list[ProjectTask]**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of tasks. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_system_celery_tasks** -> list[CeleryTask1] list_system_celery_tasks(proj_key=proj_key, project_task_id=project_task_id, started_since=started_since, task_status=task_status, limit=limit) - - - -Get the status of Celery tasks. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.TasksApi(api_client) - proj_key = 'proj_key_example' # str | (optional) -project_task_id = 'project_task_id_example' # str | (optional) -started_since = 3.4 # float | If set, return the tasks created at or after this timestamp. Otherwise, return the tasks created up to 60 minutes of the system's date, if `project_task_id` is not set. (optional) -task_status = 3.4 # float | (optional) -limit = 50 # int | (optional) (default to 50) - - try: - api_response = api_instance.list_system_celery_tasks(proj_key=proj_key, project_task_id=project_task_id, started_since=started_since, task_status=task_status, limit=limit) - pprint(api_response) - except ApiException as e: - print("Exception when calling TasksApi->list_system_celery_tasks: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | [optional] - **project_task_id** | **str**| | [optional] - **started_since** | **float**| If set, return the tasks created at or after this timestamp. Otherwise, return the tasks created up to 60 minutes of the system's date, if `project_task_id` is not set. | [optional] - **task_status** | **float**| | [optional] - **limit** | **int**| | [optional] [default to 50] - -### Return type - -[**list[CeleryTask1]**](CeleryTask1.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Celery tasks | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/TemporaryUploadFileResult.md b/docs/apis/public/TemporaryUploadFileResult.md deleted file mode 100644 index 6f38699c..00000000 --- a/docs/apis/public/TemporaryUploadFileResult.md +++ /dev/null @@ -1,16 +0,0 @@ -# TemporaryUploadFileResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**download** | [**TemporaryUploadFileResultDownload**](TemporaryUploadFileResultDownload.md) | | -**download_private** | [**TemporaryUploadFileResultDownloadPrivate**](TemporaryUploadFileResultDownloadPrivate.md) | | -**id** | **str** | ID of the temporary file. | -**metadata** | [**TemporaryUploadFileResultMetadata**](TemporaryUploadFileResultMetadata.md) | | -**metadata_private** | [**TemporaryUploadFileResultMetadataPrivate**](TemporaryUploadFileResultMetadataPrivate.md) | | -**upload** | [**TemporaryUploadFileResultUpload**](TemporaryUploadFileResultUpload.md) | | -**upload_private** | [**TemporaryUploadFileResultUploadPrivate**](TemporaryUploadFileResultUploadPrivate.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TemporaryUploadFileResultDownload.md b/docs/apis/public/TemporaryUploadFileResultDownload.md deleted file mode 100644 index 07dd97d9..00000000 --- a/docs/apis/public/TemporaryUploadFileResultDownload.md +++ /dev/null @@ -1,11 +0,0 @@ -# TemporaryUploadFileResultDownload - -URL to get the temporary file. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TemporaryUploadFileResultDownloadPrivate.md b/docs/apis/public/TemporaryUploadFileResultDownloadPrivate.md deleted file mode 100644 index d7d7609f..00000000 --- a/docs/apis/public/TemporaryUploadFileResultDownloadPrivate.md +++ /dev/null @@ -1,11 +0,0 @@ -# TemporaryUploadFileResultDownloadPrivate - -URL to get the temporary file. (private URL, usable within the infrastracture) -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TemporaryUploadFileResultMetadata.md b/docs/apis/public/TemporaryUploadFileResultMetadata.md deleted file mode 100644 index bd7857d4..00000000 --- a/docs/apis/public/TemporaryUploadFileResultMetadata.md +++ /dev/null @@ -1,11 +0,0 @@ -# TemporaryUploadFileResultMetadata - -URL to metadata of the temporary file using the HEAD HTTP method. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TemporaryUploadFileResultMetadataPrivate.md b/docs/apis/public/TemporaryUploadFileResultMetadataPrivate.md deleted file mode 100644 index 2d07f6d9..00000000 --- a/docs/apis/public/TemporaryUploadFileResultMetadataPrivate.md +++ /dev/null @@ -1,11 +0,0 @@ -# TemporaryUploadFileResultMetadataPrivate - -URL to metadata of the temporary file using the HEAD HTTP method. (private URL, usable within the infrastracture) -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TemporaryUploadFileResultUpload.md b/docs/apis/public/TemporaryUploadFileResultUpload.md deleted file mode 100644 index 9a5f9d42..00000000 --- a/docs/apis/public/TemporaryUploadFileResultUpload.md +++ /dev/null @@ -1,12 +0,0 @@ -# TemporaryUploadFileResultUpload - -URL to upload the temporary file. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fields** | [**object**](.md) | | [optional] -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TemporaryUploadFileResultUploadPrivate.md b/docs/apis/public/TemporaryUploadFileResultUploadPrivate.md deleted file mode 100644 index c04e38f5..00000000 --- a/docs/apis/public/TemporaryUploadFileResultUploadPrivate.md +++ /dev/null @@ -1,12 +0,0 @@ -# TemporaryUploadFileResultUploadPrivate - -URL to upload the temporary file. (private URL, usable within the infrastracture) -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fields** | [**object**](.md) | | [optional] -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TokenResponse.md b/docs/apis/public/TokenResponse.md deleted file mode 100644 index ee5100e3..00000000 --- a/docs/apis/public/TokenResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# TokenResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**token** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/Topology.md b/docs/apis/public/Topology.md deleted file mode 100644 index 2400668c..00000000 --- a/docs/apis/public/Topology.md +++ /dev/null @@ -1,11 +0,0 @@ -# Topology - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**categories** | [**list[TopologyNode]**](TopologyNode.md) | | -**edges** | [**list[TopologyEdge]**](TopologyEdge.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TopologyEdge.md b/docs/apis/public/TopologyEdge.md deleted file mode 100644 index 23da19de..00000000 --- a/docs/apis/public/TopologyEdge.md +++ /dev/null @@ -1,12 +0,0 @@ -# TopologyEdge - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**source** | **list[str]** | | -**target** | **list[str]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TopologyNode.md b/docs/apis/public/TopologyNode.md deleted file mode 100644 index a8a7e4aa..00000000 --- a/docs/apis/public/TopologyNode.md +++ /dev/null @@ -1,10 +0,0 @@ -# TopologyNode - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/UpdateDataFlowOptions.md b/docs/apis/public/UpdateDataFlowOptions.md deleted file mode 100644 index 3a7fcc84..00000000 --- a/docs/apis/public/UpdateDataFlowOptions.md +++ /dev/null @@ -1,14 +0,0 @@ -# UpdateDataFlowOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | [optional] -**name** | **str** | | -**public** | **bool** | | -**template** | [**DataFlowTemplate**](DataFlowTemplate.md) | | -**variables** | [**dict(str, ProjectProjKeyKgcDataflowTemplatesVariables)**](ProjectProjKeyKgcDataflowTemplatesVariables.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/UpdateProjectModelConfigOptions.md b/docs/apis/public/UpdateProjectModelConfigOptions.md deleted file mode 100644 index 58a94886..00000000 --- a/docs/apis/public/UpdateProjectModelConfigOptions.md +++ /dev/null @@ -1,13 +0,0 @@ -# UpdateProjectModelConfigOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**configurations** | [**ProjectProjKeyModelConfigsConfigurations**](ProjectProjKeyModelConfigsConfigurations.md) | | -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/UploadedFile.md b/docs/apis/public/UploadedFile.md deleted file mode 100644 index bd19941f..00000000 --- a/docs/apis/public/UploadedFile.md +++ /dev/null @@ -1,14 +0,0 @@ -# UploadedFile - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**filename** | **str** | | -**id** | **str** | ID of the temporary file. | -**proj_key** | **str** | | -**timestamp** | **float** | | -**user_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/UploadedFileResult.md b/docs/apis/public/UploadedFileResult.md deleted file mode 100644 index 864dec5c..00000000 --- a/docs/apis/public/UploadedFileResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# UploadedFileResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | ID of the temporary file. | -**url** | **str** | URL to get the temporary file form. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/UploadsApi.md b/docs/apis/public/UploadsApi.md deleted file mode 100644 index a38e2456..00000000 --- a/docs/apis/public/UploadsApi.md +++ /dev/null @@ -1,336 +0,0 @@ -# deepsearch.cps.apis.public.UploadsApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_project_scratch_file**](UploadsApi.md#create_project_scratch_file) | **POST** /project/{proj_key}/scratch/files/upload/{filename} | -[**list_project_scratch_files**](UploadsApi.md#list_project_scratch_files) | **GET** /project/{proj_key}/scratch/files | -[**list_project_scratch_files_paginated**](UploadsApi.md#list_project_scratch_files_paginated) | **GET** /project/{proj_key}/scratch/files_paginated | -[**upload_project_scratch_file**](UploadsApi.md#upload_project_scratch_file) | **POST** /project/{proj_key}/scratch/files | - - -# **create_project_scratch_file** -> TemporaryUploadFileResult create_project_scratch_file(proj_key, filename) - - - -Create file pointers for temporary storage - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.UploadsApi(api_client) - proj_key = 'proj_key_example' # str | -filename = 'filename_example' # str | - - try: - api_response = api_instance.create_project_scratch_file(proj_key, filename) - pprint(api_response) - except ApiException as e: - print("Exception when calling UploadsApi->create_project_scratch_file: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **filename** | **str**| | - -### Return type - -[**TemporaryUploadFileResult**](TemporaryUploadFileResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Temporary file details | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_scratch_files** -> list[UploadedFile] list_project_scratch_files(proj_key, scratch_ids=scratch_ids) - - - -Get temporary files uploaded to a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.UploadsApi(api_client) - proj_key = 'proj_key_example' # str | -scratch_ids = 'scratch_ids_example' # str | (optional) - - try: - api_response = api_instance.list_project_scratch_files(proj_key, scratch_ids=scratch_ids) - pprint(api_response) - except ApiException as e: - print("Exception when calling UploadsApi->list_project_scratch_files: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **scratch_ids** | **str**| | [optional] - -### Return type - -[**list[UploadedFile]**](UploadedFile.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Files | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_scratch_files_paginated** -> list[UploadedFile] list_project_scratch_files_paginated(proj_key, page=page, items_per_page=items_per_page, search_string=search_string, begin_date=begin_date, end_date=end_date) - - - -Get paginated list of temporary files uploaded to a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.UploadsApi(api_client) - proj_key = 'proj_key_example' # str | -page = 56 # int | page of the result list (optional) -items_per_page = 20 # int | items on one page of the result list (optional) (default to 20) -search_string = 'search_string_example' # str | search keyword (optional) -begin_date = 56 # int | begin date of the search date interval (optional) -end_date = 56 # int | end date of the search date interval (optional) - - try: - api_response = api_instance.list_project_scratch_files_paginated(proj_key, page=page, items_per_page=items_per_page, search_string=search_string, begin_date=begin_date, end_date=end_date) - pprint(api_response) - except ApiException as e: - print("Exception when calling UploadsApi->list_project_scratch_files_paginated: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **page** | **int**| page of the result list | [optional] - **items_per_page** | **int**| items on one page of the result list | [optional] [default to 20] - **search_string** | **str**| search keyword | [optional] - **begin_date** | **int**| begin date of the search date interval | [optional] - **end_date** | **int**| end date of the search date interval | [optional] - -### Return type - -[**list[UploadedFile]**](UploadedFile.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Files | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_project_scratch_file** -> UploadedFileResult upload_project_scratch_file(proj_key, file) - - - -Upload a file to temporary storage - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.UploadsApi(api_client) - proj_key = 'proj_key_example' # str | -file = '/path/to/file' # file | - - try: - api_response = api_instance.upload_project_scratch_file(proj_key, file) - pprint(api_response) - except ApiException as e: - print("Exception when calling UploadsApi->upload_project_scratch_file: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **file** | **file**| | - -### Return type - -[**UploadedFileResult**](UploadedFileResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | File uploaded | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/UsageStats.md b/docs/apis/public/UsageStats.md deleted file mode 100644 index dcb4be39..00000000 --- a/docs/apis/public/UsageStats.md +++ /dev/null @@ -1,12 +0,0 @@ -# UsageStats - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bag_key** | **str** | | [optional] -**last_command** | **str** | | [optional] -**proj_key** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/WellKnownDfTemplateVariable.md b/docs/apis/public/WellKnownDfTemplateVariable.md deleted file mode 100644 index 744ac58a..00000000 --- a/docs/apis/public/WellKnownDfTemplateVariable.md +++ /dev/null @@ -1,12 +0,0 @@ -# WellKnownDfTemplateVariable - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**id** | **str** | | -**type** | [**DataFlowTemplateVariable**](DataFlowTemplateVariable.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public_v2/CcsTask.md b/docs/apis/public_v2/CcsTask.md new file mode 100644 index 00000000..262395fc --- /dev/null +++ b/docs/apis/public_v2/CcsTask.md @@ -0,0 +1,31 @@ +# CcsTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**task_id** | **str** | | +**ccs_project_key** | **str** | | +**ccs_collection_name** | **str** | | + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.ccs_task import CcsTask + +# TODO update the JSON string below +json = "{}" +# create an instance of CcsTask from a JSON string +ccs_task_instance = CcsTask.from_json(json) +# print the JSON string representation of the object +print(CcsTask.to_json()) + +# convert the object into a dict +ccs_task_dict = ccs_task_instance.to_dict() +# create an instance of CcsTask from a dict +ccs_task_form_dict = ccs_task.from_dict(ccs_task_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public_v2/ConvertDocumentRequest.md b/docs/apis/public_v2/ConvertDocumentRequest.md new file mode 100644 index 00000000..dfce43de --- /dev/null +++ b/docs/apis/public_v2/ConvertDocumentRequest.md @@ -0,0 +1,30 @@ +# ConvertDocumentRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**http_source** | [**HttpSource**](HttpSource.md) | | [optional] +**file_source** | [**FileSource**](FileSource.md) | | [optional] + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.convert_document_request import ConvertDocumentRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ConvertDocumentRequest from a JSON string +convert_document_request_instance = ConvertDocumentRequest.from_json(json) +# print the JSON string representation of the object +print(ConvertDocumentRequest.to_json()) + +# convert the object into a dict +convert_document_request_dict = convert_document_request_instance.to_dict() +# create an instance of ConvertDocumentRequest from a dict +convert_document_request_form_dict = convert_document_request.from_dict(convert_document_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public_v2/ConvertDocumentsRequestBody.md b/docs/apis/public_v2/ConvertDocumentsRequestBody.md index 49dc00c3..93f757c1 100644 --- a/docs/apis/public_v2/ConvertDocumentsRequestBody.md +++ b/docs/apis/public_v2/ConvertDocumentsRequestBody.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**file_url** | **List[str]** | List of File's URL to be converted and uploaded to the data index. | [optional] -**internal_file_url** | [**List[InternalUrl]**](InternalUrl.md) | List of Internal File's URLs to be converted and uploaded to the data index. | [optional] -**s3_source** | [**S3DocumentSource**](S3DocumentSource.md) | Coordinates to object store to get files to convert. Can specify which files with object keys. | [optional] -**upload_to_elastic** | **bool** | | [optional] **conversion_settings** | [**PartialDirectConversionParameters**](PartialDirectConversionParameters.md) | Specify the conversion settings to use. | [optional] +**target_settings** | [**TargetConversionParameters**](TargetConversionParameters.md) | Specify the target settings to use. | [optional] +**document_hashes** | **List[str]** | List of document hashes to be used as filter. | [optional] +**without_operations** | **List[str]** | List of Operation Status documents don't have to be used as filter. | [optional] +**upload_to_elastic** | **bool** | | [optional] ## Example diff --git a/docs/apis/public_v2/ConvertDocumentsSources.md b/docs/apis/public_v2/ConvertDocumentsSources.md new file mode 100644 index 00000000..6ce0a065 --- /dev/null +++ b/docs/apis/public_v2/ConvertDocumentsSources.md @@ -0,0 +1,31 @@ +# ConvertDocumentsSources + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file_url** | **List[str]** | List of File's URL to be converted and uploaded to the data index. | [optional] +**internal_file_url** | [**List[InternalUrl]**](InternalUrl.md) | List of Internal File's URLs to be converted and uploaded to the data index. | [optional] +**s3_source** | [**S3DocumentSource**](S3DocumentSource.md) | Coordinates to object store to get files to convert. Can specify which files with object keys. | [optional] + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.convert_documents_sources import ConvertDocumentsSources + +# TODO update the JSON string below +json = "{}" +# create an instance of ConvertDocumentsSources from a JSON string +convert_documents_sources_instance = ConvertDocumentsSources.from_json(json) +# print the JSON string representation of the object +print(ConvertDocumentsSources.to_json()) + +# convert the object into a dict +convert_documents_sources_dict = convert_documents_sources_instance.to_dict() +# create an instance of ConvertDocumentsSources from a dict +convert_documents_sources_form_dict = convert_documents_sources.from_dict(convert_documents_sources_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public_v2/ConvertUploadDocumentsRequestBody.md b/docs/apis/public_v2/ConvertUploadDocumentsRequestBody.md new file mode 100644 index 00000000..b03b375b --- /dev/null +++ b/docs/apis/public_v2/ConvertUploadDocumentsRequestBody.md @@ -0,0 +1,34 @@ +# ConvertUploadDocumentsRequestBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file_url** | **List[str]** | List of File's URL to be converted and uploaded to the data index. | [optional] +**internal_file_url** | [**List[InternalUrl]**](InternalUrl.md) | List of Internal File's URLs to be converted and uploaded to the data index. | [optional] +**s3_source** | [**S3DocumentSource**](S3DocumentSource.md) | Coordinates to object store to get files to convert. Can specify which files with object keys. | [optional] +**upload_to_elastic** | **bool** | | [optional] +**conversion_settings** | [**PartialDirectConversionParameters**](PartialDirectConversionParameters.md) | Specify the conversion settings to use. | [optional] +**target_settings** | [**TargetConversionParameters**](TargetConversionParameters.md) | Specify the target settings to use. | [optional] + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.convert_upload_documents_request_body import ConvertUploadDocumentsRequestBody + +# TODO update the JSON string below +json = "{}" +# create an instance of ConvertUploadDocumentsRequestBody from a JSON string +convert_upload_documents_request_body_instance = ConvertUploadDocumentsRequestBody.from_json(json) +# print the JSON string representation of the object +print(ConvertUploadDocumentsRequestBody.to_json()) + +# convert the object into a dict +convert_upload_documents_request_body_dict = convert_upload_documents_request_body_instance.to_dict() +# create an instance of ConvertUploadDocumentsRequestBody from a dict +convert_upload_documents_request_body_form_dict = convert_upload_documents_request_body.from_dict(convert_upload_documents_request_body_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public_v2/DataIndicesUploadApi.md b/docs/apis/public_v2/DataIndicesUploadApi.md index 56d3eb23..4ad0b595 100644 --- a/docs/apis/public_v2/DataIndicesUploadApi.md +++ b/docs/apis/public_v2/DataIndicesUploadApi.md @@ -4,15 +4,103 @@ All URIs are relative to */api/cps/public/v2* Method | HTTP request | Description ------------- | ------------- | ------------- +[**ccs_convert_file_project_data_index**](DataIndicesUploadApi.md#ccs_convert_file_project_data_index) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/ccs_convert | Ccs Convert File Project Data Index [**ccs_convert_upload_file_project_data_index**](DataIndicesUploadApi.md#ccs_convert_upload_file_project_data_index) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload | Ccs Convert Upload File Project Data Index [**get_attachment_upload_data**](DataIndicesUploadApi.md#get_attachment_upload_data) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename} | Get Attachment Upload Data [**html_print_convert_upload**](DataIndicesUploadApi.md#html_print_convert_upload) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload | Html Print Convert Upload +[**load_project_data_index_files_elastic**](DataIndicesUploadApi.md#load_project_data_index_files_elastic) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/load_elastic | Load Project Data Index Files Elastic [**register_attachment**](DataIndicesUploadApi.md#register_attachment) | **POST** /project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment | Register Attachment [**upload_project_data_index_file**](DataIndicesUploadApi.md#upload_project_data_index_file) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/upload | Upload Project Data Index File +[**upload_register_project_documents**](DataIndicesUploadApi.md#upload_register_project_documents) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/upload_register_documents | Upload Register Project Documents +# **ccs_convert_file_project_data_index** +> CpsTask ccs_convert_file_project_data_index(index_key, proj_key, convert_documents_request_body) + +Ccs Convert File Project Data Index + +Convert files via CCS previously registered and in a project data index. + +### Example + +* Api Key Authentication (Bearer): + +```python +import deepsearch.cps.apis.public_v2 +from deepsearch.cps.apis.public_v2.models.convert_documents_request_body import ConvertDocumentsRequestBody +from deepsearch.cps.apis.public_v2.models.cps_task import CpsTask +from deepsearch.cps.apis.public_v2.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/cps/public/v2 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public_v2.Configuration( + host = "/api/cps/public/v2" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public_v2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public_v2.DataIndicesUploadApi(api_client) + index_key = 'index_key_example' # str | + proj_key = 'proj_key_example' # str | + convert_documents_request_body = deepsearch.cps.apis.public_v2.ConvertDocumentsRequestBody() # ConvertDocumentsRequestBody | + + try: + # Ccs Convert File Project Data Index + api_response = api_instance.ccs_convert_file_project_data_index(index_key, proj_key, convert_documents_request_body) + print("The response of DataIndicesUploadApi->ccs_convert_file_project_data_index:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataIndicesUploadApi->ccs_convert_file_project_data_index: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **index_key** | **str**| | + **proj_key** | **str**| | + **convert_documents_request_body** | [**ConvertDocumentsRequestBody**](ConvertDocumentsRequestBody.md)| | + +### Return type + +[**CpsTask**](CpsTask.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful Response | - | +**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **ccs_convert_upload_file_project_data_index** -> CpsTask ccs_convert_upload_file_project_data_index(index_key, proj_key, convert_documents_request_body) +> CpsTask ccs_convert_upload_file_project_data_index(index_key, proj_key, convert_upload_documents_request_body) Ccs Convert Upload File Project Data Index @@ -24,7 +112,7 @@ Convert files via CCS and upload to a project data index (only for indices with ```python import deepsearch.cps.apis.public_v2 -from deepsearch.cps.apis.public_v2.models.convert_documents_request_body import ConvertDocumentsRequestBody +from deepsearch.cps.apis.public_v2.models.convert_upload_documents_request_body import ConvertUploadDocumentsRequestBody from deepsearch.cps.apis.public_v2.models.cps_task import CpsTask from deepsearch.cps.apis.public_v2.rest import ApiException from pprint import pprint @@ -52,11 +140,11 @@ with deepsearch.cps.apis.public_v2.ApiClient(configuration) as api_client: api_instance = deepsearch.cps.apis.public_v2.DataIndicesUploadApi(api_client) index_key = 'index_key_example' # str | proj_key = 'proj_key_example' # str | - convert_documents_request_body = deepsearch.cps.apis.public_v2.ConvertDocumentsRequestBody() # ConvertDocumentsRequestBody | + convert_upload_documents_request_body = deepsearch.cps.apis.public_v2.ConvertUploadDocumentsRequestBody() # ConvertUploadDocumentsRequestBody | try: # Ccs Convert Upload File Project Data Index - api_response = api_instance.ccs_convert_upload_file_project_data_index(index_key, proj_key, convert_documents_request_body) + api_response = api_instance.ccs_convert_upload_file_project_data_index(index_key, proj_key, convert_upload_documents_request_body) print("The response of DataIndicesUploadApi->ccs_convert_upload_file_project_data_index:\n") pprint(api_response) except Exception as e: @@ -72,7 +160,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **index_key** | **str**| | **proj_key** | **str**| | - **convert_documents_request_body** | [**ConvertDocumentsRequestBody**](ConvertDocumentsRequestBody.md)| | + **convert_upload_documents_request_body** | [**ConvertUploadDocumentsRequestBody**](ConvertUploadDocumentsRequestBody.md)| | ### Return type @@ -267,6 +355,91 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **load_project_data_index_files_elastic** +> CpsTask load_project_data_index_files_elastic(index_key, proj_key, upload_elastic_request_body) + +Load Project Data Index Files Elastic + +Load file(s) in a project data index to elastic. + +### Example + +* Api Key Authentication (Bearer): + +```python +import deepsearch.cps.apis.public_v2 +from deepsearch.cps.apis.public_v2.models.cps_task import CpsTask +from deepsearch.cps.apis.public_v2.models.upload_elastic_request_body import UploadElasticRequestBody +from deepsearch.cps.apis.public_v2.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/cps/public/v2 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public_v2.Configuration( + host = "/api/cps/public/v2" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public_v2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public_v2.DataIndicesUploadApi(api_client) + index_key = 'index_key_example' # str | + proj_key = 'proj_key_example' # str | + upload_elastic_request_body = deepsearch.cps.apis.public_v2.UploadElasticRequestBody() # UploadElasticRequestBody | + + try: + # Load Project Data Index Files Elastic + api_response = api_instance.load_project_data_index_files_elastic(index_key, proj_key, upload_elastic_request_body) + print("The response of DataIndicesUploadApi->load_project_data_index_files_elastic:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataIndicesUploadApi->load_project_data_index_files_elastic: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **index_key** | **str**| | + **proj_key** | **str**| | + **upload_elastic_request_body** | [**UploadElasticRequestBody**](UploadElasticRequestBody.md)| | + +### Return type + +[**CpsTask**](CpsTask.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful Response | - | +**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **register_attachment** > register_attachment(index_key, index_item_id, proj_key, attachment_upload_request_body) @@ -436,3 +609,88 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **upload_register_project_documents** +> CpsTask upload_register_project_documents(index_key, proj_key, convert_documents_sources) + +Upload Register Project Documents + +Upload and register documents to be converted later. + +### Example + +* Api Key Authentication (Bearer): + +```python +import deepsearch.cps.apis.public_v2 +from deepsearch.cps.apis.public_v2.models.convert_documents_sources import ConvertDocumentsSources +from deepsearch.cps.apis.public_v2.models.cps_task import CpsTask +from deepsearch.cps.apis.public_v2.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/cps/public/v2 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public_v2.Configuration( + host = "/api/cps/public/v2" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public_v2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public_v2.DataIndicesUploadApi(api_client) + index_key = 'index_key_example' # str | + proj_key = 'proj_key_example' # str | + convert_documents_sources = deepsearch.cps.apis.public_v2.ConvertDocumentsSources() # ConvertDocumentsSources | + + try: + # Upload Register Project Documents + api_response = api_instance.upload_register_project_documents(index_key, proj_key, convert_documents_sources) + print("The response of DataIndicesUploadApi->upload_register_project_documents:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataIndicesUploadApi->upload_register_project_documents: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **index_key** | **str**| | + **proj_key** | **str**| | + **convert_documents_sources** | [**ConvertDocumentsSources**](ConvertDocumentsSources.md)| | + +### Return type + +[**CpsTask**](CpsTask.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful Response | - | +**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/apis/public_v2/FileSource.md b/docs/apis/public_v2/FileSource.md new file mode 100644 index 00000000..8aecd42b --- /dev/null +++ b/docs/apis/public_v2/FileSource.md @@ -0,0 +1,30 @@ +# FileSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**base64_string** | **str** | | +**filename** | **str** | | + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.file_source import FileSource + +# TODO update the JSON string below +json = "{}" +# create an instance of FileSource from a JSON string +file_source_instance = FileSource.from_json(json) +# print the JSON string representation of the object +print(FileSource.to_json()) + +# convert the object into a dict +file_source_dict = file_source_instance.to_dict() +# create an instance of FileSource from a dict +file_source_form_dict = file_source.from_dict(file_source_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public_v2/GenAIParams.md b/docs/apis/public_v2/GenAIParams.md index 7af07acf..2c30d53b 100644 --- a/docs/apis/public_v2/GenAIParams.md +++ b/docs/apis/public_v2/GenAIParams.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **model_id** | **str** | | **prompt_template** | **str** | | **params** | **object** | | +**timeout** | **float** | | ## Example diff --git a/docs/apis/public_v2/GenAIPartialParams.md b/docs/apis/public_v2/GenAIPartialParams.md index 8bcdb964..d775b835 100644 --- a/docs/apis/public_v2/GenAIPartialParams.md +++ b/docs/apis/public_v2/GenAIPartialParams.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **model_id** | **str** | | [optional] **prompt_template** | **str** | | [optional] **params** | **object** | | [optional] +**timeout** | **float** | | [optional] ## Example diff --git a/docs/apis/public_v2/HttpSource.md b/docs/apis/public_v2/HttpSource.md new file mode 100644 index 00000000..24590c82 --- /dev/null +++ b/docs/apis/public_v2/HttpSource.md @@ -0,0 +1,30 @@ +# HttpSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **str** | | +**headers** | **object** | | + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.http_source import HttpSource + +# TODO update the JSON string below +json = "{}" +# create an instance of HttpSource from a JSON string +http_source_instance = HttpSource.from_json(json) +# print the JSON string representation of the object +print(HttpSource.to_json()) + +# convert the object into a dict +http_source_dict = http_source_instance.to_dict() +# create an instance of HttpSource from a dict +http_source_form_dict = http_source.from_dict(http_source_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public_v2/ProjectApi.md b/docs/apis/public_v2/ProjectApi.md index 539ec93a..5a224d65 100644 --- a/docs/apis/public_v2/ProjectApi.md +++ b/docs/apis/public_v2/ProjectApi.md @@ -4,6 +4,8 @@ All URIs are relative to */api/cps/public/v2* Method | HTTP request | Description ------------- | ------------- | ------------- +[**check_wait_ccs_task_task**](ProjectApi.md#check_wait_ccs_task_task) | **GET** /project/{proj_key}/convert_tasks/{task_id} | Check Wait Ccs Task Task +[**convert_pdf_document**](ProjectApi.md#convert_pdf_document) | **POST** /project/{proj_key}/convert | Convert Pdf Document [**delete_project_integration_config_genai**](ProjectApi.md#delete_project_integration_config_genai) | **DELETE** /project/{proj_key}/integrations/genai | Delete Project Integration Config Genai [**get_project_default_values**](ProjectApi.md#get_project_default_values) | **GET** /project/{proj_key}/default_values | Get Project Default Values [**get_project_integration_config_genai**](ProjectApi.md#get_project_integration_config_genai) | **GET** /project/{proj_key}/integrations/genai | Get Project Integration Config Genai @@ -12,6 +14,173 @@ Method | HTTP request | Description [**update_project_integration_config_genai**](ProjectApi.md#update_project_integration_config_genai) | **POST** /project/{proj_key}/integrations/genai | Update Project Integration Config Genai +# **check_wait_ccs_task_task** +> TaskResult check_wait_ccs_task_task(task_id, proj_key, wait=wait) + +Check Wait Ccs Task Task + +Check status of a CCS conversion task. + +### Example + +* Api Key Authentication (Bearer): + +```python +import deepsearch.cps.apis.public_v2 +from deepsearch.cps.apis.public_v2.models.task_result import TaskResult +from deepsearch.cps.apis.public_v2.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/cps/public/v2 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public_v2.Configuration( + host = "/api/cps/public/v2" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public_v2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public_v2.ProjectApi(api_client) + task_id = 'task_id_example' # str | + proj_key = 'proj_key_example' # str | + wait = 3.4 # float | Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls. (optional) + + try: + # Check Wait Ccs Task Task + api_response = api_instance.check_wait_ccs_task_task(task_id, proj_key, wait=wait) + print("The response of ProjectApi->check_wait_ccs_task_task:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ProjectApi->check_wait_ccs_task_task: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **task_id** | **str**| | + **proj_key** | **str**| | + **wait** | **float**| Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls. | [optional] + +### Return type + +[**TaskResult**](TaskResult.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful Response | - | +**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **convert_pdf_document** +> CcsTask convert_pdf_document(proj_key, convert_document_request) + +Convert Pdf Document + +Convert a PDF document directly to CCS. + +### Example + +* Api Key Authentication (Bearer): + +```python +import deepsearch.cps.apis.public_v2 +from deepsearch.cps.apis.public_v2.models.ccs_task import CcsTask +from deepsearch.cps.apis.public_v2.models.convert_document_request import ConvertDocumentRequest +from deepsearch.cps.apis.public_v2.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/cps/public/v2 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public_v2.Configuration( + host = "/api/cps/public/v2" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public_v2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public_v2.ProjectApi(api_client) + proj_key = 'proj_key_example' # str | + convert_document_request = deepsearch.cps.apis.public_v2.ConvertDocumentRequest() # ConvertDocumentRequest | + + try: + # Convert Pdf Document + api_response = api_instance.convert_pdf_document(proj_key, convert_document_request) + print("The response of ProjectApi->convert_pdf_document:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ProjectApi->convert_pdf_document: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **proj_key** | **str**| | + **convert_document_request** | [**ConvertDocumentRequest**](ConvertDocumentRequest.md)| | + +### Return type + +[**CcsTask**](CcsTask.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful Response | - | +**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **delete_project_integration_config_genai** > delete_project_integration_config_genai(proj_key) diff --git a/docs/apis/public_v2/TargetConversionParameters.md b/docs/apis/public_v2/TargetConversionParameters.md new file mode 100644 index 00000000..d5b62a52 --- /dev/null +++ b/docs/apis/public_v2/TargetConversionParameters.md @@ -0,0 +1,31 @@ +# TargetConversionParameters + +Specify target settings (add_raw_pages, add_annotations). Fields left null are set to platform defaults. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**add_raw_pages** | **bool** | | [optional] +**add_annotations** | **bool** | | [optional] + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.target_conversion_parameters import TargetConversionParameters + +# TODO update the JSON string below +json = "{}" +# create an instance of TargetConversionParameters from a JSON string +target_conversion_parameters_instance = TargetConversionParameters.from_json(json) +# print the JSON string representation of the object +print(TargetConversionParameters.to_json()) + +# convert the object into a dict +target_conversion_parameters_dict = target_conversion_parameters_instance.to_dict() +# create an instance of TargetConversionParameters from a dict +target_conversion_parameters_form_dict = target_conversion_parameters.from_dict(target_conversion_parameters_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public_v2/UploadElasticRequestBody.md b/docs/apis/public_v2/UploadElasticRequestBody.md new file mode 100644 index 00000000..912c9e1c --- /dev/null +++ b/docs/apis/public_v2/UploadElasticRequestBody.md @@ -0,0 +1,30 @@ +# UploadElasticRequestBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**document_hashes** | **List[str]** | List of document hashes to be used as filter. | [optional] +**with_operations** | **List[str]** | List of Operation Status documents don't have to be used as filter. | [optional] + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.upload_elastic_request_body import UploadElasticRequestBody + +# TODO update the JSON string below +json = "{}" +# create an instance of UploadElasticRequestBody from a JSON string +upload_elastic_request_body_instance = UploadElasticRequestBody.from_json(json) +# print the JSON string representation of the object +print(UploadElasticRequestBody.to_json()) + +# convert the object into a dict +upload_elastic_request_body_dict = upload_elastic_request_body_instance.to_dict() +# create an instance of UploadElasticRequestBody from a dict +upload_elastic_request_body_form_dict = upload_elastic_request_body.from_dict(upload_elastic_request_body_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/user/AccessToken.md b/docs/apis/user/AccessToken.md deleted file mode 100644 index 9aa9d48e..00000000 --- a/docs/apis/user/AccessToken.md +++ /dev/null @@ -1,10 +0,0 @@ -# AccessToken - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_token** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/AdminApi.md b/docs/apis/user/AdminApi.md deleted file mode 100644 index e0b3bbba..00000000 --- a/docs/apis/user/AdminApi.md +++ /dev/null @@ -1,650 +0,0 @@ -# deepsearch.cps.apis.user.AdminApi - -All URIs are relative to *http://localhost/api/cps/user/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**admin_add_user**](AdminApi.md#admin_add_user) | **POST** /admin/projects/{proj_key}/users | -[**admin_list_users**](AdminApi.md#admin_list_users) | **GET** /admin/projects/{proj_key}/users | -[**admin_remove_user**](AdminApi.md#admin_remove_user) | **DELETE** /admin/projects/{proj_key}/users/{username} | -[**confirm_user**](AdminApi.md#confirm_user) | **POST** /admin/users/{user_key}/confirmation | -[**create_project**](AdminApi.md#create_project) | **POST** /admin/projects | -[**list_all_projects**](AdminApi.md#list_all_projects) | **GET** /admin/projects/all | -[**list_audits**](AdminApi.md#list_audits) | **GET** /admin/audits | -[**list_pending_users**](AdminApi.md#list_pending_users) | **GET** /admin/users/pending | - - -# **admin_add_user** -> SuccessMessage admin_add_user(proj_key, data) - - - -Assign a new user to a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - proj_key = 'proj_key_example' # str | The project key -data = deepsearch.cps.apis.user.ProjectUserAssignment() # ProjectUserAssignment | - - try: - api_response = api_instance.admin_add_user(proj_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling AdminApi->admin_add_user: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **data** | [**ProjectUserAssignment**](ProjectUserAssignment.md)| | - -### Return type - -[**SuccessMessage**](SuccessMessage.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | User assigned to project. | - | -**400** | Invalid new_user_type. | - | -**403** | The user that's performing this operation does not have permission to assign the user. | - | -**404** | User that's going to be assigned doesn't exist, or the project doesn't exist. | - | -**409** | Reassigning the user would leave the project in an invalid state. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **admin_list_users** -> dict(str, list[UserDetails]) admin_list_users(proj_key, page=page, items_per_page=items_per_page) - - - -List all users belonging to a cps project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - proj_key = 'proj_key_example' # str | The project key -page = 56 # int | page of the result list (optional) -items_per_page = 2 # int | items on one page of the result list (optional) (default to 2) - - try: - api_response = api_instance.admin_list_users(proj_key, page=page, items_per_page=items_per_page) - pprint(api_response) - except ApiException as e: - print("Exception when calling AdminApi->admin_list_users: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **page** | **int**| page of the result list | [optional] - **items_per_page** | **int**| items on one page of the result list | [optional] [default to 2] - -### Return type - -**dict(str, list[UserDetails])** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**404** | User does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **admin_remove_user** -> admin_remove_user(proj_key, username) - - - -Delete an user from a project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - proj_key = 'proj_key_example' # str | The project key -username = 'username_example' # str | The username for the user - - try: - api_instance.admin_remove_user(proj_key, username) - except ApiException as e: - print("Exception when calling AdminApi->admin_remove_user: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **username** | **str**| The username for the user | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | User deleted from project successfully. | - | -**403** | The user that is executing this operation is not an owner of the project. | - | -**404** | Project or user not found. | - | -**409** | User not assigned to project, or the project only has one owner left. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **confirm_user** -> confirm_user(user_key) - - - -Confirm a pending user. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - user_key = 'user_key_example' # str | - - try: - api_instance.confirm_user(user_key) - except ApiException as e: - print("Exception when calling AdminApi->confirm_user: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_key** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project** -> Project create_project(data) - - - -Create a new project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - data = deepsearch.cps.apis.user.CreateProjectRequestBody() # CreateProjectRequestBody | - - try: - api_response = api_instance.create_project(data) - pprint(api_response) - except ApiException as e: - print("Exception when calling AdminApi->create_project: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **data** | [**CreateProjectRequestBody**](CreateProjectRequestBody.md)| | - -### Return type - -[**Project**](Project.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | New project details | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_all_projects** -> list[Project] list_all_projects() - - - -List all projects - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - - try: - api_response = api_instance.list_all_projects() - pprint(api_response) - except ApiException as e: - print("Exception when calling AdminApi->list_all_projects: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[Project]**](Project.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**404** | Project does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_audits** -> InlineResponse200 list_audits(user_key=user_key, type_=type_, search_term=search_term, before=before, after=after, limit=limit) - - - -List audits globally - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - user_key = 'user_key_example' # str | (optional) -type_ = 'type__example' # str | (optional) -search_term = 'search_term_example' # str | (optional) -before = 'before_example' # str | (optional) -after = 'after_example' # str | (optional) -limit = 50 # int | (optional) (default to 50) - - try: - api_response = api_instance.list_audits(user_key=user_key, type_=type_, search_term=search_term, before=before, after=after, limit=limit) - pprint(api_response) - except ApiException as e: - print("Exception when calling AdminApi->list_audits: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_key** | **str**| | [optional] - **type_** | **str**| | [optional] - **search_term** | **str**| | [optional] - **before** | **str**| | [optional] - **after** | **str**| | [optional] - **limit** | **int**| | [optional] [default to 50] - -### Return type - -[**InlineResponse200**](InlineResponse200.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**404** | Project does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_pending_users** -> list[UserDetails] list_pending_users(term=term) - - - -List pending user requests. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - term = 'term_example' # str | (optional) - - try: - api_response = api_instance.list_pending_users(term=term) - pprint(api_response) - except ApiException as e: - print("Exception when calling AdminApi->list_pending_users: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **term** | **str**| | [optional] - -### Return type - -[**list[UserDetails]**](UserDetails.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/user/ApiKey.md b/docs/apis/user/ApiKey.md deleted file mode 100644 index 63d2f130..00000000 --- a/docs/apis/user/ApiKey.md +++ /dev/null @@ -1,11 +0,0 @@ -# ApiKey - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**api_key** | **str** | | -**email** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/AuditRecord.md b/docs/apis/user/AuditRecord.md deleted file mode 100644 index 7456c268..00000000 --- a/docs/apis/user/AuditRecord.md +++ /dev/null @@ -1,16 +0,0 @@ -# AuditRecord - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**details** | [**object**](.md) | | -**id** | **str** | | -**message** | **str** | | -**proj_key** | **str** | | -**timestamp** | **str** | | -**type** | **str** | | -**user_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/CreateProjectRequestBody.md b/docs/apis/user/CreateProjectRequestBody.md deleted file mode 100644 index 1c81a0f3..00000000 --- a/docs/apis/user/CreateProjectRequestBody.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateProjectRequestBody - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Name of the project | -**proj_key** | **str** | Internal project key to use. (use only if you really know what you are doing) | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/CreateProjectRequestBody1.md b/docs/apis/user/CreateProjectRequestBody1.md deleted file mode 100644 index 9dfbcdab..00000000 --- a/docs/apis/user/CreateProjectRequestBody1.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateProjectRequestBody1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Name of the project | -**proj_key** | **str** | Internal project key to use. (use only if you really know what you are doing) | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/CreateTokensRequestBody.md b/docs/apis/user/CreateTokensRequestBody.md deleted file mode 100644 index d73855e1..00000000 --- a/docs/apis/user/CreateTokensRequestBody.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTokensRequestBody - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | The oidc code response | [optional] -**refresh_token** | **str** | The refresh token | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/ErrorResponse.md b/docs/apis/user/ErrorResponse.md deleted file mode 100644 index 39647b8f..00000000 --- a/docs/apis/user/ErrorResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# ErrorResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error** | **str** | Description of the error. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/GetAccessTokenRequestBody.md b/docs/apis/user/GetAccessTokenRequestBody.md deleted file mode 100644 index b8d1d635..00000000 --- a/docs/apis/user/GetAccessTokenRequestBody.md +++ /dev/null @@ -1,10 +0,0 @@ -# GetAccessTokenRequestBody - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**admin** | **bool** | | [optional] [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/ImpersonateUserTokenRequestBody.md b/docs/apis/user/ImpersonateUserTokenRequestBody.md deleted file mode 100644 index b1fed323..00000000 --- a/docs/apis/user/ImpersonateUserTokenRequestBody.md +++ /dev/null @@ -1,11 +0,0 @@ -# ImpersonateUserTokenRequestBody - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**impersonate_secret** | **str** | | -**target_user_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/InlineResponse200.md b/docs/apis/user/InlineResponse200.md deleted file mode 100644 index 08f28bba..00000000 --- a/docs/apis/user/InlineResponse200.md +++ /dev/null @@ -1,10 +0,0 @@ -# InlineResponse200 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**audits** | [**list[AuditRecord]**](AuditRecord.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/OidcApi.md b/docs/apis/user/OidcApi.md deleted file mode 100644 index d652560a..00000000 --- a/docs/apis/user/OidcApi.md +++ /dev/null @@ -1,253 +0,0 @@ -# deepsearch.cps.apis.user.OidcApi - -All URIs are relative to *http://localhost/api/cps/user/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**authenticate**](OidcApi.md#authenticate) | **GET** /oidc/authenticate | -[**create_tokens**](OidcApi.md#create_tokens) | **POST** /oidc/token | -[**register_user**](OidcApi.md#register_user) | **POST** /oidc/register_user | -[**token**](OidcApi.md#token) | **GET** /oidc/token | - - -# **authenticate** -> authenticate() - - - -Redirect to the OIDC authenticate endpoint. - -### Example - -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient() as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.OidcApi(api_client) - - try: - api_instance.authenticate() - except ApiException as e: - print("Exception when calling OidcApi->authenticate: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**302** | Redirect to the OIDC authenticate endpoint | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_tokens** -> OidcTokenResponse create_tokens(body=body) - - - -Retrieve the user access and identity tokens using either the code or the refresh_token. - -### Example - -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient() as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.OidcApi(api_client) - body = deepsearch.cps.apis.user.CreateTokensRequestBody() # CreateTokensRequestBody | (optional) - - try: - api_response = api_instance.create_tokens(body=body) - pprint(api_response) - except ApiException as e: - print("Exception when calling OidcApi->create_tokens: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**CreateTokensRequestBody**](CreateTokensRequestBody.md)| | [optional] - -### Return type - -[**OidcTokenResponse**](OidcTokenResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **register_user** -> UserDetails register_user(data) - - - -Register a new user, provided a valid access_token and id_token from the oidc provider. - -### Example - -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient() as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.OidcApi(api_client) - data = deepsearch.cps.apis.user.RegisterUserRequestBody() # RegisterUserRequestBody | - - try: - api_response = api_instance.register_user(data) - pprint(api_response) - except ApiException as e: - print("Exception when calling OidcApi->register_user: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **data** | [**RegisterUserRequestBody**](RegisterUserRequestBody.md)| | - -### Return type - -[**UserDetails**](UserDetails.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **token** -> OidcTokenResponse token(code=code, refresh_token=refresh_token) - - - -Retrieve the user access and identity tokens using either the code or the refresh_token. - -### Example - -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient() as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.OidcApi(api_client) - code = 'code_example' # str | The oidc code response (optional) -refresh_token = 'refresh_token_example' # str | The oidc code response (optional) - - try: - api_response = api_instance.token(code=code, refresh_token=refresh_token) - pprint(api_response) - except ApiException as e: - print("Exception when calling OidcApi->token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **code** | **str**| The oidc code response | [optional] - **refresh_token** | **str**| The oidc code response | [optional] - -### Return type - -[**OidcTokenResponse**](OidcTokenResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/user/OidcTokenResponse.md b/docs/apis/user/OidcTokenResponse.md deleted file mode 100644 index 24245736..00000000 --- a/docs/apis/user/OidcTokenResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# OidcTokenResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_token** | **str** | | [optional] -**id_token** | **str** | | -**refresh_token** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/Project.md b/docs/apis/user/Project.md deleted file mode 100644 index c183ed83..00000000 --- a/docs/apis/user/Project.md +++ /dev/null @@ -1,13 +0,0 @@ -# Project - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**date** | **str** | | [optional] -**name** | **str** | | [optional] -**proj_key** | **str** | | [optional] -**role** | [**UserType**](UserType.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/ProjectUserAssignment.md b/docs/apis/user/ProjectUserAssignment.md deleted file mode 100644 index 22b56cb0..00000000 --- a/docs/apis/user/ProjectUserAssignment.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectUserAssignment - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**force_role** | **bool** | If true, the role will be assigned also for existing users | [optional] [default to True] -**role** | **str** | The role to assign to the user | -**username** | **str** | The username | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/ProjectsApi.md b/docs/apis/user/ProjectsApi.md deleted file mode 100644 index 6405d11f..00000000 --- a/docs/apis/user/ProjectsApi.md +++ /dev/null @@ -1,1065 +0,0 @@ -# deepsearch.cps.apis.user.ProjectsApi - -All URIs are relative to *http://localhost/api/cps/user/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**add_user**](ProjectsApi.md#add_user) | **POST** /projects/{proj_key}/users | -[**create**](ProjectsApi.md#create) | **POST** /projects | -[**delete**](ProjectsApi.md#delete) | **DELETE** /projects/{proj_key} | -[**details**](ProjectsApi.md#details) | **GET** /projects/{proj_key} | -[**edit_user**](ProjectsApi.md#edit_user) | **PUT** /projects/{proj_key}/users | -[**get_delete_confirmation_token**](ProjectsApi.md#get_delete_confirmation_token) | **GET** /projects/{proj_key}/delete | -[**get_project_token**](ProjectsApi.md#get_project_token) | **GET** /projects/{proj_key}/token | -[**is_authorized**](ProjectsApi.md#is_authorized) | **GET** /projects/{proj_key}/is_authorized | -[**list_audits_in_project**](ProjectsApi.md#list_audits_in_project) | **GET** /projects/{proj_key}/audits | -[**list_projects**](ProjectsApi.md#list_projects) | **GET** /projects | -[**list_users**](ProjectsApi.md#list_users) | **GET** /projects/{proj_key}/users | -[**list_users_paginated**](ProjectsApi.md#list_users_paginated) | **GET** /projects/{proj_key}/users_paginated | -[**remove_user**](ProjectsApi.md#remove_user) | **DELETE** /projects/{proj_key}/users/{username} | - - -# **add_user** -> SuccessMessage add_user(proj_key, data) - - - -Assign a new user to a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key -data = deepsearch.cps.apis.user.ProjectUserAssignment() # ProjectUserAssignment | - - try: - api_response = api_instance.add_user(proj_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->add_user: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **data** | [**ProjectUserAssignment**](ProjectUserAssignment.md)| | - -### Return type - -[**SuccessMessage**](SuccessMessage.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | User assigned to project. | - | -**400** | Invalid new_user_type. | - | -**403** | The user that's performing this operation does not have permission to assign the user. | - | -**404** | User that's going to be assigned doesn't exist, or the project doesn't exist. | - | -**409** | Reassigning the user would leave the project in an invalid state. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create** -> Project create(data) - - - -Create a new project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - data = deepsearch.cps.apis.user.CreateProjectRequestBody1() # CreateProjectRequestBody1 | - - try: - api_response = api_instance.create(data) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->create: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **data** | [**CreateProjectRequestBody1**](CreateProjectRequestBody1.md)| | - -### Return type - -[**Project**](Project.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | New project details | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete** -> delete(proj_key, confirmation_token) - - - -Delete a project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key -confirmation_token = 'confirmation_token_example' # str | The delete confirmation token - - try: - api_instance.delete(proj_key, confirmation_token) - except ApiException as e: - print("Exception when calling ProjectsApi->delete: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **confirmation_token** | **str**| The delete confirmation token | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Project deleted successfully. | - | -**403** | The user that is executing this operation is not an owner of the project. | - | -**404** | Project not found. | - | -**409** | User not assigned to project. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **details** -> Project details(proj_key) - - - -Returns the details of the project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key - - try: - api_response = api_instance.details(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->details: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - -### Return type - -[**Project**](Project.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**404** | Project does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **edit_user** -> SuccessMessage edit_user(proj_key, data) - - - -Assign a new user to a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key -data = deepsearch.cps.apis.user.ProjectUserAssignment() # ProjectUserAssignment | - - try: - api_response = api_instance.edit_user(proj_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->edit_user: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **data** | [**ProjectUserAssignment**](ProjectUserAssignment.md)| | - -### Return type - -[**SuccessMessage**](SuccessMessage.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | User assigned to project. | - | -**400** | Invalid new_user_type. | - | -**403** | The user that's performing this operation does not have permission to assign the user. | - | -**404** | User that's going to be assigned doesn't exist, or the project doesn't exist. | - | -**409** | Reassigning the user would leave the project in an invalid state. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_delete_confirmation_token** -> TokenResponse get_delete_confirmation_token(proj_key) - - - -Get a delete confirmation token for the provided project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key - - try: - api_response = api_instance.get_delete_confirmation_token(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->get_delete_confirmation_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Confirmation token. | - | -**403** | The user that is executing this operation is not an owner of the project. | - | -**404** | Project not found. | - | -**409** | User not assigned to project. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_token** -> AccessToken get_project_token(proj_key) - - - -Request a token granting access to the current project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key - - try: - api_response = api_instance.get_project_token(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->get_project_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - -### Return type - -[**AccessToken**](AccessToken.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**404** | Project does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **is_authorized** -> SuccessMessage is_authorized(proj_key, role=role) - - - -Provide user-key and project-key to coordinates a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key -role = 'role_example' # str | The specific role to probe (optional) - - try: - api_response = api_instance.is_authorized(proj_key, role=role) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->is_authorized: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **role** | **str**| The specific role to probe | [optional] - -### Return type - -[**SuccessMessage**](SuccessMessage.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | -**404** | Project does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_audits_in_project** -> InlineResponse200 list_audits_in_project(proj_key, user_key=user_key, type_=type_, search_term=search_term, before=before, after=after, limit=limit) - - - -List audits related to the project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key -user_key = 'user_key_example' # str | (optional) -type_ = 'type__example' # str | (optional) -search_term = 'search_term_example' # str | (optional) -before = 'before_example' # str | (optional) -after = 'after_example' # str | (optional) -limit = 50 # int | (optional) (default to 50) - - try: - api_response = api_instance.list_audits_in_project(proj_key, user_key=user_key, type_=type_, search_term=search_term, before=before, after=after, limit=limit) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->list_audits_in_project: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **user_key** | **str**| | [optional] - **type_** | **str**| | [optional] - **search_term** | **str**| | [optional] - **before** | **str**| | [optional] - **after** | **str**| | [optional] - **limit** | **int**| | [optional] [default to 50] - -### Return type - -[**InlineResponse200**](InlineResponse200.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**404** | Project does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_projects** -> list[Project] list_projects(role=role, include_collaborators=include_collaborators) - - - -List all projects assigned to a user - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - role = 'role_example' # str | filter for the user role (optional) -include_collaborators = True # bool | (optional) (default to True) - - try: - api_response = api_instance.list_projects(role=role, include_collaborators=include_collaborators) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->list_projects: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **role** | **str**| filter for the user role | [optional] - **include_collaborators** | **bool**| | [optional] [default to True] - -### Return type - -[**list[Project]**](Project.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**404** | Project does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_users** -> dict(str, list[UserDetails]) list_users(proj_key) - - - -List all users belonging to a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key - - try: - api_response = api_instance.list_users(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->list_users: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - -### Return type - -**dict(str, list[UserDetails])** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**404** | User does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_users_paginated** -> dict(str, list[UserDetails]) list_users_paginated(proj_key, page=page, items_per_page=items_per_page) - - - -List all users belonging to a cps project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key -page = 56 # int | page of the result list (optional) -items_per_page = 2 # int | items on one page of the result list (optional) (default to 2) - - try: - api_response = api_instance.list_users_paginated(proj_key, page=page, items_per_page=items_per_page) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->list_users_paginated: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **page** | **int**| page of the result list | [optional] - **items_per_page** | **int**| items on one page of the result list | [optional] [default to 2] - -### Return type - -**dict(str, list[UserDetails])** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**404** | User does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **remove_user** -> remove_user(proj_key, username) - - - -Delete an user from a project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key -username = 'username_example' # str | The username for the user - - try: - api_instance.remove_user(proj_key, username) - except ApiException as e: - print("Exception when calling ProjectsApi->remove_user: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **username** | **str**| The username for the user | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | User deleted from project successfully. | - | -**403** | The user that is executing this operation is not an owner of the project. | - | -**404** | Project or user not found. | - | -**409** | User not assigned to project, or the project only has one owner left. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/user/RegisterUserRequestBody.md b/docs/apis/user/RegisterUserRequestBody.md deleted file mode 100644 index adfa196f..00000000 --- a/docs/apis/user/RegisterUserRequestBody.md +++ /dev/null @@ -1,11 +0,0 @@ -# RegisterUserRequestBody - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_token** | **str** | OIDC access_token signed by the provider | -**id_token** | **str** | OIDC id_token signed by the provider | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/ServiceAccount.md b/docs/apis/user/ServiceAccount.md deleted file mode 100644 index ec5a86d2..00000000 --- a/docs/apis/user/ServiceAccount.md +++ /dev/null @@ -1,12 +0,0 @@ -# ServiceAccount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**credentials** | [**ServiceAccountCredentials**](ServiceAccountCredentials.md) | | [optional] -**name** | **str** | | [optional] -**user_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/ServiceAccountCredentials.md b/docs/apis/user/ServiceAccountCredentials.md deleted file mode 100644 index c1e13436..00000000 --- a/docs/apis/user/ServiceAccountCredentials.md +++ /dev/null @@ -1,11 +0,0 @@ -# ServiceAccountCredentials - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**password** | **str** | | -**username** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/SettingsApi.md b/docs/apis/user/SettingsApi.md deleted file mode 100644 index 9a8f0eef..00000000 --- a/docs/apis/user/SettingsApi.md +++ /dev/null @@ -1,82 +0,0 @@ -# deepsearch.cps.apis.user.SettingsApi - -All URIs are relative to *http://localhost/api/cps/user/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**global_permissions**](SettingsApi.md#global_permissions) | **GET** /permissions | - - -# **global_permissions** -> dict(str, bool) global_permissions() - - - -Get the global permissions for users. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.SettingsApi(api_client) - - try: - api_response = api_instance.global_permissions() - pprint(api_response) - except ApiException as e: - print("Exception when calling SettingsApi->global_permissions: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -**dict(str, bool)** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/user/SuccessMessage.md b/docs/apis/user/SuccessMessage.md deleted file mode 100644 index b66e15f6..00000000 --- a/docs/apis/user/SuccessMessage.md +++ /dev/null @@ -1,10 +0,0 @@ -# SuccessMessage - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**success** | **str** | Human readable message. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/TokenResponse.md b/docs/apis/user/TokenResponse.md deleted file mode 100644 index 13da8132..00000000 --- a/docs/apis/user/TokenResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# TokenResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**token** | **str** | The delete confirmation token. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/UserApi.md b/docs/apis/user/UserApi.md deleted file mode 100644 index 86d4ee6c..00000000 --- a/docs/apis/user/UserApi.md +++ /dev/null @@ -1,81 +0,0 @@ -# deepsearch.cps.apis.user.UserApi - -All URIs are relative to *http://localhost/api/cps/user/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**api_key_create**](UserApi.md#api_key_create) | **POST** /user/api_key | - - -# **api_key_create** -> ApiKey api_key_create() - - - -Create an API Key for your user - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UserApi(api_client) - - try: - api_response = api_instance.api_key_create() - pprint(api_response) - except ApiException as e: - print("Exception when calling UserApi->api_key_create: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**ApiKey**](ApiKey.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/user/UserDetails.md b/docs/apis/user/UserDetails.md deleted file mode 100644 index 7c136874..00000000 --- a/docs/apis/user/UserDetails.md +++ /dev/null @@ -1,12 +0,0 @@ -# UserDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**email** | **str** | | [optional] -**role** | **str** | | [optional] -**username** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/UserType.md b/docs/apis/user/UserType.md deleted file mode 100644 index 5f7722dd..00000000 --- a/docs/apis/user/UserType.md +++ /dev/null @@ -1,9 +0,0 @@ -# UserType - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/UsersApi.md b/docs/apis/user/UsersApi.md deleted file mode 100644 index 108fcc0c..00000000 --- a/docs/apis/user/UsersApi.md +++ /dev/null @@ -1,640 +0,0 @@ -# deepsearch.cps.apis.user.UsersApi - -All URIs are relative to *http://localhost/api/cps/user/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**api_key_get**](UsersApi.md#api_key_get) | **GET** /user/api_key | -[**get_access_token**](UsersApi.md#get_access_token) | **POST** /user/token | -[**get_current_user_details**](UsersApi.md#get_current_user_details) | **GET** /user/current | -[**impersonate_user_token**](UsersApi.md#impersonate_user_token) | **POST** /user/impersonate | -[**search**](UsersApi.md#search) | **GET** /user/search | -[**service_accounts_create**](UsersApi.md#service_accounts_create) | **POST** /user/service_accounts | -[**service_accounts_list**](UsersApi.md#service_accounts_list) | **GET** /user/service_accounts | - - -# **api_key_get** -> ApiKey api_key_get() - - - -Show the API Key for your user - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - - try: - api_response = api_instance.api_key_get() - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->api_key_get: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**ApiKey**](ApiKey.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_access_token** -> AccessToken get_access_token(options=options) - - - -Request a user API token - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure HTTP basic authorization: UserAPIKey -configuration = deepsearch.cps.apis.user.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - options = deepsearch.cps.apis.user.GetAccessTokenRequestBody() # GetAccessTokenRequestBody | (optional) - - try: - api_response = api_instance.get_access_token(options=options) - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->get_access_token: %s\n" % e) -``` - -* Basic Authentication (UserAPIKey): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure HTTP basic authorization: UserAPIKey -configuration = deepsearch.cps.apis.user.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - options = deepsearch.cps.apis.user.GetAccessTokenRequestBody() # GetAccessTokenRequestBody | (optional) - - try: - api_response = api_instance.get_access_token(options=options) - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->get_access_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **options** | [**GetAccessTokenRequestBody**](GetAccessTokenRequestBody.md)| | [optional] - -### Return type - -[**AccessToken**](AccessToken.md) - -### Authorization - -[Bearer](../README.md#Bearer), [UserAPIKey](../README.md#UserAPIKey) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_current_user_details** -> UserDetails get_current_user_details() - - - -Gets the current user's details. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - - try: - api_response = api_instance.get_current_user_details() - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->get_current_user_details: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**UserDetails**](UserDetails.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **impersonate_user_token** -> TokenResponse impersonate_user_token(body) - - - -Request an impersonate user token. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure HTTP basic authorization: UserAPIKey -configuration = deepsearch.cps.apis.user.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - body = deepsearch.cps.apis.user.ImpersonateUserTokenRequestBody() # ImpersonateUserTokenRequestBody | - - try: - api_response = api_instance.impersonate_user_token(body) - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->impersonate_user_token: %s\n" % e) -``` - -* Basic Authentication (UserAPIKey): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure HTTP basic authorization: UserAPIKey -configuration = deepsearch.cps.apis.user.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - body = deepsearch.cps.apis.user.ImpersonateUserTokenRequestBody() # ImpersonateUserTokenRequestBody | - - try: - api_response = api_instance.impersonate_user_token(body) - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->impersonate_user_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**ImpersonateUserTokenRequestBody**](ImpersonateUserTokenRequestBody.md)| | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer), [UserAPIKey](../README.md#UserAPIKey) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**403** | The user that's performing this operation does not have permission or the impersonate secret isn't valid. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search** -> list[UserDetails] search(term) - - - -Search for users matching the email or name. Depending on the user's permissions, only owners and assignees from their projects may be shown. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - term = 'term_example' # str | Search term - - try: - api_response = api_instance.search(term) - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->search: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **term** | **str**| Search term | - -### Return type - -[**list[UserDetails]**](UserDetails.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **service_accounts_create** -> ServiceAccount service_accounts_create() - - - -Create a new service accounts for your user - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - - try: - api_response = api_instance.service_accounts_create() - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->service_accounts_create: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**ServiceAccount**](ServiceAccount.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **service_accounts_list** -> list[ServiceAccount] service_accounts_list() - - - -List all service accounts of your user - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - - try: - api_response = api_instance.service_accounts_list() - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->service_accounts_list: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[ServiceAccount]**](ServiceAccount.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/poetry.lock b/poetry.lock index 4ce1152a..5f26d125 100644 --- a/poetry.lock +++ b/poetry.lock @@ -2,18 +2,15 @@ [[package]] name = "annotated-types" -version = "0.6.0" +version = "0.7.0" description = "Reusable constraint types to use with typing.Annotated" optional = false python-versions = ">=3.8" files = [ - {file = "annotated_types-0.6.0-py3-none-any.whl", hash = "sha256:0641064de18ba7a25dee8f96403ebc39113d0cb953a01429249d5c7564666a43"}, - {file = "annotated_types-0.6.0.tar.gz", hash = "sha256:563339e807e53ffd9c267e99fc6d9ea23eb8443c08f112651963e24e22f84a5d"}, + {file = "annotated_types-0.7.0-py3-none-any.whl", hash = "sha256:1f02e8b43a8fbbc3f3e0d4f0f4bfc8131bcb4eebe8849b8e5c773f3a1c582a53"}, + {file = "annotated_types-0.7.0.tar.gz", hash = "sha256:aff07c09a53a08bc8cfccb9c85b05f1aa9a2a6f23728d790723543408344ce89"}, ] -[package.dependencies] -typing-extensions = {version = ">=4.0.0", markers = "python_version < \"3.9\""} - [[package]] name = "anyio" version = "3.7.1" @@ -35,35 +32,19 @@ doc = ["Sphinx", "packaging", "sphinx-autodoc-typehints (>=1.2.0)", "sphinx-rtd- test = ["anyio[trio]", "coverage[toml] (>=4.5)", "hypothesis (>=4.0)", "mock (>=4)", "psutil (>=5.9)", "pytest (>=7.0)", "pytest-mock (>=3.6.1)", "trustme", "uvloop (>=0.17)"] trio = ["trio (<0.22)"] -[[package]] -name = "appnope" -version = "0.1.4" -description = "Disable App Nap on macOS >= 10.9" -optional = false -python-versions = ">=3.6" -files = [ - {file = "appnope-0.1.4-py2.py3-none-any.whl", hash = "sha256:502575ee11cd7a28c0205f379b525beefebab9d161b7c964670864014ed7213c"}, - {file = "appnope-0.1.4.tar.gz", hash = "sha256:1de3860566df9caf38f01f86f65e0e13e379af54f9e4bee1e66b48f2efffd1ee"}, -] - [[package]] name = "astroid" -version = "2.15.8" +version = "3.2.4" description = "An abstract syntax tree for Python with inference support." optional = false -python-versions = ">=3.7.2" +python-versions = ">=3.8.0" files = [ - {file = "astroid-2.15.8-py3-none-any.whl", hash = "sha256:1aa149fc5c6589e3d0ece885b4491acd80af4f087baafa3fb5203b113e68cd3c"}, - {file = "astroid-2.15.8.tar.gz", hash = "sha256:6c107453dffee9055899705de3c9ead36e74119cee151e5a9aaf7f0b0e020a6a"}, + {file = "astroid-3.2.4-py3-none-any.whl", hash = "sha256:413658a61eeca6202a59231abb473f932038fbcbf1666587f66d482083413a25"}, + {file = "astroid-3.2.4.tar.gz", hash = "sha256:0e14202810b30da1b735827f78f5157be2bbd4a7a59b7707ca0bfc2fb4c0063a"}, ] [package.dependencies] -lazy-object-proxy = ">=1.4.0" typing-extensions = {version = ">=4.0.0", markers = "python_version < \"3.11\""} -wrapt = [ - {version = ">=1.11,<2", markers = "python_version < \"3.11\""}, - {version = ">=1.14,<2", markers = "python_version >= \"3.11\""}, -] [[package]] name = "asttokens" @@ -84,16 +65,24 @@ astroid = ["astroid (>=1,<2)", "astroid (>=2,<4)"] test = ["astroid (>=1,<2)", "astroid (>=2,<4)", "pytest"] [[package]] -name = "backcall" -version = "0.2.0" -description = "Specifications for callback functions passed in to an API" +name = "attrs" +version = "24.1.0" +description = "Classes Without Boilerplate" optional = false -python-versions = "*" +python-versions = ">=3.7" files = [ - {file = "backcall-0.2.0-py2.py3-none-any.whl", hash = "sha256:fbbce6a29f263178a1f7915c1940bde0ec2b2a967566fe1c65c1dfb7422bd255"}, - {file = "backcall-0.2.0.tar.gz", hash = "sha256:5cbdbf27be5e7cfadb448baf0aa95508f91f2bbc6c6437cd9cd06e2a4c215e1e"}, + {file = "attrs-24.1.0-py3-none-any.whl", hash = "sha256:377b47448cb61fea38533f671fba0d0f8a96fd58facd4dc518e3dac9dbea0905"}, + {file = "attrs-24.1.0.tar.gz", hash = "sha256:adbdec84af72d38be7628e353a09b6a6790d15cd71819f6e9d7b0faa8a125745"}, ] +[package.extras] +benchmark = ["cloudpickle", "hypothesis", "mypy (>=1.11.1)", "pympler", "pytest (>=4.3.0)", "pytest-codspeed", "pytest-mypy-plugins", "pytest-xdist[psutil]"] +cov = ["cloudpickle", "coverage[toml] (>=5.3)", "hypothesis", "mypy (>=1.11.1)", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins", "pytest-xdist[psutil]"] +dev = ["cloudpickle", "hypothesis", "mypy (>=1.11.1)", "pre-commit", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins", "pytest-xdist[psutil]"] +docs = ["cogapp", "furo", "myst-parser", "sphinx", "sphinx-notfound-page", "sphinxcontrib-towncrier", "towncrier (<24.7)"] +tests = ["cloudpickle", "hypothesis", "mypy (>=1.11.1)", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins", "pytest-xdist[psutil]"] +tests-mypy = ["mypy (>=1.11.1)", "pytest-mypy-plugins"] + [[package]] name = "black" version = "22.12.0" @@ -131,15 +120,61 @@ d = ["aiohttp (>=3.7.4)"] jupyter = ["ipython (>=7.8.0)", "tokenize-rt (>=3.2.0)"] uvloop = ["uvloop (>=0.15.2)"] +[[package]] +name = "build" +version = "1.2.1" +description = "A simple, correct Python build frontend" +optional = false +python-versions = ">=3.8" +files = [ + {file = "build-1.2.1-py3-none-any.whl", hash = "sha256:75e10f767a433d9a86e50d83f418e83efc18ede923ee5ff7df93b6cb0306c5d4"}, + {file = "build-1.2.1.tar.gz", hash = "sha256:526263f4870c26f26c433545579475377b2b7588b6f1eac76a001e873ae3e19d"}, +] + +[package.dependencies] +colorama = {version = "*", markers = "os_name == \"nt\""} +importlib-metadata = {version = ">=4.6", markers = "python_full_version < \"3.10.2\""} +packaging = ">=19.1" +pyproject_hooks = "*" +tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""} + +[package.extras] +docs = ["furo (>=2023.08.17)", "sphinx (>=7.0,<8.0)", "sphinx-argparse-cli (>=1.5)", "sphinx-autodoc-typehints (>=1.10)", "sphinx-issues (>=3.0.0)"] +test = ["build[uv,virtualenv]", "filelock (>=3)", "pytest (>=6.2.4)", "pytest-cov (>=2.12)", "pytest-mock (>=2)", "pytest-rerunfailures (>=9.1)", "pytest-xdist (>=1.34)", "setuptools (>=42.0.0)", "setuptools (>=56.0.0)", "setuptools (>=56.0.0)", "setuptools (>=67.8.0)", "wheel (>=0.36.0)"] +typing = ["build[uv]", "importlib-metadata (>=5.1)", "mypy (>=1.9.0,<1.10.0)", "tomli", "typing-extensions (>=3.7.4.3)"] +uv = ["uv (>=0.1.18)"] +virtualenv = ["virtualenv (>=20.0.35)"] + +[[package]] +name = "cachecontrol" +version = "0.14.0" +description = "httplib2 caching for requests" +optional = false +python-versions = ">=3.7" +files = [ + {file = "cachecontrol-0.14.0-py3-none-any.whl", hash = "sha256:f5bf3f0620c38db2e5122c0726bdebb0d16869de966ea6a2befe92470b740ea0"}, + {file = "cachecontrol-0.14.0.tar.gz", hash = "sha256:7db1195b41c81f8274a7bbd97c956f44e8348265a1bc7641c37dfebc39f0c938"}, +] + +[package.dependencies] +filelock = {version = ">=3.8.0", optional = true, markers = "extra == \"filecache\""} +msgpack = ">=0.5.2,<2.0.0" +requests = ">=2.16.0" + +[package.extras] +dev = ["CacheControl[filecache,redis]", "black", "build", "cherrypy", "furo", "mypy", "pytest", "pytest-cov", "sphinx", "sphinx-copybutton", "tox", "types-redis", "types-requests"] +filecache = ["filelock (>=3.8.0)"] +redis = ["redis (>=2.10.5)"] + [[package]] name = "certifi" -version = "2023.11.17" +version = "2024.7.4" description = "Python package for providing Mozilla's CA Bundle." optional = false python-versions = ">=3.6" files = [ - {file = "certifi-2023.11.17-py3-none-any.whl", hash = "sha256:e036ab49d5b79556f99cfc2d9320b34cfbe5be05c5871b51de9329f0603b0474"}, - {file = "certifi-2023.11.17.tar.gz", hash = "sha256:9b469f3a900bf28dc19b8cfbf8019bf47f7fdd1a65a1d4ffb98fc14166beb4d1"}, + {file = "certifi-2024.7.4-py3-none-any.whl", hash = "sha256:c198e21b1289c2ab85ee4e67bb4b4ef3ead0892059901a8d5b622f24a1101e90"}, + {file = "certifi-2024.7.4.tar.gz", hash = "sha256:5a1e7645bc0ec61a09e26c36f6106dd4cf40c6db3a1fb6352b0244e7fb057c7b"}, ] [[package]] @@ -316,6 +351,21 @@ files = [ {file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"}, ] +[[package]] +name = "cleo" +version = "2.1.0" +description = "Cleo allows you to create beautiful and testable command-line interfaces." +optional = false +python-versions = ">=3.7,<4.0" +files = [ + {file = "cleo-2.1.0-py3-none-any.whl", hash = "sha256:4a31bd4dd45695a64ee3c4758f583f134267c2bc518d8ae9a29cf237d009b07e"}, + {file = "cleo-2.1.0.tar.gz", hash = "sha256:0b2c880b5d13660a7ea651001fb4acb527696c01f15c9ee650f377aa543fd523"}, +] + +[package.dependencies] +crashtest = ">=0.4.1,<0.5.0" +rapidfuzz = ">=3.0.0,<4.0.0" + [[package]] name = "click" version = "8.1.7" @@ -355,45 +405,51 @@ files = [ {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, ] +[[package]] +name = "crashtest" +version = "0.4.1" +description = "Manage Python errors with ease" +optional = false +python-versions = ">=3.7,<4.0" +files = [ + {file = "crashtest-0.4.1-py3-none-any.whl", hash = "sha256:8d23eac5fa660409f57472e3851dab7ac18aba459a8d19cbbba86d3d5aecd2a5"}, + {file = "crashtest-0.4.1.tar.gz", hash = "sha256:80d7b1f316ebfbd429f648076d6275c877ba30ba48979de4191714a75266f0ce"}, +] + [[package]] name = "cryptography" -version = "42.0.5" +version = "43.0.0" description = "cryptography is a package which provides cryptographic recipes and primitives to Python developers." optional = false python-versions = ">=3.7" files = [ - {file = "cryptography-42.0.5-cp37-abi3-macosx_10_12_universal2.whl", hash = "sha256:a30596bae9403a342c978fb47d9b0ee277699fa53bbafad14706af51fe543d16"}, - {file = "cryptography-42.0.5-cp37-abi3-macosx_10_12_x86_64.whl", hash = "sha256:b7ffe927ee6531c78f81aa17e684e2ff617daeba7f189f911065b2ea2d526dec"}, - {file = "cryptography-42.0.5-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2424ff4c4ac7f6b8177b53c17ed5d8fa74ae5955656867f5a8affaca36a27abb"}, - {file = "cryptography-42.0.5-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:329906dcc7b20ff3cad13c069a78124ed8247adcac44b10bea1130e36caae0b4"}, - {file = "cryptography-42.0.5-cp37-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:b03c2ae5d2f0fc05f9a2c0c997e1bc18c8229f392234e8a0194f202169ccd278"}, - {file = "cryptography-42.0.5-cp37-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:f8837fe1d6ac4a8052a9a8ddab256bc006242696f03368a4009be7ee3075cdb7"}, - {file = "cryptography-42.0.5-cp37-abi3-musllinux_1_1_aarch64.whl", hash = "sha256:0270572b8bd2c833c3981724b8ee9747b3ec96f699a9665470018594301439ee"}, - {file = "cryptography-42.0.5-cp37-abi3-musllinux_1_1_x86_64.whl", hash = "sha256:b8cac287fafc4ad485b8a9b67d0ee80c66bf3574f655d3b97ef2e1082360faf1"}, - {file = "cryptography-42.0.5-cp37-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:16a48c23a62a2f4a285699dba2e4ff2d1cff3115b9df052cdd976a18856d8e3d"}, - {file = "cryptography-42.0.5-cp37-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:2bce03af1ce5a5567ab89bd90d11e7bbdff56b8af3acbbec1faded8f44cb06da"}, - {file = "cryptography-42.0.5-cp37-abi3-win32.whl", hash = "sha256:b6cd2203306b63e41acdf39aa93b86fb566049aeb6dc489b70e34bcd07adca74"}, - {file = "cryptography-42.0.5-cp37-abi3-win_amd64.whl", hash = "sha256:98d8dc6d012b82287f2c3d26ce1d2dd130ec200c8679b6213b3c73c08b2b7940"}, - {file = "cryptography-42.0.5-cp39-abi3-macosx_10_12_universal2.whl", hash = "sha256:5e6275c09d2badf57aea3afa80d975444f4be8d3bc58f7f80d2a484c6f9485c8"}, - {file = "cryptography-42.0.5-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e4985a790f921508f36f81831817cbc03b102d643b5fcb81cd33df3fa291a1a1"}, - {file = "cryptography-42.0.5-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7cde5f38e614f55e28d831754e8a3bacf9ace5d1566235e39d91b35502d6936e"}, - {file = "cryptography-42.0.5-cp39-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:7367d7b2eca6513681127ebad53b2582911d1736dc2ffc19f2c3ae49997496bc"}, - {file = "cryptography-42.0.5-cp39-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:cd2030f6650c089aeb304cf093f3244d34745ce0cfcc39f20c6fbfe030102e2a"}, - {file = "cryptography-42.0.5-cp39-abi3-musllinux_1_1_aarch64.whl", hash = "sha256:a2913c5375154b6ef2e91c10b5720ea6e21007412f6437504ffea2109b5a33d7"}, - {file = "cryptography-42.0.5-cp39-abi3-musllinux_1_1_x86_64.whl", hash = "sha256:c41fb5e6a5fe9ebcd58ca3abfeb51dffb5d83d6775405305bfa8715b76521922"}, - {file = "cryptography-42.0.5-cp39-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:3eaafe47ec0d0ffcc9349e1708be2aaea4c6dd4978d76bf6eb0cb2c13636c6fc"}, - {file = "cryptography-42.0.5-cp39-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:1b95b98b0d2af784078fa69f637135e3c317091b615cd0905f8b8a087e86fa30"}, - {file = "cryptography-42.0.5-cp39-abi3-win32.whl", hash = "sha256:1f71c10d1e88467126f0efd484bd44bca5e14c664ec2ede64c32f20875c0d413"}, - {file = "cryptography-42.0.5-cp39-abi3-win_amd64.whl", hash = "sha256:a011a644f6d7d03736214d38832e030d8268bcff4a41f728e6030325fea3e400"}, - {file = "cryptography-42.0.5-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:9481ffe3cf013b71b2428b905c4f7a9a4f76ec03065b05ff499bb5682a8d9ad8"}, - {file = "cryptography-42.0.5-pp310-pypy310_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:ba334e6e4b1d92442b75ddacc615c5476d4ad55cc29b15d590cc6b86efa487e2"}, - {file = "cryptography-42.0.5-pp310-pypy310_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:ba3e4a42397c25b7ff88cdec6e2a16c2be18720f317506ee25210f6d31925f9c"}, - {file = "cryptography-42.0.5-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:111a0d8553afcf8eb02a4fea6ca4f59d48ddb34497aa8706a6cf536f1a5ec576"}, - {file = "cryptography-42.0.5-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:cd65d75953847815962c84a4654a84850b2bb4aed3f26fadcc1c13892e1e29f6"}, - {file = "cryptography-42.0.5-pp39-pypy39_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:e807b3188f9eb0eaa7bbb579b462c5ace579f1cedb28107ce8b48a9f7ad3679e"}, - {file = "cryptography-42.0.5-pp39-pypy39_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:f12764b8fffc7a123f641d7d049d382b73f96a34117e0b637b80643169cec8ac"}, - {file = "cryptography-42.0.5-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:37dd623507659e08be98eec89323469e8c7b4c1407c85112634ae3dbdb926fdd"}, - {file = "cryptography-42.0.5.tar.gz", hash = "sha256:6fe07eec95dfd477eb9530aef5bead34fec819b3aaf6c5bd6d20565da607bfe1"}, + {file = "cryptography-43.0.0-cp37-abi3-macosx_10_9_universal2.whl", hash = "sha256:64c3f16e2a4fc51c0d06af28441881f98c5d91009b8caaff40cf3548089e9c74"}, + {file = "cryptography-43.0.0-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3dcdedae5c7710b9f97ac6bba7e1052b95c7083c9d0e9df96e02a1932e777895"}, + {file = "cryptography-43.0.0-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3d9a1eca329405219b605fac09ecfc09ac09e595d6def650a437523fcd08dd22"}, + {file = "cryptography-43.0.0-cp37-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:ea9e57f8ea880eeea38ab5abf9fbe39f923544d7884228ec67d666abd60f5a47"}, + {file = "cryptography-43.0.0-cp37-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:9a8d6802e0825767476f62aafed40532bd435e8a5f7d23bd8b4f5fd04cc80ecf"}, + {file = "cryptography-43.0.0-cp37-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:cc70b4b581f28d0a254d006f26949245e3657d40d8857066c2ae22a61222ef55"}, + {file = "cryptography-43.0.0-cp37-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:4a997df8c1c2aae1e1e5ac49c2e4f610ad037fc5a3aadc7b64e39dea42249431"}, + {file = "cryptography-43.0.0-cp37-abi3-win32.whl", hash = "sha256:6e2b11c55d260d03a8cf29ac9b5e0608d35f08077d8c087be96287f43af3ccdc"}, + {file = "cryptography-43.0.0-cp37-abi3-win_amd64.whl", hash = "sha256:31e44a986ceccec3d0498e16f3d27b2ee5fdf69ce2ab89b52eaad1d2f33d8778"}, + {file = "cryptography-43.0.0-cp39-abi3-macosx_10_9_universal2.whl", hash = "sha256:7b3f5fe74a5ca32d4d0f302ffe6680fcc5c28f8ef0dc0ae8f40c0f3a1b4fca66"}, + {file = "cryptography-43.0.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ac1955ce000cb29ab40def14fd1bbfa7af2017cca696ee696925615cafd0dce5"}, + {file = "cryptography-43.0.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:299d3da8e00b7e2b54bb02ef58d73cd5f55fb31f33ebbf33bd00d9aa6807df7e"}, + {file = "cryptography-43.0.0-cp39-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:ee0c405832ade84d4de74b9029bedb7b31200600fa524d218fc29bfa371e97f5"}, + {file = "cryptography-43.0.0-cp39-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:cb013933d4c127349b3948aa8aaf2f12c0353ad0eccd715ca789c8a0f671646f"}, + {file = "cryptography-43.0.0-cp39-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:fdcb265de28585de5b859ae13e3846a8e805268a823a12a4da2597f1f5afc9f0"}, + {file = "cryptography-43.0.0-cp39-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:2905ccf93a8a2a416f3ec01b1a7911c3fe4073ef35640e7ee5296754e30b762b"}, + {file = "cryptography-43.0.0-cp39-abi3-win32.whl", hash = "sha256:47ca71115e545954e6c1d207dd13461ab81f4eccfcb1345eac874828b5e3eaaf"}, + {file = "cryptography-43.0.0-cp39-abi3-win_amd64.whl", hash = "sha256:0663585d02f76929792470451a5ba64424acc3cd5227b03921dab0e2f27b1709"}, + {file = "cryptography-43.0.0-pp310-pypy310_pp73-macosx_10_9_x86_64.whl", hash = "sha256:2c6d112bf61c5ef44042c253e4859b3cbbb50df2f78fa8fae6747a7814484a70"}, + {file = "cryptography-43.0.0-pp310-pypy310_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:844b6d608374e7d08f4f6e6f9f7b951f9256db41421917dfb2d003dde4cd6b66"}, + {file = "cryptography-43.0.0-pp310-pypy310_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:51956cf8730665e2bdf8ddb8da0056f699c1a5715648c1b0144670c1ba00b48f"}, + {file = "cryptography-43.0.0-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:aae4d918f6b180a8ab8bf6511a419473d107df4dbb4225c7b48c5c9602c38c7f"}, + {file = "cryptography-43.0.0-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:232ce02943a579095a339ac4b390fbbe97f5b5d5d107f8a08260ea2768be8cc2"}, + {file = "cryptography-43.0.0-pp39-pypy39_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:5bcb8a5620008a8034d39bce21dc3e23735dfdb6a33a06974739bfa04f853947"}, + {file = "cryptography-43.0.0-pp39-pypy39_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:08a24a7070b2b6804c1940ff0f910ff728932a9d0e80e7814234269f9d46d069"}, + {file = "cryptography-43.0.0-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:e9c5266c432a1e23738d178e51c2c7a5e2ddf790f248be939448c0ba2021f9d1"}, + {file = "cryptography-43.0.0.tar.gz", hash = "sha256:b88075ada2d51aa9f18283532c9f60e72170041bba88d7f37e49cbb10275299e"}, ] [package.dependencies] @@ -406,9 +462,28 @@ nox = ["nox"] pep8test = ["check-sdist", "click", "mypy", "ruff"] sdist = ["build"] ssh = ["bcrypt (>=3.1.5)"] -test = ["certifi", "pretend", "pytest (>=6.2.0)", "pytest-benchmark", "pytest-cov", "pytest-xdist"] +test = ["certifi", "cryptography-vectors (==43.0.0)", "pretend", "pytest (>=6.2.0)", "pytest-benchmark", "pytest-cov", "pytest-xdist"] test-randomorder = ["pytest-randomly"] +[[package]] +name = "dataclasses-json" +version = "0.5.9" +description = "Easily serialize dataclasses to and from JSON" +optional = false +python-versions = ">=3.6" +files = [ + {file = "dataclasses-json-0.5.9.tar.gz", hash = "sha256:e9ac87b73edc0141aafbce02b44e93553c3123ad574958f0fe52a534b6707e8e"}, + {file = "dataclasses_json-0.5.9-py3-none-any.whl", hash = "sha256:1280542631df1c375b7bc92e5b86d39e06c44760d7e3571a537b3b8acabf2f0c"}, +] + +[package.dependencies] +marshmallow = ">=3.3.0,<4.0.0" +marshmallow-enum = ">=1.5.1,<2.0.0" +typing-inspect = ">=0.4.0" + +[package.extras] +dev = ["flake8", "hypothesis", "ipython", "mypy (>=0.710)", "portray", "pytest (>=7.2.0)", "setuptools", "simplejson", "twine", "types-dataclasses", "wheel"] + [[package]] name = "decorator" version = "5.1.1" @@ -446,15 +521,35 @@ files = [ {file = "distlib-0.3.8.tar.gz", hash = "sha256:1530ea13e350031b6312d8580ddb6b27a104275a31106523b8f123787f494f64"}, ] +[[package]] +name = "docling-core" +version = "1.1.2" +description = "A python library to define and validate data types in Docling." +optional = false +python-versions = "<4.0,>=3.9" +files = [ + {file = "docling_core-1.1.2-py3-none-any.whl", hash = "sha256:bdff5643e3e37a24204449eee99505db0f1cf620b8e1ce4cf4b71850bf49496b"}, + {file = "docling_core-1.1.2.tar.gz", hash = "sha256:969cde6795631a5f5f8cbb5e7ca0e4032864c1abc8fff762415a09a9b1f7146c"}, +] + +[package.dependencies] +json-schema-for-humans = ">=1.0.0,<2.0.0" +jsonref = ">=1.1.0,<2.0.0" +jsonschema = ">=4.16.0,<5.0.0" +poetry = ">=1.8.3,<2.0.0" +pydantic = ">=2.6.0,<3.0.0" +pyproject-toml = ">=0.0.10,<0.0.11" +tabulate = ">=0.9.0,<0.10.0" + [[package]] name = "docutils" -version = "0.20.1" +version = "0.21.2" description = "Docutils -- Python Documentation Utilities" optional = false -python-versions = ">=3.7" +python-versions = ">=3.9" files = [ - {file = "docutils-0.20.1-py3-none-any.whl", hash = "sha256:96f387a2c5562db4476f09f13bbab2192e764cac08ebbf3a34a95d9b1e4a59d6"}, - {file = "docutils-0.20.1.tar.gz", hash = "sha256:f08a4e276c3a1583a86dce3e34aba3fe04d02bba2dd51ed16106244e8a923e3b"}, + {file = "docutils-0.21.2-py3-none-any.whl", hash = "sha256:dafca5b9e384f0e419294eb4d2ff9fa826435bf15f15b7bd45723e8ad76811b2"}, + {file = "docutils-0.21.2.tar.gz", hash = "sha256:3a6b18732edf182daa3cd12775bbb338cf5691468f91eeeb109deff6ebfa986f"}, ] [[package]] @@ -468,15 +563,102 @@ files = [ {file = "dotty_dict-1.3.1.tar.gz", hash = "sha256:4b016e03b8ae265539757a53eba24b9bfda506fb94fbce0bee843c6f05541a15"}, ] +[[package]] +name = "dulwich" +version = "0.21.7" +description = "Python Git Library" +optional = false +python-versions = ">=3.7" +files = [ + {file = "dulwich-0.21.7-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:d4c0110798099bb7d36a110090f2688050703065448895c4f53ade808d889dd3"}, + {file = "dulwich-0.21.7-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:2bc12697f0918bee324c18836053644035362bb3983dc1b210318f2fed1d7132"}, + {file = "dulwich-0.21.7-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:471305af74790827fcbafe330fc2e8bdcee4fb56ca1177c8c481b1c8f806c4a4"}, + {file = "dulwich-0.21.7-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d54c9d0e845be26f65f954dff13a1cd3f2b9739820c19064257b8fd7435ab263"}, + {file = "dulwich-0.21.7-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:12d61334a575474e707614f2e93d6ed4cdae9eb47214f9277076d9e5615171d3"}, + {file = "dulwich-0.21.7-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:e274cebaf345f0b1e3b70197f2651de92b652386b68020cfd3bf61bc30f6eaaa"}, + {file = "dulwich-0.21.7-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:817822f970e196e757ae01281ecbf21369383285b9f4a83496312204cf889b8c"}, + {file = "dulwich-0.21.7-cp310-cp310-win32.whl", hash = "sha256:7836da3f4110ce684dcd53489015fb7fa94ed33c5276e3318b8b1cbcb5b71e08"}, + {file = "dulwich-0.21.7-cp310-cp310-win_amd64.whl", hash = "sha256:4a043b90958cec866b4edc6aef5fe3c2c96a664d0b357e1682a46f6c477273c4"}, + {file = "dulwich-0.21.7-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:ce8db196e79c1f381469410d26fb1d8b89c6b87a4e7f00ff418c22a35121405c"}, + {file = "dulwich-0.21.7-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:62bfb26bdce869cd40be443dfd93143caea7089b165d2dcc33de40f6ac9d812a"}, + {file = "dulwich-0.21.7-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:c01a735b9a171dcb634a97a3cec1b174cfbfa8e840156870384b633da0460f18"}, + {file = "dulwich-0.21.7-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fa4d14767cf7a49c9231c2e52cb2a3e90d0c83f843eb6a2ca2b5d81d254cf6b9"}, + {file = "dulwich-0.21.7-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7bca4b86e96d6ef18c5bc39828ea349efb5be2f9b1f6ac9863f90589bac1084d"}, + {file = "dulwich-0.21.7-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:a7b5624b02ef808cdc62dabd47eb10cd4ac15e8ac6df9e2e88b6ac6b40133673"}, + {file = "dulwich-0.21.7-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:c3a539b4696a42fbdb7412cb7b66a4d4d332761299d3613d90a642923c7560e1"}, + {file = "dulwich-0.21.7-cp311-cp311-win32.whl", hash = "sha256:675a612ce913081beb0f37b286891e795d905691dfccfb9bf73721dca6757cde"}, + {file = "dulwich-0.21.7-cp311-cp311-win_amd64.whl", hash = "sha256:460ba74bdb19f8d498786ae7776745875059b1178066208c0fd509792d7f7bfc"}, + {file = "dulwich-0.21.7-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:4c51058ec4c0b45dc5189225b9e0c671b96ca9713c1daf71d622c13b0ab07681"}, + {file = "dulwich-0.21.7-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:4bc4c5366eaf26dda3fdffe160a3b515666ed27c2419f1d483da285ac1411de0"}, + {file = "dulwich-0.21.7-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:a0650ec77d89cb947e3e4bbd4841c96f74e52b4650830112c3057a8ca891dc2f"}, + {file = "dulwich-0.21.7-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4f18f0a311fb7734b033a3101292b932158cade54b74d1c44db519e42825e5a2"}, + {file = "dulwich-0.21.7-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c589468e5c0cd84e97eb7ec209ab005a2cb69399e8c5861c3edfe38989ac3a8"}, + {file = "dulwich-0.21.7-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d62446797163317a397a10080c6397ffaaca51a7804c0120b334f8165736c56a"}, + {file = "dulwich-0.21.7-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:e84cc606b1f581733df4350ca4070e6a8b30be3662bbb81a590b177d0c996c91"}, + {file = "dulwich-0.21.7-cp312-cp312-win32.whl", hash = "sha256:c3d1685f320907a52c40fd5890627945c51f3a5fa4bcfe10edb24fec79caadec"}, + {file = "dulwich-0.21.7-cp312-cp312-win_amd64.whl", hash = "sha256:6bd69921fdd813b7469a3c77bc75c1783cc1d8d72ab15a406598e5a3ba1a1503"}, + {file = "dulwich-0.21.7-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:7d8ab29c660125db52106775caa1f8f7f77a69ed1fe8bc4b42bdf115731a25bf"}, + {file = "dulwich-0.21.7-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b0d2e4485b98695bf95350ce9d38b1bb0aaac2c34ad00a0df789aa33c934469b"}, + {file = "dulwich-0.21.7-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e138d516baa6b5bafbe8f030eccc544d0d486d6819b82387fc0e285e62ef5261"}, + {file = "dulwich-0.21.7-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:f34bf9b9fa9308376263fd9ac43143c7c09da9bc75037bb75c6c2423a151b92c"}, + {file = "dulwich-0.21.7-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:2e2c66888207b71cd1daa2acb06d3984a6bc13787b837397a64117aa9fc5936a"}, + {file = "dulwich-0.21.7-cp37-cp37m-win32.whl", hash = "sha256:10893105c6566fc95bc2a67b61df7cc1e8f9126d02a1df6a8b2b82eb59db8ab9"}, + {file = "dulwich-0.21.7-cp37-cp37m-win_amd64.whl", hash = "sha256:460b3849d5c3d3818a80743b4f7a0094c893c559f678e56a02fff570b49a644a"}, + {file = "dulwich-0.21.7-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:74700e4c7d532877355743336c36f51b414d01e92ba7d304c4f8d9a5946dbc81"}, + {file = "dulwich-0.21.7-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:c92e72c43c9e9e936b01a57167e0ea77d3fd2d82416edf9489faa87278a1cdf7"}, + {file = "dulwich-0.21.7-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:d097e963eb6b9fa53266146471531ad9c6765bf390849230311514546ed64db2"}, + {file = "dulwich-0.21.7-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:808e8b9cc0aa9ac74870b49db4f9f39a52fb61694573f84b9c0613c928d4caf8"}, + {file = "dulwich-0.21.7-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e1957b65f96e36c301e419d7adaadcff47647c30eb072468901bb683b1000bc5"}, + {file = "dulwich-0.21.7-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:4b09bc3a64fb70132ec14326ecbe6e0555381108caff3496898962c4136a48c6"}, + {file = "dulwich-0.21.7-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:d5882e70b74ac3c736a42d3fdd4f5f2e6570637f59ad5d3e684760290b58f041"}, + {file = "dulwich-0.21.7-cp38-cp38-win32.whl", hash = "sha256:29bb5c1d70eba155ded41ed8a62be2f72edbb3c77b08f65b89c03976292f6d1b"}, + {file = "dulwich-0.21.7-cp38-cp38-win_amd64.whl", hash = "sha256:25c3ab8fb2e201ad2031ddd32e4c68b7c03cb34b24a5ff477b7a7dcef86372f5"}, + {file = "dulwich-0.21.7-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:8929c37986c83deb4eb500c766ee28b6670285b512402647ee02a857320e377c"}, + {file = "dulwich-0.21.7-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:cc1e11be527ac06316539b57a7688bcb1b6a3e53933bc2f844397bc50734e9ae"}, + {file = "dulwich-0.21.7-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:0fc3078a1ba04c588fabb0969d3530efd5cd1ce2cf248eefb6baf7cbc15fc285"}, + {file = "dulwich-0.21.7-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:40dcbd29ba30ba2c5bfbab07a61a5f20095541d5ac66d813056c122244df4ac0"}, + {file = "dulwich-0.21.7-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8869fc8ec3dda743e03d06d698ad489b3705775fe62825e00fa95aa158097fc0"}, + {file = "dulwich-0.21.7-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d96ca5e0dde49376fbcb44f10eddb6c30284a87bd03bb577c59bb0a1f63903fa"}, + {file = "dulwich-0.21.7-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:e0064363bd5e814359657ae32517fa8001e8573d9d040bd997908d488ab886ed"}, + {file = "dulwich-0.21.7-cp39-cp39-win32.whl", hash = "sha256:869eb7be48243e695673b07905d18b73d1054a85e1f6e298fe63ba2843bb2ca1"}, + {file = "dulwich-0.21.7-cp39-cp39-win_amd64.whl", hash = "sha256:404b8edeb3c3a86c47c0a498699fc064c93fa1f8bab2ffe919e8ab03eafaaad3"}, + {file = "dulwich-0.21.7-pp310-pypy310_pp73-macosx_10_9_x86_64.whl", hash = "sha256:e598d743c6c0548ebcd2baf94aa9c8bfacb787ea671eeeb5828cfbd7d56b552f"}, + {file = "dulwich-0.21.7-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d4a2d76c96426e791556836ef43542b639def81be4f1d6d4322cd886c115eae1"}, + {file = "dulwich-0.21.7-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f6c88acb60a1f4d31bd6d13bfba465853b3df940ee4a0f2a3d6c7a0778c705b7"}, + {file = "dulwich-0.21.7-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:ecd315847dea406a4decfa39d388a2521e4e31acde3bd9c2609c989e817c6d62"}, + {file = "dulwich-0.21.7-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:d05d3c781bc74e2c2a2a8f4e4e2ed693540fbe88e6ac36df81deac574a6dad99"}, + {file = "dulwich-0.21.7-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6de6f8de4a453fdbae8062a6faa652255d22a3d8bce0cd6d2d6701305c75f2b3"}, + {file = "dulwich-0.21.7-pp37-pypy37_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e25953c7acbbe4e19650d0225af1c0c0e6882f8bddd2056f75c1cc2b109b88ad"}, + {file = "dulwich-0.21.7-pp37-pypy37_pp73-win_amd64.whl", hash = "sha256:4637cbd8ed1012f67e1068aaed19fcc8b649bcf3e9e26649826a303298c89b9d"}, + {file = "dulwich-0.21.7-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:858842b30ad6486aacaa607d60bab9c9a29e7c59dc2d9cb77ae5a94053878c08"}, + {file = "dulwich-0.21.7-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:739b191f61e1c4ce18ac7d520e7a7cbda00e182c3489552408237200ce8411ad"}, + {file = "dulwich-0.21.7-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:274c18ec3599a92a9b67abaf110e4f181a4f779ee1aaab9e23a72e89d71b2bd9"}, + {file = "dulwich-0.21.7-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:2590e9b431efa94fc356ae33b38f5e64f1834ec3a94a6ac3a64283b206d07aa3"}, + {file = "dulwich-0.21.7-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:ed60d1f610ef6437586f7768254c2a93820ccbd4cfdac7d182cf2d6e615969bb"}, + {file = "dulwich-0.21.7-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8278835e168dd097089f9e53088c7a69c6ca0841aef580d9603eafe9aea8c358"}, + {file = "dulwich-0.21.7-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ffc27fb063f740712e02b4d2f826aee8bbed737ed799962fef625e2ce56e2d29"}, + {file = "dulwich-0.21.7-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:61e3451bd3d3844f2dca53f131982553be4d1b1e1ebd9db701843dd76c4dba31"}, + {file = "dulwich-0.21.7.tar.gz", hash = "sha256:a9e9c66833cea580c3ac12927e4b9711985d76afca98da971405d414de60e968"}, +] + +[package.dependencies] +urllib3 = ">=1.25" + +[package.extras] +fastimport = ["fastimport"] +https = ["urllib3 (>=1.24.1)"] +paramiko = ["paramiko"] +pgp = ["gpg"] + [[package]] name = "exceptiongroup" -version = "1.2.0" +version = "1.2.2" description = "Backport of PEP 654 (exception groups)" optional = false python-versions = ">=3.7" files = [ - {file = "exceptiongroup-1.2.0-py3-none-any.whl", hash = "sha256:4bfd3996ac73b41e9b9628b04e079f193850720ea5945fc96a08633c66912f14"}, - {file = "exceptiongroup-1.2.0.tar.gz", hash = "sha256:91f5c769735f051a4290d52edd0858999b57e5876e9f85937691bd4c9fa3ed68"}, + {file = "exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b"}, + {file = "exceptiongroup-1.2.2.tar.gz", hash = "sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc"}, ] [package.extras] @@ -498,37 +680,52 @@ tests = ["asttokens (>=2.1.0)", "coverage", "coverage-enable-subprocess", "ipyth [[package]] name = "fastapi" -version = "0.109.2" +version = "0.112.0" description = "FastAPI framework, high performance, easy to learn, fast to code, ready for production" optional = true python-versions = ">=3.8" files = [ - {file = "fastapi-0.109.2-py3-none-any.whl", hash = "sha256:2c9bab24667293b501cad8dd388c05240c850b58ec5876ee3283c47d6e1e3a4d"}, - {file = "fastapi-0.109.2.tar.gz", hash = "sha256:f3817eac96fe4f65a2ebb4baa000f394e55f5fccdaf7f75250804bc58f354f73"}, + {file = "fastapi-0.112.0-py3-none-any.whl", hash = "sha256:3487ded9778006a45834b8c816ec4a48d522e2631ca9e75ec5a774f1b052f821"}, + {file = "fastapi-0.112.0.tar.gz", hash = "sha256:d262bc56b7d101d1f4e8fc0ad2ac75bb9935fec504d2b7117686cec50710cf05"}, ] [package.dependencies] pydantic = ">=1.7.4,<1.8 || >1.8,<1.8.1 || >1.8.1,<2.0.0 || >2.0.0,<2.0.1 || >2.0.1,<2.1.0 || >2.1.0,<3.0.0" -starlette = ">=0.36.3,<0.37.0" +starlette = ">=0.37.2,<0.38.0" typing-extensions = ">=4.8.0" [package.extras] -all = ["email-validator (>=2.0.0)", "httpx (>=0.23.0)", "itsdangerous (>=1.1.0)", "jinja2 (>=2.11.2)", "orjson (>=3.2.1)", "pydantic-extra-types (>=2.0.0)", "pydantic-settings (>=2.0.0)", "python-multipart (>=0.0.7)", "pyyaml (>=5.3.1)", "ujson (>=4.0.1,!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0)", "uvicorn[standard] (>=0.12.0)"] +all = ["email_validator (>=2.0.0)", "fastapi-cli[standard] (>=0.0.5)", "httpx (>=0.23.0)", "itsdangerous (>=1.1.0)", "jinja2 (>=2.11.2)", "orjson (>=3.2.1)", "pydantic-extra-types (>=2.0.0)", "pydantic-settings (>=2.0.0)", "python-multipart (>=0.0.7)", "pyyaml (>=5.3.1)", "ujson (>=4.0.1,!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0)", "uvicorn[standard] (>=0.12.0)"] +standard = ["email_validator (>=2.0.0)", "fastapi-cli[standard] (>=0.0.5)", "httpx (>=0.23.0)", "jinja2 (>=2.11.2)", "python-multipart (>=0.0.7)", "uvicorn[standard] (>=0.12.0)"] + +[[package]] +name = "fastjsonschema" +version = "2.20.0" +description = "Fastest Python implementation of JSON schema" +optional = false +python-versions = "*" +files = [ + {file = "fastjsonschema-2.20.0-py3-none-any.whl", hash = "sha256:5875f0b0fa7a0043a91e93a9b8f793bcbbba9691e7fd83dca95c28ba26d21f0a"}, + {file = "fastjsonschema-2.20.0.tar.gz", hash = "sha256:3d48fc5300ee96f5d116f10fe6f28d938e6008f59a6a025c2649475b87f76a23"}, +] + +[package.extras] +devel = ["colorama", "json-spec", "jsonschema", "pylint", "pytest", "pytest-benchmark", "pytest-cache", "validictory"] [[package]] name = "filelock" -version = "3.13.1" +version = "3.15.4" description = "A platform independent file lock." optional = false python-versions = ">=3.8" files = [ - {file = "filelock-3.13.1-py3-none-any.whl", hash = "sha256:57dbda9b35157b05fb3e58ee91448612eb674172fab98ee235ccb0b5bee19a1c"}, - {file = "filelock-3.13.1.tar.gz", hash = "sha256:521f5f56c50f8426f5e03ad3b281b490a87ef15bc6c526f168290f0c7148d44e"}, + {file = "filelock-3.15.4-py3-none-any.whl", hash = "sha256:6ca1fffae96225dab4c6eaf1c4f4f28cd2568d3ec2a44e15a08520504de468e7"}, + {file = "filelock-3.15.4.tar.gz", hash = "sha256:2207938cbc1844345cb01a5a95524dae30f0ce089eba5b00378295a17e3e90cb"}, ] [package.extras] -docs = ["furo (>=2023.9.10)", "sphinx (>=7.2.6)", "sphinx-autodoc-typehints (>=1.24)"] -testing = ["covdefaults (>=2.3)", "coverage (>=7.3.2)", "diff-cover (>=8)", "pytest (>=7.4.3)", "pytest-cov (>=4.1)", "pytest-mock (>=3.12)", "pytest-timeout (>=2.2)"] +docs = ["furo (>=2023.9.10)", "sphinx (>=7.2.6)", "sphinx-autodoc-typehints (>=1.25.2)"] +testing = ["covdefaults (>=2.3)", "coverage (>=7.3.2)", "diff-cover (>=8.0.1)", "pytest (>=7.4.3)", "pytest-asyncio (>=0.21)", "pytest-cov (>=4.1)", "pytest-mock (>=3.12)", "pytest-timeout (>=2.2)", "virtualenv (>=20.26.2)"] typing = ["typing-extensions (>=4.8)"] [[package]] @@ -564,20 +761,21 @@ smmap = ">=3.0.1,<6" [[package]] name = "gitpython" -version = "3.1.42" +version = "3.1.43" description = "GitPython is a Python library used to interact with Git repositories" optional = false python-versions = ">=3.7" files = [ - {file = "GitPython-3.1.42-py3-none-any.whl", hash = "sha256:1bf9cd7c9e7255f77778ea54359e54ac22a72a5b51288c457c881057b7bb9ecd"}, - {file = "GitPython-3.1.42.tar.gz", hash = "sha256:2d99869e0fef71a73cbd242528105af1d6c1b108c60dfabd994bf292f76c3ceb"}, + {file = "GitPython-3.1.43-py3-none-any.whl", hash = "sha256:eec7ec56b92aad751f9912a73404bc02ba212a23adb2c7098ee668417051a1ff"}, + {file = "GitPython-3.1.43.tar.gz", hash = "sha256:35f314a9f878467f5453cc1fee295c3e18e52f1b99f10f6cf5b1682e968a9e7c"}, ] [package.dependencies] gitdb = ">=4.0.1,<5" [package.extras] -test = ["black", "coverage[toml]", "ddt (>=1.1.1,!=1.4.3)", "mock", "mypy", "pre-commit", "pytest (>=7.3.1)", "pytest-cov", "pytest-instafail", "pytest-mock", "pytest-sugar"] +doc = ["sphinx (==4.3.2)", "sphinx-autodoc-typehints", "sphinx-rtd-theme", "sphinxcontrib-applehelp (>=1.0.2,<=1.0.4)", "sphinxcontrib-devhelp (==1.0.2)", "sphinxcontrib-htmlhelp (>=2.0.0,<=2.0.1)", "sphinxcontrib-qthelp (==1.0.3)", "sphinxcontrib-serializinghtml (==1.1.5)"] +test = ["coverage[toml]", "ddt (>=1.1.1,!=1.4.3)", "mock", "mypy", "pre-commit", "pytest (>=7.3.1)", "pytest-cov", "pytest-instafail", "pytest-mock", "pytest-sugar", "typing-extensions"] [[package]] name = "griffe" @@ -607,15 +805,25 @@ files = [ {file = "h11-0.14.0.tar.gz", hash = "sha256:8f19fbbe99e72420ff35c00b27a34cb9937e902a8b810e2c88300c6f0a3b699d"}, ] +[[package]] +name = "htmlmin" +version = "0.1.12" +description = "An HTML Minifier" +optional = false +python-versions = "*" +files = [ + {file = "htmlmin-0.1.12.tar.gz", hash = "sha256:50c1ef4630374a5d723900096a961cff426dff46b48f34d194a81bbe14eca178"}, +] + [[package]] name = "identify" -version = "2.5.35" +version = "2.6.0" description = "File identification library for Python" optional = false python-versions = ">=3.8" files = [ - {file = "identify-2.5.35-py2.py3-none-any.whl", hash = "sha256:c4de0081837b211594f8e877a6b4fad7ca32bbfc1a9307fdd61c28bfe923f13e"}, - {file = "identify-2.5.35.tar.gz", hash = "sha256:10a7ca245cfcd756a554a7288159f72ff105ad233c7c4b9c6f0f4d108f5f6791"}, + {file = "identify-2.6.0-py2.py3-none-any.whl", hash = "sha256:e79ae4406387a9d300332b5fd366d8994f1525e8414984e1a59e058b2eda2dd0"}, + {file = "identify-2.6.0.tar.gz", hash = "sha256:cb171c685bdc31bcc4c1734698736a7d5b6c8bf2e0c15117f4d469c8640ae5cf"}, ] [package.extras] @@ -623,51 +831,33 @@ license = ["ukkonen"] [[package]] name = "idna" -version = "3.6" +version = "3.7" description = "Internationalized Domain Names in Applications (IDNA)" optional = false python-versions = ">=3.5" files = [ - {file = "idna-3.6-py3-none-any.whl", hash = "sha256:c05567e9c24a6b9faaa835c4821bad0590fbb9d5779e7caa6e1cc4978e7eb24f"}, - {file = "idna-3.6.tar.gz", hash = "sha256:9ecdbbd083b06798ae1e86adcbfe8ab1479cf864e4ee30fe4e46a003d12491ca"}, + {file = "idna-3.7-py3-none-any.whl", hash = "sha256:82fee1fc78add43492d3a1898bfa6d8a904cc97d8427f683ed8e798d07761aa0"}, + {file = "idna-3.7.tar.gz", hash = "sha256:028ff3aadf0609c1fd278d8ea3089299412a7a8b9bd005dd08b9f8285bcb5cfc"}, ] [[package]] name = "importlib-metadata" -version = "7.0.1" +version = "8.2.0" description = "Read metadata from Python packages" optional = false python-versions = ">=3.8" files = [ - {file = "importlib_metadata-7.0.1-py3-none-any.whl", hash = "sha256:4805911c3a4ec7c3966410053e9ec6a1fecd629117df5adee56dfc9432a1081e"}, - {file = "importlib_metadata-7.0.1.tar.gz", hash = "sha256:f238736bb06590ae52ac1fab06a3a9ef1d8dce2b7a35b5ab329371d6c8f5d2cc"}, + {file = "importlib_metadata-8.2.0-py3-none-any.whl", hash = "sha256:11901fa0c2f97919b288679932bb64febaeacf289d18ac84dd68cb2e74213369"}, + {file = "importlib_metadata-8.2.0.tar.gz", hash = "sha256:72e8d4399996132204f9a16dcc751af254a48f8d1b20b9ff0f98d4a8f901e73d"}, ] [package.dependencies] zipp = ">=0.5" [package.extras] -docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (<7.2.5)", "sphinx (>=3.5)", "sphinx-lint"] +doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] perf = ["ipython"] -testing = ["flufl.flake8", "importlib-resources (>=1.3)", "packaging", "pyfakefs", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-mypy (>=0.9.1)", "pytest-perf (>=0.9.2)", "pytest-ruff"] - -[[package]] -name = "importlib-resources" -version = "6.1.2" -description = "Read resources from Python packages" -optional = false -python-versions = ">=3.8" -files = [ - {file = "importlib_resources-6.1.2-py3-none-any.whl", hash = "sha256:9a0a862501dc38b68adebc82970140c9e4209fc99601782925178f8386339938"}, - {file = "importlib_resources-6.1.2.tar.gz", hash = "sha256:308abf8474e2dba5f867d279237cd4076482c3de7104a40b41426370e891549b"}, -] - -[package.dependencies] -zipp = {version = ">=3.1.0", markers = "python_version < \"3.10\""} - -[package.extras] -docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (<7.2.5)", "sphinx (>=3.5)", "sphinx-lint"] -testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-mypy", "pytest-ruff (>=0.2.1)", "zipp (>=3.17)"] +test = ["flufl.flake8", "importlib-resources (>=1.3)", "jaraco.test (>=5.4)", "packaging", "pyfakefs", "pytest (>=6,!=8.1.*)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-mypy", "pytest-perf (>=0.9.2)", "pytest-ruff (>=0.2.1)"] [[package]] name = "iniconfig" @@ -680,6 +870,17 @@ files = [ {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"}, ] +[[package]] +name = "installer" +version = "0.7.0" +description = "A library for installing Python wheels." +optional = false +python-versions = ">=3.7" +files = [ + {file = "installer-0.7.0-py3-none-any.whl", hash = "sha256:05d1933f0a5ba7d8d6296bb6d5018e7c94fa473ceb10cf198a92ccea19c27b53"}, + {file = "installer-0.7.0.tar.gz", hash = "sha256:a26d3e3116289bb08216e0d0f7d925fcef0b0194eedfa0c944bcaaa106c4b631"}, +] + [[package]] name = "invoke" version = "2.2.0" @@ -693,42 +894,40 @@ files = [ [[package]] name = "ipython" -version = "8.12.3" +version = "8.18.1" description = "IPython: Productive Interactive Computing" optional = false -python-versions = ">=3.8" +python-versions = ">=3.9" files = [ - {file = "ipython-8.12.3-py3-none-any.whl", hash = "sha256:b0340d46a933d27c657b211a329d0be23793c36595acf9e6ef4164bc01a1804c"}, - {file = "ipython-8.12.3.tar.gz", hash = "sha256:3910c4b54543c2ad73d06579aa771041b7d5707b033bd488669b4cf544e3b363"}, + {file = "ipython-8.18.1-py3-none-any.whl", hash = "sha256:e8267419d72d81955ec1177f8a29aaa90ac80ad647499201119e2f05e99aa397"}, + {file = "ipython-8.18.1.tar.gz", hash = "sha256:ca6f079bb33457c66e233e4580ebfc4128855b4cf6370dddd73842a9563e8a27"}, ] [package.dependencies] -appnope = {version = "*", markers = "sys_platform == \"darwin\""} -backcall = "*" colorama = {version = "*", markers = "sys_platform == \"win32\""} decorator = "*" +exceptiongroup = {version = "*", markers = "python_version < \"3.11\""} jedi = ">=0.16" matplotlib-inline = "*" pexpect = {version = ">4.3", markers = "sys_platform != \"win32\""} -pickleshare = "*" -prompt-toolkit = ">=3.0.30,<3.0.37 || >3.0.37,<3.1.0" +prompt-toolkit = ">=3.0.41,<3.1.0" pygments = ">=2.4.0" stack-data = "*" traitlets = ">=5" typing-extensions = {version = "*", markers = "python_version < \"3.10\""} [package.extras] -all = ["black", "curio", "docrepr", "ipykernel", "ipyparallel", "ipywidgets", "matplotlib", "matplotlib (!=3.2.0)", "nbconvert", "nbformat", "notebook", "numpy (>=1.21)", "pandas", "pytest (<7)", "pytest (<7.1)", "pytest-asyncio", "qtconsole", "setuptools (>=18.5)", "sphinx (>=1.3)", "sphinx-rtd-theme", "stack-data", "testpath", "trio", "typing-extensions"] +all = ["black", "curio", "docrepr", "exceptiongroup", "ipykernel", "ipyparallel", "ipywidgets", "matplotlib", "matplotlib (!=3.2.0)", "nbconvert", "nbformat", "notebook", "numpy (>=1.22)", "pandas", "pickleshare", "pytest (<7)", "pytest (<7.1)", "pytest-asyncio (<0.22)", "qtconsole", "setuptools (>=18.5)", "sphinx (>=1.3)", "sphinx-rtd-theme", "stack-data", "testpath", "trio", "typing-extensions"] black = ["black"] -doc = ["docrepr", "ipykernel", "matplotlib", "pytest (<7)", "pytest (<7.1)", "pytest-asyncio", "setuptools (>=18.5)", "sphinx (>=1.3)", "sphinx-rtd-theme", "stack-data", "testpath", "typing-extensions"] +doc = ["docrepr", "exceptiongroup", "ipykernel", "matplotlib", "pickleshare", "pytest (<7)", "pytest (<7.1)", "pytest-asyncio (<0.22)", "setuptools (>=18.5)", "sphinx (>=1.3)", "sphinx-rtd-theme", "stack-data", "testpath", "typing-extensions"] kernel = ["ipykernel"] nbconvert = ["nbconvert"] nbformat = ["nbformat"] notebook = ["ipywidgets", "notebook"] parallel = ["ipyparallel"] qtconsole = ["qtconsole"] -test = ["pytest (<7.1)", "pytest-asyncio", "testpath"] -test-extra = ["curio", "matplotlib (!=3.2.0)", "nbformat", "numpy (>=1.21)", "pandas", "pytest (<7.1)", "pytest-asyncio", "testpath", "trio"] +test = ["pickleshare", "pytest (<7.1)", "pytest-asyncio (<0.22)", "testpath"] +test-extra = ["curio", "matplotlib (!=3.2.0)", "nbformat", "numpy (>=1.22)", "pandas", "pickleshare", "pytest (<7.1)", "pytest-asyncio (<0.22)", "testpath", "trio"] [[package]] name = "isort" @@ -746,20 +945,20 @@ colors = ["colorama (>=0.4.6)"] [[package]] name = "jaraco-classes" -version = "3.3.1" +version = "3.4.0" description = "Utility functions for Python class constructs" optional = false python-versions = ">=3.8" files = [ - {file = "jaraco.classes-3.3.1-py3-none-any.whl", hash = "sha256:86b534de565381f6b3c1c830d13f931d7be1a75f0081c57dff615578676e2206"}, - {file = "jaraco.classes-3.3.1.tar.gz", hash = "sha256:cb28a5ebda8bc47d8c8015307d93163464f9f2b91ab4006e09ff0ce07e8bfb30"}, + {file = "jaraco.classes-3.4.0-py3-none-any.whl", hash = "sha256:f662826b6bed8cace05e7ff873ce0f9283b5c924470fe664fff1c2f00f581790"}, + {file = "jaraco.classes-3.4.0.tar.gz", hash = "sha256:47a024b51d0239c0dd8c8540c6c7f484be3b8fcf0b2d85c13825780d3b3f3acd"}, ] [package.dependencies] more-itertools = "*" [package.extras] -docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (<7.2.5)", "sphinx (>=3.5)", "sphinx-lint"] +docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-mypy", "pytest-ruff (>=0.2.1)"] [[package]] @@ -813,6 +1012,75 @@ MarkupSafe = ">=2.0" [package.extras] i18n = ["Babel (>=2.7)"] +[[package]] +name = "json-schema-for-humans" +version = "1.0.2" +description = "Generate static HTML documentation from JSON schemas" +optional = false +python-versions = "<4.0,>=3.8" +files = [ + {file = "json_schema_for_humans-1.0.2-py3-none-any.whl", hash = "sha256:d6ecb023b4f802b10b01abca1295a37e363d9f060e54c21aa2cddea44731c6e1"}, + {file = "json_schema_for_humans-1.0.2.tar.gz", hash = "sha256:8bd807a2bac31650226e451ad3b9583c27ce916375d6938ac9d0251eb6549ad5"}, +] + +[package.dependencies] +click = ">=8.0.1,<9.0.0" +dataclasses-json = ">=0.5.6,<0.6.0" +htmlmin = ">=0.1.12,<0.2.0" +Jinja2 = ">3" +markdown2 = ">=2.4.1,<3.0.0" +MarkupSafe = ">=2.0,<3.0" +Pygments = ">=2.10.0,<3.0.0" +pytz = "*" +PyYAML = ">=5.4.1,<7" +requests = ">=2.31.0,<3.0.0" + +[[package]] +name = "jsonref" +version = "1.1.0" +description = "jsonref is a library for automatic dereferencing of JSON Reference objects for Python." +optional = false +python-versions = ">=3.7" +files = [ + {file = "jsonref-1.1.0-py3-none-any.whl", hash = "sha256:590dc7773df6c21cbf948b5dac07a72a251db28b0238ceecce0a2abfa8ec30a9"}, + {file = "jsonref-1.1.0.tar.gz", hash = "sha256:32fe8e1d85af0fdefbebce950af85590b22b60f9e95443176adbde4e1ecea552"}, +] + +[[package]] +name = "jsonschema" +version = "4.23.0" +description = "An implementation of JSON Schema validation for Python" +optional = false +python-versions = ">=3.8" +files = [ + {file = "jsonschema-4.23.0-py3-none-any.whl", hash = "sha256:fbadb6f8b144a8f8cf9f0b89ba94501d143e50411a1278633f56a7acf7fd5566"}, + {file = "jsonschema-4.23.0.tar.gz", hash = "sha256:d71497fef26351a33265337fa77ffeb82423f3ea21283cd9467bb03999266bc4"}, +] + +[package.dependencies] +attrs = ">=22.2.0" +jsonschema-specifications = ">=2023.03.6" +referencing = ">=0.28.4" +rpds-py = ">=0.7.1" + +[package.extras] +format = ["fqdn", "idna", "isoduration", "jsonpointer (>1.13)", "rfc3339-validator", "rfc3987", "uri-template", "webcolors (>=1.11)"] +format-nongpl = ["fqdn", "idna", "isoduration", "jsonpointer (>1.13)", "rfc3339-validator", "rfc3986-validator (>0.1.0)", "uri-template", "webcolors (>=24.6.0)"] + +[[package]] +name = "jsonschema-specifications" +version = "2023.12.1" +description = "The JSON Schema meta-schemas and vocabularies, exposed as a Registry" +optional = false +python-versions = ">=3.8" +files = [ + {file = "jsonschema_specifications-2023.12.1-py3-none-any.whl", hash = "sha256:87e4fdf3a94858b8a2ba2778d9ba57d8a9cafca7c7489c46ba0d30a8bc6a9c3c"}, + {file = "jsonschema_specifications-2023.12.1.tar.gz", hash = "sha256:48a76787b3e70f5ed53f1160d2b81f586e4ca6d1548c5de7085d1682674764cc"}, +] + +[package.dependencies] +referencing = ">=0.31.0" + [[package]] name = "keyring" version = "24.3.1" @@ -826,7 +1094,6 @@ files = [ [package.dependencies] importlib-metadata = {version = ">=4.11.4", markers = "python_version < \"3.12\""} -importlib-resources = {version = "*", markers = "python_version < \"3.9\""} "jaraco.classes" = "*" jeepney = {version = ">=0.4.2", markers = "sys_platform == \"linux\""} pywin32-ctypes = {version = ">=0.2.0", markers = "sys_platform == \"win32\""} @@ -837,52 +1104,6 @@ completion = ["shtab (>=1.1.0)"] docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (<7.2.5)", "sphinx (>=3.5)", "sphinx-lint"] testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-mypy", "pytest-ruff (>=0.2.1)"] -[[package]] -name = "lazy-object-proxy" -version = "1.10.0" -description = "A fast and thorough lazy object proxy." -optional = false -python-versions = ">=3.8" -files = [ - {file = "lazy-object-proxy-1.10.0.tar.gz", hash = "sha256:78247b6d45f43a52ef35c25b5581459e85117225408a4128a3daf8bf9648ac69"}, - {file = "lazy_object_proxy-1.10.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:855e068b0358ab916454464a884779c7ffa312b8925c6f7401e952dcf3b89977"}, - {file = "lazy_object_proxy-1.10.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7ab7004cf2e59f7c2e4345604a3e6ea0d92ac44e1c2375527d56492014e690c3"}, - {file = "lazy_object_proxy-1.10.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dc0d2fc424e54c70c4bc06787e4072c4f3b1aa2f897dfdc34ce1013cf3ceef05"}, - {file = "lazy_object_proxy-1.10.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:e2adb09778797da09d2b5ebdbceebf7dd32e2c96f79da9052b2e87b6ea495895"}, - {file = "lazy_object_proxy-1.10.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:b1f711e2c6dcd4edd372cf5dec5c5a30d23bba06ee012093267b3376c079ec83"}, - {file = "lazy_object_proxy-1.10.0-cp310-cp310-win32.whl", hash = "sha256:76a095cfe6045c7d0ca77db9934e8f7b71b14645f0094ffcd842349ada5c5fb9"}, - {file = "lazy_object_proxy-1.10.0-cp310-cp310-win_amd64.whl", hash = "sha256:b4f87d4ed9064b2628da63830986c3d2dca7501e6018347798313fcf028e2fd4"}, - {file = "lazy_object_proxy-1.10.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:fec03caabbc6b59ea4a638bee5fce7117be8e99a4103d9d5ad77f15d6f81020c"}, - {file = "lazy_object_proxy-1.10.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:02c83f957782cbbe8136bee26416686a6ae998c7b6191711a04da776dc9e47d4"}, - {file = "lazy_object_proxy-1.10.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:009e6bb1f1935a62889ddc8541514b6a9e1fcf302667dcb049a0be5c8f613e56"}, - {file = "lazy_object_proxy-1.10.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:75fc59fc450050b1b3c203c35020bc41bd2695ed692a392924c6ce180c6f1dc9"}, - {file = "lazy_object_proxy-1.10.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:782e2c9b2aab1708ffb07d4bf377d12901d7a1d99e5e410d648d892f8967ab1f"}, - {file = "lazy_object_proxy-1.10.0-cp311-cp311-win32.whl", hash = "sha256:edb45bb8278574710e68a6b021599a10ce730d156e5b254941754a9cc0b17d03"}, - {file = "lazy_object_proxy-1.10.0-cp311-cp311-win_amd64.whl", hash = "sha256:e271058822765ad5e3bca7f05f2ace0de58a3f4e62045a8c90a0dfd2f8ad8cc6"}, - {file = "lazy_object_proxy-1.10.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:e98c8af98d5707dcdecc9ab0863c0ea6e88545d42ca7c3feffb6b4d1e370c7ba"}, - {file = "lazy_object_proxy-1.10.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:952c81d415b9b80ea261d2372d2a4a2332a3890c2b83e0535f263ddfe43f0d43"}, - {file = "lazy_object_proxy-1.10.0-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:80b39d3a151309efc8cc48675918891b865bdf742a8616a337cb0090791a0de9"}, - {file = "lazy_object_proxy-1.10.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:e221060b701e2aa2ea991542900dd13907a5c90fa80e199dbf5a03359019e7a3"}, - {file = "lazy_object_proxy-1.10.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:92f09ff65ecff3108e56526f9e2481b8116c0b9e1425325e13245abfd79bdb1b"}, - {file = "lazy_object_proxy-1.10.0-cp312-cp312-win32.whl", hash = "sha256:3ad54b9ddbe20ae9f7c1b29e52f123120772b06dbb18ec6be9101369d63a4074"}, - {file = "lazy_object_proxy-1.10.0-cp312-cp312-win_amd64.whl", hash = "sha256:127a789c75151db6af398b8972178afe6bda7d6f68730c057fbbc2e96b08d282"}, - {file = "lazy_object_proxy-1.10.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:9e4ed0518a14dd26092614412936920ad081a424bdcb54cc13349a8e2c6d106a"}, - {file = "lazy_object_proxy-1.10.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5ad9e6ed739285919aa9661a5bbed0aaf410aa60231373c5579c6b4801bd883c"}, - {file = "lazy_object_proxy-1.10.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2fc0a92c02fa1ca1e84fc60fa258458e5bf89d90a1ddaeb8ed9cc3147f417255"}, - {file = "lazy_object_proxy-1.10.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:0aefc7591920bbd360d57ea03c995cebc204b424524a5bd78406f6e1b8b2a5d8"}, - {file = "lazy_object_proxy-1.10.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:5faf03a7d8942bb4476e3b62fd0f4cf94eaf4618e304a19865abf89a35c0bbee"}, - {file = "lazy_object_proxy-1.10.0-cp38-cp38-win32.whl", hash = "sha256:e333e2324307a7b5d86adfa835bb500ee70bfcd1447384a822e96495796b0ca4"}, - {file = "lazy_object_proxy-1.10.0-cp38-cp38-win_amd64.whl", hash = "sha256:cb73507defd385b7705c599a94474b1d5222a508e502553ef94114a143ec6696"}, - {file = "lazy_object_proxy-1.10.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:366c32fe5355ef5fc8a232c5436f4cc66e9d3e8967c01fb2e6302fd6627e3d94"}, - {file = "lazy_object_proxy-1.10.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2297f08f08a2bb0d32a4265e98a006643cd7233fb7983032bd61ac7a02956b3b"}, - {file = "lazy_object_proxy-1.10.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:18dd842b49456aaa9a7cf535b04ca4571a302ff72ed8740d06b5adcd41fe0757"}, - {file = "lazy_object_proxy-1.10.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:217138197c170a2a74ca0e05bddcd5f1796c735c37d0eee33e43259b192aa424"}, - {file = "lazy_object_proxy-1.10.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:9a3a87cf1e133e5b1994144c12ca4aa3d9698517fe1e2ca82977781b16955658"}, - {file = "lazy_object_proxy-1.10.0-cp39-cp39-win32.whl", hash = "sha256:30b339b2a743c5288405aa79a69e706a06e02958eab31859f7f3c04980853b70"}, - {file = "lazy_object_proxy-1.10.0-cp39-cp39-win_amd64.whl", hash = "sha256:a899b10e17743683b293a729d3a11f2f399e8a90c73b089e29f5d0fe3509f0dd"}, - {file = "lazy_object_proxy-1.10.0-pp310.pp311.pp312.pp38.pp39-none-any.whl", hash = "sha256:80fa48bd89c8f2f456fc0765c11c23bf5af827febacd2f523ca5bc1893fcc09d"}, -] - [[package]] name = "markdown" version = "3.3.7" @@ -924,6 +1145,23 @@ profiling = ["gprof2dot"] rtd = ["jupyter_sphinx", "mdit-py-plugins", "myst-parser", "pyyaml", "sphinx", "sphinx-copybutton", "sphinx-design", "sphinx_book_theme"] testing = ["coverage", "pytest", "pytest-cov", "pytest-regressions"] +[[package]] +name = "markdown2" +version = "2.5.0" +description = "A fast and complete Python implementation of Markdown" +optional = false +python-versions = "<4,>=3.8" +files = [ + {file = "markdown2-2.5.0-py2.py3-none-any.whl", hash = "sha256:300d4429b620ebc974ef512339a9e08bc080473f95135a91f33906e24e8280c1"}, + {file = "markdown2-2.5.0.tar.gz", hash = "sha256:9bff02911f8b617b61eb269c4c1a5f9b2087d7ff051604f66a61b63cab30adc2"}, +] + +[package.extras] +all = ["latex2mathml", "pygments (>=2.7.3)", "wavedrom"] +code-syntax-highlighting = ["pygments (>=2.7.3)"] +latex = ["latex2mathml"] +wavedrom = ["wavedrom"] + [[package]] name = "markupsafe" version = "2.1.5" @@ -993,15 +1231,48 @@ files = [ {file = "MarkupSafe-2.1.5.tar.gz", hash = "sha256:d283d37a890ba4c1ae73ffadf8046435c76e7bc2247bbb63c00bd1a709c6544b"}, ] +[[package]] +name = "marshmallow" +version = "3.21.3" +description = "A lightweight library for converting complex datatypes to and from native Python datatypes." +optional = false +python-versions = ">=3.8" +files = [ + {file = "marshmallow-3.21.3-py3-none-any.whl", hash = "sha256:86ce7fb914aa865001a4b2092c4c2872d13bc347f3d42673272cabfdbad386f1"}, + {file = "marshmallow-3.21.3.tar.gz", hash = "sha256:4f57c5e050a54d66361e826f94fba213eb10b67b2fdb02c3e0343ce207ba1662"}, +] + +[package.dependencies] +packaging = ">=17.0" + +[package.extras] +dev = ["marshmallow[tests]", "pre-commit (>=3.5,<4.0)", "tox"] +docs = ["alabaster (==0.7.16)", "autodocsumm (==0.2.12)", "sphinx (==7.3.7)", "sphinx-issues (==4.1.0)", "sphinx-version-warning (==1.1.2)"] +tests = ["pytest", "pytz", "simplejson"] + +[[package]] +name = "marshmallow-enum" +version = "1.5.1" +description = "Enum field for Marshmallow" +optional = false +python-versions = "*" +files = [ + {file = "marshmallow-enum-1.5.1.tar.gz", hash = "sha256:38e697e11f45a8e64b4a1e664000897c659b60aa57bfa18d44e226a9920b6e58"}, + {file = "marshmallow_enum-1.5.1-py2.py3-none-any.whl", hash = "sha256:57161ab3dbfde4f57adeb12090f39592e992b9c86d206d02f6bd03ebec60f072"}, +] + +[package.dependencies] +marshmallow = ">=2.0.0" + [[package]] name = "matplotlib-inline" -version = "0.1.6" +version = "0.1.7" description = "Inline Matplotlib backend for Jupyter" optional = false -python-versions = ">=3.5" +python-versions = ">=3.8" files = [ - {file = "matplotlib-inline-0.1.6.tar.gz", hash = "sha256:f887e5f10ba98e8d2b150ddcf4702c1e5f8b3a20005eb0f74bfdbd360ee6f304"}, - {file = "matplotlib_inline-0.1.6-py3-none-any.whl", hash = "sha256:f1f41aab5328aa5aaea9b16d083b128102f8712542f819fe7e6a420ff581b311"}, + {file = "matplotlib_inline-0.1.7-py3-none-any.whl", hash = "sha256:df192d39a4ff8f21b1895d72e6a13f5fcc5099f00fa84384e0ea28c2cc0653ca"}, + {file = "matplotlib_inline-0.1.7.tar.gz", hash = "sha256:8423b23ec666be3d16e16b60bdd8ac4e86e840ebd1dd11a30b9f117f2fa0ab90"}, ] [package.dependencies] @@ -1172,55 +1443,120 @@ mkdocstrings = ">=0.19" [[package]] name = "more-itertools" -version = "10.2.0" +version = "10.3.0" description = "More routines for operating on iterables, beyond itertools" optional = false python-versions = ">=3.8" files = [ - {file = "more-itertools-10.2.0.tar.gz", hash = "sha256:8fccb480c43d3e99a00087634c06dd02b0d50fbf088b380de5a41a015ec239e1"}, - {file = "more_itertools-10.2.0-py3-none-any.whl", hash = "sha256:686b06abe565edfab151cb8fd385a05651e1fdf8f0a14191e4439283421f8684"}, + {file = "more-itertools-10.3.0.tar.gz", hash = "sha256:e5d93ef411224fbcef366a6e8ddc4c5781bc6359d43412a65dd5964e46111463"}, + {file = "more_itertools-10.3.0-py3-none-any.whl", hash = "sha256:ea6a02e24a9161e51faad17a8782b92a0df82c12c1c8886fec7f0c3fa1a1b320"}, +] + +[[package]] +name = "msgpack" +version = "1.0.8" +description = "MessagePack serializer" +optional = false +python-versions = ">=3.8" +files = [ + {file = "msgpack-1.0.8-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:505fe3d03856ac7d215dbe005414bc28505d26f0c128906037e66d98c4e95868"}, + {file = "msgpack-1.0.8-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:e6b7842518a63a9f17107eb176320960ec095a8ee3b4420b5f688e24bf50c53c"}, + {file = "msgpack-1.0.8-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:376081f471a2ef24828b83a641a02c575d6103a3ad7fd7dade5486cad10ea659"}, + {file = "msgpack-1.0.8-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5e390971d082dba073c05dbd56322427d3280b7cc8b53484c9377adfbae67dc2"}, + {file = "msgpack-1.0.8-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:00e073efcba9ea99db5acef3959efa45b52bc67b61b00823d2a1a6944bf45982"}, + {file = "msgpack-1.0.8-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:82d92c773fbc6942a7a8b520d22c11cfc8fd83bba86116bfcf962c2f5c2ecdaa"}, + {file = "msgpack-1.0.8-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:9ee32dcb8e531adae1f1ca568822e9b3a738369b3b686d1477cbc643c4a9c128"}, + {file = "msgpack-1.0.8-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e3aa7e51d738e0ec0afbed661261513b38b3014754c9459508399baf14ae0c9d"}, + {file = "msgpack-1.0.8-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:69284049d07fce531c17404fcba2bb1df472bc2dcdac642ae71a2d079d950653"}, + {file = "msgpack-1.0.8-cp310-cp310-win32.whl", hash = "sha256:13577ec9e247f8741c84d06b9ece5f654920d8365a4b636ce0e44f15e07ec693"}, + {file = "msgpack-1.0.8-cp310-cp310-win_amd64.whl", hash = "sha256:e532dbd6ddfe13946de050d7474e3f5fb6ec774fbb1a188aaf469b08cf04189a"}, + {file = "msgpack-1.0.8-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:9517004e21664f2b5a5fd6333b0731b9cf0817403a941b393d89a2f1dc2bd836"}, + {file = "msgpack-1.0.8-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:d16a786905034e7e34098634b184a7d81f91d4c3d246edc6bd7aefb2fd8ea6ad"}, + {file = "msgpack-1.0.8-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:e2872993e209f7ed04d963e4b4fbae72d034844ec66bc4ca403329db2074377b"}, + {file = "msgpack-1.0.8-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5c330eace3dd100bdb54b5653b966de7f51c26ec4a7d4e87132d9b4f738220ba"}, + {file = "msgpack-1.0.8-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:83b5c044f3eff2a6534768ccfd50425939e7a8b5cf9a7261c385de1e20dcfc85"}, + {file = "msgpack-1.0.8-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1876b0b653a808fcd50123b953af170c535027bf1d053b59790eebb0aeb38950"}, + {file = "msgpack-1.0.8-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:dfe1f0f0ed5785c187144c46a292b8c34c1295c01da12e10ccddfc16def4448a"}, + {file = "msgpack-1.0.8-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:3528807cbbb7f315bb81959d5961855e7ba52aa60a3097151cb21956fbc7502b"}, + {file = "msgpack-1.0.8-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e2f879ab92ce502a1e65fce390eab619774dda6a6ff719718069ac94084098ce"}, + {file = "msgpack-1.0.8-cp311-cp311-win32.whl", hash = "sha256:26ee97a8261e6e35885c2ecd2fd4a6d38252246f94a2aec23665a4e66d066305"}, + {file = "msgpack-1.0.8-cp311-cp311-win_amd64.whl", hash = "sha256:eadb9f826c138e6cf3c49d6f8de88225a3c0ab181a9b4ba792e006e5292d150e"}, + {file = "msgpack-1.0.8-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:114be227f5213ef8b215c22dde19532f5da9652e56e8ce969bf0a26d7c419fee"}, + {file = "msgpack-1.0.8-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:d661dc4785affa9d0edfdd1e59ec056a58b3dbb9f196fa43587f3ddac654ac7b"}, + {file = "msgpack-1.0.8-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:d56fd9f1f1cdc8227d7b7918f55091349741904d9520c65f0139a9755952c9e8"}, + {file = "msgpack-1.0.8-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0726c282d188e204281ebd8de31724b7d749adebc086873a59efb8cf7ae27df3"}, + {file = "msgpack-1.0.8-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8db8e423192303ed77cff4dce3a4b88dbfaf43979d280181558af5e2c3c71afc"}, + {file = "msgpack-1.0.8-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:99881222f4a8c2f641f25703963a5cefb076adffd959e0558dc9f803a52d6a58"}, + {file = "msgpack-1.0.8-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:b5505774ea2a73a86ea176e8a9a4a7c8bf5d521050f0f6f8426afe798689243f"}, + {file = "msgpack-1.0.8-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:ef254a06bcea461e65ff0373d8a0dd1ed3aa004af48839f002a0c994a6f72d04"}, + {file = "msgpack-1.0.8-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:e1dd7839443592d00e96db831eddb4111a2a81a46b028f0facd60a09ebbdd543"}, + {file = "msgpack-1.0.8-cp312-cp312-win32.whl", hash = "sha256:64d0fcd436c5683fdd7c907eeae5e2cbb5eb872fafbc03a43609d7941840995c"}, + {file = "msgpack-1.0.8-cp312-cp312-win_amd64.whl", hash = "sha256:74398a4cf19de42e1498368c36eed45d9528f5fd0155241e82c4082b7e16cffd"}, + {file = "msgpack-1.0.8-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:0ceea77719d45c839fd73abcb190b8390412a890df2f83fb8cf49b2a4b5c2f40"}, + {file = "msgpack-1.0.8-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1ab0bbcd4d1f7b6991ee7c753655b481c50084294218de69365f8f1970d4c151"}, + {file = "msgpack-1.0.8-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:1cce488457370ffd1f953846f82323cb6b2ad2190987cd4d70b2713e17268d24"}, + {file = "msgpack-1.0.8-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3923a1778f7e5ef31865893fdca12a8d7dc03a44b33e2a5f3295416314c09f5d"}, + {file = "msgpack-1.0.8-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a22e47578b30a3e199ab067a4d43d790249b3c0587d9a771921f86250c8435db"}, + {file = "msgpack-1.0.8-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:bd739c9251d01e0279ce729e37b39d49a08c0420d3fee7f2a4968c0576678f77"}, + {file = "msgpack-1.0.8-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:d3420522057ebab1728b21ad473aa950026d07cb09da41103f8e597dfbfaeb13"}, + {file = "msgpack-1.0.8-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:5845fdf5e5d5b78a49b826fcdc0eb2e2aa7191980e3d2cfd2a30303a74f212e2"}, + {file = "msgpack-1.0.8-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:6a0e76621f6e1f908ae52860bdcb58e1ca85231a9b0545e64509c931dd34275a"}, + {file = "msgpack-1.0.8-cp38-cp38-win32.whl", hash = "sha256:374a8e88ddab84b9ada695d255679fb99c53513c0a51778796fcf0944d6c789c"}, + {file = "msgpack-1.0.8-cp38-cp38-win_amd64.whl", hash = "sha256:f3709997b228685fe53e8c433e2df9f0cdb5f4542bd5114ed17ac3c0129b0480"}, + {file = "msgpack-1.0.8-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:f51bab98d52739c50c56658cc303f190785f9a2cd97b823357e7aeae54c8f68a"}, + {file = "msgpack-1.0.8-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:73ee792784d48aa338bba28063e19a27e8d989344f34aad14ea6e1b9bd83f596"}, + {file = "msgpack-1.0.8-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:f9904e24646570539a8950400602d66d2b2c492b9010ea7e965025cb71d0c86d"}, + {file = "msgpack-1.0.8-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e75753aeda0ddc4c28dce4c32ba2f6ec30b1b02f6c0b14e547841ba5b24f753f"}, + {file = "msgpack-1.0.8-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5dbf059fb4b7c240c873c1245ee112505be27497e90f7c6591261c7d3c3a8228"}, + {file = "msgpack-1.0.8-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4916727e31c28be8beaf11cf117d6f6f188dcc36daae4e851fee88646f5b6b18"}, + {file = "msgpack-1.0.8-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:7938111ed1358f536daf311be244f34df7bf3cdedb3ed883787aca97778b28d8"}, + {file = "msgpack-1.0.8-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:493c5c5e44b06d6c9268ce21b302c9ca055c1fd3484c25ba41d34476c76ee746"}, + {file = "msgpack-1.0.8-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5fbb160554e319f7b22ecf530a80a3ff496d38e8e07ae763b9e82fadfe96f273"}, + {file = "msgpack-1.0.8-cp39-cp39-win32.whl", hash = "sha256:f9af38a89b6a5c04b7d18c492c8ccf2aee7048aff1ce8437c4683bb5a1df893d"}, + {file = "msgpack-1.0.8-cp39-cp39-win_amd64.whl", hash = "sha256:ed59dd52075f8fc91da6053b12e8c89e37aa043f8986efd89e61fae69dc1b011"}, + {file = "msgpack-1.0.8.tar.gz", hash = "sha256:95c02b0e27e706e48d0e5426d1710ca78e0f0628d6e89d5b5a5b91a5f12274f3"}, ] [[package]] name = "mypy" -version = "1.8.0" +version = "1.11.1" description = "Optional static typing for Python" optional = false python-versions = ">=3.8" files = [ - {file = "mypy-1.8.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:485a8942f671120f76afffff70f259e1cd0f0cfe08f81c05d8816d958d4577d3"}, - {file = "mypy-1.8.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:df9824ac11deaf007443e7ed2a4a26bebff98d2bc43c6da21b2b64185da011c4"}, - {file = "mypy-1.8.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2afecd6354bbfb6e0160f4e4ad9ba6e4e003b767dd80d85516e71f2e955ab50d"}, - {file = "mypy-1.8.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:8963b83d53ee733a6e4196954502b33567ad07dfd74851f32be18eb932fb1cb9"}, - {file = "mypy-1.8.0-cp310-cp310-win_amd64.whl", hash = "sha256:e46f44b54ebddbeedbd3d5b289a893219065ef805d95094d16a0af6630f5d410"}, - {file = "mypy-1.8.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:855fe27b80375e5c5878492f0729540db47b186509c98dae341254c8f45f42ae"}, - {file = "mypy-1.8.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:4c886c6cce2d070bd7df4ec4a05a13ee20c0aa60cb587e8d1265b6c03cf91da3"}, - {file = "mypy-1.8.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d19c413b3c07cbecf1f991e2221746b0d2a9410b59cb3f4fb9557f0365a1a817"}, - {file = "mypy-1.8.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:9261ed810972061388918c83c3f5cd46079d875026ba97380f3e3978a72f503d"}, - {file = "mypy-1.8.0-cp311-cp311-win_amd64.whl", hash = "sha256:51720c776d148bad2372ca21ca29256ed483aa9a4cdefefcef49006dff2a6835"}, - {file = "mypy-1.8.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:52825b01f5c4c1c4eb0db253ec09c7aa17e1a7304d247c48b6f3599ef40db8bd"}, - {file = "mypy-1.8.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:f5ac9a4eeb1ec0f1ccdc6f326bcdb464de5f80eb07fb38b5ddd7b0de6bc61e55"}, - {file = "mypy-1.8.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:afe3fe972c645b4632c563d3f3eff1cdca2fa058f730df2b93a35e3b0c538218"}, - {file = "mypy-1.8.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:42c6680d256ab35637ef88891c6bd02514ccb7e1122133ac96055ff458f93fc3"}, - {file = "mypy-1.8.0-cp312-cp312-win_amd64.whl", hash = "sha256:720a5ca70e136b675af3af63db533c1c8c9181314d207568bbe79051f122669e"}, - {file = "mypy-1.8.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:028cf9f2cae89e202d7b6593cd98db6759379f17a319b5faf4f9978d7084cdc6"}, - {file = "mypy-1.8.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:4e6d97288757e1ddba10dd9549ac27982e3e74a49d8d0179fc14d4365c7add66"}, - {file = "mypy-1.8.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7f1478736fcebb90f97e40aff11a5f253af890c845ee0c850fe80aa060a267c6"}, - {file = "mypy-1.8.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:42419861b43e6962a649068a61f4a4839205a3ef525b858377a960b9e2de6e0d"}, - {file = "mypy-1.8.0-cp38-cp38-win_amd64.whl", hash = "sha256:2b5b6c721bd4aabaadead3a5e6fa85c11c6c795e0c81a7215776ef8afc66de02"}, - {file = "mypy-1.8.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5c1538c38584029352878a0466f03a8ee7547d7bd9f641f57a0f3017a7c905b8"}, - {file = "mypy-1.8.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:4ef4be7baf08a203170f29e89d79064463b7fc7a0908b9d0d5114e8009c3a259"}, - {file = "mypy-1.8.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7178def594014aa6c35a8ff411cf37d682f428b3b5617ca79029d8ae72f5402b"}, - {file = "mypy-1.8.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:ab3c84fa13c04aeeeabb2a7f67a25ef5d77ac9d6486ff33ded762ef353aa5592"}, - {file = "mypy-1.8.0-cp39-cp39-win_amd64.whl", hash = "sha256:99b00bc72855812a60d253420d8a2eae839b0afa4938f09f4d2aa9bb4654263a"}, - {file = "mypy-1.8.0-py3-none-any.whl", hash = "sha256:538fd81bb5e430cc1381a443971c0475582ff9f434c16cd46d2c66763ce85d9d"}, - {file = "mypy-1.8.0.tar.gz", hash = "sha256:6ff8b244d7085a0b425b56d327b480c3b29cafbd2eff27316a004f9a7391ae07"}, + {file = "mypy-1.11.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:a32fc80b63de4b5b3e65f4be82b4cfa362a46702672aa6a0f443b4689af7008c"}, + {file = "mypy-1.11.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:c1952f5ea8a5a959b05ed5f16452fddadbaae48b5d39235ab4c3fc444d5fd411"}, + {file = "mypy-1.11.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:e1e30dc3bfa4e157e53c1d17a0dad20f89dc433393e7702b813c10e200843b03"}, + {file = "mypy-1.11.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:2c63350af88f43a66d3dfeeeb8d77af34a4f07d760b9eb3a8697f0386c7590b4"}, + {file = "mypy-1.11.1-cp310-cp310-win_amd64.whl", hash = "sha256:a831671bad47186603872a3abc19634f3011d7f83b083762c942442d51c58d58"}, + {file = "mypy-1.11.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:7b6343d338390bb946d449677726edf60102a1c96079b4f002dedff375953fc5"}, + {file = "mypy-1.11.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:e4fe9f4e5e521b458d8feb52547f4bade7ef8c93238dfb5bbc790d9ff2d770ca"}, + {file = "mypy-1.11.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:886c9dbecc87b9516eff294541bf7f3655722bf22bb898ee06985cd7269898de"}, + {file = "mypy-1.11.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:fca4a60e1dd9fd0193ae0067eaeeb962f2d79e0d9f0f66223a0682f26ffcc809"}, + {file = "mypy-1.11.1-cp311-cp311-win_amd64.whl", hash = "sha256:0bd53faf56de9643336aeea1c925012837432b5faf1701ccca7fde70166ccf72"}, + {file = "mypy-1.11.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:f39918a50f74dc5969807dcfaecafa804fa7f90c9d60506835036cc1bc891dc8"}, + {file = "mypy-1.11.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:0bc71d1fb27a428139dd78621953effe0d208aed9857cb08d002280b0422003a"}, + {file = "mypy-1.11.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:b868d3bcff720dd7217c383474008ddabaf048fad8d78ed948bb4b624870a417"}, + {file = "mypy-1.11.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:a707ec1527ffcdd1c784d0924bf5cb15cd7f22683b919668a04d2b9c34549d2e"}, + {file = "mypy-1.11.1-cp312-cp312-win_amd64.whl", hash = "sha256:64f4a90e3ea07f590c5bcf9029035cf0efeae5ba8be511a8caada1a4893f5525"}, + {file = "mypy-1.11.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:749fd3213916f1751fff995fccf20c6195cae941dc968f3aaadf9bb4e430e5a2"}, + {file = "mypy-1.11.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:b639dce63a0b19085213ec5fdd8cffd1d81988f47a2dec7100e93564f3e8fb3b"}, + {file = "mypy-1.11.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:4c956b49c5d865394d62941b109728c5c596a415e9c5b2be663dd26a1ff07bc0"}, + {file = "mypy-1.11.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:45df906e8b6804ef4b666af29a87ad9f5921aad091c79cc38e12198e220beabd"}, + {file = "mypy-1.11.1-cp38-cp38-win_amd64.whl", hash = "sha256:d44be7551689d9d47b7abc27c71257adfdb53f03880841a5db15ddb22dc63edb"}, + {file = "mypy-1.11.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:2684d3f693073ab89d76da8e3921883019ea8a3ec20fa5d8ecca6a2db4c54bbe"}, + {file = "mypy-1.11.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:79c07eb282cb457473add5052b63925e5cc97dfab9812ee65a7c7ab5e3cb551c"}, + {file = "mypy-1.11.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:11965c2f571ded6239977b14deebd3f4c3abd9a92398712d6da3a772974fad69"}, + {file = "mypy-1.11.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:a2b43895a0f8154df6519706d9bca8280cda52d3d9d1514b2d9c3e26792a0b74"}, + {file = "mypy-1.11.1-cp39-cp39-win_amd64.whl", hash = "sha256:1a81cf05975fd61aec5ae16501a091cfb9f605dc3e3c878c0da32f250b74760b"}, + {file = "mypy-1.11.1-py3-none-any.whl", hash = "sha256:0624bdb940255d2dd24e829d99a13cfeb72e4e9031f9492148f410ed30bcab54"}, + {file = "mypy-1.11.1.tar.gz", hash = "sha256:f404a0b069709f18bbdb702eb3dcfe51910602995de00bd39cea3050b5772d08"}, ] [package.dependencies] mypy-extensions = ">=1.0.0" tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""} -typing-extensions = ">=4.1.0" +typing-extensions = ">=4.6.0" [package.extras] dmypy = ["psutil (>=4.0)"] @@ -1241,68 +1577,65 @@ files = [ [[package]] name = "nh3" -version = "0.2.15" +version = "0.2.18" description = "Python bindings to the ammonia HTML sanitization library." optional = false python-versions = "*" files = [ - {file = "nh3-0.2.15-cp37-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl", hash = "sha256:9c0d415f6b7f2338f93035bba5c0d8c1b464e538bfbb1d598acd47d7969284f0"}, - {file = "nh3-0.2.15-cp37-abi3-macosx_10_12_x86_64.whl", hash = "sha256:6f42f99f0cf6312e470b6c09e04da31f9abaadcd3eb591d7d1a88ea931dca7f3"}, - {file = "nh3-0.2.15-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ac19c0d68cd42ecd7ead91a3a032fdfff23d29302dbb1311e641a130dfefba97"}, - {file = "nh3-0.2.15-cp37-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5f0d77272ce6d34db6c87b4f894f037d55183d9518f948bba236fe81e2bb4e28"}, - {file = "nh3-0.2.15-cp37-abi3-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:8d595df02413aa38586c24811237e95937ef18304e108b7e92c890a06793e3bf"}, - {file = "nh3-0.2.15-cp37-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:86e447a63ca0b16318deb62498db4f76fc60699ce0a1231262880b38b6cff911"}, - {file = "nh3-0.2.15-cp37-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3277481293b868b2715907310c7be0f1b9d10491d5adf9fce11756a97e97eddf"}, - {file = "nh3-0.2.15-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:60684857cfa8fdbb74daa867e5cad3f0c9789415aba660614fe16cd66cbb9ec7"}, - {file = "nh3-0.2.15-cp37-abi3-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:3b803a5875e7234907f7d64777dfde2b93db992376f3d6d7af7f3bc347deb305"}, - {file = "nh3-0.2.15-cp37-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:0d02d0ff79dfd8208ed25a39c12cbda092388fff7f1662466e27d97ad011b770"}, - {file = "nh3-0.2.15-cp37-abi3-musllinux_1_2_armv7l.whl", hash = "sha256:f3b53ba93bb7725acab1e030bc2ecd012a817040fd7851b332f86e2f9bb98dc6"}, - {file = "nh3-0.2.15-cp37-abi3-musllinux_1_2_i686.whl", hash = "sha256:b1e97221cedaf15a54f5243f2c5894bb12ca951ae4ddfd02a9d4ea9df9e1a29d"}, - {file = "nh3-0.2.15-cp37-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:a5167a6403d19c515217b6bcaaa9be420974a6ac30e0da9e84d4fc67a5d474c5"}, - {file = "nh3-0.2.15-cp37-abi3-win32.whl", hash = "sha256:427fecbb1031db085eaac9931362adf4a796428ef0163070c484b5a768e71601"}, - {file = "nh3-0.2.15-cp37-abi3-win_amd64.whl", hash = "sha256:bc2d086fb540d0fa52ce35afaded4ea526b8fc4d3339f783db55c95de40ef02e"}, - {file = "nh3-0.2.15.tar.gz", hash = "sha256:d1e30ff2d8d58fb2a14961f7aac1bbb1c51f9bdd7da727be35c63826060b0bf3"}, + {file = "nh3-0.2.18-cp37-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl", hash = "sha256:14c5a72e9fe82aea5fe3072116ad4661af5cf8e8ff8fc5ad3450f123e4925e86"}, + {file = "nh3-0.2.18-cp37-abi3-macosx_10_12_x86_64.whl", hash = "sha256:7b7c2a3c9eb1a827d42539aa64091640bd275b81e097cd1d8d82ef91ffa2e811"}, + {file = "nh3-0.2.18-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42c64511469005058cd17cc1537578eac40ae9f7200bedcfd1fc1a05f4f8c200"}, + {file = "nh3-0.2.18-cp37-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:0411beb0589eacb6734f28d5497ca2ed379eafab8ad8c84b31bb5c34072b7164"}, + {file = "nh3-0.2.18-cp37-abi3-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:5f36b271dae35c465ef5e9090e1fdaba4a60a56f0bb0ba03e0932a66f28b9189"}, + {file = "nh3-0.2.18-cp37-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:34c03fa78e328c691f982b7c03d4423bdfd7da69cd707fe572f544cf74ac23ad"}, + {file = "nh3-0.2.18-cp37-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:19aaba96e0f795bd0a6c56291495ff59364f4300d4a39b29a0abc9cb3774a84b"}, + {file = "nh3-0.2.18-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:de3ceed6e661954871d6cd78b410213bdcb136f79aafe22aa7182e028b8c7307"}, + {file = "nh3-0.2.18-cp37-abi3-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:6955369e4d9f48f41e3f238a9e60f9410645db7e07435e62c6a9ea6135a4907f"}, + {file = "nh3-0.2.18-cp37-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:f0eca9ca8628dbb4e916ae2491d72957fdd35f7a5d326b7032a345f111ac07fe"}, + {file = "nh3-0.2.18-cp37-abi3-musllinux_1_2_armv7l.whl", hash = "sha256:3a157ab149e591bb638a55c8c6bcb8cdb559c8b12c13a8affaba6cedfe51713a"}, + {file = "nh3-0.2.18-cp37-abi3-musllinux_1_2_i686.whl", hash = "sha256:c8b3a1cebcba9b3669ed1a84cc65bf005728d2f0bc1ed2a6594a992e817f3a50"}, + {file = "nh3-0.2.18-cp37-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:36c95d4b70530b320b365659bb5034341316e6a9b30f0b25fa9c9eff4c27a204"}, + {file = "nh3-0.2.18-cp37-abi3-win32.whl", hash = "sha256:a7f1b5b2c15866f2db413a3649a8fe4fd7b428ae58be2c0f6bca5eefd53ca2be"}, + {file = "nh3-0.2.18-cp37-abi3-win_amd64.whl", hash = "sha256:8ce0f819d2f1933953fca255db2471ad58184a60508f03e6285e5114b6254844"}, + {file = "nh3-0.2.18.tar.gz", hash = "sha256:94a166927e53972a9698af9542ace4e38b9de50c34352b962f4d9a7d4c927af4"}, ] [[package]] name = "nodeenv" -version = "1.8.0" +version = "1.9.1" description = "Node.js virtual environment builder" optional = false -python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*" +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" files = [ - {file = "nodeenv-1.8.0-py2.py3-none-any.whl", hash = "sha256:df865724bb3c3adc86b3876fa209771517b0cfe596beff01a92700e0e8be4cec"}, - {file = "nodeenv-1.8.0.tar.gz", hash = "sha256:d51e0c37e64fbf47d017feac3145cdbb58836d7eee8c6f6d3b6880c5456227d2"}, + {file = "nodeenv-1.9.1-py2.py3-none-any.whl", hash = "sha256:ba11c9782d29c27c70ffbdda2d7415098754709be8a7056d79a737cd901155c9"}, + {file = "nodeenv-1.9.1.tar.gz", hash = "sha256:6ec12890a2dab7946721edbfbcd91f3319c6ccc9aec47be7c7e6b7011ee6645f"}, ] -[package.dependencies] -setuptools = "*" - [[package]] name = "packaging" -version = "23.2" +version = "24.1" description = "Core utilities for Python packages" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "packaging-23.2-py3-none-any.whl", hash = "sha256:8c491190033a9af7e1d931d0b5dacc2ef47509b34dd0de67ed209b5203fc88c7"}, - {file = "packaging-23.2.tar.gz", hash = "sha256:048fb0e9405036518eaaf48a55953c750c11e1a1b68e0dd1a9d62ed0c092cfc5"}, + {file = "packaging-24.1-py3-none-any.whl", hash = "sha256:5b8f2217dbdbd2f7f384c41c628544e6d52f2d0f53c6d0c3ea61aa5d1d7ff124"}, + {file = "packaging-24.1.tar.gz", hash = "sha256:026ed72c8ed3fcce5bf8950572258698927fd1dbda10a5e981cdf0ac37f4f002"}, ] [[package]] name = "parso" -version = "0.8.3" +version = "0.8.4" description = "A Python Parser" optional = false python-versions = ">=3.6" files = [ - {file = "parso-0.8.3-py2.py3-none-any.whl", hash = "sha256:c001d4636cd3aecdaf33cbb40aebb59b094be2a74c556778ef5576c175e19e75"}, - {file = "parso-0.8.3.tar.gz", hash = "sha256:8c07be290bb59f03588915921e29e8a50002acaf2cdc5fa0e0114f91709fafa0"}, + {file = "parso-0.8.4-py2.py3-none-any.whl", hash = "sha256:a418670a20291dacd2dddc80c377c5c3791378ee1e8d12bffc35420643d43f18"}, + {file = "parso-0.8.4.tar.gz", hash = "sha256:eb3a7b58240fb99099a345571deecc0f9540ea5f4dd2fe14c2a99d6b281ab92d"}, ] [package.extras] -qa = ["flake8 (==3.8.3)", "mypy (==0.782)"] -testing = ["docopt", "pytest (<6.0.0)"] +qa = ["flake8 (==5.0.4)", "mypy (==0.971)", "types-setuptools (==67.2.0.1)"] +testing = ["docopt", "pytest"] [[package]] name = "pathspec" @@ -1329,26 +1662,15 @@ files = [ [package.dependencies] ptyprocess = ">=0.5" -[[package]] -name = "pickleshare" -version = "0.7.5" -description = "Tiny 'shelve'-like database with concurrency support" -optional = false -python-versions = "*" -files = [ - {file = "pickleshare-0.7.5-py2.py3-none-any.whl", hash = "sha256:9649af414d74d4df115d5d718f82acb59c9d418196b7b4290ed47a12ce62df56"}, - {file = "pickleshare-0.7.5.tar.gz", hash = "sha256:87683d47965c1da65cdacaf31c8441d12b8044cdec9aca500cd78fc2c683afca"}, -] - [[package]] name = "pkginfo" -version = "1.10.0" +version = "1.11.1" description = "Query metadata from sdists / bdists / installed packages." optional = false -python-versions = ">=3.6" +python-versions = ">=3.8" files = [ - {file = "pkginfo-1.10.0-py3-none-any.whl", hash = "sha256:889a6da2ed7ffc58ab5b900d888ddce90bce912f2d2de1dc1c26f4cb9fe65097"}, - {file = "pkginfo-1.10.0.tar.gz", hash = "sha256:5df73835398d10db79f8eecd5cd86b1f6d29317589ea70796994d49399af6297"}, + {file = "pkginfo-1.11.1-py3-none-any.whl", hash = "sha256:bfa76a714fdfc18a045fcd684dbfc3816b603d9d075febef17cb6582bea29573"}, + {file = "pkginfo-1.11.1.tar.gz", hash = "sha256:2e0dca1cf4c8e39644eed32408ea9966ee15e0d324c62ba899a393b3c6b467aa"}, ] [package.extras] @@ -1371,19 +1693,82 @@ test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=7.4)", "pytest-co [[package]] name = "pluggy" -version = "1.4.0" +version = "1.5.0" description = "plugin and hook calling mechanisms for python" optional = false python-versions = ">=3.8" files = [ - {file = "pluggy-1.4.0-py3-none-any.whl", hash = "sha256:7db9f7b503d67d1c5b95f59773ebb58a8c1c288129a88665838012cfb07b8981"}, - {file = "pluggy-1.4.0.tar.gz", hash = "sha256:8c85c2876142a764e5b7548e7d9a0e0ddb46f5185161049a79b7e974454223be"}, + {file = "pluggy-1.5.0-py3-none-any.whl", hash = "sha256:44e1ad92c8ca002de6377e165f3e0f1be63266ab4d554740532335b9d75ea669"}, + {file = "pluggy-1.5.0.tar.gz", hash = "sha256:2cffa88e94fdc978c4c574f15f9e59b7f4201d439195c3715ca9e2486f1d0cf1"}, ] [package.extras] dev = ["pre-commit", "tox"] testing = ["pytest", "pytest-benchmark"] +[[package]] +name = "poetry" +version = "1.8.3" +description = "Python dependency management and packaging made easy." +optional = false +python-versions = "<4.0,>=3.8" +files = [ + {file = "poetry-1.8.3-py3-none-any.whl", hash = "sha256:88191c69b08d06f9db671b793d68f40048e8904c0718404b63dcc2b5aec62d13"}, + {file = "poetry-1.8.3.tar.gz", hash = "sha256:67f4eb68288eab41e841cc71a00d26cf6bdda9533022d0189a145a34d0a35f48"}, +] + +[package.dependencies] +build = ">=1.0.3,<2.0.0" +cachecontrol = {version = ">=0.14.0,<0.15.0", extras = ["filecache"]} +cleo = ">=2.1.0,<3.0.0" +crashtest = ">=0.4.1,<0.5.0" +dulwich = ">=0.21.2,<0.22.0" +fastjsonschema = ">=2.18.0,<3.0.0" +importlib-metadata = {version = ">=4.4", markers = "python_version < \"3.10\""} +installer = ">=0.7.0,<0.8.0" +keyring = ">=24.0.0,<25.0.0" +packaging = ">=23.1" +pexpect = ">=4.7.0,<5.0.0" +pkginfo = ">=1.10,<2.0" +platformdirs = ">=3.0.0,<5" +poetry-core = "1.9.0" +poetry-plugin-export = ">=1.6.0,<2.0.0" +pyproject-hooks = ">=1.0.0,<2.0.0" +requests = ">=2.26,<3.0" +requests-toolbelt = ">=1.0.0,<2.0.0" +shellingham = ">=1.5,<2.0" +tomli = {version = ">=2.0.1,<3.0.0", markers = "python_version < \"3.11\""} +tomlkit = ">=0.11.4,<1.0.0" +trove-classifiers = ">=2022.5.19" +virtualenv = ">=20.23.0,<21.0.0" +xattr = {version = ">=1.0.0,<2.0.0", markers = "sys_platform == \"darwin\""} + +[[package]] +name = "poetry-core" +version = "1.9.0" +description = "Poetry PEP 517 Build Backend" +optional = false +python-versions = ">=3.8,<4.0" +files = [ + {file = "poetry_core-1.9.0-py3-none-any.whl", hash = "sha256:4e0c9c6ad8cf89956f03b308736d84ea6ddb44089d16f2adc94050108ec1f5a1"}, + {file = "poetry_core-1.9.0.tar.gz", hash = "sha256:fa7a4001eae8aa572ee84f35feb510b321bd652e5cf9293249d62853e1f935a2"}, +] + +[[package]] +name = "poetry-plugin-export" +version = "1.8.0" +description = "Poetry plugin to export the dependencies to various formats" +optional = false +python-versions = "<4.0,>=3.8" +files = [ + {file = "poetry_plugin_export-1.8.0-py3-none-any.whl", hash = "sha256:adbe232cfa0cc04991ea3680c865cf748bff27593b9abcb1f35fb50ed7ba2c22"}, + {file = "poetry_plugin_export-1.8.0.tar.gz", hash = "sha256:1fa6168a85d59395d835ca564bc19862a7c76061e60c3e7dfaec70d50937fc61"}, +] + +[package.dependencies] +poetry = ">=1.8.0,<3.0.0" +poetry-core = ">=1.7.0,<3.0.0" + [[package]] name = "pre-commit" version = "2.21.0" @@ -1404,13 +1789,13 @@ virtualenv = ">=20.10.0" [[package]] name = "prompt-toolkit" -version = "3.0.43" +version = "3.0.47" description = "Library for building powerful interactive command lines in Python" optional = false python-versions = ">=3.7.0" files = [ - {file = "prompt_toolkit-3.0.43-py3-none-any.whl", hash = "sha256:a11a29cb3bf0a28a387fe5122cdb649816a957cd9261dcedf8c9f1fef33eacf6"}, - {file = "prompt_toolkit-3.0.43.tar.gz", hash = "sha256:3527b7af26106cbc65a040bcc84839a3566ec1b051bb0bfe953631e704b0ff7d"}, + {file = "prompt_toolkit-3.0.47-py3-none-any.whl", hash = "sha256:0d7bfa67001d5e39d02c224b663abc33687405033a8c422d0d675a5a13361d10"}, + {file = "prompt_toolkit-3.0.47.tar.gz", hash = "sha256:1e1b29cb58080b1e69f207c893a1a7bf16d127a5c30c9d17a25a5d77792e5360"}, ] [package.dependencies] @@ -1429,13 +1814,13 @@ files = [ [[package]] name = "pure-eval" -version = "0.2.2" +version = "0.2.3" description = "Safely evaluate AST nodes without side effects" optional = false python-versions = "*" files = [ - {file = "pure_eval-0.2.2-py3-none-any.whl", hash = "sha256:01eaab343580944bc56080ebe0a674b39ec44a945e6d09ba7db3cb8cec289350"}, - {file = "pure_eval-0.2.2.tar.gz", hash = "sha256:2b45320af6dfaa1750f543d714b6d1c520a1688dec6fd24d339063ce0aaa9ac3"}, + {file = "pure_eval-0.2.3-py3-none-any.whl", hash = "sha256:1db8e35b67b3d218d818ae653e27f06c3aa420901fa7b081ca98cbedc874e0d0"}, + {file = "pure_eval-0.2.3.tar.gz", hash = "sha256:5f4e983f40564c576c7c8635ae88db5956bb2229d7e9237d03b3c0b0190eaf42"}, ] [package.extras] @@ -1443,34 +1828,15 @@ tests = ["pytest"] [[package]] name = "pycparser" -version = "2.21" +version = "2.22" description = "C parser in Python" optional = false -python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" -files = [ - {file = "pycparser-2.21-py2.py3-none-any.whl", hash = "sha256:8ee45429555515e1f6b185e78100aea234072576aa43ab53aefcae078162fca9"}, - {file = "pycparser-2.21.tar.gz", hash = "sha256:e644fdec12f7872f86c58ff790da456218b10f863970249516d60a5eaca77206"}, -] - -[[package]] -name = "pydantic" -version = "2.7.4" -description = "Data validation using Python type hints" -optional = false python-versions = ">=3.8" files = [ - {file = "pydantic-2.7.4-py3-none-any.whl", hash = "sha256:ee8538d41ccb9c0a9ad3e0e5f07bf15ed8015b481ced539a1759d8cc89ae90d0"}, - {file = "pydantic-2.7.4.tar.gz", hash = "sha256:0c84efd9548d545f63ac0060c1e4d39bb9b14db8b3c0652338aecc07b5adec52"}, + {file = "pycparser-2.22-py3-none-any.whl", hash = "sha256:c3702b6d3dd8c7abc1afa565d7e63d53a1d0bd86cdc24edd75470f4de499cfcc"}, + {file = "pycparser-2.22.tar.gz", hash = "sha256:491c8be9c040f5390f5bf44a5b07752bd07f56edf992381b05c701439eec10f6"}, ] -[package.dependencies] -annotated-types = ">=0.4.0" -pydantic-core = "2.18.4" -typing-extensions = ">=4.6.1" - -[package.extras] -email = ["email-validator (>=2.0.0)"] - [[package]] name = "pydantic" version = "2.8.2" @@ -1485,102 +1851,14 @@ files = [ [package.dependencies] annotated-types = ">=0.4.0" pydantic-core = "2.20.1" -typing-extensions = {version = ">=4.6.1", markers = "python_version < \"3.13\""} +typing-extensions = [ + {version = ">=4.6.1", markers = "python_version < \"3.13\""}, + {version = ">=4.12.2", markers = "python_version >= \"3.13\""}, +] [package.extras] email = ["email-validator (>=2.0.0)"] -[[package]] -name = "pydantic-core" -version = "2.18.4" -description = "Core functionality for Pydantic validation and serialization" -optional = false -python-versions = ">=3.8" -files = [ - {file = "pydantic_core-2.18.4-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:f76d0ad001edd426b92233d45c746fd08f467d56100fd8f30e9ace4b005266e4"}, - {file = "pydantic_core-2.18.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:59ff3e89f4eaf14050c8022011862df275b552caef8082e37b542b066ce1ff26"}, - {file = "pydantic_core-2.18.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a55b5b16c839df1070bc113c1f7f94a0af4433fcfa1b41799ce7606e5c79ce0a"}, - {file = "pydantic_core-2.18.4-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:4d0dcc59664fcb8974b356fe0a18a672d6d7cf9f54746c05f43275fc48636851"}, - {file = "pydantic_core-2.18.4-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8951eee36c57cd128f779e641e21eb40bc5073eb28b2d23f33eb0ef14ffb3f5d"}, - {file = "pydantic_core-2.18.4-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4701b19f7e3a06ea655513f7938de6f108123bf7c86bbebb1196eb9bd35cf724"}, - {file = "pydantic_core-2.18.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e00a3f196329e08e43d99b79b286d60ce46bed10f2280d25a1718399457e06be"}, - {file = "pydantic_core-2.18.4-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:97736815b9cc893b2b7f663628e63f436018b75f44854c8027040e05230eeddb"}, - {file = "pydantic_core-2.18.4-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:6891a2ae0e8692679c07728819b6e2b822fb30ca7445f67bbf6509b25a96332c"}, - {file = "pydantic_core-2.18.4-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:bc4ff9805858bd54d1a20efff925ccd89c9d2e7cf4986144b30802bf78091c3e"}, - {file = "pydantic_core-2.18.4-cp310-none-win32.whl", hash = "sha256:1b4de2e51bbcb61fdebd0ab86ef28062704f62c82bbf4addc4e37fa4b00b7cbc"}, - {file = "pydantic_core-2.18.4-cp310-none-win_amd64.whl", hash = "sha256:6a750aec7bf431517a9fd78cb93c97b9b0c496090fee84a47a0d23668976b4b0"}, - {file = "pydantic_core-2.18.4-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:942ba11e7dfb66dc70f9ae66b33452f51ac7bb90676da39a7345e99ffb55402d"}, - {file = "pydantic_core-2.18.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:b2ebef0e0b4454320274f5e83a41844c63438fdc874ea40a8b5b4ecb7693f1c4"}, - {file = "pydantic_core-2.18.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a642295cd0c8df1b86fc3dced1d067874c353a188dc8e0f744626d49e9aa51c4"}, - {file = "pydantic_core-2.18.4-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5f09baa656c904807e832cf9cce799c6460c450c4ad80803517032da0cd062e2"}, - {file = "pydantic_core-2.18.4-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:98906207f29bc2c459ff64fa007afd10a8c8ac080f7e4d5beff4c97086a3dabd"}, - {file = "pydantic_core-2.18.4-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:19894b95aacfa98e7cb093cd7881a0c76f55731efad31073db4521e2b6ff5b7d"}, - {file = "pydantic_core-2.18.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0fbbdc827fe5e42e4d196c746b890b3d72876bdbf160b0eafe9f0334525119c8"}, - {file = "pydantic_core-2.18.4-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:f85d05aa0918283cf29a30b547b4df2fbb56b45b135f9e35b6807cb28bc47951"}, - {file = "pydantic_core-2.18.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e85637bc8fe81ddb73fda9e56bab24560bdddfa98aa64f87aaa4e4b6730c23d2"}, - {file = "pydantic_core-2.18.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:2f5966897e5461f818e136b8451d0551a2e77259eb0f73a837027b47dc95dab9"}, - {file = "pydantic_core-2.18.4-cp311-none-win32.whl", hash = "sha256:44c7486a4228413c317952e9d89598bcdfb06399735e49e0f8df643e1ccd0558"}, - {file = "pydantic_core-2.18.4-cp311-none-win_amd64.whl", hash = "sha256:8a7164fe2005d03c64fd3b85649891cd4953a8de53107940bf272500ba8a788b"}, - {file = "pydantic_core-2.18.4-cp311-none-win_arm64.whl", hash = "sha256:4e99bc050fe65c450344421017f98298a97cefc18c53bb2f7b3531eb39bc7805"}, - {file = "pydantic_core-2.18.4-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:6f5c4d41b2771c730ea1c34e458e781b18cc668d194958e0112455fff4e402b2"}, - {file = "pydantic_core-2.18.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:2fdf2156aa3d017fddf8aea5adfba9f777db1d6022d392b682d2a8329e087cef"}, - {file = "pydantic_core-2.18.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4748321b5078216070b151d5271ef3e7cc905ab170bbfd27d5c83ee3ec436695"}, - {file = "pydantic_core-2.18.4-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:847a35c4d58721c5dc3dba599878ebbdfd96784f3fb8bb2c356e123bdcd73f34"}, - {file = "pydantic_core-2.18.4-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3c40d4eaad41f78e3bbda31b89edc46a3f3dc6e171bf0ecf097ff7a0ffff7cb1"}, - {file = "pydantic_core-2.18.4-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:21a5e440dbe315ab9825fcd459b8814bb92b27c974cbc23c3e8baa2b76890077"}, - {file = "pydantic_core-2.18.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:01dd777215e2aa86dfd664daed5957704b769e726626393438f9c87690ce78c3"}, - {file = "pydantic_core-2.18.4-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:4b06beb3b3f1479d32befd1f3079cc47b34fa2da62457cdf6c963393340b56e9"}, - {file = "pydantic_core-2.18.4-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:564d7922e4b13a16b98772441879fcdcbe82ff50daa622d681dd682175ea918c"}, - {file = "pydantic_core-2.18.4-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:0eb2a4f660fcd8e2b1c90ad566db2b98d7f3f4717c64fe0a83e0adb39766d5b8"}, - {file = "pydantic_core-2.18.4-cp312-none-win32.whl", hash = "sha256:8b8bab4c97248095ae0c4455b5a1cd1cdd96e4e4769306ab19dda135ea4cdb07"}, - {file = "pydantic_core-2.18.4-cp312-none-win_amd64.whl", hash = "sha256:14601cdb733d741b8958224030e2bfe21a4a881fb3dd6fbb21f071cabd48fa0a"}, - {file = "pydantic_core-2.18.4-cp312-none-win_arm64.whl", hash = "sha256:c1322d7dd74713dcc157a2b7898a564ab091ca6c58302d5c7b4c07296e3fd00f"}, - {file = "pydantic_core-2.18.4-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:823be1deb01793da05ecb0484d6c9e20baebb39bd42b5d72636ae9cf8350dbd2"}, - {file = "pydantic_core-2.18.4-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:ebef0dd9bf9b812bf75bda96743f2a6c5734a02092ae7f721c048d156d5fabae"}, - {file = "pydantic_core-2.18.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ae1d6df168efb88d7d522664693607b80b4080be6750c913eefb77e34c12c71a"}, - {file = "pydantic_core-2.18.4-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:f9899c94762343f2cc2fc64c13e7cae4c3cc65cdfc87dd810a31654c9b7358cc"}, - {file = "pydantic_core-2.18.4-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:99457f184ad90235cfe8461c4d70ab7dd2680e28821c29eca00252ba90308c78"}, - {file = "pydantic_core-2.18.4-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:18f469a3d2a2fdafe99296a87e8a4c37748b5080a26b806a707f25a902c040a8"}, - {file = "pydantic_core-2.18.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b7cdf28938ac6b8b49ae5e92f2735056a7ba99c9b110a474473fd71185c1af5d"}, - {file = "pydantic_core-2.18.4-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:938cb21650855054dc54dfd9120a851c974f95450f00683399006aa6e8abb057"}, - {file = "pydantic_core-2.18.4-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:44cd83ab6a51da80fb5adbd9560e26018e2ac7826f9626bc06ca3dc074cd198b"}, - {file = "pydantic_core-2.18.4-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:972658f4a72d02b8abfa2581d92d59f59897d2e9f7e708fdabe922f9087773af"}, - {file = "pydantic_core-2.18.4-cp38-none-win32.whl", hash = "sha256:1d886dc848e60cb7666f771e406acae54ab279b9f1e4143babc9c2258213daa2"}, - {file = "pydantic_core-2.18.4-cp38-none-win_amd64.whl", hash = "sha256:bb4462bd43c2460774914b8525f79b00f8f407c945d50881568f294c1d9b4443"}, - {file = "pydantic_core-2.18.4-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:44a688331d4a4e2129140a8118479443bd6f1905231138971372fcde37e43528"}, - {file = "pydantic_core-2.18.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:a2fdd81edd64342c85ac7cf2753ccae0b79bf2dfa063785503cb85a7d3593223"}, - {file = "pydantic_core-2.18.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:86110d7e1907ab36691f80b33eb2da87d780f4739ae773e5fc83fb272f88825f"}, - {file = "pydantic_core-2.18.4-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:46387e38bd641b3ee5ce247563b60c5ca098da9c56c75c157a05eaa0933ed154"}, - {file = "pydantic_core-2.18.4-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:123c3cec203e3f5ac7b000bd82235f1a3eced8665b63d18be751f115588fea30"}, - {file = "pydantic_core-2.18.4-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:dc1803ac5c32ec324c5261c7209e8f8ce88e83254c4e1aebdc8b0a39f9ddb443"}, - {file = "pydantic_core-2.18.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:53db086f9f6ab2b4061958d9c276d1dbe3690e8dd727d6abf2321d6cce37fa94"}, - {file = "pydantic_core-2.18.4-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:abc267fa9837245cc28ea6929f19fa335f3dc330a35d2e45509b6566dc18be23"}, - {file = "pydantic_core-2.18.4-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:a0d829524aaefdebccb869eed855e2d04c21d2d7479b6cada7ace5448416597b"}, - {file = "pydantic_core-2.18.4-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:509daade3b8649f80d4e5ff21aa5673e4ebe58590b25fe42fac5f0f52c6f034a"}, - {file = "pydantic_core-2.18.4-cp39-none-win32.whl", hash = "sha256:ca26a1e73c48cfc54c4a76ff78df3727b9d9f4ccc8dbee4ae3f73306a591676d"}, - {file = "pydantic_core-2.18.4-cp39-none-win_amd64.whl", hash = "sha256:c67598100338d5d985db1b3d21f3619ef392e185e71b8d52bceacc4a7771ea7e"}, - {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:574d92eac874f7f4db0ca653514d823a0d22e2354359d0759e3f6a406db5d55d"}, - {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:1f4d26ceb5eb9eed4af91bebeae4b06c3fb28966ca3a8fb765208cf6b51102ab"}, - {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:77450e6d20016ec41f43ca4a6c63e9fdde03f0ae3fe90e7c27bdbeaece8b1ed4"}, - {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d323a01da91851a4f17bf592faf46149c9169d68430b3146dcba2bb5e5719abc"}, - {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:43d447dd2ae072a0065389092a231283f62d960030ecd27565672bd40746c507"}, - {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:578e24f761f3b425834f297b9935e1ce2e30f51400964ce4801002435a1b41ef"}, - {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:81b5efb2f126454586d0f40c4d834010979cb80785173d1586df845a632e4e6d"}, - {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:ab86ce7c8f9bea87b9d12c7f0af71102acbf5ecbc66c17796cff45dae54ef9a5"}, - {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:90afc12421df2b1b4dcc975f814e21bc1754640d502a2fbcc6d41e77af5ec312"}, - {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:51991a89639a912c17bef4b45c87bd83593aee0437d8102556af4885811d59f5"}, - {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:293afe532740370aba8c060882f7d26cfd00c94cae32fd2e212a3a6e3b7bc15e"}, - {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b48ece5bde2e768197a2d0f6e925f9d7e3e826f0ad2271120f8144a9db18d5c8"}, - {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:eae237477a873ab46e8dd748e515c72c0c804fb380fbe6c85533c7de51f23a8f"}, - {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:834b5230b5dfc0c1ec37b2fda433b271cbbc0e507560b5d1588e2cc1148cf1ce"}, - {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:e858ac0a25074ba4bce653f9b5d0a85b7456eaddadc0ce82d3878c22489fa4ee"}, - {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:2fd41f6eff4c20778d717af1cc50eca52f5afe7805ee530a4fbd0bae284f16e9"}, - {file = "pydantic_core-2.18.4.tar.gz", hash = "sha256:ec3beeada09ff865c344ff3bc2f427f5e6c26401cc6113d77e372c3fdac73864"}, -] - -[package.dependencies] -typing-extensions = ">=4.6.0,<4.7.0 || >4.7.0" - [[package]] name = "pydantic-core" version = "2.20.1" @@ -1704,38 +1982,38 @@ yaml = ["pyyaml (>=6.0.1)"] [[package]] name = "pygments" -version = "2.17.2" +version = "2.18.0" description = "Pygments is a syntax highlighting package written in Python." optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "pygments-2.17.2-py3-none-any.whl", hash = "sha256:b27c2826c47d0f3219f29554824c30c5e8945175d888647acd804ddd04af846c"}, - {file = "pygments-2.17.2.tar.gz", hash = "sha256:da46cec9fd2de5be3a8a784f434e4c4ab670b4ff54d605c4c2717e9d49c4c367"}, + {file = "pygments-2.18.0-py3-none-any.whl", hash = "sha256:b8e6aca0523f3ab76fee51799c488e38782ac06eafcf95e7ba832985c8e7b13a"}, + {file = "pygments-2.18.0.tar.gz", hash = "sha256:786ff802f32e91311bff3889f6e9a86e81505fe99f2735bb6d60ae0c5004f199"}, ] [package.extras] -plugins = ["importlib-metadata"] windows-terminal = ["colorama (>=0.4.6)"] [[package]] name = "pylint" -version = "2.17.7" +version = "3.2.6" description = "python code static checker" optional = false -python-versions = ">=3.7.2" +python-versions = ">=3.8.0" files = [ - {file = "pylint-2.17.7-py3-none-any.whl", hash = "sha256:27a8d4c7ddc8c2f8c18aa0050148f89ffc09838142193fdbe98f172781a3ff87"}, - {file = "pylint-2.17.7.tar.gz", hash = "sha256:f4fcac7ae74cfe36bc8451e931d8438e4a476c20314b1101c458ad0f05191fad"}, + {file = "pylint-3.2.6-py3-none-any.whl", hash = "sha256:03c8e3baa1d9fb995b12c1dbe00aa6c4bcef210c2a2634374aedeb22fb4a8f8f"}, + {file = "pylint-3.2.6.tar.gz", hash = "sha256:a5d01678349454806cff6d886fb072294f56a58c4761278c97fb557d708e1eb3"}, ] [package.dependencies] -astroid = ">=2.15.8,<=2.17.0-dev0" +astroid = ">=3.2.4,<=3.3.0-dev0" colorama = {version = ">=0.4.5", markers = "sys_platform == \"win32\""} dill = [ {version = ">=0.2", markers = "python_version < \"3.11\""}, - {version = ">=0.3.6", markers = "python_version >= \"3.11\""}, + {version = ">=0.3.7", markers = "python_version >= \"3.12\""}, + {version = ">=0.3.6", markers = "python_version >= \"3.11\" and python_version < \"3.12\""}, ] -isort = ">=4.2.5,<6" +isort = ">=4.2.5,<5.13.0 || >5.13.0,<6" mccabe = ">=0.6,<0.8" platformdirs = ">=2.2.0" tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""} @@ -1764,6 +2042,34 @@ pyyaml = "*" [package.extras] extra = ["pygments (>=2.12)"] +[[package]] +name = "pyproject-hooks" +version = "1.1.0" +description = "Wrappers to call pyproject.toml-based build backend hooks." +optional = false +python-versions = ">=3.7" +files = [ + {file = "pyproject_hooks-1.1.0-py3-none-any.whl", hash = "sha256:7ceeefe9aec63a1064c18d939bdc3adf2d8aa1988a510afec15151578b232aa2"}, + {file = "pyproject_hooks-1.1.0.tar.gz", hash = "sha256:4b37730834edbd6bd37f26ece6b44802fb1c1ee2ece0e54ddff8bfc06db86965"}, +] + +[[package]] +name = "pyproject-toml" +version = "0.0.10" +description = "Project intend to implement PEP 517, 518, 621, 631 and so on." +optional = false +python-versions = "*" +files = [ + {file = "pyproject-toml-0.0.10.tar.gz", hash = "sha256:f0ce0e9934ecb00c0e529b4a1c380edd3034c4be65516769c5f080bdb23dfcb3"}, + {file = "pyproject_toml-0.0.10-py3-none-any.whl", hash = "sha256:257a7070617e1a0bcfd8f790817b30bd9193876023a9b9e7a6b4fc976acf4c3e"}, +] + +[package.dependencies] +jsonschema = "*" +setuptools = ">=42" +toml = "*" +wheel = "*" + [[package]] name = "pytest" version = "7.4.4" @@ -1864,6 +2170,17 @@ docs = ["Jinja2 (==3.0.3)", "Sphinx (==1.8.6)"] mypy = ["mypy", "types-requests"] test = ["coverage (>=5,<6)", "mock (==1.3.0)", "pytest (>=7,<8)", "pytest-mock (>=2,<3)", "pytest-xdist (>=1,<2)", "responses (==0.13.3)"] +[[package]] +name = "pytz" +version = "2024.1" +description = "World timezone definitions, modern and historical" +optional = false +python-versions = "*" +files = [ + {file = "pytz-2024.1-py2.py3-none-any.whl", hash = "sha256:328171f4e3623139da4983451950b28e95ac706e13f3f2630a879749e7a8b319"}, + {file = "pytz-2024.1.tar.gz", hash = "sha256:2a29735ea9c18baf14b448846bde5a48030ed267578472d8955cd0e7443a9812"}, +] + [[package]] name = "pywin32-ctypes" version = "0.2.2" @@ -1949,34 +2266,154 @@ files = [ [package.dependencies] pyyaml = "*" +[[package]] +name = "rapidfuzz" +version = "3.9.5" +description = "rapid fuzzy string matching" +optional = false +python-versions = ">=3.8" +files = [ + {file = "rapidfuzz-3.9.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:7659058863d84a2c36c5a76c28bc8713d33eab03e677e67260d9e1cca43fc3bb"}, + {file = "rapidfuzz-3.9.5-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:802a018776bd3cb7c5d23ba38ebbb1663a9f742be1d58e73b62d8c7cace6e607"}, + {file = "rapidfuzz-3.9.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:da71e8fdb0d1a21f4b58b2c84bcbc2b89a472c073c5f7bdb9339f4cb3122c0e3"}, + {file = "rapidfuzz-3.9.5-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f9433cb12731167b358fbcff9828d2294429986a03222031f6d14308eb643c77"}, + {file = "rapidfuzz-3.9.5-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3e33e1d185206730b916b3e7d9bce1941c65b2a1488cdd0457ae21be385a7912"}, + {file = "rapidfuzz-3.9.5-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:758719e9613c47a274768f1926460955223fe0a03e7eda264f2b78b1b97a4743"}, + {file = "rapidfuzz-3.9.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7981cc6240d01d4480795d758ea2ee748257771f68127d630045e58fe1b5545a"}, + {file = "rapidfuzz-3.9.5-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:b6cdca86120c3f9aa069f8d4e1c5422e92f833d705d719a2ba7082412f4c933b"}, + {file = "rapidfuzz-3.9.5-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:ffa533acb1a9dcb6e26c4467fdc1347995fb168ec9f794b97545f6b72dee733c"}, + {file = "rapidfuzz-3.9.5-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:13eeaeb0d5fe00fa99336f73fb5ab65c46109c7121cf87659b9601908b8b6178"}, + {file = "rapidfuzz-3.9.5-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:d7b1922b1403ccb3583218e8cd931b08e04c5442ca03dbaf6ea4fcf574ee2b24"}, + {file = "rapidfuzz-3.9.5-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:b0189f691cea4dc9fe074ea6b97da30a91d0882fa69724b4b34b51d2c1983473"}, + {file = "rapidfuzz-3.9.5-cp310-cp310-win32.whl", hash = "sha256:72e466e5de12a327a09ed6d0116f024759b5146b335645c32241da84134a7f34"}, + {file = "rapidfuzz-3.9.5-cp310-cp310-win_amd64.whl", hash = "sha256:345011cfcafaa3674c46673baad67d2394eb58285530d8333e65c3c9a143b4f4"}, + {file = "rapidfuzz-3.9.5-cp310-cp310-win_arm64.whl", hash = "sha256:5dc19c8222475e4f7f528b94d2fa28e7979355c5cf7c6e73902d2abb2be96522"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6c741972d64031535cfd76d89cf47259e590e822353be57ec2f5d56758c98296"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:a7452d079800cf70a7314f73044f03cbcbd90a651d9dec39443d2a8a2b63ab53"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f06f163a0341bad162e972590b73e17f9cea2ed8ee27b193875ccbc3dd6eca2f"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:529e2cf441746bd492f6c36a38bf9fa6a418df95b9c003f8e92a55d8a979bd9c"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9811a741aa1350ad36689d675ded8b34e423e68b396bd30bff751a9c582f586e"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9e36c4640a789b8c922b69a548968939d1c0433fa7aac83cb08e1334d4e5d7de"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:53fb2f32f14c921d2f673c5b7cd58d4cc626c574a28c0791f283880d8e57022c"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:031806eb035a6f09f4ff23b9d971d50b30b5e93aa3ee620c920bee1dc32827e7"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:f6dbe1df0b9334e3cf07445d810c81734ae23d137b5efc69e1d676ff55691351"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:24345826b50aafcea26e2e4be5c103d96fe9d7fc549ac9190641300290958f3b"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:bfd3b66ee1f0ebb40c672a7a7e5bda00fb763fa9bca082058084175151f8e685"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:a6f1df5b0e602e94199cccb5e241bbc2319644003e34f077741ebf48aea7ed1a"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-win32.whl", hash = "sha256:f080d6709f51a8335e73826b96af9b4e3657631eca6c69e1ac501868dcc84b7f"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-win_amd64.whl", hash = "sha256:bf9ed6988da6a2c1f8df367cb5d6be26a3d8543646c8eba79741ac9e764fbc59"}, + {file = "rapidfuzz-3.9.5-cp311-cp311-win_arm64.whl", hash = "sha256:599714790dfac0a23a473134e6677d0a103690a4e21ba189cfc826e322cdc8d5"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:9729852038fb2de096e249899f8a9bee90fb1f92e10b6ccc539d5bb798c703bc"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:9dc39435476fb3b3b3c24ab2c08c726056b2b487aa7ee450aee698b808c808ac"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d6ceea632b0eb97dac54411c29feb190054e91fd0571f585b56e4a9159c55ab0"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:cadd66e6ef9901909dc1b11db91048f1bf4613ba7d773386f922e28b1e1df4da"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:63e34fb3586431589a5e1cd7fc61c6f057576c6c6804c1c673bac3de0516dee7"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:181073256faec68e6b8ab3329a36cfa1360f7906aa70d9aee4a39cb70889f73f"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8419c18bbbd67058ca1312f35acda2e4e4592650f105cfd166569a2ebccd01f1"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:191d1057cca56641f7b919fe712cb7e48cd226342e097a78136127f8bde32caa"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:fe5a11eefd0ae90d32d9ff706a894498b4efb4b0c263ad9d1e6401050863504d"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:e1b024d9d69bb83e125adee4162991f2764f16acc3fb1ed0f0fc1ad5aeb7e394"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:7d5a34b8388ae99bdbd5a3646f45ac318f4c870105bdbe42a2f4c85e5b347761"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:0e09abc0d397019bba61c8e6dfe2ec863d4dfb1762f51c9197ce0af5d5fd9adb"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-win32.whl", hash = "sha256:e3c4be3057472c79ba6f4eab35daa9f12908cb697c472d05fbbd47949a87aec6"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-win_amd64.whl", hash = "sha256:0d9fdb74df87018dd4146f3d00df9fca2c27f060936a9e8d3015e7bfb9cb69e4"}, + {file = "rapidfuzz-3.9.5-cp312-cp312-win_arm64.whl", hash = "sha256:491d3d425b5fe3f61f3b9a70abfd498ce9139d94956db7a8551e537e017c0e57"}, + {file = "rapidfuzz-3.9.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:518dec750a30f115ba1299ef2547cf468a69f310581a030c8a875257de747c5f"}, + {file = "rapidfuzz-3.9.5-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:252dc3d1c3d613b8db1b59d13381937e420c99f8a351ffa0e78c2f54746e107f"}, + {file = "rapidfuzz-3.9.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ebd17688b75b6fa983e8586cad30f36eb9736b860946cc8b633b9442c9481831"}, + {file = "rapidfuzz-3.9.5-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e8032492021b0aa55a623d6f6e739a5d4aaabc32af379c2a5656bf1e9e178bf1"}, + {file = "rapidfuzz-3.9.5-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:73362eb1c3d02f32e4c7f0d77eb284e9a13f278cff224f71e8f60e2aff5b6a5d"}, + {file = "rapidfuzz-3.9.5-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a42d1f7b8988f50013e703ed27b5e216ef8a725b2f4ac53754ad0476020b26f4"}, + {file = "rapidfuzz-3.9.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d4f2e985172bb76c9179e11fb67d9c9ecbee4933740eca2977797094df02498d"}, + {file = "rapidfuzz-3.9.5-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:8e943c5cbd10e15369be1f371ef303cb413c1008f64d93bd13762ea06ca84d59"}, + {file = "rapidfuzz-3.9.5-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:0d34b0e8e29f80cb2ac8afe8fb7b01a542b136ffbf7e2b9983d11bce49398f68"}, + {file = "rapidfuzz-3.9.5-cp38-cp38-musllinux_1_2_ppc64le.whl", hash = "sha256:62b8f9f58e9dffaa86fef84db2705457a58e191a962124f2b815026ba79d9aba"}, + {file = "rapidfuzz-3.9.5-cp38-cp38-musllinux_1_2_s390x.whl", hash = "sha256:ebf682bdb0f01b6b1f9a9ffe918aa3ac84fbdadb998ffbfcd5f9b12bd280170f"}, + {file = "rapidfuzz-3.9.5-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:3ed0c17e5b6fdd2ac3230bdefa908579971377c36aa4a2f132700fa8145040db"}, + {file = "rapidfuzz-3.9.5-cp38-cp38-win32.whl", hash = "sha256:ac460d89b9759e37eef23fed05184179654882a241f6b2363df194f8940cc55f"}, + {file = "rapidfuzz-3.9.5-cp38-cp38-win_amd64.whl", hash = "sha256:cf9aceb4227fd09f9a20e505f78487b2089d6420ce232d288522ea0a78b986b9"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:14587df847d0d50bd10cde0a198b5d64eedb7484c72b825f5c2ead6e6ff16eee"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:fd94d952299ec73ea63a0fa4b699a2750785b6bb82aa56fd886d9023b86f90ab"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:733bf3d7876bf6d8167e6436f99d6ea16a218ec2c8eb9da6048f20b9cc8733e2"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fb28f2b7173ed3678b4630b0c8b21503087d1cd082bae200dc2519ca38b26686"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:80a4c8a2c5ae4b133fec6b5db1af9a4126ffa6eca18a558fe5b6ab8e330d3d78"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5feb75e905281e5c669e21c98d594acc3b222a8694d9342f17df988766d83748"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d047b01637a31d9bf776b66438f574fd1db856ad14cf296c1f48bb6bef8a5aff"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:d9e0a656274ac75ec24499a06c0bc5eee67bcd8276c6061da7c05d549f1b1a61"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:16c982dd3cdd33cf4aac91027a263a081d1a8050dc33a27470367a391a8d1576"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-musllinux_1_2_ppc64le.whl", hash = "sha256:9a0c878d0980508e90e973a9cbfb591acc370085f2301c6aacadbd8362d52a36"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-musllinux_1_2_s390x.whl", hash = "sha256:1d9bcfec5efd55b6268328cccd12956d833582d8da6385231a5c6c6201a1156a"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:8171fc6e4645e636161a9ef5b44b20605adbefe23cd990b68d72cae0b9c12509"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-win32.whl", hash = "sha256:35088e759b083398ab3c4154517476e116653b7403604677af9a894179f1042f"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-win_amd64.whl", hash = "sha256:6d8cc7e6e5c6fbcacdfe3cf7a86b60dcaf216216d86e6879ff52d488e5b11e27"}, + {file = "rapidfuzz-3.9.5-cp39-cp39-win_arm64.whl", hash = "sha256:506547889f18db0acca787ffb9f287757cbfe9f0fadddd4e07c64ce0bd924e13"}, + {file = "rapidfuzz-3.9.5-pp310-pypy310_pp73-macosx_10_15_x86_64.whl", hash = "sha256:f4e0122603af2119579e9f94e172c6e460860fdcdb713164332c1951c13df999"}, + {file = "rapidfuzz-3.9.5-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:e46cd486289d1d8e3dab779c725f5dde77b286185d32e7b874bfc3d161e3a927"}, + {file = "rapidfuzz-3.9.5-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7e2c0c8bbe4f4525009e3ad9b94a39cdff5d6378233e754d0b13c29cdfaa75fc"}, + {file = "rapidfuzz-3.9.5-pp310-pypy310_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:bfb47513a17c935f6ee606dcae0ea9d20a3fb0fe9ca597758472ea08be62dc54"}, + {file = "rapidfuzz-3.9.5-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:976ed1105a76935b6a4d2bbc7d577be1b97b43997bcec2f29a0ab48ff6f5d6b1"}, + {file = "rapidfuzz-3.9.5-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:9cf2028edb9ccd21d1d5aaacef2fe3e14bee4343df1c2c0f7373ef6e81013bef"}, + {file = "rapidfuzz-3.9.5-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:926701c8e61319ee2e4888619143f58ddcc0e3e886668269b8e053f2d68c1e92"}, + {file = "rapidfuzz-3.9.5-pp38-pypy38_pp73-macosx_11_0_arm64.whl", hash = "sha256:99eaa8dd8a44664813e0bef014775993ef75a134a863bc54cd855a60622203fd"}, + {file = "rapidfuzz-3.9.5-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7508ef727ef4891141dd3ac7a39a2327384ece070521ac9c58f06c27d57c72d5"}, + {file = "rapidfuzz-3.9.5-pp38-pypy38_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f9f33d05db5bba1d076446c51347a6d93ff24d8f9d01b0b8b15ca8ec8b1ef382"}, + {file = "rapidfuzz-3.9.5-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7252666b85c931d51a59d5308bb6827a67434917ef510747d3ce7e88ec17e7f2"}, + {file = "rapidfuzz-3.9.5-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:d26f7299e2872d18fb7df1bc043e53aa94fc5a4a2a6a9537ad8707579fcb1668"}, + {file = "rapidfuzz-3.9.5-pp39-pypy39_pp73-macosx_10_15_x86_64.whl", hash = "sha256:2b17ecc17322b659962234799e90054e420911b8ca510a7869c2f4419f9f3ecb"}, + {file = "rapidfuzz-3.9.5-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:f3e037b9ec621dec0157d81566e7d47a91405e379335cf8f4ed3c20d61db91d8"}, + {file = "rapidfuzz-3.9.5-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42c4d1ba2647c8d2a82313c4dde332de750c936b94f016308339e762c2e5e53d"}, + {file = "rapidfuzz-3.9.5-pp39-pypy39_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:876e663b11d9067e1096ea76a2de87227c7b513aff2b60667b20417da74183e4"}, + {file = "rapidfuzz-3.9.5-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:adee55488490375c1604b878fbc1eb1a51fe5e6f5bd05047df2f8c6505a48728"}, + {file = "rapidfuzz-3.9.5-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:abb1ac683671000bd4ec215a494aba687d75a198db72188408154a19ea313ff4"}, + {file = "rapidfuzz-3.9.5.tar.gz", hash = "sha256:257f2406a671371bafd99a2a2c57f991783446bc2176b93a83d1d833e35d36df"}, +] + +[package.extras] +full = ["numpy"] + [[package]] name = "readme-renderer" -version = "43.0" +version = "44.0" description = "readme_renderer is a library for rendering readme descriptions for Warehouse" optional = false -python-versions = ">=3.8" +python-versions = ">=3.9" files = [ - {file = "readme_renderer-43.0-py3-none-any.whl", hash = "sha256:19db308d86ecd60e5affa3b2a98f017af384678c63c88e5d4556a380e674f3f9"}, - {file = "readme_renderer-43.0.tar.gz", hash = "sha256:1818dd28140813509eeed8d62687f7cd4f7bad90d4db586001c5dc09d4fde311"}, + {file = "readme_renderer-44.0-py3-none-any.whl", hash = "sha256:2fbca89b81a08526aadf1357a8c2ae889ec05fb03f5da67f9769c9a592166151"}, + {file = "readme_renderer-44.0.tar.gz", hash = "sha256:8712034eabbfa6805cacf1402b4eeb2a73028f72d1166d6f5cb7f9c047c5d1e1"}, ] [package.dependencies] -docutils = ">=0.13.1" +docutils = ">=0.21.2" nh3 = ">=0.2.14" Pygments = ">=2.5.1" [package.extras] md = ["cmarkgfm (>=0.8.0)"] +[[package]] +name = "referencing" +version = "0.35.1" +description = "JSON Referencing + Python" +optional = false +python-versions = ">=3.8" +files = [ + {file = "referencing-0.35.1-py3-none-any.whl", hash = "sha256:eda6d3234d62814d1c64e305c1331c9a3a6132da475ab6382eaa997b21ee75de"}, + {file = "referencing-0.35.1.tar.gz", hash = "sha256:25b42124a6c8b632a425174f24087783efb348a6f1e0008e63cd4466fedf703c"}, +] + +[package.dependencies] +attrs = ">=22.2.0" +rpds-py = ">=0.7.0" + [[package]] name = "requests" -version = "2.31.0" +version = "2.32.3" description = "Python HTTP for Humans." optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "requests-2.31.0-py3-none-any.whl", hash = "sha256:58cd2187c01e70e6e26505bca751777aa9f2ee0b7f4300988b709f44e013003f"}, - {file = "requests-2.31.0.tar.gz", hash = "sha256:942c5a758f98d790eaed1a29cb6eefc7ffb0d1cf7af05c3d2791656dbd6ad1e1"}, + {file = "requests-2.32.3-py3-none-any.whl", hash = "sha256:70761cfe03c773ceb22aa2f671b4757976145175cdfca038c02654d061d6dcc6"}, + {file = "requests-2.32.3.tar.gz", hash = "sha256:55365417734eb18255590a9ff9eb97e9e1da868d4ccd6402399eaf68af20a760"}, ] [package.dependencies] @@ -2031,11 +2468,122 @@ files = [ [package.dependencies] markdown-it-py = ">=2.2.0" pygments = ">=2.13.0,<3.0.0" -typing-extensions = {version = ">=4.0.0,<5.0", markers = "python_version < \"3.9\""} [package.extras] jupyter = ["ipywidgets (>=7.5.1,<9)"] +[[package]] +name = "rpds-py" +version = "0.19.1" +description = "Python bindings to Rust's persistent data structures (rpds)" +optional = false +python-versions = ">=3.8" +files = [ + {file = "rpds_py-0.19.1-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:aaf71f95b21f9dc708123335df22e5a2fef6307e3e6f9ed773b2e0938cc4d491"}, + {file = "rpds_py-0.19.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ca0dda0c5715efe2ab35bb83f813f681ebcd2840d8b1b92bfc6fe3ab382fae4a"}, + {file = "rpds_py-0.19.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:81db2e7282cc0487f500d4db203edc57da81acde9e35f061d69ed983228ffe3b"}, + {file = "rpds_py-0.19.1-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:1a8dfa125b60ec00c7c9baef945bb04abf8ac772d8ebefd79dae2a5f316d7850"}, + {file = "rpds_py-0.19.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:271accf41b02687cef26367c775ab220372ee0f4925591c6796e7c148c50cab5"}, + {file = "rpds_py-0.19.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f9bc4161bd3b970cd6a6fcda70583ad4afd10f2750609fb1f3ca9505050d4ef3"}, + {file = "rpds_py-0.19.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f0cf2a0dbb5987da4bd92a7ca727eadb225581dd9681365beba9accbe5308f7d"}, + {file = "rpds_py-0.19.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:b5e28e56143750808c1c79c70a16519e9bc0a68b623197b96292b21b62d6055c"}, + {file = "rpds_py-0.19.1-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:c7af6f7b80f687b33a4cdb0a785a5d4de1fb027a44c9a049d8eb67d5bfe8a687"}, + {file = "rpds_py-0.19.1-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:e429fc517a1c5e2a70d576077231538a98d59a45dfc552d1ac45a132844e6dfb"}, + {file = "rpds_py-0.19.1-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:d2dbd8f4990d4788cb122f63bf000357533f34860d269c1a8e90ae362090ff3a"}, + {file = "rpds_py-0.19.1-cp310-none-win32.whl", hash = "sha256:e0f9d268b19e8f61bf42a1da48276bcd05f7ab5560311f541d22557f8227b866"}, + {file = "rpds_py-0.19.1-cp310-none-win_amd64.whl", hash = "sha256:df7c841813f6265e636fe548a49664c77af31ddfa0085515326342a751a6ba51"}, + {file = "rpds_py-0.19.1-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:902cf4739458852fe917104365ec0efbea7d29a15e4276c96a8d33e6ed8ec137"}, + {file = "rpds_py-0.19.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f3d73022990ab0c8b172cce57c69fd9a89c24fd473a5e79cbce92df87e3d9c48"}, + {file = "rpds_py-0.19.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3837c63dd6918a24de6c526277910e3766d8c2b1627c500b155f3eecad8fad65"}, + {file = "rpds_py-0.19.1-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:cdb7eb3cf3deb3dd9e7b8749323b5d970052711f9e1e9f36364163627f96da58"}, + {file = "rpds_py-0.19.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:26ab43b6d65d25b1a333c8d1b1c2f8399385ff683a35ab5e274ba7b8bb7dc61c"}, + {file = "rpds_py-0.19.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:75130df05aae7a7ac171b3b5b24714cffeabd054ad2ebc18870b3aa4526eba23"}, + {file = "rpds_py-0.19.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c34f751bf67cab69638564eee34023909380ba3e0d8ee7f6fe473079bf93f09b"}, + {file = "rpds_py-0.19.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:f2671cb47e50a97f419a02cd1e0c339b31de017b033186358db92f4d8e2e17d8"}, + {file = "rpds_py-0.19.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:3c73254c256081704dba0a333457e2fb815364018788f9b501efe7c5e0ada401"}, + {file = "rpds_py-0.19.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:4383beb4a29935b8fa28aca8fa84c956bf545cb0c46307b091b8d312a9150e6a"}, + {file = "rpds_py-0.19.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:dbceedcf4a9329cc665452db1aaf0845b85c666e4885b92ee0cddb1dbf7e052a"}, + {file = "rpds_py-0.19.1-cp311-none-win32.whl", hash = "sha256:f0a6d4a93d2a05daec7cb885157c97bbb0be4da739d6f9dfb02e101eb40921cd"}, + {file = "rpds_py-0.19.1-cp311-none-win_amd64.whl", hash = "sha256:c149a652aeac4902ecff2dd93c3b2681c608bd5208c793c4a99404b3e1afc87c"}, + {file = "rpds_py-0.19.1-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:56313be667a837ff1ea3508cebb1ef6681d418fa2913a0635386cf29cff35165"}, + {file = "rpds_py-0.19.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:6d1d7539043b2b31307f2c6c72957a97c839a88b2629a348ebabe5aa8b626d6b"}, + {file = "rpds_py-0.19.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3e1dc59a5e7bc7f44bd0c048681f5e05356e479c50be4f2c1a7089103f1621d5"}, + {file = "rpds_py-0.19.1-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:b8f78398e67a7227aefa95f876481485403eb974b29e9dc38b307bb6eb2315ea"}, + {file = "rpds_py-0.19.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ef07a0a1d254eeb16455d839cef6e8c2ed127f47f014bbda64a58b5482b6c836"}, + {file = "rpds_py-0.19.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8124101e92c56827bebef084ff106e8ea11c743256149a95b9fd860d3a4f331f"}, + {file = "rpds_py-0.19.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:08ce9c95a0b093b7aec75676b356a27879901488abc27e9d029273d280438505"}, + {file = "rpds_py-0.19.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:0b02dd77a2de6e49078c8937aadabe933ceac04b41c5dde5eca13a69f3cf144e"}, + {file = "rpds_py-0.19.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:4dd02e29c8cbed21a1875330b07246b71121a1c08e29f0ee3db5b4cfe16980c4"}, + {file = "rpds_py-0.19.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:9c7042488165f7251dc7894cd533a875d2875af6d3b0e09eda9c4b334627ad1c"}, + {file = "rpds_py-0.19.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:f809a17cc78bd331e137caa25262b507225854073fd319e987bd216bed911b7c"}, + {file = "rpds_py-0.19.1-cp312-none-win32.whl", hash = "sha256:3ddab996807c6b4227967fe1587febade4e48ac47bb0e2d3e7858bc621b1cace"}, + {file = "rpds_py-0.19.1-cp312-none-win_amd64.whl", hash = "sha256:32e0db3d6e4f45601b58e4ac75c6f24afbf99818c647cc2066f3e4b192dabb1f"}, + {file = "rpds_py-0.19.1-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:747251e428406b05fc86fee3904ee19550c4d2d19258cef274e2151f31ae9d38"}, + {file = "rpds_py-0.19.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:dc733d35f861f8d78abfaf54035461e10423422999b360966bf1c443cbc42705"}, + {file = "rpds_py-0.19.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bbda75f245caecff8faa7e32ee94dfaa8312a3367397975527f29654cd17a6ed"}, + {file = "rpds_py-0.19.1-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:bd04d8cab16cab5b0a9ffc7d10f0779cf1120ab16c3925404428f74a0a43205a"}, + {file = "rpds_py-0.19.1-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e2d66eb41ffca6cc3c91d8387509d27ba73ad28371ef90255c50cb51f8953301"}, + {file = "rpds_py-0.19.1-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:fdf4890cda3b59170009d012fca3294c00140e7f2abe1910e6a730809d0f3f9b"}, + {file = "rpds_py-0.19.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d1fa67ef839bad3815124f5f57e48cd50ff392f4911a9f3cf449d66fa3df62a5"}, + {file = "rpds_py-0.19.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:b82c9514c6d74b89a370c4060bdb80d2299bc6857e462e4a215b4ef7aa7b090e"}, + {file = "rpds_py-0.19.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:c7b07959866a6afb019abb9564d8a55046feb7a84506c74a6f197cbcdf8a208e"}, + {file = "rpds_py-0.19.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:4f580ae79d0b861dfd912494ab9d477bea535bfb4756a2269130b6607a21802e"}, + {file = "rpds_py-0.19.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:c6d20c8896c00775e6f62d8373aba32956aa0b850d02b5ec493f486c88e12859"}, + {file = "rpds_py-0.19.1-cp313-none-win32.whl", hash = "sha256:afedc35fe4b9e30ab240b208bb9dc8938cb4afe9187589e8d8d085e1aacb8309"}, + {file = "rpds_py-0.19.1-cp313-none-win_amd64.whl", hash = "sha256:1d4af2eb520d759f48f1073ad3caef997d1bfd910dc34e41261a595d3f038a94"}, + {file = "rpds_py-0.19.1-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:34bca66e2e3eabc8a19e9afe0d3e77789733c702c7c43cd008e953d5d1463fde"}, + {file = "rpds_py-0.19.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:24f8ae92c7fae7c28d0fae9b52829235df83f34847aa8160a47eb229d9666c7b"}, + {file = "rpds_py-0.19.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:71157f9db7f6bc6599a852852f3389343bea34315b4e6f109e5cbc97c1fb2963"}, + {file = "rpds_py-0.19.1-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:1d494887d40dc4dd0d5a71e9d07324e5c09c4383d93942d391727e7a40ff810b"}, + {file = "rpds_py-0.19.1-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:7b3661e6d4ba63a094138032c1356d557de5b3ea6fd3cca62a195f623e381c76"}, + {file = "rpds_py-0.19.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:97fbb77eaeb97591efdc654b8b5f3ccc066406ccfb3175b41382f221ecc216e8"}, + {file = "rpds_py-0.19.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4cc4bc73e53af8e7a42c8fd7923bbe35babacfa7394ae9240b3430b5dcf16b2a"}, + {file = "rpds_py-0.19.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:35af5e4d5448fa179fd7fff0bba0fba51f876cd55212f96c8bbcecc5c684ae5c"}, + {file = "rpds_py-0.19.1-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:3511f6baf8438326e351097cecd137eb45c5f019944fe0fd0ae2fea2fd26be39"}, + {file = "rpds_py-0.19.1-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:57863d16187995c10fe9cf911b897ed443ac68189179541734502353af33e693"}, + {file = "rpds_py-0.19.1-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:9e318e6786b1e750a62f90c6f7fa8b542102bdcf97c7c4de2a48b50b61bd36ec"}, + {file = "rpds_py-0.19.1-cp38-none-win32.whl", hash = "sha256:53dbc35808c6faa2ce3e48571f8f74ef70802218554884787b86a30947842a14"}, + {file = "rpds_py-0.19.1-cp38-none-win_amd64.whl", hash = "sha256:8df1c283e57c9cb4d271fdc1875f4a58a143a2d1698eb0d6b7c0d7d5f49c53a1"}, + {file = "rpds_py-0.19.1-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:e76c902d229a3aa9d5ceb813e1cbcc69bf5bda44c80d574ff1ac1fa3136dea71"}, + {file = "rpds_py-0.19.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:de1f7cd5b6b351e1afd7568bdab94934d656abe273d66cda0ceea43bbc02a0c2"}, + {file = "rpds_py-0.19.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:24fc5a84777cb61692d17988989690d6f34f7f95968ac81398d67c0d0994a897"}, + {file = "rpds_py-0.19.1-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:74129d5ffc4cde992d89d345f7f7d6758320e5d44a369d74d83493429dad2de5"}, + {file = "rpds_py-0.19.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5e360188b72f8080fefa3adfdcf3618604cc8173651c9754f189fece068d2a45"}, + {file = "rpds_py-0.19.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:13e6d4840897d4e4e6b2aa1443e3a8eca92b0402182aafc5f4ca1f5e24f9270a"}, + {file = "rpds_py-0.19.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f09529d2332264a902688031a83c19de8fda5eb5881e44233286b9c9ec91856d"}, + {file = "rpds_py-0.19.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:0d4b52811dcbc1aba08fd88d475f75b4f6db0984ba12275d9bed1a04b2cae9b5"}, + {file = "rpds_py-0.19.1-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:dd635c2c4043222d80d80ca1ac4530a633102a9f2ad12252183bcf338c1b9474"}, + {file = "rpds_py-0.19.1-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:f35b34a5184d5e0cc360b61664c1c06e866aab077b5a7c538a3e20c8fcdbf90b"}, + {file = "rpds_py-0.19.1-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:d4ec0046facab83012d821b33cead742a35b54575c4edfb7ed7445f63441835f"}, + {file = "rpds_py-0.19.1-cp39-none-win32.whl", hash = "sha256:f5b8353ea1a4d7dfb59a7f45c04df66ecfd363bb5b35f33b11ea579111d4655f"}, + {file = "rpds_py-0.19.1-cp39-none-win_amd64.whl", hash = "sha256:1fb93d3486f793d54a094e2bfd9cd97031f63fcb5bc18faeb3dd4b49a1c06523"}, + {file = "rpds_py-0.19.1-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:7d5c7e32f3ee42f77d8ff1a10384b5cdcc2d37035e2e3320ded909aa192d32c3"}, + {file = "rpds_py-0.19.1-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:89cc8921a4a5028d6dd388c399fcd2eef232e7040345af3d5b16c04b91cf3c7e"}, + {file = "rpds_py-0.19.1-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bca34e913d27401bda2a6f390d0614049f5a95b3b11cd8eff80fe4ec340a1208"}, + {file = "rpds_py-0.19.1-pp310-pypy310_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5953391af1405f968eb5701ebbb577ebc5ced8d0041406f9052638bafe52209d"}, + {file = "rpds_py-0.19.1-pp310-pypy310_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:840e18c38098221ea6201f091fc5d4de6128961d2930fbbc96806fb43f69aec1"}, + {file = "rpds_py-0.19.1-pp310-pypy310_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:6d8b735c4d162dc7d86a9cf3d717f14b6c73637a1f9cd57fe7e61002d9cb1972"}, + {file = "rpds_py-0.19.1-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ce757c7c90d35719b38fa3d4ca55654a76a40716ee299b0865f2de21c146801c"}, + {file = "rpds_py-0.19.1-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:a9421b23c85f361a133aa7c5e8ec757668f70343f4ed8fdb5a4a14abd5437244"}, + {file = "rpds_py-0.19.1-pp310-pypy310_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:3b823be829407393d84ee56dc849dbe3b31b6a326f388e171555b262e8456cc1"}, + {file = "rpds_py-0.19.1-pp310-pypy310_pp73-musllinux_1_2_i686.whl", hash = "sha256:5e58b61dcbb483a442c6239c3836696b79f2cd8e7eec11e12155d3f6f2d886d1"}, + {file = "rpds_py-0.19.1-pp310-pypy310_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:39d67896f7235b2c886fb1ee77b1491b77049dcef6fbf0f401e7b4cbed86bbd4"}, + {file = "rpds_py-0.19.1-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:8b32cd4ab6db50c875001ba4f5a6b30c0f42151aa1fbf9c2e7e3674893fb1dc4"}, + {file = "rpds_py-0.19.1-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:1c32e41de995f39b6b315d66c27dea3ef7f7c937c06caab4c6a79a5e09e2c415"}, + {file = "rpds_py-0.19.1-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:1a129c02b42d46758c87faeea21a9f574e1c858b9f358b6dd0bbd71d17713175"}, + {file = "rpds_py-0.19.1-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:346557f5b1d8fd9966059b7a748fd79ac59f5752cd0e9498d6a40e3ac1c1875f"}, + {file = "rpds_py-0.19.1-pp39-pypy39_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:31e450840f2f27699d014cfc8865cc747184286b26d945bcea6042bb6aa4d26e"}, + {file = "rpds_py-0.19.1-pp39-pypy39_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:01227f8b3e6c8961490d869aa65c99653df80d2f0a7fde8c64ebddab2b9b02fd"}, + {file = "rpds_py-0.19.1-pp39-pypy39_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:69084fd29bfeff14816666c93a466e85414fe6b7d236cfc108a9c11afa6f7301"}, + {file = "rpds_py-0.19.1-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e4d2b88efe65544a7d5121b0c3b003ebba92bfede2ea3577ce548b69c5235185"}, + {file = "rpds_py-0.19.1-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:6ea961a674172ed2235d990d7edf85d15d8dfa23ab8575e48306371c070cda67"}, + {file = "rpds_py-0.19.1-pp39-pypy39_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:5beffdbe766cfe4fb04f30644d822a1080b5359df7db3a63d30fa928375b2720"}, + {file = "rpds_py-0.19.1-pp39-pypy39_pp73-musllinux_1_2_i686.whl", hash = "sha256:720f3108fb1bfa32e51db58b832898372eb5891e8472a8093008010911e324c5"}, + {file = "rpds_py-0.19.1-pp39-pypy39_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:c2087dbb76a87ec2c619253e021e4fb20d1a72580feeaa6892b0b3d955175a71"}, + {file = "rpds_py-0.19.1-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:2ddd50f18ebc05ec29a0d9271e9dbe93997536da3546677f8ca00b76d477680c"}, + {file = "rpds_py-0.19.1.tar.gz", hash = "sha256:31dd5794837f00b46f4096aa8ccaa5972f73a938982e32ed817bb520c465e520"}, +] + [[package]] name = "secretstorage" version = "3.3.3" @@ -2064,19 +2612,19 @@ files = [ [[package]] name = "setuptools" -version = "69.1.1" +version = "72.1.0" description = "Easily download, build, install, upgrade, and uninstall Python packages" optional = false python-versions = ">=3.8" files = [ - {file = "setuptools-69.1.1-py3-none-any.whl", hash = "sha256:02fa291a0471b3a18b2b2481ed902af520c69e8ae0919c13da936542754b4c56"}, - {file = "setuptools-69.1.1.tar.gz", hash = "sha256:5c0806c7d9af348e6dd3777b4f4dbb42c7ad85b190104837488eab9a7c945cf8"}, + {file = "setuptools-72.1.0-py3-none-any.whl", hash = "sha256:5a03e1860cf56bb6ef48ce186b0e557fdba433237481a9a625176c2831be15d1"}, + {file = "setuptools-72.1.0.tar.gz", hash = "sha256:8d243eff56d095e5817f796ede6ae32941278f542e0f941867cc05ae52b162ec"}, ] [package.extras] -docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "pygments-github-lexers (==0.0.5)", "rst.linker (>=1.9)", "sphinx (<7.2.5)", "sphinx (>=3.5)", "sphinx-favicon", "sphinx-inline-tabs", "sphinx-lint", "sphinx-notfound-page (>=1,<2)", "sphinx-reredirects", "sphinxcontrib-towncrier"] -testing = ["build[virtualenv]", "filelock (>=3.4.0)", "flake8-2020", "ini2toml[lite] (>=0.9)", "jaraco.develop (>=7.21)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "packaging (>=23.2)", "pip (>=19.1)", "pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-home (>=0.5)", "pytest-mypy (>=0.9.1)", "pytest-perf", "pytest-ruff (>=0.2.1)", "pytest-timeout", "pytest-xdist", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel"] -testing-integration = ["build[virtualenv] (>=1.0.3)", "filelock (>=3.4.0)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "packaging (>=23.2)", "pytest", "pytest-enabler", "pytest-xdist", "tomli", "virtualenv (>=13.0.0)", "wheel"] +core = ["importlib-metadata (>=6)", "importlib-resources (>=5.10.2)", "jaraco.text (>=3.7)", "more-itertools (>=8.8)", "ordered-set (>=3.1.1)", "packaging (>=24)", "platformdirs (>=2.6.2)", "tomli (>=2.0.1)", "wheel (>=0.43.0)"] +doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "pygments-github-lexers (==0.0.5)", "pyproject-hooks (!=1.1)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-favicon", "sphinx-inline-tabs", "sphinx-lint", "sphinx-notfound-page (>=1,<2)", "sphinx-reredirects", "sphinxcontrib-towncrier"] +test = ["build[virtualenv] (>=1.0.3)", "filelock (>=3.4.0)", "importlib-metadata", "ini2toml[lite] (>=0.14)", "jaraco.develop (>=7.21)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "jaraco.test", "mypy (==1.11.*)", "packaging (>=23.2)", "pip (>=19.1)", "pyproject-hooks (!=1.1)", "pytest (>=6,!=8.1.*)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-home (>=0.5)", "pytest-mypy", "pytest-perf", "pytest-ruff (<0.4)", "pytest-ruff (>=0.2.1)", "pytest-ruff (>=0.3.2)", "pytest-subprocess", "pytest-timeout", "pytest-xdist (>=3)", "tomli", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel"] [[package]] name = "shellingham" @@ -2143,13 +2691,13 @@ tests = ["cython", "littleutils", "pygments", "pytest", "typeguard"] [[package]] name = "starlette" -version = "0.36.3" +version = "0.37.2" description = "The little ASGI library that shines." optional = true python-versions = ">=3.8" files = [ - {file = "starlette-0.36.3-py3-none-any.whl", hash = "sha256:13d429aa93a61dc40bf503e8c801db1f1bca3dc706b10ef2434a36123568f044"}, - {file = "starlette-0.36.3.tar.gz", hash = "sha256:90a671733cfb35771d8cc605e0b679d23b992f8dcfad48cc60b38cb29aeb7080"}, + {file = "starlette-0.37.2-py3-none-any.whl", hash = "sha256:6fe59f29268538e5d0d182f2791a479a0c64638e6935d1c6989e63fb2699c6ee"}, + {file = "starlette-0.37.2.tar.gz", hash = "sha256:9af890290133b79fc3db55474ade20f6220a364a0402e0b556e7cd5e1e093823"}, ] [package.dependencies] @@ -2175,13 +2723,24 @@ widechars = ["wcwidth"] [[package]] name = "tokenize-rt" -version = "5.2.0" +version = "6.0.0" description = "A wrapper around the stdlib `tokenize` which roundtrips." optional = false python-versions = ">=3.8" files = [ - {file = "tokenize_rt-5.2.0-py2.py3-none-any.whl", hash = "sha256:b79d41a65cfec71285433511b50271b05da3584a1da144a0752e9c621a285289"}, - {file = "tokenize_rt-5.2.0.tar.gz", hash = "sha256:9fe80f8a5c1edad2d3ede0f37481cc0cc1538a2f442c9c2f9e4feacd2792d054"}, + {file = "tokenize_rt-6.0.0-py2.py3-none-any.whl", hash = "sha256:d4ff7ded2873512938b4f8cbb98c9b07118f01d30ac585a30d7a88353ca36d22"}, + {file = "tokenize_rt-6.0.0.tar.gz", hash = "sha256:b9711bdfc51210211137499b5e355d3de5ec88a85d2025c520cbb921b5194367"}, +] + +[[package]] +name = "toml" +version = "0.10.2" +description = "Python Library for Tom's Obvious, Minimal Language" +optional = false +python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" +files = [ + {file = "toml-0.10.2-py2.py3-none-any.whl", hash = "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b"}, + {file = "toml-0.10.2.tar.gz", hash = "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f"}, ] [[package]] @@ -2197,24 +2756,24 @@ files = [ [[package]] name = "tomlkit" -version = "0.12.4" +version = "0.13.0" description = "Style preserving TOML library" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "tomlkit-0.12.4-py3-none-any.whl", hash = "sha256:5cd82d48a3dd89dee1f9d64420aa20ae65cfbd00668d6f094d7578a78efbb77b"}, - {file = "tomlkit-0.12.4.tar.gz", hash = "sha256:7ca1cfc12232806517a8515047ba66a19369e71edf2439d0f5824f91032b6cc3"}, + {file = "tomlkit-0.13.0-py3-none-any.whl", hash = "sha256:7075d3042d03b80f603482d69bf0c8f345c2b30e41699fd8883227f89972b264"}, + {file = "tomlkit-0.13.0.tar.gz", hash = "sha256:08ad192699734149f5b97b45f1f18dad7eb1b6d16bc72ad0c2335772650d7b72"}, ] [[package]] name = "tqdm" -version = "4.66.2" +version = "4.66.5" description = "Fast, Extensible Progress Meter" optional = false python-versions = ">=3.7" files = [ - {file = "tqdm-4.66.2-py3-none-any.whl", hash = "sha256:1ee4f8a893eb9bef51c6e35730cebf234d5d0b6bd112b0271e10ed7c24a02bd9"}, - {file = "tqdm-4.66.2.tar.gz", hash = "sha256:6cd52cdf0fef0e0f543299cfc96fec90d7b8a7e88745f411ec33eb44d5ed3531"}, + {file = "tqdm-4.66.5-py3-none-any.whl", hash = "sha256:90279a3770753eafc9194a0364852159802111925aa30eb3f9d85b0e805ac7cd"}, + {file = "tqdm-4.66.5.tar.gz", hash = "sha256:e1020aef2e5096702d8a025ac7d16b1577279c9d63f8375b63083e9a5f0fcbad"}, ] [package.dependencies] @@ -2228,18 +2787,29 @@ telegram = ["requests"] [[package]] name = "traitlets" -version = "5.14.1" +version = "5.14.3" description = "Traitlets Python configuration system" optional = false python-versions = ">=3.8" files = [ - {file = "traitlets-5.14.1-py3-none-any.whl", hash = "sha256:2e5a030e6eff91737c643231bfcf04a65b0132078dad75e4936700b213652e74"}, - {file = "traitlets-5.14.1.tar.gz", hash = "sha256:8585105b371a04b8316a43d5ce29c098575c2e477850b62b848b964f1444527e"}, + {file = "traitlets-5.14.3-py3-none-any.whl", hash = "sha256:b74e89e397b1ed28cc831db7aea759ba6640cb3de13090ca145426688ff1ac4f"}, + {file = "traitlets-5.14.3.tar.gz", hash = "sha256:9ed0579d3502c94b4b3732ac120375cda96f923114522847de4b3bb98b96b6b7"}, ] [package.extras] docs = ["myst-parser", "pydata-sphinx-theme", "sphinx"] -test = ["argcomplete (>=3.0.3)", "mypy (>=1.7.0)", "pre-commit", "pytest (>=7.0,<7.5)", "pytest-mock", "pytest-mypy-testing"] +test = ["argcomplete (>=3.0.3)", "mypy (>=1.7.0)", "pre-commit", "pytest (>=7.0,<8.2)", "pytest-mock", "pytest-mypy-testing"] + +[[package]] +name = "trove-classifiers" +version = "2024.7.2" +description = "Canonical source for classifiers on PyPI (pypi.org)." +optional = false +python-versions = "*" +files = [ + {file = "trove_classifiers-2024.7.2-py3-none-any.whl", hash = "sha256:ccc57a33717644df4daca018e7ec3ef57a835c48e96a1e71fc07eb7edac67af6"}, + {file = "trove_classifiers-2024.7.2.tar.gz", hash = "sha256:8328f2ac2ce3fd773cbb37c765a0ed7a83f89dc564c7d452f039b69249d0ac35"}, +] [[package]] name = "twine" @@ -2266,28 +2836,21 @@ urllib3 = ">=1.26.0" [[package]] name = "typer" -version = "0.9.0" +version = "0.12.3" description = "Typer, build great CLIs. Easy to code. Based on Python type hints." optional = false -python-versions = ">=3.6" +python-versions = ">=3.7" files = [ - {file = "typer-0.9.0-py3-none-any.whl", hash = "sha256:5d96d986a21493606a358cae4461bd8cdf83cbf33a5aa950ae629ca3b51467ee"}, - {file = "typer-0.9.0.tar.gz", hash = "sha256:50922fd79aea2f4751a8e0408ff10d2662bd0c8bbfa84755a699f3bada2978b2"}, + {file = "typer-0.12.3-py3-none-any.whl", hash = "sha256:070d7ca53f785acbccba8e7d28b08dcd88f79f1fbda035ade0aecec71ca5c914"}, + {file = "typer-0.12.3.tar.gz", hash = "sha256:49e73131481d804288ef62598d97a1ceef3058905aa536a1134f90891ba35482"}, ] [package.dependencies] -click = ">=7.1.1,<9.0.0" -colorama = {version = ">=0.4.3,<0.5.0", optional = true, markers = "extra == \"all\""} -rich = {version = ">=10.11.0,<14.0.0", optional = true, markers = "extra == \"all\""} -shellingham = {version = ">=1.3.0,<2.0.0", optional = true, markers = "extra == \"all\""} +click = ">=8.0.0" +rich = ">=10.11.0" +shellingham = ">=1.3.0" typing-extensions = ">=3.7.4.3" -[package.extras] -all = ["colorama (>=0.4.3,<0.5.0)", "rich (>=10.11.0,<14.0.0)", "shellingham (>=1.3.0,<2.0.0)"] -dev = ["autoflake (>=1.3.1,<2.0.0)", "flake8 (>=3.8.3,<4.0.0)", "pre-commit (>=2.17.0,<3.0.0)"] -doc = ["cairosvg (>=2.5.2,<3.0.0)", "mdx-include (>=1.4.1,<2.0.0)", "mkdocs (>=1.1.2,<2.0.0)", "mkdocs-material (>=8.1.4,<9.0.0)", "pillow (>=9.3.0,<10.0.0)"] -test = ["black (>=22.3.0,<23.0.0)", "coverage (>=6.2,<7.0)", "isort (>=5.0.6,<6.0.0)", "mypy (==0.910)", "pytest (>=4.4.0,<8.0.0)", "pytest-cov (>=2.10.0,<5.0.0)", "pytest-sugar (>=0.9.4,<0.10.0)", "pytest-xdist (>=1.32.0,<4.0.0)", "rich (>=10.11.0,<14.0.0)", "shellingham (>=1.3.0,<2.0.0)"] - [[package]] name = "types-requests" version = "2.31.0.6" @@ -2315,13 +2878,13 @@ files = [ [[package]] name = "types-tqdm" -version = "4.66.0.20240106" +version = "4.66.0.20240417" description = "Typing stubs for tqdm" optional = false python-versions = ">=3.8" files = [ - {file = "types-tqdm-4.66.0.20240106.tar.gz", hash = "sha256:7acf4aade5bad3ded76eb829783f9961b1c2187948eaa6dd1ae8644dff95a938"}, - {file = "types_tqdm-4.66.0.20240106-py3-none-any.whl", hash = "sha256:7459b0f441b969735685645a5d8480f7912b10d05ab45f99a2db8a8e45cb550b"}, + {file = "types-tqdm-4.66.0.20240417.tar.gz", hash = "sha256:16dce9ef522ea8d40e4f5b8d84dd8a1166eefc13ceee7a7e158bf0f1a1421a31"}, + {file = "types_tqdm-4.66.0.20240417-py3-none-any.whl", hash = "sha256:248aef1f9986b7b8c2c12b3cb4399fc17dba0a29e7e3f3f9cd704babb879383d"}, ] [[package]] @@ -2337,24 +2900,39 @@ files = [ [[package]] name = "typing-extensions" -version = "4.10.0" +version = "4.12.2" description = "Backported and Experimental Type Hints for Python 3.8+" optional = false python-versions = ">=3.8" files = [ - {file = "typing_extensions-4.10.0-py3-none-any.whl", hash = "sha256:69b1a937c3a517342112fb4c6df7e72fc39a38e7891a5730ed4985b5214b5475"}, - {file = "typing_extensions-4.10.0.tar.gz", hash = "sha256:b0abd7c89e8fb96f98db18d86106ff1d90ab692004eb746cf6eda2682f91b3cb"}, + {file = "typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d"}, + {file = "typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8"}, ] +[[package]] +name = "typing-inspect" +version = "0.9.0" +description = "Runtime inspection utilities for typing module." +optional = false +python-versions = "*" +files = [ + {file = "typing_inspect-0.9.0-py3-none-any.whl", hash = "sha256:9ee6fc59062311ef8547596ab6b955e1b8aa46242d854bfc78f4f6b0eff35f9f"}, + {file = "typing_inspect-0.9.0.tar.gz", hash = "sha256:b23fc42ff6f6ef6954e4852c1fb512cdd18dbea03134f91f856a95ccc9461f78"}, +] + +[package.dependencies] +mypy-extensions = ">=0.3.0" +typing-extensions = ">=3.7.4" + [[package]] name = "urllib3" -version = "1.26.18" +version = "1.26.19" description = "HTTP library with thread-safe connection pooling, file post, and more." optional = false -python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*" +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,>=2.7" files = [ - {file = "urllib3-1.26.18-py2.py3-none-any.whl", hash = "sha256:34b97092d7e0a3a8cf7cd10e386f401b3737364026c45e622aa02903dffe0f07"}, - {file = "urllib3-1.26.18.tar.gz", hash = "sha256:f8ecc1bba5667413457c529ab955bf8c67b45db799d159066261719e328580a0"}, + {file = "urllib3-1.26.19-py2.py3-none-any.whl", hash = "sha256:37a0344459b199fce0e80b0d3569837ec6b6937435c5244e7fd73fa6006830f3"}, + {file = "urllib3-1.26.19.tar.gz", hash = "sha256:3e3d753a8618b86d7de333b4223005f68720bcd6a7d2bcb9fbd2229ec7c1e429"}, ] [package.extras] @@ -2364,13 +2942,13 @@ socks = ["PySocks (>=1.5.6,!=1.5.7,<2.0)"] [[package]] name = "uvicorn" -version = "0.27.1" +version = "0.30.5" description = "The lightning-fast ASGI server." optional = true python-versions = ">=3.8" files = [ - {file = "uvicorn-0.27.1-py3-none-any.whl", hash = "sha256:5c89da2f3895767472a35556e539fd59f7edbe9b1e9c0e1c99eebeadc61838e4"}, - {file = "uvicorn-0.27.1.tar.gz", hash = "sha256:3d9a267296243532db80c83a959a3400502165ade2c1338dea4e67915fd4745a"}, + {file = "uvicorn-0.30.5-py3-none-any.whl", hash = "sha256:b2d86de274726e9878188fa07576c9ceeff90a839e2b6e25c917fe05f5a6c835"}, + {file = "uvicorn-0.30.5.tar.gz", hash = "sha256:ac6fdbd4425c5fd17a9fe39daf4d4d075da6fdc80f653e5894cdc2fd98752bee"}, ] [package.dependencies] @@ -2383,13 +2961,13 @@ standard = ["colorama (>=0.4)", "httptools (>=0.5.0)", "python-dotenv (>=0.13)", [[package]] name = "virtualenv" -version = "20.25.1" +version = "20.26.3" description = "Virtual Python Environment builder" optional = false python-versions = ">=3.7" files = [ - {file = "virtualenv-20.25.1-py3-none-any.whl", hash = "sha256:961c026ac520bac5f69acb8ea063e8a4f071bcc9457b9c1f28f6b085c511583a"}, - {file = "virtualenv-20.25.1.tar.gz", hash = "sha256:e08e13ecdca7a0bd53798f356d5831434afa5b07b93f0abdf0797b7a06ffe197"}, + {file = "virtualenv-20.26.3-py3-none-any.whl", hash = "sha256:8cc4a31139e796e9a7de2cd5cf2489de1217193116a8fd42328f1bd65f434589"}, + {file = "virtualenv-20.26.3.tar.gz", hash = "sha256:4c43a2a236279d9ea36a0d76f98d84bd6ca94ac4e0f4a3b9d46d05e10fea542a"}, ] [package.dependencies] @@ -2398,45 +2976,48 @@ filelock = ">=3.12.2,<4" platformdirs = ">=3.9.1,<5" [package.extras] -docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.2)", "sphinx-argparse (>=0.4)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"] +docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.2,!=7.3)", "sphinx-argparse (>=0.4)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"] test = ["covdefaults (>=2.3)", "coverage (>=7.2.7)", "coverage-enable-subprocess (>=1)", "flaky (>=3.7)", "packaging (>=23.1)", "pytest (>=7.4)", "pytest-env (>=0.8.2)", "pytest-freezer (>=0.4.8)", "pytest-mock (>=3.11.1)", "pytest-randomly (>=3.12)", "pytest-timeout (>=2.1)", "setuptools (>=68)", "time-machine (>=2.10)"] [[package]] name = "watchdog" -version = "4.0.0" +version = "4.0.1" description = "Filesystem events monitoring" optional = false python-versions = ">=3.8" files = [ - {file = "watchdog-4.0.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:39cb34b1f1afbf23e9562501673e7146777efe95da24fab5707b88f7fb11649b"}, - {file = "watchdog-4.0.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:c522392acc5e962bcac3b22b9592493ffd06d1fc5d755954e6be9f4990de932b"}, - {file = "watchdog-4.0.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:6c47bdd680009b11c9ac382163e05ca43baf4127954c5f6d0250e7d772d2b80c"}, - {file = "watchdog-4.0.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:8350d4055505412a426b6ad8c521bc7d367d1637a762c70fdd93a3a0d595990b"}, - {file = "watchdog-4.0.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:c17d98799f32e3f55f181f19dd2021d762eb38fdd381b4a748b9f5a36738e935"}, - {file = "watchdog-4.0.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:4986db5e8880b0e6b7cd52ba36255d4793bf5cdc95bd6264806c233173b1ec0b"}, - {file = "watchdog-4.0.0-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:11e12fafb13372e18ca1bbf12d50f593e7280646687463dd47730fd4f4d5d257"}, - {file = "watchdog-4.0.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:5369136a6474678e02426bd984466343924d1df8e2fd94a9b443cb7e3aa20d19"}, - {file = "watchdog-4.0.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:76ad8484379695f3fe46228962017a7e1337e9acadafed67eb20aabb175df98b"}, - {file = "watchdog-4.0.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:45cc09cc4c3b43fb10b59ef4d07318d9a3ecdbff03abd2e36e77b6dd9f9a5c85"}, - {file = "watchdog-4.0.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:eed82cdf79cd7f0232e2fdc1ad05b06a5e102a43e331f7d041e5f0e0a34a51c4"}, - {file = "watchdog-4.0.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:ba30a896166f0fee83183cec913298151b73164160d965af2e93a20bbd2ab605"}, - {file = "watchdog-4.0.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:d18d7f18a47de6863cd480734613502904611730f8def45fc52a5d97503e5101"}, - {file = "watchdog-4.0.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:2895bf0518361a9728773083908801a376743bcc37dfa252b801af8fd281b1ca"}, - {file = "watchdog-4.0.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:87e9df830022488e235dd601478c15ad73a0389628588ba0b028cb74eb72fed8"}, - {file = "watchdog-4.0.0-pp310-pypy310_pp73-macosx_10_9_x86_64.whl", hash = "sha256:6e949a8a94186bced05b6508faa61b7adacc911115664ccb1923b9ad1f1ccf7b"}, - {file = "watchdog-4.0.0-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:6a4db54edea37d1058b08947c789a2354ee02972ed5d1e0dca9b0b820f4c7f92"}, - {file = "watchdog-4.0.0-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:d31481ccf4694a8416b681544c23bd271f5a123162ab603c7d7d2dd7dd901a07"}, - {file = "watchdog-4.0.0-py3-none-manylinux2014_aarch64.whl", hash = "sha256:8fec441f5adcf81dd240a5fe78e3d83767999771630b5ddfc5867827a34fa3d3"}, - {file = "watchdog-4.0.0-py3-none-manylinux2014_armv7l.whl", hash = "sha256:6a9c71a0b02985b4b0b6d14b875a6c86ddea2fdbebd0c9a720a806a8bbffc69f"}, - {file = "watchdog-4.0.0-py3-none-manylinux2014_i686.whl", hash = "sha256:557ba04c816d23ce98a06e70af6abaa0485f6d94994ec78a42b05d1c03dcbd50"}, - {file = "watchdog-4.0.0-py3-none-manylinux2014_ppc64.whl", hash = "sha256:d0f9bd1fd919134d459d8abf954f63886745f4660ef66480b9d753a7c9d40927"}, - {file = "watchdog-4.0.0-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:f9b2fdca47dc855516b2d66eef3c39f2672cbf7e7a42e7e67ad2cbfcd6ba107d"}, - {file = "watchdog-4.0.0-py3-none-manylinux2014_s390x.whl", hash = "sha256:73c7a935e62033bd5e8f0da33a4dcb763da2361921a69a5a95aaf6c93aa03a87"}, - {file = "watchdog-4.0.0-py3-none-manylinux2014_x86_64.whl", hash = "sha256:6a80d5cae8c265842c7419c560b9961561556c4361b297b4c431903f8c33b269"}, - {file = "watchdog-4.0.0-py3-none-win32.whl", hash = "sha256:8f9a542c979df62098ae9c58b19e03ad3df1c9d8c6895d96c0d51da17b243b1c"}, - {file = "watchdog-4.0.0-py3-none-win_amd64.whl", hash = "sha256:f970663fa4f7e80401a7b0cbeec00fa801bf0287d93d48368fc3e6fa32716245"}, - {file = "watchdog-4.0.0-py3-none-win_ia64.whl", hash = "sha256:9a03e16e55465177d416699331b0f3564138f1807ecc5f2de9d55d8f188d08c7"}, - {file = "watchdog-4.0.0.tar.gz", hash = "sha256:e3e7065cbdabe6183ab82199d7a4f6b3ba0a438c5a512a68559846ccb76a78ec"}, + {file = "watchdog-4.0.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:da2dfdaa8006eb6a71051795856bedd97e5b03e57da96f98e375682c48850645"}, + {file = "watchdog-4.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:e93f451f2dfa433d97765ca2634628b789b49ba8b504fdde5837cdcf25fdb53b"}, + {file = "watchdog-4.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ef0107bbb6a55f5be727cfc2ef945d5676b97bffb8425650dadbb184be9f9a2b"}, + {file = "watchdog-4.0.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:17e32f147d8bf9657e0922c0940bcde863b894cd871dbb694beb6704cfbd2fb5"}, + {file = "watchdog-4.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:03e70d2df2258fb6cb0e95bbdbe06c16e608af94a3ffbd2b90c3f1e83eb10767"}, + {file = "watchdog-4.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:123587af84260c991dc5f62a6e7ef3d1c57dfddc99faacee508c71d287248459"}, + {file = "watchdog-4.0.1-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:093b23e6906a8b97051191a4a0c73a77ecc958121d42346274c6af6520dec175"}, + {file = "watchdog-4.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:611be3904f9843f0529c35a3ff3fd617449463cb4b73b1633950b3d97fa4bfb7"}, + {file = "watchdog-4.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:62c613ad689ddcb11707f030e722fa929f322ef7e4f18f5335d2b73c61a85c28"}, + {file = "watchdog-4.0.1-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:d4925e4bf7b9bddd1c3de13c9b8a2cdb89a468f640e66fbfabaf735bd85b3e35"}, + {file = "watchdog-4.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:cad0bbd66cd59fc474b4a4376bc5ac3fc698723510cbb64091c2a793b18654db"}, + {file = "watchdog-4.0.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:a3c2c317a8fb53e5b3d25790553796105501a235343f5d2bf23bb8649c2c8709"}, + {file = "watchdog-4.0.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:c9904904b6564d4ee8a1ed820db76185a3c96e05560c776c79a6ce5ab71888ba"}, + {file = "watchdog-4.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:667f3c579e813fcbad1b784db7a1aaa96524bed53437e119f6a2f5de4db04235"}, + {file = "watchdog-4.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:d10a681c9a1d5a77e75c48a3b8e1a9f2ae2928eda463e8d33660437705659682"}, + {file = "watchdog-4.0.1-pp310-pypy310_pp73-macosx_10_9_x86_64.whl", hash = "sha256:0144c0ea9997b92615af1d94afc0c217e07ce2c14912c7b1a5731776329fcfc7"}, + {file = "watchdog-4.0.1-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:998d2be6976a0ee3a81fb8e2777900c28641fb5bfbd0c84717d89bca0addcdc5"}, + {file = "watchdog-4.0.1-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:e7921319fe4430b11278d924ef66d4daa469fafb1da679a2e48c935fa27af193"}, + {file = "watchdog-4.0.1-pp38-pypy38_pp73-macosx_11_0_arm64.whl", hash = "sha256:f0de0f284248ab40188f23380b03b59126d1479cd59940f2a34f8852db710625"}, + {file = "watchdog-4.0.1-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:bca36be5707e81b9e6ce3208d92d95540d4ca244c006b61511753583c81c70dd"}, + {file = "watchdog-4.0.1-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:ab998f567ebdf6b1da7dc1e5accfaa7c6992244629c0fdaef062f43249bd8dee"}, + {file = "watchdog-4.0.1-py3-none-manylinux2014_aarch64.whl", hash = "sha256:dddba7ca1c807045323b6af4ff80f5ddc4d654c8bce8317dde1bd96b128ed253"}, + {file = "watchdog-4.0.1-py3-none-manylinux2014_armv7l.whl", hash = "sha256:4513ec234c68b14d4161440e07f995f231be21a09329051e67a2118a7a612d2d"}, + {file = "watchdog-4.0.1-py3-none-manylinux2014_i686.whl", hash = "sha256:4107ac5ab936a63952dea2a46a734a23230aa2f6f9db1291bf171dac3ebd53c6"}, + {file = "watchdog-4.0.1-py3-none-manylinux2014_ppc64.whl", hash = "sha256:6e8c70d2cd745daec2a08734d9f63092b793ad97612470a0ee4cbb8f5f705c57"}, + {file = "watchdog-4.0.1-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:f27279d060e2ab24c0aa98363ff906d2386aa6c4dc2f1a374655d4e02a6c5e5e"}, + {file = "watchdog-4.0.1-py3-none-manylinux2014_s390x.whl", hash = "sha256:f8affdf3c0f0466e69f5b3917cdd042f89c8c63aebdb9f7c078996f607cdb0f5"}, + {file = "watchdog-4.0.1-py3-none-manylinux2014_x86_64.whl", hash = "sha256:ac7041b385f04c047fcc2951dc001671dee1b7e0615cde772e84b01fbf68ee84"}, + {file = "watchdog-4.0.1-py3-none-win32.whl", hash = "sha256:206afc3d964f9a233e6ad34618ec60b9837d0582b500b63687e34011e15bb429"}, + {file = "watchdog-4.0.1-py3-none-win_amd64.whl", hash = "sha256:7577b3c43e5909623149f76b099ac49a1a01ca4e167d1785c76eb52fa585745a"}, + {file = "watchdog-4.0.1-py3-none-win_ia64.whl", hash = "sha256:d7b9f5f3299e8dd230880b6c55504a1f69cf1e4316275d1b215ebdd8187ec88d"}, + {file = "watchdog-4.0.1.tar.gz", hash = "sha256:eebaacf674fa25511e8867028d281e602ee6500045b57f43b08778082f7f8b44"}, ] [package.extras] @@ -2455,111 +3036,105 @@ files = [ [[package]] name = "wheel" -version = "0.42.0" +version = "0.44.0" description = "A built-package format for Python" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "wheel-0.42.0-py3-none-any.whl", hash = "sha256:177f9c9b0d45c47873b619f5b650346d632cdc35fb5e4d25058e09c9e581433d"}, - {file = "wheel-0.42.0.tar.gz", hash = "sha256:c45be39f7882c9d34243236f2d63cbd58039e360f85d0913425fbd7ceea617a8"}, + {file = "wheel-0.44.0-py3-none-any.whl", hash = "sha256:2376a90c98cc337d18623527a97c31797bd02bad0033d41547043a1cbfbe448f"}, + {file = "wheel-0.44.0.tar.gz", hash = "sha256:a29c3f2817e95ab89aa4660681ad547c0e9547f20e75b0562fe7723c9a2a9d49"}, ] [package.extras] test = ["pytest (>=6.0.0)", "setuptools (>=65)"] [[package]] -name = "wrapt" -version = "1.16.0" -description = "Module for decorators, wrappers and monkey patching." +name = "xattr" +version = "1.1.0" +description = "Python wrapper for extended filesystem attributes" optional = false -python-versions = ">=3.6" +python-versions = ">=3.8" files = [ - {file = "wrapt-1.16.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:ffa565331890b90056c01db69c0fe634a776f8019c143a5ae265f9c6bc4bd6d4"}, - {file = "wrapt-1.16.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:e4fdb9275308292e880dcbeb12546df7f3e0f96c6b41197e0cf37d2826359020"}, - {file = "wrapt-1.16.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bb2dee3874a500de01c93d5c71415fcaef1d858370d405824783e7a8ef5db440"}, - {file = "wrapt-1.16.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:2a88e6010048489cda82b1326889ec075a8c856c2e6a256072b28eaee3ccf487"}, - {file = "wrapt-1.16.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ac83a914ebaf589b69f7d0a1277602ff494e21f4c2f743313414378f8f50a4cf"}, - {file = "wrapt-1.16.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:73aa7d98215d39b8455f103de64391cb79dfcad601701a3aa0dddacf74911d72"}, - {file = "wrapt-1.16.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:807cc8543a477ab7422f1120a217054f958a66ef7314f76dd9e77d3f02cdccd0"}, - {file = "wrapt-1.16.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:bf5703fdeb350e36885f2875d853ce13172ae281c56e509f4e6eca049bdfb136"}, - {file = "wrapt-1.16.0-cp310-cp310-win32.whl", hash = "sha256:f6b2d0c6703c988d334f297aa5df18c45e97b0af3679bb75059e0e0bd8b1069d"}, - {file = "wrapt-1.16.0-cp310-cp310-win_amd64.whl", hash = "sha256:decbfa2f618fa8ed81c95ee18a387ff973143c656ef800c9f24fb7e9c16054e2"}, - {file = "wrapt-1.16.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:1a5db485fe2de4403f13fafdc231b0dbae5eca4359232d2efc79025527375b09"}, - {file = "wrapt-1.16.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:75ea7d0ee2a15733684badb16de6794894ed9c55aa5e9903260922f0482e687d"}, - {file = "wrapt-1.16.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a452f9ca3e3267cd4d0fcf2edd0d035b1934ac2bd7e0e57ac91ad6b95c0c6389"}, - {file = "wrapt-1.16.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:43aa59eadec7890d9958748db829df269f0368521ba6dc68cc172d5d03ed8060"}, - {file = "wrapt-1.16.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:72554a23c78a8e7aa02abbd699d129eead8b147a23c56e08d08dfc29cfdddca1"}, - {file = "wrapt-1.16.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:d2efee35b4b0a347e0d99d28e884dfd82797852d62fcd7ebdeee26f3ceb72cf3"}, - {file = "wrapt-1.16.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:6dcfcffe73710be01d90cae08c3e548d90932d37b39ef83969ae135d36ef3956"}, - {file = "wrapt-1.16.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:eb6e651000a19c96f452c85132811d25e9264d836951022d6e81df2fff38337d"}, - {file = "wrapt-1.16.0-cp311-cp311-win32.whl", hash = "sha256:66027d667efe95cc4fa945af59f92c5a02c6f5bb6012bff9e60542c74c75c362"}, - {file = "wrapt-1.16.0-cp311-cp311-win_amd64.whl", hash = "sha256:aefbc4cb0a54f91af643660a0a150ce2c090d3652cf4052a5397fb2de549cd89"}, - {file = "wrapt-1.16.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:5eb404d89131ec9b4f748fa5cfb5346802e5ee8836f57d516576e61f304f3b7b"}, - {file = "wrapt-1.16.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:9090c9e676d5236a6948330e83cb89969f433b1943a558968f659ead07cb3b36"}, - {file = "wrapt-1.16.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:94265b00870aa407bd0cbcfd536f17ecde43b94fb8d228560a1e9d3041462d73"}, - {file = "wrapt-1.16.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f2058f813d4f2b5e3a9eb2eb3faf8f1d99b81c3e51aeda4b168406443e8ba809"}, - {file = "wrapt-1.16.0-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:98b5e1f498a8ca1858a1cdbffb023bfd954da4e3fa2c0cb5853d40014557248b"}, - {file = "wrapt-1.16.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:14d7dc606219cdd7405133c713f2c218d4252f2a469003f8c46bb92d5d095d81"}, - {file = "wrapt-1.16.0-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:49aac49dc4782cb04f58986e81ea0b4768e4ff197b57324dcbd7699c5dfb40b9"}, - {file = "wrapt-1.16.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:418abb18146475c310d7a6dc71143d6f7adec5b004ac9ce08dc7a34e2babdc5c"}, - {file = "wrapt-1.16.0-cp312-cp312-win32.whl", hash = "sha256:685f568fa5e627e93f3b52fda002c7ed2fa1800b50ce51f6ed1d572d8ab3e7fc"}, - {file = "wrapt-1.16.0-cp312-cp312-win_amd64.whl", hash = "sha256:dcdba5c86e368442528f7060039eda390cc4091bfd1dca41e8046af7c910dda8"}, - {file = "wrapt-1.16.0-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:d462f28826f4657968ae51d2181a074dfe03c200d6131690b7d65d55b0f360f8"}, - {file = "wrapt-1.16.0-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a33a747400b94b6d6b8a165e4480264a64a78c8a4c734b62136062e9a248dd39"}, - {file = "wrapt-1.16.0-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b3646eefa23daeba62643a58aac816945cadc0afaf21800a1421eeba5f6cfb9c"}, - {file = "wrapt-1.16.0-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3ebf019be5c09d400cf7b024aa52b1f3aeebeff51550d007e92c3c1c4afc2a40"}, - {file = "wrapt-1.16.0-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:0d2691979e93d06a95a26257adb7bfd0c93818e89b1406f5a28f36e0d8c1e1fc"}, - {file = "wrapt-1.16.0-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:1acd723ee2a8826f3d53910255643e33673e1d11db84ce5880675954183ec47e"}, - {file = "wrapt-1.16.0-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:bc57efac2da352a51cc4658878a68d2b1b67dbe9d33c36cb826ca449d80a8465"}, - {file = "wrapt-1.16.0-cp36-cp36m-win32.whl", hash = "sha256:da4813f751142436b075ed7aa012a8778aa43a99f7b36afe9b742d3ed8bdc95e"}, - {file = "wrapt-1.16.0-cp36-cp36m-win_amd64.whl", hash = "sha256:6f6eac2360f2d543cc875a0e5efd413b6cbd483cb3ad7ebf888884a6e0d2e966"}, - {file = "wrapt-1.16.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:a0ea261ce52b5952bf669684a251a66df239ec6d441ccb59ec7afa882265d593"}, - {file = "wrapt-1.16.0-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7bd2d7ff69a2cac767fbf7a2b206add2e9a210e57947dd7ce03e25d03d2de292"}, - {file = "wrapt-1.16.0-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9159485323798c8dc530a224bd3ffcf76659319ccc7bbd52e01e73bd0241a0c5"}, - {file = "wrapt-1.16.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a86373cf37cd7764f2201b76496aba58a52e76dedfaa698ef9e9688bfd9e41cf"}, - {file = "wrapt-1.16.0-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:73870c364c11f03ed072dda68ff7aea6d2a3a5c3fe250d917a429c7432e15228"}, - {file = "wrapt-1.16.0-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:b935ae30c6e7400022b50f8d359c03ed233d45b725cfdd299462f41ee5ffba6f"}, - {file = "wrapt-1.16.0-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:db98ad84a55eb09b3c32a96c576476777e87c520a34e2519d3e59c44710c002c"}, - {file = "wrapt-1.16.0-cp37-cp37m-win32.whl", hash = "sha256:9153ed35fc5e4fa3b2fe97bddaa7cbec0ed22412b85bcdaf54aeba92ea37428c"}, - {file = "wrapt-1.16.0-cp37-cp37m-win_amd64.whl", hash = "sha256:66dfbaa7cfa3eb707bbfcd46dab2bc6207b005cbc9caa2199bcbc81d95071a00"}, - {file = "wrapt-1.16.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1dd50a2696ff89f57bd8847647a1c363b687d3d796dc30d4dd4a9d1689a706f0"}, - {file = "wrapt-1.16.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:44a2754372e32ab315734c6c73b24351d06e77ffff6ae27d2ecf14cf3d229202"}, - {file = "wrapt-1.16.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8e9723528b9f787dc59168369e42ae1c3b0d3fadb2f1a71de14531d321ee05b0"}, - {file = "wrapt-1.16.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:dbed418ba5c3dce92619656802cc5355cb679e58d0d89b50f116e4a9d5a9603e"}, - {file = "wrapt-1.16.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:941988b89b4fd6b41c3f0bfb20e92bd23746579736b7343283297c4c8cbae68f"}, - {file = "wrapt-1.16.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:6a42cd0cfa8ffc1915aef79cb4284f6383d8a3e9dcca70c445dcfdd639d51267"}, - {file = "wrapt-1.16.0-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:1ca9b6085e4f866bd584fb135a041bfc32cab916e69f714a7d1d397f8c4891ca"}, - {file = "wrapt-1.16.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:d5e49454f19ef621089e204f862388d29e6e8d8b162efce05208913dde5b9ad6"}, - {file = "wrapt-1.16.0-cp38-cp38-win32.whl", hash = "sha256:c31f72b1b6624c9d863fc095da460802f43a7c6868c5dda140f51da24fd47d7b"}, - {file = "wrapt-1.16.0-cp38-cp38-win_amd64.whl", hash = "sha256:490b0ee15c1a55be9c1bd8609b8cecd60e325f0575fc98f50058eae366e01f41"}, - {file = "wrapt-1.16.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9b201ae332c3637a42f02d1045e1d0cccfdc41f1f2f801dafbaa7e9b4797bfc2"}, - {file = "wrapt-1.16.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:2076fad65c6736184e77d7d4729b63a6d1ae0b70da4868adeec40989858eb3fb"}, - {file = "wrapt-1.16.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c5cd603b575ebceca7da5a3a251e69561bec509e0b46e4993e1cac402b7247b8"}, - {file = "wrapt-1.16.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b47cfad9e9bbbed2339081f4e346c93ecd7ab504299403320bf85f7f85c7d46c"}, - {file = "wrapt-1.16.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f8212564d49c50eb4565e502814f694e240c55551a5f1bc841d4fcaabb0a9b8a"}, - {file = "wrapt-1.16.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:5f15814a33e42b04e3de432e573aa557f9f0f56458745c2074952f564c50e664"}, - {file = "wrapt-1.16.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:db2e408d983b0e61e238cf579c09ef7020560441906ca990fe8412153e3b291f"}, - {file = "wrapt-1.16.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:edfad1d29c73f9b863ebe7082ae9321374ccb10879eeabc84ba3b69f2579d537"}, - {file = "wrapt-1.16.0-cp39-cp39-win32.whl", hash = "sha256:ed867c42c268f876097248e05b6117a65bcd1e63b779e916fe2e33cd6fd0d3c3"}, - {file = "wrapt-1.16.0-cp39-cp39-win_amd64.whl", hash = "sha256:eb1b046be06b0fce7249f1d025cd359b4b80fc1c3e24ad9eca33e0dcdb2e4a35"}, - {file = "wrapt-1.16.0-py3-none-any.whl", hash = "sha256:6906c4100a8fcbf2fa735f6059214bb13b97f75b1a61777fcf6432121ef12ef1"}, - {file = "wrapt-1.16.0.tar.gz", hash = "sha256:5f370f952971e7d17c7d1ead40e49f32345a7f7a5373571ef44d800d06b1899d"}, + {file = "xattr-1.1.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:ef2fa0f85458736178fd3dcfeb09c3cf423f0843313e25391db2cfd1acec8888"}, + {file = "xattr-1.1.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:ccab735d0632fe71f7d72e72adf886f45c18b7787430467ce0070207882cfe25"}, + {file = "xattr-1.1.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9013f290387f1ac90bccbb1926555ca9aef75651271098d99217284d9e010f7c"}, + {file = "xattr-1.1.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9dcd5dfbcee73c7be057676ecb900cabb46c691aff4397bf48c579ffb30bb963"}, + {file = "xattr-1.1.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6480589c1dac7785d1f851347a32c4a97305937bf7b488b857fe8b28a25de9e9"}, + {file = "xattr-1.1.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:08f61cbed52dc6f7c181455826a9ff1e375ad86f67dd9d5eb7663574abb32451"}, + {file = "xattr-1.1.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:918e1f83f2e8a072da2671eac710871ee5af337e9bf8554b5ce7f20cdb113186"}, + {file = "xattr-1.1.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:0f06e0c1e4d06b4e0e49aaa1184b6f0e81c3758c2e8365597918054890763b53"}, + {file = "xattr-1.1.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:46a641ac038a9f53d2f696716147ca4dbd6a01998dc9cd4bc628801bc0df7f4d"}, + {file = "xattr-1.1.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:7e4ca0956fd11679bb2e0c0d6b9cdc0f25470cc00d8da173bb7656cc9a9cf104"}, + {file = "xattr-1.1.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6881b120f9a4b36ccd8a28d933bc0f6e1de67218b6ce6e66874e0280fc006844"}, + {file = "xattr-1.1.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:dab29d9288aa28e68a6f355ddfc3f0a7342b40c9012798829f3e7bd765e85c2c"}, + {file = "xattr-1.1.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e0c80bbf55339c93770fc294b4b6586b5bf8e85ec00a4c2d585c33dbd84b5006"}, + {file = "xattr-1.1.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d1418705f253b6b6a7224b69773842cac83fcbcd12870354b6e11dd1cd54630f"}, + {file = "xattr-1.1.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:687e7d18611ef8d84a6ecd8f4d1ab6757500c1302f4c2046ce0aa3585e13da3f"}, + {file = "xattr-1.1.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:b6ceb9efe0657a982ccb8b8a2efe96b690891779584c901d2f920784e5d20ae3"}, + {file = "xattr-1.1.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:b489b7916f239100956ea0b39c504f3c3a00258ba65677e4c8ba1bd0b5513446"}, + {file = "xattr-1.1.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:0a9c431b0e66516a078125e9a273251d4b8e5ba84fe644b619f2725050d688a0"}, + {file = "xattr-1.1.0-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:1a5921ea3313cc1c57f2f53b63ea8ca9a91e48f4cc7ebec057d2447ec82c7efe"}, + {file = "xattr-1.1.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:f6ad2a7bd5e6cf71d4a862413234a067cf158ca0ae94a40d4b87b98b62808498"}, + {file = "xattr-1.1.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:0683dae7609f7280b0c89774d00b5957e6ffcb181c6019c46632b389706b77e6"}, + {file = "xattr-1.1.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:54cb15cd94e5ef8a0ef02309f1bf973ba0e13c11e87686e983f371948cfee6af"}, + {file = "xattr-1.1.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ff6223a854229055e803c2ad0c0ea9a6da50c6be30d92c198cf5f9f28819a921"}, + {file = "xattr-1.1.0-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d44e8f955218638c9ab222eed21e9bd9ab430d296caf2176fb37abe69a714e5c"}, + {file = "xattr-1.1.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:caab2c2986c30f92301f12e9c50415d324412e8e6a739a52a603c3e6a54b3610"}, + {file = "xattr-1.1.0-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:d6eb7d5f281014cd44e2d847a9107491af1bf3087f5afeded75ed3e37ec87239"}, + {file = "xattr-1.1.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:47a3bdfe034b4fdb70e5941d97037405e3904accc28e10dbef6d1c9061fb6fd7"}, + {file = "xattr-1.1.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:00d2b415cf9d6a24112d019e721aa2a85652f7bbc9f3b9574b2d1cd8668eb491"}, + {file = "xattr-1.1.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:78b377832dd0ee408f9f121a354082c6346960f7b6b1480483ed0618b1912120"}, + {file = "xattr-1.1.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:6461a43b585e5f2e049b39bcbfcb6391bfef3c5118231f1b15d10bdb89ef17fe"}, + {file = "xattr-1.1.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:24d97f0d28f63695e3344ffdabca9fcc30c33e5c8ccc198c7524361a98d526f2"}, + {file = "xattr-1.1.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6ad47d89968c9097900607457a0c89160b4771601d813e769f68263755516065"}, + {file = "xattr-1.1.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dc53cab265f6e8449bd683d5ee3bc5a191e6dd940736f3de1a188e6da66b0653"}, + {file = "xattr-1.1.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:cd11e917f5b89f2a0ad639d9875943806c6c9309a3dd02da5a3e8ef92db7bed9"}, + {file = "xattr-1.1.0-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:9c5a78c7558989492c4cb7242e490ffb03482437bf782967dfff114e44242343"}, + {file = "xattr-1.1.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:cebcf8a303a44fbc439b68321408af7267507c0d8643229dbb107f6c132d389c"}, + {file = "xattr-1.1.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:b0d73150f2f9655b4da01c2369eb33a294b7f9d56eccb089819eafdbeb99f896"}, + {file = "xattr-1.1.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:793c01deaadac50926c0e1481702133260c7cb5e62116762f6fe1543d07b826f"}, + {file = "xattr-1.1.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:e189e440bcd04ccaad0474720abee6ee64890823ec0db361fb0a4fb5e843a1bf"}, + {file = "xattr-1.1.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:afacebbc1fa519f41728f8746a92da891c7755e6745164bd0d5739face318e86"}, + {file = "xattr-1.1.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9b1664edf003153ac8d1911e83a0fc60db1b1b374ee8ac943f215f93754a1102"}, + {file = "xattr-1.1.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dda2684228798e937a7c29b0e1c7ef3d70e2b85390a69b42a1c61b2039ba81de"}, + {file = "xattr-1.1.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:b735ac2625a4fc2c9343b19f806793db6494336338537d2911c8ee4c390dda46"}, + {file = "xattr-1.1.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:fa6a7af7a4ada43f15ccc58b6f9adcdbff4c36ba040013d2681e589e07ae280a"}, + {file = "xattr-1.1.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:d1059b2f726e2702c8bbf9bbf369acfc042202a4cc576c2dec6791234ad5e948"}, + {file = "xattr-1.1.0-pp310-pypy310_pp73-macosx_10_9_x86_64.whl", hash = "sha256:e2255f36ebf2cb2dbf772a7437ad870836b7396e60517211834cf66ce678b595"}, + {file = "xattr-1.1.0-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dba4f80b9855cc98513ddf22b7ad8551bc448c70d3147799ea4f6c0b758fb466"}, + {file = "xattr-1.1.0-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4cb70c16e7c3ae6ba0ab6c6835c8448c61d8caf43ea63b813af1f4dbe83dd156"}, + {file = "xattr-1.1.0-pp310-pypy310_pp73-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:83652910ef6a368b77b00825ad67815e5c92bfab551a848ca66e9981d14a7519"}, + {file = "xattr-1.1.0-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:7a92aff66c43fa3e44cbeab7cbeee66266c91178a0f595e044bf3ce51485743b"}, + {file = "xattr-1.1.0-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9d4f71b673339aeaae1f6ea9ef8ea6c9643c8cd0df5003b9a0eaa75403e2e06c"}, + {file = "xattr-1.1.0-pp38-pypy38_pp73-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a20de1c47b5cd7b47da61799a3b34e11e5815d716299351f82a88627a43f9a96"}, + {file = "xattr-1.1.0-pp38-pypy38_pp73-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:23705c7079b05761ff2fa778ad17396e7599c8759401abc05b312dfb3bc99f69"}, + {file = "xattr-1.1.0-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:27272afeba8422f2a9d27e1080a9a7b807394e88cce73db9ed8d2dde3afcfb87"}, + {file = "xattr-1.1.0-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dd43978966de3baf4aea367c99ffa102b289d6c2ea5f3d9ce34a203dc2f2ab73"}, + {file = "xattr-1.1.0-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ded771eaf27bb4eb3c64c0d09866460ee8801d81dc21097269cf495b3cac8657"}, + {file = "xattr-1.1.0-pp39-pypy39_pp73-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:96ca300c0acca4f0cddd2332bb860ef58e1465d376364f0e72a1823fdd58e90d"}, + {file = "xattr-1.1.0.tar.gz", hash = "sha256:fecbf3b05043ed3487a28190dec3e4c4d879b2fcec0e30bafd8ec5d4b6043630"}, ] +[package.dependencies] +cffi = ">=1.16.0" + +[package.extras] +test = ["pytest"] + [[package]] name = "zipp" -version = "3.17.0" +version = "3.19.2" description = "Backport of pathlib-compatible object wrapper for zip files" optional = false python-versions = ">=3.8" files = [ - {file = "zipp-3.17.0-py3-none-any.whl", hash = "sha256:0e923e726174922dce09c53c59ad483ff7bbb8e572e00c7f7c46b88556409f31"}, - {file = "zipp-3.17.0.tar.gz", hash = "sha256:84e64a1c28cf7e91ed2078bb8cc8c259cb19b76942096c8d7b84947690cabaf0"}, + {file = "zipp-3.19.2-py3-none-any.whl", hash = "sha256:f091755f667055f2d02b32c53771a7a6c8b47e1fdbc4b72a8b9072b3eef8015c"}, + {file = "zipp-3.19.2.tar.gz", hash = "sha256:bf1dcf6450f873a13e952a29504887c89e6de7506209e5b1bcc3460135d4de19"}, ] [package.extras] -docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (<7.2.5)", "sphinx (>=3.5)", "sphinx-lint"] -testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-ignore-flaky", "pytest-mypy (>=0.9.1)", "pytest-ruff"] +doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] +test = ["big-O", "importlib-resources", "jaraco.functools", "jaraco.itertools", "jaraco.test", "more-itertools", "pytest (>=6,!=8.1.*)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-ignore-flaky", "pytest-mypy", "pytest-ruff (>=0.2.1)"] [extras] all = ["anyio", "fastapi", "uvicorn"] @@ -2567,5 +3142,5 @@ api = ["anyio", "fastapi", "uvicorn"] [metadata] lock-version = "2.0" -python-versions = "^3.8" -content-hash = "6d8ba3380bb97710ef803fec0b9a8596c353ef86362331736cc9d3abfc7a11dd" +python-versions = "^3.9" +content-hash = "29ffcdcedc7512fef0d6a3de62c80f86e105b7d2d65d6b07c448738abc64b227" diff --git a/pyproject.toml b/pyproject.toml index 0be9c4f4..1708138d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -29,12 +29,12 @@ include = ["deepsearch/py.typed"] deepsearch = "deepsearch.cli:app" [tool.poetry.dependencies] -python = "^3.8" +python = "^3.9" # Dependencies from generated packages urllib3 = "^1.26.8" six = "^1.16.0" -certifi = "^2023.07.22" +certifi = "^2024.07.04" python-dateutil = "^2.8.2" # Actual dependencies @@ -42,15 +42,16 @@ pydantic = {version = "^2.0.3"} pydantic-settings = "^2.4.0" python-dotenv = "^1.0.0" requests = "^2.27.1" -typer = {extras = ["all"], version = "^0.9.0"} +typer = {extras = ["all"], version = ">=0.9.0, <1.0.0"} platformdirs = "^3.5.1" tabulate = ">=0.8.9, <1.0.0" pluggy = "^1.0.0" tqdm = "^4.64.0" -fastapi = {version = "^0.109.2", optional = true} -uvicorn = {version = "^0.27.0.post1", optional = true} +fastapi = {version = "^0.112.0", optional = true} +uvicorn = {version = "^0.30.5", optional = true} anyio = { version = "^3.6.2", optional = true } +docling-core = "^1.1.2" [tool.poetry.extras] # MANUAL MAINTENANCE REQUIRED: for every change in the extras, "all" must be updated, @@ -71,7 +72,7 @@ all = [ [tool.poetry.group.dev.dependencies] black = {extras = ["jupyter"], version = "^22.1.0"} -pylint = "^2.15.8" +pylint = "^3.2.6" pytest = "^7.0.1" pre-commit = "^2.17.0" mypy = "^1.0.0" @@ -95,7 +96,7 @@ build-backend = "poetry.core.masonry.api" [tool.black] line-length = 88 -target-version = ["py38"] +target-version = ["py39"] include = '\.pyi?$' extend-exclude = """ # Exclude generated API code @@ -106,7 +107,7 @@ extend-exclude = """ profile = "black" line_length = 88 skip_glob = ["docs", "deepsearch/cps/apis"] -py_version=38 +py_version=39 known_first_party = ["cps"] [tool.mypy] @@ -114,7 +115,7 @@ plugins = ["pydantic.mypy"] pretty = true # strict = true no_implicit_optional = true -python_version = 3.8 +python_version = "3.9" # We are not going to bother about generated code... [[tool.mypy.overrides]] diff --git a/tools/swagger-client-generator/generate-client.sh b/tools/swagger-client-generator/generate-client.sh index 0ab87af4..c9df160d 100755 --- a/tools/swagger-client-generator/generate-client.sh +++ b/tools/swagger-client-generator/generate-client.sh @@ -2,6 +2,11 @@ set -e +DOCKER="${DOCKER:-podman}" +DOCKER_OPTS="${DOCKER_OPTS:- --userns=keep-id:uid=\"$(id -u)\",gid=\"$(id -g)\"}" + +echo "DOCKER_OPTS=${DOCKER_OPTS}" + curdir=$(dirname $0) rootdir=$curdir/../../ @@ -32,33 +37,33 @@ fi rm -rf .generated/ || true mkdir -p .generated/ -echo "Generating client for CPS" +# echo "Generating client for CPS" -podman run --rm \ - -v "$(pwd):/local" \ - --userns=keep-id:uid="$(id -u)",gid="$(id -g)" \ - ${generator_image} generate \ - -i "/local/tools/swagger-client-generator/swagger-cps.json" \ - -g python \ - -o /local/.generated/cps-public \ - -c /local/tools/swagger-client-generator/openapi-generator-config-cps.json +# ${DOCKER} run --rm \ +# -v "$(pwd):/local" \ +# ${DOCKER_OPTS} \ +# ${generator_image} generate \ +# -i "/local/tools/swagger-client-generator/swagger-cps.json" \ +# -g python \ +# -o /local/.generated/cps-public \ +# -c /local/tools/swagger-client-generator/openapi-generator-config-cps.json -echo "Generating client for the User API" +# echo "Generating client for the User API" -podman run --rm \ - -v "$(pwd):/local" \ - --userns=keep-id:uid="$(id -u)",gid="$(id -g)" \ - ${generator_image} generate \ - -i "/local/tools/swagger-client-generator/swagger-user.json" \ - -g python \ - -o /local/.generated/cps-user \ - -c /local/tools/swagger-client-generator/openapi-generator-config-user.json +# ${DOCKER} run --rm \ +# -v "$(pwd):/local" \ +# ${DOCKER_OPTS} \ +# ${generator_image} generate \ +# -i "/local/tools/swagger-client-generator/swagger-user.json" \ +# -g python \ +# -o /local/.generated/cps-user \ +# -c /local/tools/swagger-client-generator/openapi-generator-config-user.json echo "Generating client for DS API v2" -podman run --rm \ +${DOCKER} run --rm \ -v "$(pwd):/local" \ - --userns=keep-id:uid="$(id -u)",gid="$(id -g)" \ + ${DOCKER_OPTS} \ ${generator_image_v2} generate \ -i "/local/tools/swagger-client-generator/openapi-ds-v2.json" \ -g python \ @@ -68,7 +73,7 @@ podman run --rm \ # echo "Generating client for the CPS KG API" # echo "Currently disabled: TODO FIX API Specs" -# # podman run --rm \ +# # ${DOCKER} run --rm \ # # -v "$(pwd):/local" \ # # --userns=keep-id:uid="$(id -u)",gid="$(id -g)" \ # # ${generator_image} generate \ @@ -83,7 +88,7 @@ podman run --rm \ # echo "Generating client for the KG Query API" # echo "Disabled since it generated wrong specs. It won't be updated." -# # podman run --rm \ +# # ${DOCKER} run --rm \ # # -v "$(pwd):/local" \ # # --userns=keep-id:uid="$(id -u)",gid="$(id -g)" \ # # ${generator_image} generate \ @@ -97,7 +102,7 @@ podman run --rm \ # echo "Generating client for the KG Create API" # echo "Disabled since it won't be updated." -# # podman run --rm \ +# # ${DOCKER} run --rm \ # # -v "$(pwd):/local" \ # # --userns=keep-id:uid="$(id -u)",gid="$(id -g)" \ # # ${generator_image} generate \ @@ -111,16 +116,16 @@ podman run --rm \ echo "Merging packages..." # Remove generated API client code -rm -rf $rootdir/deepsearch/cps/apis/public || true -rm -rf $rootdir/deepsearch/cps/apis/user || true +# rm -rf $rootdir/deepsearch/cps/apis/public || true +# rm -rf $rootdir/deepsearch/cps/apis/user || true rm -rf $rootdir/deepsearch/cps/apis/public_v2 || true # rm -rf $rootdir/deepsearch/cps/apis/kg || true mkdir -p $rootdir/deepsearch/cps/apis touch $rootdir/deepsearch/cps/apis/__init__.py -cp -R .generated/cps-public/deepsearch/cps/apis/ $rootdir/deepsearch/cps/apis/ -cp -R .generated/cps-user/deepsearch/cps/apis/ $rootdir/deepsearch/cps/apis/ +# cp -R .generated/cps-public/deepsearch/cps/apis/ $rootdir/deepsearch/cps/apis/ +# cp -R .generated/cps-user/deepsearch/cps/apis/ $rootdir/deepsearch/cps/apis/ cp -R .generated/ds-public-v2/deepsearch/cps/apis/ $rootdir/deepsearch/cps/apis/ # cp -R .generated/cps-kg-create/deepsearch/cps/apis/ $rootdir/deepsearch/cps/apis/ # cp -R .generated/cps-kg-query/deepsearch/cps/apis/ $rootdir/deepsearch/cps/apis/ @@ -139,8 +144,8 @@ mkdir -p $rootdir/docs/apis/user mkdir -p $rootdir/docs/apis/kg/query mkdir -p $rootdir/docs/apis/kg/create -cp -R .generated/cps-public/docs/* $rootdir/docs/apis/public -cp -R .generated/cps-user/docs/* $rootdir/docs/apis/user +# cp -R .generated/cps-public/docs/* $rootdir/docs/apis/public +# cp -R .generated/cps-user/docs/* $rootdir/docs/apis/user cp -R .generated/ds-public-v2/docs/* $rootdir/docs/apis/public_v2 # cp -R .generated/cps-kg-query/docs/* $rootdir/docs/apis/kg/create # cp -R .generated/cps-kg-create/docs/* $rootdir/docs/apis/kg/query diff --git a/tools/swagger-client-generator/openapi-ds-v2.json b/tools/swagger-client-generator/openapi-ds-v2.json index dee2ad23..873649dd 100644 --- a/tools/swagger-client-generator/openapi-ds-v2.json +++ b/tools/swagger-client-generator/openapi-ds-v2.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Deep Search (DS) API","description":"API for Deep Search.\n\n**WARNING**: This API is subject to change without warning!","version":"3.0.0"},"servers":[{"url":"/api/cps/public/v2"}],"paths":{"/project/{proj_key}/data_indices/documents/agents":{"get":{"tags":["Content Manager"],"summary":"Get Project Agents","description":"Get project agents.","operationId":"get_project_agents","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectAgents"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/transactions/{transaction_id}":{"get":{"tags":["Content Manager"],"summary":"Get Project Documents By Transaction","description":"Get project documents by transaction ID.","operationId":"get_project_documents_by_transaction","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Transaction Id"},"name":"transaction_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/":{"get":{"tags":["Content Manager"],"summary":"Get All Project Data Index Documents","description":"Get all project documents","operationId":"get_all_project_data_index_documents","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"integer","title":"Page","default":1},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page Size","default":25},"name":"page_size","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/statistics":{"get":{"tags":["Content Manager"],"summary":"Get Project Conversion Statistics","description":"Get project conversion statistics.","operationId":"get_project_conversion_statistics","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentStatistics"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/agent/{agent_name}":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Documents","description":"Get project documents, can be filter by status.","operationId":"get_project_data_index_documents","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Agent Name"},"name":"agent_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"],"title":"Status"},"name":"status","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page","default":1},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page Size","default":25},"name":"page_size","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/agent/{agent_name}/grouped":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Grouped Documents","description":"Get project documents grouped by upload.","operationId":"get_project_data_index_grouped_documents","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Agent Name"},"name":"agent_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"],"title":"Status"},"name":"status","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page","default":1},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page Size","default":25},"name":"page_size","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGroupedDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/upload_jobs":{"get":{"tags":["Content Manager"],"summary":"Get Project Index Upload Jobs","description":"Get project upload jobs.","operationId":"get_project_index_upload_jobs","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseUploadJobs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/Markdown":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Markdown","description":"Get project document Markdown.","operationId":"get_project_data_index_document_markdown","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocumentURL"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/PDF":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Pdf Document","description":"Get project PDF document.","operationId":"get_project_data_index_pdf_document","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocumentURL"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/JSON":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Json Document","description":"Get project JSON document.","operationId":"get_project_data_index_json_document","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Project Data Index Json Document"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/artifacts":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Artifacts","description":"Get project document artifacts.","operationId":"get_project_data_index_document_artifacts","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDocumentArtifacts"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/metadata":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Metadata","description":"Get project document metadata.","operationId":"get_project_data_index_document_metadata","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/doc_events":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Events","description":"Get events of a project document.","operationId":"get_project_data_index_document_events","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","title":"Agent Name"},"name":"agent_name","in":"query"},{"required":false,"schema":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"],"title":"Status"},"name":"status","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Project Data Index Document Events"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices":{"get":{"tags":["Data Indices"],"summary":"Get Project Data Indices","description":"Get project data indices.","operationId":"get_project_data_indices","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"},"type":"array","title":"Response Get Project Data Indices"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Data Indices"],"summary":"Create Project Data Index","description":"Create a project data index.","operationId":"create_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProjectDataIndexView"},{"$ref":"#/components/schemas/ProjectDataIndexNonView"}],"title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}":{"get":{"tags":["Data Indices"],"summary":"Get Project Data Index","description":"Get project data index.","operationId":"get_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Data Indices"],"summary":"Delete Project Data Index","description":"Delete a project index data.","operationId":"delete_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Confirmation Token"},"name":"confirmation_token","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"patch":{"tags":["Data Indices"],"summary":"Update Project Data Index","description":"Update a project data index.","operationId":"update_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProjectDataIndexView"},{"$ref":"#/components/schemas/ProjectDataIndexNonView"}],"title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/delete_token":{"post":{"tags":["Data Indices"],"summary":"Create Project Data Index Delete Token","description":"Get a token used to confirm the deletion of a project data index.","operationId":"create_project_data_index_delete_token","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/upload":{"post":{"tags":["Data Indices Upload"],"summary":"Upload Project Data Index File","description":"Upload a file to a project data index.","operationId":"upload_project_data_index_file","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonUploadRequestBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload":{"post":{"tags":["Data Indices Upload"],"summary":"Ccs Convert Upload File Project Data Index","description":"Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema).","operationId":"ccs_convert_upload_file_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertDocumentsRequestBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload":{"post":{"tags":["Data Indices Upload"],"summary":"Html Print Convert Upload","description":"Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema).","operationId":"html_print_convert_upload","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataIndexUploadFileSource"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename}":{"get":{"tags":["Data Indices Upload"],"summary":"Get Attachment Upload Data","description":"Get url and path to upload an attachment to a project data index.","operationId":"get_attachment_upload_data","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Index Item Id"},"name":"index_item_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Filename"},"name":"filename","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentUploadData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment":{"post":{"tags":["Data Indices Upload"],"summary":"Register Attachment","description":"Notify upload completion of an attachment to a project data index.","operationId":"register_attachment","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Index Item Id"},"name":"index_item_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentUploadRequestBody"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/public/bags":{"get":{"tags":["Knowledge Graphs"],"summary":"List Public Knowledge Graphs","description":"List all public BAGs","operationId":"list_public_knowledge_graphs","parameters":[{"required":false,"schema":{"title":"Term"},"name":"term","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array","title":"Response List Public Knowledge Graphs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/backend/project/{proj_key}/bags":{"get":{"tags":["Knowledge Graphs"],"summary":"Backend List Project Kgs","description":"List all bags in the project, backend-aware","operationId":"backend_list_project_kgs","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"title":"Term"},"name":"term","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array","title":"Response Backend List Project Kgs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Knowledge Graphs"],"summary":"Create Project Knowledge Graph","description":"Create new BAG, backend-aware","operationId":"create_project_knowledge_graph","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Create Project Knowledge Graph"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/backend/project/{proj_key}/bags/{bag_key}":{"patch":{"tags":["Knowledge Graphs"],"summary":"Update Project Knowledge Graph Metadata","description":"Update the metadata of a Knowledge graph","operationId":"update_project_knowledge_graph_metadata","parameters":[{"required":true,"schema":{"title":"Bag Key"},"name":"bag_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Update Project Knowledge Graph Metadata"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/default_values":{"get":{"tags":["Project"],"summary":"Get Project Default Values","description":"List project's default values.","operationId":"get_project_default_values","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValues"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Project"],"summary":"Update Project Default Values","description":"Update project's default values.","operationId":"update_project_default_values","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValues"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/integrations/genai":{"get":{"tags":["Project"],"summary":"Get Project Integration Config Genai","description":"Get the GenAI config for a given project.","operationId":"get_project_integration_config_genai","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"boolean","title":"Decode Secrets"},"name":"decode_secrets","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/GenAIBAM"},{"$ref":"#/components/schemas/GenAIWatsonx"},{"$ref":"#/components/schemas/GenAIHFInferenceApi"},{"$ref":"#/components/schemas/GenAIAWSBedrock"}],"title":"Response Get Project Integration Config Genai"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Project"],"summary":"Update Project Integration Config Genai","description":"Update the GenAI config for a given project.","operationId":"update_project_integration_config_genai","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/GenAIBAM"},{"$ref":"#/components/schemas/GenAIWatsonx"},{"$ref":"#/components/schemas/GenAIHFInferenceApi"},{"$ref":"#/components/schemas/GenAIAWSBedrock"}],"title":"Config"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Project"],"summary":"Delete Project Integration Config Genai","description":"Delete the GenAI config for a given project integration.","operationId":"delete_project_integration_config_genai","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/packages":{"post":{"tags":["Project"],"summary":"Provision Project Packages","description":"Install packages on a project.","operationId":"provision_project_packages","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectPackageInstalationManifest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskContext"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/semantic/ingest":{"post":{"tags":["Semantic"],"summary":"Ingest","description":"Ingest documents and collections for RAG","operationId":"ingest","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SemanticIngestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/info":{"get":{"tags":["System"],"summary":"Get System Information","description":"Get system info.","operationId":"get_system_information","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemInfo"}}}}}}},"/system/modules/configuration":{"get":{"tags":["System"],"summary":"Get System Modules Configuration","description":"Get modules configuration.","operationId":"get_system_modules_configuration","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModulesConfig"}}}}}}},"/system/modules/tasks":{"get":{"tags":["System"],"summary":"Get System Modules Tasks","description":"Get modules configuration.","operationId":"get_system_modules_tasks","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get System Modules Tasks"}}}}}}},"/system/kgs":{"get":{"tags":["System"],"summary":"List System Knowledge Graphs","description":"List all Knowledge Graphs in the system.","operationId":"list_system_knowledge_graphs","parameters":[{"required":false,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"query"},{"required":false,"schema":{"type":"string","title":"Term"},"name":"term","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{},"type":"array","title":"Response List System Knowledge Graphs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_all_kgs":{"get":{"tags":["System"],"summary":"System Get All Kgs Admin","description":"Get all kgs (only bag_key) for admin use.","operationId":"system_get_all_kgs_admin","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{},"type":"array","title":"Response System Get All Kgs Admin"}}}}},"security":[{"Bearer":[]}]}},"/system/packages":{"get":{"tags":["System"],"summary":"List Packages","description":"Get packages available in this CPS installation for installing in a project.","operationId":"list_packages","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CPSPackage"},"type":"array","title":"Response List Packages"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_all_dcs":{"get":{"tags":["System"],"summary":"System Get All Dcs Admin","description":"Get all data catalogs (only dc_key) for admin use.","operationId":"system_get_all_dcs_admin","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Response System Get All Dcs Admin"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/list_all_flavours":{"get":{"tags":["System Flavours"],"summary":"List All Flavours","description":"Get all KG flavours storage on db.","operationId":"list_all_flavours","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BagFlavourFullData"},"type":"array","title":"Response List All Flavours"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_flavour/{flavour_name}":{"get":{"tags":["System Flavours"],"summary":"Get Flavour","description":"Get flavour from db.","operationId":"get_flavour","parameters":[{"required":true,"schema":{"type":"string","title":"Flavour Name"},"name":"flavour_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BagFlavourFullData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_flavour":{"put":{"tags":["System Flavours"],"summary":"Save Flavour","description":"Save flavour on db.","operationId":"save_flavour","parameters":[{"required":true,"schema":{"type":"boolean","title":"New Flavour"},"name":"new_flavour","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BagFlavourFullData"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/delete_flavour/{flavour_name}":{"delete":{"tags":["System Flavours"],"summary":"Delete Flavour","description":"Delete flavour from db.","operationId":"delete_flavour","parameters":[{"required":true,"schema":{"type":"string","title":"Flavour Name"},"name":"flavour_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/list_projects_flavours":{"get":{"tags":["System Flavours"],"summary":"List Projects Flavours","description":"Get all projects and their flavours.","operationId":"list_projects_flavours","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectsFlavours"},"type":"array","title":"Response List Projects Flavours"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_project_flavours":{"put":{"tags":["System Flavours"],"summary":"Save Project Flavours","description":"Save project flavours assignment on db.","operationId":"save_project_flavours","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectsFlavours"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_project_flavours/{proj_key}":{"get":{"tags":["System Flavours"],"summary":"List Flavours By Project","description":"Get project assignment flavours.","operationId":"list_flavours_by_project","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectFlavours"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/kg_storage_summary/{kg_key}":{"get":{"tags":["System Summary"],"summary":"System Get Kg Storage Summary Async","description":"Get knowledge graph storage summary.","operationId":"system_get_kg_storage_summary_async","parameters":[{"required":true,"schema":{"type":"string","title":"Kg Key"},"name":"kg_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSummaryTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/dc_storage_summary/{dc_key}":{"get":{"tags":["System Summary"],"summary":"System Get Dc Storage Summary Async","description":"Get data catalog storage summary.","operationId":"system_get_dc_storage_summary_async","parameters":[{"required":true,"schema":{"type":"string","title":"Dc Key"},"name":"dc_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSummaryTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/summary":{"get":{"tags":["System Summary"],"summary":"System Get Cps Summary","description":"Get cps summary data.","operationId":"system_get_cps_summary","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CPSSummary"},"type":"array","title":"Response System Get Cps Summary"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_flavours_default_quota":{"get":{"tags":["System Quotas"],"summary":"Get Flavours Default Quotas","description":"Get flavours default values.","operationId":"get_flavours_default_quotas","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursDefaultQuota"},"type":"array","title":"Response Get Flavours Default Quotas"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_flavours_default_quota":{"put":{"tags":["System Quotas"],"summary":"Save Flavours Default Quotas","description":"Save flavours default quota.","operationId":"save_flavours_default_quotas","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursDefaultQuota"},"type":"array","title":"Flavours"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursDefaultQuota"},"type":"array","title":"Response Save Flavours Default Quotas"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_projects_flavours_quota":{"get":{"tags":["System Quotas"],"summary":"Get Projects Flavours Quota","description":"Get projects flavours quotas.","operationId":"get_projects_flavours_quota","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectFlavoursQuota"},"type":"array","title":"Response Get Projects Flavours Quota"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_project_flavours_quota":{"put":{"tags":["System Quotas"],"summary":"Save Project Flavours Quota","description":"Save project flavours quota.","operationId":"save_project_flavours_quota","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFlavoursQuota"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_project_flavours_quota/{proj_key}":{"get":{"tags":["System Quotas"],"summary":"Get Project Flavours Quota","description":"Get project flavours quota.","operationId":"get_project_flavours_quota","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursQuota"},"type":"array","title":"Response Get Project Flavours Quota"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_project_flavour_total_kgs/{proj_key}/{flavour_name}":{"get":{"tags":["System Quotas"],"summary":"Get Project Flavour Total Kgs","description":"Gets kg total number by proj_key and flavour_key.","operationId":"get_project_flavour_total_kgs","parameters":[{"required":true,"schema":{"type":"string","title":"Flavour Name"},"name":"flavour_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFlavourTotalKgs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/celery_tasks/{task_id}":{"get":{"tags":["Tasks"],"summary":"Get Project Celery Task","description":"Get a celery task for a project.","operationId":"get_project_celery_task","parameters":[{"required":true,"schema":{"type":"string","title":"Task Id"},"name":"task_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"description":"Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls.","required":false,"schema":{"type":"number","maximum":30.0,"exclusiveMinimum":0.0,"title":"Wait","description":"Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls."},"name":"wait","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/tasks":{"get":{"tags":["Tasks"],"summary":"List Project Tasks","description":"List tasks for a project.","operationId":"list_project_tasks","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","title":"Task Type"},"name":"task_type","in":"query"},{"required":false,"schema":{"type":"integer","title":"Skip","default":0},"name":"skip","in":"query"},{"required":false,"schema":{"type":"integer","title":"Limit","default":50},"name":"limit","in":"query"},{"required":false,"schema":{"type":"string","title":"Sort By","default":"_id"},"name":"sort_by","in":"query"},{"required":false,"schema":{"type":"string","enum":["asc","desc"],"title":"Sort Order","default":"desc"},"name":"sort_order","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TaskContext"},"type":"array","title":"Response List Project Tasks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/tasks/{task_id}":{"get":{"tags":["Tasks"],"summary":"Get Project Task","description":"Get a task for a project.","operationId":"get_project_task","parameters":[{"required":true,"schema":{"type":"string","title":"Task Id"},"name":"task_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskContext"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/tasks/{task_id}/actions/abort":{"post":{"tags":["Tasks"],"summary":"Abort Project Task","description":"Abort a task.","operationId":"abort_project_task","parameters":[{"required":true,"schema":{"type":"string","title":"Task Id"},"name":"task_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/scratch/files":{"get":{"tags":["Upload"],"summary":"List Project Scratch Files","description":"Get temporary files uploaded to a project.","operationId":"list_project_scratch_files","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","title":"Scratch Ids"},"name":"scratch_ids","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectScratchFiles"},"type":"array","title":"Response List Project Scratch Files"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/scratch/files_paginated":{"get":{"tags":["Upload"],"summary":"List Project Scratch Files Paginated","description":"Get paginated list of temporary files uploaded to a project.","operationId":"list_project_scratch_files_paginated","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"integer","title":"Page"},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","title":"Items Per Page","default":20},"name":"items_per_page","in":"query"},{"required":false,"schema":{"type":"string","title":"Search String"},"name":"search_string","in":"query"},{"required":false,"schema":{"type":"integer","title":"Begin Date"},"name":"begin_date","in":"query"},{"required":false,"schema":{"type":"integer","title":"End Date"},"name":"end_date","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectScratchFilesPaginated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/scratch/files/upload/{filename}":{"post":{"tags":["Upload"],"summary":"Create Project Scratch File","description":"Create file pointers for temporary storage.","operationId":"create_project_scratch_file","parameters":[{"required":true,"schema":{"type":"string","title":"Filename"},"name":"filename","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryUploadFileResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}}},"components":{"schemas":{"AssembleMode":{"properties":{"page_elements":{"items":{"type":"string","enum":["H","M","None"]},"type":"array","title":"Page Elements"},"tables":{"items":{"type":"string","enum":["H","M","None"]},"type":"array","title":"Tables"}},"type":"object","required":["page_elements","tables"],"title":"AssembleMode"},"AssembleSettings":{"properties":{"mode":{"$ref":"#/components/schemas/AssembleMode"},"include_incomplete_documents":{"type":"boolean","title":"Include Incomplete Documents"}},"type":"object","required":["mode","include_incomplete_documents"],"title":"AssembleSettings"},"AttachmentUploadData":{"properties":{"attachment_path":{"type":"string","title":"Attachment Path"},"upload_data":{"type":"string","title":"Upload Data"}},"type":"object","required":["attachment_path","upload_data"],"title":"AttachmentUploadData"},"AttachmentUploadRequestBody":{"properties":{"attachment_path":{"type":"string","title":"Attachment Path"},"attachment_key":{"type":"string","title":"Attachment Key","default":"usr_attachments"}},"type":"object","required":["attachment_path"],"title":"AttachmentUploadRequestBody"},"BagFlavourFullData":{"properties":{"backend":{"type":"string","title":"Backend"},"config":{"type":"object","title":"Config"},"default_quota":{"type":"integer","title":"Default Quota","default":0},"description":{"type":"string","title":"Description"},"display_name":{"type":"string","title":"Display Name"},"is_from_deployment":{"type":"boolean","title":"Is From Deployment","default":true},"name":{"type":"string","title":"Name"},"order":{"type":"integer","title":"Order","default":0},"project_specific":{"type":"boolean","title":"Project Specific"}},"type":"object","required":["backend","config","description","display_name","name","project_specific"],"title":"BagFlavourFullData"},"CCSProject":{"properties":{"name":{"type":"string","title":"Name"},"proj_key":{"type":"string","title":"Proj Key"},"collection_name":{"type":"string","title":"Collection Name"}},"type":"object","required":["name","proj_key","collection_name"],"title":"CCSProject"},"CPSPackage":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"package_id":{"type":"string","title":"Package Id"},"type":{"type":"string","enum":["model","dictionary","knowledge_graph","data_catalog","data_flow","bundle"],"title":"Type"}},"type":"object","required":["name","description","package_id","type"],"title":"CPSPackage"},"CPSSummary":{"properties":{"availCpuSlots":{"type":"integer","title":"Availcpuslots"},"availMemSlots":{"type":"integer","title":"Availmemslots"},"availSlots":{"type":"integer","title":"Availslots"},"name":{"type":"string","title":"Name"},"numNodes":{"type":"integer","title":"Numnodes"},"numberKgs":{"type":"integer","title":"Numberkgs"},"runningKgs":{"type":"integer","title":"Runningkgs"},"workersPool":{"type":"string","title":"Workerspool"}},"type":"object","required":["availCpuSlots","availMemSlots","availSlots","name","numNodes","numberKgs","runningKgs","workersPool"],"title":"CPSSummary"},"CollectionMetadataSettings":{"properties":{"description":{"type":"string","title":"Description"},"display_name":{"type":"string","title":"Display Name"},"license":{"type":"string","title":"License"},"source":{"type":"string","title":"Source"},"version":{"type":"string","title":"Version"}},"type":"object","title":"CollectionMetadataSettings"},"ConvertDocumentsRequestBody":{"properties":{"file_url":{"items":{"type":"string"},"type":"array","title":"File Url","description":"List of File's URL to be converted and uploaded to the data index."},"internal_file_url":{"items":{"$ref":"#/components/schemas/InternalUrl"},"type":"array","title":"Internal File Url","description":"List of Internal File's URLs to be converted and uploaded to the data index."},"s3_source":{"allOf":[{"$ref":"#/components/schemas/S3DocumentSource"}],"title":"S3 Source","description":"Coordinates to object store to get files to convert. Can specify which files with object keys."},"upload_to_elastic":{"type":"boolean","title":"Upload To Elastic"},"conversion_settings":{"allOf":[{"$ref":"#/components/schemas/PartialDirectConversionParameters"}],"title":"Conversion Settings","description":"Specify the conversion settings to use."}},"type":"object","title":"ConvertDocumentsRequestBody"},"CpsTask":{"properties":{"task_id":{"type":"string","title":"Task Id"},"task_type":{"type":"string","title":"Task Type"},"task_status":{"type":"string","title":"Task Status"}},"type":"object","required":["task_id","task_type","task_status"],"title":"CpsTask"},"DataFlow":{"properties":{"df_tpl_key":{"type":"string","title":"Df Tpl Key"},"name":{"type":"string","title":"Name"}},"type":"object","required":["df_tpl_key","name"],"title":"DataFlow"},"DataIndexUploadFileSource":{"properties":{"urls":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}],"title":"Urls","description":"List of URLs to be printed to PDF, converted and uploaded to the data index."},"conversion_settings":{"allOf":[{"$ref":"#/components/schemas/PartialDirectConversionParameters"}],"title":"Conversion Settings","description":"Specify the conversion settings to use."}},"type":"object","required":["urls"],"title":"DataIndexUploadFileSource"},"DefaultValues":{"properties":{"ccs_project":{"$ref":"#/components/schemas/CCSProject"},"dataflow":{"$ref":"#/components/schemas/DataFlow"}},"type":"object","required":["ccs_project"],"title":"DefaultValues"},"Deployment":{"properties":{"name":{"type":"string","title":"Name"},"disclaimer":{"type":"string","title":"Disclaimer"},"should_show_warning":{"type":"boolean","title":"Should Show Warning"},"disable_kg_actions":{"type":"boolean","title":"Disable Kg Actions"},"linked_ccs_api":{"type":"object","title":"Linked Ccs Api"}},"type":"object","required":["name","disclaimer","should_show_warning","disable_kg_actions","linked_ccs_api"],"title":"Deployment"},"DirectModelConfig":{"properties":{"type":{"type":"string","title":"Type"},"config":{"type":"object","title":"Config"}},"type":"object","required":["type","config"],"title":"DirectModelConfig","description":"Direct configuration of a model."},"DocumentArtifacts":{"properties":{"document_meta_json":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"document_pdf":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"document_json":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"document_glm_json":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"document_md":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"page_pdfs":{"items":{"$ref":"#/components/schemas/DocumentArtifactsPageItem"},"type":"array","title":"Page Pdfs","default":[]},"page_images":{"items":{"$ref":"#/components/schemas/DocumentArtifactsPageItem"},"type":"array","title":"Page Images","default":[]}},"type":"object","title":"DocumentArtifacts"},"DocumentArtifactsItem":{"properties":{"mime":{"type":"string","title":"Mime"},"path":{"type":"string","title":"Path"},"url":{"type":"string","title":"Url"}},"type":"object","required":["mime","path","url"],"title":"DocumentArtifactsItem"},"DocumentArtifactsPageItem":{"properties":{"mime":{"type":"string","title":"Mime"},"path":{"type":"string","title":"Path"},"url":{"type":"string","title":"Url"},"page":{"type":"integer","title":"Page","description":"Page number starting at 1."}},"type":"object","required":["mime","path","url","page"],"title":"DocumentArtifactsPageItem"},"DocumentStatistics":{"properties":{"total_documents":{"type":"integer","title":"Total Documents"},"documents_pending":{"type":"integer","title":"Documents Pending"},"documents_failed":{"type":"integer","title":"Documents Failed"},"documents_converted":{"type":"integer","title":"Documents Converted"}},"type":"object","required":["total_documents","documents_pending","documents_failed","documents_converted"],"title":"DocumentStatistics"},"ElasticIndexPropertyObject":{"properties":{"type":{"type":"string","title":"Type"},"enabled":{"type":"boolean","title":"Enabled"},"ignore_above":{"type":"integer","title":"Ignore Above"}},"type":"object","required":["type"],"title":"ElasticIndexPropertyObject"},"ElasticIndexPropertyPrimitive":{"properties":{"properties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/ElasticIndexPropertyPrimitive"},{"$ref":"#/components/schemas/ElasticIndexPropertyObject"}]},"type":"object","title":"Properties"}},"type":"object","required":["properties"],"title":"ElasticIndexPropertyPrimitive"},"ElasticIndexSearchQueryOptions":{"properties":{"_source":{"items":{"type":"string"},"type":"array","title":" Source"},"from_":{"type":"integer","title":"From "},"size":{"type":"integer","title":"Size"},"query":{"type":"object","title":"Query"},"aggs":{"type":"object","title":"Aggs"},"sort":{"items":{"type":"object"},"type":"array","title":"Sort"}},"type":"object","title":"ElasticIndexSearchQueryOptions"},"ElasticIndexSource":{"properties":{"index_key":{"type":"string","title":"Index Key"},"elastic_id":{"type":"string","title":"Elastic Id"}},"type":"object","required":["index_key","elastic_id"],"title":"ElasticIndexSource"},"ElasticInstanceDataIndex":{"properties":{"index_key":{"type":"string","title":"Index Key"},"query_options":{"$ref":"#/components/schemas/ElasticIndexSearchQueryOptions"},"elastic_id":{"type":"string","title":"Elastic Id"}},"type":"object","required":["index_key","query_options","elastic_id"],"title":"ElasticInstanceDataIndex"},"ElasticMetadata":{"properties":{"aliases":{"items":{"type":"string"},"type":"array","title":"Aliases"},"created":{"type":"string","title":"Created"},"description":{"type":"string","title":"Description"},"display_name":{"type":"string","title":"Display Name"},"source":{"type":"string","title":"Source"},"storage":{"type":"string","title":"Storage"},"version":{"type":"string","title":"Version"},"type":{"type":"string","title":"Type"},"domain":{"items":{"type":"string"},"type":"array","title":"Domain"},"classification":{"items":{"type":"string"},"type":"array","title":"Classification"}},"type":"object","required":["classification"],"title":"ElasticMetadata"},"Flavour":{"properties":{"name":{"type":"string","title":"Name"},"display_name":{"type":"string","title":"Display Name"}},"type":"object","required":["name"],"title":"Flavour"},"FlavoursDefaultQuota":{"properties":{"display_name":{"type":"string","title":"Display Name"},"name":{"type":"string","title":"Name"},"default_quota":{"type":"integer","title":"Default Quota"}},"type":"object","required":["display_name","name","default_quota"],"title":"FlavoursDefaultQuota"},"FlavoursQuota":{"properties":{"display_name":{"type":"string","title":"Display Name"},"name":{"type":"string","title":"Name"},"quota":{"type":"integer","title":"Quota"}},"type":"object","required":["display_name","name","quota"],"title":"FlavoursQuota"},"GenAIAWSBedrock":{"properties":{"kind":{"type":"string","enum":["aws_bedrock"],"title":"Kind","default":"aws_bedrock"},"config":{"$ref":"#/components/schemas/GenAIAWSBedrockConfig"},"proj_params":{"$ref":"#/components/schemas/GenAIPartialParams"}},"type":"object","required":["config"],"title":"GenAIAWSBedrock","description":"GenAI integration for AWS Bedrock settings"},"GenAIAWSBedrockConfig":{"properties":{"GENAI_AWS_ACCESS_KEY":{"type":"string","format":"password","title":"Genai Aws Access Key","writeOnly":true},"GENAI_AWS_SECRET_KEY":{"type":"string","format":"password","title":"Genai Aws Secret Key","writeOnly":true},"GENAI_AWS_REGION_NAME":{"type":"string","title":"Genai Aws Region Name"}},"type":"object","required":["GENAI_AWS_ACCESS_KEY","GENAI_AWS_SECRET_KEY","GENAI_AWS_REGION_NAME"],"title":"GenAIAWSBedrockConfig","description":"Config for AWS Bedrock"},"GenAIBAM":{"properties":{"kind":{"type":"string","enum":["bam"],"title":"Kind","default":"bam"},"config":{"$ref":"#/components/schemas/GenAIBAMConfig"},"proj_params":{"$ref":"#/components/schemas/GenAIPartialParams"}},"type":"object","required":["config"],"title":"GenAIBAM","description":"GenAI integration for BAM settings"},"GenAIBAMConfig":{"properties":{"GENAI_API":{"type":"string","title":"Genai Api"},"GENAI_KEY":{"type":"string","format":"password","title":"Genai Key","writeOnly":true}},"type":"object","required":["GENAI_API","GENAI_KEY"],"title":"GenAIBAMConfig","description":"Config for BAM"},"GenAIHFInferenceApi":{"properties":{"kind":{"type":"string","enum":["hf_api"],"title":"Kind","default":"hf_api"},"config":{"$ref":"#/components/schemas/GenAIHFInferenceApiConfig"},"proj_params":{"$ref":"#/components/schemas/GenAIPartialParams"}},"type":"object","required":["config"],"title":"GenAIHFInferenceApi","description":"GenAI integration for Inference API settings"},"GenAIHFInferenceApiConfig":{"properties":{"GENAI_HF_API_KEY":{"type":"string","format":"password","title":"Genai Hf Api Key","writeOnly":true}},"type":"object","required":["GENAI_HF_API_KEY"],"title":"GenAIHFInferenceApiConfig","description":"Config for HF Inference API"},"GenAIParams":{"properties":{"model_id":{"type":"string","title":"Model Id"},"prompt_template":{"type":"string","title":"Prompt Template"},"params":{"type":"object","title":"Params"}},"type":"object","required":["model_id","prompt_template","params"],"title":"GenAIParams"},"GenAIPartialParams":{"properties":{"model_id":{"type":"string","title":"Model Id"},"prompt_template":{"type":"string","title":"Prompt Template"},"params":{"type":"object","title":"Params"}},"type":"object","title":"GenAIPartialParams"},"GenAIWatsonx":{"properties":{"kind":{"type":"string","enum":["watsonx"],"title":"Kind","default":"watsonx"},"config":{"$ref":"#/components/schemas/GenAIWatsonxConfig"},"proj_params":{"$ref":"#/components/schemas/GenAIPartialParams"}},"type":"object","required":["config"],"title":"GenAIWatsonx","description":"GenAI integration for watsonx settings"},"GenAIWatsonxConfig":{"properties":{"GENAI_API":{"type":"string","title":"Genai Api"},"GENAI_PROJECT_ID":{"type":"string","title":"Genai Project Id"},"GENAI_KEY":{"type":"string","format":"password","title":"Genai Key","writeOnly":true}},"type":"object","required":["GENAI_API","GENAI_PROJECT_ID","GENAI_KEY"],"title":"GenAIWatsonxConfig","description":"Config for watsonx"},"GroupedProjectDocuments":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/ProjectDocument"},"type":"array","title":"Documents"},"upload_date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"title":"Upload Date"}},"type":"object","required":["documents","upload_date"],"title":"GroupedProjectDocuments"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InternalUrl":{"properties":{"download_url":{"type":"string","title":"Download Url"},"header_url":{"type":"string","title":"Header Url"}},"type":"object","required":["download_url","header_url"],"title":"InternalUrl"},"JsonUploadRequestBody":{"properties":{"file_url":{"type":"string","title":"File Url"}},"type":"object","required":["file_url"],"title":"JsonUploadRequestBody"},"ListProjectFlavours":{"properties":{"flavours":{"items":{"$ref":"#/components/schemas/BagFlavourFullData"},"type":"array","title":"Flavours"},"proj_key":{"type":"string","title":"Proj Key"}},"type":"object","required":["flavours","proj_key"],"title":"ListProjectFlavours"},"ModelPipelineSettings":{"properties":{"clusters":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Clusters"},"page":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Page"},"tables":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Tables"},"normalization":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Normalization"}},"type":"object","required":["clusters","page","tables","normalization"],"title":"ModelPipelineSettings"},"ModulesConfig":{"properties":{"df_template_variables":{"items":{},"type":"array","title":"Df Template Variables"},"linked_ccs_instances":{"items":{},"type":"array","title":"Linked Ccs Instances"},"linked_elastic_instances":{"items":{},"type":"array","title":"Linked Elastic Instances"}},"type":"object","required":["df_template_variables","linked_ccs_instances","linked_elastic_instances"],"title":"ModulesConfig"},"OcrSettings":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false},"backend":{"type":"string","title":"Backend"},"backend_settings":{"type":"object","title":"Backend Settings"},"merge_mode":{"type":"string","title":"Merge Mode"}},"type":"object","title":"OcrSettings"},"Package":{"properties":{"overrides":{"type":"object","title":"Overrides"},"package_id":{"type":"string","title":"Package Id"}},"type":"object","required":["overrides","package_id"],"title":"Package"},"PartialDirectConversionParameters":{"properties":{"type":{"type":"string","enum":["direct"],"title":"Type","default":"direct"},"ocr":{"$ref":"#/components/schemas/OcrSettings"},"assemble":{"$ref":"#/components/schemas/AssembleSettings"},"metadata":{"$ref":"#/components/schemas/CollectionMetadataSettings"},"page_labels":{"additionalProperties":{"type":"object"},"type":"object","title":"Page Labels"},"model_pipeline":{"$ref":"#/components/schemas/ModelPipelineSettings"}},"type":"object","title":"PartialDirectConversionParameters","description":"Specify conversion settings (OCR, Assemble, ML Models) directly.\n\nFields left null are set to platform defaults."},"ProjectAgent":{"properties":{"agent_info":{"type":"object","title":"Agent Info"},"agent_name":{"type":"string","title":"Agent Name"},"version":{"type":"string","title":"Version"}},"type":"object","required":["agent_info","agent_name","version"],"title":"ProjectAgent"},"ProjectAgents":{"properties":{"agents":{"items":{"$ref":"#/components/schemas/ProjectAgent"},"type":"array","title":"Agents"}},"type":"object","required":["agents"],"title":"ProjectAgents"},"ProjectDataIndexNonView":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"schema_key":{"type":"string","enum":["deepsearch-doc","deepsearch-db","generic"],"title":"Schema Key","default":"generic"}},"type":"object","required":["name"],"title":"ProjectDataIndexNonView"},"ProjectDataIndexSource":{"properties":{"index_key":{"type":"string","title":"Index Key"},"proj_key":{"type":"string","title":"Proj Key"}},"type":"object","required":["index_key","proj_key"],"title":"ProjectDataIndexSource"},"ProjectDataIndexView":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"view_of":{"anyOf":[{"$ref":"#/components/schemas/ProjectSourceDataIndex"},{"$ref":"#/components/schemas/ElasticInstanceDataIndex"}],"title":"View Of"}},"type":"object","required":["name","view_of"],"title":"ProjectDataIndexView"},"ProjectDataIndexWithStatus":{"properties":{"source":{"anyOf":[{"$ref":"#/components/schemas/ElasticIndexSource"},{"$ref":"#/components/schemas/ProjectDataIndexSource"}],"title":"Source"},"name":{"type":"string","title":"Name"},"documents":{"type":"integer","title":"Documents"},"health":{"type":"string","title":"Health"},"status":{"type":"string","title":"Status"},"creation_date":{"type":"string","title":"Creation Date"},"metadata":{"$ref":"#/components/schemas/ElasticMetadata"},"description":{"type":"string","title":"Description"},"schema_key":{"type":"string","enum":["deepsearch-doc","deepsearch-db","generic"],"title":"Schema Key"},"type":{"type":"string","title":"Type"},"view_of":{"anyOf":[{"$ref":"#/components/schemas/ProjectSourceDataIndex"},{"$ref":"#/components/schemas/ElasticInstanceDataIndex"}],"title":"View Of"},"record_properties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/ElasticIndexPropertyPrimitive"},{"$ref":"#/components/schemas/ElasticIndexPropertyObject"}]},"type":"object","title":"Record Properties"},"provenance":{"type":"string","title":"Provenance"}},"type":"object","required":["source","name","documents","health","status","creation_date","description","type"],"title":"ProjectDataIndexWithStatus"},"ProjectDocument":{"properties":{"document_hash":{"type":"string","title":"Document Hash"},"filename":{"type":"string","title":"Filename"},"file_uri":{"type":"string","title":"File Uri"},"ref_uri":{"type":"string","title":"Ref Uri"},"number_pages":{"type":"integer","title":"Number Pages"},"status":{"type":"string","title":"Status"}},"type":"object","required":["document_hash","filename"],"title":"ProjectDocument"},"ProjectDocumentURL":{"properties":{"download_url":{"type":"string","title":"Download Url"}},"type":"object","required":["download_url"],"title":"ProjectDocumentURL"},"ProjectDocuments":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/ProjectDocument"},"type":"array","title":"Documents"}},"type":"object","required":["documents"],"title":"ProjectDocuments"},"ProjectFlavourTotalKgs":{"properties":{"proj_key":{"type":"string","title":"Proj Key"},"flavour_name":{"type":"string","title":"Flavour Name"},"total_kgs":{"type":"integer","title":"Total Kgs"}},"type":"object","required":["proj_key","flavour_name","total_kgs"],"title":"ProjectFlavourTotalKgs"},"ProjectFlavoursQuota":{"properties":{"name":{"type":"string","title":"Name"},"proj_key":{"type":"string","title":"Proj Key"},"quotas":{"items":{"$ref":"#/components/schemas/FlavoursQuota"},"type":"array","title":"Quotas"}},"type":"object","required":["name","proj_key","quotas"],"title":"ProjectFlavoursQuota"},"ProjectPackageInstalationManifest":{"properties":{"packages":{"items":{"$ref":"#/components/schemas/Package"},"type":"array","title":"Packages"}},"type":"object","required":["packages"],"title":"ProjectPackageInstalationManifest"},"ProjectScratchFiles":{"properties":{"id":{"type":"string","title":"Id"},"proj_key":{"type":"string","title":"Proj Key"},"user_key":{"type":"string","title":"User Key"},"filename":{"type":"string","title":"Filename"},"timestamp":{"type":"string","title":"Timestamp"},"url":{"type":"string","title":"Url"}},"type":"object","required":["id","proj_key","user_key","filename","timestamp","url"],"title":"ProjectScratchFiles"},"ProjectScratchFilesPaginated":{"properties":{"files":{"items":{"$ref":"#/components/schemas/ProjectScratchFiles"},"type":"array","title":"Files"},"count":{"type":"integer","title":"Count"},"page":{"type":"integer","title":"Page"},"items_per_page":{"type":"integer","title":"Items Per Page"}},"type":"object","required":["files","count","page","items_per_page"],"title":"ProjectScratchFilesPaginated"},"ProjectSourceDataIndex":{"properties":{"index_key":{"type":"string","title":"Index Key"},"query_options":{"$ref":"#/components/schemas/ElasticIndexSearchQueryOptions"},"proj_key":{"type":"string","title":"Proj Key"}},"type":"object","required":["index_key","query_options","proj_key"],"title":"ProjectSourceDataIndex"},"ProjectsFlavours":{"properties":{"proj_key":{"type":"string","title":"Proj Key"},"name":{"type":"string","title":"Name"},"flavours":{"items":{"$ref":"#/components/schemas/Flavour"},"type":"array","title":"Flavours"}},"type":"object","required":["proj_key","name","flavours"],"title":"ProjectsFlavours"},"ReferenceToModel":{"properties":{"model_config_key":{"type":"string","title":"Model Config Key"},"proj_key":{"type":"string","title":"Proj Key"},"name":{"type":"string","title":"Name","default":""},"description":{"type":"string","title":"Description","default":""}},"type":"object","required":["model_config_key","proj_key"],"title":"ReferenceToModel","description":"Reference to a model configuration."},"ResponseDocumentArtifacts":{"properties":{"artifacts":{"$ref":"#/components/schemas/DocumentArtifacts"}},"type":"object","required":["artifacts"],"title":"ResponseDocumentArtifacts"},"ResponseGroupedDocuments":{"properties":{"grouped_documents":{"items":{"$ref":"#/components/schemas/GroupedProjectDocuments"},"type":"array","title":"Grouped Documents"}},"type":"object","required":["grouped_documents"],"title":"ResponseGroupedDocuments"},"ResponseUploadJobs":{"properties":{"upload_jobs":{"items":{"$ref":"#/components/schemas/UploadJob"},"type":"array","title":"Upload Jobs"}},"type":"object","required":["upload_jobs"],"title":"ResponseUploadJobs"},"S3Coordinates":{"properties":{"host":{"type":"string","title":"Host"},"port":{"type":"integer","title":"Port"},"ssl":{"type":"boolean","title":"Ssl"},"verifySSL":{"type":"boolean","title":"Verifyssl"},"access-key":{"type":"string","title":"Access-Key"},"secret-key":{"type":"string","title":"Secret-Key"},"bucket":{"type":"string","title":"Bucket"},"key_prefix":{"type":"string","title":"Key Prefix"},"location":{"type":"string","title":"Location"}},"type":"object","required":["host","port","ssl","verifySSL","access-key","secret-key","bucket","location"],"title":"S3Coordinates"},"S3DocumentSource":{"properties":{"coordinates":{"$ref":"#/components/schemas/S3Coordinates"},"object_keys":{"items":{"type":"string"},"type":"array","title":"Object Keys","description":"List of s3 object keys to retrieve from bucket to be converted and uploaded to the data index."}},"type":"object","required":["coordinates"],"title":"S3DocumentSource","description":"Specifies documents to import from an S3 bucket"},"SemanticIngestReqParams":{"properties":{"skip_ingested_docs":{"type":"boolean","title":"Skip Ingested Docs"}},"type":"object","required":["skip_ingested_docs"],"title":"SemanticIngestReqParams"},"SemanticIngestRequest":{"properties":{"source":{"anyOf":[{"$ref":"#/components/schemas/SemanticIngestSourceUrl"},{"$ref":"#/components/schemas/SemanticIngestSourcePublicDataDocument"},{"$ref":"#/components/schemas/SemanticIngestSourcePrivateDataDocument"},{"$ref":"#/components/schemas/SemanticIngestSourcePrivateDataCollection"}],"title":"Source"},"parameters":{"$ref":"#/components/schemas/SemanticIngestReqParams"}},"type":"object","required":["source","parameters"],"title":"SemanticIngestRequest"},"SemanticIngestSourcePrivateDataCollection":{"properties":{"type":{"type":"string","enum":["private_data_collection"],"title":"Type"},"proj_key":{"type":"string","title":"Proj Key"},"index_key":{"type":"string","title":"Index Key"}},"type":"object","required":["type","proj_key","index_key"],"title":"SemanticIngestSourcePrivateDataCollection"},"SemanticIngestSourcePrivateDataDocument":{"properties":{"type":{"type":"string","enum":["private_data_document"],"title":"Type"},"proj_key":{"type":"string","title":"Proj Key"},"index_key":{"type":"string","title":"Index Key"},"document_hash":{"type":"string","title":"Document Hash"}},"type":"object","required":["type","proj_key","index_key","document_hash"],"title":"SemanticIngestSourcePrivateDataDocument"},"SemanticIngestSourcePublicDataDocument":{"properties":{"type":{"type":"string","enum":["public_data_document"],"title":"Type"},"elastic_id":{"type":"string","title":"Elastic Id"},"index_key":{"type":"string","title":"Index Key"},"document_hash":{"type":"string","title":"Document Hash"}},"type":"object","required":["type","elastic_id","index_key","document_hash"],"title":"SemanticIngestSourcePublicDataDocument"},"SemanticIngestSourceUrl":{"properties":{"type":{"type":"string","enum":["url"],"title":"Type"},"url":{"type":"string","title":"Url"}},"type":"object","required":["type","url"],"title":"SemanticIngestSourceUrl"},"StorageSummaryTask":{"properties":{"dc_key":{"type":"string","title":"Dc Key"},"kg_key":{"type":"string","title":"Kg Key"},"kind":{"type":"string","enum":["project_task","celery_task"],"title":"Kind"},"proj_key":{"type":"string","title":"Proj Key"},"task_id":{"type":"string","title":"Task Id"}},"type":"object","required":["kind","proj_key","task_id"],"title":"StorageSummaryTask"},"SystemInfo":{"properties":{"notifications":{"items":{},"type":"array","title":"Notifications"},"default_project":{"type":"object","title":"Default Project"},"deployment":{"$ref":"#/components/schemas/Deployment"},"toolkit":{"type":"object","title":"Toolkit"},"allow_non_admins_to_make_resources_public":{"type":"boolean","title":"Allow Non Admins To Make Resources Public"},"api":{"type":"object","title":"Api"},"genai_defaults":{"additionalProperties":{"$ref":"#/components/schemas/GenAIParams"},"type":"object","title":"Genai Defaults"}},"type":"object","required":["notifications","default_project","deployment","toolkit","allow_non_admins_to_make_resources_public","api","genai_defaults"],"title":"SystemInfo"},"TaskContext":{"properties":{"proj_key":{"type":"string","title":"Proj Key"},"user_key":{"type":"string","title":"User Key"},"task_type":{"type":"string","title":"Task Type"},"task_id":{"type":"string","title":"Task Id"},"task_status":{"type":"string","title":"Task Status"},"execution_mode":{"type":"string","title":"Execution Mode"},"progress":{"type":"number","title":"Progress"},"meta":{"type":"object","title":"Meta"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"started_at":{"type":"string","format":"date-time","title":"Started At"},"completed_at":{"type":"string","format":"date-time","title":"Completed At"},"start_count":{"type":"integer","title":"Start Count"},"error_reason":{"type":"string","title":"Error Reason"},"related_tasks":{"items":{},"type":"array","title":"Related Tasks"}},"type":"object","required":["proj_key","user_key","task_type","task_id","task_status","execution_mode","progress","meta","created_at"],"title":"TaskContext"},"TaskResult":{"properties":{"result":{"title":"Result"},"task_id":{"type":"string","title":"Task Id"},"task_status":{"type":"string","title":"Task Status"}},"type":"object","required":["task_id","task_status"],"title":"TaskResult"},"TemporaryUploadFileResult":{"properties":{"id":{"type":"string","title":"Id"},"upload":{"$ref":"#/components/schemas/TemporaryUrlFields"},"download":{"$ref":"#/components/schemas/TemporaryUrl"},"metadata":{"$ref":"#/components/schemas/TemporaryUrl"},"upload_private":{"$ref":"#/components/schemas/TemporaryUrlFields"},"download_private":{"$ref":"#/components/schemas/TemporaryUrl"},"metadata_private":{"$ref":"#/components/schemas/TemporaryUrl"}},"type":"object","required":["id","upload","download","metadata","upload_private","download_private","metadata_private"],"title":"TemporaryUploadFileResult"},"TemporaryUrl":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"TemporaryUrl"},"TemporaryUrlFields":{"properties":{"url":{"type":"string","title":"Url"},"fields":{"type":"object","title":"Fields"}},"type":"object","required":["url","fields"],"title":"TemporaryUrlFields"},"TokenResponse":{"properties":{"token":{"type":"string","title":"Token"}},"type":"object","required":["token"],"title":"TokenResponse"},"UploadJob":{"properties":{"date":{"type":"string","format":"date-time","title":"Date"},"num_docs":{"type":"integer","title":"Num Docs"}},"type":"object","required":["date","num_docs"],"title":"UploadJob"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"Bearer":{"type":"apiKey","description":"Provide a Bearer token in the `Authorization` header","in":"header","name":"Authorization"}}}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Deep Search (DS) API","description":"API for Deep Search.\n\n**WARNING**: This API is subject to change without warning!","version":"3.0.0"},"servers":[{"url":"/api/cps/public/v2"}],"paths":{"/project/{proj_key}/data_indices/documents/agents":{"get":{"tags":["Content Manager"],"summary":"Get Project Agents","description":"Get project agents.","operationId":"get_project_agents","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectAgents"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/transactions/{transaction_id}":{"get":{"tags":["Content Manager"],"summary":"Get Project Documents By Transaction","description":"Get project documents by transaction ID.","operationId":"get_project_documents_by_transaction","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","format":"uuid","title":"Transaction Id"},"name":"transaction_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/":{"get":{"tags":["Content Manager"],"summary":"Get All Project Data Index Documents","description":"Get all project documents","operationId":"get_all_project_data_index_documents","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"integer","title":"Page","default":1},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page Size","default":25},"name":"page_size","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/statistics":{"get":{"tags":["Content Manager"],"summary":"Get Project Conversion Statistics","description":"Get project conversion statistics.","operationId":"get_project_conversion_statistics","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentStatistics"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/agent/{agent_name}":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Documents","description":"Get project documents, can be filter by status.","operationId":"get_project_data_index_documents","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Agent Name"},"name":"agent_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"],"title":"Status"},"name":"status","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page","default":1},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page Size","default":25},"name":"page_size","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/agent/{agent_name}/grouped":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Grouped Documents","description":"Get project documents grouped by upload.","operationId":"get_project_data_index_grouped_documents","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Agent Name"},"name":"agent_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"],"title":"Status"},"name":"status","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page","default":1},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page Size","default":25},"name":"page_size","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGroupedDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/upload_jobs":{"get":{"tags":["Content Manager"],"summary":"Get Project Index Upload Jobs","description":"Get project upload jobs.","operationId":"get_project_index_upload_jobs","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseUploadJobs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/Markdown":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Markdown","description":"Get project document Markdown.","operationId":"get_project_data_index_document_markdown","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocumentURL"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/PDF":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Pdf Document","description":"Get project PDF document.","operationId":"get_project_data_index_pdf_document","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocumentURL"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/JSON":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Json Document","description":"Get project JSON document.","operationId":"get_project_data_index_json_document","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Project Data Index Json Document"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/artifacts":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Artifacts","description":"Get project document artifacts.","operationId":"get_project_data_index_document_artifacts","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDocumentArtifacts"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/metadata":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Metadata","description":"Get project document metadata.","operationId":"get_project_data_index_document_metadata","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/doc_events":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Events","description":"Get events of a project document.","operationId":"get_project_data_index_document_events","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","title":"Agent Name"},"name":"agent_name","in":"query"},{"required":false,"schema":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"],"title":"Status"},"name":"status","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Project Data Index Document Events"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices":{"get":{"tags":["Data Indices"],"summary":"Get Project Data Indices","description":"Get project data indices.","operationId":"get_project_data_indices","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"},"type":"array","title":"Response Get Project Data Indices"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Data Indices"],"summary":"Create Project Data Index","description":"Create a project data index.","operationId":"create_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProjectDataIndexView"},{"$ref":"#/components/schemas/ProjectDataIndexNonView"}],"title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}":{"get":{"tags":["Data Indices"],"summary":"Get Project Data Index","description":"Get project data index.","operationId":"get_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Data Indices"],"summary":"Delete Project Data Index","description":"Delete a project index data.","operationId":"delete_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Confirmation Token"},"name":"confirmation_token","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"patch":{"tags":["Data Indices"],"summary":"Update Project Data Index","description":"Update a project data index.","operationId":"update_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProjectDataIndexView"},{"$ref":"#/components/schemas/ProjectDataIndexNonView"}],"title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/delete_token":{"post":{"tags":["Data Indices"],"summary":"Create Project Data Index Delete Token","description":"Get a token used to confirm the deletion of a project data index.","operationId":"create_project_data_index_delete_token","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/upload":{"post":{"tags":["Data Indices Upload"],"summary":"Upload Project Data Index File","description":"Upload a file to a project data index.","operationId":"upload_project_data_index_file","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonUploadRequestBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/upload_register_documents":{"post":{"tags":["Data Indices Upload"],"summary":"Upload Register Project Documents","description":"Upload and register documents to be converted later.","operationId":"upload_register_project_documents","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertDocumentsSources"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/load_elastic":{"post":{"tags":["Data Indices Upload"],"summary":"Load Project Data Index Files Elastic","description":"Load file(s) in a project data index to elastic.","operationId":"load_project_data_index_files_elastic","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadElasticRequestBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert":{"post":{"tags":["Data Indices Upload"],"summary":"Ccs Convert File Project Data Index","description":"Convert files via CCS previously registered and in a project data index.","operationId":"ccs_convert_file_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertDocumentsRequestBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload":{"post":{"tags":["Data Indices Upload"],"summary":"Ccs Convert Upload File Project Data Index","description":"Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema).","operationId":"ccs_convert_upload_file_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertUploadDocumentsRequestBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload":{"post":{"tags":["Data Indices Upload"],"summary":"Html Print Convert Upload","description":"Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema).","operationId":"html_print_convert_upload","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataIndexUploadFileSource"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename}":{"get":{"tags":["Data Indices Upload"],"summary":"Get Attachment Upload Data","description":"Get url and path to upload an attachment to a project data index.","operationId":"get_attachment_upload_data","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Index Item Id"},"name":"index_item_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Filename"},"name":"filename","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentUploadData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment":{"post":{"tags":["Data Indices Upload"],"summary":"Register Attachment","description":"Notify upload completion of an attachment to a project data index.","operationId":"register_attachment","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Index Item Id"},"name":"index_item_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentUploadRequestBody"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/public/bags":{"get":{"tags":["Knowledge Graphs"],"summary":"List Public Knowledge Graphs","description":"List all public BAGs","operationId":"list_public_knowledge_graphs","parameters":[{"required":false,"schema":{"title":"Term"},"name":"term","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array","title":"Response List Public Knowledge Graphs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/backend/project/{proj_key}/bags":{"get":{"tags":["Knowledge Graphs"],"summary":"Backend List Project Kgs","description":"List all bags in the project, backend-aware","operationId":"backend_list_project_kgs","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"title":"Term"},"name":"term","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array","title":"Response Backend List Project Kgs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Knowledge Graphs"],"summary":"Create Project Knowledge Graph","description":"Create new BAG, backend-aware","operationId":"create_project_knowledge_graph","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Create Project Knowledge Graph"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/backend/project/{proj_key}/bags/{bag_key}":{"patch":{"tags":["Knowledge Graphs"],"summary":"Update Project Knowledge Graph Metadata","description":"Update the metadata of a Knowledge graph","operationId":"update_project_knowledge_graph_metadata","parameters":[{"required":true,"schema":{"title":"Bag Key"},"name":"bag_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Update Project Knowledge Graph Metadata"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/default_values":{"get":{"tags":["Project"],"summary":"Get Project Default Values","description":"List project's default values.","operationId":"get_project_default_values","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValues"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Project"],"summary":"Update Project Default Values","description":"Update project's default values.","operationId":"update_project_default_values","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValues"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/integrations/genai":{"get":{"tags":["Project"],"summary":"Get Project Integration Config Genai","description":"Get the GenAI config for a given project.","operationId":"get_project_integration_config_genai","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"boolean","title":"Decode Secrets"},"name":"decode_secrets","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/GenAIBAM"},{"$ref":"#/components/schemas/GenAIWatsonx"},{"$ref":"#/components/schemas/GenAIHFInferenceApi"},{"$ref":"#/components/schemas/GenAIAWSBedrock"}],"title":"Response Get Project Integration Config Genai"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Project"],"summary":"Update Project Integration Config Genai","description":"Update the GenAI config for a given project.","operationId":"update_project_integration_config_genai","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/GenAIBAM"},{"$ref":"#/components/schemas/GenAIWatsonx"},{"$ref":"#/components/schemas/GenAIHFInferenceApi"},{"$ref":"#/components/schemas/GenAIAWSBedrock"}],"title":"Config"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Project"],"summary":"Delete Project Integration Config Genai","description":"Delete the GenAI config for a given project integration.","operationId":"delete_project_integration_config_genai","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/packages":{"post":{"tags":["Project"],"summary":"Provision Project Packages","description":"Install packages on a project.","operationId":"provision_project_packages","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectPackageInstalationManifest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskContext"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/convert":{"post":{"tags":["Project"],"summary":"Convert Pdf Document","description":"Convert a PDF document directly to CCS.","operationId":"convert_pdf_document","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertDocumentRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CcsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/convert_tasks/{task_id}":{"get":{"tags":["Project"],"summary":"Check Wait Ccs Task Task","description":"Check status of a CCS conversion task.","operationId":"check_wait_ccs_task_task","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Task Id"},"name":"task_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"description":"Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls.","required":false,"schema":{"type":"number","maximum":30.0,"exclusiveMinimum":0.0,"title":"Wait","description":"Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls."},"name":"wait","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/semantic/ingest":{"post":{"tags":["Semantic"],"summary":"Ingest","description":"Ingest documents and collections for RAG","operationId":"ingest","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SemanticIngestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/info":{"get":{"tags":["System"],"summary":"Get System Information","description":"Get system info.","operationId":"get_system_information","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemInfo"}}}}}}},"/system/modules/configuration":{"get":{"tags":["System"],"summary":"Get System Modules Configuration","description":"Get modules configuration.","operationId":"get_system_modules_configuration","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModulesConfig"}}}}}}},"/system/modules/tasks":{"get":{"tags":["System"],"summary":"Get System Modules Tasks","description":"Get modules configuration.","operationId":"get_system_modules_tasks","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get System Modules Tasks"}}}}}}},"/system/kgs":{"get":{"tags":["System"],"summary":"List System Knowledge Graphs","description":"List all Knowledge Graphs in the system.","operationId":"list_system_knowledge_graphs","parameters":[{"required":false,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"query"},{"required":false,"schema":{"type":"string","title":"Term"},"name":"term","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{},"type":"array","title":"Response List System Knowledge Graphs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_all_kgs":{"get":{"tags":["System"],"summary":"System Get All Kgs Admin","description":"Get all kgs (only bag_key) for admin use.","operationId":"system_get_all_kgs_admin","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{},"type":"array","title":"Response System Get All Kgs Admin"}}}}},"security":[{"Bearer":[]}]}},"/system/packages":{"get":{"tags":["System"],"summary":"List Packages","description":"Get packages available in this CPS installation for installing in a project.","operationId":"list_packages","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CPSPackage"},"type":"array","title":"Response List Packages"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_all_dcs":{"get":{"tags":["System"],"summary":"System Get All Dcs Admin","description":"Get all data catalogs (only dc_key) for admin use.","operationId":"system_get_all_dcs_admin","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Response System Get All Dcs Admin"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/list_all_flavours":{"get":{"tags":["System Flavours"],"summary":"List All Flavours","description":"Get all KG flavours storage on db.","operationId":"list_all_flavours","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BagFlavourFullData"},"type":"array","title":"Response List All Flavours"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_flavour/{flavour_name}":{"get":{"tags":["System Flavours"],"summary":"Get Flavour","description":"Get flavour from db.","operationId":"get_flavour","parameters":[{"required":true,"schema":{"type":"string","title":"Flavour Name"},"name":"flavour_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BagFlavourFullData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_flavour":{"put":{"tags":["System Flavours"],"summary":"Save Flavour","description":"Save flavour on db.","operationId":"save_flavour","parameters":[{"required":true,"schema":{"type":"boolean","title":"New Flavour"},"name":"new_flavour","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BagFlavourFullData"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/delete_flavour/{flavour_name}":{"delete":{"tags":["System Flavours"],"summary":"Delete Flavour","description":"Delete flavour from db.","operationId":"delete_flavour","parameters":[{"required":true,"schema":{"type":"string","title":"Flavour Name"},"name":"flavour_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/list_projects_flavours":{"get":{"tags":["System Flavours"],"summary":"List Projects Flavours","description":"Get all projects and their flavours.","operationId":"list_projects_flavours","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectsFlavours"},"type":"array","title":"Response List Projects Flavours"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_project_flavours":{"put":{"tags":["System Flavours"],"summary":"Save Project Flavours","description":"Save project flavours assignment on db.","operationId":"save_project_flavours","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectsFlavours"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_project_flavours/{proj_key}":{"get":{"tags":["System Flavours"],"summary":"List Flavours By Project","description":"Get project assignment flavours.","operationId":"list_flavours_by_project","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectFlavours"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/kg_storage_summary/{kg_key}":{"get":{"tags":["System Summary"],"summary":"System Get Kg Storage Summary Async","description":"Get knowledge graph storage summary.","operationId":"system_get_kg_storage_summary_async","parameters":[{"required":true,"schema":{"type":"string","title":"Kg Key"},"name":"kg_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSummaryTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/dc_storage_summary/{dc_key}":{"get":{"tags":["System Summary"],"summary":"System Get Dc Storage Summary Async","description":"Get data catalog storage summary.","operationId":"system_get_dc_storage_summary_async","parameters":[{"required":true,"schema":{"type":"string","title":"Dc Key"},"name":"dc_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSummaryTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/summary":{"get":{"tags":["System Summary"],"summary":"System Get Cps Summary","description":"Get cps summary data.","operationId":"system_get_cps_summary","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CPSSummary"},"type":"array","title":"Response System Get Cps Summary"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_flavours_default_quota":{"get":{"tags":["System Quotas"],"summary":"Get Flavours Default Quotas","description":"Get flavours default values.","operationId":"get_flavours_default_quotas","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursDefaultQuota"},"type":"array","title":"Response Get Flavours Default Quotas"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_flavours_default_quota":{"put":{"tags":["System Quotas"],"summary":"Save Flavours Default Quotas","description":"Save flavours default quota.","operationId":"save_flavours_default_quotas","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursDefaultQuota"},"type":"array","title":"Flavours"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursDefaultQuota"},"type":"array","title":"Response Save Flavours Default Quotas"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_projects_flavours_quota":{"get":{"tags":["System Quotas"],"summary":"Get Projects Flavours Quota","description":"Get projects flavours quotas.","operationId":"get_projects_flavours_quota","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectFlavoursQuota"},"type":"array","title":"Response Get Projects Flavours Quota"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_project_flavours_quota":{"put":{"tags":["System Quotas"],"summary":"Save Project Flavours Quota","description":"Save project flavours quota.","operationId":"save_project_flavours_quota","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFlavoursQuota"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_project_flavours_quota/{proj_key}":{"get":{"tags":["System Quotas"],"summary":"Get Project Flavours Quota","description":"Get project flavours quota.","operationId":"get_project_flavours_quota","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursQuota"},"type":"array","title":"Response Get Project Flavours Quota"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_project_flavour_total_kgs/{proj_key}/{flavour_name}":{"get":{"tags":["System Quotas"],"summary":"Get Project Flavour Total Kgs","description":"Gets kg total number by proj_key and flavour_key.","operationId":"get_project_flavour_total_kgs","parameters":[{"required":true,"schema":{"type":"string","title":"Flavour Name"},"name":"flavour_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFlavourTotalKgs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/celery_tasks/{task_id}":{"get":{"tags":["Tasks"],"summary":"Get Project Celery Task","description":"Get a celery task for a project.","operationId":"get_project_celery_task","parameters":[{"required":true,"schema":{"type":"string","title":"Task Id"},"name":"task_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"description":"Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls.","required":false,"schema":{"type":"number","maximum":30.0,"exclusiveMinimum":0.0,"title":"Wait","description":"Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls."},"name":"wait","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/tasks":{"get":{"tags":["Tasks"],"summary":"List Project Tasks","description":"List tasks for a project.","operationId":"list_project_tasks","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","title":"Task Type"},"name":"task_type","in":"query"},{"required":false,"schema":{"type":"integer","title":"Skip","default":0},"name":"skip","in":"query"},{"required":false,"schema":{"type":"integer","title":"Limit","default":50},"name":"limit","in":"query"},{"required":false,"schema":{"type":"string","title":"Sort By","default":"_id"},"name":"sort_by","in":"query"},{"required":false,"schema":{"type":"string","enum":["asc","desc"],"title":"Sort Order","default":"desc"},"name":"sort_order","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TaskContext"},"type":"array","title":"Response List Project Tasks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/tasks/{task_id}":{"get":{"tags":["Tasks"],"summary":"Get Project Task","description":"Get a task for a project.","operationId":"get_project_task","parameters":[{"required":true,"schema":{"type":"string","title":"Task Id"},"name":"task_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskContext"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/tasks/{task_id}/actions/abort":{"post":{"tags":["Tasks"],"summary":"Abort Project Task","description":"Abort a task.","operationId":"abort_project_task","parameters":[{"required":true,"schema":{"type":"string","title":"Task Id"},"name":"task_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/scratch/files":{"get":{"tags":["Upload"],"summary":"List Project Scratch Files","description":"Get temporary files uploaded to a project.","operationId":"list_project_scratch_files","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","title":"Scratch Ids"},"name":"scratch_ids","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectScratchFiles"},"type":"array","title":"Response List Project Scratch Files"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/scratch/files_paginated":{"get":{"tags":["Upload"],"summary":"List Project Scratch Files Paginated","description":"Get paginated list of temporary files uploaded to a project.","operationId":"list_project_scratch_files_paginated","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"integer","title":"Page"},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","title":"Items Per Page","default":20},"name":"items_per_page","in":"query"},{"required":false,"schema":{"type":"string","title":"Search String"},"name":"search_string","in":"query"},{"required":false,"schema":{"type":"integer","title":"Begin Date"},"name":"begin_date","in":"query"},{"required":false,"schema":{"type":"integer","title":"End Date"},"name":"end_date","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectScratchFilesPaginated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/scratch/files/upload/{filename}":{"post":{"tags":["Upload"],"summary":"Create Project Scratch File","description":"Create file pointers for temporary storage.","operationId":"create_project_scratch_file","parameters":[{"required":true,"schema":{"type":"string","title":"Filename"},"name":"filename","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryUploadFileResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}}},"components":{"schemas":{"AssembleMode":{"properties":{"page_elements":{"items":{"type":"string","enum":["H","M","None"]},"type":"array","title":"Page Elements"},"tables":{"items":{"type":"string","enum":["H","M","None"]},"type":"array","title":"Tables"}},"type":"object","required":["page_elements","tables"],"title":"AssembleMode"},"AssembleSettings":{"properties":{"mode":{"$ref":"#/components/schemas/AssembleMode"},"include_incomplete_documents":{"type":"boolean","title":"Include Incomplete Documents"}},"type":"object","required":["mode","include_incomplete_documents"],"title":"AssembleSettings"},"AttachmentUploadData":{"properties":{"attachment_path":{"type":"string","title":"Attachment Path"},"upload_data":{"type":"string","title":"Upload Data"}},"type":"object","required":["attachment_path","upload_data"],"title":"AttachmentUploadData"},"AttachmentUploadRequestBody":{"properties":{"attachment_path":{"type":"string","title":"Attachment Path"},"attachment_key":{"type":"string","title":"Attachment Key","default":"usr_attachments"}},"type":"object","required":["attachment_path"],"title":"AttachmentUploadRequestBody"},"BagFlavourFullData":{"properties":{"backend":{"type":"string","title":"Backend"},"config":{"type":"object","title":"Config"},"default_quota":{"type":"integer","title":"Default Quota","default":0},"description":{"type":"string","title":"Description"},"display_name":{"type":"string","title":"Display Name"},"is_from_deployment":{"type":"boolean","title":"Is From Deployment","default":true},"name":{"type":"string","title":"Name"},"order":{"type":"integer","title":"Order","default":0},"project_specific":{"type":"boolean","title":"Project Specific"}},"type":"object","required":["backend","config","description","display_name","name","project_specific"],"title":"BagFlavourFullData"},"CCSProject":{"properties":{"name":{"type":"string","title":"Name"},"proj_key":{"type":"string","title":"Proj Key"},"collection_name":{"type":"string","title":"Collection Name"}},"type":"object","required":["name","proj_key","collection_name"],"title":"CCSProject"},"CPSPackage":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"package_id":{"type":"string","title":"Package Id"},"type":{"type":"string","enum":["model","dictionary","knowledge_graph","data_catalog","data_flow","bundle"],"title":"Type"}},"type":"object","required":["name","description","package_id","type"],"title":"CPSPackage"},"CPSSummary":{"properties":{"availCpuSlots":{"type":"integer","title":"Availcpuslots"},"availMemSlots":{"type":"integer","title":"Availmemslots"},"availSlots":{"type":"integer","title":"Availslots"},"name":{"type":"string","title":"Name"},"numNodes":{"type":"integer","title":"Numnodes"},"numberKgs":{"type":"integer","title":"Numberkgs"},"runningKgs":{"type":"integer","title":"Runningkgs"},"workersPool":{"type":"string","title":"Workerspool"}},"type":"object","required":["availCpuSlots","availMemSlots","availSlots","name","numNodes","numberKgs","runningKgs","workersPool"],"title":"CPSSummary"},"CcsTask":{"properties":{"task_id":{"type":"string","title":"Task Id"},"ccs_project_key":{"type":"string","title":"Ccs Project Key"},"ccs_collection_name":{"type":"string","title":"Ccs Collection Name"}},"type":"object","required":["task_id","ccs_project_key","ccs_collection_name"],"title":"CcsTask"},"CollectionMetadataSettings":{"properties":{"description":{"type":"string","title":"Description"},"display_name":{"type":"string","title":"Display Name"},"license":{"type":"string","title":"License"},"source":{"type":"string","title":"Source"},"version":{"type":"string","title":"Version"}},"type":"object","title":"CollectionMetadataSettings"},"ConvertDocumentRequest":{"properties":{"http_source":{"$ref":"#/components/schemas/HttpSource"},"file_source":{"$ref":"#/components/schemas/FileSource"}},"type":"object","title":"ConvertDocumentRequest"},"ConvertDocumentsRequestBody":{"properties":{"conversion_settings":{"allOf":[{"$ref":"#/components/schemas/PartialDirectConversionParameters"}],"title":"Conversion Settings","description":"Specify the conversion settings to use."},"target_settings":{"allOf":[{"$ref":"#/components/schemas/TargetConversionParameters"}],"title":"Target Settings","description":"Specify the target settings to use."},"document_hashes":{"items":{"type":"string"},"type":"array","title":"Document Hashes","description":"List of document hashes to be used as filter."},"without_operations":{"items":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"]},"type":"array","title":"Without Operations","description":"List of Operation Status documents don't have to be used as filter."},"upload_to_elastic":{"type":"boolean","title":"Upload To Elastic"}},"type":"object","title":"ConvertDocumentsRequestBody"},"ConvertDocumentsSources":{"properties":{"file_url":{"items":{"type":"string"},"type":"array","title":"File Url","description":"List of File's URL to be converted and uploaded to the data index."},"internal_file_url":{"items":{"$ref":"#/components/schemas/InternalUrl"},"type":"array","title":"Internal File Url","description":"List of Internal File's URLs to be converted and uploaded to the data index."},"s3_source":{"allOf":[{"$ref":"#/components/schemas/S3DocumentSource"}],"title":"S3 Source","description":"Coordinates to object store to get files to convert. Can specify which files with object keys."}},"type":"object","title":"ConvertDocumentsSources"},"ConvertUploadDocumentsRequestBody":{"properties":{"file_url":{"items":{"type":"string"},"type":"array","title":"File Url","description":"List of File's URL to be converted and uploaded to the data index."},"internal_file_url":{"items":{"$ref":"#/components/schemas/InternalUrl"},"type":"array","title":"Internal File Url","description":"List of Internal File's URLs to be converted and uploaded to the data index."},"s3_source":{"allOf":[{"$ref":"#/components/schemas/S3DocumentSource"}],"title":"S3 Source","description":"Coordinates to object store to get files to convert. Can specify which files with object keys."},"upload_to_elastic":{"type":"boolean","title":"Upload To Elastic"},"conversion_settings":{"allOf":[{"$ref":"#/components/schemas/PartialDirectConversionParameters"}],"title":"Conversion Settings","description":"Specify the conversion settings to use."},"target_settings":{"allOf":[{"$ref":"#/components/schemas/TargetConversionParameters"}],"title":"Target Settings","description":"Specify the target settings to use."}},"type":"object","title":"ConvertUploadDocumentsRequestBody"},"CpsTask":{"properties":{"task_id":{"type":"string","title":"Task Id"},"task_type":{"type":"string","title":"Task Type"},"task_status":{"type":"string","title":"Task Status"}},"type":"object","required":["task_id","task_type","task_status"],"title":"CpsTask"},"DataFlow":{"properties":{"df_tpl_key":{"type":"string","title":"Df Tpl Key"},"name":{"type":"string","title":"Name"}},"type":"object","required":["df_tpl_key","name"],"title":"DataFlow"},"DataIndexUploadFileSource":{"properties":{"urls":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}],"title":"Urls","description":"List of URLs to be printed to PDF, converted and uploaded to the data index."},"conversion_settings":{"allOf":[{"$ref":"#/components/schemas/PartialDirectConversionParameters"}],"title":"Conversion Settings","description":"Specify the conversion settings to use."}},"type":"object","required":["urls"],"title":"DataIndexUploadFileSource"},"DefaultValues":{"properties":{"ccs_project":{"$ref":"#/components/schemas/CCSProject"},"dataflow":{"$ref":"#/components/schemas/DataFlow"}},"type":"object","required":["ccs_project"],"title":"DefaultValues"},"Deployment":{"properties":{"name":{"type":"string","title":"Name"},"disclaimer":{"type":"string","title":"Disclaimer"},"should_show_warning":{"type":"boolean","title":"Should Show Warning"},"disable_kg_actions":{"type":"boolean","title":"Disable Kg Actions"},"linked_ccs_api":{"type":"object","title":"Linked Ccs Api"}},"type":"object","required":["name","disclaimer","should_show_warning","disable_kg_actions","linked_ccs_api"],"title":"Deployment"},"DirectModelConfig":{"properties":{"type":{"type":"string","title":"Type"},"config":{"type":"object","title":"Config"}},"type":"object","required":["type","config"],"title":"DirectModelConfig","description":"Direct configuration of a model."},"DocumentArtifacts":{"properties":{"document_meta_json":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"document_pdf":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"document_json":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"document_glm_json":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"document_md":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"page_pdfs":{"items":{"$ref":"#/components/schemas/DocumentArtifactsPageItem"},"type":"array","title":"Page Pdfs","default":[]},"page_images":{"items":{"$ref":"#/components/schemas/DocumentArtifactsPageItem"},"type":"array","title":"Page Images","default":[]}},"type":"object","title":"DocumentArtifacts"},"DocumentArtifactsItem":{"properties":{"mime":{"type":"string","title":"Mime"},"path":{"type":"string","title":"Path"},"url":{"type":"string","title":"Url"}},"type":"object","required":["mime","path","url"],"title":"DocumentArtifactsItem"},"DocumentArtifactsPageItem":{"properties":{"mime":{"type":"string","title":"Mime"},"path":{"type":"string","title":"Path"},"url":{"type":"string","title":"Url"},"page":{"type":"integer","title":"Page","description":"Page number starting at 1."}},"type":"object","required":["mime","path","url","page"],"title":"DocumentArtifactsPageItem"},"DocumentStatistics":{"properties":{"total_documents":{"type":"integer","title":"Total Documents"},"documents_pending":{"type":"integer","title":"Documents Pending"},"documents_failed":{"type":"integer","title":"Documents Failed"},"documents_converted":{"type":"integer","title":"Documents Converted"}},"type":"object","required":["total_documents","documents_pending","documents_failed","documents_converted"],"title":"DocumentStatistics"},"ElasticIndexPropertyObject":{"properties":{"type":{"type":"string","title":"Type"},"enabled":{"type":"boolean","title":"Enabled"},"ignore_above":{"type":"integer","title":"Ignore Above"}},"type":"object","required":["type"],"title":"ElasticIndexPropertyObject"},"ElasticIndexPropertyPrimitive":{"properties":{"properties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/ElasticIndexPropertyPrimitive"},{"$ref":"#/components/schemas/ElasticIndexPropertyObject"}]},"type":"object","title":"Properties"}},"type":"object","required":["properties"],"title":"ElasticIndexPropertyPrimitive"},"ElasticIndexSearchQueryOptions":{"properties":{"_source":{"items":{"type":"string"},"type":"array","title":" Source"},"from_":{"type":"integer","title":"From "},"size":{"type":"integer","title":"Size"},"query":{"type":"object","title":"Query"},"aggs":{"type":"object","title":"Aggs"},"sort":{"items":{"type":"object"},"type":"array","title":"Sort"}},"type":"object","title":"ElasticIndexSearchQueryOptions"},"ElasticIndexSource":{"properties":{"index_key":{"type":"string","title":"Index Key"},"elastic_id":{"type":"string","title":"Elastic Id"}},"type":"object","required":["index_key","elastic_id"],"title":"ElasticIndexSource"},"ElasticInstanceDataIndex":{"properties":{"index_key":{"type":"string","title":"Index Key"},"query_options":{"$ref":"#/components/schemas/ElasticIndexSearchQueryOptions"},"elastic_id":{"type":"string","title":"Elastic Id"}},"type":"object","required":["index_key","query_options","elastic_id"],"title":"ElasticInstanceDataIndex"},"ElasticMetadata":{"properties":{"aliases":{"items":{"type":"string"},"type":"array","title":"Aliases"},"created":{"type":"string","title":"Created"},"description":{"type":"string","title":"Description"},"display_name":{"type":"string","title":"Display Name"},"source":{"type":"string","title":"Source"},"storage":{"type":"string","title":"Storage"},"version":{"type":"string","title":"Version"},"type":{"type":"string","title":"Type"},"domain":{"items":{"type":"string"},"type":"array","title":"Domain"},"classification":{"items":{"type":"string"},"type":"array","title":"Classification"}},"type":"object","required":["classification"],"title":"ElasticMetadata"},"FileSource":{"properties":{"base64_string":{"type":"string","title":"Base64 String"},"filename":{"type":"string","title":"Filename"}},"type":"object","required":["base64_string","filename"],"title":"FileSource"},"Flavour":{"properties":{"name":{"type":"string","title":"Name"},"display_name":{"type":"string","title":"Display Name"}},"type":"object","required":["name"],"title":"Flavour"},"FlavoursDefaultQuota":{"properties":{"display_name":{"type":"string","title":"Display Name"},"name":{"type":"string","title":"Name"},"default_quota":{"type":"integer","title":"Default Quota"}},"type":"object","required":["display_name","name","default_quota"],"title":"FlavoursDefaultQuota"},"FlavoursQuota":{"properties":{"display_name":{"type":"string","title":"Display Name"},"name":{"type":"string","title":"Name"},"quota":{"type":"integer","title":"Quota"}},"type":"object","required":["display_name","name","quota"],"title":"FlavoursQuota"},"GenAIAWSBedrock":{"properties":{"kind":{"type":"string","enum":["aws_bedrock"],"title":"Kind","default":"aws_bedrock"},"config":{"$ref":"#/components/schemas/GenAIAWSBedrockConfig"},"proj_params":{"$ref":"#/components/schemas/GenAIPartialParams"}},"type":"object","required":["config"],"title":"GenAIAWSBedrock","description":"GenAI integration for AWS Bedrock settings"},"GenAIAWSBedrockConfig":{"properties":{"GENAI_AWS_ACCESS_KEY":{"type":"string","format":"password","title":"Genai Aws Access Key","writeOnly":true},"GENAI_AWS_SECRET_KEY":{"type":"string","format":"password","title":"Genai Aws Secret Key","writeOnly":true},"GENAI_AWS_REGION_NAME":{"type":"string","title":"Genai Aws Region Name"}},"type":"object","required":["GENAI_AWS_ACCESS_KEY","GENAI_AWS_SECRET_KEY","GENAI_AWS_REGION_NAME"],"title":"GenAIAWSBedrockConfig","description":"Config for AWS Bedrock"},"GenAIBAM":{"properties":{"kind":{"type":"string","enum":["bam"],"title":"Kind","default":"bam"},"config":{"$ref":"#/components/schemas/GenAIBAMConfig"},"proj_params":{"$ref":"#/components/schemas/GenAIPartialParams"}},"type":"object","required":["config"],"title":"GenAIBAM","description":"GenAI integration for BAM settings"},"GenAIBAMConfig":{"properties":{"GENAI_API":{"type":"string","title":"Genai Api"},"GENAI_KEY":{"type":"string","format":"password","title":"Genai Key","writeOnly":true}},"type":"object","required":["GENAI_API","GENAI_KEY"],"title":"GenAIBAMConfig","description":"Config for BAM"},"GenAIHFInferenceApi":{"properties":{"kind":{"type":"string","enum":["hf_api"],"title":"Kind","default":"hf_api"},"config":{"$ref":"#/components/schemas/GenAIHFInferenceApiConfig"},"proj_params":{"$ref":"#/components/schemas/GenAIPartialParams"}},"type":"object","required":["config"],"title":"GenAIHFInferenceApi","description":"GenAI integration for Inference API settings"},"GenAIHFInferenceApiConfig":{"properties":{"GENAI_HF_API_KEY":{"type":"string","format":"password","title":"Genai Hf Api Key","writeOnly":true}},"type":"object","required":["GENAI_HF_API_KEY"],"title":"GenAIHFInferenceApiConfig","description":"Config for HF Inference API"},"GenAIParams":{"properties":{"model_id":{"type":"string","title":"Model Id"},"prompt_template":{"type":"string","title":"Prompt Template"},"params":{"type":"object","title":"Params"},"timeout":{"type":"number","title":"Timeout"}},"type":"object","required":["model_id","prompt_template","params","timeout"],"title":"GenAIParams"},"GenAIPartialParams":{"properties":{"model_id":{"type":"string","title":"Model Id"},"prompt_template":{"type":"string","title":"Prompt Template"},"params":{"type":"object","title":"Params"},"timeout":{"type":"number","title":"Timeout"}},"type":"object","title":"GenAIPartialParams"},"GenAIWatsonx":{"properties":{"kind":{"type":"string","enum":["watsonx"],"title":"Kind","default":"watsonx"},"config":{"$ref":"#/components/schemas/GenAIWatsonxConfig"},"proj_params":{"$ref":"#/components/schemas/GenAIPartialParams"}},"type":"object","required":["config"],"title":"GenAIWatsonx","description":"GenAI integration for watsonx settings"},"GenAIWatsonxConfig":{"properties":{"GENAI_API":{"type":"string","title":"Genai Api"},"GENAI_PROJECT_ID":{"type":"string","title":"Genai Project Id"},"GENAI_KEY":{"type":"string","format":"password","title":"Genai Key","writeOnly":true}},"type":"object","required":["GENAI_API","GENAI_PROJECT_ID","GENAI_KEY"],"title":"GenAIWatsonxConfig","description":"Config for watsonx"},"GroupedProjectDocuments":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/ProjectDocument"},"type":"array","title":"Documents"},"upload_date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"title":"Upload Date"}},"type":"object","required":["documents","upload_date"],"title":"GroupedProjectDocuments"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HttpSource":{"properties":{"url":{"type":"string","title":"Url"},"headers":{"type":"object","title":"Headers"}},"type":"object","required":["url","headers"],"title":"HttpSource"},"InternalUrl":{"properties":{"download_url":{"type":"string","title":"Download Url"},"header_url":{"type":"string","title":"Header Url"}},"type":"object","required":["download_url","header_url"],"title":"InternalUrl"},"JsonUploadRequestBody":{"properties":{"file_url":{"type":"string","title":"File Url"}},"type":"object","required":["file_url"],"title":"JsonUploadRequestBody"},"ListProjectFlavours":{"properties":{"flavours":{"items":{"$ref":"#/components/schemas/BagFlavourFullData"},"type":"array","title":"Flavours"},"proj_key":{"type":"string","title":"Proj Key"}},"type":"object","required":["flavours","proj_key"],"title":"ListProjectFlavours"},"ModelPipelineSettings":{"properties":{"clusters":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Clusters"},"page":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Page"},"tables":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Tables"},"normalization":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Normalization"}},"type":"object","required":["clusters","page","tables","normalization"],"title":"ModelPipelineSettings"},"ModulesConfig":{"properties":{"df_template_variables":{"items":{},"type":"array","title":"Df Template Variables"},"linked_ccs_instances":{"items":{},"type":"array","title":"Linked Ccs Instances"},"linked_elastic_instances":{"items":{},"type":"array","title":"Linked Elastic Instances"}},"type":"object","required":["df_template_variables","linked_ccs_instances","linked_elastic_instances"],"title":"ModulesConfig"},"OcrSettings":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false},"backend":{"type":"string","title":"Backend"},"backend_settings":{"type":"object","title":"Backend Settings"},"merge_mode":{"type":"string","title":"Merge Mode"}},"type":"object","title":"OcrSettings"},"Package":{"properties":{"overrides":{"type":"object","title":"Overrides"},"package_id":{"type":"string","title":"Package Id"}},"type":"object","required":["overrides","package_id"],"title":"Package"},"PartialDirectConversionParameters":{"properties":{"type":{"type":"string","enum":["direct"],"title":"Type","default":"direct"},"ocr":{"$ref":"#/components/schemas/OcrSettings"},"assemble":{"$ref":"#/components/schemas/AssembleSettings"},"metadata":{"$ref":"#/components/schemas/CollectionMetadataSettings"},"page_labels":{"additionalProperties":{"type":"object"},"type":"object","title":"Page Labels"},"model_pipeline":{"$ref":"#/components/schemas/ModelPipelineSettings"}},"type":"object","title":"PartialDirectConversionParameters","description":"Specify conversion settings (OCR, Assemble, ML Models) directly.\n\nFields left null are set to platform defaults."},"ProjectAgent":{"properties":{"agent_info":{"type":"object","title":"Agent Info"},"agent_name":{"type":"string","title":"Agent Name"},"version":{"type":"string","title":"Version"}},"type":"object","required":["agent_info","agent_name","version"],"title":"ProjectAgent"},"ProjectAgents":{"properties":{"agents":{"items":{"$ref":"#/components/schemas/ProjectAgent"},"type":"array","title":"Agents"}},"type":"object","required":["agents"],"title":"ProjectAgents"},"ProjectDataIndexNonView":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"schema_key":{"type":"string","enum":["deepsearch-doc","deepsearch-db","generic"],"title":"Schema Key","default":"generic"}},"type":"object","required":["name"],"title":"ProjectDataIndexNonView"},"ProjectDataIndexSource":{"properties":{"index_key":{"type":"string","title":"Index Key"},"proj_key":{"type":"string","title":"Proj Key"}},"type":"object","required":["index_key","proj_key"],"title":"ProjectDataIndexSource"},"ProjectDataIndexView":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"view_of":{"anyOf":[{"$ref":"#/components/schemas/ProjectSourceDataIndex"},{"$ref":"#/components/schemas/ElasticInstanceDataIndex"}],"title":"View Of"}},"type":"object","required":["name","view_of"],"title":"ProjectDataIndexView"},"ProjectDataIndexWithStatus":{"properties":{"source":{"anyOf":[{"$ref":"#/components/schemas/ElasticIndexSource"},{"$ref":"#/components/schemas/ProjectDataIndexSource"}],"title":"Source"},"name":{"type":"string","title":"Name"},"documents":{"type":"integer","title":"Documents"},"health":{"type":"string","title":"Health"},"status":{"type":"string","title":"Status"},"creation_date":{"type":"string","title":"Creation Date"},"metadata":{"$ref":"#/components/schemas/ElasticMetadata"},"description":{"type":"string","title":"Description"},"schema_key":{"type":"string","enum":["deepsearch-doc","deepsearch-db","generic"],"title":"Schema Key"},"type":{"type":"string","title":"Type"},"view_of":{"anyOf":[{"$ref":"#/components/schemas/ProjectSourceDataIndex"},{"$ref":"#/components/schemas/ElasticInstanceDataIndex"}],"title":"View Of"},"record_properties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/ElasticIndexPropertyPrimitive"},{"$ref":"#/components/schemas/ElasticIndexPropertyObject"}]},"type":"object","title":"Record Properties"},"provenance":{"type":"string","title":"Provenance"}},"type":"object","required":["source","name","documents","health","status","creation_date","description","type"],"title":"ProjectDataIndexWithStatus"},"ProjectDocument":{"properties":{"document_hash":{"type":"string","title":"Document Hash"},"filename":{"type":"string","title":"Filename"},"file_uri":{"type":"string","title":"File Uri"},"ref_uri":{"type":"string","title":"Ref Uri"},"number_pages":{"type":"integer","title":"Number Pages"},"status":{"type":"string","title":"Status"}},"type":"object","required":["document_hash","filename"],"title":"ProjectDocument"},"ProjectDocumentURL":{"properties":{"download_url":{"type":"string","title":"Download Url"}},"type":"object","required":["download_url"],"title":"ProjectDocumentURL"},"ProjectDocuments":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/ProjectDocument"},"type":"array","title":"Documents"}},"type":"object","required":["documents"],"title":"ProjectDocuments"},"ProjectFlavourTotalKgs":{"properties":{"proj_key":{"type":"string","title":"Proj Key"},"flavour_name":{"type":"string","title":"Flavour Name"},"total_kgs":{"type":"integer","title":"Total Kgs"}},"type":"object","required":["proj_key","flavour_name","total_kgs"],"title":"ProjectFlavourTotalKgs"},"ProjectFlavoursQuota":{"properties":{"name":{"type":"string","title":"Name"},"proj_key":{"type":"string","title":"Proj Key"},"quotas":{"items":{"$ref":"#/components/schemas/FlavoursQuota"},"type":"array","title":"Quotas"}},"type":"object","required":["name","proj_key","quotas"],"title":"ProjectFlavoursQuota"},"ProjectPackageInstalationManifest":{"properties":{"packages":{"items":{"$ref":"#/components/schemas/Package"},"type":"array","title":"Packages"}},"type":"object","required":["packages"],"title":"ProjectPackageInstalationManifest"},"ProjectScratchFiles":{"properties":{"id":{"type":"string","title":"Id"},"proj_key":{"type":"string","title":"Proj Key"},"user_key":{"type":"string","title":"User Key"},"filename":{"type":"string","title":"Filename"},"timestamp":{"type":"string","title":"Timestamp"},"url":{"type":"string","title":"Url"}},"type":"object","required":["id","proj_key","user_key","filename","timestamp","url"],"title":"ProjectScratchFiles"},"ProjectScratchFilesPaginated":{"properties":{"files":{"items":{"$ref":"#/components/schemas/ProjectScratchFiles"},"type":"array","title":"Files"},"count":{"type":"integer","title":"Count"},"page":{"type":"integer","title":"Page"},"items_per_page":{"type":"integer","title":"Items Per Page"}},"type":"object","required":["files","count","page","items_per_page"],"title":"ProjectScratchFilesPaginated"},"ProjectSourceDataIndex":{"properties":{"index_key":{"type":"string","title":"Index Key"},"query_options":{"$ref":"#/components/schemas/ElasticIndexSearchQueryOptions"},"proj_key":{"type":"string","title":"Proj Key"}},"type":"object","required":["index_key","query_options","proj_key"],"title":"ProjectSourceDataIndex"},"ProjectsFlavours":{"properties":{"proj_key":{"type":"string","title":"Proj Key"},"name":{"type":"string","title":"Name"},"flavours":{"items":{"$ref":"#/components/schemas/Flavour"},"type":"array","title":"Flavours"}},"type":"object","required":["proj_key","name","flavours"],"title":"ProjectsFlavours"},"ReferenceToModel":{"properties":{"model_config_key":{"type":"string","title":"Model Config Key"},"proj_key":{"type":"string","title":"Proj Key"},"name":{"type":"string","title":"Name","default":""},"description":{"type":"string","title":"Description","default":""}},"type":"object","required":["model_config_key","proj_key"],"title":"ReferenceToModel","description":"Reference to a model configuration."},"ResponseDocumentArtifacts":{"properties":{"artifacts":{"$ref":"#/components/schemas/DocumentArtifacts"}},"type":"object","required":["artifacts"],"title":"ResponseDocumentArtifacts"},"ResponseGroupedDocuments":{"properties":{"grouped_documents":{"items":{"$ref":"#/components/schemas/GroupedProjectDocuments"},"type":"array","title":"Grouped Documents"}},"type":"object","required":["grouped_documents"],"title":"ResponseGroupedDocuments"},"ResponseUploadJobs":{"properties":{"upload_jobs":{"items":{"$ref":"#/components/schemas/UploadJob"},"type":"array","title":"Upload Jobs"}},"type":"object","required":["upload_jobs"],"title":"ResponseUploadJobs"},"S3Coordinates":{"properties":{"host":{"type":"string","title":"Host"},"port":{"type":"integer","title":"Port"},"ssl":{"type":"boolean","title":"Ssl"},"verifySSL":{"type":"boolean","title":"Verifyssl"},"access-key":{"type":"string","title":"Access-Key"},"secret-key":{"type":"string","title":"Secret-Key"},"bucket":{"type":"string","title":"Bucket"},"key_prefix":{"type":"string","title":"Key Prefix"},"location":{"type":"string","title":"Location"}},"type":"object","required":["host","port","ssl","verifySSL","access-key","secret-key","bucket","location"],"title":"S3Coordinates"},"S3DocumentSource":{"properties":{"coordinates":{"$ref":"#/components/schemas/S3Coordinates"},"object_keys":{"items":{"type":"string"},"type":"array","title":"Object Keys","description":"List of s3 object keys to retrieve from bucket to be converted and uploaded to the data index."}},"type":"object","required":["coordinates"],"title":"S3DocumentSource","description":"Specifies documents to import from an S3 bucket"},"SemanticIngestReqParams":{"properties":{"skip_ingested_docs":{"type":"boolean","title":"Skip Ingested Docs"}},"type":"object","required":["skip_ingested_docs"],"title":"SemanticIngestReqParams"},"SemanticIngestRequest":{"properties":{"source":{"anyOf":[{"$ref":"#/components/schemas/SemanticIngestSourceUrl"},{"$ref":"#/components/schemas/SemanticIngestSourcePublicDataDocument"},{"$ref":"#/components/schemas/SemanticIngestSourcePrivateDataDocument"},{"$ref":"#/components/schemas/SemanticIngestSourcePrivateDataCollection"}],"title":"Source"},"parameters":{"$ref":"#/components/schemas/SemanticIngestReqParams"}},"type":"object","required":["source","parameters"],"title":"SemanticIngestRequest"},"SemanticIngestSourcePrivateDataCollection":{"properties":{"type":{"type":"string","enum":["private_data_collection"],"title":"Type"},"proj_key":{"type":"string","title":"Proj Key"},"index_key":{"type":"string","title":"Index Key"}},"type":"object","required":["type","proj_key","index_key"],"title":"SemanticIngestSourcePrivateDataCollection"},"SemanticIngestSourcePrivateDataDocument":{"properties":{"type":{"type":"string","enum":["private_data_document"],"title":"Type"},"proj_key":{"type":"string","title":"Proj Key"},"index_key":{"type":"string","title":"Index Key"},"document_hash":{"type":"string","title":"Document Hash"}},"type":"object","required":["type","proj_key","index_key","document_hash"],"title":"SemanticIngestSourcePrivateDataDocument"},"SemanticIngestSourcePublicDataDocument":{"properties":{"type":{"type":"string","enum":["public_data_document"],"title":"Type"},"elastic_id":{"type":"string","title":"Elastic Id"},"index_key":{"type":"string","title":"Index Key"},"document_hash":{"type":"string","title":"Document Hash"}},"type":"object","required":["type","elastic_id","index_key","document_hash"],"title":"SemanticIngestSourcePublicDataDocument"},"SemanticIngestSourceUrl":{"properties":{"type":{"type":"string","enum":["url"],"title":"Type"},"url":{"type":"string","title":"Url"}},"type":"object","required":["type","url"],"title":"SemanticIngestSourceUrl"},"StorageSummaryTask":{"properties":{"dc_key":{"type":"string","title":"Dc Key"},"kg_key":{"type":"string","title":"Kg Key"},"kind":{"type":"string","enum":["project_task","celery_task"],"title":"Kind"},"proj_key":{"type":"string","title":"Proj Key"},"task_id":{"type":"string","title":"Task Id"}},"type":"object","required":["kind","proj_key","task_id"],"title":"StorageSummaryTask"},"SystemInfo":{"properties":{"notifications":{"items":{},"type":"array","title":"Notifications"},"default_project":{"type":"object","title":"Default Project"},"deployment":{"$ref":"#/components/schemas/Deployment"},"toolkit":{"type":"object","title":"Toolkit"},"allow_non_admins_to_make_resources_public":{"type":"boolean","title":"Allow Non Admins To Make Resources Public"},"api":{"type":"object","title":"Api"},"genai_defaults":{"additionalProperties":{"$ref":"#/components/schemas/GenAIParams"},"type":"object","title":"Genai Defaults"}},"type":"object","required":["notifications","default_project","deployment","toolkit","allow_non_admins_to_make_resources_public","api","genai_defaults"],"title":"SystemInfo"},"TargetConversionParameters":{"properties":{"add_raw_pages":{"type":"boolean","title":"Add Raw Pages"},"add_annotations":{"type":"boolean","title":"Add Annotations"}},"type":"object","title":"TargetConversionParameters","description":"Specify target settings (add_raw_pages, add_annotations).\n\nFields left null are set to platform defaults."},"TaskContext":{"properties":{"proj_key":{"type":"string","title":"Proj Key"},"user_key":{"type":"string","title":"User Key"},"task_type":{"type":"string","title":"Task Type"},"task_id":{"type":"string","title":"Task Id"},"task_status":{"type":"string","title":"Task Status"},"execution_mode":{"type":"string","title":"Execution Mode"},"progress":{"type":"number","title":"Progress"},"meta":{"type":"object","title":"Meta"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"started_at":{"type":"string","format":"date-time","title":"Started At"},"completed_at":{"type":"string","format":"date-time","title":"Completed At"},"start_count":{"type":"integer","title":"Start Count"},"error_reason":{"type":"string","title":"Error Reason"},"related_tasks":{"items":{},"type":"array","title":"Related Tasks"}},"type":"object","required":["proj_key","user_key","task_type","task_id","task_status","execution_mode","progress","meta","created_at"],"title":"TaskContext"},"TaskResult":{"properties":{"result":{"title":"Result"},"task_id":{"type":"string","title":"Task Id"},"task_status":{"type":"string","title":"Task Status"}},"type":"object","required":["task_id","task_status"],"title":"TaskResult"},"TemporaryUploadFileResult":{"properties":{"id":{"type":"string","title":"Id"},"upload":{"$ref":"#/components/schemas/TemporaryUrlFields"},"download":{"$ref":"#/components/schemas/TemporaryUrl"},"metadata":{"$ref":"#/components/schemas/TemporaryUrl"},"upload_private":{"$ref":"#/components/schemas/TemporaryUrlFields"},"download_private":{"$ref":"#/components/schemas/TemporaryUrl"},"metadata_private":{"$ref":"#/components/schemas/TemporaryUrl"}},"type":"object","required":["id","upload","download","metadata","upload_private","download_private","metadata_private"],"title":"TemporaryUploadFileResult"},"TemporaryUrl":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"TemporaryUrl"},"TemporaryUrlFields":{"properties":{"url":{"type":"string","title":"Url"},"fields":{"type":"object","title":"Fields"}},"type":"object","required":["url","fields"],"title":"TemporaryUrlFields"},"TokenResponse":{"properties":{"token":{"type":"string","title":"Token"}},"type":"object","required":["token"],"title":"TokenResponse"},"UploadElasticRequestBody":{"properties":{"document_hashes":{"items":{"type":"string"},"type":"array","title":"Document Hashes","description":"List of document hashes to be used as filter."},"with_operations":{"items":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"]},"type":"array","title":"With Operations","description":"List of Operation Status documents don't have to be used as filter."}},"type":"object","title":"UploadElasticRequestBody"},"UploadJob":{"properties":{"date":{"type":"string","format":"date-time","title":"Date"},"num_docs":{"type":"integer","title":"Num Docs"}},"type":"object","required":["date","num_docs"],"title":"UploadJob"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"Bearer":{"type":"apiKey","description":"Provide a Bearer token in the `Authorization` header","in":"header","name":"Authorization"}}}} \ No newline at end of file diff --git a/tools/swagger-client-generator/swagger-cps-kg.json b/tools/swagger-client-generator/swagger-cps-kg.json index fd8f49bb..c62a5434 100644 --- a/tools/swagger-client-generator/swagger-cps-kg.json +++ b/tools/swagger-client-generator/swagger-cps-kg.json @@ -1 +1 @@ -{"basePath":"/api/cps/kg/v1","consumes":["application/json"],"definitions":{"KGClientResponse":{"properties":{"query":{"type":"string"},"status":{"type":"string"},"version":{"type":"string"}},"required":["query","status","version"],"type":"object"},"NodeCollection":{"properties":{"collection_key":{"type":"string"},"name":{"type":"string"},"node_list":{"items":{"properties":{"db":{"type":"string"},"id":{"type":"string"}},"required":["db","id"],"type":"object"},"type":"array"}},"required":["name","node_list"],"type":"object"},"NodeDataView":{"properties":{"parameters":{"type":"object"},"projections":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"}},"required":["type"],"type":"object"},"Problem":{"additionalProperties":{},"example":{"detail":"A descriptive message.","may_have_extra_fields":true,"status":500,"title":"An example title","type":"ExampleError"},"properties":{"detail":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"Workflow":{"properties":{"description":{"type":"string"},"name":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"name":{"type":"string"},"node_views":{"properties":{"active_type":{"type":"string"},"columns":{"items":{"$ref":"#/definitions/NodeDataView"},"type":"array"},"configurations":{"items":{"$ref":"#/definitions/NodeDataView"},"type":"array"},"expanded":{"type":"boolean"},"limit":{"type":"number"}},"type":"object"}},"type":"object"},"type":"object"},"template":{"type":"array"},"variables":{"type":"object"},"wf_key":{"type":"string"}},"required":["name","description","template","variables"],"type":"object"}},"info":{"title":"Corpus Processing Service (CPS) - KG API","version":"0.0.1"},"paths":{"/project/{proj_key}/bags/{bag_key}/dataset/export":{"post":{"description":"Export node collection dataset.","operationId":"api_server.controllers.kg.node_collections_controller.export_dataset","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"collection_key":{"type":"string"},"include_s3_data":{"default":false,"type":"boolean"},"node_list":{"example":[{"_db":"db1-hash","_id":"node-id"},{"_db":"db2-hash","_id":"node-id"}],"items":{"properties":{"_db":{"type":"string"},"_id":{"type":"string"}},"required":["_db","_id"],"type":"object"},"minLength":1,"type":"array"},"projection":{"description":"A dict specifying the fields to include or exclude. Use a dict to exclude fields from the result (e.g. projection={'main-text': false}).","example":{"projection":{}},"type":"object"}},"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Successful response","schema":{"properties":{"completed_at":{"format":"double","type":"number","x-nullable":true},"created_at":{"format":"double","type":"number"},"meta":{"type":"object"},"progress":{"format":"double","type":"number"},"proj_key":{"type":"string"},"started_at":{"format":"double","type":"number","x-nullable":true},"task_id":{"type":"string"},"task_status":{"type":"string"},"task_type":{"type":"string"},"user_key":{"type":"string"}},"type":"object"}},"400":{"description":"Missing field or invalid format"},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/Problem"}}},"tags":["Node collections"]}},"/project/{proj_key}/bags/{bag_key}/description":{"get":{"description":"Retrieve the kg graph description","operationId":"api_server.controllers.kg.controller.get_kg_graph_description","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KGClientResponse"}},"404":{"description":"Knowledge graph not found or missing backend","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Unknown error","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["General"]}},"/project/{proj_key}/bags/{bag_key}/node_collections":{"get":{"description":"Retrieve a list of node collections","operationId":"api_server.controllers.kg.node_collections_controller.list_node_collections","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"query","name":"search","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of Collection nodes","schema":{"items":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"}}},"tags":["Node collections"]},"post":{"consumes":["application/json"],"description":"Create a new node collection","operationId":"api_server.controllers.kg.node_collections_controller.create_node_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"collection_name":{"type":"string"},"node_list":{"items":{"properties":{"db":{"type":"string"},"id":{"type":"string"}},"required":["db","id"],"type":"object"},"type":"array"}},"required":["collection_name","node_list"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Node collection created"},"409":{"description":"Collection already exists","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Node collections"]}},"/project/{proj_key}/bags/{bag_key}/node_collections/{collection_key}":{"delete":{"consumes":["application/json"],"description":"Delete a node collection","operationId":"api_server.controllers.kg.node_collections_controller.delete_node_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"path","name":"collection_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Node collection deleted"},"404":{"description":"Node collection doesn't exist","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Node collections"]},"get":{"description":"Retrieve a node collection by its collection key","operationId":"api_server.controllers.kg.node_collections_controller.get_node_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"path","name":"collection_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Node collection","schema":{"$ref":"#/definitions/NodeCollection"}},"404":{"description":"Node collection doesn't exist","schema":{"$ref":"#/definitions/Problem"}}},"tags":["Node collections"]},"put":{"consumes":["application/json"],"description":"Update a node collection","operationId":"api_server.controllers.kg.node_collections_controller.update_node_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"path","name":"collection_key","required":true,"type":"string"},{"in":"body","name":"node_list","required":true,"schema":{"items":{"properties":{"db":{"type":"string"},"id":{"type":"string"}},"required":["db","id"],"type":"object"},"type":"array"}}],"produces":["application/json"],"responses":{"204":{"description":"Node collection updated"},"404":{"description":"Node collection doesn't exist","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Node collections"]}},"/project/{proj_key}/bags/{bag_key}/temp/workflows":{"get":{"description":"Retrieve a list of temporary workflows","operationId":"api_server.controllers.kg.temporary_workflows_controller.list_workflows","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"query","name":"search","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Workflows","schema":{"items":{"$ref":"#/definitions/Workflow"},"type":"array"}}},"tags":["Temporary Workflows"]},"post":{"consumes":["application/json"],"description":"Create a new temporary workflow","operationId":"api_server.controllers.kg.temporary_workflows_controller.create_workflow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"description":{"type":"string"},"name":{"type":"string"},"template":{"items":{"type":"object"},"type":"array"},"variables":{"additionalProperties":{"properties":{"type":{"type":"string"}},"type":"object"},"type":"object"}},"required":["name","description","template","variables"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Workflow created","schema":{"$ref":"#/definitions/Workflow"}}},"security":[{"Bearer":[]}],"tags":["Temporary Workflows"]}},"/project/{proj_key}/bags/{bag_key}/temp/workflows/{wf_key}":{"get":{"description":"Retrieve a temporary workflow by its id","operationId":"api_server.controllers.kg.temporary_workflows_controller.get_workflow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"path","name":"wf_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Workflow","schema":{"$ref":"#/definitions/Workflow"}},"404":{"description":"Workflow doesn't exist","schema":{"$ref":"#/definitions/Problem"}}},"tags":["Temporary Workflows"]}},"/project/{proj_key}/bags/{bag_key}/temp/workflows/{wf_key}/render":{"post":{"consumes":["application/json"],"description":"Render a temporary workflow","operationId":"api_server.controllers.kg.temporary_workflows_controller.render_workflow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"path","name":"wf_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"variables":{"type":"object"}},"required":["variables"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Rendered workflow","schema":{"type":"object"}}},"tags":["Temporary Workflows"]}},"/project/{proj_key}/bags/{bag_key}/workflows":{"get":{"description":"Retrieve a list of workflows","operationId":"api_server.controllers.kg.workflows_controller.list_workflows","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"query","name":"search","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Workflows","schema":{"items":{"$ref":"#/definitions/Workflow"},"type":"array"}}},"tags":["Workflows"]},"post":{"consumes":["application/json"],"description":"Create a new workflow","operationId":"api_server.controllers.kg.workflows_controller.create_workflow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Workflow"}}],"produces":["application/json"],"responses":{"200":{"description":"Workflow created","schema":{"$ref":"#/definitions/Workflow"}}},"security":[{"Bearer":[]}],"tags":["Workflows"]}},"/project/{proj_key}/bags/{bag_key}/workflows/import":{"post":{"consumes":["application/json"],"description":"Import multiple workflows","operationId":"api_server.controllers.kg.workflows_controller.import_workflows","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"items":{"$ref":"#/definitions/Workflow"},"type":"array"}}],"produces":["application/json"],"responses":{"200":{"description":"Workflow imported","schema":{"items":{"$ref":"#/definitions/Workflow"},"type":"array"}}},"security":[{"Bearer":[]}],"tags":["Workflows"]}},"/project/{proj_key}/bags/{bag_key}/workflows/{wf_key}":{"delete":{"description":"Delete a workflow by its id","operationId":"api_server.controllers.kg.workflows_controller.delete_workflow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"path","name":"wf_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Workflow deleted"},"404":{"description":"Workflow doesn't exist","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Workflows"]},"get":{"description":"Retrieve a workflow by its id","operationId":"api_server.controllers.kg.workflows_controller.get_workflow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"path","name":"wf_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Workflow","schema":{"$ref":"#/definitions/Workflow"}},"404":{"description":"Workflow doesn't exist","schema":{"$ref":"#/definitions/Problem"}}},"tags":["Workflows"]},"put":{"consumes":["application/json"],"description":"Update a workflow","operationId":"api_server.controllers.kg.workflows_controller.update_workflow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"path","name":"wf_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Workflow"}}],"produces":["application/json"],"responses":{"204":{"description":"Workflow updated"},"404":{"description":"Workflow doesn't exist","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Workflows"]}}},"produces":["application/json"],"schemes":["http","https"],"securityDefinitions":{"Bearer":{"description":"For accessing the API a valid JWT token must be passed in all the queries in\nthe 'Authorization' header.\n\nA valid JWT token is generated by the API and returned.\n\nThe following syntax must be used in the 'Authorization' header :\n Bearer xxxxxx.yyyyyyy.zzzzzz\n","in":"header","name":"Authorization","type":"apiKey","x-apikeyInfoFunc":"oidc_user_mngt.utils.connexion_auth.api_key_info"}},"swagger":"2.0"} +{"swagger": "2.0", "info": {"version": "0.0.1", "title": "Corpus Processing Service (CPS) - KG API"}, "schemes": ["http", "https"], "consumes": ["application/json"], "produces": ["application/json"], "securityDefinitions": {"Bearer": {"description": "For accessing the API a valid JWT token must be passed in all the queries in\nthe 'Authorization' header.\n\nA valid JWT token is generated by the API and returned.\n\nThe following syntax must be used in the 'Authorization' header :\n Bearer xxxxxx.yyyyyyy.zzzzzz\n", "type": "apiKey", "name": "Authorization", "in": "header", "x-apikeyInfoFunc": "oidc_user_mngt.utils.connexion_auth.api_key_info"}}, "paths": {"/project/{proj_key}/bags/{bag_key}/description": {"get": {"operationId": "api_server.controllers.kg.controller.get_kg_graph_description", "tags": ["General"], "security": [{"Bearer": []}], "description": "Retrieve the kg graph description", "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/KGClientResponse"}}, "404": {"description": "Knowledge graph not found or missing backend", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Unknown error", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/bags/{bag_key}/node_collections": {"get": {"operationId": "api_server.controllers.kg.node_collections_controller.list_node_collections", "tags": ["Node collections"], "description": "Retrieve a list of node collections", "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "search", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "List of Collection nodes", "schema": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}}}}}}}, "post": {"operationId": "api_server.controllers.kg.node_collections_controller.create_node_collection", "tags": ["Node collections"], "security": [{"Bearer": []}], "description": "Create a new node collection", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "properties": {"collection_name": {"type": "string"}, "node_list": {"type": "array", "items": {"type": "object", "properties": {"db": {"type": "string"}, "id": {"type": "string"}}, "required": ["db", "id"]}}}, "required": ["collection_name", "node_list"]}}], "responses": {"200": {"description": "Node collection created"}, "409": {"description": "Collection already exists", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/bags/{bag_key}/node_collections/{collection_key}": {"get": {"operationId": "api_server.controllers.kg.node_collections_controller.get_node_collection", "tags": ["Node collections"], "description": "Retrieve a node collection by its collection key", "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "collection_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Node collection", "schema": {"$ref": "#/definitions/NodeCollection"}}, "404": {"description": "Node collection doesn't exist", "schema": {"$ref": "#/definitions/Problem"}}}}, "delete": {"operationId": "api_server.controllers.kg.node_collections_controller.delete_node_collection", "tags": ["Node collections"], "security": [{"Bearer": []}], "description": "Delete a node collection", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "collection_key", "in": "path", "type": "string", "required": true}], "responses": {"204": {"description": "Node collection deleted"}, "404": {"description": "Node collection doesn't exist", "schema": {"$ref": "#/definitions/Problem"}}}}, "put": {"operationId": "api_server.controllers.kg.node_collections_controller.update_node_collection", "tags": ["Node collections"], "security": [{"Bearer": []}], "description": "Update a node collection", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "collection_key", "in": "path", "type": "string", "required": true}, {"name": "node_list", "in": "body", "required": true, "schema": {"type": "array", "items": {"type": "object", "properties": {"db": {"type": "string"}, "id": {"type": "string"}}, "required": ["db", "id"]}}}], "responses": {"204": {"description": "Node collection updated"}, "404": {"description": "Node collection doesn't exist", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/bags/{bag_key}/dataset/export": {"post": {"operationId": "api_server.controllers.kg.node_collections_controller.export_dataset", "tags": ["Node collections"], "description": "Export node collection dataset.", "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "options", "in": "body", "required": true, "schema": {"type": "object", "properties": {"node_list": {"type": "array", "minLength": 1, "items": {"type": "object", "properties": {"_db": {"type": "string"}, "_id": {"type": "string"}}, "required": ["_db", "_id"]}, "example": [{"_db": "db1-hash", "_id": "node-id"}, {"_db": "db2-hash", "_id": "node-id"}]}, "collection_key": {"type": "string"}, "include_s3_data": {"type": "boolean", "default": false}, "projection": {"type": "object", "example": {"projection": {}}, "description": "A dict specifying the fields to include or exclude. Use a dict to exclude fields from the result (e.g. projection={'main-text': false})."}}}}], "responses": {"200": {"description": "Successful response", "schema": {"type": "object", "properties": {"proj_key": {"type": "string"}, "user_key": {"type": "string"}, "task_type": {"type": "string"}, "task_id": {"type": "string"}, "task_status": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "started_at": {"type": "number", "format": "double", "x-nullable": true}, "completed_at": {"type": "number", "format": "double", "x-nullable": true}, "progress": {"type": "number", "format": "double"}, "meta": {"type": "object"}}}}, "400": {"description": "Missing field or invalid format"}, "default": {"description": "unexpected error", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/bags/{bag_key}/temp/workflows": {"get": {"operationId": "api_server.controllers.kg.temporary_workflows_controller.list_workflows", "tags": ["Temporary Workflows"], "description": "Retrieve a list of temporary workflows", "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "search", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "Workflows", "schema": {"type": "array", "items": {"$ref": "#/definitions/Workflow"}}}}}, "post": {"operationId": "api_server.controllers.kg.temporary_workflows_controller.create_workflow", "tags": ["Temporary Workflows"], "security": [{"Bearer": []}], "description": "Create a new temporary workflow", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string"}, "template": {"type": "array", "items": {"type": "object"}}, "variables": {"type": "object", "additionalProperties": {"type": "object", "properties": {"type": {"type": "string"}}}}}, "required": ["name", "description", "template", "variables"]}}], "responses": {"200": {"description": "Workflow created", "schema": {"$ref": "#/definitions/Workflow"}}}}}, "/project/{proj_key}/bags/{bag_key}/temp/workflows/{wf_key}": {"get": {"operationId": "api_server.controllers.kg.temporary_workflows_controller.get_workflow", "tags": ["Temporary Workflows"], "description": "Retrieve a temporary workflow by its id", "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "wf_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Workflow", "schema": {"$ref": "#/definitions/Workflow"}}, "404": {"description": "Workflow doesn't exist", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/bags/{bag_key}/temp/workflows/{wf_key}/render": {"post": {"operationId": "api_server.controllers.kg.temporary_workflows_controller.render_workflow", "tags": ["Temporary Workflows"], "description": "Render a temporary workflow", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "wf_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "properties": {"variables": {"type": "object"}}, "required": ["variables"]}}], "responses": {"200": {"description": "Rendered workflow", "schema": {"type": "object"}}}}}, "/project/{proj_key}/bags/{bag_key}/workflows": {"get": {"operationId": "api_server.controllers.kg.workflows_controller.list_workflows", "tags": ["Workflows"], "description": "Retrieve a list of workflows", "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "search", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "Workflows", "schema": {"type": "array", "items": {"$ref": "#/definitions/Workflow"}}}}}, "post": {"operationId": "api_server.controllers.kg.workflows_controller.create_workflow", "tags": ["Workflows"], "security": [{"Bearer": []}], "description": "Create a new workflow", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Workflow"}}], "responses": {"200": {"description": "Workflow created", "schema": {"$ref": "#/definitions/Workflow"}}}}}, "/project/{proj_key}/bags/{bag_key}/workflows/import": {"post": {"operationId": "api_server.controllers.kg.workflows_controller.import_workflows", "tags": ["Workflows"], "security": [{"Bearer": []}], "description": "Import multiple workflows", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "array", "items": {"$ref": "#/definitions/Workflow"}}}], "responses": {"200": {"description": "Workflow imported", "schema": {"type": "array", "items": {"$ref": "#/definitions/Workflow"}}}}}}, "/project/{proj_key}/bags/{bag_key}/workflows/{wf_key}": {"get": {"operationId": "api_server.controllers.kg.workflows_controller.get_workflow", "tags": ["Workflows"], "description": "Retrieve a workflow by its id", "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "wf_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Workflow", "schema": {"$ref": "#/definitions/Workflow"}}, "404": {"description": "Workflow doesn't exist", "schema": {"$ref": "#/definitions/Problem"}}}}, "delete": {"operationId": "api_server.controllers.kg.workflows_controller.delete_workflow", "tags": ["Workflows"], "security": [{"Bearer": []}], "description": "Delete a workflow by its id", "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "wf_key", "in": "path", "type": "string", "required": true}], "responses": {"204": {"description": "Workflow deleted"}, "404": {"description": "Workflow doesn't exist", "schema": {"$ref": "#/definitions/Problem"}}}}, "put": {"operationId": "api_server.controllers.kg.workflows_controller.update_workflow", "tags": ["Workflows"], "security": [{"Bearer": []}], "description": "Update a workflow", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "wf_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Workflow"}}], "responses": {"204": {"description": "Workflow updated"}, "404": {"description": "Workflow doesn't exist", "schema": {"$ref": "#/definitions/Problem"}}}}}}, "definitions": {"Problem": {"type": "object", "properties": {"type": {"type": "string"}, "title": {"type": "string"}, "detail": {"type": "string"}, "status": {"type": "integer"}}, "additionalProperties": {}, "example": {"type": "ExampleError", "title": "An example title", "detail": "A descriptive message.", "status": 500, "may_have_extra_fields": true}}, "KGClientResponse": {"type": "object", "required": ["query", "status", "version"], "properties": {"query": {"type": "string"}, "status": {"type": "string"}, "version": {"type": "string"}}}, "NodeDataView": {"type": "object", "properties": {"type": {"type": "string"}, "projections": {"type": "array", "items": {"type": "string"}}, "parameters": {"type": "object"}}, "required": ["type"]}, "Workflow": {"type": "object", "properties": {"wf_key": {"type": "string"}, "name": {"type": "string"}, "description": {"type": "string"}, "template": {"type": "array"}, "variables": {"type": "object"}, "outputs": {"type": "object", "additionalProperties": {"type": "object", "properties": {"name": {"type": "string"}, "node_views": {"type": "object", "properties": {"limit": {"type": "number"}, "active_type": {"type": "string"}, "expanded": {"type": "boolean"}, "configurations": {"type": "array", "items": {"$ref": "#/definitions/NodeDataView"}}, "columns": {"type": "array", "items": {"$ref": "#/definitions/NodeDataView"}}}}}}}}, "required": ["name", "description", "template", "variables"]}, "NodeCollection": {"type": "object", "required": ["name", "node_list"], "properties": {"name": {"type": "string"}, "collection_key": {"type": "string"}, "node_list": {"type": "array", "items": {"type": "object", "properties": {"db": {"type": "string"}, "id": {"type": "string"}}, "required": ["db", "id"]}}}}}, "basePath": "/api/cps/kg/v1"} diff --git a/tools/swagger-client-generator/swagger-cps.json b/tools/swagger-client-generator/swagger-cps.json index 3d1e009a..43601f7c 100644 --- a/tools/swagger-client-generator/swagger-cps.json +++ b/tools/swagger-client-generator/swagger-cps.json @@ -1 +1 @@ -{"basePath":"/api/cps/public/v1","consumes":["application/json"],"definitions":{"AnnotatedImage":{"properties":{"entities":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"properties":{"$ref":"#/definitions/ObjectPropertyMap"},"relationships":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"text":{"type":"string"}},"required":["entities","relationships","properties"],"type":"object"},"AnnotatedObject":{"maxProperties":1,"minProperties":1,"properties":{"image":{"$ref":"#/definitions/AnnotatedImage"},"table":{"$ref":"#/definitions/AnnotatedTable"},"text":{"properties":{"entities":{"description":"One item per line on the original text.","items":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"type":"array"},"properties":{"description":"One item per line on the original text.","items":{"$ref":"#/definitions/ObjectPropertyMap"},"type":"array"},"relationships":{"description":"One item per line on the original text.","items":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"type":"array"},"text":{"description":"Input text after clean up. The annotation indexes will be based on this text and not the input text.","type":"string"}},"required":["text","entities","relationships","properties"],"title":"AnnotatedTextLines","type":"object"}},"type":"object"},"AnnotatedTable":{"properties":{"entities":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"properties":{"$ref":"#/definitions/ObjectPropertyMap"},"relationships":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"text":{"type":"string"}},"required":["entities","relationships","properties"],"type":"object"},"AnnotatedText":{"properties":{"entities":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"properties":{"$ref":"#/definitions/ObjectPropertyMap"},"relationships":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"text":{"type":"string"}},"required":["text","entities","relationships","properties"],"type":"object"},"AnnotatorParametersOrRef":{"properties":{"model_config_key":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"type":{"type":"string"}},"type":"object"},"AnnotatorSupportedAnnotationsParameters":{"properties":{"annotator":{"type":"string"},"annotator_settings":{"type":"object"}},"required":["annotator"],"type":"object"},"Bag":{"properties":{"_svc_endpoint":{"type":"string"},"bag_domain":{"type":"string"},"bag_key":{"type":"string"},"bag_url":{"type":"string"},"flavour":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"slug":{"type":"string"},"timestamp":{"format":"double","type":"number"},"token":{"type":"string"}},"required":["proj_key","bag_key","name","slug","timestamp","bag_domain","flavour","bag_url","public","_svc_endpoint","token"],"type":"object"},"BagBackendAware":{"properties":{"backend":{"properties":{"kg_amqp":{"properties":{"flavour":{"type":"string"}},"title":"BagAmqpBackend","type":"object"},"kg_legacy_api":{"properties":{"_svc_endpoint":{"type":"string"},"bag_domain":{"type":"string"},"bag_url":{"type":"string"},"flavour":{"type":"string"},"token":{"type":"string"}},"title":"BagKgLegacyApiBackend","type":"object"}},"title":"BagBackends","type":"object"},"bag_key":{"type":"string"},"description":{"type":"string"},"last_coords_resolution":{"type":"number"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"slug":{"type":"string"},"timestamp":{"format":"double","type":"number"}},"required":["proj_key","bag_key","name","description","slug","timestamp","backend","public"],"type":"object"},"BagCallback":{"properties":{"callback_url":{"type":"string"}},"type":"object"},"BagComponentStatus":{"properties":{"start_time":{"format":"double","type":"number","x-nullable":true},"status":{"$ref":"#/definitions/BagComponentStatusEnum"}},"required":["status","start_time"],"type":"object"},"BagComponentStatusEnum":{"enum":["LAUNCHING","READY","BUSY","SUSPENDED","SUSPENDING","ERROR","PROVISIONING","PROVISIONING_FAILED","UNKNOWN","CHECKING","PENDING_RESOURCES","IDLE"],"type":"string"},"BagFlavour":{"properties":{"description":{"type":"string"},"display_name":{"type":"string"},"name":{"type":"string"}},"type":"object"},"BagFlavourDefaultQuota":{"properties":{"default_quota":{"type":"number"},"display_name":{"type":"string"},"name":{"type":"string"}},"required":["name","display_name"],"title":"BagFlavourDefaultQuota","type":"object"},"BagFlavourFullData":{"properties":{"backend":{"type":"string"},"config":{"type":"object"},"default_quota":{"type":"integer"},"description":{"type":"string"},"display_name":{"type":"string"},"is_from_deployment":{"type":"boolean"},"name":{"type":"string"},"order":{"type":"number"},"project_specific":{"type":"boolean"}},"required":["display_name","description","project_specific","backend","config"],"type":"object"},"BagStatus":{"properties":{"components":{"properties":{"erlenmeyer_api":{"allOf":[{"$ref":"#/definitions/BagComponentStatus"}],"description":"Status of the Erlenmeyer API for this Graph"},"erlenmeyer_ui":{"allOf":[{"$ref":"#/definitions/BagComponentStatus"}],"description":"Status of the Erlenmeyer UI for this Graph"},"kg":{"allOf":[{"$ref":"#/definitions/BagComponentStatus"}],"description":"Status of the Knowledge Graph and its API"}},"required":["kg","erlenmeyer_api","erlenmeyer_ui"],"type":"object"},"status":{"$ref":"#/definitions/BagComponentStatusEnum"}},"required":["status","components"],"type":"object"},"BagStatusBackendAware":{"properties":{"kg_amqp":{"properties":{"status":{"$ref":"#/definitions/BagComponentStatusEnum"}},"required":["status"],"type":"object"},"kg_legacy_api":{"$ref":"#/definitions/BagStatus"},"overall_status":{"$ref":"#/definitions/BagComponentStatusEnum"}},"required":["overall_status"],"type":"object"},"CatalogReference":{"properties":{"collection_name":{"type":"string"},"dc_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["dc_key","collection_name"],"type":"object"},"CcsCollectionReference":{"properties":{"collection_name":{"type":"string"},"language":{"type":"string"},"proj_key":{"type":"string"}},"required":["proj_key","collection_name"],"type":"object"},"CcsTask":{"properties":{"ccs_collection_name":{"type":"string"},"ccs_project_key":{"type":"string"},"task_id":{"type":"string"}},"required":["task_id","ccs_project_key","ccs_collection_name"],"title":"CcsTask","type":"object"},"CloneDataCatalogResult":{"properties":{"clone_task":{"$ref":"#/definitions/Task"},"data_catalogue":{"$ref":"#/definitions/DataCatalogue"}},"required":["data_catalogue","clone_task"],"type":"object"},"CollectionListCoordinates":{"properties":{"collections":{"items":{"type":"string"},"type":"array"}},"type":"object"},"CpsModelReference":{"properties":{"model_config_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["model_config_key","proj_key"],"type":"object"},"CpsPackage":{"properties":{"dependencies":{"items":{"type":"string"},"type":"array"},"description":{"type":"string"},"name":{"type":"string"},"package_id":{"type":"string"},"type":{"enum":["model","dictionary","knowledge_graph","data_catalog","data_flow","bundle"],"type":"string"}},"required":["name","package_id","description","type","dependencies"],"type":"object"},"CpsTask":{"properties":{"task_id":{"type":"string"},"task_status":{"type":"string"},"task_type":{"type":"string"}},"required":["task_id","task_status","task_type"],"title":"CpsTask","type":"object"},"DataCatalogCollection":{"properties":{"item_count":{"type":"integer"},"name":{"type":"string"}},"required":["name","item_count"],"type":"object"},"DataCatalogImportResult":{"properties":{"data_catalogue":{"$ref":"#/definitions/DataCatalogue"},"import_task":{"$ref":"#/definitions/Task"}},"required":["data_catalogue","import_task"],"type":"object"},"DataCatalogSchema":{"properties":{"name":{"type":"string"},"schema":{"type":"string"}},"type":"object"},"DataCatalogTopology":{"properties":{"categories":{"items":{"$ref":"#/definitions/DataCatalogTopologyNode"},"type":"array"},"edges":{"items":{"$ref":"#/definitions/DataCatalogTopologyEdge"},"type":"array"}},"required":["categories","edges"]},"DataCatalogTopologyEdge":{"properties":{"name":{"type":"string"},"source":{"items":{"type":"string"},"type":"array"},"source_field":{"type":"string"},"target":{"items":{"type":"string"},"type":"array"},"target_field":{"type":"string"}},"required":["name","source","target","source_field","target_field"],"type":"object"},"DataCatalogTopologyNode":{"properties":{"data-fields":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"}},"required":["name","data-fields"]},"DataCatalogue":{"properties":{"category_schemas":{"items":{"properties":{"key":{"type":"string"},"schema":{"additionalProperties":{},"type":"object"}},"required":["key","schema"],"title":"DataCatalogCategorySchema","type":"object"},"type":"array"},"collections":{"items":{"$ref":"#/definitions/DataCatalogCollection"},"type":"array"},"collections_data_flows":{"items":{"properties":{"data_flows":{"items":{"type":"object"},"type":"array"},"key":{"type":"string"}},"required":["key","data_flows"],"title":"DataCatalogDataFlow","type":"object"},"type":"array"},"copy_of":{"type":"string","x-nullable":true},"created_at":{"format":"double","type":"number"},"created_by":{"type":"string"},"dc_key":{"type":"string"},"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"proj_key":{"type":"string"},"provenance_logs":{"items":{"properties":{"collection_name":{"type":"string","x-nullable":true},"source":{"properties":{"ccs":{},"clone":{},"elastic":{},"file":{},"mongo_s3":{},"url":{}},"title":"DataCatalogProvenanceLogSource","type":"object","x-nullable":true},"timestamp":{"type":"number"},"user":{"properties":{"email":{"type":"string"},"name":{"type":"string"},"user_key":{"type":"string"}},"required":["user_key","name","email"],"title":"DataCatalogProvenanceLogUser","type":"object"}},"required":["user","timestamp","collection_name","source"],"title":"DataCatalogProvenanceLog","type":"object"},"type":"array"},"public":{"type":"boolean"},"topology":{"$ref":"#/definitions/DataCatalogTopology"}},"required":["name","description","dc_key","proj_key","created_by","created_at","copy_of","public","topology","category_schemas","collections_data_flows","provenance_logs"],"type":"object"},"DataCollection":{"properties":{"documents":{"type":"number"},"health":{"type":"string"},"metadata":{"properties":{"aliases":{"items":{"type":"string"},"type":"array"},"created":{"format":"datetime","type":"string"},"description":{"type":"string"},"domain":{"items":{"type":"string"},"type":"array"},"source":{"type":"string"},"storage":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"required":["aliases","created","description","source","version","type","domain"],"type":"object"},"name":{"type":"string"},"source":{"properties":{"elastic_id":{"type":"string"},"index_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["index_key"],"type":"object"},"status":{"type":"string"}},"required":["name","documents","health","status","metadata"],"type":"object"},"DataFlow":{"properties":{"created_at":{"format":"double","type":"number"},"description":{"type":"string"},"df_tpl_key":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"template":{"type":"object"},"updated_at":{"format":"double","type":"number"},"variables":{"additionalProperties":{"type":"object"},"type":"object"}},"type":"object"},"DataFlowTemplate":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"type":"object"},"type":"array"}},"required":["config","data-flow"],"type":"object"},"DataFlowTemplateListItem":{"properties":{"created_at":{"format":"double","type":"number"},"description":{"type":"string"},"df_tpl_key":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"updated_at":{"format":"double","type":"number"}},"type":"object"},"DataFlowTemplateVariable":{"enum":["string","boolean","number","integer","DataCatalogId","DictionaryId","KnowledgeGraphId","ModelConfigurationId","file","SecretString","ElasticId","DataCatalogCollection","DictionaryCollection","KnowledgeGraphCollection","CcsCollection","DocumentSources"],"type":"string"},"Dictionary":{"properties":{"collections":{"items":{"$ref":"#/definitions/DictionaryCollection"},"type":"array"},"copy_of":{"type":"string","x-nullable":true},"created_at":{"format":"double","type":"number"},"created_by":{"type":"string"},"description":{"type":"string","x-nullable":true},"dict_key":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","dict_key","proj_key","created_by","created_at","copy_of","public"],"type":"object"},"DictionaryCloneResult":{"properties":{"clone_task":{"$ref":"#/definitions/Task"},"dictionary":{"$ref":"#/definitions/Dictionary"}},"type":"object"},"DictionaryCollection":{"properties":{"item_count":{"type":"integer"},"name":{"type":"string"}},"required":["name","item_count"],"type":"object"},"DictionaryCollectionCsvData":{"properties":{"body":{"type":"string"},"header":{"type":"string"}},"required":["header","body"],"title":"DictionaryCollectionCsvData","type":"object"},"DictionaryCollectionObjectData":{"items":{"allOf":[{"$ref":"#/definitions/DictionaryEntry"}],"properties":{"_id":{"type":"string"}},"required":["_id"],"title":"DictionaryEntryWithId"},"title":"DictionaryCollectionObjectData","type":"array"},"DictionaryCollectionPatch":{"properties":{"op":{"enum":["add","replace","remove"],"type":"string"},"path":{"description":"A path (see JSON patch specification) in the format `/{objectid}` for existing objects, or `/-` for new objects (`add` operations).","pattern":"^/(?:-|[a-zA-Z0-9]{24})$","type":"string"},"value":{"$ref":"#/definitions/DictionaryEntry"}},"required":["op","path"],"type":"object"},"DictionaryEntry":{"additionalProperties":{},"properties":{"_name":{"type":"string"},"_synonyms":{"items":{"type":"string"},"type":"array"}},"required":["_name","_synonyms"],"type":"object"},"ElasticCoordinates":{"properties":{"ca_certificate_base64":{"type":"string"},"dangerously_disable_ssl_validation":{"type":"boolean"},"hosts":{"items":{"type":"string"},"type":"array"}},"required":["hosts"],"type":"object"},"ElasticIndexProperties":{"type":"object"},"ElasticIndexSearchQueryOptions":{"properties":{"_source":{"items":{"type":"string"},"type":"array"},"aggs":{"type":"object"},"from":{"minimum":0,"type":"number"},"query":{"additionalProperties":{},"type":"object"},"size":{"maximum":10000,"minimum":0,"type":"number"},"sort":{"items":{"type":"object"},"type":"array"}},"type":"object"},"EntityAnnotation":{"properties":{"match":{"type":"string"},"range":{"description":"2-Tuple representing the low and high indexes of the matching substring","items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"},"subtype":{"type":"string"},"type":{"type":"string"}},"required":["match","range","type"],"type":"object"},"EntityMapping":{"additionalProperties":{"type":"string"},"type":"object"},"FlavoursQuota":{"properties":{"display_name":{"type":"string"},"name":{"type":"string"},"quota":{"type":"integer"}},"required":["name","display_name"],"title":"FlavoursQuota","type":"object"},"KgSnapshot":{"properties":{"data_flow":{"type":"object","x-nullable":true},"is_current":{"type":"boolean"},"name":{"type":"string"},"project_task_id":{"type":"string"},"task_type":{"type":"string"},"timestamp":{"format":"double","type":"number"}},"type":"object"},"KgcDataInput":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"additionalProperties":{},"properties":{"config":{"additionalProperties":{},"properties":{"coordinates":{"additionalProperties":{},"properties":{"source":{"additionalProperties":{},"properties":{"bag_key":{"type":"string"},"collection":{"type":"string"},"dc_key":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"type":{"default":"bag","enum":["raw","bag","catalogue"],"type":"string"}},"type":"object"},"target":{"additionalProperties":{},"properties":{"bag_key":{"type":"string"},"collection":{"type":"string"},"dc_key":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"type":{"default":"bag","enum":["raw","bag","catalogue"],"type":"string"}},"type":"object"}},"type":"object"}},"required":["coordinates"],"type":"object"}},"required":["config"],"type":"object"},"type":"array"}},"required":["config","data-flow"],"type":"object"},"KibanaSavedQueriesResult":{"properties":{"description":{"type":"string"},"fields":{"items":{"type":"string"},"type":"array"},"query":{"type":"string"},"title":{"type":"string"}},"type":"object"},"LoadKgcDataInput":{"properties":{"dataflow":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"type":"object"},"type":"array"}},"type":"object"},"target":{"properties":{"bag_key":{"type":"string"},"save":{"type":"object"}},"required":["bag_key","save"],"type":"object"}},"required":["dataflow","target"],"type":"object"},"ModelConfiguration":{"properties":{"configurations":{"additionalProperties":{},"properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"created_at":{"format":"double","type":"number"},"created_by":{"type":"string"},"description":{"type":"string","x-nullable":true},"model_config_key":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"supported_annotations":{"type":"object"}},"required":["name","description","model_config_key","proj_key","created_by","created_at","public"],"type":"object"},"ModelSupportedAnnotationsParameters":{"properties":{"model_config_key":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"}},"required":["model_config_key","proj_key","public"],"type":"object"},"MongoCoordinates":{"properties":{"database":{"type":"string"},"uri":{"type":"string"}},"required":["uri","database"],"type":"object"},"MongoS3Coordinates":{"properties":{"mongo":{"$ref":"#/definitions/MongoCoordinates"},"s3":{"$ref":"#/definitions/S3Coordinates"}},"type":"object"},"MongoS3CoordinatesWithCollectionList":{"allOf":[{"$ref":"#/definitions/MongoS3Coordinates"},{"$ref":"#/definitions/CollectionListCoordinates"}]},"ObjectPropertyMap":{"type":"object"},"Problem":{"additionalProperties":{},"example":{"detail":"A descriptive message.","may_have_extra_fields":true,"status":500,"title":"An example title","type":"ExampleError"},"properties":{"detail":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"ProcessingModel":{"properties":{"dataflow":{"$ref":"#/definitions/ProcessingModelDataFlow"},"variables":{"additionalProperties":{"properties":{"type":{"type":"string"}},"required":["type"],"title":"DataFlowVariableDefinition","type":"object"},"type":"object"}},"required":["dataflow"],"type":"object"},"ProcessingModelDataFlow":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"type":"object"},"type":"array"}},"required":["config","data-flow"],"type":"object"},"ProcessingModelDescription":{"properties":{"description":{"type":"string"},"display_name":{"type":"string"},"name":{"type":"string"}},"required":["name","display_name","description"],"type":"object"},"ProjectDataIndexConversionSettings":{"description":"Specify the conversion settings to use.","properties":{"assemble":{"properties":{"include_incomplete_documents":{"title":"Include Incomplete Documents","type":"boolean"},"mode":{"properties":{"page_elements":{"items":{"enum":["H","M","None"],"type":"string"},"title":"Page Elements","type":"array"},"tables":{"items":{"enum":["H","M","None"],"type":"string"},"title":"Tables","type":"array"}},"required":["page_elements","tables"],"type":"object"}},"required":["mode","include_incomplete_documents"],"title":"Assemble Settings","type":"object"},"metadata":{"properties":{"description":{"title":"Description","type":"string"},"display_name":{"title":"Display Name","type":"string"},"licence":{"title":"Licence","type":"string"},"source":{"title":"Source","type":"string"},"version":{"title":"Version","type":"string"}},"title":"Collection Metadata Settings","type":"object"},"model_pipeline":{"properties":{"clusters":{"title":"Clusters","x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/0"},{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/1"}]},"normalization":{"title":"Normalization","x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/0"},{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/1"}]},"page":{"title":"Page","x-oneOf":[{"description":"Reference to a model configuration","properties":{"description":{"title":"Description","type":"string"},"model_config_key":{"title":"Model Config Key","type":"string"},"name":{"title":"Name","type":"string"},"proj_key":{"title":"Proj Key","type":"string"}},"required":["model_config_key","proj_key"],"type":"object"},{"description":"Direct configuration of a model","properties":{"config":{"title":"Config","type":"string"},"type":{"title":"Type","type":"string"}},"required":["type","config"],"type":"object"}]},"tables":{"title":"Tables","x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/0"},{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/1"}]}},"required":["clusters","page","tables","normalization"],"title":"Model Pipeline Settings","type":"object"},"ocr":{"properties":{"backend":{"title":"Backend","type":"string"},"backend_settings":{"title":"Backend Settings","type":"object"},"enabled":{"default":false,"title":"Enabled","type":"boolean"},"merge_mode":{"title":"Merge Mode","type":"string"}},"title":"OCR Settings","type":"object"},"page_labels":{"title":"Page Labels","type":"object"},"type":{"default":"direct","enum":["direct"],"title":"Type","type":"string"}},"title":"ProjectDataIndexConversionSettings","type":"object"},"ProjectDataIndexNonView":{"description":"Object to create a project data index","properties":{"description":{"description":"Description of the Index","maxLength":254,"minLength":1,"type":"string"},"name":{"description":"Name of the data index","maxLength":64,"minLength":1,"type":"string"},"schema_key":{"default":"generic","description":"Schema key","enum":["deepsearch-doc","deepsearch-db","generic"],"maxLength":64,"minLength":1,"type":"string"}},"required":["name"],"title":"ProjectDataIndexNonView","type":"object"},"ProjectDataIndexS3Coordinates":{"description":"Coordinates to COS","properties":{"access_key":{"title":"access_key","type":"string"},"bucket":{"title":"bucket","type":"string"},"host":{"title":"host","type":"string"},"key_prefix":{"title":"key_prefix","type":"string"},"location":{"title":"location","type":"string"},"port":{"title":"port","type":"number"},"secret_key":{"title":"secret_key","type":"string"},"ssl":{"title":"ssl","type":"boolean"},"verify_ssl":{"title":"verify_ssl","type":"boolean"}},"required":["host","port","ssl","verify_ssl","access_key","secret_key","bucket","location"],"title":"ProjectDataIndexCOSCoordinates","type":"object"},"ProjectDataIndexView":{"description":"Object to create a project data index view","properties":{"description":{"description":"Description of the index view","maxLength":254,"minLength":1,"type":"string"},"name":{"description":"Name of the data index view","maxLength":64,"minLength":1,"type":"string"},"view_of":{"properties":{"index_key":{"description":"Data index key","maxLength":64,"minLength":1,"type":"string"},"instance_id":{"description":"Instance id key, if the source is a data asset","maxLength":64,"minLength":1,"type":"string"},"proj_key":{"description":"Project id key, if the source is a project data index","maxLength":64,"minLength":1,"type":"string"},"query_options":{"$ref":"#/definitions/ElasticIndexSearchQueryOptions"}},"required":["index_key","query_options"],"title":"ProjectDataIndexViewOf","type":"object"}},"required":["name","view_of"],"title":"ProjectDataIndexView","type":"object"},"ProjectDataIndexWithStatus":{"description":"Project data index with elastic status","properties":{"creation_date":{"type":"string"},"description":{"type":"string"},"documents":{"type":"number"},"health":{"type":"string"},"name":{"type":"string"},"provenance":{"type":"string"},"record_properties":{"$ref":"#/definitions/ElasticIndexProperties"},"schema_key":{"description":"Index's schema key","enum":["deepsearch-doc","deepsearch-db","generic"],"type":"string"},"source":{"properties":{"index_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["proj_key","index_key"],"title":"ProjectDataIndexSource","type":"object"},"status":{"type":"string"},"type":{"description":"Index type, user friendly format","enum":["View","Document","DB Record","Generic","Experiment"],"type":"string"},"view_of":{"properties":{"elastic_id":{"type":"string"},"index_key":{"type":"string"},"proj_key":{"type":"string"},"query_options":{"$ref":"#/definitions/ElasticIndexSearchQueryOptions"}},"required":["index_key","query_options"],"type":"object"}},"required":["source","name","description","type","documents","health","status","creation_date"],"title":"ProjectDataIndexWithStatus","type":"object"},"ProjectDefaultValues":{"properties":{"ccs_project":{"properties":{"collection_name":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"}},"required":["proj_key","name"],"type":"object"},"dataflow":{"properties":{"df_tpl_key":{"type":"string"},"name":{"type":"string"}},"required":["df_tpl_key","name"],"type":"object"}},"type":"object"},"ProjectIntegrations":{"x-anyOf":[{"title":"Genai","x-anyOf":[{"description":"GenAI integration for watsonx settings","properties":{"config":{"description":"Config for watsonx","properties":{"GENAI_API":{"title":"Endpoint","type":"string"},"GENAI_KEY":{"format":"password","title":"Apikey","type":"string","writeOnly":true},"GENAI_PROJECT_ID":{"title":"Project Id","type":"string"}},"required":["endpoint","project_id","apikey"],"title":"GenAIWatsonxConfig","type":"object"},"kind":{"const":"watsonx","default":"watsonx","title":"Kind","type":"string"}},"required":["config"],"title":"GenAIWatsonx","type":"object"},{"description":"GenAI integration for BAM settings","properties":{"config":{"description":"Config for BAM","properties":{"GENAI_API":{"title":"Endpoint","type":"string"},"GENAI_KEY":{"format":"password","title":"Apikey","type":"string","writeOnly":true}},"required":["endpoint","apikey"],"title":"GenAIBAMConfig","type":"object"},"kind":{"const":"bam","default":"bam","title":"Kind","type":"string"}},"required":["config"],"title":"GenAIBAM","type":"object"},{"description":"GenAI integration for Inference API settings","properties":{"config":{"description":"Config for HF Inference API","properties":{"GENAI_HF_API_KEY":{"format":"password","title":"Genai Hf Api Key","type":"string","writeOnly":true}},"required":["GENAI_HF_API_KEY"],"title":"GenAIHFInferenceApiConfig","type":"object"},"kind":{"const":"hf_api","default":"hf_api","title":"Kind","type":"string"}},"required":["config"],"title":"GenAIHFInferenceApi","type":"object"},{"description":"GenAI integration for AWS Bedrock settings","properties":{"config":{"description":"Config for AWS Bedrock","properties":{"GENAI_AWS_ACCESS_KEY":{"format":"password","title":"Genai Aws Access Key","type":"string","writeOnly":true},"GENAI_AWS_REGION_NAME":{"title":"Genai Aws Region Name","type":"string"},"GENAI_AWS_SECRET_KEY":{"format":"password","title":"Genai Aws Secret Key","type":"string","writeOnly":true}},"required":["GENAI_AWS_ACCESS_KEY","GENAI_AWS_SECRET_KEY","GENAI_AWS_REGION_NAME"],"title":"GenAIAWSBedrockConfig","type":"object"},"kind":{"const":"aws_bedrock","default":"aws_bedrock","title":"Kind","type":"string"}},"required":["config"],"title":"GenAIAWSBedrock","type":"object"}]}]},"ProjectTask":{"properties":{"completed_at":{"format":"double","type":"number","x-nullable":true},"created_at":{"format":"double","type":"number"},"meta":{"type":"object"},"progress":{"format":"double","type":"number"},"proj_key":{"type":"string"},"started_at":{"format":"double","type":"number","x-nullable":true},"task_id":{"type":"string"},"task_status":{"type":"string"},"task_type":{"type":"string"},"user_key":{"type":"string"}},"type":"object"},"ProjectsFlavours":{"properties":{"flavours":{"items":{"properties":{"display_name":{"type":"string"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"},"name":{"type":"string"},"proj_key":{"type":"string"}},"required":["proj_key","name","flavours"],"type":"object"},"ProjectsFlavoursQuota":{"properties":{"name":{"type":"string"},"proj_key":{"type":"string"},"quotas":{"items":{"$ref":"#/definitions/FlavoursQuota"},"type":"array"}},"required":["proj_key","name","quotas"],"title":"ProjectsFlavoursQuota","type":"object"},"RelationshipAnnotation":{"type":"object"},"S3Coordinates":{"description":"If provided, the S3 data will be copied","properties":{"access-key":{"type":"string"},"bucket":{"type":"string"},"host":{"type":"string"},"key_prefix":{"type":"string"},"location":{"type":"string"},"port":{"type":"integer"},"secret-key":{"type":"string"},"ssl":{"type":"boolean"},"verifySSL":{"type":"boolean"}},"required":["host","port","ssl","verifySSL","access-key","secret-key","bucket","location","key_prefix"],"type":"object"},"S3CoordinatesWithBackupKey":{"properties":{"access-key":{"type":"string"},"backup_key":{"type":"string"},"bucket":{"type":"string"},"host":{"type":"string"},"location":{"type":"string"},"port":{"type":"integer"},"presigned":{"properties":{"fields":{"additionalProperties":{},"type":"object"},"url":{"type":"string"}},"required":["url","fields"],"type":"object"},"secret-key":{"type":"string"},"ssl":{"type":"boolean"},"verifySSL":{"type":"boolean"}},"required":["bucket","backup_key"],"type":"object"},"StorageSummaryDC":{"properties":{"dc_key":{"type":"string"},"name":{"type":"string"},"size_bytes_db":{"type":"number"},"size_bytes_s3":{"type":"number"},"size_converted_db":{"type":"string"},"size_converted_s3":{"type":"string"}},"required":["dc_key","name","size_bytes_db","size_converted_db","size_bytes_s3","size_converted_s3"],"type":"object"},"StorageSummaryKG":{"properties":{"bag_key":{"type":"string"},"categories_fraction":{"items":{"properties":{"color":{"type":"string"},"name":{"type":"string"},"percentage":{"type":"number"},"size_bytes_db":{"type":"number"},"size_converted_db":{"type":"string"}},"required":["name","percentage","size_bytes_db","size_converted_db"],"type":"object"},"type":"array"},"name":{"type":"string"},"size_bytes_db":{"type":"number"},"size_bytes_s3":{"type":"number"},"size_converted_db":{"type":"string"},"size_converted_s3":{"type":"string"}},"required":["bag_key","name","size_bytes_db","size_converted_db","size_bytes_s3","size_converted_s3","categories_fraction"],"type":"object"},"StorageSummaryTask":{"properties":{"dc_key":{"type":"string"},"kg_key":{"type":"string"},"kind":{"enum":["project_task","celery_task"],"type":"string"},"proj_key":{"type":"string"},"task_id":{"type":"string"}},"required":["task_id","proj_key","kind"],"type":"object"},"SystemInfo":{"properties":{"allow_non_admins_to_make_resources_public":{"type":"boolean"},"api":{"properties":{"build_date":{"type":"integer"},"commit_hash":{"type":"string"},"version":{"type":"string"}},"type":"object"},"deployment":{"properties":{"disable_kg_actions":{"type":"boolean"},"disclaimer":{"type":"string"},"linked_ccs_api":{"properties":{"project_sync":{"type":"boolean"},"uri":{"type":"string"}},"type":"object"},"name":{"type":"string"},"should_show_warning":{"type":"boolean"}},"type":"object"},"toolkit":{"properties":{"cli_command":{"type":"string"},"host":{"type":"string"},"name":{"type":"string"},"required_version":{"type":"string","x-nullable":true},"verify_ssl":{"type":"boolean"}},"type":"object"}},"type":"object"},"SystemModulesConfiguration":{"properties":{"df_template_variables":{"items":{"properties":{"description":{"type":"string"},"id":{"type":"string"},"type":{"$ref":"#/definitions/DataFlowTemplateVariable"}},"required":["description","id","type"],"title":"WellKnownDfTemplateVariable","type":"object"},"type":"array"},"linked_ccs_instances":{"items":{"properties":{"description":{"type":"string"},"id":{"type":"string"}},"required":["description","id"],"title":"LinkedCcsInstances","type":"object"},"type":"array"},"linked_elastic_instances":{"items":{"properties":{"description":{"type":"string"},"id":{"type":"string"}},"required":["description","id"],"title":"LinkedElasticInstances","type":"object"},"type":"array"}},"required":["df_template_variables","linked_ccs_instances","linked_elastic_instances"],"type":"object"},"SystemModulesTasks":{"properties":{"tasks":{"additionalProperties":{"properties":{"schema":{"type":"object"}},"type":"object"},"type":"object"}},"type":"object"},"TakeSnapshotSettings":{"properties":{"flavour":{"type":"string"},"load_into_kg_after_created":{"default":false,"type":"boolean"},"name":{"type":"string"}},"required":["flavour"],"type":"object"},"TakeSnapshotSettingsBackendAware":{"properties":{"backend_flavours":{"properties":{"kg_amqp":{"type":"string"},"kg_legacy_api":{"type":"string"}},"title":"BackendFlavour","type":"object"},"load_into_kg_after_created":{"default":false,"type":"boolean"},"name":{"type":"string"}},"required":["backend_flavours"],"type":"object"},"Task":{"properties":{"error_reason":{"type":"string","x-nullable":true},"kind":{"enum":["project_task","celery_task"],"type":"string"},"proj_key":{"type":"string"},"related_tasks":{"items":{"properties":{"task_id":{"type":"string"},"task_type":{"type":"string"}},"required":["task_id","task_type"],"title":"RelatedTask","type":"object"},"type":"array"},"task_id":{"type":"string"},"task_status":{"type":"string"},"task_type":{"type":"string"}},"required":["task_id","task_type","task_status","proj_key","error_reason","kind"],"type":"object"},"TokenResponse":{"properties":{"token":{"type":"string"}},"required":["token"],"type":"object"},"Topology":{"properties":{"categories":{"items":{"$ref":"#/definitions/TopologyNode"},"type":"array"},"edges":{"items":{"$ref":"#/definitions/TopologyEdge"},"type":"array"}},"required":["categories","edges"],"type":"object"},"TopologyEdge":{"properties":{"name":{"type":"string"},"source":{"items":{"type":"string"},"type":"array"},"target":{"items":{"type":"string"},"type":"array"}},"required":["name","source","target"],"type":"object"},"TopologyNode":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"WorkFlow":{"type":"object"},"error_response":{"properties":{"error_code":{"type":"string","x-nullable":true},"error_message":{"type":"string"}},"required":["error_message"],"type":"object"}},"info":{"title":"Corpus Processing Service (CPS) API","version":"2.0.0"},"paths":{"/backend/project/{proj_key}/bags":{"get":{"description":"List all bags in the project, backend-aware","operationId":"backend_list_project_kgs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"term","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/BagBackendAware"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"description":"Create new BAG, backend-aware","operationId":"backend_create_project_kg","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"properties":{"description":{"description":"Description of the BAG","type":"string","x-nullable":true},"flavours":{"description":"Flavours names of the bag. Determines its available resources","items":{"type":"string"},"type":"array"},"name":{"description":"Name of the BAG","maxLength":32,"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"description":"If true, the BAG will be publicly available","type":"boolean"}},"required":["name","flavours","public"],"title":"CreateKnowledgeGraphOptions","type":"object"},"x-body-name":"data"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/BagBackendAware"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"403":{"description":"Create knowledge graphs is disabled.","schema":{"$ref":"#/definitions/Problem"}},"409":{"description":"Cannot create BAG because one already exists with that name.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/backend/project/{proj_key}/bags/{bag_key}":{"patch":{"description":"Update the metadata of a Knowledge graph, backend-aware","operationId":"backend_update_project_kg_metadata","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"additionalProperties":false,"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"PatchKnowledgeGraphOptions","type":"object"},"x-body-name":"data"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge graph metadata updated.","schema":{"$ref":"#/definitions/BagBackendAware"}},"404":{"description":"Knowledge graph not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/backend/project/{proj_key}/bags/{bag_key}/status":{"get":{"description":"Get the status of a Knowledge Graph, backend-aware","operationId":"backend_get_project_kg_status","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"default":false,"in":"query","name":"details","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge Graph status.","schema":{"$ref":"#/definitions/BagStatusBackendAware"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow":{"post":{"consumes":["application/json"],"description":"Assemble a data flow on a Knowledge Graph, backend-aware","operationId":"backend_assemble_project_kg_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"data_flow":{"properties":{"df_tpl_key":{"description":"If set, the data flow with this key will be used.","type":"string"},"proj_key":{"description":"If set, allows for cross-project data flows to be used.","type":"string"},"public":{"description":"Must be set if the data flow template is public","type":"boolean"},"raw_data_flow":{"description":"If this is set, the raw data flow contents will be used.","properties":{"template":{"description":"Must be valid JSON","type":"string"},"variables":{"type":"object"}},"required":["template","variables"],"type":"object"}},"type":"object"},"render":{"properties":{"variables":{"additionalProperties":{},"type":"object"}},"required":["variables"],"type":"object"},"snapshot":{"$ref":"#/definitions/TakeSnapshotSettingsBackendAware"}},"required":["render","data_flow"],"title":"AssembleDataFlowIntoKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots":{"post":{"description":"Create a snapshot of a Knowledge Graph from the last data flow assembly task, backend-aware","operationId":"backend_create_project_kg_snapshot_from_data_flow_assembly","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"snapshot":{"$ref":"#/definitions/TakeSnapshotSettingsBackendAware"}},"required":["snapshot"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"KG/BAG/Data Flow Assembly not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/deployment/info":{"get":{"description":"Get deployment version report","operationId":"get_version_report","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"OK"},"401":{"description":"Authentication failed, management api token is invalid or doesn't match","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"ManagementKey":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/elastic/domains":{"get":{"description":"List system elastic domains.","operationId":"get_elastic_domains","produces":["application/json"],"responses":{"200":{"description":"List of Elastic Domains.","schema":{"items":{"type":"string"},"type":"array"}},"404":{"description":"Domains not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/elastic/indices/{index_type}/{index_domain}":{"get":{"description":"List of indices for elastic instance.","operationId":"list_indices_from_elastic_instance","parameters":[{"default":"all","in":"path","name":"index_type","required":true,"type":"string"},{"default":"all","in":"path","name":"index_domain","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of Elastic Instance Indices","schema":{"items":{"$ref":"#/definitions/DataCollection"},"type":"array"}},"404":{"description":"Instance indices not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/elastic/query_max_size":{"get":{"description":"Get the system maximum workable elastic query size.","operationId":"get_elastic_query_max_size","produces":["application/json"],"responses":{"200":{"description":"Maximum elastic query size.","schema":{"properties":{"elastic_query_max_size":{"type":"number"}},"type":"object"}},"404":{"description":"No maximum workable elastic query size found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/elastic/{elastic_instance}/{elastic_index}/properties":{"get":{"description":"Get the property schema of the given index.","operationId":"get_index_properties","parameters":[{"in":"path","name":"elastic_instance","required":true,"type":"string"},{"in":"path","name":"elastic_index","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Property schema","schema":{"$ref":"#/definitions/ElasticIndexProperties"}},"404":{"description":"Instance index not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/elastic/{elastic_instance}/{elastic_index}/saved_queries":{"get":{"description":"List Kibana saved queries.","operationId":"get_kibana_saved_queries","parameters":[{"in":"path","name":"elastic_instance","required":true,"type":"string"},{"in":"path","name":"elastic_index","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of Kibana saved queries","schema":{"items":{"$ref":"#/definitions/KibanaSavedQueriesResult"},"title":"KibanaSavedQueriesResult","type":"array"}},"404":{"description":"Instance indices not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/processing_models":{"get":{"description":"List the available processing models.","operationId":"get_processing_models","produces":["application/json"],"responses":{"200":{"description":"List of processing models and their description","schema":{"properties":{"processing_models":{"items":{"$ref":"#/definitions/ProcessingModelDescription"},"type":"array"}},"required":["processing_models"],"type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Processing Model"],"x-swagger-router-controller":"api_server.controllers.processing_model_controller"}},"/processing_models/docs_graph_with_databases":{"post":{"consumes":["application/json"],"description":"Create a Data Flow from a list of CCS Collections and CPS Models.","operationId":"create_data_flow_from_df_wizard","parameters":[{"in":"body","name":"body","required":true,"schema":{"properties":{"access_token":{"type":"string"},"catalog_document_collections":{"items":{"$ref":"#/definitions/CatalogReference"},"type":"array"},"ccs_document_collections":{"items":{"$ref":"#/definitions/CcsCollectionReference"},"type":"array"},"data_catalogs":{"items":{"$ref":"#/definitions/CatalogReference"},"type":"array"},"entity_mappings":{"$ref":"#/definitions/EntityMapping"},"models":{"items":{"$ref":"#/definitions/CpsModelReference"},"type":"array"}},"required":["ccs_document_collections","catalog_document_collections","models","access_token"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Processing model generated successfully","schema":{"$ref":"#/definitions/ProcessingModel"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Processing Model"],"x-swagger-router-controller":"api_server.controllers.processing_model_controller"}},"/project/data_cataloges/known_schemas":{"get":{"description":"List System Known Data Catalog Schemas.","operationId":"list_known_data_catalog_schemas","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"List of Known Data Catalog Schemas.","schema":{"items":{"$ref":"#/definitions/DataCatalogSchema"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/data_catalogues/with_schema":{"post":{"description":"List data catalogues with specific schema","operationId":"list_data_catalogs_and_collections_from_schema","parameters":[{"in":"query","name":"proj_key","required":false,"type":"string"},{"in":"body","name":"schema","required":true,"schema":{"additionalProperties":{},"type":"object"},"x-body-name":"schema"}],"produces":["application/json"],"responses":{"200":{"description":"List of data catalogues","schema":{"items":{"$ref":"#/definitions/DataCatalogue"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/bags":{"get":{"description":"List all public BAGs","operationId":"list_public_knowledge_graphs","parameters":[{"in":"query","name":"term","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Bag"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/public/data_catalogues":{"get":{"description":"List public data catalogues","operationId":"list_public_data_catalogs","parameters":[{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of public data catalogues","schema":{"items":{"$ref":"#/definitions/DataCatalogue"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/data_catalogues/{dc_key}":{"get":{"description":"Get a single data catalogue that was made public","operationId":"get_public_data_catalog","parameters":[{"in":"path","name":"dc_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue","schema":{"$ref":"#/definitions/DataCatalogue"}},"404":{"description":"Data catalogue not found or is not public","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/data_catalogues/{dc_key}/actions/clone":{"post":{"consumes":["application/json"],"description":"Clone an existing public data catalogue","operationId":"clone_public_data_catalog","parameters":[{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"collections":{"items":{"type":"string"},"type":"array"},"copy_s3":{"default":true,"description":"Should the catalog's S3 data also be copied?","type":"boolean"},"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string","x-nullable":true},"proj_key":{"description":"The project key of the project to store the resulting data catalogue","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public","proj_key"],"title":"ClonePublicDataCatalogOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue cloned, and data is being copied.","schema":{"$ref":"#/definitions/CloneDataCatalogResult"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/data_catalogues/{dc_key}/collections":{"get":{"description":"Get the collections of a data catalog.","operationId":"list_public_data_catalog_collections","parameters":[{"in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog collections","schema":{"items":{"$ref":"#/definitions/DataCatalogCollection"},"type":"array"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/dictionaries":{"get":{"description":"List public dictionaries","operationId":"list_public_dictionaries","parameters":[{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of public dictionaries","schema":{"items":{"$ref":"#/definitions/Dictionary"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/public/dictionaries/{dict_key}":{"get":{"description":"Get a single dictionary that was made public","operationId":"get_public_dictionary","parameters":[{"in":"path","name":"dict_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary","schema":{"$ref":"#/definitions/Dictionary"}},"404":{"description":"Dictionary not found or is not public","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/public/dictionaries/{dict_key}/actions/clone":{"post":{"consumes":["application/json"],"description":"Clone an existing public dictionary","operationId":"clone_public_dictionary","parameters":[{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"collections":{"items":{"type":"string"},"type":"array"},"copy_s3":{"default":true,"description":"Should the dictionary's S3 data also be copied?","type":"boolean"},"description":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"proj_key":{"description":"The project key of the project to store the resulting dictionary","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public","proj_key"],"title":"ClonePublicDictionaryOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary cloned, and data is being copied.","schema":{"$ref":"#/definitions/DictionaryCloneResult"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/public/dictionaries/{dict_key}/collections":{"get":{"description":"Get the collections of a dictionary.","operationId":"list_public_dictionary_collections","parameters":[{"in":"path","name":"dict_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary collections","schema":{"items":{"$ref":"#/definitions/DictionaryCollection"},"type":"array"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/public/kgc/dataflow_templates":{"get":{"description":"List public data flow templates","operationId":"list_public_data_flow_templates","parameters":[{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of data flow templates.","schema":{"items":{"$ref":"#/definitions/DataFlowTemplateListItem"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/public/kgc/dataflow_templates/{df_tpl_key}":{"get":{"description":"Get a single data flow template","operationId":"get_public_data_flow_template","parameters":[{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data flow.","schema":{"$ref":"#/definitions/DataFlow"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/public/kgc/dataflow_templates/{df_tpl_key}/export.json":{"post":{"description":"Export a single public data flow template","operationId":"export_public_data_flow_template","parameters":[{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/vnd.ibm.cps.df-template+json"],"responses":{"200":{"description":"Data flow template.","schema":{"type":"file"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/public/model_configs":{"get":{"description":"List public Model Configurations","operationId":"list_public_model_configs","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"List of public Model Configurations","schema":{"items":{"$ref":"#/definitions/ModelConfiguration"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/public/model_configs/{model_config_key}":{"get":{"description":"Get a single Model Configuration that was made public","operationId":"read_public_model_config","parameters":[{"in":"path","name":"model_config_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Model configuration","schema":{"$ref":"#/definitions/ModelConfiguration"}},"404":{"description":"Model configuration not found or is not public","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/{proj_key}/annotate/document":{"post":{"description":"Run an annotator on a document","operationId":"annotate_document","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"document":{"type":"object"},"image_annotators":{"items":{"$ref":"#/definitions/AnnotatorParametersOrRef"},"type":"array"},"table_annotators":{"items":{"$ref":"#/definitions/AnnotatorParametersOrRef"},"type":"array"},"text_annotators":{"items":{"$ref":"#/definitions/AnnotatorParametersOrRef"},"type":"array"},"use_cache":{"default":true,"type":"boolean"}},"required":["document","text_annotators","image_annotators","table_annotators"],"title":"AnnotateDocumentRequest","type":"object"},"x-body-name":"body"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Inspection"],"x-swagger-router-controller":"api_server.controllers.document_inspect_controller"}},"/project/{proj_key}/annotate/document/report":{"post":{"description":"Submit a report on an inspected document","operationId":"report_inspected_document","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"document":{"properties":{"input_scratch_id":{"type":"string"},"output_scratch_id":{"type":"string"}},"required":["input_scratch_id","output_scratch_id"],"type":"object"},"document_annotation_parameters":{"type":"object"},"document_conversion_parameters":{"type":"object"},"report":{"properties":{"description":{"type":"string"},"review_consent":{"type":"boolean"}},"required":["review_consent"],"type":"object"}},"required":["document","report"],"title":"AnnotatedDocumentReport","type":"object"},"x-body-name":"body"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Inspection"],"x-swagger-router-controller":"api_server.controllers.document_inspect_controller"}},"/project/{proj_key}/annotate/document/results/{document_hash}":{"delete":{"description":"Delete annotation results for a document","operationId":"delete_document_annotation_result","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"document_hash","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK"},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Inspection"],"x-swagger-router-controller":"api_server.controllers.document_inspect_controller"}},"/project/{proj_key}/annotate/document/tasks/{task_id}":{"get":{"description":"Get the result of a previous document annotation","operationId":"get_annotate_document_result","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"},{"description":"Allow the response to be delayed for a few seconds to wait for the result, instead of doing client-side polling.","in":"query","maximum":10,"minimum":0,"name":"wait","required":false,"type":"number"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"properties":{"done":{"type":"boolean"},"result":{"type":"object","x-nullable":true},"task_id":{"type":"string"},"task_status":{"type":"string"}},"required":["task_id","task_status","result","done"],"type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Inspection"],"x-swagger-router-controller":"api_server.controllers.document_inspect_controller"}},"/project/{proj_key}/annotate/inspection_report":{"get":{"description":"Get paginated list of inspection reports for a project","operationId":"list_project_inspection_report","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"description":"page of the result list","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"items on one page of the result list","in":"query","name":"items_per_page","required":false,"type":"integer"},{"description":"search keyword","in":"query","name":"search_string","required":false,"type":"string"},{"description":"begin date of the search date interval","in":"query","name":"begin_date","required":false,"type":"integer"},{"description":"end date of the search date interval","in":"query","name":"end_date","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"Reports","schema":{"items":{"properties":{"document":{"type":"string"},"id":{"description":"ID of the inpection report.","type":"string"},"proj_key":{"type":"string"},"timestamp":{"type":"number"},"user_key":{"type":"string"}},"required":["id","proj_key","user_key","timestamp","document"],"title":"InspectionReport","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Inspection"],"x-swagger-router-controller":"api_server.controllers.document_inspect_controller"}},"/project/{proj_key}/annotate/supported_annotations":{"post":{"description":"Get supported annotations for an annotator","operationId":"get_project_annotator_supported_annotations","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"x-oneOf":[{"$ref":"#/definitions/AnnotatorSupportedAnnotationsParameters"},{"$ref":"#/definitions/ModelSupportedAnnotationsParameters"}]}}],"produces":["application/json","text/html"],"responses":{"200":{"description":"OK","schema":{"properties":{"entities":{"items":{"properties":{"data_fields":{"items":{"type":"string"},"type":"array","uniqueItems":true},"description":{"type":"string"},"key":{"type":"string"}},"required":["key","description"],"title":"EntityAnnotationDescriptor","type":"object"},"type":"array"},"relationships":{"items":{"properties":{"columns":{"items":{"properties":{"entities":{"items":{"type":"string"},"type":"array"},"key":{"type":"string"}},"required":["key","entities"],"title":"RelationshipAnnotationColumn","type":"object"},"type":"array"},"description":{"type":"string"},"key":{"type":"string"}},"required":["key","description","columns"],"title":"RelationshipAnnotationDescriptor","type":"object"},"type":"array"},"supported_object_types":{"items":{"type":"string"},"type":"array"}},"required":["entities","relationships"],"title":"SupportedAnnotatorAnnotations","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Annotate"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/annotator/metadata":{"post":{"description":"Get annotator's metadata","operationId":"get_cached_annotator_metadata","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"x-oneOf":[{"$ref":"#/definitions/AnnotatorSupportedAnnotationsParameters"},{"$ref":"#/definitions/ModelSupportedAnnotationsParameters"}]}}],"produces":["application/json","text/html"],"responses":{"200":{"description":"OK","schema":{"properties":{"author":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"version":{"type":"string"}},"required":["name","version","url","author","description"],"title":"AnnotatorMetadata","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Annotate"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/bags":{"get":{"deprecated":true,"description":"List all bags in the project","operationId":"list_project_knowledge_graphs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"term","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Bag"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"deprecated":true,"description":"Create new BAG","operationId":"create_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"properties":{"description":{"description":"Description of the BAG","type":"string","x-nullable":true},"flavour":{"description":"\"Flavour\" of the BAG, determines its available resources.","type":"string"},"name":{"description":"Name of the BAG","maxLength":32,"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"description":"If true, the BAG will be publicly available","type":"boolean"}},"required":["name","flavour","public"],"title":"CreateKnowledgeGraphOptions","type":"object"},"x-body-name":"data"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/Bag"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"403":{"description":"Create knowledge graphs is disabled.","schema":{"$ref":"#/definitions/Problem"}},"409":{"description":"Cannot create BAG because one already exists with that name.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}":{"delete":{"description":"Delete a BAG","operationId":"delete_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"BAG deleted."},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"patch":{"description":"Update the metadata of a Knowledge graph","operationId":"update_project_knowledge_graph_metadata","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"additionalProperties":false,"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"PatchKnowledgeGraphOptions","type":"object"},"x-body-name":"data"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge graph metadata updated.","schema":{"$ref":"#/definitions/Bag"}},"404":{"description":"Knowledge graph not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/auth_callback":{"get":{"description":"Final step of redirection for authentication on a BAG.","operationId":"get_project_knowledge_graph_authentication_callback","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"query","name":"bag_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"BAG auth redirect URL.","schema":{"properties":{"callback_url":{"type":"string"}},"title":"KnowledgeGraphAuthenticationCallback","type":"object"}},"401":{"description":"Unauthorized.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/auth_token":{"get":{"description":"Get a token used to authenticate in the Erlenmeyer / KG APIs of a BAG.","operationId":"create_project_knowledge_graph_authentication_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"BAG auth token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a BAG.","operationId":"create_project_knowledge_graph_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"BAG deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/snapshots":{"get":{"description":"List snapshots for a knowledge graph from assembled data flows.","operationId":"list_project_knowledge_graph_snapshots","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Snapshots","schema":{"items":{"$ref":"#/definitions/KgSnapshot"},"type":"array"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"description":"Create a snapshot of a Knowledge Graph, with its current state.","operationId":"create_project_knowledge_graph_snapshot","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"name":{"pattern":"^(?:\\w| |-)+$","type":"string"}},"required":["name"],"title":"KnowledgeGraphSnapshotOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"403":{"description":"Feature is disabled on this instance.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.kg_controller"}},"/project/{proj_key}/bags/{bag_key}/snapshots/{execution_id}":{"delete":{"description":"Delete a snapshot resulting from an assembled data flow. The execution log itself is not deleted.","operationId":"delete_project_knowledge_graph_snapshot","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"path","name":"execution_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"OK"},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG/Snapshot not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/snapshots/{execution_id}/actions/load":{"post":{"description":"Load a snapshot resulting from an assembled data flow","operationId":"load_project_knowledge_graph_snapshot","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"path","name":"execution_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Snapshot is being loaded.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"403":{"description":"Feature is disabled on this instance.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG/Snapshot not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/status":{"get":{"deprecated":true,"description":"Get the status of a Knowledge Graph","operationId":"get_project_knowledge_graph_status","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"default":false,"in":"query","name":"details","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge Graph status.","schema":{"$ref":"#/definitions/BagStatus"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow":{"get":{"deprecated":true,"description":"List assemble tasks for a Knowledge Graph.","operationId":"list_project_knowledge_graph_assemble_tasks","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"default":50,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"},{"default":0,"in":"query","minimum":0,"name":"skip","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"List of tasks.","schema":{"items":{"properties":{"data_flow":{"properties":{"render_options":{"properties":{"target_bag":{"type":"object"},"variables":{"type":"object"}},"type":"object"},"template":{"type":"string"},"variables":{"type":"object"}},"type":"object"},"timestamp":{"format":"double","type":"number"}},"title":"DataFlowAssembleIntoKnowledgeGraphTask","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"consumes":["application/json"],"deprecated":true,"description":"Assemble a data flow on a Knowledge Graph","operationId":"assemble_project_knowledge_graph_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"data_flow":{"properties":{"df_tpl_key":{"description":"If set, the data flow with this key will be used.","type":"string"},"proj_key":{"description":"If set, allows for cross-project data flows to be used.","type":"string"},"public":{"description":"Must be set if the data flow template is public","type":"boolean"},"raw_data_flow":{"description":"If this is set, the raw data flow contents will be used.","properties":{"template":{"description":"Must be valid JSON","type":"string"},"variables":{"type":"object"}},"required":["template","variables"],"type":"object"}},"type":"object"},"render":{"properties":{"variables":{"additionalProperties":{},"type":"object"}},"required":["variables"],"type":"object"},"snapshot":{"$ref":"#/definitions/TakeSnapshotSettings"}},"required":["render","data_flow"],"title":"AssembleDataFlowIntoKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots":{"post":{"deprecated":true,"description":"Create a snapshot of a Knowledge Graph from the last data flow assembly task.","operationId":"create_project_knowledge_graph_snapshot_from_data_flow_assembly","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"snapshot":{"$ref":"#/definitions/TakeSnapshotSettings"}},"required":["snapshot"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"KG/BAG/Data Flow Assembly not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/backup":{"post":{"description":"Back up a Knowledge Graph","operationId":"create_project_knowledge_graph_backup","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"backup_s3":{"default":true,"type":"boolean"},"coordinates":{"$ref":"#/definitions/S3CoordinatesWithBackupKey"}},"title":"BackupKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/export":{"post":{"description":"Download a Knowledge Graph","operationId":"download_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/export_dataset":{"post":{"description":"Export dataset from a Knowledge Graph","operationId":"export_dataset","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"properties":{"info":{"properties":{"collection_key":{"type":"string"},"coords":{"properties":{"databases":{"additionalProperties":true,"type":"object"},"node_collection":{"properties":{"collection":{"type":"string"},"collection_name_prefix":{"type":"string"},"database":{"type":"string"},"uri":{"type":"string"}},"required":["uri","database","collection_name_prefix","collection"],"type":"object"}},"required":["databases","node_collection"],"type":"object"},"include_s3_data":{"default":false,"type":"boolean"},"node_list":{"example":[{"_db":"db1-hash","_id":"node-id"},{"_db":"db2-hash","_id":"node-id"}],"items":{"properties":{"_db":{"type":"string"},"_id":{"type":"string"}},"required":["_db","_id"],"type":"object"},"minLength":1,"type":"array"},"projection":{"description":"A dict specifying the fields to include or exclude. Use a dict to exclude fields from the result (e.g. projection={'main-text': false}).","example":{"projection":{}},"type":"object"}},"required":["coords"],"type":"object"}},"required":["info"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"Task not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]},{"KGAuth":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.kg_controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/load_dataflow":{"get":{"description":"List load tasks for a Knowledge Graph","operationId":"list_project_knowledge_graph_load_tasks","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"default":50,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"},{"default":0,"in":"query","minimum":0,"name":"skip","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"List of tasks.","schema":{"items":{"properties":{"data_flow":{"properties":{"render_options":{"properties":{"target_bag":{"type":"object"},"variables":{"type":"object"}},"type":"object"},"template":{"type":"string"},"variables":{"type":"object"}},"type":"object"},"save":{"type":"object"},"timestamp":{"format":"double","type":"number"}},"title":"DataFlowLoadIntoKnowledgeGraphTask","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"consumes":["application/json"],"description":"Load a data flow onto a Knowledge Graph.","operationId":"load_project_knowledge_graph_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"data_flow":{"properties":{"df_tpl_key":{"description":"If set, the data flow with this key will be used.","type":"string"},"proj_key":{"description":"If set, allows for cross-project data flows to be used.","type":"string"},"public":{"description":"Must be set if the data flow template is public","type":"boolean"},"raw_data_flow":{"description":"If this is set, the raw data flow contents will be used.","properties":{"template":{"description":"Must be valid JSON","type":"string"},"variables":{"type":"object"}},"required":["template","variables"],"type":"object"}},"type":"object"},"render":{"properties":{"variables":{"additionalProperties":{},"type":"object"}},"required":["variables"],"type":"object"},"save":{"type":"object"}},"required":["save","render","data_flow"],"title":"LoadDataFlowIntoKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/recreate_deployment":{"post":{"consumes":["application/json"],"description":"(Re)create the deployment for a Knowledge Graph","operationId":"recreate_project_knowledge_graph_deployment","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"force":{"type":"boolean"}},"required":["force"],"title":"KnowledgeGraphDeploymentRecreationOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Deployment upgrading."},"404":{"description":"Knowledge Graph doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"409":{"description":"Refused to recreate the deployment since it already exists and the `force` flag is not `true`.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/restore":{"post":{"description":"Restore a back up of a Knowledge Graph","operationId":"restore_project_knowledge_graph_backup","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"coordinates":{"$ref":"#/definitions/S3CoordinatesWithBackupKey"}},"title":"RestoreKnowledgeGraphBackupOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/resume":{"post":{"consumes":["application/json"],"description":"Resume a Knowledge Graph","operationId":"resume_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"reset":{"type":"boolean"},"snapshot_to_restore_id":{"type":"string"}},"title":"ResumeKnowledgeGraphOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"403":{"description":"Feature is disabled on this instance.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Knowledge Graph doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/suspend":{"post":{"consumes":["application/json"],"description":"Suspend a Knowledge Graph","operationId":"suspend_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"force":{"description":"If true, the KG will be suspended even if it's busy","type":"boolean"},"snapshot":{"properties":{"name":{"type":"string"}},"type":"object"}},"required":["force"],"title":"SuspendKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"Knowledge Graph doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/upgrade":{"post":{"consumes":["application/json"],"description":"Upgrade the deployment chart of a Knowledge Graph","operationId":"upgrade_project_knowledge_graph_deployment","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"chart":{"type":"string"}},"title":"KnowledgeGraphChartUpgradeOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Chart upgrading."},"404":{"description":"Knowledge Graph doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/usage_stats":{"get":{"description":"Get the usage stats of a Knowledge Graph","operationId":"get_project_knowledge_graph_usage_stats","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge Graph usage stats.","schema":{"properties":{"bag_key":{"type":"string"},"last_command":{"type":"string"},"proj_key":{"type":"string"}},"title":"UsageStats","type":"object"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/celery_tasks/{task_id}":{"get":{"description":"Get a celery task for a project.","operationId":"get_project_celery_task","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Task","schema":{"properties":{"result":{"x-nullable":true},"task_id":{"type":"string"},"task_status":{"type":"string"}},"required":["task_id","task_status","result"],"title":"CeleryTaskPromise","type":"object"}},"404":{"description":"Task not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/data_catalogues":{"get":{"description":"List data catalogues for a project","operationId":"list_project_data_catalogs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of data catalogues","schema":{"items":{"$ref":"#/definitions/DataCatalogue"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"},"post":{"consumes":["application/json"],"description":"Create an empty data catalog","operationId":"create_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"category_schemas":{"items":{"properties":{"key":{"type":"string"},"schema":{"additionalProperties":{},"type":"object"}},"required":["key","schema"],"title":"DataCatalogCategorySchema","type":"object"},"type":"array"},"collections_data_flows":{"items":{"properties":{"data_flows":{"items":{"type":"object"},"type":"array"},"key":{"type":"string"}},"required":["key","data_flows"],"title":"DataCatalogDataFlow","type":"object"},"type":"array"},"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"},"topology:data_flows":{"items":{"$ref":"#/definitions/DataCatalogTopology","properties":{"data_flows":{"additionalProperties":{},"type":"object"},"key":{"type":"string"}},"required":["key","data_flows"],"title":"DataCatalogDataFlow","type":"object"},"type":"array"}},"required":["name","description","public"],"title":"CreateDataCatalogOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog created.","schema":{"$ref":"#/definitions/DataCatalogue"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/from_mongo":{"post":{"consumes":["application/json"],"description":"Create a data catalogue from a mongo database","operationId":"import_project_data_catalog_from_mongo","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"options":{"properties":{"coordinates":{"$ref":"#/definitions/MongoS3CoordinatesWithCollectionList"}},"required":["coordinates"],"type":"object"},"target":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"type":"object"}},"required":["target","options"],"title":"DataCatalogImportOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue created, and data is being imported.","schema":{"$ref":"#/definitions/DataCatalogImportResult"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/from_url":{"post":{"consumes":["application/json"],"description":"Create a data catalogue from a URL to a file","operationId":"import_project_data_catalog_from_url","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"options":{"properties":{"url":{"type":"string"}},"required":["url"],"type":"object"},"target":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"type":"object"}},"required":["target","options"],"title":"DataCatalogUrlImportOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue created, and data is being imported.","schema":{"$ref":"#/definitions/DataCatalogImportResult"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}":{"delete":{"description":"Delete a single data catalog","operationId":"delete_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Data catalog deleted."},"404":{"description":"Data catalog doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"},"get":{"description":"Get a single data catalogue","operationId":"get_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue","schema":{"$ref":"#/definitions/DataCatalogue"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"},"patch":{"consumes":["application/json"],"description":"Update the metadata of a data catalog.","operationId":"patch_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"additionalProperties":false,"properties":{"category_schemas":{"items":{"properties":{"key":{"type":"string"},"schema":{"additionalProperties":{},"type":"object"}},"required":["key","schema"],"title":"DataCatalogCategorySchema","type":"object"},"type":"array"},"collections_data_flows":{"items":{"properties":{"data_flows":{"items":{"type":"object"},"type":"array"},"key":{"type":"string"}},"required":["key","data_flows"],"title":"DataCatalogDataFlow","type":"object"},"type":"array"},"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"},"topology":{"$ref":"#/definitions/DataCatalogTopology"}},"title":"PatchDataCatalogOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog updated.","schema":{"$ref":"#/definitions/DataCatalogue"}},"404":{"description":"Data catalog not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/actions/clone":{"post":{"consumes":["application/json"],"description":"Clone an existing data catalogue","operationId":"clone_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"collections":{"items":{"type":"string"},"type":"array"},"copy_s3":{"default":true,"description":"Should the catalog's S3 data also be copied?","type":"boolean"},"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string","x-nullable":true},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"CloneDataCatalogOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue cloned, and data is being copied.","schema":{"$ref":"#/definitions/CloneDataCatalogResult"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/actions/export":{"post":{"description":"Export the contents of a data catalog.","operationId":"export_project_data_catalog_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/zip"],"responses":{"200":{"description":"Data catalog contents.","schema":{"type":"file"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/actions/import":{"post":{"consumes":["application/json"],"description":"Import data to a data catalog. The collections will be created if they don't exist.","operationId":"import_project_data_catalog_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"maxProperties":1,"minProperties":1,"properties":{"coordinates":{"$ref":"#/definitions/MongoS3CoordinatesWithCollectionList"},"url":{"type":"string"}},"title":"ImportToDataCatalogOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/actions/upload":{"post":{"consumes":["multipart/form-data"],"description":"Upload data to a data catalog. The collection name(s) will be inferred from the file name(s).","operationId":"upload_project_data_catalog_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections":{"get":{"description":"Get the collections of a data catalog.","operationId":"list_project_data_catalog_collections","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog collections","schema":{"items":{"$ref":"#/definitions/DataCatalogCollection"},"type":"array"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"},"post":{"description":"Create a collection in a data catalog","operationId":"create_project_data_catalog_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"collection_name":{"maxLength":24,"minLength":4,"pattern":"^(?:\\w|-)+$","type":"string"}},"required":["collection_name"],"title":"CreateDataCatalogCollectionOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Collection created."},"404":{"description":"Dictionary doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}":{"delete":{"description":"Delete a single data catalog's collection","operationId":"delete_project_data_catalog_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Collection deleted."},"404":{"description":"Collection doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/export":{"post":{"description":"Export the contents of a data catalog's collection","operationId":"export_project_data_catalog_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"}],"produces":["application/zip","application/json","application/x-jsonlines"],"responses":{"200":{"description":"Data catalog collection contents.","schema":{"type":"file"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/import":{"post":{"consumes":["application/json"],"description":"Import data to a data catalog collection. The collection will be created if it doesn't exist.","operationId":"import_project_data_catalog_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"maxProperties":1,"minProperties":1,"properties":{"ccs":{"properties":{"auth_token":{"type":"string"},"export_package_mongo_options":{"properties":{"assemble_options":{"properties":{"mode":{"properties":{"page_elements":{"description":"Which type of annotations to filter for the page elements: H (human annotations), M (model generated)","items":{"enum":["H","M"],"type":"string"},"maxItems":2,"minItems":2,"type":"array"},"tables":{"description":"Which type of annotations to filter for the tables: H (human annotations), M (model generated)","items":{"enum":["H","M"],"type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"required":["page_elements","tables"],"type":"object"},"options":{"properties":{"include_incomplete_documents":{"description":"Include documents with missing pages? (e.g. no annotations for some pages)","type":"boolean"}},"required":["include_incomplete_documents"],"type":"object"}},"required":["mode","options"],"type":"object"},"incremental":{"type":"boolean"},"inputs":{"properties":{"document_hashes":{"default":[],"items":{"type":"string"},"type":"array"}},"required":["document_hashes"],"type":"object"},"package_options":{"properties":{"match_mode":{"default":"document_hash","enum":["use_fuzzy_search","document_hash"],"type":"string"},"redirect_keys_to_s3":{"default":[],"items":{"type":"string"},"type":"array"}},"type":"object"}},"required":["assemble_options","incremental","package_options"],"type":"object"},"proj_key":{"type":"string"},"source_collection_name":{"type":"string"},"url":{"type":"string"}},"required":["proj_key"],"type":"object"},"elastic":{"properties":{"coordinates":{"$ref":"#/definitions/ElasticCoordinates"},"elastic_id":{"type":"string"},"parameters":{"properties":{"import_s3_data":{"type":"boolean"},"index":{"type":"string"},"page_size":{"default":100,"type":"number"},"query_options":{"properties":{"_source":{"items":{"type":"string"},"type":"array"},"query":{"additionalProperties":{},"type":"object"},"size":{"minimum":0,"type":"number"}},"type":"object"},"s3":{"properties":{"access-key":{"type":"string"},"bucket":{"type":"string"},"host":{"type":"string"},"key_prefix":{"type":"string"},"location":{"type":"string"},"port":{"type":"integer"},"secret-key":{"type":"string"},"ssl":{"type":"boolean"},"verifySSL":{"type":"boolean"}},"required":["host","port","ssl","verifySSL","access-key","secret-key","bucket","key_prefix","location"],"title":"ImportFromElasticToDataCatalogS3Coords","type":"object"}},"required":["index","query_options"],"type":"object"}},"required":["parameters"],"title":"ImportFromElasticToDataCatalogOptions","type":"object"},"url":{"type":"string"}},"title":"ImportToDataCatalogCollectionOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/infer_schema":{"post":{"description":"Infer the schema for a data catalog's collection.","operationId":"infer_project_data_catalog_category_schema","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"sample_size":{"maximum":1000,"minimum":1,"type":"integer"}},"title":"InferProjectDataCatalogCategorySchema","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/upload":{"post":{"consumes":["multipart/form-data"],"description":"Upload data to a data catalog collection. The collection will be created if it doesn't exist.","operationId":"upload_project_data_catalog_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/data":{"get":{"description":"Get Data Catalog Collection data.","operationId":"get_data_catalog_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"query","name":"after","required":false,"type":"string"},{"default":50,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"Get Data Catalog Collection data."},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a data catalog.","operationId":"create_project_data_catalog_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"Data flow template not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_indices":{"get":{"description":"Get project data indices","operationId":"get_project_data_indices","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project data indices.","schema":{"items":{"$ref":"#/definitions/ProjectDataIndexWithStatus"},"type":"array"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"},"post":{"description":"Create a project data index","operationId":"create_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexNonView"},{"$ref":"#/definitions/ProjectDataIndexView"}]},"x-body-name":"data"}],"produces":["application/json"],"responses":{"200":{"description":"Project data index.","schema":{"$ref":"#/definitions/ProjectDataIndexWithStatus"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}":{"delete":{"description":"Delete a project index data","operationId":"delete_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"description":"The delete confirmation token","in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project data index deleted successfully."},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"},"get":{"description":"Get project data index","operationId":"get_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project data index.","schema":{"$ref":"#/definitions/ProjectDataIndexWithStatus"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"},"patch":{"description":"Update a project data index","operationId":"update_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexNonView"},{"$ref":"#/definitions/ProjectDataIndexView"}]},"x-body-name":"data"}],"produces":["application/json"],"responses":{"200":{"description":"Updated project data index.","schema":{"$ref":"#/definitions/ProjectDataIndexWithStatus"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload":{"post":{"description":"Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema)","operationId":"ccs_convert_upload_file_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"conversion_settings":{"$ref":"#/definitions/ProjectDataIndexConversionSettings","description":"Specify conversion settings (OCR, Assemble, ML Models) directly"},"file_url":{"description":"List of File's URL to be converted and uploaded to the data index","items":{"type":"string"},"type":"array"},"s3_source":{"description":"Coordinates to object store to get files to convert. Can specify which files with object keys.","properties":{"coordinates":{"$ref":"#/definitions/ProjectDataIndexS3Coordinates","description":"Coordinates to object store to get files to convert"},"object_keys":{"description":"List of s3 object keys to retrieve from bucket to be converted and uploaded to the data index","items":{"type":"string"},"type":"array"}},"type":"object"},"scratch_files_id":{"description":"List of CCS's scratch files id to be converted and uploaded to the data index","items":{"type":"string"},"type":"array"}},"title":"DataIndexUploadFileSource","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"CPS task info","schema":{"$ref":"#/definitions/CpsTask"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload":{"post":{"description":"Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema)","operationId":"html_print_convert_upload","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"conversion_settings":{"$ref":"#/definitions/ProjectDataIndexConversionSettings","description":"Specify conversion settings (OCR, Assemble, ML Models) directly"},"urls":{"description":"List of URLs to be printed to PDF, converted and uploaded to the data index","items":{"x-oneOf":[{"type":"string"},{"properties":{"filename":{"type":"string"},"meta":{"type":"object"},"url":{"type":"string"}},"required":["url"],"type":"object"}]},"type":"array"}},"required":["urls"],"title":"DataIndexUploadFileSource","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"CPS task info","schema":{"$ref":"#/definitions/CpsTask"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/actions/upload":{"post":{"description":"Upload a file to a project data index","operationId":"upload_project_data_index_file","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"body","name":"params","required":true,"schema":{"properties":{"file_url":{"type":"string"}},"required":["file_url"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"CPS task info","schema":{"$ref":"#/definitions/CpsTask"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a project data index.","operationId":"create_project_data_index_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project data index deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"Data flow template not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment":{"post":{"description":"Notify upload completion of an attachment to a project data index","operationId":"register_attachment","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"path","name":"index_item_id","required":true,"type":"string"},{"in":"body","name":"params","required":true,"schema":{"properties":{"attachment_key":{"type":"string"},"attachment_path":{"type":"string"}},"required":["attachment_path"],"type":"object"}}],"produces":["application/json"],"responses":{"204":{"description":"Attachment notify successfull"},"404":{"description":"Project data index or document ID not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename}":{"get":{"description":"Get url and path to upload an attachment to a project data index","operationId":"get_attachment_upload_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"path","name":"index_item_id","required":true,"type":"string"},{"in":"path","name":"filename","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Attachment upload url and path","schema":{"properties":{"attachment_path":{"description":"Attachment path.","type":"string"},"upload_data":{"description":"Data to upload the temporary file. Example using requests 'requests(dot)post(url, data=fields, files=file)'. More information can be found on aws s3 documentation here https://docs.aws.amazon.com/AmazonS3/latest/userguide/PresignedUrlUploadObject.html","properties":{"fields":{"description":"fields to use in request body.","type":"object"},"url":{"description":"url of the host.","type":"string"}},"type":"object"}},"required":["attachment_path","upload_data"],"title":"AttachmentUploadData","type":"object"}},"404":{"description":"Project data index or document ID not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/dataset_assembles/{task_id}/report":{"post":{"description":"Create a report for a data flow task assemble.","operationId":"create_project_knowledge_graph_assemble_report","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"event_log_level":{"default":"error","enum":["debug","info","warning","error","critical"],"type":"string"},"max_errors":{"default":50,"maximum":100,"minimum":0,"type":"integer"}},"title":"DataFlowAssembleReportOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Report.","schema":{"properties":{"dataflow_tasks":{"additionalProperties":{"properties":{"chunks":{"properties":{"completed":{"type":"integer"},"failure":{"type":"integer"},"spawned":{"type":"integer"},"success":{"type":"integer"},"total":{"type":"integer"}},"type":"object"},"errors":{"items":{"properties":{"cause":{"properties":{"type":{"type":"string"},"value":{}},"type":"object"},"timestamp":{"type":"number"}},"type":"object"},"type":"array"},"progress":{"type":"number"},"status":{"type":"string"},"task_type":{"type":"string"}},"title":"DataFlowAssembleReportSingleTask","type":"object"},"type":"object"},"task_id":{"type":"string"}},"title":"DataFlowAssembleReport","type":"object"}},"404":{"description":"Task not found, or is not a data flow assemble.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/default_values":{"get":{"description":"List project's default values","operationId":"get_project_default_values","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ProjectDefaultValues"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"description":"List project's default values","operationId":"update_project_default_values","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"default_values","required":true,"schema":{"$ref":"#/definitions/ProjectDefaultValues"}}],"produces":["application/json"],"responses":{"200":{"description":"OK"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/dictionaries":{"get":{"description":"List dictionaries for a project","operationId":"list_project_dictionaries","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of dictionaries","schema":{"items":{"$ref":"#/definitions/Dictionary"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"post":{"consumes":["application/json"],"description":"Create an empty dictionary","operationId":"create_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"CreateDictionaryOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary created.","schema":{"$ref":"#/definitions/Dictionary"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/from_mongo":{"post":{"consumes":["application/json"],"description":"Create a dictionary from a mongo database","operationId":"import_project_dictionary_from_mongo","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"options":{"properties":{"coordinates":{"$ref":"#/definitions/MongoS3CoordinatesWithCollectionList"}},"required":["coordinates"],"type":"object"},"target":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"type":"object"}},"required":["target","options"],"title":"DictionaryImportOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary created, and data is being imported.","schema":{"properties":{"dictionary":{"$ref":"#/definitions/Dictionary"},"import_task":{"$ref":"#/definitions/Task"}},"title":"DictionaryImportResult","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}":{"delete":{"description":"Delete a single dictionary","operationId":"delete_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Dictionary deleted."},"404":{"description":"Dictionary doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"get":{"description":"Get a single dictionary","operationId":"get_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary","schema":{"$ref":"#/definitions/Dictionary"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"patch":{"description":"Update the metadata of a dictionary","operationId":"update_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"additionalProperties":false,"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"title":"PatchDictionaryOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary updated.","schema":{"$ref":"#/definitions/Dictionary"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/actions/clone":{"post":{"consumes":["application/json"],"description":"Clone an existing dictionary","operationId":"clone_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"collections":{"items":{"type":"string"},"type":"array"},"copy_s3":{"default":true,"description":"Should the dictionary's S3 data also be copied?","type":"boolean"},"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string","x-nullable":true},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"CloneDictionaryOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary cloned, and data is being copied.","schema":{"$ref":"#/definitions/DictionaryCloneResult"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/actions/export":{"post":{"description":"Export the contents of a dictionary.","operationId":"export_project_dictionary_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"}],"produces":["application/zip"],"responses":{"200":{"description":"Dictionary contents.","schema":{"type":"file"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/actions/upload":{"post":{"consumes":["multipart/form-data"],"description":"Upload data to a dictionary. The collection name(s) will be inferred from the file name(s).","operationId":"upload_project_dictionary_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections":{"get":{"description":"Get the collections of a dictionary.","operationId":"list_project_dictionary_collections","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary collections","schema":{"items":{"$ref":"#/definitions/DictionaryCollection"},"type":"array"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"post":{"description":"Create a collection in a dictionary","operationId":"create_project_dictionary_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"collection_name":{"maxLength":50,"minLength":4,"pattern":"^(?:\\w|-)(?:\\w|\\s|-)*(?:\\w|-)$","type":"string"}},"required":["collection_name"],"title":"CreateCollectionInDictionaryOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Collection created."},"404":{"description":"Dictionary doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}":{"delete":{"description":"Delete a single dictionary's collection","operationId":"delete_project_dictionary_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Collection deleted."},"404":{"description":"Collection doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/export":{"post":{"description":"Export the contents of a dictionary's collection","operationId":"export_project_dictionary_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"query","name":"file_format","required":false,"type":"string"}],"produces":["application/zip","application/json"],"responses":{"200":{"description":"Dictionary collection contents.","schema":{"type":"file"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/upload":{"post":{"consumes":["multipart/form-data"],"description":"Upload data to a dictionary collection. The collection will be created if it doesn't exist.","operationId":"upload_project_dictionary_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/data":{"get":{"description":"Get a preview of the data in a dictionary","operationId":"get_project_dictionary_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"query","name":"after","pattern":"[a-zA-Z0-9]{24}","required":false,"type":"string"},{"default":1000,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"},{"default":"object","in":"query","name":"response_format","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary collection contents.","schema":{"x-oneOf":[{"$ref":"#/definitions/DictionaryCollectionObjectData"},{"$ref":"#/definitions/DictionaryCollectionCsvData"}]}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"patch":{"description":"Update the data in a dictionary's collection","operationId":"update_project_dictionary_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"description":"A subset of JSON Patch operation list. Only `add`, `replace`, and `remove` is supported.\nSee http://jsonpatch.com/ for more details.\n","in":"body","name":"body","required":true,"schema":{"items":{"$ref":"#/definitions/DictionaryCollectionPatch"},"type":"array"}}],"produces":["application/json"],"responses":{"204":{"description":"Data updated."},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a dictionary.","operationId":"create_project_dictionary_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"Data flow template not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/ingest/documentqa":{"post":{"deprecated":true,"description":"Ingest a document for QA","operationId":"ingest_documentqa","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"source":{"title":"Source","x-anyOf":[{"properties":{"type":{"enum":["url"],"title":"Type","type":"string"},"url":{"title":"Url","type":"string"}},"required":["type","url"],"title":"IngestDocumentQASourceUrl","type":"object"},{"properties":{"document_hash":{"title":"Document Hash","type":"string"},"elastic_id":{"title":"Elastic Id","type":"string"},"index_key":{"title":"Index Key","type":"string"},"type":{"enum":["public_data"],"title":"Type","type":"string"}},"required":["type","elastic_id","index_key","document_hash"],"title":"IngestDocumentQASourcePublicData","type":"object"},{"properties":{"document_hash":{"title":"Document Hash","type":"string"},"index_key":{"title":"Index Key","type":"string"},"proj_key":{"title":"Proj Key","type":"string"},"type":{"enum":["private_data"],"title":"Type","type":"string"}},"required":["type","proj_key","index_key","document_hash"],"title":"IngestDocumentQASourcePrivateData","type":"object"}]}},"required":["source"],"title":"IngestDocumentQARequest","type":"object"},"x-body-name":"body"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Inspection","Semantic"],"x-swagger-router-controller":"api_server.controllers.document_inspect_controller"}},"/project/{proj_key}/integrations/{integration_name}":{"delete":{"description":"Delete the config for a given project integration","operationId":"delete_project_integration_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"integration_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.controller"},"get":{"description":"Get the config for a given project integration","operationId":"get_project_integration_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"integration_name","required":true,"type":"string"},{"default":false,"description":"Project owners can retrieve decoded secrets","in":"query","name":"decode_secrets","type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ProjectIntegrations"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"description":"Update the config for a given project integration","operationId":"update_project_integration_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"integration_name","required":true,"type":"string"},{"in":"body","name":"config","required":true,"schema":{"$ref":"#/definitions/ProjectIntegrations"}}],"produces":["application/json"],"responses":{"200":{"description":"OK"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates":{"get":{"description":"List a data flow templates","operationId":"list_project_data_flow_templates","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of data flow templates.","schema":{"items":{"$ref":"#/definitions/DataFlowTemplateListItem"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"description":"Create a data flow template","operationId":"create_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"maxLength":50,"minLength":1,"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"},"template":{"$ref":"#/definitions/DataFlowTemplate"},"variables":{"additionalProperties":{"properties":{"default_value":{},"type":{"$ref":"#/definitions/DataFlowTemplateVariable"}},"required":["type"],"type":"object"},"type":"object"}},"required":["public","name","variables","template","description"],"title":"CreateDataFlowTemplateOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Dataflow created.","schema":{"$ref":"#/definitions/DataFlow"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/from_json":{"post":{"consumes":["multipart/form-data"],"deprecated":true,"description":"Create a data flow template from a JSON file.\n**DEPRECATED**: use `create_project_data_flow_template`\n","operationId":"upload_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"formData","name":"name","required":false,"type":"string"},{"in":"formData","name":"description","required":false,"type":"string"},{"in":"formData","name":"public","required":false,"type":"boolean"},{"in":"formData","name":"contents","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Dataflow created.","schema":{"$ref":"#/definitions/DataFlow"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}":{"delete":{"description":"Delete a single data flow template","operationId":"delete_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Data flow deleted."},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"},"get":{"description":"Get a single data flow template","operationId":"get_project_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data flow template.","schema":{"$ref":"#/definitions/DataFlow"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"},"put":{"description":"Update a data flow template","operationId":"update_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"description":{"type":"string"},"name":{"type":"string"},"public":{"type":"boolean"},"template":{"$ref":"#/definitions/DataFlowTemplate"},"variables":{"additionalProperties":{"properties":{"default_value":{},"type":{"$ref":"#/definitions/DataFlowTemplateVariable"}},"required":["type"],"type":"object"},"type":"object"}},"required":["public","name","variables","template"],"title":"UpdateDataFlowOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Dataflow updated.","schema":{"$ref":"#/definitions/DataFlow"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/load":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values and load it into a Knowledge Graph.","operationId":"load_project_data_flow_template_into_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"render":{"properties":{"target_bag":{"properties":{"bag_key":{"type":"string"},"proj_key":{"description":"If set, this will override the 'proj_key' parameter in the path, allowing cross-project KGs to be used.","type":"string"}},"required":["bag_key"],"type":"object"},"variables":{"additionalProperties":{},"type":"object"}},"required":["target_bag","variables"],"type":"object"},"target":{"properties":{"save":{"type":"object"}},"required":["save"],"type":"object"}},"title":"LoadDataFlowIntoKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/render":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values.","operationId":"render_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"target_bag":{"properties":{"bag_key":{"type":"string"},"proj_key":{"description":"If set, this will override the 'proj_key' parameter in the path, allowing cross-project KGs to be used.","type":"string"}},"required":["bag_key"],"type":"object"},"variables":{"additionalProperties":{},"type":"object"}},"required":["target_bag","variables"],"title":"RenderDataFlowTemplateOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Rendered data flow","schema":{"type":"object"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/run":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values and run it.","operationId":"assemble_project_data_flow_template_into_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"target_bag_key":{"type":"string"},"variables":{"additionalProperties":{},"type":"object"}},"title":"RunDataFlowTemplateOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a data flow template.","operationId":"create_project_data_flow_template_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data flow deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"Data flow template not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/export.json":{"post":{"description":"Export a single data flow template","operationId":"export_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/vnd.ibm.cps.df-template+json"],"responses":{"200":{"description":"Data flow template.","schema":{"type":"file"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/topology":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values and get the resulting Knowledge Graph topology from it.","operationId":"get_project_data_flow_template_topology","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"variables":{"additionalProperties":{},"type":"object"}},"title":"DataFlowTopologyOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data flow topology.","schema":{"$ref":"#/definitions/Topology"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflows/actions/load":{"post":{"description":"Load a dataflow into a KG","operationId":"load_project_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"$ref":"#/definitions/LoadKgcDataInput"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflows/actions/run":{"post":{"description":"Run a dataflow","operationId":"assemble_project_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"dataflow","required":true,"schema":{"$ref":"#/definitions/KgcDataInput"},"x-body-name":"dataflow"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflows/actions/validate":{"post":{"description":"Validate a dataflow","operationId":"validate_project_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"dataflow","required":true,"schema":{"$ref":"#/definitions/KgcDataInput"},"x-body-name":"dataflow"}],"produces":["application/json"],"responses":{"200":{"description":"Validation successful."},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/raw_dataflow_templates/actions/run":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values and run it.","operationId":"assemble_project_raw_data_flow_template_into_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"data_flow":{"properties":{"template":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"type":"object"},"type":"array"}},"required":["config","data-flow"],"type":"object"},"variables":{"additionalProperties":{},"type":"object"}},"required":["template","variables"],"type":"object"},"log_task":{"default":true,"type":"boolean"},"variable_values":{"additionalProperties":{},"type":"object"}},"required":["data_flow","variable_values","log_task"],"title":"RunDataFlowTemplateOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc_dataflow_templates/debug/{df_tpl_key}":{"post":{"consumes":["application/json"],"description":"(Debug) get the fully rendered data flow, with all the coordinates set.","operationId":"debug_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"target_bag":{"properties":{"bag_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["bag_key"],"type":"object"},"variables":{"additionalProperties":{},"type":"object"}},"title":"FullyRenderedDataFlow","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Rendered data flow.","schema":{"type":"object"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/model_configs":{"get":{"description":"List Model Configurations for a project","operationId":"list_project_model_configs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of Model Configurations","schema":{"items":{"$ref":"#/definitions/ModelConfiguration"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"},"post":{"consumes":["application/json"],"description":"Create a Model Configuration","operationId":"create_project_model_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"configurations":{"properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"description":{"type":"string","x-nullable":true},"model_config_key":{"type":"string"},"name":{"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public","configurations"],"title":"CreateProjectModelConfigOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Model Configuration created.","schema":{"$ref":"#/definitions/ModelConfiguration"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/{proj_key}/model_configs/{model_config_key}":{"delete":{"description":"Delete a single Model Configuration","operationId":"delete_project_model_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"model_config_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Model Configuration deleted."},"404":{"description":"Model Configuration doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"},"get":{"description":"Get a single Model Configuration","operationId":"read_project_model_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"model_config_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Model Configuration","schema":{"$ref":"#/definitions/ModelConfiguration"}},"404":{"description":"Model Configuration not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"},"patch":{"description":"Update a single Model Configuration","operationId":"update_project_model_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"model_config_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"configurations":{"properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public","configurations"],"title":"UpdateProjectModelConfigOptions","type":"object"}}],"produces":["application/json"],"responses":{"204":{"description":"Model Configuration updated."},"404":{"description":"Model Configuration doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/{proj_key}/models":{"get":{"description":"List models with the supported annotations for a project","operationId":"get_project_models_with_supported_annotations","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of Models with the supported annotations","schema":{"items":{"$ref":"#/definitions/ModelConfiguration"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/{proj_key}/object_annotations":{"post":{"deprecated":true,"description":"Run an annotator on an object, using resources from the project.\n*DEPRECATED*, please use generate_project_object_annotations_async instead.\n","operationId":"generate_project_object_annotations","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"input":{"maxProperties":1,"minProperties":1,"properties":{"image":{"properties":{"metadata":{"properties":{"cells":{"properties":{"data":{"description":"A 6-tuple consisting of x1, y1, x2, y2, font, coordinates","items":[{"type":"number"},{"type":"number"},{"type":"number"},{"type":"number"},{"type":"string"},{"type":"string"}],"type":"array"}},"required":["data"],"title":"ImageCells","type":"object"},"info":{"properties":{"height":{"type":"number"},"width":{"type":"number"}},"required":["width","height"],"title":"ImageInfo","type":"object"}},"required":["cells"],"title":"ImageMetadata","type":"object"},"source":{"minProperties":1,"properties":{"proj_key":{"type":"string"},"scratch_id":{"type":"string"},"url":{"type":"string"}},"title":"ImageSource","type":"object"}},"required":["source"],"title":"AnnotatorImageInput","type":"object"},"table":{"description":"A table, specified as an array of arrays. Each outer array represents a row, and each item in the inner array represents the column.","items":{"items":{"properties":{"bbox":{"items":{"format":"double","type":"number"},"maxItems":4,"minItems":4,"type":"array"},"spans":{"description":"2-tuple representing the row:column where this cell spans to.","items":{"items":{"format":"integer","type":"number"},"maxItems":2,"minItems":2,"type":"array"},"type":"array"},"text":{"type":"string"},"type":{"enum":["col_header","row_header","body"],"title":"AnnotateTableCellType","type":"string"}},"required":["bbox","spans","text","type"],"title":"AnnotateTableCell","type":"object"},"type":"array"},"type":"array"},"text":{"maxLength":4500,"type":"string"}},"title":"AnnotatorInput","type":"object"},"parameters":{"additionalProperties":{},"properties":{"type":{"type":"string"}},"required":["type"],"title":"AnnotatorParameters","type":"object"}},"required":["parameters","input"],"title":"AnnotateObjectOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"maxProperties":1,"minProperties":1,"properties":{"image":{"$ref":"#/definitions/AnnotatedImage"},"table":{"$ref":"#/definitions/AnnotatedTable"},"text":{"properties":{"entities":{"description":"One item per line on the original text.","items":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"type":"array"},"properties":{"description":"One item per line on the original text.","items":{"$ref":"#/definitions/ObjectPropertyMap"},"type":"array"},"relationships":{"description":"One item per line on the original text.","items":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"type":"array"},"text":{"description":"Input text after clean up. The annotation indexes will be based on this text and not the input text.","type":"string"}},"required":["text","entities","relationships","properties"],"title":"AnnotatedTextLines","type":"object"}},"title":"AnnotatedObject","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Annotate"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/object_annotations_async":{"post":{"description":"Run an annotator on an object, using resources from the project.","operationId":"generate_project_object_annotations_async","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"input":{"maxProperties":1,"minProperties":1,"properties":{"image":{"properties":{"metadata":{"properties":{"cells":{"properties":{"data":{"description":"A 6-tuple consisting of x1, y1, x2, y2, font, coordinates","items":[{"type":"number"},{"type":"number"},{"type":"number"},{"type":"number"},{"type":"string"},{"type":"string"}],"type":"array"}},"required":["data"],"title":"ImageCells","type":"object"},"info":{"properties":{"height":{"type":"number"},"width":{"type":"number"}},"required":["width","height"],"title":"ImageInfo","type":"object"}},"required":["cells"],"title":"ImageMetadata","type":"object"},"source":{"minProperties":1,"properties":{"proj_key":{"type":"string"},"scratch_id":{"type":"string"},"url":{"type":"string"}},"title":"ImageSource","type":"object"}},"required":["source"],"title":"AnnotatorImageInput","type":"object"},"table":{"description":"A table, specified as an array of arrays. Each outer array represents a row, and each item in the inner array represents the column.","items":{"items":{"properties":{"bbox":{"items":{"format":"double","type":"number"},"maxItems":4,"minItems":4,"type":"array"},"spans":{"description":"2-tuple representing the row:column where this cell spans to.","items":{"items":{"format":"integer","type":"number"},"maxItems":2,"minItems":2,"type":"array"},"type":"array"},"text":{"type":"string"},"type":{"enum":["col_header","row_header","body"],"title":"AnnotateTableCellType","type":"string"}},"required":["bbox","spans","text","type"],"title":"AnnotateTableCell","type":"object"},"type":"array"},"type":"array"},"text":{"maxLength":4500,"type":"string"}},"title":"AnnotatorInput","type":"object"},"model_config_key":{"type":"string"},"parameters":{"additionalProperties":{},"properties":{"type":{"type":"string"}},"required":["type"],"title":"AnnotatorParameters","type":"object"},"proj_key":{"type":"string"},"public":{"type":"boolean"}},"required":["parameters","input"],"title":"AnnotateObjectOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Annotate"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/packages":{"post":{"description":"Install packages on a project","operationId":"provision_project_packages","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","schema":{"properties":{"packages":{"items":{"properties":{"overrides":{"type":"object"},"package_id":{"type":"string"}},"required":["package_id"],"type":"object"},"type":"array","uniqueItems":true}},"required":["packages"],"title":"ProjectPackageInstalationManifest","type":"object"}}],"responses":{"200":{"description":"Task started. It can be found in the tasks endpoint for the project.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Package not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/project/{proj_key}/scratch/files":{"get":{"description":"Get temporary files uploaded to a project","operationId":"list_project_scratch_files","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"scratch_ids","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Files","schema":{"items":{"properties":{"filename":{"type":"string"},"id":{"description":"ID of the temporary file.","type":"string"},"proj_key":{"type":"string"},"timestamp":{"type":"number"},"user_key":{"type":"string"}},"required":["id","proj_key","user_key","filename","timestamp"],"title":"UploadedFile","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Uploads"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"consumes":["multipart/form-data"],"deprecated":true,"description":"Upload a file to temporary storage","operationId":"upload_project_scratch_file","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"File uploaded","schema":{"properties":{"id":{"description":"ID of the temporary file.","type":"string"},"url":{"description":"URL to get the temporary file form.","type":"string"}},"required":["id","url"],"title":"UploadedFileResult","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Uploads"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/scratch/files/upload/{filename}":{"post":{"consumes":["application/json"],"description":"Create file pointers for temporary storage","operationId":"create_project_scratch_file","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"filename","required":true,"type":"string"}],"produces":["application/json"],"responses":{"201":{"description":"Temporary file details","schema":{"properties":{"download":{"description":"URL to get the temporary file.","properties":{"url":{"type":"string"}},"type":"object"},"download_private":{"description":"URL to get the temporary file. (private URL, usable within the infrastracture)","properties":{"url":{"type":"string"}},"type":"object"},"id":{"description":"ID of the temporary file.","type":"string"},"metadata":{"description":"URL to metadata of the temporary file using the HEAD HTTP method.","properties":{"url":{"type":"string"}},"type":"object"},"metadata_private":{"description":"URL to metadata of the temporary file using the HEAD HTTP method. (private URL, usable within the infrastracture)","properties":{"url":{"type":"string"}},"type":"object"},"upload":{"description":"URL to upload the temporary file.","properties":{"fields":{"type":"object"},"url":{"type":"string"}},"type":"object"},"upload_private":{"description":"URL to upload the temporary file. (private URL, usable within the infrastracture)","properties":{"fields":{"type":"object"},"url":{"type":"string"}},"type":"object"}},"required":["id","upload","download","metadata","upload_private","download_private","metadata_private"],"title":"TemporaryUploadFileResult","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Uploads"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/scratch/files_paginated":{"get":{"description":"Get paginated list of temporary files uploaded to a project","operationId":"list_project_scratch_files_paginated","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"description":"page of the result list","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"items on one page of the result list","in":"query","name":"items_per_page","required":false,"type":"integer"},{"description":"search keyword","in":"query","name":"search_string","required":false,"type":"string"},{"description":"begin date of the search date interval","in":"query","name":"begin_date","required":false,"type":"integer"},{"description":"end date of the search date interval","in":"query","name":"end_date","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"Files","schema":{"items":{"properties":{"filename":{"type":"string"},"id":{"description":"ID of the temporary file.","type":"string"},"proj_key":{"type":"string"},"timestamp":{"type":"number"},"user_key":{"type":"string"}},"required":["id","proj_key","user_key","filename","timestamp"],"title":"UploadedFile","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Uploads"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/semantic/ingest":{"post":{"description":"Ingest documents and collections for RAG","operationId":"ingest","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"parameters":{"properties":{"skip_ingested_docs":{"title":"Skip Ingested Docs","type":"boolean"}},"required":["skip_ingested_docs"],"title":"SemanticIngestReqParams","type":"object"},"source":{"title":"Source","x-anyOf":[{"properties":{"type":{"enum":["url"],"title":"Type","type":"string"},"url":{"title":"Url","type":"string"}},"required":["type","url"],"title":"IngestDocumentQASourceUrl","type":"object"},{"properties":{"document_hash":{"title":"Document Hash","type":"string"},"elastic_id":{"title":"Elastic Id","type":"string"},"index_key":{"title":"Index Key","type":"string"},"type":{"enum":["public_data_document"],"title":"Type","type":"string"}},"required":["type","elastic_id","index_key","document_hash"],"title":"SemanticIngestSourcePublicDataDocument","type":"object"},{"properties":{"document_hash":{"title":"Document Hash","type":"string"},"index_key":{"title":"Index Key","type":"string"},"proj_key":{"title":"Proj Key","type":"string"},"type":{"enum":["private_data_document"],"title":"Type","type":"string"}},"required":["type","proj_key","index_key","document_hash"],"title":"SemanticIngestSourcePrivateDataDocument","type":"object"},{"properties":{"index_key":{"title":"Index Key","type":"string"},"proj_key":{"title":"Proj Key","type":"string"},"type":{"enum":["private_data_collection"],"title":"Type","type":"string"}},"required":["type","proj_key","index_key"],"title":"SemanticIngestSourcePrivateDataCollection","type":"object"}]}},"required":["source","parameters"],"title":"SemanticIngestRequest","type":"object"},"x-body-name":"body"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Semantic"],"x-swagger-router-controller":"api_server.controllers.semantic_controller"}},"/project/{proj_key}/tasks":{"get":{"description":"List tasks for a project.","operationId":"list_project_tasks","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"task_type","required":false,"type":"string"},{"default":50,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"},{"default":0,"in":"query","minimum":0,"name":"skip","required":false,"type":"integer"},{"in":"query","name":"sort_by","required":false,"type":"string"},{"default":"asc","enum":["asc","desc"],"in":"query","name":"sort_order","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of tasks.","schema":{"items":{"$ref":"#/definitions/ProjectTask"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/tasks/{task_id}":{"get":{"description":"Get a task for a project.","operationId":"get_project_task","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Task","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"Task not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]},{"KGAuth":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/tasks/{task_id}/actions/abort":{"post":{"description":"Abort a task.","operationId":"abort_project_task","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Task aborted."},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/dc_storage_summary/{dc_key}":{"get":{"description":"Get dc storage summary","operationId":"system_get_dc_storage_summary_async","parameters":[{"description":"Data catalog key","in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"DC storage summary","schema":{"$ref":"#/definitions/StorageSummaryTask"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/delete_flavour/{flavour_name}":{"delete":{"description":"Delete flavour from db","operationId":"delete_flavour","parameters":[{"in":"path","name":"flavour_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Deleted flavour successful"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_all_dcs":{"get":{"description":"Get all data catalogs (only dc_key) for admin use","operationId":"system_get_all_dcs_admin","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Array with all dcs's key","schema":{"items":{"type":"string"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/get_all_kgs":{"get":{"description":"Get all kgs (only bag_key) for admin use","operationId":"system_get_all_kgs_admin","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Array with all kgs's key","schema":{"items":{"type":"string"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/get_flavour/{flavour_name}":{"get":{"description":"Get flavour from db","operationId":"get_flavour","parameters":[{"in":"path","name":"flavour_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Get flavour successful","schema":{"$ref":"#/definitions/BagFlavourFullData"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_flavours_default_quota":{"get":{"description":"Get flavours default values","operationId":"get_flavours_default_quotas","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Flavours default values","schema":{"items":{"$ref":"#/definitions/BagFlavourDefaultQuota"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_project_flavour_total_kgs/{proj_key}/{flavour_name}":{"get":{"description":"Gets kg total number by proj_key and flavour_key","operationId":"get_project_flavour_total_kgs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"flavour_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project flavours total kg number","schema":{"properties":{"flavour_name":{"type":"string"},"proj_key":{"type":"string"},"total_kgs":{"type":"integer"}},"required":["proj_key","flavour_name","total_kgs"],"title":"ProjectFlavourTotalKgs","type":"object"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_project_flavours/{proj_key}":{"get":{"description":"Get project assignment flavours","operationId":"list_flavours_by_project","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"properties":{"flavours":{"items":{"$ref":"#/definitions/BagFlavourFullData"},"type":"array"},"proj_key":{"type":"string"}},"required":["proj_key","flavours"],"title":"ProjectFlavours","type":"object"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_project_flavours_quota/{proj_key}":{"get":{"description":"Get project flavours quota","operationId":"get_project_flavours_quota","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project flavours quota","schema":{"items":{"$ref":"#/definitions/FlavoursQuota"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_projects_flavours_quota":{"get":{"description":"Get projects flavours quotas","operationId":"get_projects_flavours_quota","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Projects flavours quotas","schema":{"items":{"$ref":"#/definitions/ProjectsFlavoursQuota"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/kg_storage_summary/{kg_key}":{"get":{"description":"Get kg storage summary","operationId":"system_get_kg_storage_summary_async","parameters":[{"description":"Knowledge graph key","in":"path","name":"kg_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Kg storage summary","schema":{"$ref":"#/definitions/StorageSummaryTask"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/list_all_flavours":{"get":{"description":"Get all KG flavours storage on db","operationId":"list_all_flavours","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Flavours storage on db","schema":{"items":{"$ref":"#/definitions/BagFlavourFullData"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/list_projects_flavours":{"get":{"description":"Get all projects and their flavours","operationId":"list_projects_flavours","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Flavours storage on db","schema":{"items":{"$ref":"#/definitions/ProjectsFlavours"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/save_flavour":{"put":{"description":"Save flavour on db","operationId":"save_flavour","parameters":[{"in":"query","name":"new_flavour","required":true,"type":"boolean"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/BagFlavourFullData"}}],"produces":["application/json"],"responses":{"200":{"description":"Save flavour successful"},"409":{"description":"Flavour name already taken"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/save_flavours_default_quota":{"put":{"description":"Save flavours default quota","operationId":"save_flavours_default_quotas","parameters":[{"in":"body","name":"flavours","required":true,"schema":{"items":{"$ref":"#/definitions/BagFlavourDefaultQuota"},"type":"array"}}],"produces":["application/json"],"responses":{"200":{"description":"Save flavours default quotas successful","schema":{"items":{"$ref":"#/definitions/BagFlavourDefaultQuota"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/save_project_flavours":{"put":{"description":"Save project flavours assignment on db","operationId":"save_project_flavours","parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ProjectsFlavours"}}],"produces":["application/json"],"responses":{"200":{"description":"Save project flavours successful"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/save_project_flavours_quota":{"put":{"description":"Save project flavours quota","operationId":"save_project_flavours_quota","parameters":[{"in":"body","name":"projects_flavours_quotas","required":true,"schema":{"$ref":"#/definitions/ProjectsFlavoursQuota"}}],"produces":["application/json"],"responses":{"200":{"description":"Save project flavours quota successful"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/summary":{"get":{"description":"Get cps summary data.","operationId":"system_get_cps_summary","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Cps summary","schema":{"items":{"properties":{"availCpuSlots":{"type":"integer"},"availMemSlots":{"type":"integer"},"availSlots":{"type":"integer"},"name":{"type":"string"},"numNodes":{"type":"integer"},"numberKgs":{"type":"integer"},"runningKgs":{"type":"integer"},"workersPool":{"type":"string"}},"type":"object"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/celery_tasks/failure":{"get":{"description":"Get celery tasks that failed.","operationId":"list_failure_celery_tasks","parameters":[{"in":"query","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"task_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Celery tasks","schema":{"items":{"properties":{"failures":{"items":{"properties":{"logs":{"additionalProperties":{},"type":"object"},"meta":{"additionalProperties":{},"type":"object"},"task_id":{"type":"string"},"worker_name":{"type":"string"}},"type":"object"},"type":"array"},"proj_key":{"type":"string"},"task_id":{"type":"string"}},"required":["proj_key","task_id","failures"],"title":"CeleryTask","type":"object"},"type":"array"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/celery_tasks/status":{"get":{"description":"Get the status of Celery tasks.","operationId":"list_system_celery_tasks","parameters":[{"in":"query","name":"proj_key","required":false,"type":"string"},{"in":"query","name":"project_task_id","required":false,"type":"string"},{"description":"If set, return the tasks created at or after this timestamp. Otherwise, return the tasks created up to 60 minutes of the system's date, if `project_task_id` is not set.","in":"query","name":"started_since","required":false,"type":"number"},{"format":"double","in":"query","name":"task_status","required":false,"type":"number"},{"default":50,"in":"query","name":"limit","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"Celery tasks","schema":{"items":{"properties":{"completed_at":{"type":"number"},"created_at":{"type":"number"},"meta":{"additionalProperties":{},"type":"object"},"metrics":{"type":"object"},"proj_key":{"type":"string"},"project_task_id":{"type":"string"},"project_task_type":{"type":"string","x-nullable":true},"started_at":{"type":"number"},"task_id":{"type":"string"},"task_status":{"type":"string"},"task_type":{"type":"string"},"worker_name":{"type":"string"}},"required":["task_id","project_task_id","proj_key","task_type","created_at","started_at","completed_at","task_status","worker_name","meta"],"title":"CeleryTask","type":"object"},"type":"array"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/info":{"get":{"description":"Get system info","operationId":"get_system_information","parameters":[],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/SystemInfo"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/kgs":{"get":{"description":"List all Knowledge Graphs in the system","operationId":"list_system_knowledge_graphs","parameters":[{"in":"query","name":"proj_key","required":false,"type":"string"},{"in":"query","name":"term","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"properties":{"backend":{"additionalProperties":{"properties":{"deployment":{"properties":{"chart":{"type":"string"},"flavour":{"type":"string"},"name":{"type":"string"},"resources":{"additionalProperties":{"properties":{"limits":{"type":"object"},"requests":{"type":"object"}},"type":"object"},"type":"object"}},"type":"object"},"flavour":{"type":"string"}},"type":"object"},"type":"object"},"bag_domain":{"type":"string"},"bag_key":{"type":"string"},"bag_url":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"project_name":{"type":"string"},"public":{"type":"boolean"},"slug":{"type":"string"},"timestamp":{"format":"double","type":"number"}},"title":"KnowledgeGraphSystemInformation","type":"object"},"type":"array"}},"default":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.admin_kg_controller"}},"/system/modules/configuration":{"get":{"description":"Get modules configuration","operationId":"get_system_modules_configuration","parameters":[],"produces":["application/json"],"responses":{"201":{"description":"Modules configuration","schema":{"$ref":"#/definitions/SystemModulesConfiguration"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/modules/tasks":{"get":{"description":"Get modules tasks","operationId":"get_system_modules_tasks","parameters":[],"produces":["application/json"],"responses":{"201":{"description":"Modules tasks","schema":{"$ref":"#/definitions/SystemModulesTasks"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/packages":{"get":{"description":"Get packages available in this CPS installation for installing in a project.","operationId":"list_packages","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Packages available to this CPS installation","schema":{"items":{"$ref":"#/definitions/CpsPackage"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}}},"produces":["application/json"],"schemes":["http","https"],"securityDefinitions":{"Bearer":{"description":"For accessing the API a valid JWT token must be passed in all the queries in\nthe 'Authorization' header.\n\nA valid JWT token is generated by the API and returned.\n\nThe following syntax must be used in the 'Authorization' header :\n Bearer xxxxxx.yyyyyyy.zzzzzz\n","in":"header","name":"Authorization","type":"apiKey","x-apikeyInfoFunc":"oidc_user_mngt.utils.connexion_auth.api_key_info"},"KGAuth":{"description":"API endpoints called by the KG application are authenticated by a valid JWT\ntoken which must contain the correct project resources which is needed.\nThe token must be passed in the 'X-CPS-KG-Authorization' header.\n\nA valid JWT token can be obtained by the CPS API or UI.\n\nThe following syntax must be used in the 'Authorization' header :\n KGToken xxxxxx.yyyyyyy.zzzzzz\n","in":"header","name":"X-CPS-KG-Authorization","type":"apiKey","x-apikeyInfoFunc":"api_server.utils.connexion_auth.kg_auth_info"},"ManagementKey":{"description":"For accessing the API using a valid management token, it must be passed in all the queries in\nthe 'Authorization' header.\n","in":"header","name":"Authorization","type":"apiKey","x-apikeyInfoFunc":"api_server.utils.connexion_auth.api_mngt_token_info"}},"swagger":"2.0"} +{"swagger": "2.0", "info": {"version": "2.0.0", "title": "Corpus Processing Service (CPS) API"}, "schemes": ["http", "https"], "consumes": ["application/json"], "produces": ["application/json"], "securityDefinitions": {"Bearer": {"description": "For accessing the API a valid JWT token must be passed in all the queries in\nthe 'Authorization' header.\n\nA valid JWT token is generated by the API and returned.\n\nThe following syntax must be used in the 'Authorization' header :\n Bearer xxxxxx.yyyyyyy.zzzzzz\n", "type": "apiKey", "name": "Authorization", "in": "header", "x-apikeyInfoFunc": "oidc_user_mngt.utils.connexion_auth.api_key_info"}, "ManagementKey": {"description": "For accessing the API using a valid management token, it must be passed in all the queries in\nthe 'Authorization' header.\n", "type": "apiKey", "name": "Authorization", "in": "header", "x-apikeyInfoFunc": "api_server.utils.connexion_auth.api_mngt_token_info"}, "KGAuth": {"description": "API endpoints called by the KG application are authenticated by a valid JWT\ntoken which must contain the correct project resources which is needed.\nThe token must be passed in the 'X-CPS-KG-Authorization' header.\n\nA valid JWT token can be obtained by the CPS API or UI.\n\nThe following syntax must be used in the 'Authorization' header :\n KGToken xxxxxx.yyyyyyy.zzzzzz\n", "type": "apiKey", "name": "X-CPS-KG-Authorization", "in": "header", "x-apikeyInfoFunc": "api_server.utils.connexion_auth.kg_auth_info"}}, "paths": {"/project/{proj_key}/packages": {"post": {"tags": ["Project"], "description": "Install packages on a project", "operationId": "provision_project_packages", "x-swagger-router-controller": "api_server.controllers.system_controller", "security": [{"Bearer": []}], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "schema": {"title": "ProjectPackageInstalationManifest", "type": "object", "required": ["packages"], "properties": {"packages": {"type": "array", "items": {"type": "object", "properties": {"package_id": {"type": "string"}, "overrides": {"type": "object"}}, "required": ["package_id"]}, "uniqueItems": true}}}}], "responses": {"200": {"description": "Task started. It can be found in the tasks endpoint for the project.", "schema": {"$ref": "#/definitions/Task"}}, "404": {"description": "Package not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/data_indices": {"get": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Get project data indices", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "get_project_data_indices", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Project data indices.", "schema": {"type": "array", "items": {"$ref": "#/definitions/ProjectDataIndexWithStatus"}}}, "404": {"description": "Project data index not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}, "post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Create a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "create_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"x-oneOf": [{"$ref": "#/definitions/ProjectDataIndexNonView"}, {"$ref": "#/definitions/ProjectDataIndexView"}]}}], "responses": {"200": {"description": "Project data index.", "schema": {"$ref": "#/definitions/ProjectDataIndexWithStatus"}}, "404": {"description": "Project data index not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/data_indices/{index_key}": {"get": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Get project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "get_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Project data index.", "schema": {"$ref": "#/definitions/ProjectDataIndexWithStatus"}}, "404": {"description": "Project data index not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}, "patch": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Update a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "update_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"x-oneOf": [{"$ref": "#/definitions/ProjectDataIndexNonView"}, {"$ref": "#/definitions/ProjectDataIndexView"}]}}], "responses": {"200": {"description": "Updated project data index.", "schema": {"$ref": "#/definitions/ProjectDataIndexWithStatus"}}, "404": {"description": "Project data index not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}, "delete": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Delete a project index data", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "delete_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "confirmation_token", "in": "query", "required": true, "type": "string", "description": "The delete confirmation token"}], "responses": {"200": {"description": "Project data index deleted successfully."}, "404": {"description": "Project data index not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/data_indices/{index_key}/delete_token": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a project data index.", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "create_project_data_index_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Project data index deletion token.", "schema": {"$ref": "#/definitions/TokenResponse"}}, "404": {"description": "Data flow template not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/data_indices/{index_key}/actions/upload": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Upload a file to a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "upload_project_data_index_file", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "params", "in": "body", "required": true, "schema": {"type": "object", "required": ["file_url"], "properties": {"file_url": {"type": "string"}}}}], "responses": {"200": {"description": "CPS task info", "schema": {"$ref": "#/definitions/CpsTask"}}, "404": {"description": "Project data index not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema)", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "ccs_convert_upload_file_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DataIndexUploadFileSource", "type": "object", "properties": {"scratch_files_id": {"description": "List of CCS's scratch files id to be converted and uploaded to the data index", "type": "array", "items": {"type": "string"}}, "file_url": {"description": "List of File's URL to be converted and uploaded to the data index", "type": "array", "items": {"type": "string"}}, "s3_source": {"description": "Coordinates to object store to get files to convert. Can specify which files with object keys.", "type": "object", "properties": {"coordinates": {"description": "Coordinates to object store to get files to convert", "$ref": "#/definitions/ProjectDataIndexS3Coordinates"}, "object_keys": {"description": "List of s3 object keys to retrieve from bucket to be converted and uploaded to the data index", "type": "array", "items": {"type": "string"}}}}, "conversion_settings": {"description": "Specify conversion settings (OCR, Assemble, ML Models) directly", "$ref": "#/definitions/ProjectDataIndexConversionSettings"}, "target_settings": {"description": "Specify the conversion target settings to use.", "type": "object", "properties": {"add_raw_pages": {"title": "add_raw_pages", "type": "boolean"}, "add_annotations": {"type": "boolean", "title": "add_annotations"}}}}}}], "responses": {"200": {"description": "CPS task info", "schema": {"$ref": "#/definitions/CpsTask"}}, "404": {"description": "Project data index not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema)", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "html_print_convert_upload", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DataIndexUploadFileSource", "type": "object", "required": ["urls"], "properties": {"urls": {"description": "List of URLs to be printed to PDF, converted and uploaded to the data index", "type": "array", "items": {"x-oneOf": [{"type": "string"}, {"type": "object", "properties": {"url": {"type": "string"}, "filename": {"type": "string"}, "meta": {"type": "object"}}, "required": ["url"]}]}}, "conversion_settings": {"description": "Specify conversion settings (OCR, Assemble, ML Models) directly", "$ref": "#/definitions/ProjectDataIndexConversionSettings"}}}}], "responses": {"200": {"description": "CPS task info", "schema": {"$ref": "#/definitions/CpsTask"}}, "404": {"description": "Project data index not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename}": {"get": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Get url and path to upload an attachment to a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "get_attachment_upload_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "index_item_id", "in": "path", "type": "string", "required": true}, {"name": "filename", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Attachment upload url and path", "schema": {"title": "AttachmentUploadData", "type": "object", "required": ["attachment_path", "upload_data"], "properties": {"attachment_path": {"type": "string", "description": "Attachment path."}, "upload_data": {"type": "object", "description": "Data to upload the temporary file. Example using requests 'requests(dot)post(url, data=fields, files=file)'. More information can be found on aws s3 documentation here https://docs.aws.amazon.com/AmazonS3/latest/userguide/PresignedUrlUploadObject.html", "properties": {"url": {"type": "string", "description": "url of the host."}, "fields": {"type": "object", "description": "fields to use in request body."}}}}}}, "404": {"description": "Project data index or document ID not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Notify upload completion of an attachment to a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "register_attachment", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "index_item_id", "in": "path", "type": "string", "required": true}, {"name": "params", "in": "body", "required": true, "schema": {"type": "object", "required": ["attachment_path"], "properties": {"attachment_path": {"type": "string"}, "attachment_key": {"type": "string"}}}}], "responses": {"204": {"description": "Attachment notify successfull"}, "404": {"description": "Project data index or document ID not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/backend/project/{proj_key}/bags": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List all bags in the project, backend-aware", "produces": ["application/json"], "operationId": "backend_list_project_kgs", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "term", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/BagBackendAware"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create new BAG, backend-aware", "produces": ["application/json"], "operationId": "backend_create_project_kg", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateKnowledgeGraphOptions", "properties": {"name": {"type": "string", "pattern": "^(?:\\w| |-)+$", "description": "Name of the BAG", "maxLength": 32}, "flavours": {"type": "array", "description": "Flavours names of the bag. Determines its available resources", "items": {"type": "string"}}, "public": {"type": "boolean", "description": "If true, the BAG will be publicly available"}, "description": {"type": "string", "x-nullable": true, "description": "Description of the BAG"}}, "required": ["name", "flavours", "public"]}}], "responses": {"201": {"description": "OK", "schema": {"$ref": "#/definitions/BagBackendAware"}}, "400": {"description": "Invalid parameters.", "schema": {"$ref": "#/definitions/Problem"}}, "403": {"description": "Create knowledge graphs is disabled.", "schema": {"$ref": "#/definitions/Problem"}}, "409": {"description": "Cannot create BAG because one already exists with that name.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/backend/project/{proj_key}/bags/{bag_key}": {"patch": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Update the metadata of a Knowledge graph, backend-aware", "produces": ["application/json"], "operationId": "backend_update_project_kg_metadata", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "PatchKnowledgeGraphOptions", "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}}, "required": ["name", "description", "public"], "additionalProperties": false}}], "responses": {"200": {"description": "Knowledge graph metadata updated.", "schema": {"$ref": "#/definitions/BagBackendAware"}}, "404": {"description": "Knowledge graph not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Assemble a data flow on a Knowledge Graph, backend-aware", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "backend_assemble_project_kg_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "AssembleDataFlowIntoKnowledgeGraphOptions", "type": "object", "properties": {"data_flow": {"type": "object", "properties": {"raw_data_flow": {"type": "object", "description": "If this is set, the raw data flow contents will be used.", "properties": {"template": {"description": "Must be valid JSON", "type": "string"}, "variables": {"type": "object"}}, "required": ["template", "variables"]}, "public": {"description": "Must be set if the data flow template is public", "type": "boolean"}, "df_tpl_key": {"description": "If set, the data flow with this key will be used.", "type": "string"}, "proj_key": {"description": "If set, allows for cross-project data flows to be used.", "type": "string"}}}, "snapshot": {"$ref": "#/definitions/TakeSnapshotSettingsBackendAware"}, "render": {"type": "object", "properties": {"variables": {"type": "object", "additionalProperties": {}}}, "required": ["variables"]}}, "required": ["render", "data_flow"]}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/ProjectTask"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "Data flow template doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create a snapshot of a Knowledge Graph from the last data flow assembly task, backend-aware", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.controller", "operationId": "backend_create_project_kg_snapshot_from_data_flow_assembly", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "required": ["snapshot"], "properties": {"snapshot": {"$ref": "#/definitions/TakeSnapshotSettingsBackendAware"}}}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/ProjectTask"}}, "404": {"description": "KG/BAG/Data Flow Assembly not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/backend/project/{proj_key}/bags/{bag_key}/status": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get the status of a Knowledge Graph, backend-aware", "produces": ["application/json"], "operationId": "backend_get_project_kg_status", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "details", "in": "query", "type": "boolean", "required": false, "default": false}], "responses": {"200": {"description": "Knowledge Graph status.", "schema": {"$ref": "#/definitions/BagStatusBackendAware"}}, "404": {"description": "BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/public/bags": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List all public BAGs", "produces": ["application/json"], "operationId": "list_public_knowledge_graphs", "parameters": [{"name": "term", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/Bag"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags": {"get": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List all bags in the project", "produces": ["application/json"], "operationId": "list_project_knowledge_graphs", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "term", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/Bag"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create new BAG", "produces": ["application/json"], "operationId": "create_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateKnowledgeGraphOptions", "properties": {"name": {"type": "string", "pattern": "^(?:\\w| |-)+$", "description": "Name of the BAG", "maxLength": 32}, "flavour": {"type": "string", "description": "\"Flavour\" of the BAG, determines its available resources."}, "public": {"type": "boolean", "description": "If true, the BAG will be publicly available"}, "description": {"type": "string", "x-nullable": true, "description": "Description of the BAG"}}, "required": ["name", "flavour", "public"]}}], "responses": {"201": {"description": "OK", "schema": {"$ref": "#/definitions/Bag"}}, "400": {"description": "Invalid parameters.", "schema": {"$ref": "#/definitions/Problem"}}, "403": {"description": "Create knowledge graphs is disabled.", "schema": {"$ref": "#/definitions/Problem"}}, "409": {"description": "Cannot create BAG because one already exists with that name.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}": {"delete": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Delete a BAG", "produces": ["application/json"], "operationId": "delete_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "confirmation_token", "in": "query", "type": "string", "required": true}], "responses": {"204": {"description": "BAG deleted."}, "404": {"description": "BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "patch": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Update the metadata of a Knowledge graph", "produces": ["application/json"], "operationId": "update_project_knowledge_graph_metadata", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "PatchKnowledgeGraphOptions", "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}}, "required": ["name", "description", "public"], "additionalProperties": false}}], "responses": {"200": {"description": "Knowledge graph metadata updated.", "schema": {"$ref": "#/definitions/Bag"}}, "404": {"description": "Knowledge graph not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/status": {"get": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get the status of a Knowledge Graph", "produces": ["application/json"], "operationId": "get_project_knowledge_graph_status", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "details", "in": "query", "type": "boolean", "required": false, "default": false}], "responses": {"200": {"description": "Knowledge Graph status.", "schema": {"$ref": "#/definitions/BagStatus"}}, "404": {"description": "BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/usage_stats": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get the usage stats of a Knowledge Graph", "produces": ["application/json"], "operationId": "get_project_knowledge_graph_usage_stats", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Knowledge Graph usage stats.", "schema": {"title": "UsageStats", "type": "object", "properties": {"proj_key": {"type": "string"}, "bag_key": {"type": "string"}, "last_command": {"type": "string"}}}}, "404": {"description": "BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/delete_token": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a BAG.", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "BAG deletion token.", "schema": {"$ref": "#/definitions/TokenResponse"}}, "404": {"description": "BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/auth_token": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get a token used to authenticate in the Erlenmeyer / KG APIs of a BAG.", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_authentication_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "BAG auth token.", "schema": {"$ref": "#/definitions/TokenResponse"}}, "404": {"description": "BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/auth_callback": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Final step of redirection for authentication on a BAG.", "produces": ["application/json"], "operationId": "get_project_knowledge_graph_authentication_callback", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "bag_token", "in": "query", "type": "string", "required": true}], "responses": {"200": {"description": "BAG auth redirect URL.", "schema": {"title": "KnowledgeGraphAuthenticationCallback", "type": "object", "properties": {"callback_url": {"type": "string"}}}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/backup": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Back up a Knowledge Graph", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_backup", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "BackupKnowledgeGraphOptions", "type": "object", "properties": {"backup_s3": {"type": "boolean", "default": true}, "coordinates": {"$ref": "#/definitions/S3CoordinatesWithBackupKey"}}}}], "responses": {"201": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "400": {"description": "Invalid parameters.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "KG/BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/restore": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Restore a back up of a Knowledge Graph", "produces": ["application/json"], "operationId": "restore_project_knowledge_graph_backup", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "RestoreKnowledgeGraphBackupOptions", "type": "object", "properties": {"coordinates": {"$ref": "#/definitions/S3CoordinatesWithBackupKey"}}}}], "responses": {"201": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "400": {"description": "Invalid parameters.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "KG/BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/export": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Download a Knowledge Graph", "produces": ["application/json"], "operationId": "download_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "responses": {"201": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "400": {"description": "Invalid parameters.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "KG/BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow": {"get": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List assemble tasks for a Knowledge Graph.", "produces": ["application/json"], "operationId": "list_project_knowledge_graph_assemble_tasks", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "limit", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 50}, {"name": "skip", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 0}], "responses": {"200": {"description": "List of tasks.", "schema": {"type": "array", "items": {"title": "DataFlowAssembleIntoKnowledgeGraphTask", "type": "object", "properties": {"timestamp": {"type": "number", "format": "double"}, "data_flow": {"type": "object", "properties": {"render_options": {"type": "object", "properties": {"variables": {"type": "object"}, "target_bag": {"type": "object"}}}, "template": {"type": "string"}, "variables": {"type": "object"}}}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Assemble a data flow on a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "assemble_project_knowledge_graph_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "AssembleDataFlowIntoKnowledgeGraphOptions", "type": "object", "properties": {"data_flow": {"type": "object", "properties": {"raw_data_flow": {"type": "object", "description": "If this is set, the raw data flow contents will be used.", "properties": {"template": {"description": "Must be valid JSON", "type": "string"}, "variables": {"type": "object"}}, "required": ["template", "variables"]}, "public": {"description": "Must be set if the data flow template is public", "type": "boolean"}, "df_tpl_key": {"description": "If set, the data flow with this key will be used.", "type": "string"}, "proj_key": {"description": "If set, allows for cross-project data flows to be used.", "type": "string"}}}, "snapshot": {"$ref": "#/definitions/TakeSnapshotSettings"}, "render": {"type": "object", "properties": {"variables": {"type": "object", "additionalProperties": {}}}, "required": ["variables"]}}, "required": ["render", "data_flow"]}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/ProjectTask"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "Data flow template doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/dataset_assembles/{task_id}/report": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Create a report for a data flow task assemble.", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_assemble_report", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "DataFlowAssembleReportOptions", "type": "object", "properties": {"max_errors": {"type": "integer", "default": 50, "minimum": 0, "maximum": 100}, "event_log_level": {"type": "string", "default": "error", "enum": ["debug", "info", "warning", "error", "critical"]}}}}], "responses": {"200": {"description": "Report.", "schema": {"title": "DataFlowAssembleReport", "type": "object", "properties": {"task_id": {"type": "string"}, "dataflow_tasks": {"type": "object", "additionalProperties": {"title": "DataFlowAssembleReportSingleTask", "type": "object", "properties": {"status": {"type": "string"}, "progress": {"type": "number"}, "chunks": {"type": "object", "properties": {"total": {"type": "integer"}, "completed": {"type": "integer"}, "spawned": {"type": "integer"}, "success": {"type": "integer"}, "failure": {"type": "integer"}}}, "errors": {"type": "array", "items": {"type": "object", "properties": {"cause": {"type": "object", "properties": {"type": {"type": "string"}, "value": {}}}, "timestamp": {"type": "number"}}}}, "task_type": {"type": "string"}}}}}}}, "404": {"description": "Task not found, or is not a data flow assemble.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots": {"post": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create a snapshot of a Knowledge Graph from the last data flow assembly task.", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.controller", "operationId": "create_project_knowledge_graph_snapshot_from_data_flow_assembly", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "required": ["snapshot"], "properties": {"snapshot": {"$ref": "#/definitions/TakeSnapshotSettings"}}}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/ProjectTask"}}, "404": {"description": "KG/BAG/Data Flow Assembly not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/bags/{bag_key}/snapshots": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List snapshots for a knowledge graph from assembled data flows.", "produces": ["application/json"], "operationId": "list_project_knowledge_graph_snapshots", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Snapshots", "schema": {"type": "array", "items": {"$ref": "#/definitions/KgSnapshot"}}}, "404": {"description": "KG/BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create a snapshot of a Knowledge Graph, with its current state.", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_snapshot", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "KnowledgeGraphSnapshotOptions", "type": "object", "properties": {"name": {"type": "string", "pattern": "^(?:\\w| |-)+$"}}, "required": ["name"]}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/ProjectTask"}}, "403": {"description": "Feature is disabled on this instance.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "KG/BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.kg_controller"}}, "/project/{proj_key}/bags/{bag_key}/snapshots/{execution_id}/actions/load": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Load a snapshot resulting from an assembled data flow", "produces": ["application/json"], "operationId": "load_project_knowledge_graph_snapshot", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "execution_id", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Snapshot is being loaded.", "schema": {"$ref": "#/definitions/Task"}}, "400": {"description": "Invalid parameters.", "schema": {"$ref": "#/definitions/Problem"}}, "403": {"description": "Feature is disabled on this instance.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "KG/BAG/Snapshot not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/snapshots/{execution_id}": {"delete": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Delete a snapshot resulting from an assembled data flow. The execution log itself is not deleted.", "produces": ["application/json"], "operationId": "delete_project_knowledge_graph_snapshot", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "execution_id", "in": "path", "type": "string", "required": true}], "responses": {"204": {"description": "OK"}, "400": {"description": "Invalid parameters.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "KG/BAG/Snapshot not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/load_dataflow": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List load tasks for a Knowledge Graph", "produces": ["application/json"], "operationId": "list_project_knowledge_graph_load_tasks", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "limit", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 50}, {"name": "skip", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 0}], "responses": {"200": {"description": "List of tasks.", "schema": {"type": "array", "items": {"title": "DataFlowLoadIntoKnowledgeGraphTask", "type": "object", "properties": {"timestamp": {"type": "number", "format": "double"}, "data_flow": {"type": "object", "properties": {"render_options": {"type": "object", "properties": {"variables": {"type": "object"}, "target_bag": {"type": "object"}}}, "template": {"type": "string"}, "variables": {"type": "object"}}}, "save": {"type": "object"}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Load a data flow onto a Knowledge Graph.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "load_project_knowledge_graph_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "LoadDataFlowIntoKnowledgeGraphOptions", "type": "object", "properties": {"data_flow": {"type": "object", "properties": {"raw_data_flow": {"type": "object", "description": "If this is set, the raw data flow contents will be used.", "properties": {"template": {"description": "Must be valid JSON", "type": "string"}, "variables": {"type": "object"}}, "required": ["template", "variables"]}, "public": {"description": "Must be set if the data flow template is public", "type": "boolean"}, "df_tpl_key": {"description": "If set, the data flow with this key will be used.", "type": "string"}, "proj_key": {"description": "If set, allows for cross-project data flows to be used.", "type": "string"}}}, "render": {"type": "object", "properties": {"variables": {"type": "object", "additionalProperties": {}}}, "required": ["variables"]}, "save": {"type": "object"}}, "required": ["save", "render", "data_flow"]}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/ProjectTask"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "Data flow template doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/suspend": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Suspend a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "suspend_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "SuspendKnowledgeGraphOptions", "type": "object", "properties": {"force": {"type": "boolean", "description": "If true, the KG will be suspended even if it's busy"}, "snapshot": {"type": "object", "properties": {"name": {"type": "string"}}}}, "required": ["force"]}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/ProjectTask"}}, "404": {"description": "Knowledge Graph doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/resume": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Resume a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "resume_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "ResumeKnowledgeGraphOptions", "type": "object", "properties": {"snapshot_to_restore_id": {"type": "string"}, "reset": {"type": "boolean"}}}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/ProjectTask"}}, "403": {"description": "Feature is disabled on this instance.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "Knowledge Graph doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/upgrade": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Upgrade the deployment chart of a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "upgrade_project_knowledge_graph_deployment", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "KnowledgeGraphChartUpgradeOptions", "type": "object", "properties": {"chart": {"type": "string"}}}}], "responses": {"200": {"description": "Chart upgrading."}, "404": {"description": "Knowledge Graph doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/recreate_deployment": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "(Re)create the deployment for a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "recreate_project_knowledge_graph_deployment", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "KnowledgeGraphDeploymentRecreationOptions", "type": "object", "properties": {"force": {"type": "boolean"}}, "required": ["force"]}}], "responses": {"200": {"description": "Deployment upgrading."}, "404": {"description": "Knowledge Graph doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "409": {"description": "Refused to recreate the deployment since it already exists and the `force` flag is not `true`.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/export_dataset": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}, {"KGAuth": []}], "description": "Export dataset from a Knowledge Graph", "produces": ["application/json"], "operationId": "export_dataset", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "data", "in": "body", "required": true, "schema": {"type": "object", "required": ["info"], "properties": {"info": {"type": "object", "required": ["coords"], "properties": {"node_list": {"type": "array", "minLength": 1, "example": [{"_db": "db1-hash", "_id": "node-id"}, {"_db": "db2-hash", "_id": "node-id"}], "items": {"type": "object", "properties": {"_db": {"type": "string"}, "_id": {"type": "string"}}, "required": ["_db", "_id"]}}, "collection_key": {"type": "string"}, "include_s3_data": {"type": "boolean", "default": false}, "projection": {"type": "object", "example": {"projection": {}}, "description": "A dict specifying the fields to include or exclude. Use a dict to exclude fields from the result (e.g. projection={'main-text': false})."}, "coords": {"type": "object", "required": ["databases", "node_collection"], "properties": {"databases": {"type": "object", "additionalProperties": true}, "node_collection": {"type": "object", "properties": {"uri": {"type": "string"}, "database": {"type": "string"}, "collection_name_prefix": {"type": "string"}, "collection": {"type": "string"}}, "required": ["uri", "database", "collection_name_prefix", "collection"]}}}}}}}}], "responses": {"200": {"description": "Task", "schema": {"$ref": "#/definitions/ProjectTask"}}, "404": {"description": "Task not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.kg_controller"}}, "/elastic/indices/{index_type}/{index_domain}": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "List of indices for elastic instance.", "produces": ["application/json"], "operationId": "list_indices_from_elastic_instance", "parameters": [{"name": "index_type", "in": "path", "type": "string", "default": "all", "required": true}, {"name": "index_domain", "in": "path", "type": "string", "required": true, "default": "all"}], "responses": {"200": {"description": "List of Elastic Instance Indices", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCollection"}}}, "404": {"description": "Instance indices not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/elastic/{elastic_instance}/{elastic_index}/properties": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "Get the property schema of the given index.", "produces": ["application/json"], "operationId": "get_index_properties", "parameters": [{"name": "elastic_instance", "in": "path", "type": "string", "required": true}, {"name": "elastic_index", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Property schema", "schema": {"$ref": "#/definitions/ElasticIndexProperties"}}, "404": {"description": "Instance index not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/elastic/{elastic_instance}/{elastic_index}/saved_queries": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "List Kibana saved queries.", "produces": ["application/json"], "operationId": "get_kibana_saved_queries", "parameters": [{"name": "elastic_instance", "in": "path", "type": "string", "required": true}, {"name": "elastic_index", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "List of Kibana saved queries", "schema": {"type": "array", "title": "KibanaSavedQueriesResult", "items": {"$ref": "#/definitions/KibanaSavedQueriesResult"}}}, "404": {"description": "Instance indices not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/elastic/domains": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "List system elastic domains.", "produces": ["application/json"], "operationId": "get_elastic_domains", "responses": {"200": {"description": "List of Elastic Domains.", "schema": {"type": "array", "items": {"type": "string"}}}, "404": {"description": "Domains not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/elastic/query_max_size": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "Get the system maximum workable elastic query size.", "produces": ["application/json"], "operationId": "get_elastic_query_max_size", "responses": {"200": {"description": "Maximum elastic query size.", "schema": {"type": "object", "properties": {"elastic_query_max_size": {"type": "number"}}}}, "404": {"description": "No maximum workable elastic query size found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/deployment/info": {"get": {"tags": ["System"], "description": "Get deployment version report", "produces": ["application/json"], "operationId": "get_version_report", "security": [{"ManagementKey": []}], "parameters": [], "responses": {"200": {"description": "OK"}, "401": {"description": "Authentication failed, management api token is invalid or doesn't match", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/info": {"get": {"tags": ["System"], "description": "Get system info", "produces": ["application/json"], "operationId": "get_system_information", "parameters": [], "responses": {"201": {"description": "OK", "schema": {"$ref": "#/definitions/SystemInfo"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/modules/configuration": {"get": {"tags": ["System"], "description": "Get modules configuration", "produces": ["application/json"], "operationId": "get_system_modules_configuration", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [], "responses": {"201": {"description": "Modules configuration", "schema": {"$ref": "#/definitions/SystemModulesConfiguration"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/modules/tasks": {"get": {"tags": ["System"], "description": "Get modules tasks", "produces": ["application/json"], "operationId": "get_system_modules_tasks", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [], "responses": {"201": {"description": "Modules tasks", "schema": {"$ref": "#/definitions/SystemModulesTasks"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/celery_tasks/status": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "Get the status of Celery tasks.", "produces": ["application/json"], "operationId": "list_system_celery_tasks", "parameters": [{"name": "proj_key", "in": "query", "required": false, "type": "string"}, {"name": "project_task_id", "in": "query", "required": false, "type": "string"}, {"name": "started_since", "required": false, "type": "number", "in": "query", "description": "If set, return the tasks created at or after this timestamp. Otherwise, return the tasks created up to 60 minutes of the system's date, if `project_task_id` is not set."}, {"name": "task_status", "required": false, "type": "number", "format": "double", "in": "query"}, {"name": "limit", "required": false, "type": "integer", "in": "query", "default": 50}], "responses": {"200": {"description": "Celery tasks", "schema": {"type": "array", "items": {"title": "CeleryTask", "type": "object", "required": ["task_id", "project_task_id", "proj_key", "task_type", "created_at", "started_at", "completed_at", "task_status", "worker_name", "meta"], "properties": {"task_id": {"type": "string"}, "task_type": {"type": "string"}, "project_task_id": {"type": "string"}, "project_task_type": {"type": "string", "x-nullable": true}, "meta": {"type": "object", "additionalProperties": {}}, "proj_key": {"type": "string"}, "created_at": {"type": "number"}, "started_at": {"type": "number"}, "completed_at": {"type": "number"}, "task_status": {"type": "string"}, "worker_name": {"type": "string"}, "metrics": {"type": "object"}}}}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/celery_tasks/failure": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "Get celery tasks that failed.", "produces": ["application/json"], "operationId": "list_failure_celery_tasks", "parameters": [{"name": "proj_key", "in": "query", "required": true, "type": "string"}, {"name": "task_id", "in": "query", "required": true, "type": "string"}], "responses": {"200": {"description": "Celery tasks", "schema": {"type": "array", "items": {"title": "CeleryTask", "type": "object", "required": ["proj_key", "task_id", "failures"], "properties": {"proj_key": {"type": "string"}, "task_id": {"type": "string"}, "failures": {"type": "array", "items": {"type": "object", "properties": {"worker_name": {"type": "string"}, "task_id": {"type": "string"}, "meta": {"type": "object", "additionalProperties": {}}, "logs": {"type": "object", "additionalProperties": {}}}}}}}}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/kgs": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "List all Knowledge Graphs in the system", "produces": ["application/json"], "operationId": "list_system_knowledge_graphs", "parameters": [{"name": "proj_key", "in": "query", "type": "string", "required": false}, {"name": "term", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"title": "KnowledgeGraphSystemInformation", "type": "object", "properties": {"proj_key": {"type": "string"}, "bag_key": {"type": "string"}, "name": {"type": "string"}, "slug": {"type": "string"}, "timestamp": {"type": "number", "format": "double"}, "bag_domain": {"type": "string"}, "bag_url": {"type": "string"}, "public": {"type": "boolean"}, "project_name": {"type": "string"}, "backend": {"type": "object", "additionalProperties": {"type": "object", "properties": {"flavour": {"type": "string"}, "deployment": {"type": "object", "properties": {"name": {"type": "string"}, "chart": {"type": "string"}, "flavour": {"type": "string"}, "resources": {"type": "object", "additionalProperties": {"type": "object", "properties": {"requests": {"type": "object"}, "limits": {"type": "object"}}}}}}}}}}}}}, "default": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.admin_kg_controller"}}, "/system/packages": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get packages available in this CPS installation for installing in a project.", "produces": ["application/json"], "operationId": "list_packages", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Packages available to this CPS installation", "schema": {"type": "array", "items": {"$ref": "#/definitions/CpsPackage"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_all_kgs": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get all kgs (only bag_key) for admin use", "produces": ["application/json"], "operationId": "system_get_all_kgs_admin", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [], "responses": {"200": {"description": "Array with all kgs's key", "schema": {"type": "array", "items": {"type": "string"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_all_dcs": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get all data catalogs (only dc_key) for admin use", "produces": ["application/json"], "operationId": "system_get_all_dcs_admin", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [], "responses": {"200": {"description": "Array with all dcs's key", "schema": {"type": "array", "items": {"type": "string"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/kg_storage_summary/{kg_key}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get kg storage summary", "produces": ["application/json"], "operationId": "system_get_kg_storage_summary_async", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "kg_key", "in": "path", "type": "string", "required": true, "description": "Knowledge graph key"}], "responses": {"200": {"description": "Kg storage summary", "schema": {"$ref": "#/definitions/StorageSummaryTask"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/dc_storage_summary/{dc_key}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get dc storage summary", "produces": ["application/json"], "operationId": "system_get_dc_storage_summary_async", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "dc_key", "in": "path", "type": "string", "required": true, "description": "Data catalog key"}], "responses": {"200": {"description": "DC storage summary", "schema": {"$ref": "#/definitions/StorageSummaryTask"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/summary": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get cps summary data.", "produces": ["application/json"], "operationId": "system_get_cps_summary", "parameters": [], "responses": {"200": {"description": "Cps summary", "schema": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "workersPool": {"type": "string"}, "numNodes": {"type": "integer"}, "availSlots": {"type": "integer"}, "availMemSlots": {"type": "integer"}, "availCpuSlots": {"type": "integer"}, "numberKgs": {"type": "integer"}, "runningKgs": {"type": "integer"}}}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/admin/list_all_flavours": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get all KG flavours storage on db", "produces": ["application/json"], "operationId": "list_all_flavours", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Flavours storage on db", "schema": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourFullData"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_flavour/{flavour_name}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get flavour from db", "produces": ["application/json"], "operationId": "get_flavour", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "flavour_name", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Get flavour successful", "schema": {"$ref": "#/definitions/BagFlavourFullData"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/save_flavour": {"put": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Save flavour on db", "produces": ["application/json"], "operationId": "save_flavour", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "new_flavour", "in": "query", "required": true, "type": "boolean"}, {"name": "body", "in": "body", "required": true, "schema": {"$ref": "#/definitions/BagFlavourFullData"}}], "responses": {"200": {"description": "Save flavour successful"}, "409": {"description": "Flavour name already taken"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/delete_flavour/{flavour_name}": {"delete": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Delete flavour from db", "produces": ["application/json"], "operationId": "delete_flavour", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "flavour_name", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Deleted flavour successful"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/list_projects_flavours": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get all projects and their flavours", "produces": ["application/json"], "operationId": "list_projects_flavours", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Flavours storage on db", "schema": {"type": "array", "items": {"$ref": "#/definitions/ProjectsFlavours"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/save_project_flavours": {"put": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Save project flavours assignment on db", "produces": ["application/json"], "operationId": "save_project_flavours", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "body", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectsFlavours"}}], "responses": {"200": {"description": "Save project flavours successful"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_project_flavours/{proj_key}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get project assignment flavours", "produces": ["application/json"], "operationId": "list_flavours_by_project", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Ok", "schema": {"title": "ProjectFlavours", "type": "object", "properties": {"proj_key": {"type": "string"}, "flavours": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourFullData"}}}, "required": ["proj_key", "flavours"]}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_flavours_default_quota": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get flavours default values", "produces": ["application/json"], "operationId": "get_flavours_default_quotas", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Flavours default values", "schema": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourDefaultQuota"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/save_flavours_default_quota": {"put": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Save flavours default quota", "produces": ["application/json"], "operationId": "save_flavours_default_quotas", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "flavours", "in": "body", "required": true, "schema": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourDefaultQuota"}}}], "responses": {"200": {"description": "Save flavours default quotas successful", "schema": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourDefaultQuota"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_projects_flavours_quota": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get projects flavours quotas", "produces": ["application/json"], "operationId": "get_projects_flavours_quota", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Projects flavours quotas", "schema": {"type": "array", "items": {"$ref": "#/definitions/ProjectsFlavoursQuota"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/save_project_flavours_quota": {"put": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Save project flavours quota", "produces": ["application/json"], "operationId": "save_project_flavours_quota", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "projects_flavours_quotas", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectsFlavoursQuota"}}], "responses": {"200": {"description": "Save project flavours quota successful"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_project_flavours_quota/{proj_key}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get project flavours quota", "produces": ["application/json"], "operationId": "get_project_flavours_quota", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Project flavours quota", "schema": {"type": "array", "items": {"$ref": "#/definitions/FlavoursQuota"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_project_flavour_total_kgs/{proj_key}/{flavour_name}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Gets kg total number by proj_key and flavour_key", "produces": ["application/json"], "operationId": "get_project_flavour_total_kgs", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "flavour_name", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Project flavours total kg number", "schema": {"title": "ProjectFlavourTotalKgs", "type": "object", "properties": {"proj_key": {"type": "string"}, "flavour_name": {"type": "string"}, "total_kgs": {"type": "integer"}}, "required": ["proj_key", "flavour_name", "total_kgs"]}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/kgc/dataflows/actions/validate": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Validate a dataflow", "produces": ["application/json"], "operationId": "validate_project_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dataflow", "x-body-name": "dataflow", "in": "body", "required": true, "schema": {"$ref": "#/definitions/KgcDataInput"}}], "responses": {"200": {"description": "Validation successful."}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflows/actions/run": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Run a dataflow", "produces": ["application/json"], "operationId": "assemble_project_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dataflow", "x-body-name": "dataflow", "in": "body", "required": true, "schema": {"$ref": "#/definitions/KgcDataInput"}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/Task"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflows/actions/load": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Load a dataflow into a KG", "produces": ["application/json"], "operationId": "load_project_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"$ref": "#/definitions/LoadKgcDataInput"}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/Task"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/public/kgc/dataflow_templates": {"get": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "List public data flow templates", "produces": ["application/json"], "operationId": "list_public_data_flow_templates", "parameters": [{"name": "query", "in": "query", "required": false, "type": "string"}], "responses": {"200": {"description": "List of data flow templates.", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataFlowTemplateListItem"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates": {"get": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "List a data flow templates", "produces": ["application/json"], "operationId": "list_project_data_flow_templates", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "query", "in": "query", "required": false, "type": "string"}], "responses": {"200": {"description": "List of data flow templates.", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataFlowTemplateListItem"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Create a data flow template", "produces": ["application/json"], "operationId": "create_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "CreateDataFlowTemplateOptions", "type": "object", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$", "maxLength": 50, "minLength": 1}, "description": {"type": "string", "x-nullable": true}, "variables": {"type": "object", "additionalProperties": {"type": "object", "required": ["type"], "properties": {"type": {"$ref": "#/definitions/DataFlowTemplateVariable"}, "default_value": {}}}}, "template": {"$ref": "#/definitions/DataFlowTemplate"}}, "required": ["public", "name", "variables", "template", "description"]}}], "responses": {"200": {"description": "Dataflow created.", "schema": {"$ref": "#/definitions/DataFlow"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/from_json": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Create a data flow template from a JSON file.\n**DEPRECATED**: use `create_project_data_flow_template`\n", "deprecated": true, "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "name", "in": "formData", "required": false, "type": "string"}, {"name": "description", "in": "formData", "required": false, "type": "string"}, {"name": "public", "in": "formData", "type": "boolean", "required": false}, {"name": "contents", "in": "formData", "required": true, "type": "file"}], "responses": {"200": {"description": "Dataflow created.", "schema": {"$ref": "#/definitions/DataFlow"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/public/kgc/dataflow_templates/{df_tpl_key}": {"get": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Get a single data flow template", "produces": ["application/json"], "operationId": "get_public_data_flow_template", "parameters": [{"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}], "responses": {"200": {"description": "Data flow.", "schema": {"$ref": "#/definitions/DataFlow"}}, "404": {"description": "Data flow template doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/public/kgc/dataflow_templates/{df_tpl_key}/export.json": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Export a single public data flow template", "produces": ["application/vnd.ibm.cps.df-template+json"], "operationId": "export_public_data_flow_template", "parameters": [{"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}], "responses": {"200": {"description": "Data flow template.", "schema": {"type": "file"}}, "404": {"description": "Data flow template doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}": {"get": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Get a single data flow template", "produces": ["application/json"], "operationId": "get_project_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}], "responses": {"200": {"description": "Data flow template.", "schema": {"$ref": "#/definitions/DataFlow"}}, "404": {"description": "Data flow template doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "put": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Update a data flow template", "produces": ["application/json"], "operationId": "update_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "UpdateDataFlowOptions", "type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string"}, "variables": {"type": "object", "additionalProperties": {"type": "object", "required": ["type"], "properties": {"type": {"$ref": "#/definitions/DataFlowTemplateVariable"}, "default_value": {}}}}, "template": {"$ref": "#/definitions/DataFlowTemplate"}, "public": {"type": "boolean"}}, "required": ["public", "name", "variables", "template"]}}], "responses": {"200": {"description": "Dataflow updated.", "schema": {"$ref": "#/definitions/DataFlow"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "delete": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Delete a single data flow template", "produces": ["application/json"], "operationId": "delete_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "confirmation_token", "in": "query", "type": "string", "required": true}], "responses": {"204": {"description": "Data flow deleted."}, "404": {"description": "Data flow template doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/delete_token": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a data flow template.", "produces": ["application/json"], "operationId": "create_project_data_flow_template_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Data flow deletion token.", "schema": {"$ref": "#/definitions/TokenResponse"}}, "404": {"description": "Data flow template not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/export.json": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Export a single data flow template", "produces": ["application/vnd.ibm.cps.df-template+json"], "operationId": "export_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}], "responses": {"200": {"description": "Data flow template.", "schema": {"type": "file"}}, "404": {"description": "Data flow template doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/topology": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values and get the resulting Knowledge Graph topology from it.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "get_project_data_flow_template_topology", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "DataFlowTopologyOptions", "type": "object", "properties": {"variables": {"type": "object", "additionalProperties": {}}}}}], "responses": {"200": {"description": "Data flow topology.", "schema": {"$ref": "#/definitions/Topology"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "Data flow template doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/render": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "render_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "RenderDataFlowTemplateOptions", "type": "object", "properties": {"target_bag": {"type": "object", "properties": {"bag_key": {"type": "string"}, "proj_key": {"type": "string", "description": "If set, this will override the 'proj_key' parameter in the path, allowing cross-project KGs to be used."}}, "required": ["bag_key"]}, "variables": {"type": "object", "additionalProperties": {}}}, "required": ["target_bag", "variables"]}}], "responses": {"200": {"description": "Rendered data flow", "schema": {"type": "object"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "Data flow template doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/run": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values and run it.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "assemble_project_data_flow_template_into_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "RunDataFlowTemplateOptions", "type": "object", "properties": {"target_bag_key": {"type": "string"}, "variables": {"type": "object", "additionalProperties": {}}}}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/Task"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "Data flow template doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/raw_dataflow_templates/actions/run": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values and run it.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "assemble_project_raw_data_flow_template_into_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "RunDataFlowTemplateOptions", "type": "object", "required": ["data_flow", "variable_values", "log_task"], "properties": {"log_task": {"type": "boolean", "default": true}, "data_flow": {"type": "object", "properties": {"template": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object"}}}, "required": ["config", "data-flow"]}, "variables": {"type": "object", "additionalProperties": {}}}, "required": ["template", "variables"]}, "variable_values": {"type": "object", "additionalProperties": {}}}}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/Task"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "Data flow template doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/load": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values and load it into a Knowledge Graph.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "load_project_data_flow_template_into_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "LoadDataFlowIntoKnowledgeGraphOptions", "type": "object", "properties": {"render": {"type": "object", "properties": {"target_bag": {"type": "object", "properties": {"bag_key": {"type": "string"}, "proj_key": {"type": "string", "description": "If set, this will override the 'proj_key' parameter in the path, allowing cross-project KGs to be used."}}, "required": ["bag_key"]}, "variables": {"type": "object", "additionalProperties": {}}}, "required": ["target_bag", "variables"]}, "target": {"type": "object", "properties": {"save": {"type": "object"}}, "required": ["save"]}}}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/Task"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "Data flow template doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc_dataflow_templates/debug/{df_tpl_key}": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "(Debug) get the fully rendered data flow, with all the coordinates set.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "debug_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "FullyRenderedDataFlow", "type": "object", "properties": {"target_bag": {"type": "object", "required": ["bag_key"], "properties": {"bag_key": {"type": "string"}, "proj_key": {"type": "string"}}}, "variables": {"type": "object", "additionalProperties": {}}}}}], "responses": {"200": {"description": "Rendered data flow.", "schema": {"type": "object"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "404": {"description": "Data flow template doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/data_cataloges/known_schemas": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "List System Known Data Catalog Schemas.", "produces": ["application/json"], "operationId": "list_known_data_catalog_schemas", "parameters": [], "responses": {"200": {"description": "List of Known Data Catalog Schemas.", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogSchema"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/data_catalogues/with_schema": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "List data catalogues with specific schema", "produces": ["application/json"], "operationId": "list_data_catalogs_and_collections_from_schema", "parameters": [{"name": "proj_key", "in": "query", "type": "string", "required": false}, {"name": "schema", "x-body-name": "schema", "in": "body", "required": true, "schema": {"type": "object", "additionalProperties": {}}}], "responses": {"200": {"description": "List of data catalogues", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogue"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/data": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get Data Catalog Collection data.", "produces": ["application/json"], "operationId": "get_data_catalog_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "after", "in": "query", "type": "string", "required": false}, {"name": "limit", "in": "query", "type": "integer", "minimum": 0, "default": 50, "required": false}], "responses": {"200": {"description": "Get Data Catalog Collection data."}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/from_mongo": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Create a data catalogue from a mongo database", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_data_catalog_from_mongo", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DataCatalogImportOptions", "type": "object", "properties": {"target": {"type": "object", "required": ["name", "description", "public"], "properties": {"public": {"type": "boolean"}, "name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}}}, "options": {"type": "object", "required": ["coordinates"], "properties": {"coordinates": {"$ref": "#/definitions/MongoS3CoordinatesWithCollectionList"}}}}, "required": ["target", "options"]}}], "responses": {"200": {"description": "Data catalogue created, and data is being imported.", "schema": {"$ref": "#/definitions/DataCatalogImportResult"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/from_url": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Create a data catalogue from a URL to a file", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_data_catalog_from_url", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DataCatalogUrlImportOptions", "type": "object", "properties": {"target": {"type": "object", "required": ["name", "description", "public"], "properties": {"public": {"type": "boolean"}, "name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}}}, "options": {"type": "object", "required": ["url"], "properties": {"url": {"type": "string"}}}}, "required": ["target", "options"]}}], "responses": {"200": {"description": "Data catalogue created, and data is being imported.", "schema": {"$ref": "#/definitions/DataCatalogImportResult"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/actions/clone": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Clone an existing data catalogue", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "clone_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "CloneDataCatalogOptions", "type": "object", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "x-nullable": true, "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}, "copy_s3": {"type": "boolean", "description": "Should the catalog's S3 data also be copied?", "default": true}, "collections": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "description", "public"]}}], "responses": {"200": {"description": "Data catalogue cloned, and data is being copied.", "schema": {"$ref": "#/definitions/CloneDataCatalogResult"}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "List data catalogues for a project", "produces": ["application/json"], "operationId": "list_project_data_catalogs", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "query", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "List of data catalogues", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogue"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}, "post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Create an empty data catalog", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "create_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateDataCatalogOptions", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}, "topology:data_flows": {"type": "array", "items": {"type": "object", "title": "DataCatalogDataFlow", "required": ["key", "data_flows"], "properties": {"key": {"type": "string"}, "data_flows": {"type": "object", "additionalProperties": {}}}, "$ref": "#/definitions/DataCatalogTopology"}}, "category_schemas": {"type": "array", "items": {"type": "object", "title": "DataCatalogCategorySchema", "required": ["key", "schema"], "properties": {"key": {"type": "string"}, "schema": {"type": "object", "additionalProperties": {}}}}}, "collections_data_flows": {"type": "array", "items": {"type": "object", "title": "DataCatalogDataFlow", "required": ["key", "data_flows"], "properties": {"key": {"type": "string"}, "data_flows": {"type": "array", "items": {"type": "object"}}}}}}, "required": ["name", "description", "public"]}}], "responses": {"200": {"description": "Data catalog created.", "schema": {"$ref": "#/definitions/DataCatalogue"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/public/data_catalogues/{dc_key}": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get a single data catalogue that was made public", "produces": ["application/json"], "operationId": "get_public_data_catalog", "parameters": [{"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "responses": {"200": {"description": "Data catalogue", "schema": {"$ref": "#/definitions/DataCatalogue"}}, "404": {"description": "Data catalogue not found or is not public", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/public/data_catalogues/{dc_key}/collections": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get the collections of a data catalog.", "produces": ["application/json"], "operationId": "list_public_data_catalog_collections", "parameters": [{"name": "dc_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Data catalog collections", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogCollection"}}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}": {"delete": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Delete a single data catalog's collection", "produces": ["application/json"], "operationId": "delete_project_data_catalog_collection", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}], "responses": {"204": {"description": "Collection deleted."}, "404": {"description": "Collection doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/infer_schema": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Infer the schema for a data catalog's collection.", "produces": ["application/json"], "operationId": "infer_project_data_catalog_category_schema", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "InferProjectDataCatalogCategorySchema", "type": "object", "properties": {"sample_size": {"type": "integer", "minimum": 1, "maximum": 1000}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/upload": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Upload data to a data catalog collection. The collection will be created if it doesn't exist.", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_data_catalog_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "responses": {"200": {"description": "Data is being processed.", "schema": {"$ref": "#/definitions/Task"}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/import": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Import data to a data catalog collection. The collection will be created if it doesn't exist.", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_data_catalog_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "title": "ImportToDataCatalogCollectionOptions", "minProperties": 1, "maxProperties": 1, "properties": {"ccs": {"type": "object", "properties": {"proj_key": {"type": "string"}, "auth_token": {"type": "string"}, "url": {"type": "string"}, "source_collection_name": {"type": "string"}, "export_package_mongo_options": {"type": "object", "required": ["assemble_options", "incremental", "package_options"], "properties": {"incremental": {"type": "boolean"}, "assemble_options": {"type": "object", "required": ["mode", "options"], "properties": {"mode": {"required": ["page_elements", "tables"], "properties": {"page_elements": {"description": "Which type of annotations to filter for the page elements: H (human annotations), M (model generated)", "items": {"enum": ["H", "M"], "type": "string"}, "type": "array", "minItems": 2, "maxItems": 2}, "tables": {"description": "Which type of annotations to filter for the tables: H (human annotations), M (model generated)", "items": {"enum": ["H", "M"], "type": "string"}, "type": "array", "minItems": 2, "maxItems": 2}}, "type": "object"}, "options": {"required": ["include_incomplete_documents"], "properties": {"include_incomplete_documents": {"type": "boolean", "description": "Include documents with missing pages? (e.g. no annotations for some pages)"}}, "type": "object"}}}, "inputs": {"type": "object", "required": ["document_hashes"], "properties": {"document_hashes": {"type": "array", "default": [], "items": {"type": "string"}}}}, "package_options": {"type": "object", "properties": {"match_mode": {"type": "string", "default": "document_hash", "enum": ["use_fuzzy_search", "document_hash"]}, "redirect_keys_to_s3": {"type": "array", "default": [], "items": {"type": "string"}}}}}}}, "required": ["proj_key"]}, "url": {"type": "string"}, "elastic": {"title": "ImportFromElasticToDataCatalogOptions", "type": "object", "required": ["parameters"], "properties": {"coordinates": {"$ref": "#/definitions/ElasticCoordinates"}, "elastic_id": {"type": "string"}, "parameters": {"type": "object", "required": ["index", "query_options"], "properties": {"index": {"type": "string"}, "query_options": {"type": "object", "properties": {"_source": {"type": "array", "items": {"type": "string"}}, "size": {"type": "number", "minimum": 0}, "query": {"type": "object", "additionalProperties": {}}}}, "import_s3_data": {"type": "boolean"}, "s3": {"title": "ImportFromElasticToDataCatalogS3Coords", "type": "object", "properties": {"host": {"type": "string"}, "port": {"type": "integer"}, "ssl": {"type": "boolean"}, "verifySSL": {"type": "boolean"}, "access-key": {"type": "string"}, "secret-key": {"type": "string"}, "bucket": {"type": "string"}, "key_prefix": {"type": "string"}, "location": {"type": "string"}}, "required": ["host", "port", "ssl", "verifySSL", "access-key", "secret-key", "bucket", "key_prefix", "location"]}, "page_size": {"type": "number", "default": 100}}}}}}}}], "responses": {"200": {"description": "Data is being processed.", "schema": {"$ref": "#/definitions/Task"}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/export": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Export the contents of a data catalog's collection", "produces": ["application/zip", "application/json", "application/x-jsonlines"], "operationId": "export_project_data_catalog_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Data catalog collection contents.", "schema": {"type": "file"}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/actions/upload": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Upload data to a data catalog. The collection name(s) will be inferred from the file name(s).", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_data_catalog_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "responses": {"200": {"description": "Data is being processed.", "schema": {"$ref": "#/definitions/Task"}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/actions/import": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Import data to a data catalog. The collections will be created if they don't exist.", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_data_catalog_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "title": "ImportToDataCatalogOptions", "minProperties": 1, "maxProperties": 1, "properties": {"url": {"type": "string"}, "coordinates": {"$ref": "#/definitions/MongoS3CoordinatesWithCollectionList"}}}}], "responses": {"200": {"description": "Data is being processed.", "schema": {"$ref": "#/definitions/Task"}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/actions/export": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Export the contents of a data catalog.", "produces": ["application/zip"], "operationId": "export_project_data_catalog_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Data catalog contents.", "schema": {"type": "file"}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/delete_token": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a data catalog.", "produces": ["application/json"], "operationId": "create_project_data_catalog_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Data catalog deletion token.", "schema": {"$ref": "#/definitions/TokenResponse"}}, "404": {"description": "Data flow template not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/public/data_catalogues": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "List public data catalogues", "produces": ["application/json"], "operationId": "list_public_data_catalogs", "parameters": [{"name": "query", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "List of public data catalogues", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogue"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/public/data_catalogues/{dc_key}/actions/clone": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Clone an existing public data catalogue", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "clone_public_data_catalog", "parameters": [{"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "ClonePublicDataCatalogOptions", "type": "object", "properties": {"proj_key": {"description": "The project key of the project to store the resulting data catalogue", "type": "string"}, "public": {"type": "boolean"}, "name": {"type": "string", "x-nullable": true, "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}, "collections": {"type": "array", "items": {"type": "string"}}, "copy_s3": {"type": "boolean", "description": "Should the catalog's S3 data also be copied?", "default": true}}, "required": ["name", "description", "public", "proj_key"]}}], "responses": {"200": {"description": "Data catalogue cloned, and data is being copied.", "schema": {"$ref": "#/definitions/CloneDataCatalogResult"}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get a single data catalogue", "produces": ["application/json"], "operationId": "get_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "responses": {"200": {"description": "Data catalogue", "schema": {"$ref": "#/definitions/DataCatalogue"}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}, "delete": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Delete a single data catalog", "produces": ["application/json"], "operationId": "delete_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "required": true, "type": "string"}, {"name": "confirmation_token", "in": "query", "type": "string", "required": true}], "responses": {"204": {"description": "Data catalog deleted."}, "404": {"description": "Data catalog doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}, "patch": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Update the metadata of a data catalog.", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "patch_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"type": "object", "title": "PatchDataCatalogOptions", "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}, "topology": {"$ref": "#/definitions/DataCatalogTopology"}, "category_schemas": {"type": "array", "items": {"type": "object", "title": "DataCatalogCategorySchema", "required": ["key", "schema"], "properties": {"key": {"type": "string"}, "schema": {"type": "object", "additionalProperties": {}}}}}, "collections_data_flows": {"type": "array", "items": {"type": "object", "title": "DataCatalogDataFlow", "required": ["key", "data_flows"], "properties": {"key": {"type": "string"}, "data_flows": {"type": "array", "items": {"type": "object"}}}}}}, "additionalProperties": false}}], "responses": {"200": {"description": "Data catalog updated.", "schema": {"$ref": "#/definitions/DataCatalogue"}}, "404": {"description": "Data catalog not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get the collections of a data catalog.", "produces": ["application/json"], "operationId": "list_project_data_catalog_collections", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Data catalog collections", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogCollection"}}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}, "post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Create a collection in a data catalog", "produces": ["application/json"], "operationId": "create_project_data_catalog_collection", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateDataCatalogCollectionOptions", "properties": {"collection_name": {"type": "string", "pattern": "^(?:\\w|-)+$", "maxLength": 24, "minLength": 4}}, "required": ["collection_name"]}}], "responses": {"200": {"description": "Collection created."}, "404": {"description": "Dictionary doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/tasks": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "List tasks for a project.", "produces": ["application/json"], "operationId": "list_project_tasks", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_type", "in": "query", "required": false, "type": "string"}, {"name": "limit", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 50}, {"name": "skip", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 0}, {"name": "sort_by", "in": "query", "required": false, "type": "string"}, {"name": "sort_order", "in": "query", "required": false, "type": "string", "default": "asc", "enum": ["asc", "desc"]}], "responses": {"200": {"description": "List of tasks.", "schema": {"type": "array", "items": {"$ref": "#/definitions/ProjectTask"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/tasks/{task_id}": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}, {"KGAuth": []}], "description": "Get a task for a project.", "produces": ["application/json"], "operationId": "get_project_task", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "required": true, "type": "string"}], "responses": {"200": {"description": "Task", "schema": {"$ref": "#/definitions/ProjectTask"}}, "404": {"description": "Task not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/tasks/{task_id}/actions/abort": {"post": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "Abort a task.", "produces": ["application/json"], "operationId": "abort_project_task", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "required": true, "type": "string"}], "responses": {"204": {"description": "Task aborted."}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/celery_tasks/{task_id}": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "Get a celery task for a project.", "produces": ["application/json"], "operationId": "get_project_celery_task", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "required": true, "type": "string"}], "responses": {"200": {"description": "Task", "schema": {"type": "object", "title": "CeleryTaskPromise", "required": ["task_id", "task_status", "result"], "properties": {"task_id": {"type": "string"}, "task_status": {"type": "string"}, "result": {"x-nullable": true}}}}, "404": {"description": "Task not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/annotator/metadata": {"post": {"tags": ["Annotate"], "security": [{"Bearer": []}], "description": "Get annotator's metadata", "produces": ["application/json", "text/html"], "operationId": "get_cached_annotator_metadata", "x-swagger-router-controller": "api_server.controllers.annotate", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "in": "body", "schema": {"x-oneOf": [{"$ref": "#/definitions/AnnotatorSupportedAnnotationsParameters"}, {"$ref": "#/definitions/ModelSupportedAnnotationsParameters"}]}, "required": true}], "responses": {"200": {"description": "OK", "schema": {"title": "AnnotatorMetadata", "type": "object", "required": ["name", "version", "url", "author", "description"], "properties": {"name": {"type": "string"}, "version": {"type": "string"}, "url": {"type": "string"}, "author": {"type": "string"}, "description": {"type": "string"}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/annotate/supported_annotations": {"post": {"tags": ["Annotate"], "security": [{"Bearer": []}], "description": "Get supported annotations for an annotator", "produces": ["application/json", "text/html"], "operationId": "get_project_annotator_supported_annotations", "x-swagger-router-controller": "api_server.controllers.annotate", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "in": "body", "schema": {"x-oneOf": [{"$ref": "#/definitions/AnnotatorSupportedAnnotationsParameters"}, {"$ref": "#/definitions/ModelSupportedAnnotationsParameters"}]}, "required": true}], "responses": {"200": {"description": "OK", "schema": {"title": "SupportedAnnotatorAnnotations", "type": "object", "required": ["entities", "relationships"], "properties": {"entities": {"type": "array", "items": {"title": "EntityAnnotationDescriptor", "type": "object", "properties": {"key": {"type": "string"}, "description": {"type": "string"}, "data_fields": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}}, "required": ["key", "description"]}}, "relationships": {"type": "array", "items": {"title": "RelationshipAnnotationDescriptor", "type": "object", "properties": {"key": {"type": "string"}, "description": {"type": "string"}, "columns": {"type": "array", "items": {"type": "object", "title": "RelationshipAnnotationColumn", "properties": {"key": {"type": "string"}, "entities": {"type": "array", "items": {"type": "string"}}}, "required": ["key", "entities"]}}}, "required": ["key", "description", "columns"]}}, "supported_object_types": {"type": "array", "items": {"type": "string"}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/object_annotations": {"post": {"tags": ["Annotate"], "security": [{"Bearer": []}], "description": "Run an annotator on an object, using resources from the project.\n*DEPRECATED*, please use generate_project_object_annotations_async instead.\n", "deprecated": true, "produces": ["application/json"], "operationId": "generate_project_object_annotations", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "AnnotateObjectOptions", "type": "object", "required": ["parameters", "input"], "properties": {"input": {"title": "AnnotatorInput", "type": "object", "minProperties": 1, "maxProperties": 1, "properties": {"text": {"type": "string", "maxLength": 4500}, "table": {"type": "array", "description": "A table, specified as an array of arrays. Each outer array represents a row, and each item in the inner array represents the column.", "items": {"type": "array", "items": {"title": "AnnotateTableCell", "type": "object", "required": ["bbox", "spans", "text", "type"], "properties": {"bbox": {"type": "array", "items": {"type": "number", "format": "double"}, "minItems": 4, "maxItems": 4}, "spans": {"type": "array", "description": "2-tuple representing the row:column where this cell spans to.", "items": {"type": "array", "items": {"type": "number", "format": "integer"}, "minItems": 2, "maxItems": 2}}, "text": {"type": "string"}, "type": {"title": "AnnotateTableCellType", "type": "string", "enum": ["col_header", "row_header", "body"]}}}}}, "image": {"title": "AnnotatorImageInput", "type": "object", "required": ["source"], "properties": {"source": {"title": "ImageSource", "type": "object", "minProperties": 1, "properties": {"scratch_id": {"type": "string"}, "proj_key": {"type": "string"}, "url": {"type": "string"}}}, "metadata": {"title": "ImageMetadata", "type": "object", "required": ["cells"], "properties": {"cells": {"title": "ImageCells", "type": "object", "required": ["data"], "properties": {"data": {"type": "array", "description": "A 6-tuple consisting of x1, y1, x2, y2, font, coordinates", "items": [{"type": "number"}, {"type": "number"}, {"type": "number"}, {"type": "number"}, {"type": "string"}, {"type": "string"}]}}}, "info": {"title": "ImageInfo", "type": "object", "required": ["width", "height"], "properties": {"width": {"type": "number"}, "height": {"type": "number"}}}}}}}}}, "parameters": {"title": "AnnotatorParameters", "type": "object", "properties": {"type": {"type": "string"}}, "additionalProperties": {}, "required": ["type"]}}}}], "responses": {"200": {"description": "OK", "schema": {"title": "AnnotatedObject", "type": "object", "minProperties": 1, "maxProperties": 1, "properties": {"text": {"title": "AnnotatedTextLines", "type": "object", "required": ["text", "entities", "relationships", "properties"], "properties": {"text": {"description": "Input text after clean up. The annotation indexes will be based on this text and not the input text.", "type": "string"}, "entities": {"type": "array", "description": "One item per line on the original text.", "items": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}}, "relationships": {"type": "array", "description": "One item per line on the original text.", "items": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}}, "properties": {"type": "array", "description": "One item per line on the original text.", "items": {"$ref": "#/definitions/ObjectPropertyMap"}}}}, "table": {"$ref": "#/definitions/AnnotatedTable"}, "image": {"$ref": "#/definitions/AnnotatedImage"}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.annotate"}}, "/project/{proj_key}/object_annotations_async": {"post": {"tags": ["Annotate"], "security": [{"Bearer": []}], "description": "Run an annotator on an object, using resources from the project.", "produces": ["application/json"], "operationId": "generate_project_object_annotations_async", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "AnnotateObjectOptions", "type": "object", "required": ["parameters", "input"], "properties": {"input": {"title": "AnnotatorInput", "type": "object", "minProperties": 1, "maxProperties": 1, "properties": {"text": {"type": "string", "maxLength": 4500}, "table": {"type": "array", "description": "A table, specified as an array of arrays. Each outer array represents a row, and each item in the inner array represents the column.", "items": {"type": "array", "items": {"title": "AnnotateTableCell", "type": "object", "required": ["bbox", "spans", "text", "type"], "properties": {"bbox": {"type": "array", "items": {"type": "number", "format": "double"}, "minItems": 4, "maxItems": 4}, "spans": {"type": "array", "description": "2-tuple representing the row:column where this cell spans to.", "items": {"type": "array", "items": {"type": "number", "format": "integer"}, "minItems": 2, "maxItems": 2}}, "text": {"type": "string"}, "type": {"title": "AnnotateTableCellType", "type": "string", "enum": ["col_header", "row_header", "body"]}}}}}, "image": {"title": "AnnotatorImageInput", "type": "object", "required": ["source"], "properties": {"source": {"title": "ImageSource", "type": "object", "minProperties": 1, "properties": {"scratch_id": {"type": "string"}, "proj_key": {"type": "string"}, "url": {"type": "string"}}}, "metadata": {"title": "ImageMetadata", "type": "object", "required": ["cells"], "properties": {"cells": {"title": "ImageCells", "type": "object", "required": ["data"], "properties": {"data": {"type": "array", "description": "A 6-tuple consisting of x1, y1, x2, y2, font, coordinates", "items": [{"type": "number"}, {"type": "number"}, {"type": "number"}, {"type": "number"}, {"type": "string"}, {"type": "string"}]}}}, "info": {"title": "ImageInfo", "type": "object", "required": ["width", "height"], "properties": {"width": {"type": "number"}, "height": {"type": "number"}}}}}}}}}, "parameters": {"title": "AnnotatorParameters", "type": "object", "properties": {"type": {"type": "string"}}, "additionalProperties": {}, "required": ["type"]}, "proj_key": {"type": "string"}, "model_config_key": {"type": "string"}, "public": {"type": "boolean"}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.annotate"}}, "/project/{proj_key}/scratch/files": {"get": {"tags": ["Uploads"], "security": [{"Bearer": []}], "description": "Get temporary files uploaded to a project", "produces": ["application/json"], "operationId": "list_project_scratch_files", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "scratch_ids", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "Files", "schema": {"type": "array", "items": {"title": "UploadedFile", "type": "object", "properties": {"id": {"type": "string", "description": "ID of the temporary file."}, "proj_key": {"type": "string"}, "user_key": {"type": "string"}, "filename": {"type": "string"}, "timestamp": {"type": "number"}}, "required": ["id", "proj_key", "user_key", "filename", "timestamp"]}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"deprecated": true, "tags": ["Uploads"], "security": [{"Bearer": []}], "description": "Upload a file to temporary storage", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_scratch_file", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "responses": {"200": {"description": "File uploaded", "schema": {"title": "UploadedFileResult", "type": "object", "required": ["id", "url"], "properties": {"id": {"type": "string", "description": "ID of the temporary file."}, "url": {"type": "string", "description": "URL to get the temporary file form."}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/scratch/files_paginated": {"get": {"tags": ["Uploads"], "security": [{"Bearer": []}], "description": "Get paginated list of temporary files uploaded to a project", "produces": ["application/json"], "operationId": "list_project_scratch_files_paginated", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "page", "in": "query", "description": "page of the result list", "required": false, "type": "integer"}, {"name": "items_per_page", "in": "query", "description": "items on one page of the result list", "required": false, "default": 20, "type": "integer"}, {"name": "search_string", "in": "query", "description": "search keyword", "required": false, "type": "string"}, {"name": "begin_date", "in": "query", "description": "begin date of the search date interval", "required": false, "type": "integer"}, {"name": "end_date", "in": "query", "description": "end date of the search date interval", "required": false, "type": "integer"}], "responses": {"200": {"description": "Files", "schema": {"type": "array", "items": {"title": "UploadedFile", "type": "object", "properties": {"id": {"type": "string", "description": "ID of the temporary file."}, "proj_key": {"type": "string"}, "user_key": {"type": "string"}, "filename": {"type": "string"}, "timestamp": {"type": "number"}}, "required": ["id", "proj_key", "user_key", "filename", "timestamp"]}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/scratch/files/upload/{filename}": {"post": {"tags": ["Uploads"], "security": [{"Bearer": []}], "description": "Create file pointers for temporary storage", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "create_project_scratch_file", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "filename", "in": "path", "required": true, "type": "string"}], "responses": {"201": {"description": "Temporary file details", "schema": {"title": "TemporaryUploadFileResult", "type": "object", "required": ["id", "upload", "download", "metadata", "upload_private", "download_private", "metadata_private"], "properties": {"id": {"type": "string", "description": "ID of the temporary file."}, "upload": {"type": "object", "description": "URL to upload the temporary file.", "properties": {"url": {"type": "string"}, "fields": {"type": "object"}}}, "upload_private": {"type": "object", "description": "URL to upload the temporary file. (private URL, usable within the infrastracture)", "properties": {"url": {"type": "string"}, "fields": {"type": "object"}}}, "download": {"type": "object", "description": "URL to get the temporary file.", "properties": {"url": {"type": "string"}}}, "download_private": {"type": "object", "description": "URL to get the temporary file. (private URL, usable within the infrastracture)", "properties": {"url": {"type": "string"}}}, "metadata": {"type": "object", "description": "URL to metadata of the temporary file using the HEAD HTTP method.", "properties": {"url": {"type": "string"}}}, "metadata_private": {"type": "object", "description": "URL to metadata of the temporary file using the HEAD HTTP method. (private URL, usable within the infrastracture)", "properties": {"url": {"type": "string"}}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/default_values": {"get": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "List project's default values", "produces": ["application/json"], "operationId": "get_project_default_values", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/ProjectDefaultValues"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}, "post": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "List project's default values", "produces": ["application/json"], "operationId": "update_project_default_values", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "default_values", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectDefaultValues"}}], "responses": {"200": {"description": "OK"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/integrations/{integration_name}": {"get": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "Get the config for a given project integration", "produces": ["application/json"], "operationId": "get_project_integration_config", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "integration_name", "in": "path", "type": "string", "required": true}, {"name": "decode_secrets", "in": "query", "type": "boolean", "description": "Project owners can retrieve decoded secrets", "default": false}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/ProjectIntegrations"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}, "post": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "Update the config for a given project integration", "produces": ["application/json"], "operationId": "update_project_integration_config", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "integration_name", "in": "path", "type": "string", "required": true}, {"name": "config", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectIntegrations"}}], "responses": {"200": {"description": "OK"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}, "delete": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "Delete the config for a given project integration", "produces": ["application/json"], "operationId": "delete_project_integration_config", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "integration_name", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "OK"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/annotate/document": {"post": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Run an annotator on a document", "produces": ["application/json"], "operationId": "annotate_document", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "x-body-name": "body", "in": "body", "required": true, "schema": {"title": "AnnotateDocumentRequest", "type": "object", "required": ["document", "text_annotators", "image_annotators", "table_annotators"], "properties": {"document": {"type": "object"}, "text_annotators": {"type": "array", "items": {"$ref": "#/definitions/AnnotatorParametersOrRef"}}, "image_annotators": {"type": "array", "items": {"$ref": "#/definitions/AnnotatorParametersOrRef"}}, "table_annotators": {"type": "array", "items": {"$ref": "#/definitions/AnnotatorParametersOrRef"}}, "use_cache": {"type": "boolean", "default": true}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/annotate/document/report": {"post": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Submit a report on an inspected document", "produces": ["application/json"], "operationId": "report_inspected_document", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "x-body-name": "body", "in": "body", "required": true, "schema": {"title": "AnnotatedDocumentReport", "type": "object", "required": ["document", "report"], "properties": {"document": {"type": "object", "properties": {"input_scratch_id": {"type": "string"}, "output_scratch_id": {"type": "string"}}, "required": ["input_scratch_id", "output_scratch_id"]}, "document_conversion_parameters": {"type": "object"}, "document_annotation_parameters": {"type": "object"}, "report": {"type": "object", "properties": {"description": {"type": "string"}, "review_consent": {"type": "boolean"}}, "required": ["review_consent"]}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/annotate/document/results/{document_hash}": {"delete": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Delete annotation results for a document", "produces": ["application/json"], "operationId": "delete_document_annotation_result", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "document_hash", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "OK"}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/annotate/document/tasks/{task_id}": {"get": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Get the result of a previous document annotation", "produces": ["application/json"], "operationId": "get_annotate_document_result", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "required": true, "type": "string"}, {"name": "wait", "in": "query", "required": false, "type": "number", "minimum": 0, "maximum": 10, "description": "Allow the response to be delayed for a few seconds to wait for the result, instead of doing client-side polling."}], "responses": {"200": {"description": "OK", "schema": {"type": "object", "required": ["task_id", "task_status", "result", "done"], "properties": {"task_id": {"type": "string"}, "task_status": {"type": "string"}, "result": {"type": "object", "x-nullable": true}, "done": {"type": "boolean"}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/annotate/inspection_report": {"get": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Get paginated list of inspection reports for a project", "produces": ["application/json"], "operationId": "list_project_inspection_report", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "page", "in": "query", "description": "page of the result list", "required": false, "type": "integer"}, {"name": "items_per_page", "in": "query", "description": "items on one page of the result list", "required": false, "default": 20, "type": "integer"}, {"name": "search_string", "in": "query", "description": "search keyword", "required": false, "type": "string"}, {"name": "begin_date", "in": "query", "description": "begin date of the search date interval", "required": false, "type": "integer"}, {"name": "end_date", "in": "query", "description": "end date of the search date interval", "required": false, "type": "integer"}], "responses": {"200": {"description": "Reports", "schema": {"type": "array", "items": {"title": "InspectionReport", "type": "object", "properties": {"id": {"type": "string", "description": "ID of the inpection report."}, "proj_key": {"type": "string"}, "user_key": {"type": "string"}, "timestamp": {"type": "number"}, "document": {"type": "string"}}, "required": ["id", "proj_key", "user_key", "timestamp", "document"]}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/ingest/documentqa": {"post": {"deprecated": true, "tags": ["Document Inspection", "Semantic"], "security": [{"Bearer": []}], "description": "Ingest a document for QA", "produces": ["application/json"], "operationId": "ingest_documentqa", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "x-body-name": "body", "in": "body", "required": true, "schema": {"title": "IngestDocumentQARequest", "type": "object", "properties": {"source": {"title": "Source", "x-anyOf": [{"title": "IngestDocumentQASourceUrl", "type": "object", "properties": {"type": {"title": "Type", "enum": ["url"], "type": "string"}, "url": {"title": "Url", "type": "string"}}, "required": ["type", "url"]}, {"title": "IngestDocumentQASourcePublicData", "type": "object", "properties": {"type": {"title": "Type", "enum": ["public_data"], "type": "string"}, "elastic_id": {"title": "Elastic Id", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}, "document_hash": {"title": "Document Hash", "type": "string"}}, "required": ["type", "elastic_id", "index_key", "document_hash"]}, {"title": "IngestDocumentQASourcePrivateData", "type": "object", "properties": {"type": {"title": "Type", "enum": ["private_data"], "type": "string"}, "proj_key": {"title": "Proj Key", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}, "document_hash": {"title": "Document Hash", "type": "string"}}, "required": ["type", "proj_key", "index_key", "document_hash"]}]}}, "required": ["source"]}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/semantic/ingest": {"post": {"tags": ["Semantic"], "security": [{"Bearer": []}], "description": "Ingest documents and collections for RAG", "produces": ["application/json"], "operationId": "ingest", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "x-body-name": "body", "in": "body", "required": true, "schema": {"title": "SemanticIngestRequest", "type": "object", "properties": {"source": {"title": "Source", "x-anyOf": [{"title": "IngestDocumentQASourceUrl", "type": "object", "properties": {"type": {"title": "Type", "enum": ["url"], "type": "string"}, "url": {"title": "Url", "type": "string"}}, "required": ["type", "url"]}, {"title": "SemanticIngestSourcePublicDataDocument", "type": "object", "properties": {"type": {"title": "Type", "enum": ["public_data_document"], "type": "string"}, "elastic_id": {"title": "Elastic Id", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}, "document_hash": {"title": "Document Hash", "type": "string"}}, "required": ["type", "elastic_id", "index_key", "document_hash"]}, {"title": "SemanticIngestSourcePrivateDataDocument", "type": "object", "properties": {"type": {"title": "Type", "enum": ["private_data_document"], "type": "string"}, "proj_key": {"title": "Proj Key", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}, "document_hash": {"title": "Document Hash", "type": "string"}}, "required": ["type", "proj_key", "index_key", "document_hash"]}, {"title": "SemanticIngestSourcePrivateDataCollection", "type": "object", "properties": {"type": {"title": "Type", "enum": ["private_data_collection"], "type": "string"}, "proj_key": {"title": "Proj Key", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}}, "required": ["type", "proj_key", "index_key"]}]}, "parameters": {"title": "SemanticIngestReqParams", "type": "object", "properties": {"skip_ingested_docs": {"title": "Skip Ingested Docs", "type": "boolean"}}, "required": ["skip_ingested_docs"]}}, "required": ["source", "parameters"]}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.semantic_controller"}}, "/project/{proj_key}/dictionaries/from_mongo": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Create a dictionary from a mongo database", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_dictionary_from_mongo", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DictionaryImportOptions", "type": "object", "properties": {"target": {"type": "object", "required": ["name", "description", "public"], "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}}}, "options": {"type": "object", "required": ["coordinates"], "properties": {"coordinates": {"$ref": "#/definitions/MongoS3CoordinatesWithCollectionList"}}}}, "required": ["target", "options"]}}], "responses": {"200": {"description": "Dictionary created, and data is being imported.", "schema": {"title": "DictionaryImportResult", "type": "object", "properties": {"dictionary": {"$ref": "#/definitions/Dictionary"}, "import_task": {"$ref": "#/definitions/Task"}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/actions/clone": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Clone an existing dictionary", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "clone_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "CloneDictionaryOptions", "type": "object", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$", "x-nullable": true}, "description": {"type": "string", "x-nullable": true}, "copy_s3": {"type": "boolean", "description": "Should the dictionary's S3 data also be copied?", "default": true}, "collections": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "description", "public"]}}], "responses": {"200": {"description": "Dictionary cloned, and data is being copied.", "schema": {"$ref": "#/definitions/DictionaryCloneResult"}}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "List dictionaries for a project", "produces": ["application/json"], "operationId": "list_project_dictionaries", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "query", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "List of dictionaries", "schema": {"type": "array", "items": {"$ref": "#/definitions/Dictionary"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Create an empty dictionary", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "create_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "CreateDictionaryOptions", "type": "object", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}}, "required": ["name", "description", "public"]}}], "responses": {"200": {"description": "Dictionary created.", "schema": {"$ref": "#/definitions/Dictionary"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/public/dictionaries/{dict_key}": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get a single dictionary that was made public", "produces": ["application/json"], "operationId": "get_public_dictionary", "parameters": [{"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "responses": {"200": {"description": "Dictionary", "schema": {"$ref": "#/definitions/Dictionary"}}, "404": {"description": "Dictionary not found or is not public", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/public/dictionaries/{dict_key}/collections": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get the collections of a dictionary.", "produces": ["application/json"], "operationId": "list_public_dictionary_collections", "parameters": [{"name": "dict_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Dictionary collections", "schema": {"type": "array", "items": {"$ref": "#/definitions/DictionaryCollection"}}}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/upload": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Upload data to a dictionary collection. The collection will be created if it doesn't exist.", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_dictionary_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "responses": {"200": {"description": "Data is being processed.", "schema": {"$ref": "#/definitions/Task"}}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/export": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Export the contents of a dictionary's collection", "produces": ["application/zip", "application/json"], "operationId": "export_project_dictionary_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "file_format", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "Dictionary collection contents.", "schema": {"type": "file"}}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/actions/upload": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Upload data to a dictionary. The collection name(s) will be inferred from the file name(s).", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_dictionary_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "responses": {"200": {"description": "Data is being processed.", "schema": {"$ref": "#/definitions/Task"}}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/actions/export": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Export the contents of a dictionary.", "produces": ["application/zip"], "operationId": "export_project_dictionary_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Dictionary contents.", "schema": {"type": "file"}}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/delete_token": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a dictionary.", "produces": ["application/json"], "operationId": "create_project_dictionary_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Dictionary deletion token.", "schema": {"$ref": "#/definitions/TokenResponse"}}, "404": {"description": "Data flow template not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/public/dictionaries": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "List public dictionaries", "produces": ["application/json"], "operationId": "list_public_dictionaries", "parameters": [{"name": "query", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "List of public dictionaries", "schema": {"type": "array", "items": {"$ref": "#/definitions/Dictionary"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/public/dictionaries/{dict_key}/actions/clone": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Clone an existing public dictionary", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "clone_public_dictionary", "parameters": [{"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "ClonePublicDictionaryOptions", "type": "object", "properties": {"proj_key": {"description": "The project key of the project to store the resulting dictionary", "type": "string"}, "public": {"type": "boolean"}, "name": {"type": "string", "x-nullable": true}, "description": {"type": "string", "x-nullable": true}, "collections": {"type": "array", "items": {"type": "string"}}, "copy_s3": {"type": "boolean", "description": "Should the dictionary's S3 data also be copied?", "default": true}}, "required": ["name", "description", "public", "proj_key"]}}], "responses": {"200": {"description": "Dictionary cloned, and data is being copied.", "schema": {"$ref": "#/definitions/DictionaryCloneResult"}}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get a single dictionary", "produces": ["application/json"], "operationId": "get_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "responses": {"200": {"description": "Dictionary", "schema": {"$ref": "#/definitions/Dictionary"}}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "delete": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Delete a single dictionary", "produces": ["application/json"], "operationId": "delete_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "required": true, "type": "string"}, {"name": "confirmation_token", "in": "query", "type": "string", "required": true}], "responses": {"204": {"description": "Dictionary deleted."}, "404": {"description": "Dictionary doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "patch": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Update the metadata of a dictionary", "produces": ["application/json"], "operationId": "update_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"type": "object", "title": "PatchDictionaryOptions", "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}}, "additionalProperties": false}}], "responses": {"200": {"description": "Dictionary updated.", "schema": {"$ref": "#/definitions/Dictionary"}}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get the collections of a dictionary.", "produces": ["application/json"], "operationId": "list_project_dictionary_collections", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Dictionary collections", "schema": {"type": "array", "items": {"$ref": "#/definitions/DictionaryCollection"}}}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Create a collection in a dictionary", "produces": ["application/json"], "operationId": "create_project_dictionary_collection", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "CreateCollectionInDictionaryOptions", "type": "object", "properties": {"collection_name": {"type": "string", "pattern": "^(?:\\w|-)(?:\\w|\\s|-)*(?:\\w|-)$", "maxLength": 50, "minLength": 4}}, "required": ["collection_name"]}}], "responses": {"200": {"description": "Collection created."}, "404": {"description": "Dictionary doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}": {"delete": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Delete a single dictionary's collection", "produces": ["application/json"], "operationId": "delete_project_dictionary_collection", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "required": true, "type": "string"}, {"name": "collection_name", "in": "path", "type": "string", "required": true}], "responses": {"204": {"description": "Collection deleted."}, "404": {"description": "Collection doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/data": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get a preview of the data in a dictionary", "produces": ["application/json"], "operationId": "get_project_dictionary_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "after", "in": "query", "type": "string", "pattern": "[a-zA-Z0-9]{24}", "required": false}, {"name": "limit", "in": "query", "type": "integer", "minimum": 0, "default": 1000, "required": false}, {"name": "response_format", "in": "query", "type": "string", "default": "object", "required": false}], "responses": {"200": {"description": "Dictionary collection contents.", "schema": {"x-oneOf": [{"$ref": "#/definitions/DictionaryCollectionObjectData"}, {"$ref": "#/definitions/DictionaryCollectionCsvData"}]}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "patch": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Update the data in a dictionary's collection", "produces": ["application/json"], "operationId": "update_project_dictionary_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "description": "A subset of JSON Patch operation list. Only `add`, `replace`, and `remove` is supported.\nSee http://jsonpatch.com/ for more details.\n", "schema": {"type": "array", "items": {"$ref": "#/definitions/DictionaryCollectionPatch"}}}], "responses": {"204": {"description": "Data updated."}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/model_configs": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "List Model Configurations for a project", "produces": ["application/json"], "operationId": "list_project_model_configs", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "List of Model Configurations", "schema": {"type": "array", "items": {"$ref": "#/definitions/ModelConfiguration"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}, "post": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Create a Model Configuration", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "create_project_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "CreateProjectModelConfigOptions", "type": "object", "additionalProperties": false, "properties": {"public": {"type": "boolean"}, "name": {"pattern": "^(?:\\w| |-)+$", "type": "string"}, "description": {"type": "string", "x-nullable": true}, "configurations": {"type": "object", "properties": {"type": {"type": "string"}}, "required": ["type"]}, "model_config_key": {"type": "string"}}, "required": ["name", "description", "public", "configurations"]}}], "responses": {"200": {"description": "Model Configuration created.", "schema": {"$ref": "#/definitions/ModelConfiguration"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/model_configs/{model_config_key}": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Get a single Model Configuration", "produces": ["application/json"], "operationId": "read_project_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "model_config_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "responses": {"200": {"description": "Model Configuration", "schema": {"$ref": "#/definitions/ModelConfiguration"}}, "404": {"description": "Model Configuration not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}, "patch": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Update a single Model Configuration", "produces": ["application/json"], "operationId": "update_project_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "model_config_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "UpdateProjectModelConfigOptions", "type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}, "configurations": {"type": "object", "properties": {"type": {"type": "string"}}, "required": ["type"]}}, "required": ["name", "description", "public", "configurations"]}}], "responses": {"204": {"description": "Model Configuration updated."}, "404": {"description": "Model Configuration doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}, "delete": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Delete a single Model Configuration", "produces": ["application/json"], "operationId": "delete_project_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "model_config_key", "in": "path", "required": true, "type": "string"}], "responses": {"204": {"description": "Model Configuration deleted."}, "404": {"description": "Model Configuration doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/public/model_configs": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "List public Model Configurations", "produces": ["application/json"], "operationId": "list_public_model_configs", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [], "responses": {"200": {"description": "List of public Model Configurations", "schema": {"type": "array", "items": {"$ref": "#/definitions/ModelConfiguration"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/public/model_configs/{model_config_key}": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Get a single Model Configuration that was made public", "produces": ["application/json"], "operationId": "read_public_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "model_config_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "responses": {"200": {"description": "Model configuration", "schema": {"$ref": "#/definitions/ModelConfiguration"}}, "404": {"description": "Model configuration not found or is not public", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/models": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "List models with the supported annotations for a project", "produces": ["application/json"], "operationId": "get_project_models_with_supported_annotations", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "List of Models with the supported annotations", "schema": {"type": "array", "items": {"$ref": "#/definitions/ModelConfiguration"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/processing_models/docs_graph_with_databases": {"post": {"tags": ["Processing Model"], "security": [{"Bearer": []}], "consumes": ["application/json"], "produces": ["application/json"], "description": "Create a Data Flow from a list of CCS Collections and CPS Models.", "operationId": "create_data_flow_from_df_wizard", "parameters": [{"name": "body", "in": "body", "required": true, "schema": {"type": "object", "required": ["ccs_document_collections", "catalog_document_collections", "models", "access_token"], "properties": {"access_token": {"type": "string"}, "ccs_document_collections": {"type": "array", "items": {"$ref": "#/definitions/CcsCollectionReference"}}, "models": {"type": "array", "items": {"$ref": "#/definitions/CpsModelReference"}}, "entity_mappings": {"$ref": "#/definitions/EntityMapping"}, "catalog_document_collections": {"type": "array", "items": {"$ref": "#/definitions/CatalogReference"}}, "data_catalogs": {"type": "array", "items": {"$ref": "#/definitions/CatalogReference"}}}}}], "responses": {"200": {"description": "Processing model generated successfully", "schema": {"$ref": "#/definitions/ProcessingModel"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.processing_model_controller"}}, "/processing_models": {"get": {"tags": ["Processing Model"], "security": [{"Bearer": []}], "produces": ["application/json"], "description": "List the available processing models.", "operationId": "get_processing_models", "x-swagger-router-controller": "api_server.controllers.processing_model_controller", "responses": {"200": {"description": "List of processing models and their description", "schema": {"type": "object", "required": ["processing_models"], "properties": {"processing_models": {"type": "array", "items": {"$ref": "#/definitions/ProcessingModelDescription"}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}}, "definitions": {"TokenResponse": {"type": "object", "properties": {"token": {"type": "string"}}, "required": ["token"]}, "ProjectDataIndexWithStatus": {"title": "ProjectDataIndexWithStatus", "description": "Project data index with elastic status", "type": "object", "properties": {"source": {"title": "ProjectDataIndexSource", "type": "object", "properties": {"proj_key": {"type": "string"}, "index_key": {"type": "string"}}, "required": ["proj_key", "index_key"]}, "name": {"type": "string"}, "description": {"type": "string"}, "schema_key": {"type": "string", "description": "Index's schema key", "enum": ["deepsearch-doc", "deepsearch-db", "generic"]}, "type": {"type": "string", "description": "Index type, user friendly format", "enum": ["View", "Document", "DB Record", "Generic", "Experiment"]}, "view_of": {"type": "object", "properties": {"index_key": {"type": "string"}, "elastic_id": {"type": "string"}, "proj_key": {"type": "string"}, "query_options": {"$ref": "#/definitions/ElasticIndexSearchQueryOptions"}}, "required": ["index_key", "query_options"]}, "documents": {"type": "number"}, "health": {"type": "string"}, "status": {"type": "string"}, "creation_date": {"type": "string"}, "record_properties": {"$ref": "#/definitions/ElasticIndexProperties"}, "provenance": {"type": "string"}}, "required": ["source", "name", "description", "type", "documents", "health", "status", "creation_date"]}, "ProjectDataIndexNonView": {"title": "ProjectDataIndexNonView", "description": "Object to create a project data index", "type": "object", "properties": {"name": {"type": "string", "description": "Name of the data index", "minLength": 1, "maxLength": 64}, "description": {"type": "string", "description": "Description of the Index", "minLength": 1, "maxLength": 254}, "schema_key": {"type": "string", "description": "Schema key", "minLength": 1, "maxLength": 64, "default": "generic", "enum": ["deepsearch-doc", "deepsearch-db", "generic"]}}, "required": ["name"]}, "ProjectDataIndexView": {"title": "ProjectDataIndexView", "description": "Object to create a project data index view", "type": "object", "properties": {"name": {"type": "string", "description": "Name of the data index view", "minLength": 1, "maxLength": 64}, "description": {"type": "string", "description": "Description of the index view", "minLength": 1, "maxLength": 254}, "view_of": {"type": "object", "title": "ProjectDataIndexViewOf", "properties": {"instance_id": {"type": "string", "description": "Instance id key, if the source is a data asset", "minLength": 1, "maxLength": 64}, "proj_key": {"type": "string", "description": "Project id key, if the source is a project data index", "minLength": 1, "maxLength": 64}, "index_key": {"type": "string", "description": "Data index key", "minLength": 1, "maxLength": 64}, "query_options": {"$ref": "#/definitions/ElasticIndexSearchQueryOptions"}}, "required": ["index_key", "query_options"]}}, "required": ["name", "view_of"]}, "ProjectDataIndexConversionSettings": {"title": "ProjectDataIndexConversionSettings", "description": "Specify the conversion settings to use.", "type": "object", "properties": {"type": {"title": "Type", "type": "string", "default": "direct", "enum": ["direct"]}, "ocr": {"type": "object", "title": "OCR Settings", "properties": {"enabled": {"title": "Enabled", "type": "boolean", "default": false}, "backend": {"title": "Backend", "type": "string"}, "backend_settings": {"title": "Backend Settings", "type": "object"}, "merge_mode": {"title": "Merge Mode", "type": "string"}}}, "assemble": {"title": "Assemble Settings", "type": "object", "required": ["mode", "include_incomplete_documents"], "properties": {"mode": {"type": "object", "required": ["page_elements", "tables"], "properties": {"page_elements": {"title": "Page Elements", "type": "array", "items": {"type": "string", "enum": ["H", "M", "None"]}}, "tables": {"title": "Tables", "type": "array", "items": {"type": "string", "enum": ["H", "M", "None"]}}}}, "include_incomplete_documents": {"title": "Include Incomplete Documents", "type": "boolean"}}}, "metadata": {"title": "Collection Metadata Settings", "type": "object", "properties": {"description": {"title": "Description", "type": "string"}, "display_name": {"title": "Display Name", "type": "string"}, "licence": {"title": "Licence", "type": "string"}, "source": {"title": "Source", "type": "string"}, "version": {"title": "Version", "type": "string"}}}, "page_labels": {"title": "Page Labels", "type": "object"}, "model_pipeline": {"title": "Model Pipeline Settings", "type": "object", "required": ["clusters", "page", "tables", "normalization"], "properties": {"clusters": {"title": "Clusters", "x-oneOf": [{"$ref": "#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/0"}, {"$ref": "#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/1"}]}, "page": {"title": "Page", "x-oneOf": [{"type": "object", "description": "Reference to a model configuration", "required": ["model_config_key", "proj_key"], "properties": {"model_config_key": {"title": "Model Config Key", "type": "string"}, "proj_key": {"title": "Proj Key", "type": "string"}, "name": {"title": "Name", "type": "string"}, "description": {"title": "Description", "type": "string"}}}, {"type": "object", "description": "Direct configuration of a model", "required": ["type", "config"], "properties": {"type": {"title": "Type", "type": "string"}, "config": {"title": "Config", "type": "string"}}}]}, "tables": {"title": "Tables", "x-oneOf": [{"$ref": "#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/0"}, {"$ref": "#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/1"}]}, "normalization": {"title": "Normalization", "x-oneOf": [{"$ref": "#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/0"}, {"$ref": "#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/1"}]}}}}}, "ProjectDataIndexS3Coordinates": {"title": "ProjectDataIndexCOSCoordinates", "description": "Coordinates to COS", "type": "object", "properties": {"host": {"title": "host", "type": "string"}, "port": {"title": "port", "type": "number"}, "ssl": {"title": "ssl", "type": "boolean"}, "verify_ssl": {"title": "verify_ssl", "type": "boolean"}, "access_key": {"title": "access_key", "type": "string"}, "secret_key": {"title": "secret_key", "type": "string"}, "bucket": {"title": "bucket", "type": "string"}, "location": {"title": "location", "type": "string"}, "key_prefix": {"title": "key_prefix", "type": "string"}}, "required": ["host", "port", "ssl", "verify_ssl", "access_key", "secret_key", "bucket", "location"]}, "error_response": {"type": "object", "properties": {"error_message": {"type": "string"}, "error_code": {"type": "string", "x-nullable": true}}, "required": ["error_message"]}, "Problem": {"type": "object", "properties": {"type": {"type": "string"}, "title": {"type": "string"}, "detail": {"type": "string"}, "status": {"type": "integer"}}, "additionalProperties": {}, "example": {"type": "ExampleError", "title": "An example title", "detail": "A descriptive message.", "status": 500, "may_have_extra_fields": true}}, "Bag": {"type": "object", "required": ["proj_key", "bag_key", "name", "slug", "timestamp", "bag_domain", "flavour", "bag_url", "public", "_svc_endpoint", "token"], "properties": {"proj_key": {"type": "string"}, "bag_key": {"type": "string"}, "name": {"type": "string"}, "slug": {"type": "string"}, "timestamp": {"type": "number", "format": "double"}, "bag_domain": {"type": "string"}, "flavour": {"type": "string"}, "bag_url": {"type": "string"}, "public": {"type": "boolean"}, "_svc_endpoint": {"type": "string"}, "token": {"type": "string"}}}, "BagFlavour": {"type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "description": {"type": "string"}}}, "BagFlavourDefaultQuota": {"title": "BagFlavourDefaultQuota", "type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "default_quota": {"type": "number"}}, "required": ["name", "display_name"]}, "BagFlavourFullData": {"type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "description": {"type": "string"}, "is_from_deployment": {"type": "boolean"}, "project_specific": {"type": "boolean"}, "default_quota": {"type": "integer"}, "order": {"type": "number"}, "backend": {"type": "string"}, "config": {"type": "object"}}, "required": ["display_name", "description", "project_specific", "backend", "config"]}, "ProjectsFlavours": {"type": "object", "properties": {"proj_key": {"type": "string"}, "name": {"type": "string"}, "flavours": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}}, "required": ["name"]}}}, "required": ["proj_key", "name", "flavours"]}, "ProjectsFlavoursQuota": {"title": "ProjectsFlavoursQuota", "type": "object", "properties": {"proj_key": {"type": "string"}, "name": {"type": "string"}, "quotas": {"type": "array", "items": {"$ref": "#/definitions/FlavoursQuota"}}}, "required": ["proj_key", "name", "quotas"]}, "FlavoursQuota": {"title": "FlavoursQuota", "type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "quota": {"type": "integer"}}, "required": ["name", "display_name"]}, "SystemInfo": {"type": "object", "properties": {"allow_non_admins_to_make_resources_public": {"type": "boolean"}, "deployment": {"type": "object", "properties": {"name": {"type": "string"}, "disclaimer": {"type": "string"}, "should_show_warning": {"type": "boolean"}, "disable_kg_actions": {"type": "boolean"}, "linked_ccs_api": {"type": "object", "properties": {"uri": {"type": "string"}, "project_sync": {"type": "boolean"}}}}}, "toolkit": {"type": "object", "properties": {"name": {"type": "string"}, "host": {"type": "string"}, "verify_ssl": {"type": "boolean"}, "cli_command": {"type": "string"}, "required_version": {"type": "string", "x-nullable": true}}}, "api": {"type": "object", "properties": {"version": {"type": "string"}, "commit_hash": {"type": "string"}, "build_date": {"type": "integer"}}}}}, "SystemModulesConfiguration": {"type": "object", "required": ["df_template_variables", "linked_ccs_instances", "linked_elastic_instances"], "properties": {"df_template_variables": {"type": "array", "items": {"type": "object", "title": "WellKnownDfTemplateVariable", "required": ["description", "id", "type"], "properties": {"description": {"type": "string"}, "id": {"type": "string"}, "type": {"$ref": "#/definitions/DataFlowTemplateVariable"}}}}, "linked_ccs_instances": {"type": "array", "items": {"type": "object", "title": "LinkedCcsInstances", "required": ["description", "id"], "properties": {"description": {"type": "string"}, "id": {"type": "string"}}}}, "linked_elastic_instances": {"type": "array", "items": {"type": "object", "title": "LinkedElasticInstances", "required": ["description", "id"], "properties": {"description": {"type": "string"}, "id": {"type": "string"}}}}}}, "SystemModulesTasks": {"type": "object", "properties": {"tasks": {"type": "object", "additionalProperties": {"type": "object", "properties": {"schema": {"type": "object"}}}}}}, "BagCallback": {"type": "object", "properties": {"callback_url": {"type": "string"}}}, "KgcDataInput": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object", "additionalProperties": {}, "properties": {"config": {"type": "object", "additionalProperties": {}, "properties": {"coordinates": {"type": "object", "additionalProperties": {}, "properties": {"source": {"type": "object", "additionalProperties": {}, "properties": {"type": {"type": "string", "default": "bag", "enum": ["raw", "bag", "catalogue"]}, "bag_key": {"type": "string"}, "dc_key": {"type": "string"}, "proj_key": {"type": "string"}, "collection": {"type": "string"}, "public": {"type": "boolean"}}}, "target": {"type": "object", "additionalProperties": {}, "properties": {"type": {"type": "string", "default": "bag", "enum": ["raw", "bag", "catalogue"]}, "bag_key": {"type": "string"}, "dc_key": {"type": "string"}, "proj_key": {"type": "string"}, "collection": {"type": "string"}, "public": {"type": "boolean"}}}}}}, "required": ["coordinates"]}}, "required": ["config"]}}}, "required": ["config", "data-flow"]}, "LoadKgcDataInput": {"type": "object", "properties": {"dataflow": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object"}}}}, "target": {"type": "object", "properties": {"bag_key": {"type": "string"}, "save": {"type": "object"}}, "required": ["bag_key", "save"]}}, "required": ["dataflow", "target"]}, "Task": {"type": "object", "properties": {"task_id": {"type": "string"}, "task_type": {"type": "string"}, "task_status": {"type": "string"}, "proj_key": {"type": "string"}, "error_reason": {"type": "string", "x-nullable": true}, "kind": {"type": "string", "enum": ["project_task", "celery_task"]}, "related_tasks": {"type": "array", "items": {"title": "RelatedTask", "type": "object", "required": ["task_id", "task_type"], "properties": {"task_id": {"type": "string"}, "task_type": {"type": "string"}}}}}, "required": ["task_id", "task_type", "task_status", "proj_key", "error_reason", "kind"]}, "CcsTask": {"title": "CcsTask", "type": "object", "properties": {"task_id": {"type": "string"}, "ccs_project_key": {"type": "string"}, "ccs_collection_name": {"type": "string"}}, "required": ["task_id", "ccs_project_key", "ccs_collection_name"]}, "CpsTask": {"title": "CpsTask", "type": "object", "properties": {"task_id": {"type": "string"}, "task_status": {"type": "string"}, "task_type": {"type": "string"}}, "required": ["task_id", "task_status", "task_type"]}, "StorageSummaryTask": {"type": "object", "properties": {"task_id": {"type": "string"}, "proj_key": {"type": "string"}, "kg_key": {"type": "string"}, "dc_key": {"type": "string"}, "kind": {"type": "string", "enum": ["project_task", "celery_task"]}}, "required": ["task_id", "proj_key", "kind"]}, "StorageSummaryKG": {"type": "object", "properties": {"bag_key": {"type": "string"}, "name": {"type": "string"}, "size_bytes_db": {"type": "number"}, "size_converted_db": {"type": "string"}, "size_bytes_s3": {"type": "number"}, "size_converted_s3": {"type": "string"}, "categories_fraction": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "percentage": {"type": "number"}, "size_bytes_db": {"type": "number"}, "size_converted_db": {"type": "string"}, "color": {"type": "string"}}, "required": ["name", "percentage", "size_bytes_db", "size_converted_db"]}}}, "required": ["bag_key", "name", "size_bytes_db", "size_converted_db", "size_bytes_s3", "size_converted_s3", "categories_fraction"]}, "StorageSummaryDC": {"type": "object", "properties": {"dc_key": {"type": "string"}, "name": {"type": "string"}, "size_bytes_db": {"type": "number"}, "size_converted_db": {"type": "string"}, "size_bytes_s3": {"type": "number"}, "size_converted_s3": {"type": "string"}}, "required": ["dc_key", "name", "size_bytes_db", "size_converted_db", "size_bytes_s3", "size_converted_s3"]}, "DataCatalogue": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}, "dc_key": {"type": "string"}, "proj_key": {"type": "string"}, "created_by": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "copy_of": {"type": "string", "x-nullable": true}, "public": {"type": "boolean"}, "collections": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogCollection"}}, "topology": {"$ref": "#/definitions/DataCatalogTopology"}, "category_schemas": {"type": "array", "items": {"type": "object", "title": "DataCatalogCategorySchema", "required": ["key", "schema"], "properties": {"key": {"type": "string"}, "schema": {"type": "object", "additionalProperties": {}}}}}, "collections_data_flows": {"type": "array", "items": {"type": "object", "title": "DataCatalogDataFlow", "required": ["key", "data_flows"], "properties": {"key": {"type": "string"}, "data_flows": {"type": "array", "items": {"type": "object"}}}}}, "provenance_logs": {"type": "array", "items": {"type": "object", "title": "DataCatalogProvenanceLog", "required": ["user", "timestamp", "collection_name", "source"], "properties": {"user": {"type": "object", "title": "DataCatalogProvenanceLogUser", "properties": {"user_key": {"type": "string"}, "name": {"type": "string"}, "email": {"type": "string"}}, "required": ["user_key", "name", "email"]}, "timestamp": {"type": "number"}, "collection_name": {"type": "string", "x-nullable": true}, "source": {"type": "object", "title": "DataCatalogProvenanceLogSource", "x-nullable": true, "properties": {"elastic": {}, "mongo_s3": {}, "file": {}, "url": {}, "clone": {}, "ccs": {}}}}}}}, "required": ["name", "description", "dc_key", "proj_key", "created_by", "created_at", "copy_of", "public", "topology", "category_schemas", "collections_data_flows", "provenance_logs"]}, "DataCatalogSchema": {"type": "object", "properties": {"name": {"type": "string"}, "schema": {"type": "string"}}}, "DataCatalogCollection": {"type": "object", "required": ["name", "item_count"], "properties": {"name": {"type": "string"}, "item_count": {"type": "integer"}}}, "CloneDataCatalogResult": {"type": "object", "properties": {"data_catalogue": {"$ref": "#/definitions/DataCatalogue"}, "clone_task": {"$ref": "#/definitions/Task"}}, "required": ["data_catalogue", "clone_task"]}, "ProjectTask": {"type": "object", "properties": {"proj_key": {"type": "string"}, "user_key": {"type": "string"}, "task_type": {"type": "string"}, "task_id": {"type": "string"}, "task_status": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "started_at": {"type": "number", "format": "double", "x-nullable": true}, "completed_at": {"type": "number", "format": "double", "x-nullable": true}, "progress": {"type": "number", "format": "double"}, "meta": {"type": "object"}}}, "BagComponentStatus": {"type": "object", "properties": {"status": {"$ref": "#/definitions/BagComponentStatusEnum"}, "start_time": {"type": "number", "format": "double", "x-nullable": true}}, "required": ["status", "start_time"]}, "BagStatus": {"type": "object", "properties": {"status": {"$ref": "#/definitions/BagComponentStatusEnum"}, "components": {"type": "object", "properties": {"kg": {"description": "Status of the Knowledge Graph and its API", "allOf": [{"$ref": "#/definitions/BagComponentStatus"}]}, "erlenmeyer_api": {"description": "Status of the Erlenmeyer API for this Graph", "allOf": [{"$ref": "#/definitions/BagComponentStatus"}]}, "erlenmeyer_ui": {"description": "Status of the Erlenmeyer UI for this Graph", "allOf": [{"$ref": "#/definitions/BagComponentStatus"}]}}, "required": ["kg", "erlenmeyer_api", "erlenmeyer_ui"]}}, "required": ["status", "components"]}, "BagComponentStatusEnum": {"type": "string", "enum": ["LAUNCHING", "READY", "BUSY", "SUSPENDED", "SUSPENDING", "ERROR", "PROVISIONING", "PROVISIONING_FAILED", "UNKNOWN", "CHECKING", "PENDING_RESOURCES", "IDLE"]}, "DataFlowTemplate": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object"}}}, "required": ["config", "data-flow"]}, "DataFlowTemplateListItem": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string"}, "proj_key": {"type": "string"}, "df_tpl_key": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "updated_at": {"type": "number", "format": "double"}, "public": {"type": "boolean"}}}, "DataFlow": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string"}, "variables": {"type": "object", "additionalProperties": {"type": "object"}}, "template": {"type": "object"}, "proj_key": {"type": "string"}, "df_tpl_key": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "updated_at": {"type": "number", "format": "double"}, "public": {"type": "boolean"}}}, "DataFlowTemplateVariable": {"type": "string", "enum": ["string", "boolean", "number", "integer", "DataCatalogId", "DictionaryId", "KnowledgeGraphId", "ModelConfigurationId", "file", "SecretString", "ElasticId", "DataCatalogCollection", "DictionaryCollection", "KnowledgeGraphCollection", "CcsCollection", "DocumentSources"]}, "TakeSnapshotSettings": {"type": "object", "properties": {"flavour": {"type": "string"}, "name": {"type": "string"}, "load_into_kg_after_created": {"type": "boolean", "default": false}}, "required": ["flavour"]}, "KgSnapshot": {"type": "object", "properties": {"timestamp": {"type": "number", "format": "double"}, "data_flow": {"type": "object", "x-nullable": true}, "project_task_id": {"type": "string"}, "task_type": {"type": "string"}, "name": {"type": "string"}, "is_current": {"type": "boolean"}}}, "S3CoordinatesWithBackupKey": {"type": "object", "properties": {"host": {"type": "string"}, "port": {"type": "integer"}, "ssl": {"type": "boolean"}, "verifySSL": {"type": "boolean"}, "access-key": {"type": "string"}, "secret-key": {"type": "string"}, "bucket": {"type": "string"}, "location": {"type": "string"}, "backup_key": {"type": "string"}, "presigned": {"type": "object", "properties": {"url": {"type": "string"}, "fields": {"type": "object", "additionalProperties": {}}}, "required": ["url", "fields"]}}, "required": ["bucket", "backup_key"]}, "MongoCoordinates": {"type": "object", "properties": {"uri": {"type": "string"}, "database": {"type": "string"}}, "required": ["uri", "database"]}, "S3Coordinates": {"type": "object", "description": "If provided, the S3 data will be copied", "properties": {"host": {"type": "string"}, "port": {"type": "integer"}, "ssl": {"type": "boolean"}, "verifySSL": {"type": "boolean"}, "access-key": {"type": "string"}, "secret-key": {"type": "string"}, "bucket": {"type": "string"}, "location": {"type": "string"}, "key_prefix": {"type": "string"}}, "required": ["host", "port", "ssl", "verifySSL", "access-key", "secret-key", "bucket", "location", "key_prefix"]}, "MongoS3Coordinates": {"type": "object", "properties": {"mongo": {"$ref": "#/definitions/MongoCoordinates"}, "s3": {"$ref": "#/definitions/S3Coordinates"}}}, "CollectionListCoordinates": {"type": "object", "properties": {"collections": {"type": "array", "items": {"type": "string"}}}}, "MongoS3CoordinatesWithCollectionList": {"allOf": [{"$ref": "#/definitions/MongoS3Coordinates"}, {"$ref": "#/definitions/CollectionListCoordinates"}]}, "CpsPackage": {"type": "object", "properties": {"name": {"type": "string"}, "package_id": {"type": "string"}, "description": {"type": "string"}, "type": {"type": "string", "enum": ["model", "dictionary", "knowledge_graph", "data_catalog", "data_flow", "bundle"]}, "dependencies": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "package_id", "description", "type", "dependencies"]}, "EntityAnnotation": {"type": "object", "properties": {"match": {"type": "string"}, "range": {"type": "array", "description": "2-Tuple representing the low and high indexes of the matching substring", "items": {"type": "integer"}, "minItems": 2, "maxItems": 2}, "subtype": {"type": "string"}, "type": {"type": "string"}}, "required": ["match", "range", "type"]}, "RelationshipAnnotation": {"type": "object"}, "ObjectPropertyMap": {"type": "object"}, "AnnotatedText": {"type": "object", "required": ["text", "entities", "relationships", "properties"], "properties": {"text": {"type": "string"}, "entities": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}, "relationships": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}, "properties": {"$ref": "#/definitions/ObjectPropertyMap"}}}, "AnnotatedTable": {"type": "object", "required": ["entities", "relationships", "properties"], "properties": {"text": {"type": "string"}, "entities": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}, "relationships": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}, "properties": {"$ref": "#/definitions/ObjectPropertyMap"}}}, "AnnotatedImage": {"type": "object", "required": ["entities", "relationships", "properties"], "properties": {"text": {"type": "string"}, "entities": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}, "relationships": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}, "properties": {"$ref": "#/definitions/ObjectPropertyMap"}}}, "AnnotatedObject": {"type": "object", "minProperties": 1, "maxProperties": 1, "properties": {"text": {"title": "AnnotatedTextLines", "type": "object", "required": ["text", "entities", "relationships", "properties"], "properties": {"text": {"description": "Input text after clean up. The annotation indexes will be based on this text and not the input text.", "type": "string"}, "entities": {"type": "array", "description": "One item per line on the original text.", "items": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}}, "relationships": {"type": "array", "description": "One item per line on the original text.", "items": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}}, "properties": {"type": "array", "description": "One item per line on the original text.", "items": {"$ref": "#/definitions/ObjectPropertyMap"}}}}, "table": {"$ref": "#/definitions/AnnotatedTable"}, "image": {"$ref": "#/definitions/AnnotatedImage"}}}, "TopologyNode": {"type": "object", "properties": {"name": {"type": "string"}}, "required": ["name"]}, "TopologyEdge": {"type": "object", "properties": {"name": {"type": "string"}, "source": {"type": "array", "items": {"type": "string"}}, "target": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "source", "target"]}, "Topology": {"type": "object", "properties": {"categories": {"type": "array", "items": {"$ref": "#/definitions/TopologyNode"}}, "edges": {"type": "array", "items": {"$ref": "#/definitions/TopologyEdge"}}}, "required": ["categories", "edges"]}, "DataCatalogTopologyNode": {"properties": {"name": {"type": "string"}, "data-fields": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "data-fields"]}, "DataCatalogTopologyEdge": {"type": "object", "properties": {"name": {"type": "string"}, "source": {"type": "array", "items": {"type": "string"}}, "target": {"type": "array", "items": {"type": "string"}}, "source_field": {"type": "string"}, "target_field": {"type": "string"}}, "required": ["name", "source", "target", "source_field", "target_field"]}, "DataCatalogTopology": {"properties": {"categories": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogTopologyNode"}}, "edges": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogTopologyEdge"}}}, "required": ["categories", "edges"]}, "DataCatalogImportResult": {"type": "object", "required": ["data_catalogue", "import_task"], "properties": {"data_catalogue": {"$ref": "#/definitions/DataCatalogue"}, "import_task": {"$ref": "#/definitions/Task"}}}, "ElasticCoordinates": {"type": "object", "required": ["hosts"], "properties": {"hosts": {"type": "array", "items": {"type": "string"}}, "ca_certificate_base64": {"type": "string"}, "dangerously_disable_ssl_validation": {"type": "boolean"}}}, "ModelConfiguration": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}, "model_config_key": {"type": "string"}, "proj_key": {"type": "string"}, "created_by": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "public": {"type": "boolean"}, "configurations": {"type": "object", "properties": {"type": {"type": "string"}}, "required": ["type"], "additionalProperties": {}}, "supported_annotations": {"type": "object"}}, "required": ["name", "description", "model_config_key", "proj_key", "created_by", "created_at", "public"]}, "DictionaryCollectionObjectData": {"title": "DictionaryCollectionObjectData", "type": "array", "items": {"title": "DictionaryEntryWithId", "properties": {"_id": {"type": "string"}}, "required": ["_id"], "allOf": [{"$ref": "#/definitions/DictionaryEntry"}]}}, "DictionaryCollectionCsvData": {"title": "DictionaryCollectionCsvData", "type": "object", "properties": {"header": {"type": "string"}, "body": {"type": "string"}}, "required": ["header", "body"]}, "ProjectDefaultValues": {"type": "object", "properties": {"ccs_project": {"type": "object", "required": ["proj_key", "name"], "properties": {"proj_key": {"type": "string"}, "name": {"type": "string"}, "collection_name": {"type": "string"}}}, "dataflow": {"type": "object", "required": ["df_tpl_key", "name"], "properties": {"df_tpl_key": {"type": "string"}, "name": {"type": "string"}}}}}, "ProjectIntegrations": {"x-anyOf": [{"title": "Genai", "x-anyOf": [{"title": "GenAIWatsonx", "description": "GenAI integration for watsonx settings", "type": "object", "properties": {"kind": {"title": "Kind", "default": "watsonx", "const": "watsonx", "type": "string"}, "config": {"title": "GenAIWatsonxConfig", "description": "Config for watsonx", "type": "object", "properties": {"GENAI_API": {"title": "Endpoint", "type": "string"}, "GENAI_PROJECT_ID": {"title": "Project Id", "type": "string"}, "GENAI_KEY": {"title": "Apikey", "type": "string", "writeOnly": true, "format": "password"}}, "required": ["endpoint", "project_id", "apikey"]}}, "required": ["config"]}, {"title": "GenAIBAM", "description": "GenAI integration for BAM settings", "type": "object", "properties": {"kind": {"title": "Kind", "default": "bam", "const": "bam", "type": "string"}, "config": {"title": "GenAIBAMConfig", "description": "Config for BAM", "type": "object", "properties": {"GENAI_API": {"title": "Endpoint", "type": "string"}, "GENAI_KEY": {"title": "Apikey", "type": "string", "writeOnly": true, "format": "password"}}, "required": ["endpoint", "apikey"]}}, "required": ["config"]}, {"title": "GenAIHFInferenceApi", "description": "GenAI integration for Inference API settings", "type": "object", "properties": {"kind": {"title": "Kind", "default": "hf_api", "const": "hf_api", "type": "string"}, "config": {"title": "GenAIHFInferenceApiConfig", "description": "Config for HF Inference API", "type": "object", "properties": {"GENAI_HF_API_KEY": {"title": "Genai Hf Api Key", "type": "string", "writeOnly": true, "format": "password"}}, "required": ["GENAI_HF_API_KEY"]}}, "required": ["config"]}, {"title": "GenAIAWSBedrock", "description": "GenAI integration for AWS Bedrock settings", "type": "object", "properties": {"kind": {"title": "Kind", "default": "aws_bedrock", "const": "aws_bedrock", "type": "string"}, "config": {"title": "GenAIAWSBedrockConfig", "description": "Config for AWS Bedrock", "type": "object", "properties": {"GENAI_AWS_ACCESS_KEY": {"title": "Genai Aws Access Key", "type": "string", "writeOnly": true, "format": "password"}, "GENAI_AWS_SECRET_KEY": {"title": "Genai Aws Secret Key", "type": "string", "writeOnly": true, "format": "password"}, "GENAI_AWS_REGION_NAME": {"title": "Genai Aws Region Name", "type": "string"}}, "required": ["GENAI_AWS_ACCESS_KEY", "GENAI_AWS_SECRET_KEY", "GENAI_AWS_REGION_NAME"]}}, "required": ["config"]}]}]}, "BagBackendAware": {"type": "object", "required": ["proj_key", "bag_key", "name", "description", "slug", "timestamp", "backend", "public"], "properties": {"proj_key": {"type": "string"}, "bag_key": {"type": "string"}, "name": {"type": "string"}, "description": {"type": "string"}, "slug": {"type": "string"}, "timestamp": {"type": "number", "format": "double"}, "backend": {"type": "object", "title": "BagBackends", "properties": {"kg_legacy_api": {"type": "object", "title": "BagKgLegacyApiBackend", "properties": {"bag_domain": {"type": "string"}, "flavour": {"type": "string"}, "bag_url": {"type": "string"}, "token": {"type": "string"}, "_svc_endpoint": {"type": "string"}}}, "kg_amqp": {"type": "object", "title": "BagAmqpBackend", "properties": {"flavour": {"type": "string"}}}}}, "public": {"type": "boolean"}, "last_coords_resolution": {"type": "number"}}}, "TakeSnapshotSettingsBackendAware": {"type": "object", "properties": {"backend_flavours": {"type": "object", "title": "BackendFlavour", "properties": {"kg_amqp": {"type": "string"}, "kg_legacy_api": {"type": "string"}}}, "name": {"type": "string"}, "load_into_kg_after_created": {"type": "boolean", "default": false}}, "required": ["backend_flavours"]}, "BagStatusBackendAware": {"type": "object", "properties": {"overall_status": {"$ref": "#/definitions/BagComponentStatusEnum"}, "kg_amqp": {"type": "object", "properties": {"status": {"$ref": "#/definitions/BagComponentStatusEnum"}}, "required": ["status"]}, "kg_legacy_api": {"$ref": "#/definitions/BagStatus"}}, "required": ["overall_status"]}, "AnnotatorSupportedAnnotationsParameters": {"type": "object", "properties": {"annotator": {"type": "string"}, "annotator_settings": {"type": "object"}}, "required": ["annotator"]}, "ModelSupportedAnnotationsParameters": {"type": "object", "properties": {"model_config_key": {"type": "string"}, "proj_key": {"type": "string"}, "public": {"type": "boolean"}}, "required": ["model_config_key", "proj_key", "public"]}, "ElasticIndexSearchQueryOptions": {"type": "object", "properties": {"_source": {"type": "array", "items": {"type": "string"}}, "from": {"type": "number", "minimum": 0}, "size": {"type": "number", "minimum": 0, "maximum": 10000}, "query": {"type": "object", "additionalProperties": {}}, "aggs": {"type": "object"}, "sort": {"type": "array", "items": {"type": "object"}}}}, "ElasticIndexProperties": {"type": "object"}, "KibanaSavedQueriesResult": {"type": "object", "properties": {"description": {"type": "string"}, "fields": {"type": "array", "items": {"type": "string"}}, "query": {"type": "string"}, "title": {"type": "string"}}}, "AnnotatorParametersOrRef": {"type": "object", "properties": {"type": {"type": "string"}, "model_config_key": {"type": "string"}, "proj_key": {"type": "string"}, "public": {"type": "boolean"}}}, "DataCollection": {"type": "object", "required": ["name", "documents", "health", "status", "metadata"], "properties": {"name": {"type": "string"}, "documents": {"type": "number"}, "health": {"type": "string"}, "status": {"type": "string"}, "metadata": {"type": "object", "required": ["aliases", "created", "description", "source", "version", "type", "domain"], "properties": {"aliases": {"type": "array", "items": {"type": "string"}}, "created": {"type": "string", "format": "datetime"}, "description": {"type": "string"}, "source": {"type": "string"}, "storage": {"type": "string"}, "version": {"type": "string"}, "type": {"type": "string"}, "domain": {"type": "array", "items": {"type": "string"}}}}, "source": {"type": "object", "required": ["index_key"], "properties": {"index_key": {"type": "string"}, "proj_key": {"type": "string"}, "elastic_id": {"type": "string"}}}}}, "Dictionary": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}, "dict_key": {"type": "string"}, "proj_key": {"type": "string"}, "created_by": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "copy_of": {"type": "string", "x-nullable": true}, "public": {"type": "boolean"}, "collections": {"type": "array", "items": {"$ref": "#/definitions/DictionaryCollection"}}}, "required": ["name", "description", "dict_key", "proj_key", "created_by", "created_at", "copy_of", "public"]}, "DictionaryEntry": {"type": "object", "additionalProperties": {}, "properties": {"_name": {"type": "string"}, "_synonyms": {"type": "array", "items": {"type": "string"}}}, "required": ["_name", "_synonyms"]}, "DictionaryCloneResult": {"type": "object", "properties": {"dictionary": {"$ref": "#/definitions/Dictionary"}, "clone_task": {"$ref": "#/definitions/Task"}}}, "DictionaryCollection": {"type": "object", "required": ["name", "item_count"], "properties": {"name": {"type": "string"}, "item_count": {"type": "integer"}}}, "DictionaryCollectionPatch": {"type": "object", "required": ["op", "path"], "properties": {"op": {"type": "string", "enum": ["add", "replace", "remove"]}, "path": {"type": "string", "description": "A path (see JSON patch specification) in the format `/{objectid}` for existing objects, or `/-` for new objects (`add` operations).", "pattern": "^/(?:-|[a-zA-Z0-9]{24})$"}, "value": {"$ref": "#/definitions/DictionaryEntry"}}}, "CpsModelReference": {"type": "object", "properties": {"model_config_key": {"type": "string"}, "proj_key": {"type": "string"}}, "required": ["model_config_key", "proj_key"]}, "CcsCollectionReference": {"type": "object", "properties": {"proj_key": {"type": "string"}, "collection_name": {"type": "string"}, "language": {"type": "string"}}, "required": ["proj_key", "collection_name"]}, "ProcessingModelDataFlow": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object"}}}, "required": ["config", "data-flow"]}, "WorkFlow": {"type": "object"}, "ProcessingModel": {"type": "object", "required": ["dataflow"], "properties": {"dataflow": {"$ref": "#/definitions/ProcessingModelDataFlow"}, "variables": {"type": "object", "additionalProperties": {"type": "object", "title": "DataFlowVariableDefinition", "properties": {"type": {"type": "string"}}, "required": ["type"]}}}}, "CatalogReference": {"type": "object", "properties": {"dc_key": {"type": "string"}, "proj_key": {"type": "string"}, "collection_name": {"type": "string"}}, "required": ["dc_key", "collection_name"]}, "EntityMapping": {"type": "object", "additionalProperties": {"type": "string"}}, "ProcessingModelDescription": {"type": "object", "required": ["name", "display_name", "description"], "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "description": {"type": "string"}}}}, "basePath": "/api/cps/public/v1"} diff --git a/tools/swagger-client-generator/swagger-user.json b/tools/swagger-client-generator/swagger-user.json index 1ffff2d3..3f2c5ea1 100644 --- a/tools/swagger-client-generator/swagger-user.json +++ b/tools/swagger-client-generator/swagger-user.json @@ -1 +1 @@ -{"basePath":"/api/cps/user/v1","consumes":["application/json"],"definitions":{"AccessToken":{"properties":{"access_token":{"type":"string"}},"type":"object"},"ApiKey":{"properties":{"api_key":{"type":"string"},"email":{"type":"string"}},"required":["api_key"],"type":"object"},"AuditRecord":{"properties":{"details":{"title":"Details","type":"object"},"id":{"title":"Id","type":"string"},"message":{"title":"Message","type":"string"},"proj_key":{"title":"Proj Key","type":"string","x-nullable":true},"timestamp":{"format":"datetime","title":"Timestamp","type":"string"},"type":{"title":"Type","type":"string"},"user_key":{"title":"User Key","type":"string"}},"required":["id","timestamp","user_key","type","message","details","proj_key"],"title":"AuditRecord","type":"object"},"ErrorResponse":{"properties":{"error":{"description":"Description of the error.","type":"string"}},"required":["error"],"type":"object"},"OidcTokenResponse":{"properties":{"access_token":{"type":"string"},"id_token":{"type":"string"},"refresh_token":{"type":"string"}},"required":["id_token","refresh_token"],"type":"object"},"Project":{"additionalProperties":{"items":{"$ref":"#/definitions/UserDetails"},"type":"array"},"properties":{"date":{"format":"datetime","type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"role":{"$ref":"#/definitions/UserType"}},"type":"object"},"ProjectUserAssignment":{"properties":{"force_role":{"default":true,"description":"If true, the role will be assigned also for existing users","type":"boolean"},"role":{"description":"The role to assign to the user","type":"string"},"username":{"description":"The username","type":"string"}},"required":["username","role"],"type":"object"},"ServiceAccount":{"properties":{"credentials":{"properties":{"password":{"type":"string"},"username":{"type":"string"}},"required":["username","password"],"type":"object"},"name":{"type":"string"},"user_key":{"type":"string"}},"required":["user_key"],"type":"object"},"SuccessMessage":{"properties":{"success":{"description":"Human readable message.","type":"string"}},"required":["success"],"type":"object"},"TokenResponse":{"properties":{"token":{"description":"The delete confirmation token.","type":"string"}},"required":["token"],"type":"object"},"UserDetails":{"properties":{"email":{"type":"string"},"role":{"type":"string"},"username":{"type":"string"}},"type":"object"},"UserType":{"enum":["assignee","owner"],"type":"string"}},"info":{"title":"User Management API","version":"1.2.0"},"paths":{"/admin/audits":{"get":{"description":"List audits globally","operationId":"list_audits","parameters":[{"in":"query","name":"user_key","required":false,"type":"string"},{"in":"query","name":"type_","required":false,"type":"string"},{"in":"query","name":"search_term","required":false,"type":"string"},{"format":"datetime","in":"query","name":"before","required":false,"type":"string"},{"format":"datetime","in":"query","name":"after","required":false,"type":"string"},{"default":50,"in":"query","name":"limit","type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"properties":{"audits":{"items":{"$ref":"#/definitions/AuditRecord"},"type":"array"}},"required":["audits"],"type":"object"}},"401":{"description":"Unauthorized.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Project does not exist.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Admin"],"x-swagger-router-controller":"oidc_user_mngt.controllers.admin"}},"/admin/projects":{"post":{"description":"Create a new project","operationId":"create_project","parameters":[{"in":"body","name":"data","required":true,"schema":{"properties":{"name":{"description":"Name of the project","type":"string"},"proj_key":{"description":"Internal project key to use. (use only if you really know what you are doing)","type":"string"}},"required":["name"],"title":"CreateProjectRequestBody","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"New project details","schema":{"$ref":"#/definitions/Project"}}},"security":[{"Bearer":[]}],"tags":["Admin"],"x-swagger-router-controller":"oidc_user_mngt.controllers.admin"}},"/admin/projects/all":{"get":{"description":"List all projects","operationId":"list_all_projects","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Project"},"type":"array"}},"404":{"description":"Project does not exist.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Admin"],"x-swagger-router-controller":"oidc_user_mngt.controllers.admin"}},"/admin/projects/{proj_key}/users":{"get":{"description":"List all users belonging to a cps project","operationId":"admin_list_users","parameters":[{"description":"The project key","in":"path","name":"proj_key","required":true,"type":"string"},{"description":"page of the result list","in":"query","name":"page","required":false,"type":"integer"},{"default":2,"description":"items on one page of the result list","in":"query","name":"items_per_page","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"additionalProperties":{"items":{"$ref":"#/definitions/UserDetails"},"type":"array"},"type":"object"}},"401":{"description":"Unauthorized.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"User does not exist.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Admin"],"x-swagger-router-controller":"oidc_user_mngt.controllers.admin"},"post":{"description":"Assign a new user to a project","operationId":"admin_add_user","parameters":[{"description":"The project key","in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ProjectUserAssignment"}}],"produces":["application/json"],"responses":{"200":{"description":"User assigned to project.","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Invalid new_user_type.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"The user that's performing this operation does not have permission to assign the user.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"User that's going to be assigned doesn't exist, or the project doesn't exist.","schema":{"$ref":"#/definitions/ErrorResponse"}},"409":{"description":"Reassigning the user would leave the project in an invalid state.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Admin"],"x-swagger-router-controller":"oidc_user_mngt.controllers.admin"}},"/admin/projects/{proj_key}/users/{username}":{"delete":{"description":"Delete an user from a project.","operationId":"admin_remove_user","parameters":[{"description":"The project key","in":"path","name":"proj_key","required":true,"type":"string"},{"description":"The username for the user","in":"path","name":"username","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"User deleted from project successfully."},"403":{"description":"The user that is executing this operation is not an owner of the project.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Project or user not found.","schema":{"$ref":"#/definitions/ErrorResponse"}},"409":{"description":"User not assigned to project, or the project only has one owner left.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Admin"],"x-swagger-router-controller":"oidc_user_mngt.controllers.admin"}},"/admin/users/pending":{"get":{"description":"List pending user requests.","operationId":"list_pending_users","parameters":[{"in":"query","name":"term","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/UserDetails"},"type":"array"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Admin"],"x-swagger-router-controller":"oidc_user_mngt.controllers.admin"}},"/admin/users/{user_key}/confirmation":{"post":{"consumes":["application/json"],"description":"Confirm a pending user.","operationId":"confirm_user","parameters":[{"in":"path","name":"user_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Admin"],"x-swagger-router-controller":"oidc_user_mngt.controllers.admin"}},"/oidc/authenticate":{"get":{"description":"Redirect to the OIDC authenticate endpoint.","operationId":"authenticate","produces":["text/plain"],"responses":{"302":{"description":"Redirect to the OIDC authenticate endpoint"}},"tags":["Oidc"],"x-swagger-router-controller":"oidc_user_mngt.controllers.oidc"}},"/oidc/register_user":{"post":{"description":"Register a new user, provided a valid access_token and id_token from the oidc provider.","operationId":"register_user","parameters":[{"in":"body","name":"data","required":true,"schema":{"properties":{"access_token":{"description":"OIDC access_token signed by the provider","type":"string"},"id_token":{"description":"OIDC id_token signed by the provider","type":"string"}},"required":["access_token","id_token"],"title":"RegisterUserRequestBody","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UserDetails"}}},"tags":["Oidc"],"x-swagger-router-controller":"oidc_user_mngt.controllers.oidc"}},"/oidc/token":{"get":{"deprecated":true,"description":"Retrieve the user access and identity tokens using either the code or the refresh_token.","operationId":"token","parameters":[{"description":"The oidc code response","in":"query","name":"code","required":false,"type":"string"},{"description":"The oidc code response","in":"query","name":"refresh_token","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OidcTokenResponse"}}},"tags":["Oidc"],"x-swagger-router-controller":"oidc_user_mngt.controllers.oidc"},"post":{"description":"Retrieve the user access and identity tokens using either the code or the refresh_token.","operationId":"create_tokens","parameters":[{"in":"body","name":"body","schema":{"properties":{"code":{"description":"The oidc code response","type":"string"},"refresh_token":{"description":"The refresh token","type":"string"}},"title":"CreateTokensRequestBody","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OidcTokenResponse"}}},"tags":["Oidc"],"x-swagger-router-controller":"oidc_user_mngt.controllers.oidc"}},"/permissions":{"get":{"description":"Get the global permissions for users.","operationId":"global_permissions","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"additionalProperties":{"type":"boolean"},"type":"object"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Settings"],"x-swagger-router-controller":"oidc_user_mngt.controllers.global"}},"/projects":{"get":{"description":"List all projects assigned to a user","operationId":"list_projects","parameters":[{"description":"filter for the user role","in":"query","name":"role","required":false,"type":"string"},{"default":true,"in":"query","name":"include_collaborators","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Project"},"type":"array"}},"404":{"description":"Project does not exist.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Projects"],"x-swagger-router-controller":"oidc_user_mngt.controllers.project"},"post":{"description":"Create a new project","operationId":"create","parameters":[{"in":"body","name":"data","required":true,"schema":{"properties":{"name":{"description":"Name of the project","type":"string"},"proj_key":{"description":"Internal project key to use. (use only if you really know what you are doing)","type":"string"}},"required":["name"],"title":"CreateProjectRequestBody","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"New project details","schema":{"$ref":"#/definitions/Project"}}},"security":[{"Bearer":[]}],"tags":["Projects"],"x-swagger-router-controller":"oidc_user_mngt.controllers.project"}},"/projects/{proj_key}":{"delete":{"description":"Delete a project.","operationId":"delete","parameters":[{"description":"The project key","in":"path","name":"proj_key","required":true,"type":"string"},{"description":"The delete confirmation token","in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Project deleted successfully."},"403":{"description":"The user that is executing this operation is not an owner of the project.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Project not found.","schema":{"$ref":"#/definitions/ErrorResponse"}},"409":{"description":"User not assigned to project.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Projects"],"x-swagger-router-controller":"oidc_user_mngt.controllers.project"},"get":{"description":"Returns the details of the project","operationId":"details","parameters":[{"description":"The project key","in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Project"}},"401":{"description":"Unauthorized.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Project does not exist.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Projects"],"x-swagger-router-controller":"oidc_user_mngt.controllers.project"}},"/projects/{proj_key}/audits":{"get":{"description":"List audits related to the project","operationId":"list_audits_in_project","parameters":[{"description":"The project key","in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"user_key","required":false,"type":"string"},{"in":"query","name":"type_","required":false,"type":"string"},{"in":"query","name":"search_term","required":false,"type":"string"},{"format":"datetime","in":"query","name":"before","required":false,"type":"string"},{"format":"datetime","in":"query","name":"after","required":false,"type":"string"},{"default":50,"in":"query","name":"limit","type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"properties":{"audits":{"items":{"$ref":"#/definitions/AuditRecord"},"type":"array"}},"required":["audits"],"type":"object"}},"401":{"description":"Unauthorized.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Project does not exist.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Projects"],"x-swagger-router-controller":"oidc_user_mngt.controllers.project"}},"/projects/{proj_key}/delete":{"get":{"description":"Get a delete confirmation token for the provided project.","operationId":"get_delete_confirmation_token","parameters":[{"description":"The project key","in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Confirmation token.","schema":{"$ref":"#/definitions/TokenResponse"}},"403":{"description":"The user that is executing this operation is not an owner of the project.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Project not found.","schema":{"$ref":"#/definitions/ErrorResponse"}},"409":{"description":"User not assigned to project.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Projects"],"x-swagger-router-controller":"oidc_user_mngt.controllers.project"}},"/projects/{proj_key}/is_authorized":{"get":{"description":"Provide user-key and project-key to coordinates a project","operationId":"is_authorized","parameters":[{"description":"The project key","in":"path","name":"proj_key","required":true,"type":"string"},{"description":"The specific role to probe","in":"query","name":"role","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SuccessMessage"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Project does not exist.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Projects"],"x-swagger-router-controller":"oidc_user_mngt.controllers.project"}},"/projects/{proj_key}/token":{"get":{"description":"Request a token granting access to the current project","operationId":"get_project_token","parameters":[{"description":"The project key","in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AccessToken"}},"401":{"description":"Unauthorized.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Project does not exist.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Projects"],"x-swagger-router-controller":"oidc_user_mngt.controllers.project"}},"/projects/{proj_key}/users":{"get":{"description":"List all users belonging to a project","operationId":"list_users","parameters":[{"description":"The project key","in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"additionalProperties":{"items":{"$ref":"#/definitions/UserDetails"},"type":"array"},"type":"object"}},"401":{"description":"Unauthorized.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"User does not exist.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Projects"],"x-swagger-router-controller":"oidc_user_mngt.controllers.project"},"post":{"description":"Assign a new user to a project","operationId":"add_user","parameters":[{"description":"The project key","in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ProjectUserAssignment"}}],"produces":["application/json"],"responses":{"200":{"description":"User assigned to project.","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Invalid new_user_type.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"The user that's performing this operation does not have permission to assign the user.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"User that's going to be assigned doesn't exist, or the project doesn't exist.","schema":{"$ref":"#/definitions/ErrorResponse"}},"409":{"description":"Reassigning the user would leave the project in an invalid state.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Projects"],"x-swagger-router-controller":"oidc_user_mngt.controllers.project"},"put":{"description":"Assign a new user to a project","operationId":"edit_user","parameters":[{"description":"The project key","in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ProjectUserAssignment"}}],"produces":["application/json"],"responses":{"200":{"description":"User assigned to project.","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Invalid new_user_type.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"The user that's performing this operation does not have permission to assign the user.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"User that's going to be assigned doesn't exist, or the project doesn't exist.","schema":{"$ref":"#/definitions/ErrorResponse"}},"409":{"description":"Reassigning the user would leave the project in an invalid state.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Projects"],"x-swagger-router-controller":"oidc_user_mngt.controllers.project"}},"/projects/{proj_key}/users/{username}":{"delete":{"description":"Delete an user from a project.","operationId":"remove_user","parameters":[{"description":"The project key","in":"path","name":"proj_key","required":true,"type":"string"},{"description":"The username for the user","in":"path","name":"username","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"User deleted from project successfully."},"403":{"description":"The user that is executing this operation is not an owner of the project.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Project or user not found.","schema":{"$ref":"#/definitions/ErrorResponse"}},"409":{"description":"User not assigned to project, or the project only has one owner left.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Projects"],"x-swagger-router-controller":"oidc_user_mngt.controllers.project"}},"/projects/{proj_key}/users_paginated":{"get":{"description":"List all users belonging to a cps project","operationId":"list_users_paginated","parameters":[{"description":"The project key","in":"path","name":"proj_key","required":true,"type":"string"},{"description":"page of the result list","in":"query","name":"page","required":false,"type":"integer"},{"default":2,"description":"items on one page of the result list","in":"query","name":"items_per_page","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"additionalProperties":{"items":{"$ref":"#/definitions/UserDetails"},"type":"array"},"type":"object"}},"401":{"description":"Unauthorized.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"User does not exist.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]}],"tags":["Projects"],"x-swagger-router-controller":"oidc_user_mngt.controllers.project"}},"/user/api_key":{"get":{"description":"Show the API Key for your user","operationId":"api_key_get","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApiKey"}}},"security":[{"Bearer":[]}],"tags":["Users"],"x-swagger-router-controller":"oidc_user_mngt.controllers.user"},"post":{"description":"Create an API Key for your user","operationId":"api_key_create","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApiKey"}}},"security":[{"Bearer":[]}],"tags":["User"],"x-swagger-router-controller":"oidc_user_mngt.controllers.user"}},"/user/current":{"get":{"description":"Gets the current user's details.","operationId":"get_current_user_details","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UserDetails"}}},"security":[{"Bearer":[]}],"tags":["Users"],"x-swagger-router-controller":"oidc_user_mngt.controllers.user"}},"/user/impersonate":{"post":{"description":"Request an impersonate user token.","operationId":"impersonate_user_token","parameters":[{"in":"body","name":"body","required":true,"schema":{"properties":{"impersonate_secret":{"type":"string"},"target_user_key":{"type":"string"}},"required":["target_user_key","impersonate_secret"],"title":"ImpersonateUserTokenRequestBody","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TokenResponse"}},"401":{"description":"Unauthorized.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"The user that's performing this operation does not have permission or the impersonate secret isn't valid.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]},{"UserAPIKey":[]}],"tags":["Users"],"x-swagger-router-controller":"oidc_user_mngt.controllers.user"}},"/user/search":{"get":{"description":"Search for users matching the email or name. Depending on the user's permissions, only owners and assignees from their projects may be shown.","operationId":"search","parameters":[{"description":"Search term","in":"query","name":"term","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/UserDetails"},"type":"array"}}},"security":[{"Bearer":[]}],"tags":["Users"],"x-swagger-router-controller":"oidc_user_mngt.controllers.user"}},"/user/service_accounts":{"get":{"deprecated":true,"description":"List all service accounts of your user","operationId":"service_accounts_list","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ServiceAccount"},"type":"array"}}},"security":[{"Bearer":[]}],"tags":["Users"],"x-swagger-router-controller":"oidc_user_mngt.controllers.user"},"post":{"deprecated":true,"description":"Create a new service accounts for your user","operationId":"service_accounts_create","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceAccount"}}},"security":[{"Bearer":[]}],"tags":["Users"],"x-swagger-router-controller":"oidc_user_mngt.controllers.user"}},"/user/token":{"post":{"description":"Request a user API token","operationId":"get_access_token","parameters":[{"in":"body","name":"options","required":false,"schema":{"properties":{"admin":{"default":false,"type":"boolean"}},"title":"GetAccessTokenRequestBody","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AccessToken"}},"401":{"description":"Unauthorized.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"Bearer":[]},{"UserAPIKey":[]}],"tags":["Users"],"x-swagger-router-controller":"oidc_user_mngt.controllers.user"}}},"produces":["application/json"],"schemes":["http","https"],"securityDefinitions":{"Bearer":{"description":"For accessing the API a valid JWT token must be passed in all the queries in\nthe 'Authorization' header.\n\nA valid JWT token is generated by the API and returned.\n\nThe following syntax must be used in the 'Authorization' header :\n Bearer: xxxxxx.yyyyyyy.zzzzzz\n","in":"header","name":"Authorization","type":"apiKey","x-apikeyInfoFunc":"oidc_user_mngt.utils.connexion_auth.api_key_info"},"UserAPIKey":{"description":"Login using the user credentials. Username is the email address. Password is\nthe API Key.\n","type":"basic","x-basicInfoFunc":"oidc_user_mngt.utils.connexion_auth.basic_auth_info"}},"swagger":"2.0"} +{"swagger": "2.0", "info": {"version": "1.2.0", "title": "User Management API"}, "schemes": ["http", "https"], "consumes": ["application/json"], "produces": ["application/json"], "securityDefinitions": {"Bearer": {"description": "For accessing the API a valid JWT token must be passed in all the queries in\nthe 'Authorization' header.\n\nA valid JWT token is generated by the API and returned.\n\nThe following syntax must be used in the 'Authorization' header :\n Bearer: xxxxxx.yyyyyyy.zzzzzz\n", "type": "apiKey", "name": "Authorization", "in": "header", "x-apikeyInfoFunc": "oidc_user_mngt.utils.connexion_auth.api_key_info"}, "UserAPIKey": {"description": "Login using the user credentials. Username is the email address. Password is\nthe API Key.\n", "type": "basic", "x-basicInfoFunc": "oidc_user_mngt.utils.connexion_auth.basic_auth_info"}}, "paths": {"/oidc/authenticate": {"get": {"tags": ["Oidc"], "description": "Redirect to the OIDC authenticate endpoint.", "produces": ["text/plain"], "x-swagger-router-controller": "oidc_user_mngt.controllers.oidc", "operationId": "authenticate", "responses": {"302": {"description": "Redirect to the OIDC authenticate endpoint"}}}}, "/oidc/token": {"get": {"tags": ["Oidc"], "description": "Retrieve the user access and identity tokens using either the code or the refresh_token.", "deprecated": true, "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.oidc", "operationId": "token", "parameters": [{"name": "code", "in": "query", "required": false, "type": "string", "description": "The oidc code response"}, {"name": "refresh_token", "in": "query", "required": false, "type": "string", "description": "The oidc code response"}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/OidcTokenResponse"}}}}, "post": {"tags": ["Oidc"], "description": "Retrieve the user access and identity tokens using either the code or the refresh_token.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.oidc", "operationId": "create_tokens", "parameters": [{"name": "body", "in": "body", "schema": {"title": "CreateTokensRequestBody", "type": "object", "properties": {"code": {"type": "string", "description": "The oidc code response"}, "refresh_token": {"type": "string", "description": "The refresh token"}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/OidcTokenResponse"}}}}}, "/oidc/register_user": {"post": {"tags": ["Oidc"], "description": "Register a new user, provided a valid access_token and id_token from the oidc provider.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.oidc", "operationId": "register_user", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "RegisterUserRequestBody", "properties": {"access_token": {"type": "string", "description": "OIDC access_token signed by the provider"}, "id_token": {"type": "string", "description": "OIDC id_token signed by the provider"}}, "required": ["access_token", "id_token"]}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/UserDetails"}}}}}, "/user/impersonate": {"post": {"tags": ["Users"], "security": [{"Bearer": []}, {"UserAPIKey": []}], "description": "Request an impersonate user token.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "impersonate_user_token", "parameters": [{"name": "body", "in": "body", "required": true, "schema": {"type": "object", "title": "ImpersonateUserTokenRequestBody", "required": ["target_user_key", "impersonate_secret"], "properties": {"target_user_key": {"type": "string"}, "impersonate_secret": {"type": "string"}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/TokenResponse"}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "403": {"description": "The user that's performing this operation does not have permission or the impersonate secret isn't valid.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/user/service_accounts": {"get": {"deprecated": true, "tags": ["Users"], "security": [{"Bearer": []}], "description": "List all service accounts of your user", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "service_accounts_list", "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/ServiceAccount"}}}}}, "post": {"deprecated": true, "tags": ["Users"], "security": [{"Bearer": []}], "description": "Create a new service accounts for your user", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "service_accounts_create", "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/ServiceAccount"}}}}}, "/user/api_key": {"get": {"tags": ["Users"], "security": [{"Bearer": []}], "description": "Show the API Key for your user", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "api_key_get", "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/ApiKey"}}}}, "post": {"tags": ["User"], "security": [{"Bearer": []}], "description": "Create an API Key for your user", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "api_key_create", "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/ApiKey"}}}}}, "/user/token": {"post": {"tags": ["Users"], "security": [{"Bearer": []}, {"UserAPIKey": []}], "description": "Request a user API token", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "get_access_token", "parameters": [{"name": "options", "in": "body", "required": false, "schema": {"type": "object", "title": "GetAccessTokenRequestBody", "properties": {"admin": {"type": "boolean", "default": false}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/AccessToken"}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/user/search": {"get": {"tags": ["Users"], "security": [{"Bearer": []}], "description": "Search for users matching the email or name. Depending on the user's permissions, only owners and assignees from their projects may be shown.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "search", "parameters": [{"name": "term", "in": "query", "required": true, "type": "string", "description": "Search term"}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/UserDetails"}}}}}}, "/user/current": {"get": {"tags": ["Users"], "security": [{"Bearer": []}], "description": "Gets the current user's details.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "get_current_user_details", "parameters": [], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/UserDetails"}}}}}, "/projects": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "List all projects assigned to a user", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "list_projects", "parameters": [{"name": "role", "in": "query", "required": false, "type": "string", "description": "filter for the user role"}, {"name": "include_collaborators", "in": "query", "required": false, "type": "boolean", "default": true}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/Project"}}}, "404": {"description": "Project does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "post": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Create a new project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "create", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateProjectRequestBody", "properties": {"name": {"type": "string", "description": "Name of the project"}, "proj_key": {"type": "string", "description": "Internal project key to use. (use only if you really know what you are doing)"}}, "required": ["name"]}}], "responses": {"200": {"description": "New project details", "schema": {"$ref": "#/definitions/Project"}}}}}, "/projects/{proj_key}/is_authorized": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Provide user-key and project-key to coordinates a project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "is_authorized", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "role", "in": "query", "required": false, "type": "string", "description": "The specific role to probe"}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/SuccessMessage"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/projects/{proj_key}/delete": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Get a delete confirmation token for the provided project.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "get_delete_confirmation_token", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}], "responses": {"200": {"description": "Confirmation token.", "schema": {"$ref": "#/definitions/TokenResponse"}}, "403": {"description": "The user that is executing this operation is not an owner of the project.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project not found.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "User not assigned to project.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/projects/{proj_key}": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Returns the details of the project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "details", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Project"}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "delete": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Delete a project.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "delete", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "confirmation_token", "in": "query", "required": true, "type": "string", "description": "The delete confirmation token"}], "responses": {"204": {"description": "Project deleted successfully."}, "403": {"description": "The user that is executing this operation is not an owner of the project.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project not found.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "User not assigned to project.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/projects/{proj_key}/users": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "List all users belonging to a project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "list_users", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}], "responses": {"200": {"description": "OK", "schema": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/UserDetails"}}}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "User does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "post": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Assign a new user to a project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "add_user", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectUserAssignment"}}], "responses": {"200": {"description": "User assigned to project.", "schema": {"$ref": "#/definitions/SuccessMessage"}}, "400": {"description": "Invalid new_user_type.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "403": {"description": "The user that's performing this operation does not have permission to assign the user.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "User that's going to be assigned doesn't exist, or the project doesn't exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Reassigning the user would leave the project in an invalid state.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "put": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Assign a new user to a project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "edit_user", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectUserAssignment"}}], "responses": {"200": {"description": "User assigned to project.", "schema": {"$ref": "#/definitions/SuccessMessage"}}, "400": {"description": "Invalid new_user_type.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "403": {"description": "The user that's performing this operation does not have permission to assign the user.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "User that's going to be assigned doesn't exist, or the project doesn't exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Reassigning the user would leave the project in an invalid state.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/projects/{proj_key}/users_paginated": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "List all users belonging to a cps project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "list_users_paginated", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "page", "in": "query", "description": "page of the result list", "required": false, "type": "integer"}, {"name": "items_per_page", "in": "query", "description": "items on one page of the result list", "required": false, "default": 2, "type": "integer"}], "responses": {"200": {"description": "OK", "schema": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/UserDetails"}}}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "User does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/projects/{proj_key}/users/{username}": {"delete": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Delete an user from a project.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "remove_user", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "username", "in": "path", "required": true, "type": "string", "description": "The username for the user"}], "responses": {"204": {"description": "User deleted from project successfully."}, "403": {"description": "The user that is executing this operation is not an owner of the project.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project or user not found.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "User not assigned to project, or the project only has one owner left.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/projects/{proj_key}/token": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Request a token granting access to the current project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "get_project_token", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/AccessToken"}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/projects/{proj_key}/audits": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "List audits related to the project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "list_audits_in_project", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "user_key", "in": "query", "required": false, "type": "string"}, {"name": "type_", "in": "query", "type": "string", "required": false}, {"name": "search_term", "in": "query", "type": "string", "required": false}, {"name": "before", "in": "query", "type": "string", "format": "datetime", "required": false}, {"name": "after", "in": "query", "type": "string", "format": "datetime", "required": false}, {"name": "limit", "in": "query", "type": "integer", "default": 50}], "responses": {"200": {"description": "OK", "schema": {"type": "object", "required": ["audits"], "properties": {"audits": {"type": "array", "items": {"$ref": "#/definitions/AuditRecord"}}}}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/permissions": {"get": {"tags": ["Settings"], "security": [{"Bearer": []}], "description": "Get the global permissions for users.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.global", "operationId": "global_permissions", "responses": {"200": {"description": "OK", "schema": {"type": "object", "additionalProperties": {"type": "boolean"}}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/admin/users/pending": {"get": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "List pending user requests.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "list_pending_users", "parameters": [{"name": "term", "type": "string", "in": "query", "required": false}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/UserDetails"}}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/admin/users/{user_key}/confirmation": {"post": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "Confirm a pending user.", "consumes": ["application/json"], "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "confirm_user", "parameters": [{"name": "user_key", "in": "path", "required": true, "type": "string"}], "responses": {"200": {"description": "OK"}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/admin/projects/all": {"get": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "List all projects", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "list_all_projects", "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/Project"}}}, "404": {"description": "Project does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/admin/audits": {"get": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "List audits globally", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "list_audits", "parameters": [{"name": "user_key", "in": "query", "required": false, "type": "string"}, {"name": "type_", "in": "query", "type": "string", "required": false}, {"name": "search_term", "in": "query", "type": "string", "required": false}, {"name": "before", "in": "query", "type": "string", "format": "datetime", "required": false}, {"name": "after", "in": "query", "type": "string", "format": "datetime", "required": false}, {"name": "limit", "in": "query", "type": "integer", "default": 50}], "responses": {"200": {"description": "OK", "schema": {"type": "object", "required": ["audits"], "properties": {"audits": {"type": "array", "items": {"$ref": "#/definitions/AuditRecord"}}}}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/admin/projects/{proj_key}/users": {"get": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "List all users belonging to a cps project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "admin_list_users", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "page", "in": "query", "description": "page of the result list", "required": false, "type": "integer"}, {"name": "items_per_page", "in": "query", "description": "items on one page of the result list", "required": false, "default": 2, "type": "integer"}], "responses": {"200": {"description": "OK", "schema": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/UserDetails"}}}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "User does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "post": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "Assign a new user to a project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "admin_add_user", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectUserAssignment"}}], "responses": {"200": {"description": "User assigned to project.", "schema": {"$ref": "#/definitions/SuccessMessage"}}, "400": {"description": "Invalid new_user_type.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "403": {"description": "The user that's performing this operation does not have permission to assign the user.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "User that's going to be assigned doesn't exist, or the project doesn't exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Reassigning the user would leave the project in an invalid state.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/admin/projects/{proj_key}/users/{username}": {"delete": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "Delete an user from a project.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "admin_remove_user", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "username", "in": "path", "required": true, "type": "string", "description": "The username for the user"}], "responses": {"204": {"description": "User deleted from project successfully."}, "403": {"description": "The user that is executing this operation is not an owner of the project.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project or user not found.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "User not assigned to project, or the project only has one owner left.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/admin/projects": {"post": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "Create a new project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "create_project", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateProjectRequestBody", "properties": {"name": {"type": "string", "description": "Name of the project"}, "proj_key": {"type": "string", "description": "Internal project key to use. (use only if you really know what you are doing)"}}, "required": ["name"]}}], "responses": {"200": {"description": "New project details", "schema": {"$ref": "#/definitions/Project"}}}}}}, "definitions": {"ErrorResponse": {"type": "object", "properties": {"error": {"type": "string", "description": "Description of the error."}}, "required": ["error"]}, "UserDetails": {"type": "object", "properties": {"username": {"type": "string"}, "email": {"type": "string"}, "role": {"type": "string"}}}, "UserType": {"type": "string", "enum": ["assignee", "owner"]}, "ServiceAccount": {"type": "object", "required": ["user_key"], "properties": {"user_key": {"type": "string"}, "name": {"type": "string"}, "credentials": {"type": "object", "required": ["username", "password"], "properties": {"username": {"type": "string"}, "password": {"type": "string"}}}}}, "TokenResponse": {"type": "object", "properties": {"token": {"type": "string", "description": "The delete confirmation token."}}, "required": ["token"]}, "Project": {"type": "object", "properties": {"name": {"type": "string"}, "date": {"type": "string", "format": "datetime"}, "proj_key": {"type": "string"}, "role": {"$ref": "#/definitions/UserType"}}, "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/UserDetails"}}}, "SuccessMessage": {"type": "object", "properties": {"success": {"type": "string", "description": "Human readable message."}}, "required": ["success"]}, "ApiKey": {"type": "object", "required": ["api_key"], "properties": {"api_key": {"type": "string"}, "email": {"type": "string"}}}, "AccessToken": {"type": "object", "properties": {"access_token": {"type": "string"}}}, "ProjectUserAssignment": {"type": "object", "properties": {"username": {"type": "string", "description": "The username"}, "role": {"type": "string", "description": "The role to assign to the user"}, "force_role": {"type": "boolean", "default": true, "description": "If true, the role will be assigned also for existing users"}}, "required": ["username", "role"]}, "OidcTokenResponse": {"type": "object", "properties": {"access_token": {"type": "string"}, "id_token": {"type": "string"}, "refresh_token": {"type": "string"}}, "required": ["id_token", "refresh_token"]}, "AuditRecord": {"title": "AuditRecord", "type": "object", "properties": {"id": {"title": "Id", "type": "string"}, "timestamp": {"title": "Timestamp", "type": "string", "format": "datetime"}, "user_key": {"title": "User Key", "type": "string"}, "type": {"title": "Type", "type": "string"}, "message": {"title": "Message", "type": "string"}, "details": {"title": "Details", "type": "object"}, "proj_key": {"title": "Proj Key", "type": "string", "x-nullable": true}}, "required": ["id", "timestamp", "user_key", "type", "message", "details", "proj_key"]}}, "basePath": "/api/cps/user/v1"}